@ellipticltd/aml-utils 0.15.32 → 0.15.34

package/lib/structured-file-parser/structured-file-parser.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHeaderRowValid = exports.hasHeaderRow = void 0;
+const tslib_1 = require("tslib");
+/* eslint-disable no-await-in-loop */
+/* eslint-disable no-restricted-syntax */
+const parse_row_1 = tslib_1.__importDefault(require("./parse-row"));
+const errors_1 = require("./errors");
+const sanitize_rows_1 = tslib_1.__importDefault(require("./sanitize-rows"));
+function chunk(array, size) {
+    if (!array.length) {
+        return [];
+    }
+    const head = array.slice(0, size);
+    const tail = array.slice(size);
+    return [head, ...chunk(tail, size)];
+}
+function processChunk(parsedRows, dependencies) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const { processRow, headers } = dependencies;
+        return new Promise((resolve, reject) => {
+            setTimeout(() => {
+                try {
+                    const processedRows = parsedRows.map((row) => processRow(row, headers));
+                    resolve(processedRows);
+                }
+                catch (ex) {
+                    reject(ex);
+                }
+            }, 0);
+        });
+    });
+}
+// a row is said to contain headers if two valid header names are present
+const hasHeaderRow = (rows, requiredHeaderNames) => {
+    const firstRow = rows[0];
+    if (!firstRow) {
+        return false;
+    }
+    const foundIndex = firstRow.findIndex((value) => requiredHeaderNames.includes(value.toLowerCase()));
+    if (foundIndex < 0) {
+        return false;
+    }
+    const containsSecondHeader = firstRow
+        .filter((_val, i) => i !== foundIndex)
+        .some((value) => requiredHeaderNames.includes(value.toLowerCase()));
+    return containsSecondHeader;
+};
+exports.hasHeaderRow = hasHeaderRow;
+const isHeaderRowValid = (rows, requiredHeaderNames) => {
+    const firstRow = rows[0];
+    if (!firstRow) {
+        return false;
+    }
+    return (requiredHeaderNames.every((header) => firstRow.map((value) => value.toLowerCase()).includes(header)) &&
+        requiredHeaderNames.length === firstRow.length);
+};
+exports.isHeaderRowValid = isHeaderRowValid;
+function parseFile(fileContent, maxRows, requiredHeaderNames, dependencies) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        if (fileContent === 'invalidFileType') {
+            throw new errors_1.InvalidFileError();
+        }
+        const rows = fileContent.split('\n');
+        const parsedRows = rows.map(parse_row_1.default);
+        const sanitizedRows = (0, sanitize_rows_1.default)(parsedRows);
+        if (sanitizedRows.length > maxRows) {
+            throw new errors_1.TooManyRowsError();
+        }
+        if (sanitizedRows.length === 0) {
+            throw new errors_1.NoRowsError();
+        }
+        const containsHeaders = (0, exports.hasHeaderRow)(sanitizedRows, requiredHeaderNames);
+        if (containsHeaders && !(0, exports.isHeaderRowValid)(sanitizedRows, requiredHeaderNames)) {
+            throw new errors_1.InvalidHeadersError();
+        }
+        const firstSanitizedRow = sanitizedRows[0];
+        if (!firstSanitizedRow) {
+            throw new errors_1.NoRowsError();
+        }
+        const headers = containsHeaders ? firstSanitizedRow.map((value) => value.toLowerCase()) : requiredHeaderNames;
+        const dataRows = containsHeaders ? sanitizedRows.splice(1) : sanitizedRows;
+        if (dataRows.length === 0) {
+            throw new errors_1.NoRowsError();
+        }
+        const parsedRowChunks = chunk(dataRows, 30);
+        let results = [];
+        for (const currentRowChunk of parsedRowChunks) {
+            const chunkResult = yield processChunk(currentRowChunk, Object.assign(Object.assign({}, dependencies), { headers }));
+            results = results.concat(chunkResult);
+        }
+        return results;
+    });
+}
+exports.default = parseFile;
+//# sourceMappingURL=structured-file-parser.js.map

