sliftutils 0.9.0 → 0.10.0

package/.cursorrules

@@ -1,5 +1,7 @@
 The code automatically updates on save, so do not ever run commands to rerun the site.
 
+Don't run shell commands when you need to create or move small code files. You should use tool calls to do this. You should also use tool calls to make files within folders. You don't need to make the folder, just make the file. The folder will automatically be created.
+
 We use MobX for state management. Components should use a variable called synced that is an observable for their state, and never Component.state. All components need the @observer decorator. For example:
     import preact from "preact";
     import { observable } from "mobx";

package/builders/generateIndexDts.ts

@@ -0,0 +1,63 @@
+import * as fs from "fs";
+import * as path from "path";
+
+const FOLDERS_TO_INCLUDE = ["render-utils", "misc"];
+
+function getAllDtsFiles(dir: string, fileList: string[] = []): string[] {
+    const files = fs.readdirSync(dir);
+
+    for (const file of files) {
+        const filePath = path.join(dir, file);
+        const stat = fs.statSync(filePath);
+
+        if (stat.isDirectory()) {
+            getAllDtsFiles(filePath, fileList);
+        } else if (file.endsWith(".d.ts")) {
+            fileList.push(filePath);
+        }
+    }
+
+    return fileList;
+}
+
+function generateIndexDts() {
+    const allModules: string[] = [];
+
+    for (const folderName of FOLDERS_TO_INCLUDE) {
+        const folderPath = path.join(__dirname, "..", folderName);
+
+        if (!fs.existsSync(folderPath)) {
+            console.log(`Warning: Folder ${folderName} does not exist, skipping...`);
+            continue;
+        }
+
+        const dtsFiles = getAllDtsFiles(folderPath);
+
+        const modules = dtsFiles
+            .map(filePath => {
+                const relativePath = path.relative(folderPath, filePath);
+                const withoutExt = relativePath.replace(/\.d\.ts$/, "");
+                const modulePath = "sliftutils/" + folderName + "/" + withoutExt.replace(/\\/g, "/");
+
+                const content = fs.readFileSync(filePath, "utf8");
+                const indentedContent = content
+                    .split("\n")
+                    .map(line => line ? "    " + line : line)
+                    .join("\n");
+
+                return `declare module "${modulePath}" {\n${indentedContent}\n}`;
+            });
+
+        allModules.push(...modules);
+    }
+
+    const sortedModules = allModules.sort().join("\n\n");
+    const outputPath = path.join(__dirname, "..", "index.d.ts");
+    const header = `// Auto-generated file. Do not edit manually.\n// Generated by: yarn generate-index-dts\n\n`;
+
+    fs.writeFileSync(outputPath, header + sortedModules + "\n", "utf8");
+    console.log(`Generated ${outputPath} with ${allModules.length} module declarations`);
+}
+
+generateIndexDts();
+

package/index.d.ts

@@ -1,6 +1,51 @@
 // Auto-generated file. Do not edit manually.
 // Generated by: yarn generate-index-dts
 
