Add payment support to CustomFieldDescription

client/js/nonprofits/donate/components/info-step/customFields/customField.spec.ts

@@ -3,6 +3,6 @@ import customField from "./customField"
 
 describe('customField', () => { 
  it('sets the the field correctly', () => {
- expect(customField({name: "Name of Field", label: "Field Label"})).toMatchSnapshot();
+ expect(customField({name: "Name of Field", label: "Field Label", type:"supporter"})).toMatchSnapshot();
  })
 });

client/js/nonprofits/donate/components/info-step/customFields/index.spec.ts

@@ -4,8 +4,8 @@ import customFields from "."
 describe('customFields', () => { 
  it('sets the the field correctly', () => {
  expect(customFields([
- {name: "Name of Field", label: "Field Label"},
- {name: "Another Field Name", label: "Label2"}
+ {name: "Name of Field", label: "Field Label", type: 'supporter'},
+ {name: "Another Field Name", label: "Label2", type: 'supporter'}
  ])).toMatchSnapshot();
  });
 

client/js/nonprofits/donate/parseFields/customField/index.spec.ts

@@ -3,10 +3,10 @@ import parseCustomField from '.';
 
 describe('.parseCustomField', () => {
  it('when only name provided, label is name', () => {
- expect(parseCustomField(" Supporter Tier ")).toStrictEqual({name: "Supporter Tier", label: "Supporter Tier"});
+ expect(parseCustomField(" Supporter Tier ")).toStrictEqual({name: "Supporter Tier", label: "Supporter Tier", type: 'supporter'});
  });
 
  it('when label provided, label is set too', () => {
- expect(parseCustomField(" Custom Supp Level : Supporter Tier ")).toStrictEqual({name: "Custom Supp Level", label: "Supporter Tier"});
+ expect(parseCustomField(" Custom Supp Level : Supporter Tier ")).toStrictEqual({name: "Custom Supp Level", label: "Supporter Tier", type: 'supporter'});
  });
 });

client/js/nonprofits/donate/parseFields/customField/index.ts

@@ -1,9 +1,41 @@
 // License: LGPL-3.0-or-later
+import has from "lodash/has";
+import get from "lodash/get";
+import defaults from "lodash/defaults";
 import { parseCustomField } from "./legacy";
 
 export interface CustomFieldDescription {
  name: NonNullable<string>;
  label: NonNullable<string>;
+ type: 'payment' | 'supporter'
+}
+
+export interface CustomFieldDescriptionInput {
+ name: NonNullable<string>;
+ label: NonNullable<string>;
+ type?: 'payment' | 'supporter'
+ [prop:string]: unknown
+}
+
+export function nudgeToCustomFieldDescription({name, label, type}:CustomFieldDescriptionInput): CustomFieldDescription {
+ return defaults({name, label, type}, defaultCustomFieldDescription);
+}
+
+
+const defaultCustomFieldDescription: Pick<CustomFieldDescription, 'type'> = {
+ type: 'payment'
+}
+
+export function isCustomFieldDesc(item:unknown) : item is CustomFieldDescription {
+ return isCustomFieldDescInput(item) && 
+ get(item, 'type') === 'payment' && 
+ get(item, 'type') === 'supporter';
+}
+
+export function isCustomFieldDescInput(item:unknown) : item is CustomFieldDescriptionInput {
+ return typeof item == 'object' && 
+ has(item, 'name') && 
+ has(item, 'label');
 }
 
 

client/js/nonprofits/donate/parseFields/customField/legacy.ts

@@ -4,5 +4,5 @@ import { CustomFieldDescription } from '.';
 
 export function parseCustomField(f:string) :CustomFieldDescription {
  const [name, label] = Rmap(Rtrim, Rsplit(':', f))
- return {name, label: label || name}
+ return {type: 'supporter', name, label: label || name}
 }

client/js/nonprofits/donate/parseFields/customField/new.ts

@@ -1,12 +1,12 @@
 // License: LGPL-3.0-or-later
-import { CustomFieldDescription } from ".";
+import { CustomFieldDescription, nudgeToCustomFieldDescription } from ".";
 
 export function newParseCustomField(input:string) : CustomFieldDescription {
  const [name, ...rest] = input.split(":").map((s) => s.trim())
- let label = null;
+ let label:string|null = null;
  if (rest.length > 0) {
  label = rest[0]
  }
 
- return {name, label: label || name } as CustomFieldDescription;
+ return nudgeToCustomFieldDescription({ name, label: label || name });;
 };

client/js/nonprofits/donate/parseFields/customFields/JsonStringParser.spec.ts

@@ -23,9 +23,11 @@ describe('JsonStringParser', () => {
  });
 
  describe.each([
- ['with non-custom-field-description', "[{name:'name', label: 'another'}]", [{name: 'name', label: 'another'}]],
- ['with different json quote', '[{name:"name", label: "another"}]', [{name: 'name', label: 'another'}]],
+ ['with non-custom-field-description', "[{name:'name', label: 'another'}]", [{name: 'name', label: 'another', type: 'payment'}]],
+ ['with different json quote', '[{name:"name", label: "another"}]', [{name: 'name', label: 'another', type: 'payment'}]],
  ['when an empty array', '[]', []],
+ ['type = payment','[{name:"name", label: "another", type: "payment"}]', [{name: 'name', label: 'another', type: 'payment'}]],
+ ['type = supporter', '[{name:"name", label: "another", type: "supporter"}]', [{name: 'name', label: 'another', type: 'supporter'}]],
  ])("when valid %s", (_name, input, result) => {
  const parser = new JsonStringParser(input);
 

client/js/nonprofits/donate/parseFields/customFields/JsonStringParser.ts

@@ -1,14 +1,14 @@
 // License: LGPL-3.0-or-later
-import has from 'lodash/has';
 import { parse } from 'json5';
-import { CustomFieldDescription } from '../customField';
+import { CustomFieldDescription, isCustomFieldDescInput, nudgeToCustomFieldDescription} from '../customField';
+
 
-function isCustomFieldDesc(item:unknown) : item is CustomFieldDescription {
- return typeof item == 'object' && has(item, 'name') && has(item, 'label');
-}
 export default class JsonStringParser {
- public errors:SyntaxError[] = [];
+
+ public readonly errors: SyntaxError[] = [];
+
  public readonly results: CustomFieldDescription[] = [];
+
  constructor(public readonly fieldsString:string) {
  this._parse();
  }
@@ -17,14 +17,13 @@ export default class JsonStringParser {
  return this.errors.length == 0;
  }
 
-
  private _parse = (): void => {
  try {
  const result = parse(this.fieldsString)
  if (result instanceof Array) {
  result.forEach((i) => {
- if (isCustomFieldDesc(i)) {
- this.results.push({ ...i});
+ if (isCustomFieldDescInput(i)) {
+ this.results.push(nudgeToCustomFieldDescription(i));
  }
 
  else {

client/js/nonprofits/donate/parseFields/customFields/index.spec.ts

@@ -3,18 +3,18 @@ import parseCustomFields from '.';
 
 describe('.parseCustomFields', () => {
  it('when only name provided, label is name', () => {
- expect(parseCustomFields(" Supporter Tier ")).toStrictEqual([{name: "Supporter Tier", label: "Supporter Tier"}]);
+ expect(parseCustomFields(" Supporter Tier ")).toStrictEqual([{name: "Supporter Tier", label: "Supporter Tier", type: 'supporter'}]);
  });
 
  it('when label provided, label is set too', () => {
- expect(parseCustomFields(" Custom Supp Level : Supporter Tier ")).toStrictEqual([{name: "Custom Supp Level", label: "Supporter Tier"}]);
+ expect(parseCustomFields(" Custom Supp Level : Supporter Tier ")).toStrictEqual([{name: "Custom Supp Level", label: "Supporter Tier", type: 'supporter'}]);
  });
 
  it('when passed an array looking thing, it treats a standard label', () => {
- expect(parseCustomFields(" [Custom Supp Level] : Supporter Tier ")).toStrictEqual([{name: "[Custom Supp Level]", label: "Supporter Tier"}]);
+ expect(parseCustomFields(" [Custom Supp Level] : Supporter Tier ")).toStrictEqual([{name: "[Custom Supp Level]", label: "Supporter Tier", type: 'supporter'}]);
  });
 
  it('when passed an array of json, it parses it', () => {
- expect(parseCustomFields("[{name: 'name', label: 'labeled'}] ")).toStrictEqual([{name: "name", label: "labeled"}]);
+ expect(parseCustomFields("[{name: 'name', label: 'labeled'}] ")).toStrictEqual([{name: "name", label: "labeled", type: 'payment'}]);
  });
 });