@prisma-next/sql-contract-psl 0.3.0-dev.71 → 0.4.0-dev.1

package/src/default-function-registry.ts

@@ -18,13 +18,14 @@ export interface DefaultFunctionLoweringContext {
   readonly sourceId: string;
   readonly modelName: string;
   readonly fieldName: string;
+  readonly columnCodecId?: string;
 }
 
-type LoweredDefaultValue =
+export type LoweredDefaultValue =
   | { readonly kind: 'storage'; readonly defaultValue: ColumnDefault }
   | { readonly kind: 'execution'; readonly generated: ExecutionMutationDefaultValue };
 
-type LoweredDefaultResult =
+export type LoweredDefaultResult =
   | { readonly ok: true; readonly value: LoweredDefaultValue }
   | { readonly ok: false; readonly diagnostic: ContractSourceDiagnostic };
 
@@ -33,7 +34,42 @@ export type DefaultFunctionLoweringHandler = (input: {
   readonly context: DefaultFunctionLoweringContext;
 }) => LoweredDefaultResult;
 
-export type DefaultFunctionRegistry = ReadonlyMap<string, DefaultFunctionLoweringHandler>;
+export interface DefaultFunctionRegistryEntry {
+  readonly lower: DefaultFunctionLoweringHandler;
+  readonly usageSignatures?: readonly string[];
+}
+
+export type DefaultFunctionRegistry = ReadonlyMap<string, DefaultFunctionRegistryEntry>;
+
+export interface MutationDefaultGeneratorDescriptor {
+  readonly id: string;
+  readonly applicableCodecIds: readonly string[];
+  readonly resolveGeneratedColumnDescriptor?: (input: {
+    readonly generated: ExecutionMutationDefaultValue;
+  }) =>
+    | {
+        readonly codecId: string;
+        readonly nativeType: string;
+        readonly typeRef?: string;
+        readonly typeParams?: Record<string, unknown>;
+      }
+    | undefined;
+}
+
+export interface ControlMutationDefaultEntry {
+  readonly lower: (input: {
+    readonly call: ParsedDefaultFunctionCall;
+    readonly context: DefaultFunctionLoweringContext;
+  }) => LoweredDefaultResult;
+  readonly usageSignatures?: readonly string[];
+}
+
+export type ControlMutationDefaultRegistry = ReadonlyMap<string, ControlMutationDefaultEntry>;
+
+export interface ControlMutationDefaults {
+  readonly defaultFunctionRegistry: ControlMutationDefaultRegistry;
+  readonly generatorDescriptors: readonly MutationDefaultGeneratorDescriptor[];
+}
 
 function resolveSpanPositionFromBase(
   base: PslSpan,
@@ -191,318 +227,34 @@ export function parseDefaultFunctionCall(
   };
 }
 