+declare module "sliftutils/misc/environment" {
+    /// <reference types="chrome" />
+    export declare function isInChromeExtension(): string | false;
+    export declare function isInChromeExtensionBackground(): boolean;
+    export declare function isInChromeExtensionContentScript(): boolean | "";
+    export declare function isInElectron(): string | false | undefined;
+    export declare function triggerIsInBuild(): void;
+    export declare function isInBuild(): boolean;
+    export declare function isInBrowser(): boolean;
+
+}
+
+declare module "sliftutils/misc/fs" {
+    export declare function getAllFiles(folder: string): AsyncIterableIterator<string>;
+
+}
+
+declare module "sliftutils/misc/getSecret" {
+    export declare const getSecret: {
+        (key: string): Promise<string>;
+        clear(key: string): void;
+        clearAll(): void;
+        forceSet(key: string, value: Promise<string>): void;
+        getAllKeys(): string[];
+        get(key: string): Promise<string> | undefined;
+    };
+
+}
+
+declare module "sliftutils/misc/types" {
+    export declare function isDefined<T>(value: T | undefined | null): value is T;
+
+}
+
+declare module "sliftutils/misc/zip" {
+    /// <reference types="node" />
+    /// <reference types="node" />
+    export declare class Zip {
+        static gzip(buffer: Buffer, level?: number): Promise<Buffer>;
+        static gunzip(buffer: Buffer): Promise<Buffer>;
+        static gunzipBatch(buffers: Buffer[]): Promise<Buffer[]>;
+    }
+
+}
+
 declare module "sliftutils/render-utils/DropdownCustom" {
     import preact from "preact";
     import { LengthOrPercentage } from "typesafecss/cssTypes";
@@ -182,6 +227,7 @@ declare module "sliftutils/render-utils/LocalStorageParam" {
 }
 
 declare module "sliftutils/render-utils/SyncedController" {
+    /// <reference types="socket-function" />
     import { SocketRegistered } from "socket-function/SocketFunctionTypes";
     type RemapFunction<T> = T extends (...args: infer Args) => Promise<infer Return> ? {
         (...args: Args): Return | undefined;

package/misc/environment.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="chrome" />
+export declare function isInChromeExtension(): string | false;
+export declare function isInChromeExtensionBackground(): boolean;
+export declare function isInChromeExtensionContentScript(): boolean | "";
+export declare function isInElectron(): string | false | undefined;
+export declare function triggerIsInBuild(): void;
+export declare function isInBuild(): boolean;
+export declare function isInBrowser(): boolean;

package/misc/fs.d.ts

@@ -0,0 +1 @@
+export declare function getAllFiles(folder: string): AsyncIterableIterator<string>;

package/misc/getSecret.d.ts

@@ -0,0 +1,8 @@
+export declare const getSecret: {
+    (key: string): Promise<string>;
+    clear(key: string): void;
+    clearAll(): void;
+    forceSet(key: string, value: Promise<string>): void;
+    getAllKeys(): string[];
+    get(key: string): Promise<string> | undefined;
+};

package/misc/getSecret.ts

@@ -1,8 +1,4 @@
 
-// Ex, sms.json.id => os.homedir() + "/sms.json", then read key "id"
-//  - As in, we expect .json, and use that to determine the path vs key.
-//  - If there is no .json, we just assume the entire key is the path (still os.homedir()), and return the entire file.
-
 import { cache } from "socket-function/src/caching";
 import os from "os";
 import fs from "fs";

package/misc/types.d.ts

@@ -0,0 +1 @@
+export declare function isDefined<T>(value: T | undefined | null): value is T;

package/misc/zip.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+/// <reference types="node" />
+export declare class Zip {
+    static gzip(buffer: Buffer, level?: number): Promise<Buffer>;
+    static gunzip(buffer: Buffer): Promise<Buffer>;
+    static gunzipBatch(buffers: Buffer[]): Promise<Buffer[]>;
+}

package/package.json

@@ -1,12 +1,13 @@
 {
     "name": "sliftutils",
-    "version": "0.9.0",
+    "version": "0.10.0",
     "main": "index.js",
     "license": "MIT",
     "scripts": {
         "type": "yarn tsc --noEmit",
-        "emit-dts": "yarn tsc --project tsconfig.declarations.json",
-        "generate-index-dts": "node ./builders/generateIndexDts.js",
+        "update-types": "yarn emit-dts && yarn generate-index-dts",
+        "emit-dts": "yarn tsc --project tsconfig.declarations.json || true",
+        "generate-index-dts": "typenode ./builders/generateIndexDts.ts",
         "run-nodejs": "node ./build-nodejs/server.js",
         "run-nodejs-dev": "typenode ./nodejs/server.ts",
         "run-web": "node ./builders/webRun.js",

package/render-utils/SyncedController.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="socket-function" />
 import { SocketRegistered } from "socket-function/SocketFunctionTypes";
 type RemapFunction<T> = T extends (...args: infer Args) => Promise<infer Return> ? {
     (...args: Args): Return | undefined;

package/tsconfig.declarations.json

@@ -8,7 +8,9 @@
     },
     "include": [
         "render-utils/**/*.ts",
-        "render-utils/**/*.tsx"
+        "render-utils/**/*.tsx",
+        "misc/**/*.ts",
+        "misc/**/*.tsx"
     ],
     "exclude": [
         "node_modules",

package/builders/generateIndexDts.js

@@ -1,50 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-
-function getAllDtsFiles(dir, fileList = []) {
-    const files = fs.readdirSync(dir);
-
-    for (const file of files) {
-        const filePath = path.join(dir, file);
-        const stat = fs.statSync(filePath);
-
-        if (stat.isDirectory()) {
-            getAllDtsFiles(filePath, fileList);
-        } else if (file.endsWith(".d.ts")) {
-            fileList.push(filePath);
-        }
-    }
-
-    return fileList;
-}
-
-function generateIndexDts() {
-    const renderUtilsPath = path.join(__dirname, "..", "render-utils");
-    const dtsFiles = getAllDtsFiles(renderUtilsPath);
-
-    const modules = dtsFiles
-        .map(filePath => {
-            const relativePath = path.relative(renderUtilsPath, filePath);
-            const withoutExt = relativePath.replace(/\.d\.ts$/, "");
-            const modulePath = "sliftutils/render-utils/" + withoutExt.replace(/\\/g, "/");
-
-            const content = fs.readFileSync(filePath, "utf8");
-            const indentedContent = content
-                .split("\n")
-                .map(line => line ? "    " + line : line)
-                .join("\n");
-
-            return `declare module "${modulePath}" {\n${indentedContent}\n}`;
-        })
-        .sort()
-        .join("\n\n");
-
-    const outputPath = path.join(__dirname, "..", "index.d.ts");
-    const header = `// Auto-generated file. Do not edit manually.\n// Generated by: yarn generate-index-dts\n\n`;
-
-    fs.writeFileSync(outputPath, header + modules + "\n", "utf8");
-    console.log(`Generated ${outputPath} with ${dtsFiles.length} module declarations`);
-}
-
-generateIndexDts();
-