@prisma-next/contract 0.3.0-pr.99.5 → 0.3.0

package/src/canonicalization.ts

@@ -0,0 +1,263 @@
+import { isArrayEqual } from '@prisma-next/utils/array-equal';
+import { ifDefined } from '@prisma-next/utils/defined';
+
+import type { Contract } from './contract-types';
+
+const TOP_LEVEL_ORDER = [
+  'schemaVersion',
+  'canonicalVersion',
+  'targetFamily',
+  'target',
+  'profileHash',
+  'roots',
+  'models',
+  'valueObjects',
+  'storage',
+  'execution',
+  'capabilities',
+  'extensionPacks',
+  'meta',
+] as const;
+
+function isDefaultValue(value: unknown): boolean {
+  if (value === false) return true;
+  if (value === null) return false;
+  if (Array.isArray(value) && value.length === 0) return true;
+  if (typeof value === 'object' && value !== null) {
+    const keys = Object.keys(value);
+    return keys.length === 0;
+  }
+  return false;
+}
+
+function omitDefaults(obj: unknown, path: readonly string[]): unknown {
+  if (obj === null || typeof obj !== 'object') {
+    return obj;
+  }
+
+  if (Array.isArray(obj)) {
+    return obj.map((item) => omitDefaults(item, path));
+  }
+
+  const result: Record<string, unknown> = {};
+
+  for (const [key, value] of Object.entries(obj)) {
+    const currentPath = [...path, key];
+
+    if (key === '_generated') {
+      continue;
+    }
+
+    if (key === 'generated' && value === false) {
+      continue;
+    }
+
+    if ((key === 'onDelete' || key === 'onUpdate') && value === 'noAction') {
+      continue;
+    }
+
+    if (isDefaultValue(value)) {
+      const isRequiredModels = isArrayEqual(currentPath, ['models']);
+      const isRequiredTables = isArrayEqual(currentPath, ['storage', 'tables']);
+      const isRequiredCollections = isArrayEqual(currentPath, ['storage', 'collections']);
+      const isCollectionEntry =
+        currentPath.length === 3 &&
+        isArrayEqual([currentPath[0], currentPath[1]], ['storage', 'collections']);
+      const isRequiredRoots = isArrayEqual(currentPath, ['roots']);
+      const isRequiredExtensionPacks = isArrayEqual(currentPath, ['extensionPacks']);
+      const isRequiredCapabilities = isArrayEqual(currentPath, ['capabilities']);
+      const isRequiredMeta = isArrayEqual(currentPath, ['meta']);
+      const isRequiredExecutionDefaults = isArrayEqual(currentPath, [
+        'execution',
+        'mutations',
+        'defaults',
+      ]);
+      const isExtensionNamespace = currentPath.length === 2 && currentPath[0] === 'extensionPacks';
+      const isModelRelations =
+        currentPath.length === 3 &&
+        isArrayEqual([currentPath[0], currentPath[2]], ['models', 'relations']);
+      const isModelStorage =
+        currentPath.length === 3 &&
+        isArrayEqual([currentPath[0], currentPath[2]], ['models', 'storage']);
+      const isTableUniques =
+        currentPath.length === 4 &&
+        isArrayEqual(
+          [currentPath[0], currentPath[1], currentPath[3]],
+          ['storage', 'tables', 'uniques'],
+        );
+      const isTableIndexes =
+        currentPath.length === 4 &&
+        isArrayEqual(
+          [currentPath[0], currentPath[1], currentPath[3]],
+          ['storage', 'tables', 'indexes'],
+        );
+      const isTableForeignKeys =
+        currentPath.length === 4 &&
+        isArrayEqual(
+          [currentPath[0], currentPath[1], currentPath[3]],
+          ['storage', 'tables', 'foreignKeys'],
+        );
+
+      const isFkBooleanField =
+        currentPath.length === 5 &&
+        currentPath[0] === 'storage' &&
+        currentPath[1] === 'tables' &&
+        currentPath[3] === 'foreignKeys' &&
+        (key === 'constraint' || key === 'index');
+
+      const isNullableField = key === 'nullable';
+
+      if (
+        !isRequiredModels &&
+        !isRequiredTables &&
+        !isRequiredCollections &&
+        !isCollectionEntry &&
+        !isRequiredRoots &&
+        !isRequiredExtensionPacks &&
+        !isRequiredCapabilities &&
+        !isRequiredMeta &&
+        !isRequiredExecutionDefaults &&
+        !isExtensionNamespace &&
+        !isModelRelations &&
+        !isModelStorage &&
+        !isTableUniques &&
+        !isTableIndexes &&
+        !isTableForeignKeys &&
+        !isFkBooleanField &&
+        !isNullableField
+      ) {
+        continue;
+      }
+    }
+
+    result[key] = omitDefaults(value, currentPath);
+  }
+
+  return result;
+}
+
+function sortObjectKeys(obj: unknown): unknown {
+  if (obj === null || typeof obj !== 'object') {
+    return obj;
+  }
+
+  if (Array.isArray(obj)) {
+    return obj.map((item) => sortObjectKeys(item));
+  }
+
+  const sorted: Record<string, unknown> = {};
+  const keys = Object.keys(obj).sort();
+  for (const key of keys) {
+    sorted[key] = sortObjectKeys((obj as Record<string, unknown>)[key]);
+  }
+
+  return sorted;
+}
+
+type StorageObject = {
+  tables?: Record<string, unknown>;
+  [key: string]: unknown;
+};
+
+type TableObject = {
+  indexes?: unknown[];
+  uniques?: unknown[];
+  [key: string]: unknown;
+};
+
+function sortIndexesAndUniques(storage: unknown): unknown {
+  if (!storage || typeof storage !== 'object') {
+    return storage;
+  }
+
+  const storageObj = storage as StorageObject;
+  if (!storageObj.tables || typeof storageObj.tables !== 'object') {
+    return storage;
+  }
+
+  const tables = storageObj.tables;
+  const result: StorageObject = { ...storageObj };
+
+  result.tables = {};
+  const sortedTableNames = Object.keys(tables).sort();
+  for (const tableName of sortedTableNames) {
+    const table = tables[tableName];
+    if (!table || typeof table !== 'object') {
+      result.tables[tableName] = table;
+      continue;
+    }
+
+    const tableObj = table as TableObject;
+    const sortedTable: TableObject = { ...tableObj };
+
+    if (Array.isArray(tableObj.indexes)) {
+      sortedTable.indexes = [...tableObj.indexes].sort((a, b) => {
+        const nameA = (a as { name?: string })?.name || '';
+        const nameB = (b as { name?: string })?.name || '';
+        return nameA.localeCompare(nameB);
+      });
+    }
+
+    if (Array.isArray(tableObj.uniques)) {
+      sortedTable.uniques = [...tableObj.uniques].sort((a, b) => {
+        const nameA = (a as { name?: string })?.name || '';
+        const nameB = (b as { name?: string })?.name || '';
+        return nameA.localeCompare(nameB);
+      });
+    }
+
+    result.tables[tableName] = sortedTable;
+  }
+
+  return result;
+}
+
+export function orderTopLevel(obj: Record<string, unknown>): Record<string, unknown> {
+  const ordered: Record<string, unknown> = {};
+  const remaining = new Set(Object.keys(obj));
+
+  for (const key of TOP_LEVEL_ORDER) {
+    if (remaining.has(key)) {
+      ordered[key] = obj[key];
+      remaining.delete(key);
+    }
+  }
+
+  for (const key of Array.from(remaining).sort()) {
+    ordered[key] = obj[key];
+  }
+
+  return ordered;
+}
+
+export function canonicalizeContractToObject(
+  contract: Contract,
+  options?: { schemaVersion?: string },
+): Record<string, unknown> {
+  const normalized: Record<string, unknown> = {
+    ...ifDefined('schemaVersion', options?.schemaVersion),
+    targetFamily: contract.targetFamily,
+    target: contract.target,
+    profileHash: contract.profileHash,
+    roots: contract.roots,
+    models: contract.models,
+    ...ifDefined('valueObjects', contract.valueObjects),
+    storage: contract.storage,
+    ...ifDefined('execution', contract.execution),
+    extensionPacks: contract.extensionPacks,
+    capabilities: contract.capabilities,
+    meta: contract.meta,
+  };
+  const withDefaultsOmitted = omitDefaults(normalized, []) as Record<string, unknown>;
+  const withSortedIndexes = sortIndexesAndUniques(withDefaultsOmitted['storage']);
+  const withSortedStorage = { ...withDefaultsOmitted, storage: withSortedIndexes };
+  const withSortedKeys = sortObjectKeys(withSortedStorage) as Record<string, unknown>;
+  return orderTopLevel(withSortedKeys);
+}
+
+export function canonicalizeContract(
+  contract: Contract,
+  options?: { schemaVersion?: string },
+): string {
+  return JSON.stringify(canonicalizeContractToObject(contract, options), null, 2);
+}

