@rebilly/instruments 3.29.2 → 3.30.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rebilly/instruments",
-  "version": "3.29.2",
+  "version": "3.30.0",
   "author": "Rebilly",
   "license": "MIT",
   "main": "dist/index.js",
@@ -9,6 +9,7 @@
     "build": "yarn prefetch && yarn rollup -c --environment NODE_ENV:production",
     "dev": "yarn prefetch && yarn rollup -c --watch --environment NODE_ENV:development",
     "test": "yarn jest",
+    "test:unit": "yarn jest",
     "test:watch": "yarn jest --watchAll",
     "prefetch": "node --experimental-modules service/prefetch/prefetch.mjs"
   },
@@ -18,6 +19,7 @@
     "@babel/preset-env": "^7.21.5",
     "@rebilly/risk-data-collector": "*",
     "@vue/reactivity": "^3.2.39",
+    "ajv": "^8.12.0",
     "jwt-decode": "^3.1.2",
     "lodash.camelcase": "^4.3.0",
     "lodash.clonedeep": "^4.5.0",
@@ -39,7 +41,7 @@
     "component-emitter": "^1.3.0",
     "core-js": "^3.23.3",
     "jest": "^29.5.0",
-    "msw": "0.45.0",
+    "msw": "^1.2.1",
     "msw-when-then": "^1.5.1",
     "rollup": "^2.35.1",
     "rollup-plugin-ignore": "^1.0.10",

package/src/data/options-schema/index.js

