@8ms/helpers 1.1.112 → 1.2.0

package/global/forceUpdate.d.ts

@@ -0,0 +1,8 @@
+declare type ForceUpdate = {
+    key: string;
+};
+/**
+ * Force an update of the cached data
+ */
+declare const forceUpdate: ({ key }: ForceUpdate) => Promise<void>;
+export default forceUpdate;

package/global/forceUpdate.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Force an update of the cached data
+ */
+const forceUpdate = async ({ key }) => {
+    // Doesn't exist
+    if (undefined === global[key] || null === global[key]) {
+        // Throw error - should always exist
+        throw `Global key '${key}' does not exist, requires initialisation.`;
+    }
+    // Reassign the global key
+    else {
+        global[key] = {
+            expires: global[key].expires,
+            insertedAt: Date.now(),
+            updateFn: global[key].updateFn,
+            value: await global[key].updateFn(),
+        };
+    }
+};
+exports.default = forceUpdate;

package/global/init.d.ts

@@ -0,0 +1,10 @@
+declare type Update = {
+    expires: number;
+    key: string;
+    updateFn: Function;
+};
+/**
+ * Initialise a new global data.
+ */
+declare const init: ({ expires, key, updateFn }: Update) => Promise<any>;
+export default init;

package/global/init.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Initialise a new global data.
+ */
+const init = async ({ expires, key, updateFn }) => {
+    global[key] = {
+        expires,
+        insertedAt: Date.now(),
+        updateFn,
+        value: await updateFn(),
+    };
+    return global[key];
+};
+exports.default = init;

package/global/read.d.ts

@@ -0,0 +1,10 @@
+declare type Update = {
+    expires: number;
+    key: string;
+    updateFn: Function;
+};
+/**
+ * Retrieve a value from global memory.
+ */
+declare const read: ({ key }: Update) => Promise<any>;
+export default read;

package/global/read.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const forceUpdate_1 = __importDefault(require("./forceUpdate"));
+/**
+ * Retrieve a value from global memory.
+ */
+const read = async ({ key }) => {
+    // Doesn't exist
+    if (undefined === global[key] || null === global[key]) {
+        // Throw error - should always exist
+        throw `Global key '${key}' does not exist, requires initialisation.`;
+    }
+    // Exists (0 is determined as forever)
+    else if (0 != global[key].expires) {
+        // https://ui.dev/get-current-timestamp-javascript
+        const expiresAt = Math.floor(global[key].insertedAt / 1000) + global[key].expires;
+        const now = Math.floor(Date.now() / 1000);
+        // If we are now beyond the expiry date, update the data
+        if (now > expiresAt) {
+            await (0, forceUpdate_1.default)({ key });
+        }
+    }
+    return global[key];
+};
+exports.default = read;

package/object/replaceKeys.d.ts

@@ -0,0 +1,10 @@
+declare type ReplaceKeys = {
+    instance: any;
+    getNewKey: Function;
+};
+/**
+ * Iteratively replace all the keys in an object.
+ * https://www.techighness.com/post/replace-all-keys-of-deeply-nested-objects-or-array-of-objects/
+ */
+declare const replaceKeys: ({ instance, getNewKey }: ReplaceKeys) => object;
+export default replaceKeys;

package/object/replaceKeys.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Iteratively replace all the keys in an object.
+ * https://www.techighness.com/post/replace-all-keys-of-deeply-nested-objects-or-array-of-objects/
+ */
+const replaceKeys = ({ instance, getNewKey }) => {
+    let response = instance;
+    if (Array.isArray(instance)) {
+        response = [];
+        for (let i = 0; i < instance.length; i++) {
+            response[i] = replaceKeys({
+                instance: instance[i],
+                getNewKey,
+            });
+        }
+    }
+    else if ("object" === typeof instance) {
+        response = {};
+        for (const key in instance) {
+            const newKey = getNewKey(key);
+            response[newKey] = replaceKeys({
+                instance: instance[key],
+                getNewKey,
+            });
+        }
+    }
+    return response;
+};
+exports.default = replaceKeys;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@8ms/helpers",
 	"license": "UNLICENSED",
-	"version": "1.1.112",
+	"version": "1.2.0",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"