sliftutils 0.87.0 → 1.0.0

package/builders/dist/generateIndexDts.ts.cache

@@ -71,4 +71,4 @@ function generateIndexDts() {
 }
 generateIndexDts();
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ2VuZXJhdGVJbmRleER0cy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbImdlbmVyYXRlSW5kZXhEdHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLHVDQUF5QjtBQUN6QiwyQ0FBNkI7QUFFN0IsTUFBTSxrQkFBa0IsR0FBRyxDQUFDLGNBQWMsRUFBRSxNQUFNLEVBQUUsU0FBUyxDQUFDLENBQUM7QUFFL0QsU0FBUyxjQUFjLENBQUMsR0FBVyxFQUFFLFdBQXFCLEVBQUU7SUFDeEQsTUFBTSxLQUFLLEdBQUcsRUFBRSxDQUFDLFdBQVcsQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUVsQyxLQUFLLE1BQU0sSUFBSSxJQUFJLEtBQUssRUFBRSxDQUFDO1FBQ3ZCLE1BQU0sUUFBUSxHQUFHLElBQUksQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLElBQUksQ0FBQyxDQUFDO1FBQ3RDLE1BQU0sSUFBSSxHQUFHLEVBQUUsQ0FBQyxRQUFRLENBQUMsUUFBUSxDQUFDLENBQUM7UUFFbkMsSUFBSSxJQUFJLENBQUMsV0FBVyxFQUFFLEVBQUUsQ0FBQztZQUNyQixjQUFjLENBQUMsUUFBUSxFQUFFLFFBQVEsQ0FBQyxDQUFDO1FBQ3ZDLENBQUM7YUFBTSxJQUFJLElBQUksQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQztZQUNoQyxRQUFRLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDO1FBQzVCLENBQUM7SUFDTCxDQUFDO0lBRUQsT0FBTyxRQUFRLENBQUM7QUFDcEIsQ0FBQztBQUVELFNBQVMsZ0JBQWdCO0lBQ3JCLE1BQU0sVUFBVSxHQUFhLEVBQUUsQ0FBQztJQUVoQyxLQUFLLE1BQU0sVUFBVSxJQUFJLGtCQUFrQixFQUFFLENBQUM7UUFDMUMsTUFBTSxVQUFVLEdBQUcsSUFBSSxDQUFDLElBQUksQ0FBQyxTQUFTLEVBQUUsSUFBSSxFQUFFLFVBQVUsQ0FBQyxDQUFDO1FBRTFELElBQUksQ0FBQyxFQUFFLENBQUMsVUFBVSxDQUFDLFVBQVUsQ0FBQyxFQUFFLENBQUM7WUFDN0IsT0FBTyxDQUFDLEdBQUcsQ0FBQyxtQkFBbUIsVUFBVSw4QkFBOEIsQ0FBQyxDQUFDO1lBQ3pFLFNBQVM7UUFDYixDQUFDO1FBRUQsTUFBTSxRQUFRLEdBQUcsY0FBYyxDQUFDLFVBQVUsQ0FBQyxDQUFDO1FBRTVDLE1BQU0sT0FBTyxHQUFHLFFBQVE7YUFDbkIsR0FBRyxDQUFDLFFBQVEsQ0FBQyxFQUFFO1lBQ1osTUFBTSxZQUFZLEdBQUcsSUFBSSxDQUFDLFFBQVEsQ0FBQyxVQUFVLEVBQUUsUUFBUSxDQUFDLENBQUM7WUFDekQsTUFBTSxVQUFVLEdBQUcsWUFBWSxDQUFDLE9BQU8sQ0FBQyxVQUFVLEVBQUUsRUFBRSxDQUFDLENBQUM7WUFDeEQsTUFBTSxVQUFVLEdBQUcsYUFBYSxHQUFHLFVBQVUsR0FBRyxHQUFHLEdBQUcsVUFBVSxDQUFDLE9BQU8sQ0FBQyxLQUFLLEVBQUUsR0FBRyxDQUFDLENBQUM7WUFFckYsTUFBTSxPQUFPLEdBQUcsRUFBRSxDQUFDLFlBQVksQ0FBQyxRQUFRLEVBQUUsTUFBTSxDQUFDLENBQUM7WUFDbEQsTUFBTSxlQUFlLEdBQUcsT0FBTztpQkFDMUIsS0FBSyxDQUFDLElBQUksQ0FBQztpQkFDWCxHQUFHLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLE1BQU0sR0FBRyxJQUFJLENBQUMsQ0FBQyxDQUFDLElBQUksQ0FBQztpQkFDeEMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1lBRWhCLE9BQU8sbUJBQW1CLFVBQVUsUUFBUSxlQUFlLEtBQUssQ0FBQztRQUNyRSxDQUFDLENBQUMsQ0FBQztRQUVQLFVBQVUsQ0FBQyxJQUFJLENBQUMsR0FBRyxPQUFPLENBQUMsQ0FBQztJQUNoQyxDQUFDO0lBRUQsTUFBTSxhQUFhLEdBQUcsVUFBVSxDQUFDLElBQUksRUFBRSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUNyRCxNQUFNLFVBQVUsR0FBRyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBRSxJQUFJLEVBQUUsWUFBWSxDQUFDLENBQUM7SUFDNUQsTUFBTSxNQUFNLEdBQUcsNkZBQTZGLENBQUM7SUFFN0csRUFBRSxDQUFDLGFBQWEsQ0FBQyxVQUFVLEVBQUUsTUFBTSxHQUFHLGFBQWEsR0FBRyxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDcEUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxhQUFhLFVBQVUsU0FBUyxVQUFVLENBQUMsTUFBTSxzQkFBc0IsQ0FBQyxDQUFDO0FBQ3pGLENBQUM7QUFFRCxnQkFBZ0IsRUFBRSxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0ICogYXMgZnMgZnJvbSBcImZzXCI7XG5pbXBvcnQgKiBhcyBwYXRoIGZyb20gXCJwYXRoXCI7XG5cbmNvbnN0IEZPTERFUlNfVE9fSU5DTFVERSA9IFtcInJlbmRlci11dGlsc1wiLCBcIm1pc2NcIiwgXCJzdG9yYWdlXCJdO1xuXG5mdW5jdGlvbiBnZXRBbGxEdHNGaWxlcyhkaXI6IHN0cmluZywgZmlsZUxpc3Q6IHN0cmluZ1tdID0gW10pOiBzdHJpbmdbXSB7XG4gICAgY29uc3QgZmlsZXMgPSBmcy5yZWFkZGlyU3luYyhkaXIpO1xuXG4gICAgZm9yIChjb25zdCBmaWxlIG9mIGZpbGVzKSB7XG4gICAgICAgIGNvbnN0IGZpbGVQYXRoID0gcGF0aC5qb2luKGRpciwgZmlsZSk7XG4gICAgICAgIGNvbnN0IHN0YXQgPSBmcy5zdGF0U3luYyhmaWxlUGF0aCk7XG5cbiAgICAgICAgaWYgKHN0YXQuaXNEaXJlY3RvcnkoKSkge1xuICAgICAgICAgICAgZ2V0QWxsRHRzRmlsZXMoZmlsZVBhdGgsIGZpbGVMaXN0KTtcbiAgICAgICAgfSBlbHNlIGlmIChmaWxlLmVuZHNXaXRoKFwiLmQudHNcIikpIHtcbiAgICAgICAgICAgIGZpbGVMaXN0LnB1c2goZmlsZVBhdGgpO1xuICAgICAgICB9XG4gICAgfVxuXG4gICAgcmV0dXJuIGZpbGVMaXN0O1xufVxuXG5mdW5jdGlvbiBnZW5lcmF0ZUluZGV4RHRzKCkge1xuICAgIGNvbnN0IGFsbE1vZHVsZXM6IHN0cmluZ1tdID0gW107XG5cbiAgICBmb3IgKGNvbnN0IGZvbGRlck5hbWUgb2YgRk9MREVSU19UT19JTkNMVURFKSB7XG4gICAgICAgIGNvbnN0IGZvbGRlclBhdGggPSBwYXRoLmpvaW4oX19kaXJuYW1lLCBcIi4uXCIsIGZvbGRlck5hbWUpO1xuXG4gICAgICAgIGlmICghZnMuZXhpc3RzU3luYyhmb2xkZXJQYXRoKSkge1xuICAgICAgICAgICAgY29uc29sZS5sb2coYFdhcm5pbmc6IEZvbGRlciAke2ZvbGRlck5hbWV9IGRvZXMgbm90IGV4aXN0LCBza2lwcGluZy4uLmApO1xuICAgICAgICAgICAgY29udGludWU7XG4gICAgICAgIH1cblxuICAgICAgICBjb25zdCBkdHNGaWxlcyA9IGdldEFsbER0c0ZpbGVzKGZvbGRlclBhdGgpO1xuXG4gICAgICAgIGNvbnN0IG1vZHVsZXMgPSBkdHNGaWxlc1xuICAgICAgICAgICAgLm1hcChmaWxlUGF0aCA9PiB7XG4gICAgICAgICAgICAgICAgY29uc3QgcmVsYXRpdmVQYXRoID0gcGF0aC5yZWxhdGl2ZShmb2xkZXJQYXRoLCBmaWxlUGF0aCk7XG4gICAgICAgICAgICAgICAgY29uc3Qgd2l0aG91dEV4dCA9IHJlbGF0aXZlUGF0aC5yZXBsYWNlKC9cXC5kXFwudHMkLywgXCJcIik7XG4gICAgICAgICAgICAgICAgY29uc3QgbW9kdWxlUGF0aCA9IFwic2xpZnR1dGlscy9cIiArIGZvbGRlck5hbWUgKyBcIi9cIiArIHdpdGhvdXRFeHQucmVwbGFjZSgvXFxcXC9nLCBcIi9cIik7XG5cbiAgICAgICAgICAgICAgICBjb25zdCBjb250ZW50ID0gZnMucmVhZEZpbGVTeW5jKGZpbGVQYXRoLCBcInV0ZjhcIik7XG4gICAgICAgICAgICAgICAgY29uc3QgaW5kZW50ZWRDb250ZW50ID0gY29udGVudFxuICAgICAgICAgICAgICAgICAgICAuc3BsaXQoXCJcXG5cIilcbiAgICAgICAgICAgICAgICAgICAgLm1hcChsaW5lID0+IGxpbmUgPyBcIiAgICBcIiArIGxpbmUgOiBsaW5lKVxuICAgICAgICAgICAgICAgICAgICAuam9pbihcIlxcblwiKTtcblxuICAgICAgICAgICAgICAgIHJldHVybiBgZGVjbGFyZSBtb2R1bGUgXCIke21vZHVsZVBhdGh9XCIge1xcbiR7aW5kZW50ZWRDb250ZW50fVxcbn1gO1xuICAgICAgICAgICAgfSk7XG5cbiAgICAgICAgYWxsTW9kdWxlcy5wdXNoKC4uLm1vZHVsZXMpO1xuICAgIH1cblxuICAgIGNvbnN0IHNvcnRlZE1vZHVsZXMgPSBhbGxNb2R1bGVzLnNvcnQoKS5qb2luKFwiXFxuXFxuXCIpO1xuICAgIGNvbnN0IG91dHB1dFBhdGggPSBwYXRoLmpvaW4oX19kaXJuYW1lLCBcIi4uXCIsIFwiaW5kZXguZC50c1wiKTtcbiAgICBjb25zdCBoZWFkZXIgPSBgLy8gQXV0by1nZW5lcmF0ZWQgZmlsZS4gRG8gbm90IGVkaXQgbWFudWFsbHkuXFxuLy8gR2VuZXJhdGVkIGJ5OiB5YXJuIGdlbmVyYXRlLWluZGV4LWR0c1xcblxcbmA7XG5cbiAgICBmcy53cml0ZUZpbGVTeW5jKG91dHB1dFBhdGgsIGhlYWRlciArIHNvcnRlZE1vZHVsZXMgKyBcIlxcblwiLCBcInV0ZjhcIik7XG4gICAgY29uc29sZS5sb2coYEdlbmVyYXRlZCAke291dHB1dFBhdGh9IHdpdGggJHthbGxNb2R1bGVzLmxlbmd0aH0gbW9kdWxlIGRlY2xhcmF0aW9uc2ApO1xufVxuXG5nZW5lcmF0ZUluZGV4RHRzKCk7XG5cbiJdfQ==
- /* _JS_SOURCE_HASH = "396b7ba67cc84f07dc98f22fe7d79e8fe6b153ca5bc3146e063afd6fc30913cf"; */
+ /* _JS_SOURCE_HASH = "129340ac8505ab8c53e1c38952975631792aeb44f95f010b20472273dfb343f1"; */

