@prisma-next/target-postgres 0.4.0-dev.6 → 0.4.0-dev.8

package/src/core/migrations/scaffolding.ts

@@ -0,0 +1,140 @@
+import type {
+  MigrationScaffoldContext,
+  OperationDescriptor,
+} from '@prisma-next/framework-components/control';
+import { relative } from 'pathe';
+
+/**
+ * Postgres's internal plan shape. Happens to be descriptor-shaped today — that
+ * is a target-internal choice; the framework has no opinion.
+ */
+type PostgresPlan = readonly OperationDescriptor[];
+
+function serializeQueryInput(input: unknown): string {
+  if (typeof input === 'boolean') return String(input);
+  if (typeof input === 'symbol') return 'TODO /* fill in using db.sql.from(...) */';
+  if (input === null || input === undefined) return 'null';
+  if (Array.isArray(input)) {
+    if (input.length === 0) return '[]';
+    if (input.every((item) => typeof item === 'symbol'))
+      return '[TODO /* fill in using db.sql.from(...) */]';
+    return `[${input.map(serializeQueryInput).join(', ')}]`;
+  }
+  return JSON.stringify(input);
+}
+
+function renderDescriptor(desc: OperationDescriptor): string {
+  switch (desc.kind) {
+    case 'createTable':
+      return `createTable(${JSON.stringify(desc['table'])})`;
+    case 'dropTable':
+      return `dropTable(${JSON.stringify(desc['table'])})`;
+    case 'addColumn': {
+      const args = [JSON.stringify(desc['table']), JSON.stringify(desc['column'])];
+      if (desc['overrides']) {
+        args.push(JSON.stringify(desc['overrides']));
+      }
+      return `addColumn(${args.join(', ')})`;
+    }
+    case 'dropColumn':
+      return `dropColumn(${JSON.stringify(desc['table'])}, ${JSON.stringify(desc['column'])})`;
+    case 'alterColumnType': {
+      const opts: Record<string, unknown> = {};
+      if (desc['using']) opts['using'] = desc['using'];
+      if (desc['toType']) opts['toType'] = desc['toType'];
+      const hasOpts = Object.keys(opts).length > 0;
+      return hasOpts
+        ? `alterColumnType(${JSON.stringify(desc['table'])}, ${JSON.stringify(desc['column'])}, ${JSON.stringify(opts)})`
+        : `alterColumnType(${JSON.stringify(desc['table'])}, ${JSON.stringify(desc['column'])})`;
+    }
+    case 'setNotNull':
+      return `setNotNull(${JSON.stringify(desc['table'])}, ${JSON.stringify(desc['column'])})`;
+    case 'dropNotNull':
+      return `dropNotNull(${JSON.stringify(desc['table'])}, ${JSON.stringify(desc['column'])})`;
+    case 'setDefault':
+      return `setDefault(${JSON.stringify(desc['table'])}, ${JSON.stringify(desc['column'])})`;
+    case 'dropDefault':
+      return `dropDefault(${JSON.stringify(desc['table'])}, ${JSON.stringify(desc['column'])})`;
+    case 'addPrimaryKey':
+      return `addPrimaryKey(${JSON.stringify(desc['table'])})`;
+    case 'addUnique':
+      return `addUnique(${JSON.stringify(desc['table'])}, ${JSON.stringify(desc['columns'])})`;
+    case 'addForeignKey':
+      return `addForeignKey(${JSON.stringify(desc['table'])}, ${JSON.stringify(desc['columns'])})`;
+    case 'dropConstraint':
+      return `dropConstraint(${JSON.stringify(desc['table'])}, ${JSON.stringify(desc['constraintName'])})`;
+    case 'createIndex':
+      return `createIndex(${JSON.stringify(desc['table'])}, ${JSON.stringify(desc['columns'])})`;
+    case 'dropIndex':
+      return `dropIndex(${JSON.stringify(desc['table'])}, ${JSON.stringify(desc['indexName'])})`;
+    case 'createEnumType':
+      return desc['values']
+        ? `createEnumType(${JSON.stringify(desc['typeName'])}, ${JSON.stringify(desc['values'])})`
+        : `createEnumType(${JSON.stringify(desc['typeName'])})`;
+    case 'addEnumValues':
+      return `addEnumValues(${JSON.stringify(desc['typeName'])}, ${JSON.stringify(desc['values'])})`;
+    case 'dropEnumType':
+      return `dropEnumType(${JSON.stringify(desc['typeName'])})`;
+    case 'renameType':
+      return `renameType(${JSON.stringify(desc['fromName'])}, ${JSON.stringify(desc['toName'])})`;
+    case 'createDependency':
+      return `createDependency(${JSON.stringify(desc['dependencyId'])})`;
+    case 'dataTransform':
+      return `dataTransform(${JSON.stringify(desc['name'])}, {\n    check: ${serializeQueryInput(desc['check'])},\n    run: ${serializeQueryInput(desc['run'])},\n  })`;
+    default:
+      throw new Error(`Unknown Postgres descriptor kind: ${desc.kind}`);
+  }
+}
+
+function renderPreamble(
+  plan: PostgresPlan,
+  context: MigrationScaffoldContext,
+): ReadonlyArray<string> {
+  const hasDataTransform = plan.some((d) => d.kind === 'dataTransform');
+
+  if (hasDataTransform && context.contractJsonPath) {
+    const relativeContractDts = relative(context.packageDir, context.contractJsonPath).replace(
+      /\.json$/,
+      '.d',
+    );
+    const importList = [...new Set(plan.map((d) => d.kind))];
+    importList.push('TODO');
+    return [
+      `import type { Contract } from "${relativeContractDts}"`,
+      `import { createBuilders } from "@prisma-next/target-postgres/migration-builders"`,
+      '',
+      `const { ${importList.join(', ')} } = createBuilders<Contract>()`,
+    ];
+  }
+
+  const importList = [...new Set(plan.map((d) => d.kind))];
+  if (importList.length === 0) {
+    importList.push('createTable');
+  }
+  if (hasDataTransform) {
+    importList.push('TODO');
+  }
+  return [
+    `import { ${importList.join(', ')} } from "@prisma-next/target-postgres/migration-builders"`,
+  ];
+}
+
+/**
+ * Render a Postgres descriptor list to a `migration.ts` source string.
+ *
+ * Internal to the Postgres target — no longer part of the framework SPI.
+ * Invoked from two paths:
+ *  - the migrations capability's `renderDescriptorTypeScript` hook (called by
+ *    the CLI after `planWithDescriptors` to seed an editable authoring
+ *    surface, and by `emptyMigration()` to produce the `migration new` stub);
+ *  - directly by this package's unit tests.
+ */
+export function renderDescriptorTypeScript(
+  descriptors: readonly OperationDescriptor[],
+  context: MigrationScaffoldContext,
+): string {
+  const preamble = renderPreamble(descriptors, context);
+  const calls = descriptors.map((d) => `  ${renderDescriptor(d)},`);
+  const body = calls.length > 0 ? `\n${calls.join('\n')}\n` : '';
+  return [...preamble, '', `export default () => [${body}]`, ''].join('\n');
+}