package/src/contract-types.ts

@@ -0,0 +1,55 @@
+import type { ContractModelBase, ContractValueObject } from './domain-types';
+import type {
+  ExecutionHashBase,
+  ExecutionMutationDefault,
+  ProfileHashBase,
+  StorageBase,
+} from './types';
+
+/**
+ * Execution section for the unified contract (ADR 182).
+ *
+ * Unlike the legacy {@link import('./types').ExecutionSection}, this type
+ * requires `executionHash` — when an execution section is present, its
+ * hash must be too (consistent with `StorageBase.storageHash`).
+ *
+ * @template THash  Literal hash string type for type-safe hash tracking.
+ */
+export type ContractExecutionSection<THash extends string = string> = {
+  readonly executionHash: ExecutionHashBase<THash>;
+  readonly mutations: {
+    readonly defaults: ReadonlyArray<ExecutionMutationDefault>;
+  };
+};
+
+/**
+ * Unified contract representation (ADR 182).
+ *
+ * A `Contract` is the canonical in-memory representation of a data contract.
+ * It is model-first (domain models carry their own storage bridge) and
+ * family-parameterized (SQL, Mongo, etc. specialize via `TStorage` and model
+ * storage generics on `ContractModel`).
+ *
+ * JSON persistence fields (`schemaVersion`, `sources`) are not represented
+ * here — they are handled at the serialization boundary.
+ *
+ * @template TStorage  Family-specific storage block (extends {@link StorageBase}).
+ * @template TModels   Record of model name → {@link ContractModel} with
+ *                     family-specific model storage.
+ */
+export interface Contract<
+  TStorage extends StorageBase = StorageBase,
+  TModels extends Record<string, ContractModelBase> = Record<string, ContractModelBase>,
+> {
+  readonly target: string;
+  readonly targetFamily: string;
+  readonly roots: Record<string, string>;
+  readonly models: TModels;
+  readonly valueObjects?: Record<string, ContractValueObject>;
+  readonly storage: TStorage;
+  readonly capabilities: Record<string, Record<string, boolean>>;
+  readonly extensionPacks: Record<string, unknown>;
+  readonly execution?: ContractExecutionSection;
+  readonly profileHash: ProfileHashBase<string>;
+  readonly meta: Record<string, unknown>;
+}

