@deenruv/common 1.0.0

package/lib/shared-utils.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGraphQlInputName = exports.generateAllCombinations = exports.summate = exports.isClassInstance = exports.isObject = exports.assertNever = exports.notNullOrUndefined = void 0;
+/**
+ * Predicate with type guard, used to filter out null or undefined values
+ * in a filter operation.
+ */
+function notNullOrUndefined(val) {
+    return val !== undefined && val !== null;
+}
+exports.notNullOrUndefined = notNullOrUndefined;
+/**
+ * Used in exhaustiveness checks to assert a codepath should never be reached.
+ */
+function assertNever(value) {
+    throw new Error(`Expected never, got ${typeof value} (${JSON.stringify(value)})`);
+}
+exports.assertNever = assertNever;
+/**
+ * Simple object check.
+ * From https://stackoverflow.com/a/34749873/772859
+ */
+function isObject(item) {
+    return item && typeof item === "object" && !Array.isArray(item);
+}
+exports.isObject = isObject;
+function isClassInstance(item) {
+    // Even if item is an object, it might not have a constructor as in the
+    // case when it is a null-prototype object, i.e. created using `Object.create(null)`.
+    return (isObject(item) && item.constructor && item.constructor.name !== "Object");
+}
+exports.isClassInstance = isClassInstance;
+/**
+ * Adds up all the values of a given numeric property of a list of objects.
+ */
+function summate(items, prop) {
+    return (items || []).reduce((sum, i) => sum + i[prop], 0);
+}
+exports.summate = summate;
+/**
+ * Given an array of option arrays `[['red, 'blue'], ['small', 'large']]`, this method returns a new array
+ * containing all the combinations of those options:
+ *
+ * @example
+ * ```
+ * generateAllCombinations([['red, 'blue'], ['small', 'large']]);
+ * // =>
+ * // [
+ * //  ['red', 'small'],
+ * //  ['red', 'large'],
+ * //  ['blue', 'small'],
+ * //  ['blue', 'large'],
+ * // ]
+ */
+function generateAllCombinations(optionGroups, combination = [], k = 0, output = []) {
+    if (k === 0) {
+        optionGroups = optionGroups.filter((g) => 0 < g.length);
+    }
+    if (k === optionGroups.length) {
+        output.push(combination);
+        return [];
+    }
+    else {
+        for (let i = 0; i < optionGroups[k].length; i++) {
+            generateAllCombinations(optionGroups, combination.concat(optionGroups[k][i]), k + 1, output);
+        }
+        return output;
+    }
+}
+exports.generateAllCombinations = generateAllCombinations;
+/**
+ * @description
+ * Returns the input field name of a custom field, taking into account that "relation" type custom
+ * field inputs are suffixed with "Id" or "Ids".
+ */
+function getGraphQlInputName(config) {
+    if (config.type === "relation") {
+        return config.list === true ? `${config.name}Ids` : `${config.name}Id`;
+    }
+    else {
+        return config.name;
+    }
+}
+exports.getGraphQlInputName = getGraphQlInputName;
+//# sourceMappingURL=shared-utils.js.map

package/lib/shared-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared-utils.js","sourceRoot":"","sources":["../src/shared-utils.ts"],"names":[],"mappings":";;;AAEA;;;GAGG;AACH,SAAgB,kBAAkB,CAAI,GAAyB;IAC7D,OAAO,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,CAAC;AAC3C,CAAC;AAFD,gDAEC;AAED;;GAEG;AACH,SAAgB,WAAW,CAAC,KAAY;IACtC,MAAM,IAAI,KAAK,CACb,uBAAuB,OAAO,KAAK,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CACjE,CAAC;AACJ,CAAC;AAJD,kCAIC;AAED;;;GAGG;AACH,SAAgB,QAAQ,CAAC,IAAS;IAChC,OAAO,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAClE,CAAC;AAFD,4BAEC;AAED,SAAgB,eAAe,CAAC,IAAS;IACvC,uEAAuE;IACvE,qFAAqF;IACrF,OAAO,CACL,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,IAAI,KAAK,QAAQ,CACzE,CAAC;AACJ,CAAC;AAND,0CAMC;AAoBD;;GAEG;AACH,SAAgB,OAAO,CACrB,KAA6B,EAC7B,IAA2B;IAE3B,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,CACzB,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAI,CAAC,CAAC,IAAI,CAAuB,EAChD,CAAC,CACF,CAAC;AACJ,CAAC;AARD,0BAQC;AAED;;;;;;;;;;;;;;GAcG;AACH,SAAgB,uBAAuB,CACrC,YAAmB,EACnB,cAAmB,EAAE,EACrB,IAAY,CAAC,EACb,SAAgB,EAAE;IAElB,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACZ,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,CAAC,KAAK,YAAY,CAAC,MAAM,EAAE,CAAC;QAC9B,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzB,OAAO,EAAE,CAAC;IACZ,CAAC;SAAM,CAAC;QACN,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAChD,uBAAuB,CACrB,YAAY,EACZ,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACtC,CAAC,GAAG,CAAC,EACL,MAAM,CACP,CAAC;QACJ,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;AACH,CAAC;AAxBD,0DAwBC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAAC,MAInC;IACC,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,IAAI,CAAC;IACzE,CAAC;SAAM,CAAC;QACN,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;AACH,CAAC;AAVD,kDAUC"}

