instant-cli 0.22.96-experimental.drewh-ts-target.20761590091.1 → 0.22.96-experimental.surgical.20765817844.1

package/__tests__/updateSchemaFile.test.ts

@@ -0,0 +1,557 @@
+import { test, expect } from 'vitest';
+import {
+  diffSchemas,
+  i,
+  schemaTypescriptFileToInstantSchema,
+} from '@instantdb/platform';
+import { updateSchemaFile } from '../src/util/updateSchemaFile';
+
+test('throws when schema call is missing', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+export const nope = 1;
+`;
+  const schema = i.schema({
+    entities: { todos: i.entity({ title: i.string() }) },
+    links: {},
+  });
+  await expect(updateSchemaFile(oldFile, schema, schema)).rejects.toThrow(
+    'Could not find i.schema',
+  );
+});
+
+test('throws when entities object is missing', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  links: {},
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const schema = i.schema({
+    entities: { todos: i.entity({ title: i.string() }) },
+    links: {},
+  });
+  await expect(updateSchemaFile(oldFile, schema, schema)).rejects.toThrow(
+    'entities object',
+  );
+});
+
+test('throws when links object is missing', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      title: i.string(),
+    }),
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const schema = i.schema({
+    entities: { todos: i.entity({ title: i.string() }) },
+    links: {},
+  });
+  await expect(updateSchemaFile(oldFile, schema, schema)).rejects.toThrow(
+    'links object',
+  );
+});
+
+test('preserves type params across chained calls', 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'>().optional().indexed(),
+      labels: i.json<Label[]>(),
+    }),
+    users: i.entity({
+      email: i.string(),
+    }),
+  },
+  links: {
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const serverSchema = i.schema({
+    entities: {
+      todos: i.entity({
+        title: i.string(),
+        status: i.string().unique().indexed(),
+        labels: i.json(),
+        metadata: i.json(),
+      }),
+      users: i.entity({
+        email: i.string().unique(),
+      }),
+    },
+    links: {},
+  });
+
+  const result = await update(oldFile, serverSchema);
+
+  expect(result).toMatchSnapshot();
+});
+
+test('drops constraints removed by server', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      title: i.string().unique().indexed().optional(),
+      done: i.boolean().optional(),
+    }),
+  },
+  links: {
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const serverSchema = i.schema({
+    entities: {
+      todos: i.entity({
+        title: i.string(),
+        done: i.boolean().optional(),
+      }),
+    },
+    links: {},
+  });
+
+  const result = await update(oldFile, serverSchema);
+
+  expect(result).toMatchSnapshot();
+});
+
+test('updates link details', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      title: i.string(),
+    }),
+    users: i.entity({
+      email: i.string(),
+    }),
+  },
+  links: {
+    todoOwner: {
+      forward: { on: 'todos', has: 'one', label: 'owner' },
+      reverse: { on: 'users', has: 'many', label: 'todos' },
+    },
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const serverSchema = i.schema({
+    entities: {
+      todos: i.entity({ title: i.string() }),
+      users: i.entity({ email: i.string() }),
+    },
+    links: {
+      todoOwner: {
+        forward: {
+          on: 'todos',
+          has: 'one',
+          label: 'owner',
+          required: true,
+          onDelete: 'cascade',
+        },
+        reverse: {
+          on: 'users',
+          has: 'many',
+          label: 'todos',
+          onDelete: 'cascade',
+        },
+      },
+    },
+  });
+
+  const result = await update(oldFile, serverSchema);
+
+  expect(result).toMatchSnapshot();
+});
+
+test('removes a link with surrounding comments and commas', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      title: i.string(),
+    }),
+    users: i.entity({
+      email: i.string(),
+    }),
+    projects: i.entity({
+      name: i.string(),
+    }),
+  },
+  links: {
+    // owner link
+    todoOwner: {
+      forward: { on: 'todos', has: 'one', label: 'owner' },
+      reverse: { on: 'users', has: 'many', label: 'todos' },
+    },
+    /* project link */
+    projectTodos: {
+      forward: { on: 'projects', has: 'many', label: 'todos' },
+      reverse: { on: 'todos', has: 'one', label: 'project' },
+    },
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const serverSchema = i.schema({
+    entities: {
+      todos: i.entity({ title: i.string() }),
+      users: i.entity({ email: i.string() }),
+      projects: i.entity({ name: i.string() }),
+    },
+    links: {
+      projectTodos: {
+        forward: { on: 'projects', has: 'many', label: 'todos' },
+        reverse: { on: 'todos', has: 'one', label: 'project' },
+      },
+    },
+  });
+
+  const result = await update(oldFile, serverSchema);
+
+  expect(result).toMatchSnapshot();
+});
+
+test('updates single-line entity in place', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    projects: i.entity({ name: i.string() }),
+    todos: i.entity({
+      title: i.string(),
+    }),
+  },
+  links: {
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const serverSchema = i.schema({
+    entities: {
+      projects: i.entity({
+        name: i.string(),
+        status: i.string(),
+      }),
+      todos: i.entity({
+        title: i.string(),
+      }),
+    },
+    links: {},
+  });
+
+  const result = await update(oldFile, serverSchema);
+
+  expect(result).toMatchSnapshot();
+});
+
+test('adds multiple attrs to a single-line entity', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    projects: i.entity({ name: i.string() }),
+  },
+  links: {
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const serverSchema = i.schema({
+    entities: {
+      projects: i.entity({
+        name: i.string(),
+        status: i.string(),
+        priority: i.number(),
+      }),
+    },
+    links: {},
+  });
+
+  const result = await update(oldFile, serverSchema);
+
+  await expectNoDiff(result, serverSchema);
+});
+
+test('inserts attrs into multi-line entities with indentation', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      title: i.string(),
+      done: i.boolean().optional(),
+    }),
+  },
+  links: {
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const serverSchema = i.schema({
+    entities: {
+      todos: i.entity({
+        title: i.string(),
+        done: i.boolean().optional(),
+        priority: i.number(),
+      }),
+    },
+    links: {},
+  });
+
+  const result = await update(oldFile, serverSchema);
+
+  expect(result).toMatchSnapshot();
+});
+
+test('adds and updates attrs in a single-line entity', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    projects: i.entity({ name: i.string().optional(), code: i.string() }),
+  },
+  links: {
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const serverSchema = i.schema({
+    entities: {
+      projects: i.entity({
+        name: i.string(),
+        code: i.string().unique(),
+        status: i.string(),
+        priority: i.number(),
+      }),
+    },
+    links: {},
+  });
+
+  const result = await update(oldFile, serverSchema);
+
+  await expectNoDiff(result, serverSchema);
+});
+
+test('handles quoted keys for entities, attrs, and links', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      title: i.string(),
+    }),
+    users: i.entity({
+      email: i.string(),
+    }),
+    'user-profiles': i.entity({
+      'display-name': i.string(),
+    }),
+  },
+  links: {
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const serverSchema = i.schema({
+    entities: {
+      todos: i.entity({ title: i.string() }),
+      users: i.entity({ email: i.string() }),
+      'user-profiles': i.entity({
+        'display-name': i.string(),
+        'avatar-url': i.string(),
+      }),
+    },
+    links: {
+      'todo-owner': {
+        forward: { on: 'todos', has: 'one', label: 'owner' },
+        reverse: { on: 'users', has: 'many', label: 'todos' },
+      },
+    },
+  });
+
+  const result = await update(oldFile, serverSchema);
+
+  expect(result).toMatchSnapshot();
+});
+
+test('adds a link when links object is empty', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      title: i.string(),
+    }),
+    users: i.entity({
+      email: i.string(),
+    }),
+  },
+  links: {
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const serverSchema = i.schema({
+    entities: {
+      todos: i.entity({ title: i.string() }),
+      users: i.entity({ email: i.string() }),
+    },
+    links: {
+      todoOwner: {
+        forward: { on: 'todos', has: 'one', label: 'owner' },
+        reverse: { on: 'users', has: 'many', label: 'todos' },
+      },
+    },
+  });
+
+  const result = await update(oldFile, serverSchema);
+
+  expect(result).toMatchSnapshot();
+});
+
+test('adds multiple links when links object is empty', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      title: i.string(),
+    }),
+    users: i.entity({
+      email: i.string(),
+    }),
+    projects: i.entity({
+      name: i.string(),
+    }),
+  },
+  links: {
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const serverSchema = i.schema({
+    entities: {
+      todos: i.entity({ title: i.string() }),
+      users: i.entity({ email: i.string() }),
+      projects: i.entity({ name: i.string() }),
+    },
+    links: {
+      todoOwner: {
+        forward: { on: 'todos', has: 'one', label: 'owner' },
+        reverse: { on: 'users', has: 'many', label: 'todos' },
+      },
+      projectTodos: {
+        forward: { on: 'projects', has: 'many', label: 'todos' },
+        reverse: { on: 'todos', has: 'one', label: 'project' },
+      },
+    },
+  });
+
+  const result = await update(oldFile, serverSchema);
+
+  await expectNoDiff(result, serverSchema);
+});
+
+test('removes the last link cleanly', async () => {
+  const oldFile = `
+import { i } from '@instantdb/core';
+
+const _schema = i.schema({
+  entities: {
+    todos: i.entity({
+      title: i.string(),
+    }),
+    users: i.entity({
+      email: i.string(),
+    }),
+  },
+  links: {
+    todoOwner: {
+      forward: { on: 'todos', has: 'one', label: 'owner' },
+      reverse: { on: 'users', has: 'many', label: 'todos' },
+    },
+  },
+  rooms: {},
+});
+
+export default _schema;
+`;
+  const serverSchema = i.schema({
+    entities: {
+      todos: i.entity({ title: i.string() }),
+      users: i.entity({ email: i.string() }),
+    },
+    links: {},
+  });
+
+  const result = await update(oldFile, serverSchema);
+
+  expect(result).toMatchSnapshot();
+});
+
+async function update(oldFile: string, serverSchema: any) {
+  const localSchema = schemaTypescriptFileToInstantSchema(oldFile);
+  return updateSchemaFile(oldFile, localSchema, serverSchema);
+}
+
+async function expectNoDiff(result: string, serverSchema: any) {
+  const parsed = schemaTypescriptFileToInstantSchema(result);
+  const diff = await diffSchemas(parsed, serverSchema, async (created) => created, {});
+  expect(diff).toEqual([]);
+}

package/dist/index.d.ts.map

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