sliftutils 0.87.0 → 0.88.0

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": "0.88.0",
     "main": "index.js",
     "license": "MIT",
     "files": [

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);