instant-cli 0.22.94 → 0.22.95-experimental.surgical.20385805945.1

package/.turbo/turbo-build.log

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

package/__tests__/updateSchemaFile.test.ts

@@ -0,0 +1,149 @@
+import { test, expect } from 'vitest';
+import { i, schemaTypescriptFileToInstantSchema } from '@instantdb/platform';
+import { updateSchemaFile } from '../src/util/updateSchemaFile';
+
+test('preserves type annotations while adding entities', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+import { Label } from './types';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      title: i.string(),
+      status: i.string<'todo' | 'done'>(),
+      labels: i.json<Label[]>(),
+    }),
+  },
+  links: {},
+  rooms: {},
+});
+
+export default _schema;
+`;
+
+  const serverSchema = i.schema({
+    entities: {
+      todos: i.entity({
+        title: i.string(),
+        status: i.string(),
+        labels: i.json(),
+      }),
+      projects: i.entity({
+        name: i.string(),
+      }),
+    },
+    links: {},
+  });
+
+  const localSchema = schemaTypescriptFileToInstantSchema(oldFile);
+  const result = await updateSchemaFile(
+    oldFile,
+    localSchema,
+    serverSchema,
+  );
+
+  expect(result).toContain("status: i.string<'todo' | 'done'>()");
+  expect(result).toContain('labels: i.json<Label[]>()');
+  expect(result).toContain("import { Label } from './types';");
+  expect(result).toContain('projects: i.entity({');
+});
+
+test('removes deleted entities and attributes', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      title: i.string(),
+      priority: i.number(),
+    }),
+    oldEntity: i.entity({
+      data: i.json(),
+    }),
+  },
+  links: {},
+  rooms: {},
+});
+
+export default _schema;
+`;
+
+  const serverSchema = i.schema({
+    entities: {
+      todos: i.entity({
+        title: i.string(),
+      }),
+    },
+    links: {},
+  });
+
+  const localSchema = schemaTypescriptFileToInstantSchema(oldFile);
+  const result = await updateSchemaFile(
+    oldFile,
+    localSchema,
+    serverSchema,
+  );
+
+  expect(result).not.toContain('oldEntity');
+  expect(result).not.toContain('priority: i.number()');
+  expect(result).toContain('title: i.string()');
+});
+
+test('updates constraints and adds links', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      title: i.string(),
+      status: i.string<'todo' | 'done'>(),
+    }),
+    users: i.entity({
+      email: i.string(),
+    }),
+  },
+  links: {},
+  rooms: {},
+});
+
+export default _schema;
+`;
+
+  const serverSchema = i.schema({
+    entities: {
+      todos: i.entity({
+        title: i.string().unique().indexed().optional(),
+        status: i.string(),
+      }),
+      users: i.entity({
+        email: i.string().unique(),
+      }),
+    },
+    links: {
+      todoOwner: {
+        forward: { on: 'todos', has: 'one', label: 'owner' },
+        reverse: { on: 'users', has: 'many', label: 'todos' },
+      },
+    },
+  });
+
+  const localSchema = schemaTypescriptFileToInstantSchema(oldFile);
+  const result = await updateSchemaFile(
+    oldFile,
+    localSchema,
+    serverSchema,
+  );
+
+  expect(result).toContain(
+    'title: i.string().unique().indexed().optional()',
+  );
+  expect(result).toContain("status: i.string<'todo' | 'done'>()");
+  expect(result).toContain('todoOwner: {');
+  expect(result).toContain("on: 'todos'");
+  expect(result).toContain("label: 'owner'");
+  expect(result).toContain("on: 'users'");
+  expect(result).toContain("label: 'todos'");
+});

package/dist/index.d.ts.map

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

package/dist/index.js

@@ -10,7 +10,6 @@ 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';
@@ -38,6 +37,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';
 const execAsync = promisify(exec);
 loadEnv();
 const dev = Boolean(process.env.INSTANT_CLI_DEV);
@@ -353,6 +353,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')
     .description('Pull schema and perm files from production.')
     .addHelpText('after', `
 Environment Variables:
@@ -504,7 +505,7 @@ function handlePull(bag, opts) {
             error('No app ID detected. Please specify one with --app or set up with `instant-cli init`');
             return;
         }
-        yield pull(bag, appId, pkgAndAuthInfo);
+        yield pull(bag, appId, Object.assign(Object.assign({}, pkgAndAuthInfo), opts));
     });
 }
 function push(bag, appId, opts) {
@@ -988,7 +989,7 @@ function getOrPromptPackageAndAuthInfoWithErrorLogging(opts) {
     });
 }
 function pullSchema(appId_1, _a) {
-    return __awaiter(this, arguments, void 0, function* (appId, { pkgDir, instantModuleName }) {
+    return __awaiter(this, arguments, void 0, function* (appId, { pkgDir, instantModuleName, experimentalTypePreservation }) {
         console.log('Pulling schema...');
         const pullRes = yield fetchJson({
             path: `/dash/apps/${appId}/schema/pull`,
@@ -1015,7 +1016,21 @@ function pullSchema(appId_1, _a) {
         }
         const shortSchemaPath = getSchemaPathToWrite(prev === null || prev === void 0 ? void 0 : prev.path);
         const schemaPath = join(pkgDir, shortSchemaPath);
-        yield writeTypescript(schemaPath, generateSchemaTypescriptFile(prev === null || prev === void 0 ? void 0 : prev.schema, apiSchemaToInstantSchemaDef(pullRes.data.schema), instantModuleName), 'utf-8');
+        const serverSchema = apiSchemaToInstantSchemaDef(pullRes.data.schema);
+        let newSchemaContent;
+        if (prev && experimentalTypePreservation) {
+            try {
+                const oldSchemaContent = yield readFile(prev.path, 'utf-8');
+                newSchemaContent = yield updateSchemaFile(oldSchemaContent, prev.schema, serverSchema);
+            }
+            catch (e) {
+                warn('Failed to update 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 };
     });