@convertcom/js-sdk-rules 2.0.0 → 2.1.2

package/lib/utils/index.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * Convert JS SDK test
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+export * from './src/array-utils';
+export * from './src/comparisons';
+export * from './src/data-store';
+export * from './src/file-logger';
+export * from './src/http-client';
+export * from './src/object-utils';
+export * from './src/string-utils';
+export * from './src/types-utils';

package/lib/utils/src/array-utils.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/**
+ * Validates variable is array and not empty
+ * @param array
+ */
+export declare function arrayNotEmpty(array: Array<unknown>): boolean;

package/lib/utils/src/comparisons.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/**
+ * Comparison Processor. Provides comparison methods for rules validation
+ */
+export declare class Comparisons {
+    static equals(value: string | number | boolean | Array<string | number | boolean> | Record<string, string | number | boolean>, testAgainst: string | number | boolean, negation?: boolean): boolean;
+    static equalsNumber: typeof Comparisons.equals;
+    static matches: typeof Comparisons.equals;
+    static less(value: string | number, testAgainst: string | number, negation?: boolean): boolean;
+    static lessEqual(value: string | number, testAgainst: string | number, negation?: boolean): boolean;
+    static contains(value: string | number, testAgainst: string | number, negation?: boolean): boolean;
+    static isIn(values: string | number, testAgainst: Array<string | number> | string, negation?: boolean, splitter?: string): boolean;
+    static startsWith(value: string | number, testAgainst: string | number, negation?: boolean): boolean;
+    static endsWith(value: string | number, testAgainst: string | number, negation?: boolean): boolean;
+    static regexMatches(value: string | number, testAgainst: string | number, negation?: boolean): boolean;
+    private static _returnNegationCheck;
+}

package/lib/utils/src/data-store.d.ts

@@ -0,0 +1,39 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/**
+ * Example of Data Store implementation with simple database Based JSON file.
+ * It's not recommended to use it in production as it can be memory and CPU intensive.
+ * @param {string} file
+ * @param {module} fs
+ */
+declare class DataStore {
+    private _file;
+    private _fs;
+    /**
+     * @param {string} file
+     * @param {module} fs
+     */
+    constructor(file: string, fs: any);
+    /**
+     * Get value by key
+     * @param {string} key
+     * @return {any}
+     */
+    get(key: string): any;
+    /**
+     * Store value by key
+     * @param {string} key
+     * @param {any} value
+     */
+    set(key: string, value: any): void;
+    /**
+     * Delete value by key
+     * @param {string} key
+     */
+    delete(key: string): void;
+}
+export { DataStore };

package/lib/utils/src/file-logger.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @param {string} file
+ * @param {module} fs
+ * @param {string=} appendMethod Defaults to 'appendFileSync'
+ * @example new FileLogger('./convert.log', require('fs'), 'appendFileSync')
+ * @constructor
+ */
+declare class FileLogger {
+    private _file;
+    private _fs;
+    private _appendMethod;
+    /**
+     * @param {string} file
+     * @param {module} fs
+     * @param {string=} appendMethod
+     */
+    constructor(file: string, fs: any, appendMethod?: string);
+    private _write;
+    /**
+     * @param {Array<any>} args
+     */
+    log(...args: any): Promise<void>;
+    /**
+     * @param {Array<any>} args
+     */
+    info(...args: any): Promise<void>;
+    /**
+     * @param {Array<any>} args
+     */
+    debug(...args: any): Promise<void>;
+    /**
+     * @param {Array<any>} args
+     */
+    warn(...args: any): Promise<void>;
+    /**
+     * @param {Array<any>} args
+     */
+    error(...args: any): Promise<void>;
+}
+export { FileLogger };

package/lib/utils/src/http-client.d.ts