package/builders/setup.ts

@@ -78,7 +78,7 @@ async function main() {
     let packageJsonPath = path.join(targetDir, "package.json");
     if (fs.existsSync(packageJsonPath)) {
         console.log("\nUpdating package.json scripts...");
-        updatePackageJson(packageJsonPath);
+        await updatePackageJson(packageJsonPath);
     } else {
         console.warn("\nNo package.json found in target directory");
     }
@@ -136,7 +136,7 @@ function replaceImports(content: string, importMappings: { [key: string]: string
     return processedLines.join("\n");
 }
 
-function updatePackageJson(packageJsonPath: string) {
+async function updatePackageJson(packageJsonPath: string) {
     let packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
 
     // Read our current package.json to get the type script
@@ -191,8 +191,22 @@ function updatePackageJson(packageJsonPath: string) {
         }
     }
 
+    let needsYarnInstall = false;
+
+    // ALSO, add socket-function, if it doesn't have it already. This fixes intelliSense, for socket-function, which has a lot of useful utilities related to caching.
+    if (!packageJson.dependencies?.["socket-function"]) {
+        packageJson.dependencies = packageJson.dependencies || {};
+        packageJson.dependencies["socket-function"] = "*";
+        needsYarnInstall = true;
+    }
+
     fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, undefined, 4) + "\n", "utf8");
     console.log("  package.json updated");
+
+    if (needsYarnInstall) {
+        console.log("  Needs yarn install");
+        await execSync("yarn install", { cwd: path.dirname(packageJsonPath), stdio: "inherit" });
+    }
 }
 
 main().catch(error => {

package/index.d.ts

@@ -661,7 +661,11 @@ declare module "sliftutils/storage/DiskCollection" {
             cbor?: boolean | undefined;
             noPrompt?: boolean | undefined;
             freeze?: "deep" | "shallow" | undefined;
-            beforeWrite?: ((newValue: T) => void) | undefined;
+            beforeWrite?: ((update: {
+                newValue: T;
+                key: string;
+                collection: DiskCollection<T>;
+            }) => void) | undefined;
         } | undefined);
         transactionStorage: TransactionStorage | undefined;
         initStorage(): Promise<IStorage<T>>;
@@ -985,7 +989,11 @@ declare module "sliftutils/storage/StorageObservable" {
         };
         constructor(storage: IStorage<T>, config?: {
             freeze?: "deep" | "shallow" | undefined;
-            beforeWrite?: ((newValue: T) => void) | undefined;
+            beforeWrite?: ((update: {
+                newValue: T;
+                key: string;
+                collection: StorageSync<T>;
+            }) => void) | undefined;
         } | undefined);
         get(key: string): T | undefined;
         set(key: string, value: T): void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "sliftutils",
-    "version": "0.87.0",
+    "version": "1.0.0",
     "main": "index.js",
     "license": "MIT",
     "files": [
@@ -14,7 +14,7 @@
         "update-types": "yarn emit-dts && yarn generate-index-dts",
         "prepublishOnly": "yarn update-types",
         "run-nodejs": "node ./build-nodejs/server.js",
-        "run-nodejs-dev": "typenode ./nodejs/server.ts",
+        "run-nodejs-dev": "typenode ./nodejs/server.ts --npminstall",
         "run-web": "node ./builders/webRun.js",
         "run-electron": "node ./node_modules/electron/cli.js ./build-electron/electronMain.js",
         "build-nodejs": "node ./builders/nodeJSBuildRun.js",
@@ -48,8 +48,8 @@
         "mobx": "^6.13.3",
         "preact-old-types": "^10.28.1",
         "shell-quote": "^1.8.3",
-        "socket-function": "^0.165.0",
-        "typenode": "^6.0.0",
+        "socket-function": "^1.0.1",
+        "typenode": "*",
         "typesafecss": "*",
         "ws": "^8.18.3",
         "yargs": "15.4.1"

package/storage/DiskCollection.d.ts

@@ -11,7 +11,11 @@ export declare class DiskCollection<T> implements IStorageSync<T> {
         cbor?: boolean | undefined;
         noPrompt?: boolean | undefined;
         freeze?: "deep" | "shallow" | undefined;
-        beforeWrite?: ((newValue: T) => void) | undefined;
+        beforeWrite?: ((update: {
+            newValue: T;
+            key: string;
+            collection: DiskCollection<T>;
+        }) => void) | undefined;
     } | undefined);
     transactionStorage: TransactionStorage | undefined;
     initStorage(): Promise<IStorage<T>>;

package/storage/DiskCollection.ts

@@ -20,7 +20,7 @@ export class DiskCollection<T> implements IStorageSync<T> {
             noPrompt?: boolean;
             freeze?: "shallow" | "deep";
             // May mutate newValue in order to change what will be written
-            beforeWrite?: (newValue: T) => void;
+            beforeWrite?: (update: { newValue: T; key: string; collection: DiskCollection<T> }) => void;
         }
     ) {
     }