-function invalidArgumentDiagnostic(input: {
-  readonly context: DefaultFunctionLoweringContext;
-  readonly span: PslSpan;
-  readonly message: string;
-}): LoweredDefaultResult {
-  return {
-    ok: false,
-    diagnostic: {
-      code: 'PSL_INVALID_DEFAULT_FUNCTION_ARGUMENT',
-      message: input.message,
-      sourceId: input.context.sourceId,
-      span: input.span,
-    },
-  };
-}
-
-function executionGenerator(
-  id: ExecutionMutationDefaultValue['id'],
-  params?: Record<string, unknown>,
-): LoweredDefaultResult {
-  return {
-    ok: true,
-    value: {
-      kind: 'execution',
-      generated: {
-        kind: 'generator',
-        id,
-        ...(params ? { params } : {}),
-      },
-    },
-  };
-}
-
-function expectNoArgs(input: {
-  readonly call: ParsedDefaultFunctionCall;
-  readonly context: DefaultFunctionLoweringContext;
-  readonly usage: string;
-}): LoweredDefaultResult | undefined {
-  if (input.call.args.length === 0) {
-    return undefined;
-  }
-  return invalidArgumentDiagnostic({
-    context: input.context,
-    span: input.call.span,
-    message: `Default function "${input.call.name}" does not accept arguments. Use ${input.usage}.`,
-  });
-}
-
-function parseIntegerArgument(raw: string): number | undefined {
-  const trimmed = raw.trim();
-  if (!/^-?\d+$/.test(trimmed)) {
-    return undefined;
-  }
-  const value = Number(trimmed);
-  if (!Number.isInteger(value)) {
-    return undefined;
-  }
-  return value;
-}
-
-function parseStringLiteral(raw: string): string | undefined {
-  const match = raw.trim().match(/^(['"])(.*)\1$/s);
-  if (!match) {
-    return undefined;
-  }
-  return match[2] ?? '';
-}
-
-function lowerAutoincrement(input: {
-  readonly call: ParsedDefaultFunctionCall;
-  readonly context: DefaultFunctionLoweringContext;
-}): LoweredDefaultResult {
-  const maybeNoArgs = expectNoArgs({
-    call: input.call,
-    context: input.context,
-    usage: '`autoincrement()`',
-  });
-  if (maybeNoArgs) {
-    return maybeNoArgs;
-  }
-  return {
-    ok: true,
-    value: {
-      kind: 'storage',
-      defaultValue: {
-        kind: 'function',
-        expression: 'autoincrement()',
-      },
-    },
-  };
-}
-
-function lowerNow(input: {
-  readonly call: ParsedDefaultFunctionCall;
-  readonly context: DefaultFunctionLoweringContext;
-}): LoweredDefaultResult {
-  const maybeNoArgs = expectNoArgs({
-    call: input.call,
-    context: input.context,
-    usage: '`now()`',
-  });
-  if (maybeNoArgs) {
-    return maybeNoArgs;
-  }
-  return {
-    ok: true,
-    value: {
-      kind: 'storage',
-      defaultValue: {
-        kind: 'function',
-        expression: 'now()',
-      },
-    },
-  };
-}
-
-function lowerUuid(input: {
-  readonly call: ParsedDefaultFunctionCall;
-  readonly context: DefaultFunctionLoweringContext;
-}): LoweredDefaultResult {
-  if (input.call.args.length === 0) {
-    return executionGenerator('uuidv4');
-  }
-  if (input.call.args.length !== 1) {
-    return invalidArgumentDiagnostic({
-      context: input.context,
-      span: input.call.span,
-      message:
-        'Default function "uuid" accepts at most one version argument: `uuid()`, `uuid(4)`, or `uuid(7)`.',
-    });
-  }
-  const version = parseIntegerArgument(input.call.args[0]?.raw ?? '');
-  if (version === 4) {
-    return executionGenerator('uuidv4');
-  }
-  if (version === 7) {
-    return executionGenerator('uuidv7');
-  }
-  return invalidArgumentDiagnostic({
-    context: input.context,
-    span: input.call.args[0]?.span ?? input.call.span,
-    message:
-      'Default function "uuid" supports only `uuid()`, `uuid(4)`, or `uuid(7)` in SQL PSL provider v1.',
-  });
-}
-
-function lowerCuid(input: {
-  readonly call: ParsedDefaultFunctionCall;
-  readonly context: DefaultFunctionLoweringContext;
-}): LoweredDefaultResult {
-  if (input.call.args.length === 0) {
-    return {
-      ok: false,
-      diagnostic: {
-        code: 'PSL_UNKNOWN_DEFAULT_FUNCTION',
-        message:
-          'Default function "cuid()" is not supported in SQL PSL provider v1. Use `cuid(2)` instead.',
-        sourceId: input.context.sourceId,
-        span: input.call.span,
-      },
-    };
-  }
-  if (input.call.args.length !== 1) {
-    return invalidArgumentDiagnostic({
-      context: input.context,
-      span: input.call.span,
-      message: 'Default function "cuid" accepts exactly one version argument: `cuid(2)`.',
+function formatSupportedFunctionList(registry: ControlMutationDefaultRegistry): string {
+  const signatures = Array.from(registry.entries())
+    .sort(([a], [b]) => a.localeCompare(b))
+    .flatMap(([functionName, entry]) => {
+      const usageSignatures = entry.usageSignatures?.filter((signature) => signature.length > 0);
+      return usageSignatures && usageSignatures.length > 0
+        ? usageSignatures
+        : [`${functionName}()`];
     });
-  }
-  const version = parseIntegerArgument(input.call.args[0]?.raw ?? '');
-  if (version === 2) {
-    return executionGenerator('cuid2');
-  }
-  return invalidArgumentDiagnostic({
-    context: input.context,
-    span: input.call.args[0]?.span ?? input.call.span,
-    message: 'Default function "cuid" supports only `cuid(2)` in SQL PSL provider v1.',
-  });
-}
-
-function lowerUlid(input: {
-  readonly call: ParsedDefaultFunctionCall;
-  readonly context: DefaultFunctionLoweringContext;
-}): LoweredDefaultResult {
-  const maybeNoArgs = expectNoArgs({
-    call: input.call,
-    context: input.context,
-    usage: '`ulid()`',
-  });
-  if (maybeNoArgs) {
-    return maybeNoArgs;
-  }
-  return executionGenerator('ulid');
-}
-
-function lowerNanoid(input: {
-  readonly call: ParsedDefaultFunctionCall;
-  readonly context: DefaultFunctionLoweringContext;
-}): LoweredDefaultResult {
-  if (input.call.args.length === 0) {
-    return executionGenerator('nanoid');
-  }
-  if (input.call.args.length !== 1) {
-    return invalidArgumentDiagnostic({
-      context: input.context,
-      span: input.call.span,
-      message:
-        'Default function "nanoid" accepts at most one size argument: `nanoid()` or `nanoid(<2-255>)`.',
-    });
-  }
-  const size = parseIntegerArgument(input.call.args[0]?.raw ?? '');
-  if (size !== undefined && size >= 2 && size <= 255) {
-    return executionGenerator('nanoid', { size });
-  }
-  return invalidArgumentDiagnostic({
-    context: input.context,
-    span: input.call.args[0]?.span ?? input.call.span,
-    message: 'Default function "nanoid" size argument must be an integer between 2 and 255.',
-  });
-}
-
-function lowerDbgenerated(input: {
-  readonly call: ParsedDefaultFunctionCall;
-  readonly context: DefaultFunctionLoweringContext;
-}): LoweredDefaultResult {
-  if (input.call.args.length !== 1) {
-    return invalidArgumentDiagnostic({
-      context: input.context,
-      span: input.call.span,
-      message:
-        'Default function "dbgenerated" requires exactly one string argument: `dbgenerated("...")`.',
-    });
-  }
-  const rawExpression = parseStringLiteral(input.call.args[0]?.raw ?? '');
-  if (rawExpression === undefined) {
-    return invalidArgumentDiagnostic({
-      context: input.context,
-      span: input.call.args[0]?.span ?? input.call.span,
-      message: 'Default function "dbgenerated" argument must be a string literal.',
-    });
-  }
-  if (rawExpression.trim().length === 0) {
-    return invalidArgumentDiagnostic({
-      context: input.context,
-      span: input.call.args[0]?.span ?? input.call.span,
-      message: 'Default function "dbgenerated" argument cannot be empty.',
-    });
-  }
-  return {
-    ok: true,
-    value: {
-      kind: 'storage',
-      defaultValue: {
-        kind: 'function',
-        expression: rawExpression,
-      },
-    },
-  };
-}
-
-const supportedFunctionUsageByName: Readonly<Record<string, readonly string[]>> = {
-  autoincrement: ['autoincrement()'],
-  now: ['now()'],
-  uuid: ['uuid()', 'uuid(4)', 'uuid(7)'],
-  cuid: ['cuid(2)'],
-  ulid: ['ulid()'],
-  nanoid: ['nanoid()', 'nanoid(n)'],
-  dbgenerated: ['dbgenerated("...")'],
-};
-
-const unknownFunctionSuggestionsByName: Readonly<Record<string, string>> = {
-  cuid2: 'Use `cuid(2)`.',
-  uuidv4: 'Use `uuid()` or `uuid(4)`.',
-  uuidv7: 'Use `uuid(7)`.',
-};
-
-function formatSupportedFunctionList(registry: DefaultFunctionRegistry): string {
-  const signatures = Array.from(registry.keys())
-    .sort()
-    .flatMap((functionName) => supportedFunctionUsageByName[functionName] ?? [`${functionName}()`]);
   return signatures.length > 0 ? signatures.join(', ') : 'none';
 }
 
-export function createBuiltinDefaultFunctionRegistry(): DefaultFunctionRegistry {
-  return new Map<string, DefaultFunctionLoweringHandler>([
-    ['autoincrement', lowerAutoincrement],
-    ['now', lowerNow],
-    ['uuid', lowerUuid],
-    ['cuid', lowerCuid],
-    ['ulid', lowerUlid],
-    ['nanoid', lowerNanoid],
-    ['dbgenerated', lowerDbgenerated],
-  ]);
-}
-
 export function lowerDefaultFunctionWithRegistry(input: {
   readonly call: ParsedDefaultFunctionCall;
-  readonly registry: DefaultFunctionRegistry;
+  readonly registry: ControlMutationDefaultRegistry;
   readonly context: DefaultFunctionLoweringContext;
 }): LoweredDefaultResult {
-  const handler = input.registry.get(input.call.name);
-  if (handler) {
-    return handler({ call: input.call, context: input.context });
+  const entry = input.registry.get(input.call.name);
+  if (entry) {
+    return entry.lower({ call: input.call, context: input.context });
   }
   const supportedFunctionList = formatSupportedFunctionList(input.registry);
-  const suggestion = unknownFunctionSuggestionsByName[input.call.name];
 
   return {
     ok: false,
     diagnostic: {
       code: 'PSL_UNKNOWN_DEFAULT_FUNCTION',
-      message: `Default function "${input.call.name}" is not supported in SQL PSL provider v1. Supported functions: ${supportedFunctionList}.${suggestion ? ` ${suggestion}` : ''}`,
+      message: `Default function "${input.call.name}" is not supported in SQL PSL provider v1. Supported functions: ${supportedFunctionList}.`,
       sourceId: input.context.sourceId,
       span: input.call.span,
     },

package/src/exports/index.ts

@@ -1,4 +1,12 @@
+export type {
+  ControlMutationDefaults,
+  DefaultFunctionLoweringContext,
+  DefaultFunctionLoweringHandler,
+  DefaultFunctionRegistry,
+  DefaultFunctionRegistryEntry,
+  MutationDefaultGeneratorDescriptor,
+} from '../default-function-registry';
 export {
-  type InterpretPslDocumentToSqlContractIRInput,
-  interpretPslDocumentToSqlContractIR,
+  type InterpretPslDocumentToSqlContractInput,
+  interpretPslDocumentToSqlContract,
 } from '../interpreter';