package/src/domain-types.ts

@@ -0,0 +1,95 @@
+export type ScalarFieldType = {
+  readonly kind: 'scalar';
+  readonly codecId: string;
+  readonly typeParams?: Record<string, unknown>;
+};
+
+export type ValueObjectFieldType = {
+  readonly kind: 'valueObject';
+  readonly name: string;
+};
+
+export type UnionFieldType = {
+  readonly kind: 'union';
+  readonly members: ReadonlyArray<ScalarFieldType | ValueObjectFieldType>;
+};
+
+export type ContractFieldType = ScalarFieldType | ValueObjectFieldType | UnionFieldType;
+
+export type ContractField = {
+  readonly nullable: boolean;
+  readonly type: ContractFieldType;
+  readonly many?: true;
+  readonly dict?: true;
+};
+
+export type ContractRelationOn = {
+  readonly localFields: readonly string[];
+  readonly targetFields: readonly string[];
+};
+
+export type ContractReferenceRelation = {
+  readonly to: string;
+  readonly cardinality: '1:1' | '1:N' | 'N:1';
+  readonly on: ContractRelationOn;
+};
+
+export type ContractEmbedRelation = {
+  readonly to: string;
+  readonly cardinality: '1:1' | '1:N';
+};
+
+export type ContractRelation = ContractReferenceRelation | ContractEmbedRelation;
+
+export type ContractDiscriminator = {
+  readonly field: string;
+};
+
+export type ContractVariantEntry = {
+  readonly value: string;
+};
+
+export type ContractValueObject = {
+  readonly fields: Record<string, ContractField>;
+};
+
+export type ModelStorageBase = Readonly<Record<string, unknown>>;
+
+export interface ContractModelBase<TModelStorage extends ModelStorageBase = ModelStorageBase> {
+  readonly fields: Record<string, ContractField>;
+  readonly relations: Record<string, ContractRelation>;
+  readonly storage: TModelStorage;
+  readonly discriminator?: ContractDiscriminator;
+  readonly variants?: Record<string, ContractVariantEntry>;
+  readonly base?: string;
+  readonly owner?: string;
+}
+
+export interface ContractModel<TModelStorage extends ModelStorageBase = ModelStorageBase>
+  extends ContractModelBase<TModelStorage> {
+  readonly fields: Record<string, ContractField>;
+}
+
+// ── Relation key helpers ─────────────────────────────────────────────────────
+
+type HasModelsWithRelations = {
+  readonly models: Record<string, { readonly relations: Record<string, ContractRelation> }>;
+};
+
+export type ReferenceRelationKeys<
+  TContract extends HasModelsWithRelations,
+  ModelName extends string & keyof TContract['models'],
+> = {
+  [K in keyof TContract['models'][ModelName]['relations']]: TContract['models'][ModelName]['relations'][K] extends ContractReferenceRelation
+    ? K
+    : never;
+}[keyof TContract['models'][ModelName]['relations']];
+
+export type EmbedRelationKeys<
+  TContract extends HasModelsWithRelations,
+  ModelName extends string & keyof TContract['models'],
+> = {
+  [K in keyof TContract['models'][ModelName]['relations']]: TContract['models'][ModelName]['relations'][K] extends ContractReferenceRelation
+    ? never
+    : K;
+}[keyof TContract['models'][ModelName]['relations']];