@@ -0,0 +1,115 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+export type HttpMethod = 'GET' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'POST' | 'PUT' | 'PATCH';
+export type HttpResponseType = 'json' | 'arraybuffer' | 'text';
+export type HttpRequest = {
+    baseURL: string;
+    path?: string;
+    method?: HttpMethod;
+    headers?: {
+        [x: string]: any;
+    };
+    responseType?: HttpResponseType;
+    data?: Record<string, any>;
+};
+declare enum HttpStatusCode {
+    Continue = 100,
+    SwitchingProtocols = 101,
+    Processing = 102,
+    EarlyHints = 103,
+    Ok = 200,
+    Created = 201,
+    Accepted = 202,
+    NonAuthoritativeInformation = 203,
+    NoContent = 204,
+    ResetContent = 205,
+    PartialContent = 206,
+    MultiStatus = 207,
+    AlreadyReported = 208,
+    ImUsed = 226,
+    MultipleChoices = 300,
+    MovedPermanently = 301,
+    Found = 302,
+    SeeOther = 303,
+    NotModified = 304,
+    UseProxy = 305,
+    Unused = 306,
+    TemporaryRedirect = 307,
+    PermanentRedirect = 308,
+    BadRequest = 400,
+    Unauthorized = 401,
+    PaymentRequired = 402,
+    Forbidden = 403,
+    NotFound = 404,
+    MethodNotAllowed = 405,
+    NotAcceptable = 406,
+    ProxyAuthenticationRequired = 407,
+    RequestTimeout = 408,
+    Conflict = 409,
+    Gone = 410,
+    LengthRequired = 411,
+    PreconditionFailed = 412,
+    PayloadTooLarge = 413,
+    UriTooLong = 414,
+    UnsupportedMediaType = 415,
+    RangeNotSatisfiable = 416,
+    ExpectationFailed = 417,
+    ImATeapot = 418,
+    MisdirectedRequest = 421,
+    UnprocessableEntity = 422,
+    Locked = 423,
+    FailedDependency = 424,
+    TooEarly = 425,
+    UpgradeRequired = 426,
+    PreconditionRequired = 428,
+    TooManyRequests = 429,
+    RequestHeaderFieldsTooLarge = 431,
+    UnavailableForLegalReasons = 451,
+    InternalServerError = 500,
+    NotImplemented = 501,
+    BadGateway = 502,
+    ServiceUnavailable = 503,
+    GatewayTimeout = 504,
+    HttpVersionNotSupported = 505,
+    VariantAlsoNegotiates = 506,
+    InsufficientStorage = 507,
+    LoopDetected = 508,
+    NotExtended = 510,
+    NetworkAuthenticationRequired = 511
+}
+export type HttpResponse = {
+    data: any;
+    status: HttpStatusCode;
+    statusText: string;
+    headers?: {
+        [x: string]: any;
+    };
+};
+interface HttpClientInterface {
+    request(config: HttpRequest): Promise<HttpResponse>;
+}
+type RuntimeResult = {
+    runtime: 'browser' | 'server-with-fetch' | 'unknown';
+} | {
+    runtime: 'old-nodejs';
+    url: typeof import('url');
+    http: typeof import('http');
+    https: typeof import('https');
+    queryString: typeof import('querystring');
+};
+export declare const serialize: (params: Record<string, any>, method: string, runtimeResult: RuntimeResult) => string;
+/**
+ * Provide http client for newtork requests
+ * @param {HttpRequest}
+ * @returns {HttpClient}
+ */
+export declare const HttpClient: HttpClientInterface;
+export {};

package/lib/utils/src/object-utils.d.ts

@@ -0,0 +1,35 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/**
+ * Returns the value at path of object
+ * TODO: get this utility to work with the optional mapper() helper from config
+ * @param {Record<string, any>} object
+ * @param {string} path
+ * @param {any=} defaultValue
+ * @param {boolean=} truthy Should Number 0 number and Boolean false be considered as normal value
+ * @return {any}
+ */
+export declare function objectDeepValue(object: Record<string, any>, path: string, defaultValue?: any, truthy?: boolean): any;
+/**
+ * Deep merge objects and their keys and nested objects
+ * Accepts arrays
+ *
+ * @param {...Record<any, any>} objects Objects to merge
+ * @return {Record<any, any>}
+ */
+export declare function objectDeepMerge(...objects: any[]): any;
+/**
+ * Validates variable is object and not empty
+ * @param object
+ */
+export declare function objectNotEmpty(object: any): boolean;
+/**
+ * Compare two objects
+ * @param a
+ * @param b
+ */
+export declare const objectDeepEqual: (a: any, b: any) => boolean;

package/lib/utils/src/string-utils.d.ts

@@ -0,0 +1,32 @@
+/**
+ * String formatter tool. Use %s for string %d for digit and %j for JSON formatting
+ * @param {string} template
+ * @param {Array<string>} args
+ * @return {string}
+ */
+export declare function stringFormat(template: string, ...args: any[]): string;
+/**
+ * String formatter tool. Transforms a space-separated string into camelCase
+ * @param {string} input
+ * @return {string}
+ */
+export declare function camelCase(input: string): string;
+/**
+ * Generate numeric hash based on seed
+ * @param {string} value
+ * @param {number=} seed
+ * @return {number}
+ */
+export declare function generateHash(value: string, seed?: number): number;
+/**
+ * Check if a value is numeric
+ * @param {string | number} value
+ * @returns {boolean}
+ */
+export declare function isNumeric(value: string | number): boolean;
+/**
+ * Convert a string to a number
+ * @param {string | number} value
+ * @returns {number}
+ */
+export declare function toNumber(value: string | number): number;