package/src/exports/control.ts

@@ -17,7 +17,6 @@ import { verifySqlSchema } from '@prisma-next/family-sql/schema-verify';
 import type { TargetBoundComponentDescriptor } from '@prisma-next/framework-components/components';
 import type {
   ControlTargetInstance,
-  MigrationPlanner,
   MigrationRunner,
   OperationDescriptor,
 } from '@prisma-next/framework-components/control';
@@ -33,6 +32,7 @@ import { createPostgresMigrationPlanner } from '../core/migrations/planner';
 import { renderDefaultLiteral } from '../core/migrations/planner-ddl-builders';
 import type { PostgresPlanTargetDetails } from '../core/migrations/planner-target-details';
 import { createPostgresMigrationRunner } from '../core/migrations/runner';
+import { renderDescriptorTypeScript } from '../core/migrations/scaffolding';
 
 function parseDescriptors(descriptors: readonly OperationDescriptor[]) {
   const result = MigrationDescriptorArraySchema([...descriptors]);
@@ -127,7 +127,7 @@ const postgresTargetDescriptor: SqlControlTargetDescriptor<'postgres', PostgresP
     ...postgresTargetDescriptorMeta,
     migrations: {
       createPlanner(_family: SqlControlFamilyInstance) {
-        return createPostgresMigrationPlanner() as MigrationPlanner<'sql', 'postgres'>;
+        return createPostgresMigrationPlanner();
       },
       createRunner(family) {
         return createPostgresMigrationRunner(family) as MigrationRunner<'sql', 'postgres'>;
@@ -199,6 +199,9 @@ const postgresTargetDescriptor: SqlControlTargetDescriptor<'postgres', PostgresP
           db,
         });
       },