package/src/exports/hashing.ts

@@ -0,0 +1,2 @@
+export { canonicalizeContract, canonicalizeContractToObject } from '../canonicalization';
+export { computeExecutionHash, computeProfileHash, computeStorageHash } from '../hashing';

package/src/exports/testing.ts

@@ -0,0 +1 @@
+export { createContract, createSqlContract, DUMMY_HASH } from '../testing-factories';

package/src/exports/types.ts

@@ -1,33 +1,49 @@
-// Shared types
-// Document family types
-// Plan types - target-family agnostic execution types
-// Emitter types (moved from @prisma-next/emitter)
-// Parameterized codec descriptor types
+export type { Contract, ContractExecutionSection } from '../contract-types';
 export type {
-  ContractBase,
+  ContractDiscriminator,
+  ContractEmbedRelation,
+  ContractField,
+  ContractFieldType,
+  ContractModel,
+  ContractModelBase,
+  ContractReferenceRelation,
+  ContractRelation,
+  ContractRelationOn,
+  ContractValueObject,
+  ContractVariantEntry,
+  EmbedRelationKeys,
+  ModelStorageBase,
+  ReferenceRelationKeys,
+  ScalarFieldType,
+  UnionFieldType,
+  ValueObjectFieldType,
+} from '../domain-types';
+export type {
+  $,
+  Brand,
+  ColumnDefault,
+  ColumnDefaultLiteralInputValue,
+  ColumnDefaultLiteralValue,
   ContractMarkerRecord,
   DocCollection,
   DocIndex,
-  DocumentContract,
-  DocumentStorage,
+  ExecutionHashBase,
+  ExecutionMutationDefault,
+  ExecutionMutationDefaultValue,
   ExecutionPlan,
+  ExecutionSection,
   Expr,
   FieldType,
-  // Type generation options for parameterized codecs
-  GenerateContractTypesOptions,
-  OperationManifest,
+  GeneratedValueSpec,
+  JsonPrimitive,
+  JsonValue,
   ParamDescriptor,
-  ParameterizedCodecDescriptor,
   PlanMeta,
   PlanRefs,
+  ProfileHashBase,
   ResultType,
   Source,
-  TargetFamilyHook,
-  TypeRenderContext,
-  TypeRenderEntry,
-  TypeRenderer,
-  TypesImportSpec,
-  ValidationContext,
+  StorageBase,
+  StorageHashBase,
 } from '../types';
-// Type guards
-export { isDocumentContract } from '../types';
+export { coreHash, executionHash, profileHash } from '../types';

package/src/exports/validate-contract.ts

@@ -0,0 +1,6 @@
+export {
+  ContractValidationError,
+  type ContractValidationPhase,
+  type StorageValidator,
+  validateContract,
+} from '../validate-contract';

package/src/exports/validate-domain.ts

@@ -0,0 +1,5 @@
+export {
+  type DomainContractShape,
+  type DomainModelShape,
+  validateContractDomain,
+} from '../validate-domain';

package/src/hashing.ts