package/lib/utils/src/types-utils.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Convert JS SDK
+ * Version 1.0.0
+ * Copyright(c) 2020 Convert Insights, Inc
+ * License Apache-2.0
+ */
+/**
+ * Transform value type. Does not do any JSON validation
+ * @param value
+ * @param type
+ */
+export declare function castType(value: any, type: string): any;

package/package.json

@@ -22,8 +22,8 @@
     "clean": "rm -rf lib",
     "prebuild:version": "node -p \"'export const LIB_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'\" > src/version.ts",
     "prebuild": "yarn clean",
-    "build": "rollup -c build.mjs",
-    "lint": "eslint src --ext .ts,.tsx",
+    "build": "rollup -c ../../rollup.config.mjs",
+    "lint": "eslint src",
     "lint:fix": "yarn lint -- --fix",
     "coverage": "nyc report -r cobertura --reporter=text-summary",
     "postcoverage": "istanbul-cobertura-badger -e 85 -g 70 -r coverage/cobertura-coverage.xml -d ./coverage -b coverage"
@@ -32,44 +32,48 @@
     "node": ">=8.0.0"
   },
   "devDependencies": {
-    "@babel/core": "^7.23.2",
-    "@babel/preset-env": "^7.23.2",
+    "@babel/cli": "^7.24.7",
+    "@babel/core": "^7.24.7",
+    "@babel/preset-env": "^7.24.7",
+    "@eslint/eslintrc": "^3.1.0",
     "@rollup/plugin-babel": "^6.0.4",
-    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-commonjs": "^26.0.1",
     "@rollup/plugin-terser": "^0.4.4",
-    "@types/chai": "^4.3.9",
-    "@types/chai-string": "^1.4.4",
-    "@types/mocha": "^10.0.3",
-    "@typescript-eslint/eslint-plugin": "^6.9.0",
-    "@typescript-eslint/parser": "^6.9.0",
+    "@types/chai": "^4.3.16",
+    "@types/chai-string": "^1.4.5",
+    "@types/mocha": "^10.0.6",
+    "@types/node": "20.14.4",
+    "@typescript-eslint/parser": "^7.13.1",
     "assert": "^2.1.0",
-    "babel-cli": "^6.26.0",
-    "babel-preset-es2015": "^6.24.1",
     "chai": "^4.3.10",
     "chai-string": "^1.5.0",
-    "dotenv": "^16.3.1",
-    "eslint": "^8.52.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-jasmine": "^4.1.3",
-    "eslint-plugin-local-rules": "^2.0.0",
-    "eslint-plugin-mocha": "^10.2.0",
-    "eslint-plugin-prettier": "^5.0.1",
+    "dotenv": "^16.4.5",
+    "eslint": "^9.5.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jasmine": "^4.2.0",
+    "eslint-plugin-local-rules": "^2.0.1",
+    "eslint-plugin-mocha": "^10.4.3",
+    "eslint-plugin-prettier": "^5.1.3",
     "istanbul-cobertura-badger": "^1.3.1",
-    "mocha": "^10.2.0",
-    "nyc": "^15.1.0",
-    "prettier": "^3.0.3",
-    "require": "^2.4.20",
-    "rollup": "^3.20.2",
-    "rollup-plugin-dts": "^6.1.0",
+    "mocha": "^10.4.0",
+    "nyc": "^17.0.0",
+    "prettier": "^3.3.2",
+    "rollup": "^4.18.0",
     "rollup-plugin-generate-package-json": "^3.2.0",
     "rollup-plugin-modify": "^3.0.0",
     "rollup-plugin-typescript2": "^0.36.0",
-    "ts-node": "^10.9.1",
+    "ts-node": "^10.9.2",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typescript": "^5.2.2",
-    "typings": "^2.1.1",
-    "webpack": "^5.89.0"
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^7.13.1",
+    "webpack": "^5.92.0"
   },
-  "version": "2.0.0"
-}
+  "version": "2.1.2",
+  "peerDependencies": {
+    "@convertcom/js-sdk-enums": ">=2.2.1",
+    "@convertcom/js-sdk-logger": ">=2.1.1",
+    "@convertcom/js-sdk-types": ">=3.8.1",
+    "@convertcom/js-sdk-utils": ">=2.2.2"
+  }
+}