+      renderDescriptorTypeScript(descriptors, context) {
+        return renderDescriptorTypeScript(descriptors, context);
+      },
     },
     create(): ControlTargetInstance<'sql', 'postgres'> {
       return {

package/src/exports/pack.ts

@@ -1,10 +1 @@
-import type { CodecTypes } from '@prisma-next/adapter-postgres/codec-types';
-import type { TargetPackRef } from '@prisma-next/framework-components/components';
-import { postgresTargetDescriptorMeta } from '../core/descriptor-meta';
-
-const postgresPack = postgresTargetDescriptorMeta;
-
-export default postgresPack as typeof postgresTargetDescriptorMeta &
-  TargetPackRef<'sql', 'postgres'> & {
-    readonly __codecTypes?: CodecTypes;
-  };
+export { postgresTargetDescriptorMeta as default } from '../core/descriptor-meta';

package/dist/descriptor-meta-CAf16lsJ.mjs

@@ -1,32 +0,0 @@
-//#region src/core/authoring.ts
-const postgresAuthoringTypes = { enum: {
-	kind: "typeConstructor",
-	args: [{ kind: "string" }, { kind: "stringArray" }],
-	output: {
-		codecId: "pg/enum@1",
-		nativeType: {
-			kind: "arg",
-			index: 0
-		},
-		typeParams: { values: {
-			kind: "arg",
-			index: 1
-		} }
-	}
-} };
-
-//#endregion
-//#region src/core/descriptor-meta.ts
-const postgresTargetDescriptorMeta = {
-	kind: "target",
-	familyId: "sql",
-	targetId: "postgres",
-	id: "postgres",
-	version: "0.0.1",
-	capabilities: {},
-	authoring: { type: postgresAuthoringTypes }
-};
-
-//#endregion
-export { postgresTargetDescriptorMeta as t };
-//# sourceMappingURL=descriptor-meta-CAf16lsJ.mjs.map

package/dist/descriptor-meta-CAf16lsJ.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"descriptor-meta-CAf16lsJ.mjs","names":[],"sources":["../src/core/authoring.ts","../src/core/descriptor-meta.ts"],"sourcesContent":["import type { AuthoringTypeNamespace } from '@prisma-next/framework-components/authoring';\n\nexport const postgresAuthoringTypes = {\n  enum: {\n    kind: 'typeConstructor',\n    args: [{ kind: 'string' }, { kind: 'stringArray' }],\n    output: {\n      codecId: 'pg/enum@1',\n      nativeType: { kind: 'arg', index: 0 },\n      typeParams: {\n        values: { kind: 'arg', index: 1 },\n      },\n    },\n  },\n} as const satisfies AuthoringTypeNamespace;\n","import { postgresAuthoringTypes } from './authoring';\n\nexport const postgresTargetDescriptorMeta = {\n  kind: 'target',\n  familyId: 'sql',\n  targetId: 'postgres',\n  id: 'postgres',\n  version: '0.0.1',\n  capabilities: {},\n  authoring: {\n    type: postgresAuthoringTypes,\n  },\n} as const;\n"],"mappings":";AAEA,MAAa,yBAAyB,EACpC,MAAM;CACJ,MAAM;CACN,MAAM,CAAC,EAAE,MAAM,UAAU,EAAE,EAAE,MAAM,eAAe,CAAC;CACnD,QAAQ;EACN,SAAS;EACT,YAAY;GAAE,MAAM;GAAO,OAAO;GAAG;EACrC,YAAY,EACV,QAAQ;GAAE,MAAM;GAAO,OAAO;GAAG,EAClC;EACF;CACF,EACF;;;;ACZD,MAAa,+BAA+B;CAC1C,MAAM;CACN,UAAU;CACV,UAAU;CACV,IAAI;CACJ,SAAS;CACT,cAAc,EAAE;CAChB,WAAW,EACT,MAAM,wBACP;CACF"}

package/dist/pack.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"pack.mjs","names":[],"sources":["../src/exports/pack.ts"],"sourcesContent":["import type { CodecTypes } from '@prisma-next/adapter-postgres/codec-types';\nimport type { TargetPackRef } from '@prisma-next/framework-components/components';\nimport { postgresTargetDescriptorMeta } from '../core/descriptor-meta';\n\nconst postgresPack = postgresTargetDescriptorMeta;\n\nexport default postgresPack as typeof postgresTargetDescriptorMeta &\n  TargetPackRef<'sql', 'postgres'> & {\n    readonly __codecTypes?: CodecTypes;\n  };\n"],"mappings":";;;AAIA,MAAM,eAAe;AAErB,mBAAe"}