@@ -0,0 +1,93 @@
+import schema from './schemas/options-schema';
+import AJV from 'ajv/dist/2019';
+
+export class RebillyInstrumentsConfigError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "Rebilly Instruments Configuration Error";
+  }
+
+  trimStack() {
+    Error.captureStackTrace(this, RebillyInstrumentsConfigError)
+    return this
+  }
+}
+
+const ajv = new AJV({
+  allErrors: true,
+  removeAdditional: true,
+  useDefaults: true
+});
+const validate = ajv.compile(schema);
+
+export function sanitize(data) {
+  // cast data to be only json object
+  return JSON.parse(
+    JSON.stringify(data)
+  )
+}
+
+export function validateOptions(data) {
+  const sanitizedData = sanitize(data);
+  const valid = validate(sanitizedData);
+  if (valid) {
+    return sanitizedData;
+  }
+
+  validate.errors.forEach(error => {
+    let errorMessage = ``;
+    let instancePathReadable = error.instancePath.substring(1).replace(/\//gi, '.');
+    instancePathReadable = instancePathReadable.replace(/\.\d+/ig, (match) => {
+      return `[${match.replace('.', '')}]`;
+    });
+    if (!instancePathReadable.length) {
+      instancePathReadable = 'options'
+    }
+
+    switch(error.keyword) {
+      case 'if':
+      case 'false schema':
+        // ignore keywords
+        break;
+      case 'required':
+        if (error.schemaPath.match(/(oneOf|anyOf)/)) {
+          // ignore and allow their oneOf or anyOf keywords to handle error message
+          break;
+        }
+        errorMessage = `${instancePathReadable} ${error.message}`;
+        break;
+      case 'oneOf':
+      case 'anyOf':
+        console.error(
+          new RebillyInstrumentsConfigError(`${instancePathReadable} ${error.message}, see schemas below.`)
+            .trimStack()
+        );
+        const schemaPath = error.schemaPath.replace('#/', '').split('/');
+        let nodes = schema;
+        schemaPath.forEach(item => nodes = nodes[item]);
+        nodes.forEach(node => {
+          const displayNode = JSON.stringify(node, null, 2);
+          console.error(`${instancePathReadable} ${error.keyword} schema.\n${displayNode}`, );
+        });
+        break;
+      case 'enum':
+        errorMessage = `${instancePathReadable} ${error.message}: ${error.params.allowedValues}. received: ${data[instancePathReadable]}`
+        break;
+      case 'dependentRequired':
+      case 'maxLength':
+      case 'minItems':
+      case 'pattern':
+        errorMessage = `${instancePathReadable} ${error.message}`;
+        break;
+      default:
+        errorMessage = `Error with ${instancePathReadable} - See error message`;
+        console.error(error);
+        break;
+    }
+    if (errorMessage) {
+      console.error(new RebillyInstrumentsConfigError(errorMessage).trimStack());
+    }
+  });
+
+  throw new RebillyInstrumentsConfigError('Configuration is invalid');
+}

package/src/data/options-schema/schemas/options-schema.js

@@ -0,0 +1,425 @@
+export default {
+  title: 'Mount Options Schema',
+  type: 'object',
+  properties: {
+    form: {
+      type: 'string',
+      default: '.rebilly-instruments',
+    },
+    summary: {
+      type: 'string',
+      default: '.rebilly-instruments-summary',
+    },
+    apiMode: {
+      type: 'string',
+      enum: ['sandbox', 'live'],
+    },
+    publishableKey: {type: 'string',},
+    jwt: {type: 'string'},
+    websiteId: {type: 'string',},
+    organizationId: {type: 'string',},
+    items: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          planId: {type: 'string'},
+          thumbnail: {type: 'string'},
+        },
+        oneOf: [
+          {
+            properties: {
+              quantity: { type: 'number' },
+            },
+          }, {
+            properties: {
+              quantity: {
+                type: 'object',
+                properties: {
+                  default: {type: 'number'},
+                  minimum: {type: 'number'},
+                  maximum: {type: 'number'},
+                  multipleOf: {type: 'number'}
+                }
+              }
+            }
+          }
+        ],
+        required: ['planId', 'quantity'],
+      },
+      minItems: 1,
+    },
+    addons: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          planId: {type: 'string'},
+          quantity: {type: 'number'},
+          thumbnail: {type: 'string'},
+        },
+        required: ['planId', 'quantity']
+      },
+      default: [],
+    },
+    bumpOffer: {
+      type: 'array',
+      items: {
+        type: 'object',
+        properties: {
+          planId: {type: 'string'},
+          quantity: {type: 'number'},
+          thumbnail: {type: 'string'},
+        },
+        required: ['planId', 'quantity']
+      },
+      default: [],
+    },
+    money: {
+      type: 'object',
+      properties: {
+        amount: {type: 'number'},
+        currency: {
+          type: 'string',
+          minLength: 3,
+          maxLength: 3,
+        },
+      },
+      required: ['amount', 'currency'],
+    },
+    invoiceId: {type: 'string'},
+    transactionId: {type: 'string'},
+    deposit: {
+      oneOf: [
+        {
+          type: 'object',
+          properties: {
+            depositRequestId: {type: 'string'},
+          },
+          required: ['depositRequestId']
+        }, {
+          type: 'object',
+          properties: {
+            currency: {
+              type: 'string',
+              minLength: 3,
+              maxLength: 3,
+            },
+            amount: {type: 'number'},
+            buttons: {
+              type: 'array',
+              items: {
+                type: 'number'
+              }
+            },
+            editable: {type: 'boolean'},
+            customAmount: {
+              type: 'object',
+              properties: {
+                minimum: {type: 'number'},
+                maximum: {type: 'number'},
+                increment: {type: 'number'}
+              },
+            }
+          },
+          required: ['currency']
+        }
+      ]
+    },
+    transactionType: {
+      type: 'string',
+      enum: ['purchase', 'setup'],
+      default: 'purchase',
+    },
+    css: {type: 'string'},
+    theme: {
+      type: 'object',
+      properties: {
+        labels: {
+          type: 'string',
+          enum: ['stacked', 'floating'],
+          default: 'stacked'
+        },
+        // TODO: split file add schema for all tokens
+      },
+      default: {},
+    },
+    countryCode: {
+      type: 'string',
+      default: 'US',
+    },
+    locale: {
+      type: 'string',
+      default: 'auto',
+    },
+    i18n: {
+      type: 'object',
+      patternProperties: {
+        "^[a-z]{2}(-[A-Z]{2})?$": {
+          type: "object",
+          properties: {
+            // TODO: split file add schema for all translation keys
+            summary: {type: 'object'},
+            form: {type: 'object'},
+            confirmation: {type: 'object'},
+            result: {type: 'object'},
+            validations: {type: 'object'},
+            paymentMethods: {type: 'object'},
+          }
+        },
+      }
+    },
+    paymentInstruments: {
+      type: 'object',
+      properties: {
+        compactExpressInstruments: {
+          type: 'boolean',
+          default: false
+        },
+        address: {
+          type: 'object',
+          properties: {
+            name: {
+              type: 'string',
+              enum: ['default', 'combined', 'stacked'],
+              default: 'default',
+            },
+            region: {
+              type: 'string',
+              enum: ['default', 'split', 'stacked'],
+              default: 'default',
+            },
+            show: {
+              type: 'array',
+              default: [],
+              items: {
+                type: 'string',
+                enum: ['email', 'organization', 'phoneNumber', 'city', 'country', 'region', 'postalCode']
+              }
+            },
+            hide: {
+              type: 'array',
+              default: [],
+              items: {
+                type: 'string',
+                enum: ['address2']
+              }
+            },
+            require: {
+              type: 'array',
+              default: [],
+              items: {
+                type: 'string',
+                enum: [
+                  'organization',
+                  'email',
+                  'phoneNumber',
+                  'address',
+                  'address2',
+                  'city',
+                  'country',
+                  'region',
+                  'postalCode'
+                ]
+              }
+            },
+          },
+          default: {},
+        },
+        paypal: {
+          type: 'object',
+          properties: {
+            buttonHeight: {
+              type: 'number',
+              default: 48
+            },
+          },
+          default: {}
+        },
+        googlePay: {
+          type: 'object',
+          properties: {
+            displayOptions: {
+              type: 'object',
+              properties: {
+                buttonColor: {
+                  type: 'string',
+                  enum: ['black', 'white'],
+                  default: 'black',
+                },
+                buttonHeight: {
+                  type: 'string',
+                  pattern: '^[0-9]+px$',
+                  default: '48px',
+                },
+                buttonType: {
+                  type: 'string',
+                  enum: ['book', 'buy', 'checkout', 'donate', 'order', 'pay', 'plain', 'subscribe'],
+                  default: 'plain',
+                }
+              },
+              default: {},
+            }
+          },
+          default: {},
+        },
+        applePay: {
+          type: 'object',
+          properties: {
+            displayOptions: {
+              type: 'object',
+              properties: {
+                buttonColor: {
+                  type: 'string',
+                  enum: ['black', 'white', 'white-outline'],
+                  default: 'black',
+                },
+                buttonHeight: {
+                  type: 'string',
+                  pattern: '^[0-9]+px$',
+                  default: '48px',
+                },
+                buttonType: {
+                  type: 'string',
+                  enum: [
+                    'add-money',
+                    'book',
+                    'buy',
+                    'check-out',
+                    'continue',
+                    'contribute',
+                    'donate',
+                    'order',
+                    'pay',
+                    'plain',
+                    'reload',
+                    'rent',
+                    'set-up',
+                    'subscribe',
+                    'support',
+                    'tip',
+                    'top-up'
+                  ],
+                  default: 'plain',
+                }
+              },
+              default: {},
+            }
+          },
+          default: {},
+        },
+        paymentCard: {
+          type: 'object',
+          properties: {
+            popup: {
+              type: 'boolean',
+              default: false,
+            },
+          },
+          default: {},
+        },
+      },
+      default: {},
+    },
+    features: {
+      type: 'object',
+      properties: {
+        autoConfirmation: {
+          type: 'boolean',
+          default: true,
+        },
+        autoResult: {
+          type: 'boolean',
+          default: true,
+        },
+        showCoupons: {
+          type: 'array',
+          items: {
+            type: 'string',
+            enum: ['summary', 'confirmation']
+          }
+        }
+      },
+      default: {},
+    },
+    _dev: {
+      type: 'object',
+      properties: {
+        paymentMethodsUrl: {
+          type: 'string',
+          default: 'https://forms.local.rebilly.dev:3000',
+        },
+        liveUrl: {type: 'string'},
+        sandboxUrl: {type: 'string'},
+        framePayScriptLink: {type: 'string'},
+        framePayStyleLink: {type: 'string'},
+      },
+    }
+  },
+  required: ['apiMode'],
+  dependentRequired: {
+    invoiceId: ['jwt'],
+    transactionId: ['jwt'],
+    deposit: ['jwt'],
+  },
+  anyOf: [
+    {
+      if: {required: ['items']},
+      then: {
+        properties: {
+          transactionId: false,
+          invoiceId: false,
+          deposit: false,
+          money: false,
+        }
+      },
+      else: false
+    }, {
+      if: {required: ['money']},
+      then: {
+        properties: {
+          transactionId: false,
+          invoiceId: false,
+          deposit: false,
+          items: false,
+        }
+      },
+      else: false
+    }, {
+      if: {required: ['transactionId']},
+      then: {
+        properties: {
+          invoiceId: false,
+          deposit: false,
+          items: false,
+          money: false,
+        }
+      },
+      else: false
+    },{
+      if: {required: ['invoiceId']},
+      then: {
+        properties: {
+          transactionId: false,
+          deposit: false,
+          items: false,
+          money: false,
+        }
+      },
+      else: false
+    }, {
+      if: {required: ['deposit']},
+      then: {
+        properties: {
+          invoiceId: false,
+          transactionId: false,
+          items: false,
+          money: false,
+        }
+      },
+      else: false
+    }, {
+      required: ['jwt']
+    }
+  ]
+}