feat: add option to ignore field

Author: ynixt

package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript-flat-serializer",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A typescript library to serialize/deserialize classes to/from string in a flat format. Supports inheritance, circular reference and more",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

src/flat-property.ts

@@ -6,6 +6,7 @@ export type PropertyTransformer = (property: any) => any;
 export interface TSFlatPropertyMetadata {
   beforeStringify?: PropertyTransformer;
   afterParse?: PropertyTransformer;
+  ignore?: boolean
 }
 
 export type TSFlatPropertyOptions = TSFlatPropertyMetadata;
@@ -16,6 +17,7 @@ export const TSFlatProperty = (options?: TSFlatPropertyOptions): Function => {
       {
         beforeStringify: options?.beforeStringify,
         afterParse: options?.afterParse,
+        ignore: options?.ignore,
       },
       target,
       key,

src/flat-serializer.ts

@@ -94,7 +94,7 @@ function convertArrayToOriginalCollectionType(value: CollectionType, currentColl
 /**
  * Get the flatPropertyMetadata searching on the object and on object's parent.
  */
-function getFlatPropertyMetadata(obj: any, propertyKey: string): TSFlatPropertyMetadata {
+export function getFlatPropertyMetadata(obj: any, propertyKey: string): TSFlatPropertyMetadata {
   let propertyMetadata: TSFlatPropertyMetadata = null;
 
   do {

src/rfdc.ts

@@ -4,6 +4,7 @@
     Probably on the future I'll move this file into a new repository.
  */
 import { Type } from './helpers';
+import { getFlatPropertyMetadata } from "./flat-serializer";
 
 function copyBuffer(cur) {
   if (cur instanceof Buffer) {
@@ -60,7 +61,9 @@ export function rfdc(opts?: RFDCOptions) {
     refs.push(o);
     refsNew.push(o2);
     for (const k in o) {
-      if (Object.hasOwnProperty.call(o, k) === false) continue;
+      const propertyMetadata = getFlatPropertyMetadata(o, k);
+
+      if (Object.hasOwnProperty.call(o, k) === false || propertyMetadata?.ignore === true) continue;
       const cur = o[k];
       if (typeof cur !== 'object' || cur === null) {
         o2[k] = cur;

test/core.test.ts

@@ -4,6 +4,13 @@ class AnyClassExample {
   constructor(public str: string) {}
 }
 
+class AnyClassExampleWithIgnore {
+  @TSFlatProperty({ ignore: true })
+  public ignoredField: string;
+
+  constructor(public str: string) {}
+}
+
 @TSFlatObject()
 export class AnyClassExampleWithDecorator {
   constructor(public str: string) {}
@@ -80,3 +87,14 @@ test('afterParse', () => {
 
   expect(parsedRoot.str).toBe('after works');
 });
+
+test('basic stringify/parse with ignore', () => {
+  const root = new AnyClassExampleWithIgnore('adsdsa');
+  root.ignoredField = 'nnn';
+
+  const str = stringify(root);
+  const parsedRoot = parse<AnyClassExampleWithIgnore>(str);
+
+  expect(parsedRoot.str).toEqual(root.str);
+  expect(parsedRoot.ignoredField).toBeUndefined()
+});