package/lib/simple-deep-clone.d.ts

@@ -0,0 +1,5 @@
+/**
+ * An extremely fast function for deep-cloning an object which only contains simple
+ * values, i.e. primitives, arrays and nested simple objects.
+ */
+export declare function simpleDeepClone<T extends string | number | any[] | object>(input: T): T;

package/lib/simple-deep-clone.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.simpleDeepClone = void 0;
+const shared_utils_1 = require("./shared-utils");
+/**
+ * An extremely fast function for deep-cloning an object which only contains simple
+ * values, i.e. primitives, arrays and nested simple objects.
+ */
+function simpleDeepClone(input) {
+    // if not array or object or is null return self
+    if (typeof input !== "object" || input === null) {
+        return input;
+    }
+    let output;
+    let i;
+    // handle case: array
+    if (input instanceof Array) {
+        let l;
+        output = [];
+        for (i = 0, l = input.length; i < l; i++) {
+            output[i] = simpleDeepClone(input[i]);
+        }
+        return output;
+    }
+    if ((0, shared_utils_1.isClassInstance)(input)) {
+        return input;
+    }
+    // handle case: object
+    output = {};
+    for (i in input) {
+        if (input.hasOwnProperty(i)) {
+            output[i] = simpleDeepClone(input[i]);
+        }
+    }
+    return output;
+}
+exports.simpleDeepClone = simpleDeepClone;
+//# sourceMappingURL=simple-deep-clone.js.map

package/lib/simple-deep-clone.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"simple-deep-clone.js","sourceRoot":"","sources":["../src/simple-deep-clone.ts"],"names":[],"mappings":";;;AAAA,iDAAiD;AAEjD;;;GAGG;AACH,SAAgB,eAAe,CAC7B,KAAQ;IAER,gDAAgD;IAChD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,MAAW,CAAC;IAChB,IAAI,CAAkB,CAAC;IACvB,qBAAqB;IACrB,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,IAAI,CAAC,CAAC;QACN,MAAM,GAAG,EAAW,CAAC;QACrB,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,MAAM,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,IAAI,IAAA,8BAAe,EAAC,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,sBAAsB;IACtB,MAAM,GAAG,EAAE,CAAC;IACZ,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC;QAChB,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC;YAC5B,MAAM,CAAC,CAAC,CAAC,GAAG,eAAe,CAAE,KAAa,CAAC,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AA7BD,0CA6BC"}

package/lib/unique.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @description
+ * Returns an array with only unique values. Objects are compared by reference,
+ * unless the `byKey` argument is supplied, in which case matching properties will
+ * be used to check duplicates
+ */
+export declare function unique<T>(arr: T[], byKey?: keyof T): T[];

package/lib/unique.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unique = void 0;
+/**
+ * @description
+ * Returns an array with only unique values. Objects are compared by reference,
+ * unless the `byKey` argument is supplied, in which case matching properties will
+ * be used to check duplicates
+ */
+function unique(arr, byKey) {
+    if (byKey == null) {
+        return Array.from(new Set(arr));
+    }
+    else {
+        // Based on https://stackoverflow.com/a/58429784/772859
+        return [...new Map(arr.map((item) => [item[byKey], item])).values()];
+    }
+}
+exports.unique = unique;
+//# sourceMappingURL=unique.js.map

package/lib/unique.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"unique.js","sourceRoot":"","sources":["../src/unique.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,SAAgB,MAAM,CAAI,GAAQ,EAAE,KAAe;IACjD,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,uDAAuD;QACvD,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACvE,CAAC;AACH,CAAC;AAPD,wBAOC"}

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@deenruv/common",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "homepage": "https://deenruv.com/",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "devDependencies": {
+    "rimraf": "^5.0.5",
+    "typescript": "5.3.3"
+  },
+  "scripts": {
+    "watch": "tsc -p ./tsconfig.build.json -w",
+    "build": "rimraf lib && tsc -p ./tsconfig.build.json",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "test": "vitest --run",
+    "ci": "npm run build"
+  }
+}