@@ -45,7 +45,10 @@ export class DiskCollection<T> implements IStorageSync<T> {
         new PendingStorage(`Collection (${this.collectionName})`,
             new DelayedStorage<T>(this.baseStorage)
         ),
-        this.config
+        {
+            freeze: this.config?.freeze,
+            beforeWrite: this.config?.beforeWrite && ((update) => this.config!.beforeWrite!({ ...update, collection: this })),
+        }
     );
 
     public get(key: string): T | undefined {

package/storage/StorageObservable.d.ts

@@ -13,7 +13,11 @@ export declare class StorageSync<T> implements IStorageSync<T> {
     };
     constructor(storage: IStorage<T>, config?: {
         freeze?: "deep" | "shallow" | undefined;
-        beforeWrite?: ((newValue: T) => void) | undefined;
+        beforeWrite?: ((update: {
+            newValue: T;
+            key: string;
+            collection: StorageSync<T>;
+        }) => void) | undefined;
     } | undefined);
     get(key: string): T | undefined;
     set(key: string, value: T): void;

package/storage/StorageObservable.ts

@@ -14,7 +14,7 @@ export class StorageSync<T> implements IStorageSync<T> {
     constructor(public storage: IStorage<T>, private config?: {
         freeze?: "shallow" | "deep";
         // May mutate newValue in order to change what will be written
-        beforeWrite?: (newValue: T) => void;
+        beforeWrite?: (update: { newValue: T; key: string; collection: StorageSync<T> }) => void;
     }) {
         storage.watchResync?.(async () => {
             // NOTE: If there's multiple tabs open, this'll trigger a lot, so we can't just clear all the values, as that'll cause a render where nothing's loaded. 
@@ -38,7 +38,7 @@ export class StorageSync<T> implements IStorageSync<T> {
     }
     public set(key: string, value: T): void {
         if (this.config?.beforeWrite) {
-            this.config.beforeWrite(value);
+            this.config.beforeWrite({ newValue: value, key, collection: this });
         }
         if (!this.keys.has(key)) {
             this.keys.add(key);

package/yarn.lock

@@ -1494,10 +1494,10 @@ slash@^3.0.0:
   resolved "https://registry.yarnpkg.com/slash/-/slash-3.0.0.tgz#6539be870c165adbd5240220dbe361f1bc4d4634"
   integrity sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==
 
-socket-function@^0.165.0:
-  version "0.165.0"
-  resolved "https://registry.yarnpkg.com/socket-function/-/socket-function-0.165.0.tgz#2c262c5cc75a79233d08538517030c504745a94c"
-  integrity sha512-VfpljEyUEjQD4flTboGwgcerK2vuVvDM0iPNL4L4Qyo76G5DQVGcHCaYDwZuuAJ8gvTXDq9j7P7vgdjElNAhXw==
+socket-function@^1.0.1:
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/socket-function/-/socket-function-1.0.1.tgz#0fb37346c3395661c2c82a00a34908e1e5ed00bc"
+  integrity sha512-qsiDZxYEwLtSoX+/tlSfR5bE6YUNTdV+ccs+swtZFHsTajx3PhWnTvQRdgE2AnSwhtrldv3QOmZJsOTOZKL0/A==
   dependencies:
     "@types/pako" "^2.0.3"
     "@types/ws" "^8.5.3"
@@ -1506,7 +1506,7 @@ socket-function@^0.165.0:
     pako "^2.1.0"
     preact "10.24.3"
     typedev "^0.4.0"
-    typenode "^5.13.0"
+    typenode "^6.0.1"
     ws "^8.17.1"
 
 source-map-js@^0.6.2:
@@ -1617,19 +1617,10 @@ typedev@^0.4.0:
     debugbreak "^0.11.0"
     eslint "^8.18.0"
 
-typenode@^5.13.0:
-  version "5.14.0"
-  resolved "https://registry.yarnpkg.com/typenode/-/typenode-5.14.0.tgz#c5639533b6007ded7c888188457c6b89b3669530"
-  integrity sha512-F42sCiPWoE/3rbJ92Wtcay9Hgp4qG7z6OSEFo4ucPybzn1hxKrsmaIStWSlqdmCwbUecguxPWTrlINErFXzbhA==
-  dependencies:
-    "@types/pegjs" "^0.10.3"
-    source-map-support "https://github.com/7rulnik/node-source-map-support"
-    typescript "5.3.3"
-
-typenode@^6.0.0:
-  version "6.0.0"
-  resolved "https://registry.yarnpkg.com/typenode/-/typenode-6.0.0.tgz#5b59fcf3e7ef3c6cbfae45ceb50e45ec0fa88d5a"
-  integrity sha512-uZmCYbmvGSTuD8inJM1Kf/FahOFpUlwiSumearWLKza+UCwiVT4If/EPEcrcCcGXPZg1yScidK2zWnJ9uZPPZQ==
+typenode@*, typenode@^6.0.1:
+  version "6.0.1"
+  resolved "https://registry.yarnpkg.com/typenode/-/typenode-6.0.1.tgz#bff58967341704babab8e95437f0b9242bd8aeba"
+  integrity sha512-Nvul74JuBeioAZNZaGkLXVuDBNK/fEM+iJGErxPCrZbxpxIvJrXWAk1tW5KVbDZqde7JnC96OC/G7nNphw9fTw==
   dependencies:
     "@types/pegjs" "^0.10.3"
     source-map-support "https://github.com/7rulnik/node-source-map-support"