typed-bridge 2.1.3 → 2.1.5

package/dist/bridge/index.js

@@ -91,6 +91,7 @@ const createBridge = (bridge, port, path = '/bridge') => {
         if (shuttingDown)
             return;
         shuttingDown = true;
+        // Server.close waits for all active connections to be completed & stops accepting new connections
         server.close(() => {
             (0, helpers_1.printStopLogs)();
             shutdownCallback();

package/dist/scripts/typedBridgeCleaner.js

@@ -78,9 +78,9 @@ const resolveZodTypesTransformer = context => {
             if (typescript_1.default.isTypeReferenceNode(node) &&
                 typescript_1.default.isQualifiedName(node.typeName) &&
                 typescript_1.default.isIdentifier(node.typeName.left) &&
-                (node.typeName.left.text === 'z' ||
-                    node.typeName.left.text === 'zod' ||
-                    node.typeName.left.text.startsWith('zod_'))) {
+                (/^z(\$\d+)?$/.test(node.typeName.left.text) ||
+                    /^zod(\$\d+)?$/.test(node.typeName.left.text) ||
+                    /^zod_/.test(node.typeName.left.text))) {
                 return { name: node.typeName.right.text, typeArgs: node.typeArguments };
             }
             return null;
@@ -124,6 +124,9 @@ const resolveZodTypesTransformer = context => {
                 return resolveZodType(typeArgs[0]);
             if (name === 'ZodLiteral' && typeArgs && typeArgs.length >= 1)
                 return typeArgs[0];
+            // v4: ZodRecord<ZodString, ZodNumber> -> Record<string, number>
+            if (name === 'ZodRecord' && typeArgs && typeArgs.length >= 2)
+                return typescript_1.default.factory.createTypeReferenceNode('Record', [resolveZodType(typeArgs[0]), resolveZodType(typeArgs[1])]);
             // v4: ZodEnum<{pending: "pending", confirmed: "confirmed", ...}>
             if (name === 'ZodEnum' && typeArgs && typeArgs.length >= 1 && typescript_1.default.isTypeLiteralNode(typeArgs[0])) {
                 const types = [];
@@ -133,6 +136,9 @@ const resolveZodTypesTransformer = context => {
                 }
                 if (types.length > 0)
                     return typescript_1.default.factory.createUnionTypeNode(types);
+                // ZodEnum<{[x: string]: string}> -> string (dynamic enum with index signature)
+                if (typeArgs[0].members.some(m => typescript_1.default.isIndexSignatureDeclaration(m)))
+                    return typescript_1.default.factory.createKeywordTypeNode(typescript_1.default.SyntaxKind.StringKeyword);
             }
             // v4: ZodDiscriminatedUnion<[ZodObject<...>, ...], "disc">
             if (name === 'ZodDiscriminatedUnion' && typeArgs && typeArgs.length >= 1) {
@@ -173,7 +179,7 @@ const resolveZodTypesTransformer = context => {
         for (const stmt of sourceFile.statements) {
             if (typescript_1.default.isImportDeclaration(stmt) &&
                 typescript_1.default.isStringLiteral(stmt.moduleSpecifier) &&
-                (stmt.moduleSpecifier.text === 'zod' || stmt.moduleSpecifier.text.startsWith('zod/'))) {
+                (stmt.moduleSpecifier.text === 'zod' || stmt.moduleSpecifier.text.startsWith('zod/') || stmt.moduleSpecifier.text === 'typed-bridge')) {
                 continue;
             }
             const transformed = typescript_1.default.visitEachChild(stmt, typeVisitor, context);

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "typed-bridge",
     "description": "Strictly typed server functions for typescript apps",
-    "version": "2.1.3",
+    "version": "2.1.5",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "author": "neilveil",
@@ -14,7 +14,7 @@
         "test:cli": "tsx src/scripts/cli.ts gen-typed-bridge-client --src ./src/demo/bridge/index.ts --dest ./test/bridge.ts",
         "test:bridge": "tsx test/index.ts",
         "lint": "eslint",
-        "docs": "cat readme.md docs/* > docs.md"
+        "prepublishOnly": "npm run dist"
     },
     "bin": {
         "typed-bridge": "./dist/scripts/cli.js"

package/docs/auto-bridge-sync.md

@@ -1,56 +0,0 @@
-## Automatically sync bridge file from back-end to front-end
-
-### Step 1: Host the bridge file
-
-```ts
-// Back-end
-
-const app = createBridge(bridge, 8080, '/')
-
-app.use(express.static(path.join(__dirname, 'public')))
-```
-
-### Step 2: Configure generate command to build in public directory
-
-```json
-{
-    "scripts": {
-        "gen-typed-bridge": "typed-bridge gen-typed-bridge --src ./src/bridge/index.ts --dest ./public/bridge.ts"
-    }
-}
-```
-
-### Step 3: Setup typed-bridge types file clone script
-
-[Clone Kit](https://www.npmjs.com/package/clone-kit)
-
-```bash
-npm install clone-kit
-```
-
-Add clone-kit configuration file in front-end project `clone-kit.json`
-
-```json
-{
-    "files": [
-        {
-            "name": "Typed Bridge",
-            "src": "https://www.my-server.com/bridge.ts",
-            "dst": "src/bridge.ts"
-        }
-    ]
-}
-```
-
-### Step 4: Setup clone script to run before project start/build
-
-```json
-{
-    "scripts": {
-        "start": "next start && clone-kit ./clone-kit.json",
-        "build": "next build && clone-kit ./clone-kit.json"
-    }
-}
-```
-
-> It's completely safe to share Typed Bridge types file publicly as it only contains request & response types.