instant-cli 0.22.95-experimental.surgical.20386947966.1 → 0.22.95

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> instant-cli@0.22.95-experimental.surgical.20386947966.1 build /home/runner/work/instant/instant/client/packages/cli
+> instant-cli@0.22.95 build /home/runner/work/instant/instant/client/packages/cli
 > rm -rf dist; tsc -p tsconfig.json
 

package/__tests__/mergeSchema.test.ts

@@ -0,0 +1,197 @@
+import { describe, test, expect } from 'vitest';
+import { mergeSchema } from '../src/util/mergeSchema';
+
+test('preserves type annotations', () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+import { Label } from './types';
+
+const _schema = i.schema({
+  entities: {
+    $users: i.entity({
+      email: i.string().unique().indexed(),
+    }),
+    todos: i.entity({
+      title: i.string(),
+      status: i.string<'todo' | 'in_progress' | 'done'>(),
+      priority: i.number<1 | 2 | 3>(),
+      labels: i.json<Label[]>().optional(),
+    }),
+    projects: i.entity({
+      name: i.string(),
+    }),
+  },
+  links: {
+    todoProject: {
+      forward: { on: 'todos', has: 'one', label: 'project' },
+      reverse: { on: 'projects', has: 'many', label: 'todos' },
+    },
+    projectOwner: {
+      forward: { on: 'projects', has: 'one', label: 'owner' },
+      reverse: { on: '$users', has: 'many', label: 'projects' },
+    },
+  },
+  rooms: {
+    projectRoom: {
+      presence: i.entity({
+        cursor: i.json<{ x: number; y: number }>(),
+      }),
+    },
+  },
+});
+
+export default _schema;
+`;
+
+  const newFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    $users: i.entity({
+      email: i.string().unique().indexed(),
+    }),
+    todos: i.entity({
+      title: i.string(),
+      status: i.string(),
+      priority: i.number(),
+      labels: i.json().optional(),
+    }),
+    projects: i.entity({
+      name: i.string(),
+    }),
+  },
+  links: {
+    todoProject: {
+      forward: { on: 'todos', has: 'one', label: 'project' },
+      reverse: { on: 'projects', has: 'many', label: 'todos' },
+    },
+    projectOwner: {
+      forward: { on: 'projects', has: 'one', label: 'owner' },
+      reverse: { on: '$users', has: 'many', label: 'projects' },
+    },
+  },
+  rooms: {
+    projectRoom: {
+      presence: i.entity({
+        cursor: i.json(),
+      }),
+    },
+  },
+});
+
+export default _schema;
+`;
+
+  const result = mergeSchema(oldFile, newFile);
+
+  // Type annotations preserved
+  expect(result).toContain("i.string<'todo' | 'in_progress' | 'done'>()");
+  expect(result).toContain('i.number<1 | 2 | 3>()');
+  expect(result).toContain('i.json<Label[]>()');
+  expect(result).toContain('i.json<{ x: number; y: number }>()');
+
+  // Import preserved
+  expect(result).toContain("import { Label } from './types';");
+});
+
+test('preserves different import styles', () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+import { Label } from './types';
+import { Tag as MyTag } from './types';
+import Priority from './Priority';
+import * as Models from './models';
+import type { Meta } from './meta';
+
+const _schema = i.schema({
+  entities: {
+    a: i.entity({ f: i.json<Label>() }),
+    b: i.entity({ f: i.json<MyTag>() }),
+    c: i.entity({ f: i.json<Priority>() }),
+    d: i.entity({ f: i.json<Models.Status>() }),
+    e: i.entity({ f: i.json<Meta>() }),
+  },
+});
+`;
+
+  const newFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    a: i.entity({ f: i.json() }),
+    b: i.entity({ f: i.json() }),
+    c: i.entity({ f: i.json() }),
+    d: i.entity({ f: i.json() }),
+    e: i.entity({ f: i.json() }),
+  },
+});
+`;
+
+  const result = mergeSchema(oldFile, newFile);
+
+  // All import styles preserved (named imports from same module are combined)
+  expect(result).toContain('Label');
+  expect(result).toContain('Tag as MyTag');
+  expect(result).toContain("import Priority from './Priority';");
+  expect(result).toContain("import * as Models from './models';");
+  expect(result).toContain("import type { Meta } from './meta';");
+
+  // Type annotations preserved
+  expect(result).toContain('i.json<Label>()');
+  expect(result).toContain('i.json<MyTag>()');
+  expect(result).toContain('i.json<Priority>()');
+  expect(result).toContain('i.json<Models.Status>()');
+  expect(result).toContain('i.json<Meta>()');
+});
+
+test('handles entity additions and removals', () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+import { Label } from './types';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      labels: i.json<Label[]>(),
+    }),
+    oldEntity: i.entity({
+      data: i.json<{ removed: true }>(),
+    }),
+  },
+});
+`;
+
+  const newFile = `
+import { i } from '@instantdb/core';
+import { Label } from './types';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      labels: i.json(),
+    }),
+    newEntity: i.entity({
+      data: i.json(),
+    }),
+  },
+});
+`;
+
+  const result = mergeSchema(oldFile, newFile);
+
+  // Existing entity type preserved
+  expect(result).toContain('i.json<Label[]>()');
+
+  // Removed entity is gone
+  expect(result).not.toContain('oldEntity');
+
+  // New entity has no type annotation
+  expect(result).toContain('newEntity: i.entity({');
+  expect(result).not.toContain('i.json<{ removed: true }>()');
+
+  // Import not duplicated (was already in newFile)
+  const importMatches = result.match(/import { Label } from '\.\/types';/g);
+  expect(importMatches?.length).toBe(1);
+});

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"AA68DA,8EAQC;AA+ED;;;;;EAKE"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"AAo8DA,8EAQC;AA+ED;;;;;EAKE"}

package/dist/index.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 // @ts-check
 import { generatePermsTypescriptFile, apiSchemaToInstantSchemaDef, generateSchemaTypescriptFile, diffSchemas, convertTxSteps, validateSchema, SchemaValidationError, PlatformApi, } from '@instantdb/platform';
 import version from './version.js';
+import { existsSync } from 'fs';
 import { mkdir, writeFile, readFile, unlink } from 'fs/promises';
 import path, { join } from 'path';
 import { randomUUID } from 'crypto';
@@ -37,7 +38,7 @@ import { buildAutoRenameSelector } from './rename.js';
 import { loadEnv } from './util/loadEnv.js';
 import { isHeadlessEnvironment } from './util/isHeadlessEnvironment.js';
 import { getSchemaReadCandidates, getPermsReadCandidates, getSchemaPathToWrite, getPermsPathToWrite, } from './util/findConfigCandidates.js';
-import { updateSchemaFile } from './util/updateSchemaFile.js';
+import { mergeSchema } from './util/mergeSchema.js';
 const execAsync = promisify(exec);
 loadEnv();
 const dev = Boolean(process.env.INSTANT_CLI_DEV);
@@ -353,7 +354,7 @@ program
     .argument('[schema|perms|all]', 'Which configuration to push. Defaults to `all`')
     .option('-a --app <app-id>', 'App ID to push to. Defaults to *_INSTANT_APP_ID in .env')
     .option('-p --package <react|react-native|core|admin>', 'Which package to automatically install if there is not one installed already.')
-    .option('--experimental-type-preservation', '[Experimental] Preserve manual type changes and schema edits when pulling schema')
+    .option('--experimental-type-preservation', "[Experimental] Preserve manual type changes like `status: i.json<'online' | 'offline'>()` when doing `instant-cli pull schema`")
     .description('Pull schema and perm files from production.')
     .addHelpText('after', `
 Environment Variables:
@@ -1016,20 +1017,16 @@ function pullSchema(appId_1, _a) {
         }
         const shortSchemaPath = getSchemaPathToWrite(prev === null || prev === void 0 ? void 0 : prev.path);
         const schemaPath = join(pkgDir, shortSchemaPath);
-        const serverSchema = apiSchemaToInstantSchemaDef(pullRes.data.schema);
-        let newSchemaContent;
+        let newSchemaContent = generateSchemaTypescriptFile(prev === null || prev === void 0 ? void 0 : prev.schema, apiSchemaToInstantSchemaDef(pullRes.data.schema), instantModuleName);
         if (prev && experimentalTypePreservation) {
             try {
                 const oldSchemaContent = yield readFile(prev.path, 'utf-8');
-                newSchemaContent = yield updateSchemaFile(oldSchemaContent, prev.schema, serverSchema);
+                newSchemaContent = mergeSchema(oldSchemaContent, newSchemaContent);
             }
             catch (e) {
-                warn('Failed to update schema with existing file. Overwriting instead.', e);
+                warn('Failed to merge schema with existing file. Overwriting instead.', e);
             }
         }
-        if (!newSchemaContent) {
-            newSchemaContent = generateSchemaTypescriptFile(prev === null || prev === void 0 ? void 0 : prev.schema, serverSchema, instantModuleName);
-        }
         yield writeTypescript(schemaPath, newSchemaContent, 'utf-8');
         console.log('✅ Wrote schema to ' + shortSchemaPath);
         return { ok: true };