@@ -0,0 +1,53 @@
+import { createHash } from 'node:crypto';
+import { canonicalizeContract } from './canonicalization';
+import type { Contract } from './contract-types';
+import type { ExecutionHashBase, ProfileHashBase, StorageHashBase } from './types';
+
+const SCHEMA_VERSION = '1';
+
+function sha256(content: string): string {
+  const hash = createHash('sha256');
+  hash.update(content);
+  return `sha256:${hash.digest('hex')}`;
+}
+
+function hashContract(section: Record<string, unknown>): string {
+  const contract = {
+    targetFamily: section['targetFamily'],
+    target: section['target'],
+    roots: {},
+    models: {},
+    storage: section['storage'] ?? {},
+    execution: section['execution'],
+    extensionPacks: {},
+    capabilities: section['capabilities'] ?? {},
+    meta: {},
+    profileHash: '',
+    ...section,
+  } as Contract;
+  return canonicalizeContract(contract, { schemaVersion: SCHEMA_VERSION });
+}
+
+export function computeStorageHash(args: {
+  target: string;
+  targetFamily: string;
+  storage: Record<string, unknown>;
+}): StorageHashBase<string> {
+  return sha256(hashContract(args)) as StorageHashBase<string>;
+}
+
+export function computeExecutionHash(args: {
+  target: string;
+  targetFamily: string;
+  execution: Record<string, unknown>;
+}): ExecutionHashBase<string> {
+  return sha256(hashContract(args)) as ExecutionHashBase<string>;
+}
+
+export function computeProfileHash(args: {
+  target: string;
+  targetFamily: string;
+  capabilities: Record<string, Record<string, boolean>>;
+}): ProfileHashBase<string> {
+  return sha256(hashContract(args)) as ProfileHashBase<string>;
+}

package/src/testing-factories.ts

@@ -0,0 +1,101 @@
+import { ifDefined } from '@prisma-next/utils/defined';
+import type { Contract } from './contract-types';
+import type {
+  ContractModel,
+  ContractModelBase,
+  ContractValueObject,
+  ModelStorageBase,
+} from './domain-types';
+import { computeExecutionHash, computeProfileHash, computeStorageHash } from './hashing';
+import type { ExecutionSection, ProfileHashBase, StorageBase } from './types';
+import { coreHash } from './types';
+
+type ContractOverrides<
+  TStorage extends StorageBase = StorageBase,
+  TModels extends Record<string, ContractModelBase> = Record<string, ContractModel>,
+> = {
+  target?: string;
+  targetFamily?: string;
+  roots?: Record<string, string>;
+  models?: TModels;
+  storage?: Omit<TStorage, 'storageHash'>;
+  valueObjects?: Record<string, ContractValueObject>;
+  capabilities?: Record<string, Record<string, boolean>>;
+  extensionPacks?: Record<string, unknown>;
+  execution?: Omit<ExecutionSection, 'executionHash'>;
+  profileHash?: ProfileHashBase<string>;
+  meta?: Record<string, unknown>;
+};
+
+const DUMMY_HASH = coreHash('sha256:test');
+
+export function createContract<
+  TStorage extends StorageBase = StorageBase,
+  TModels extends Record<string, ContractModelBase> = Record<string, ContractModel>,
+>(overrides: ContractOverrides<TStorage, TModels> = {}): Contract<TStorage, TModels> {
+  const target = overrides.target ?? 'postgres';
+  const targetFamily = overrides.targetFamily ?? 'sql';
+  const capabilities = overrides.capabilities ?? {};
+
+  const rawStorage =
+    overrides.storage ?? ({ tables: {} } as unknown as Omit<TStorage, 'storageHash'>);
+
+  const storageHash = computeStorageHash({
+    target,
+    targetFamily,
+    storage: rawStorage as Record<string, unknown>,
+  });
+
+  const storage = {
+    ...rawStorage,
+    storageHash,
+  } as TStorage;
+
+  const computedProfileHash =
+    overrides.profileHash ?? computeProfileHash({ target, targetFamily, capabilities });
+
+  return {
+    target,
+    targetFamily,
+    roots: overrides.roots ?? {},
+    models: (overrides.models ?? {}) as TModels,
+    ...ifDefined('valueObjects', overrides.valueObjects),
+    storage,
+    capabilities,
+    extensionPacks: overrides.extensionPacks ?? {},
+    ...(overrides.execution !== undefined
+      ? {
+          execution: {
+            ...overrides.execution,
+            executionHash: computeExecutionHash({
+              target,
+              targetFamily,
+              execution: overrides.execution,
+            }),
+          },
+        }
+      : {}),
+    profileHash: computedProfileHash,
+    meta: overrides.meta ?? {},
+  };
+}
+
+type SqlStorageLike = StorageBase & {
+  readonly tables: Record<string, unknown>;
+  readonly types?: Record<string, unknown>;
+};
+
+type SqlModelLike = ContractModel<ModelStorageBase & { table: string }>;
+
+export function createSqlContract(
+  overrides: ContractOverrides<SqlStorageLike, Record<string, SqlModelLike>> = {},
+): Contract<SqlStorageLike, Record<string, SqlModelLike>> {
+  return createContract<SqlStorageLike, Record<string, SqlModelLike>>({
+    target: 'postgres',
+    targetFamily: 'sql',
+    storage: overrides.storage ?? { tables: {} },
+    ...overrides,
+  });
+}
+
+export { DUMMY_HASH };