package/lib/structured-file-parser/structured-file-parser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"structured-file-parser.js","sourceRoot":"","sources":["../../../../../libs/aml-utils/lib/structured-file-parser/structured-file-parser.ts"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,yCAAyC;AACzC,oEAAmC;AACnC,qCAAgG;AAChG,4EAA2C;AAe3C,SAAS,KAAK,CAAI,KAAU,EAAE,IAAY;IACxC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE;QACjB,OAAO,EAAE,CAAC;KACX;IACD,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAClC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE/B,OAAO,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,SAAe,YAAY,CACzB,UAAsB,EACtB,YAAwC;;QAExC,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC;QAC7C,OAAO,IAAI,OAAO,CAAC,CAAC,OAAyC,EAAE,MAA8B,EAAQ,EAAE;YACrG,UAAU,CAAC,GAAG,EAAE;gBACd,IAAI;oBACF,MAAM,aAAa,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;oBACxE,OAAO,CAAC,aAAa,CAAC,CAAC;iBACxB;gBAAC,OAAO,EAAE,EAAE;oBACX,MAAM,CAAC,EAAE,CAAC,CAAC;iBACZ;YACH,CAAC,EAAE,CAAC,CAAC,CAAC;QACR,CAAC,CAAC,CAAC;IACL,CAAC;CAAA;AAED,yEAAyE;AAClE,MAAM,YAAY,GAAG,CAAC,IAAgB,EAAE,mBAA6B,EAAW,EAAE;IACvF,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,KAAK,CAAC;KACd;IACD,MAAM,UAAU,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IACpG,IAAI,UAAU,GAAG,CAAC,EAAE;QAClB,OAAO,KAAK,CAAC;KACd;IACD,MAAM,oBAAoB,GAAG,QAAQ;SAClC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,UAAU,CAAC;SACrC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IACtE,OAAO,oBAAoB,CAAC;AAC9B,CAAC,CAAC;AAbW,QAAA,YAAY,gBAavB;AAEK,MAAM,gBAAgB,GAAG,CAAC,IAAgB,EAAE,mBAA6B,EAAW,EAAE;IAC3F,MAAM,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IACzB,IAAI,CAAC,QAAQ,EAAE;QACb,OAAO,KAAK,CAAC;KACd;IACD,OAAO,CACL,mBAAmB,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACpG,mBAAmB,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,CAC/C,CAAC;AACJ,CAAC,CAAC;AATW,QAAA,gBAAgB,oBAS3B;AAEF,SAAe,SAAS,CACtB,WAAmB,EACnB,OAAe,EACf,mBAA6B,EAC7B,YAA6B;;QAE7B,IAAI,WAAW,KAAK,iBAAiB,EAAE;YACrC,MAAM,IAAI,yBAAgB,EAAE,CAAC;SAC9B;QAED,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,mBAAQ,CAAC,CAAC;QAEtC,MAAM,aAAa,GAAG,IAAA,uBAAY,EAAC,UAAU,CAAC,CAAC;QAE/C,IAAI,aAAa,CAAC,MAAM,GAAG,OAAO,EAAE;YAClC,MAAM,IAAI,yBAAgB,EAAE,CAAC;SAC9B;QAED,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;YAC9B,MAAM,IAAI,oBAAW,EAAE,CAAC;SACzB;QAED,MAAM,eAAe,GAAG,IAAA,oBAAY,EAAC,aAAa,EAAE,mBAAmB,CAAC,CAAC;QACzE,IAAI,eAAe,IAAI,CAAC,IAAA,wBAAgB,EAAC,aAAa,EAAE,mBAAmB,CAAC,EAAE;YAC5E,MAAM,IAAI,4BAAmB,EAAE,CAAC;SACjC;QAED,MAAM,iBAAiB,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;QAE3C,IAAI,CAAC,iBAAiB,EAAE;YACtB,MAAM,IAAI,oBAAW,EAAE,CAAC;SACzB;QAED,MAAM,OAAO,GAAG,eAAe,CAAC,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC;QAE9G,MAAM,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;QAE3E,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;YACzB,MAAM,IAAI,oBAAW,EAAE,CAAC;SACzB;QAED,MAAM,eAAe,GAAG,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC5C,IAAI,OAAO,GAAQ,EAAE,CAAC;QACtB,KAAK,MAAM,eAAe,IAAI,eAAe,EAAE;YAC7C,MAAM,WAAW,GAAG,MAAM,YAAY,CAAC,eAAe,kCACjD,YAAY,KACf,OAAO,IACP,CAAC;YACH,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;SACvC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CAAA;AAED,kBAAe,SAAS,CAAC","sourcesContent":["/* eslint-disable no-await-in-loop */\n/* eslint-disable no-restricted-syntax */\nimport parseRow from './parse-row';\nimport { InvalidFileError, TooManyRowsError, NoRowsError, InvalidHeadersError } from './errors';\nimport sanitizeRows from './sanitize-rows';\n\nexport type ProcessingEntry = {\n  isValid: boolean;\n};\n\ntype Dependencies<T extends ProcessingEntry> = {\n  processRow: (cells: string[], headers: string[]) => T;\n};\n\ntype CompleteDependencies<T extends ProcessingEntry, U extends string[]> = {\n  processRow: (cells: string[], headers: U) => T;\n  headers: U;\n};\n\nfunction chunk<T>(array: T[], size: number): T[][] {\n  if (!array.length) {\n    return [];\n  }\n  const head = array.slice(0, size);\n  const tail = array.slice(size);\n\n  return [head, ...chunk(tail, size)];\n}\n\nasync function processChunk<T extends ProcessingEntry, U extends string[]>(\n  parsedRows: string[][],\n  dependencies: CompleteDependencies<T, U>\n): Promise<T[]> {\n  const { processRow, headers } = dependencies;\n  return new Promise((resolve: (value: T[] | undefined) => void, reject: (error: Error) => void): void => {\n    setTimeout(() => {\n      try {\n        const processedRows = parsedRows.map((row) => processRow(row, headers));\n        resolve(processedRows);\n      } catch (ex) {\n        reject(ex);\n      }\n    }, 0);\n  });\n}\n\n// a row is said to contain headers if two valid header names are present\nexport const hasHeaderRow = (rows: string[][], requiredHeaderNames: string[]): boolean => {\n  const firstRow = rows[0];\n  if (!firstRow) {\n    return false;\n  }\n  const foundIndex = firstRow.findIndex((value) => requiredHeaderNames.includes(value.toLowerCase()));\n  if (foundIndex < 0) {\n    return false;\n  }\n  const containsSecondHeader = firstRow\n    .filter((_val, i) => i !== foundIndex)\n    .some((value) => requiredHeaderNames.includes(value.toLowerCase()));\n  return containsSecondHeader;\n};\n\nexport const isHeaderRowValid = (rows: string[][], requiredHeaderNames: string[]): boolean => {\n  const firstRow = rows[0];\n  if (!firstRow) {\n    return false;\n  }\n  return (\n    requiredHeaderNames.every((header) => firstRow.map((value) => value.toLowerCase()).includes(header)) &&\n    requiredHeaderNames.length === firstRow.length\n  );\n};\n\nasync function parseFile<T extends ProcessingEntry>(\n  fileContent: string,\n  maxRows: number,\n  requiredHeaderNames: string[],\n  dependencies: Dependencies<T>\n): Promise<T[]> {\n  if (fileContent === 'invalidFileType') {\n    throw new InvalidFileError();\n  }\n\n  const rows = fileContent.split('\\n');\n  const parsedRows = rows.map(parseRow);\n\n  const sanitizedRows = sanitizeRows(parsedRows);\n\n  if (sanitizedRows.length > maxRows) {\n    throw new TooManyRowsError();\n  }\n\n  if (sanitizedRows.length === 0) {\n    throw new NoRowsError();\n  }\n\n  const containsHeaders = hasHeaderRow(sanitizedRows, requiredHeaderNames);\n  if (containsHeaders && !isHeaderRowValid(sanitizedRows, requiredHeaderNames)) {\n    throw new InvalidHeadersError();\n  }\n\n  const firstSanitizedRow = sanitizedRows[0];\n\n  if (!firstSanitizedRow) {\n    throw new NoRowsError();\n  }\n\n  const headers = containsHeaders ? firstSanitizedRow.map((value) => value.toLowerCase()) : requiredHeaderNames;\n\n  const dataRows = containsHeaders ? sanitizedRows.splice(1) : sanitizedRows;\n\n  if (dataRows.length === 0) {\n    throw new NoRowsError();\n  }\n\n  const parsedRowChunks = chunk(dataRows, 30);\n  let results: T[] = [];\n  for (const currentRowChunk of parsedRowChunks) {\n    const chunkResult = await processChunk(currentRowChunk, {\n      ...dependencies,\n      headers,\n    });\n    results = results.concat(chunkResult);\n  }\n\n  return results;\n}\n\nexport default parseFile;\n"]}

package/lib/types/types.d.ts

@@ -0,0 +1,11 @@
+declare const withNullable: {};
+export function parseType(str: any): any;
+export function parsedTypeCheck(type: any, obj: any): any;
+export function typeCheck(type: any, obj: any): any;
+export namespace opts {
+    export { withNullable as customTypes };
+}
+export function ensureType(type: any, obj: any, msg: any): boolean;
+export function checkArg(obj: any, prop: any, type: any, msg: any): any;
+export function checkArgs(input: any, types: any): void;
+export {};

package/lib/types/types.js

@@ -1,211 +1,201 @@
 const TC = require('type-check');
-
 const _ = require('lodash');
-
 const E = require('../errors/errors');
-
 const V = require('../validations/validations');
-
 const customTypes = {
-  Integer: {
-    typeOf: 'Number',
-    validate(x) {
-      return x % 1 === 0;
-    },
-  },
-  IntString: {
-    typeOf: 'String',
-    validate: V.isInt,
-  },
-  BoolString: {
-    typeOf: 'String',
-    validate: V.isBoolean,
-  },
-  Hex32: {
-    typeOf: 'String',
-    validate(x) {
-      return V.isHexadecimal(x) && x.length === 32;
-    },
-  },
-  Email: {
-    typeOf: 'String',
-    validate: V.isEmail,
-  },
-  UUID: {
-    typeOf: 'String',
-    validate: V.isUUID,
-  },
-  UUIDv4: {
-    typeOf: 'String',
-    validate(x) {
-      return V.isUUID(x, 4);
-    },
-  },
-  JSON: {
-    typeOf: 'String',
-    validate: V.isJSON,
-  },
-  Url: {
-    typeOf: 'String',
-    validate: V.isURL,
-  },
-  DateString: {
-    typeOf: 'String',
-    validate: V.isDate,
-  },
-  NonEmptyArray: {
-    typeOf: 'Array',
-    validate: V.nonEmpty,
-  },
-  NonNullString: {
-    typeOf: 'String',
-    validate: V.nonEmpty,
-  },
-  CustomerReference: {
-    typeOf: 'String',
-    validate: V.isCustomerReference,
-  },
-  CustomerLabelName: {
-    typeOf: 'String',
-    validate: V.isCustomerLabelName,
-  },
-  BitcoinAddress: {
-    typeOf: 'String',
-    validate: V.bitcoin.isAddress,
-  },
-  EthereumAddress: {
-    typeOf: 'String',
-    validate: V.ethereum.isAddress,
-  },
-  EthereumTx: {
-    typeOf: 'String',
-    validate: V.ethereum.isTxHash,
-  },
-  EthereumBlockHash: {
-    typeOf: 'String',
-    validate: V.ethereum.isBlockHash,
-  },
-  EthereumWeiAmount: {
-    typeOf: 'String',
-    validate: V.ethereum.isValidWeiAmount,
-  },
-  EthereumAddressCode: {
-    typeOf: 'String',
-    validate: V.ethereum.isAddressCode,
-  },
-  MineId: {
-    typeOf: 'String',
-    validate(x) {
-      return x === 'mine';
-    },
-  },
-  BitcoinTxHash: {
-    typeOf: 'String',
-    validate: V.bitcoin.isTxHash,
-  },
-  BitcoinAddressArray: {
-    typeOf: 'Array',
-    validate(as) {
-      return _.every(as, V.bitcoin.isAddress);
-    },
-  },
-  BitcoinTxHashArray: {
-    typeOf: 'Array',
-    validate(as) {
-      return _.every(as, V.bitcoin.isTxHash);
-    },
-  },
-  BitcoinTxHex: {
-    typeOf: 'String',
-    validate: V.bitcoin.isTxHex,
-  },
-  BitcoinScriptHex: {
-    typeOf: 'String',
-    validate: V.bitcoin.isScriptHex,
-  },
-  BitcoinHDPath: {
-    typeOf: 'String',
-    validate: V.bitcoin.isHDPath,
-  },
-  BitcoinPublicKey: {
-    typeOf: 'String',
-    validate: V.bitcoin.isPublicKey,
-  },
-  BitcoinXpub: {
-    typeOf: 'String',
-    validate: V.bitcoin.isHDPublicKey,
-  },
-  BitcoinTxSignature: {
-    typeOf: 'String',
-    validate: V.bitcoin.isTxSignature,
-  },
-  BitcoinBlockHeight: {
-    typeOf: 'Number',
-    validate: V.bitcoin.isBlockHeight,
-  },
+    Integer: {
+        typeOf: 'Number',
+        validate(x) {
+            return x % 1 === 0;
+        },
+    },
+    IntString: {
+        typeOf: 'String',
+        validate: V.isInt,
+    },
+    BoolString: {
+        typeOf: 'String',
+        validate: V.isBoolean,
+    },
+    Hex32: {
+        typeOf: 'String',
+        validate(x) {
+            return V.isHexadecimal(x) && x.length === 32;
+        },
+    },
+    Email: {
+        typeOf: 'String',
+        validate: V.isEmail,
+    },
+    UUID: {
+        typeOf: 'String',
+        validate: V.isUUID,
+    },
+    UUIDv4: {
+        typeOf: 'String',
+        validate(x) {
+            return V.isUUID(x, 4);
+        },
+    },
+    JSON: {
+        typeOf: 'String',
+        validate: V.isJSON,
+    },
+    Url: {
+        typeOf: 'String',
+        validate: V.isURL,
+    },
+    DateString: {
+        typeOf: 'String',
+        validate: V.isDate,
+    },
+    NonEmptyArray: {
+        typeOf: 'Array',
+        validate: V.nonEmpty,
+    },
+    NonNullString: {
+        typeOf: 'String',
+        validate: V.nonEmpty,
+    },
+    CustomerReference: {
+        typeOf: 'String',
+        validate: V.isCustomerReference,
+    },
+    CustomerLabelName: {
+        typeOf: 'String',
+        validate: V.isCustomerLabelName,
+    },
+    BitcoinAddress: {
+        typeOf: 'String',
+        validate: V.bitcoin.isAddress,
+    },
+    EthereumAddress: {
+        typeOf: 'String',
+        validate: V.ethereum.isAddress,
+    },
+    EthereumTx: {
+        typeOf: 'String',
+        validate: V.ethereum.isTxHash,
+    },
+    EthereumBlockHash: {
+        typeOf: 'String',
+        validate: V.ethereum.isBlockHash,
+    },
+    EthereumWeiAmount: {
+        typeOf: 'String',
+        validate: V.ethereum.isValidWeiAmount,
+    },
+    EthereumAddressCode: {
+        typeOf: 'String',
+        validate: V.ethereum.isAddressCode,
+    },
+    MineId: {
+        typeOf: 'String',
+        validate(x) {
+            return x === 'mine';
+        },
+    },
+    BitcoinTxHash: {
+        typeOf: 'String',
+        validate: V.bitcoin.isTxHash,
+    },
+    BitcoinAddressArray: {
+        typeOf: 'Array',
+        validate(as) {
+            return _.every(as, V.bitcoin.isAddress);
+        },
+    },
+    BitcoinTxHashArray: {
+        typeOf: 'Array',
+        validate(as) {
+            return _.every(as, V.bitcoin.isTxHash);
+        },
+    },
+    BitcoinTxHex: {
+        typeOf: 'String',
+        validate: V.bitcoin.isTxHex,
+    },
+    BitcoinScriptHex: {
+        typeOf: 'String',
+        validate: V.bitcoin.isScriptHex,
+    },
+    BitcoinHDPath: {
+        typeOf: 'String',
+        validate: V.bitcoin.isHDPath,
+    },
+    BitcoinPublicKey: {
+        typeOf: 'String',
+        validate: V.bitcoin.isPublicKey,
+    },
+    BitcoinXpub: {
+        typeOf: 'String',
+        validate: V.bitcoin.isHDPublicKey,
+    },
+    BitcoinTxSignature: {
+        typeOf: 'String',
+        validate: V.bitcoin.isTxSignature,
+    },
+    BitcoinBlockHeight: {
+        typeOf: 'Number',
+        validate: V.bitcoin.isBlockHeight,
+    },
 };
-
 // add support for nullable properties
 const withNullable = Object.keys(customTypes).reduce((acc, type) => {
-  acc[type] = customTypes[type];
-  const { typeOf, validate } = customTypes[type];
-
-  // for every type, add Nullable+type. A nullable string can also be empty
-  acc[`Nullable${type}`] = { ...customTypes[type], validate: (x) => x == null || (typeOf === 'String' && x === '') || validate(x) };
-
-  return acc;
+    acc[type] = customTypes[type];
+    const { typeOf, validate } = customTypes[type];
+    // for every type, add Nullable+type. A nullable string can also be empty
+    acc[`Nullable${type}`] = Object.assign(Object.assign({}, customTypes[type]), { validate: (x) => x == null || (typeOf === 'String' && x === '') || validate(x) });
+    return acc;
 }, {});
-
 module.exports = {
-  parseType(str) {
-    return TC.parseType(str);
-  },
-  parsedTypeCheck(type, obj) {
-    return TC.parsedTypeCheck(type, obj, this.opts);
-  },
-  typeCheck(type, obj) {
-    return TC.typeCheck(type, obj, this.opts);
-  },
-  opts: {
-    customTypes: withNullable,
-  },
-  ensureType(type, obj, msg) {
-    return V.ensure(this.typeCheck(type, obj), msg);
-  },
-  checkArg(obj, prop, type, msg) {
-    let message;
-    if (msg == null) {
-      message = `Invalid ${prop}`;
-    } else {
-      message = msg;
-    }
-    this.ensureType(type, obj[prop], message);
-    return obj[prop];
-  },
-  checkArgs(input, types) {
-    const inputKeys = {};
-    const [typ] = types;
-    const fields = typ.of;
-    let numInputKeys = 0;
-    let numKeys;
-
-    Object.keys(input).forEach((k) => {
-      inputKeys[k] = true;
-      numInputKeys += 1;
-    });
-
-    numKeys = 0;
-
-    Object.keys(fields).forEach((key) => {
-      const objTypes = fields[key];
-      V.ensure(this.parsedTypeCheck(objTypes, input[key]), `Invalid ${key}`);
-      if (inputKeys[key]) {
-        numKeys += 1;
-      }
-    });
-
-    if (!(typ.subset || numInputKeys === numKeys)) {
-      throw new E.BadRequest('invalid extra arguments are present');
-    }
-  },
+    parseType(str) {
+        return TC.parseType(str);
+    },
+    parsedTypeCheck(type, obj) {
+        return TC.parsedTypeCheck(type, obj, this.opts);
+    },
+    typeCheck(type, obj) {
+        return TC.typeCheck(type, obj, this.opts);
+    },
+    opts: {
+        customTypes: withNullable,
+    },
+    ensureType(type, obj, msg) {
+        return V.ensure(this.typeCheck(type, obj), msg);
+    },
+    checkArg(obj, prop, type, msg) {
+        let message;
+        if (msg == null) {
+            message = `Invalid ${prop}`;
+        }
+        else {
+            message = msg;
+        }
+        this.ensureType(type, obj[prop], message);
+        return obj[prop];
+    },
+    checkArgs(input, types) {
+        const inputKeys = {};
+        const [typ] = types;
+        const fields = typ.of;
+        let numInputKeys = 0;
+        let numKeys;
+        Object.keys(input).forEach((k) => {
+            inputKeys[k] = true;
+            numInputKeys += 1;
+        });
+        numKeys = 0;
+        Object.keys(fields).forEach((key) => {
+            const objTypes = fields[key];
+            V.ensure(this.parsedTypeCheck(objTypes, input[key]), `Invalid ${key}`);
+            if (inputKeys[key]) {
+                numKeys += 1;
+            }
+        });
+        if (!(typ.subset || numInputKeys === numKeys)) {
+            throw new E.BadRequest('invalid extra arguments are present');
+        }
+    },
 };
+//# sourceMappingURL=types.js.map

package/lib/types/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../libs/aml-utils/lib/types/types.js"],"names":[],"mappings":"AAAA,MAAM,EAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;AAEjC,MAAM,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;AAE5B,MAAM,CAAC,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAEtC,MAAM,CAAC,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;AAEhD,MAAM,WAAW,GAAG;IAClB,OAAO,EAAE;QACP,MAAM,EAAE,QAAQ;QAChB,QAAQ,CAAC,CAAC;YACR,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;KACF;IACD,SAAS,EAAE;QACT,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,KAAK;KAClB;IACD,UAAU,EAAE;QACV,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,SAAS;KACtB;IACD,KAAK,EAAE;QACL,MAAM,EAAE,QAAQ;QAChB,QAAQ,CAAC,CAAC;YACR,OAAO,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,EAAE,CAAC;QAC/C,CAAC;KACF;IACD,KAAK,EAAE;QACL,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,OAAO;KACpB;IACD,IAAI,EAAE;QACJ,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,MAAM;KACnB;IACD,MAAM,EAAE;QACN,MAAM,EAAE,QAAQ;QAChB,QAAQ,CAAC,CAAC;YACR,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QACxB,CAAC;KACF;IACD,IAAI,EAAE;QACJ,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,MAAM;KACnB;IACD,GAAG,EAAE;QACH,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,KAAK;KAClB;IACD,UAAU,EAAE;QACV,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,MAAM;KACnB;IACD,aAAa,EAAE;QACb,MAAM,EAAE,OAAO;QACf,QAAQ,EAAE,CAAC,CAAC,QAAQ;KACrB;IACD,aAAa,EAAE;QACb,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,QAAQ;KACrB;IACD,iBAAiB,EAAE;QACjB,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,mBAAmB;KAChC;IACD,iBAAiB,EAAE;QACjB,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,mBAAmB;KAChC;IACD,cAAc,EAAE;QACd,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS;KAC9B;IACD,eAAe,EAAE;QACf,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS;KAC/B;IACD,UAAU,EAAE;QACV,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ;KAC9B;IACD,iBAAiB,EAAE;QACjB,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW;KACjC;IACD,iBAAiB,EAAE;QACjB,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,gBAAgB;KACtC;IACD,mBAAmB,EAAE;QACnB,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,aAAa;KACnC;IACD,MAAM,EAAE;QACN,MAAM,EAAE,QAAQ;QAChB,QAAQ,CAAC,CAAC;YACR,OAAO,CAAC,KAAK,MAAM,CAAC;QACtB,CAAC;KACF;IACD,aAAa,EAAE;QACb,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ;KAC7B;IACD,mBAAmB,EAAE;QACnB,MAAM,EAAE,OAAO;QACf,QAAQ,CAAC,EAAE;YACT,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC;KACF;IACD,kBAAkB,EAAE;QAClB,MAAM,EAAE,OAAO;QACf,QAAQ,CAAC,EAAE;YACT,OAAO,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;KACF;IACD,YAAY,EAAE;QACZ,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO;KAC5B;IACD,gBAAgB,EAAE;QAChB,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW;KAChC;IACD,aAAa,EAAE;QACb,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ;KAC7B;IACD,gBAAgB,EAAE;QAChB,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW;KAChC;IACD,WAAW,EAAE;QACX,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa;KAClC;IACD,kBAAkB,EAAE;QAClB,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa;KAClC;IACD,kBAAkB,EAAE;QAClB,MAAM,EAAE,QAAQ;QAChB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa;KAClC;CACF,CAAC;AAEF,sCAAsC;AACtC,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;IACjE,GAAG,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAE/C,yEAAyE;IACzE,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,mCAAQ,WAAW,CAAC,IAAI,CAAC,KAAE,QAAQ,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAE,CAAC;IAElI,OAAO,GAAG,CAAC;AACb,CAAC,EAAE,EAAE,CAAC,CAAC;AAEP,MAAM,CAAC,OAAO,GAAG;IACf,SAAS,CAAC,GAAG;QACX,OAAO,EAAE,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IACD,eAAe,CAAC,IAAI,EAAE,GAAG;QACvB,OAAO,EAAE,CAAC,eAAe,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IACD,SAAS,CAAC,IAAI,EAAE,GAAG;QACjB,OAAO,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IACD,IAAI,EAAE;QACJ,WAAW,EAAE,YAAY;KAC1B;IACD,UAAU,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG;QACvB,OAAO,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IACD,QAAQ,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG;QAC3B,IAAI,OAAO,CAAC;QACZ,IAAI,GAAG,IAAI,IAAI,EAAE;YACf,OAAO,GAAG,WAAW,IAAI,EAAE,CAAC;SAC7B;aAAM;YACL,OAAO,GAAG,GAAG,CAAC;SACf;QACD,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAC1C,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IACD,SAAS,CAAC,KAAK,EAAE,KAAK;QACpB,MAAM,SAAS,GAAG,EAAE,CAAC;QACrB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;QACpB,MAAM,MAAM,GAAG,GAAG,CAAC,EAAE,CAAC;QACtB,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,IAAI,OAAO,CAAC;QAEZ,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YAC/B,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;YACpB,YAAY,IAAI,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,CAAC,CAAC;QAEZ,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YAClC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAC7B,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,GAAG,EAAE,CAAC,CAAC;YACvE,IAAI,SAAS,CAAC,GAAG,CAAC,EAAE;gBAClB,OAAO,IAAI,CAAC,CAAC;aACd;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,IAAI,YAAY,KAAK,OAAO,CAAC,EAAE;YAC7C,MAAM,IAAI,CAAC,CAAC,UAAU,CAAC,qCAAqC,CAAC,CAAC;SAC/D;IACH,CAAC;CACF,CAAC","sourcesContent":["const TC = require('type-check');\n\nconst _ = require('lodash');\n\nconst E = require('../errors/errors');\n\nconst V = require('../validations/validations');\n\nconst customTypes = {\n  Integer: {\n    typeOf: 'Number',\n    validate(x) {\n      return x % 1 === 0;\n    },\n  },\n  IntString: {\n    typeOf: 'String',\n    validate: V.isInt,\n  },\n  BoolString: {\n    typeOf: 'String',\n    validate: V.isBoolean,\n  },\n  Hex32: {\n    typeOf: 'String',\n    validate(x) {\n      return V.isHexadecimal(x) && x.length === 32;\n    },\n  },\n  Email: {\n    typeOf: 'String',\n    validate: V.isEmail,\n  },\n  UUID: {\n    typeOf: 'String',\n    validate: V.isUUID,\n  },\n  UUIDv4: {\n    typeOf: 'String',\n    validate(x) {\n      return V.isUUID(x, 4);\n    },\n  },\n  JSON: {\n    typeOf: 'String',\n    validate: V.isJSON,\n  },\n  Url: {\n    typeOf: 'String',\n    validate: V.isURL,\n  },\n  DateString: {\n    typeOf: 'String',\n    validate: V.isDate,\n  },\n  NonEmptyArray: {\n    typeOf: 'Array',\n    validate: V.nonEmpty,\n  },\n  NonNullString: {\n    typeOf: 'String',\n    validate: V.nonEmpty,\n  },\n  CustomerReference: {\n    typeOf: 'String',\n    validate: V.isCustomerReference,\n  },\n  CustomerLabelName: {\n    typeOf: 'String',\n    validate: V.isCustomerLabelName,\n  },\n  BitcoinAddress: {\n    typeOf: 'String',\n    validate: V.bitcoin.isAddress,\n  },\n  EthereumAddress: {\n    typeOf: 'String',\n    validate: V.ethereum.isAddress,\n  },\n  EthereumTx: {\n    typeOf: 'String',\n    validate: V.ethereum.isTxHash,\n  },\n  EthereumBlockHash: {\n    typeOf: 'String',\n    validate: V.ethereum.isBlockHash,\n  },\n  EthereumWeiAmount: {\n    typeOf: 'String',\n    validate: V.ethereum.isValidWeiAmount,\n  },\n  EthereumAddressCode: {\n    typeOf: 'String',\n    validate: V.ethereum.isAddressCode,\n  },\n  MineId: {\n    typeOf: 'String',\n    validate(x) {\n      return x === 'mine';\n    },\n  },\n  BitcoinTxHash: {\n    typeOf: 'String',\n    validate: V.bitcoin.isTxHash,\n  },\n  BitcoinAddressArray: {\n    typeOf: 'Array',\n    validate(as) {\n      return _.every(as, V.bitcoin.isAddress);\n    },\n  },\n  BitcoinTxHashArray: {\n    typeOf: 'Array',\n    validate(as) {\n      return _.every(as, V.bitcoin.isTxHash);\n    },\n  },\n  BitcoinTxHex: {\n    typeOf: 'String',\n    validate: V.bitcoin.isTxHex,\n  },\n  BitcoinScriptHex: {\n    typeOf: 'String',\n    validate: V.bitcoin.isScriptHex,\n  },\n  BitcoinHDPath: {\n    typeOf: 'String',\n    validate: V.bitcoin.isHDPath,\n  },\n  BitcoinPublicKey: {\n    typeOf: 'String',\n    validate: V.bitcoin.isPublicKey,\n  },\n  BitcoinXpub: {\n    typeOf: 'String',\n    validate: V.bitcoin.isHDPublicKey,\n  },\n  BitcoinTxSignature: {\n    typeOf: 'String',\n    validate: V.bitcoin.isTxSignature,\n  },\n  BitcoinBlockHeight: {\n    typeOf: 'Number',\n    validate: V.bitcoin.isBlockHeight,\n  },\n};\n\n// add support for nullable properties\nconst withNullable = Object.keys(customTypes).reduce((acc, type) => {\n  acc[type] = customTypes[type];\n  const { typeOf, validate } = customTypes[type];\n\n  // for every type, add Nullable+type. A nullable string can also be empty\n  acc[`Nullable${type}`] = { ...customTypes[type], validate: (x) => x == null || (typeOf === 'String' && x === '') || validate(x) };\n\n  return acc;\n}, {});\n\nmodule.exports = {\n  parseType(str) {\n    return TC.parseType(str);\n  },\n  parsedTypeCheck(type, obj) {\n    return TC.parsedTypeCheck(type, obj, this.opts);\n  },\n  typeCheck(type, obj) {\n    return TC.typeCheck(type, obj, this.opts);\n  },\n  opts: {\n    customTypes: withNullable,\n  },\n  ensureType(type, obj, msg) {\n    return V.ensure(this.typeCheck(type, obj), msg);\n  },\n  checkArg(obj, prop, type, msg) {\n    let message;\n    if (msg == null) {\n      message = `Invalid ${prop}`;\n    } else {\n      message = msg;\n    }\n    this.ensureType(type, obj[prop], message);\n    return obj[prop];\n  },\n  checkArgs(input, types) {\n    const inputKeys = {};\n    const [typ] = types;\n    const fields = typ.of;\n    let numInputKeys = 0;\n    let numKeys;\n\n    Object.keys(input).forEach((k) => {\n      inputKeys[k] = true;\n      numInputKeys += 1;\n    });\n\n    numKeys = 0;\n\n    Object.keys(fields).forEach((key) => {\n      const objTypes = fields[key];\n      V.ensure(this.parsedTypeCheck(objTypes, input[key]), `Invalid ${key}`);\n      if (inputKeys[key]) {\n        numKeys += 1;\n      }\n    });\n\n    if (!(typ.subset || numInputKeys === numKeys)) {\n      throw new E.BadRequest('invalid extra arguments are present');\n    }\n  },\n};\n"]}