@prisma-next/target-mongo 0.3.0 → 0.4.0-dev.2

package/README.md

@@ -7,14 +7,18 @@ MongoDB target pack for Prisma Next.
 - **Target pack assembly**: Exports the MongoDB target pack for authoring and family composition
 - **Target metadata**: Defines the stable Mongo target identity (`kind`, `familyId`, `targetId`, `version`, `capabilities`)
 - **Codec type surface**: Exposes the base Mongo codec type map used by authoring-time type composition
+- **Migration operation factories**: Factory functions for MongoDB migration operations
 
 ## Entrypoints
 
 - `./pack`: pure target pack ref used by `@prisma-next/family-mongo` and `@prisma-next/mongo-contract-ts`
 - `./codec-types`: base Mongo codec type map
+- `./migration`: factory functions (the `Migration` base class is in `@prisma-next/family-mongo/migration`)
 
 ## Usage
 
+### Contract definition
+
 ```typescript
 import mongoFamily from '@prisma-next/family-mongo/pack';
 import { defineContract } from '@prisma-next/mongo-contract-ts/contract-builder';
@@ -25,3 +29,36 @@ const contract = defineContract({
   target: mongoTarget,
 });
 ```
+
+### Migration authoring
+
+```typescript
+import { Migration } from '@prisma-next/family-mongo/migration';
+import { createIndex, createCollection } from '@prisma-next/target-mongo/migration';
+
+class UsersMigration extends Migration {
+  plan() {
+    return [
+      createCollection("users", {
+        validator: { $jsonSchema: { required: ["email"] } },
+        validationLevel: "strict",
+      }),
+      createIndex("users", [{ field: "email", direction: 1 }], { unique: true }),
+    ]
+  }
+}
+
+export default UsersMigration;
+Migration.run(import.meta.url, UsersMigration)
+```
+
+Run `tsx migration.ts` to produce `ops.json` and `migration.json` (when `describe()` is implemented). Use `--dry-run` to preview without writing.
+
+### Available factories
+
+- `createIndex(collection, keys, options?)` — create an index
+- `dropIndex(collection, keys)` — drop an index
+- `createCollection(collection, options?)` — create a collection
+- `dropCollection(collection)` — drop a collection
+- `setValidation(collection, schema, options?)` — set document validation on a collection
+- `validatedCollection(name, schema, indexes)` — create a collection with a JSON Schema validator and indexes

package/dist/control.d.mts

@@ -1,6 +1,30 @@
+import { a as DropCollectionCall, c as OpFactoryCallVisitor, i as CreateIndexCall, l as schemaCollectionToCreateCollectionOptions, n as CollModMeta, o as DropIndexCall, r as CreateCollectionCall, s as OpFactoryCall, t as CollModCall, u as schemaIndexToCreateIndexOptions } from "./op-factory-call-CfPGebEH.mjs";
+import { MongoSchemaIR } from "@prisma-next/mongo-schema-ir";
+import { MongoAndExpr, MongoDdlCommandVisitor, MongoExistsExpr, MongoExprFilter, MongoFieldFilter, MongoFilterExpr, MongoFilterVisitor, MongoInspectionCommandVisitor, MongoMigrationPlanOperation, MongoNotExpr, MongoOrExpr } from "@prisma-next/mongo-query-ast/control";
+import { MongoContract } from "@prisma-next/mongo-contract";
+import { MigrationOperationPolicy, MigrationPlan, MigrationPlanOperation, MigrationPlanner, MigrationPlannerConflict, MigrationPlannerResult, MigrationRunnerExecutionChecks, MigrationRunnerResult } from "@prisma-next/framework-components/control";
 import { ContractMarkerRecord } from "@prisma-next/contract/types";
 import { Db } from "mongodb";
+import { TargetBoundComponentDescriptor } from "@prisma-next/framework-components/components";
 
+//#region src/core/contract-to-schema.d.ts
+declare function contractToMongoSchemaIR(contract: MongoContract | null): MongoSchemaIR;
+//#endregion
+//#region src/core/ddl-formatter.d.ts
+declare function formatMongoOperations(operations: readonly MigrationPlanOperation[]): string[];
+//#endregion
+//#region src/core/filter-evaluator.d.ts
+declare class FilterEvaluator implements MongoFilterVisitor<boolean> {
+  private doc;
+  evaluate(filter: MongoFilterExpr, doc: Record<string, unknown>): boolean;
+  field(expr: MongoFieldFilter): boolean;
+  and(expr: MongoAndExpr): boolean;
+  or(expr: MongoOrExpr): boolean;
+  not(expr: MongoNotExpr): boolean;
+  exists(expr: MongoExistsExpr): boolean;
+  expr(_expr: MongoExprFilter): boolean;
+}
+//#endregion
 //#region src/core/marker-ledger.d.ts
 declare function readMarker(db: Db): Promise<ContractMarkerRecord | null>;
 declare function initMarker(db: Db, destination: {
@@ -17,5 +41,87 @@ declare function writeLedgerEntry(db: Db, entry: {
   readonly to: string;
 }): Promise<void>;
 //#endregion
-export { initMarker, readMarker, updateMarker, writeLedgerEntry };
+//#region src/core/mongo-ops-serializer.d.ts
+declare function deserializeMongoOp(json: unknown): MongoMigrationPlanOperation;
+declare function deserializeMongoOps(json: readonly unknown[]): MongoMigrationPlanOperation[];
+declare function serializeMongoOps(ops: readonly MongoMigrationPlanOperation[]): string;
+//#endregion
+//#region src/core/mongo-planner.d.ts
+type PlanCallsResult = {
+  readonly kind: 'success';
+  readonly calls: OpFactoryCall[];
+} | {
+  readonly kind: 'failure';
+  readonly conflicts: MigrationPlannerConflict[];
+};
+declare class MongoMigrationPlanner implements MigrationPlanner<'mongo', 'mongo'> {
+  planCalls(options: {
+    readonly contract: unknown;
+    readonly schema: unknown;
+    readonly policy: MigrationOperationPolicy;
+    readonly frameworkComponents: ReadonlyArray<TargetBoundComponentDescriptor<'mongo', 'mongo'>>;
+  }): PlanCallsResult;
+  plan(options: {
+    readonly contract: unknown;
+    readonly schema: unknown;
+    readonly policy: MigrationOperationPolicy;
+    readonly frameworkComponents: ReadonlyArray<TargetBoundComponentDescriptor<'mongo', 'mongo'>>;
+  }): MigrationPlannerResult;
+}
+//#endregion
+//#region src/core/mongo-runner.d.ts
+interface MarkerOperations {
+  readMarker(): Promise<ContractMarkerRecord | null>;
+  initMarker(destination: {
+    readonly storageHash: string;
+    readonly profileHash: string;
+  }): Promise<void>;
+  updateMarker(expectedFrom: string, destination: {
+    readonly storageHash: string;
+    readonly profileHash: string;
+  }): Promise<boolean>;
+  writeLedgerEntry(entry: {
+    readonly edgeId: string;
+    readonly from: string;
+    readonly to: string;
+  }): Promise<void>;
+}
+interface MongoRunnerDependencies {
+  readonly commandExecutor: MongoDdlCommandVisitor<Promise<void>>;
+  readonly inspectionExecutor: MongoInspectionCommandVisitor<Promise<Record<string, unknown>[]>>;
+  readonly markerOps: MarkerOperations;
+}
+declare class MongoMigrationRunner {
+  private readonly deps;
+  constructor(deps: MongoRunnerDependencies);
+  execute(options: {
+    readonly plan: MigrationPlan;
+    readonly destinationContract: unknown;
+    readonly policy: MigrationOperationPolicy;
+    readonly callbacks?: {
+      onOperationStart?(op: MigrationPlanOperation): void;
+      onOperationComplete?(op: MigrationPlanOperation): void;
+    };
+    readonly executionChecks?: MigrationRunnerExecutionChecks;
+    readonly frameworkComponents: ReadonlyArray<TargetBoundComponentDescriptor<'mongo', 'mongo'>>;
+  }): Promise<MigrationRunnerResult>;
+  private evaluateChecks;
+  private allChecksSatisfied;
+  private enforcePolicyCompatibility;
+  private ensureMarkerCompatibility;
+}
+//#endregion
+//#region src/core/render-ops.d.ts
+declare function renderOps(calls: ReadonlyArray<OpFactoryCall>): MongoMigrationPlanOperation[];
+//#endregion
+//#region src/core/render-typescript.d.ts
+interface RenderMigrationMeta {
+  readonly from: string;
+  readonly to: string;
+  readonly kind?: string;
+  readonly labels?: readonly string[];
+}
+declare function renderTypeScript(calls: ReadonlyArray<OpFactoryCall>, meta?: RenderMigrationMeta): string;
+//#endregion
+export { CollModCall, type CollModMeta, CreateCollectionCall, CreateIndexCall, DropCollectionCall, DropIndexCall, FilterEvaluator, type MarkerOperations, MongoMigrationPlanner, MongoMigrationRunner, type MongoRunnerDependencies, type OpFactoryCall, type OpFactoryCallVisitor, type PlanCallsResult, type RenderMigrationMeta, contractToMongoSchemaIR, deserializeMongoOp, deserializeMongoOps, formatMongoOperations, initMarker, readMarker, renderOps, renderTypeScript, schemaCollectionToCreateCollectionOptions, schemaIndexToCreateIndexOptions, serializeMongoOps, updateMarker, writeLedgerEntry };
 //# sourceMappingURL=control.d.mts.map

package/dist/control.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"control.d.mts","names":[],"sources":["../src/core/marker-ledger.ts"],"sourcesContent":[],"mappings":";;;;iBA+BsB,UAAA,KAAe,KAAK,QAAQ;iBAgB5B,UAAA,KAChB;EAjBgB,SAAA,WAAU,EAAA,MAAA;EAAK,SAAA,WAAA,EAAA,MAAA;CAAa,CAAA,EAmB/C,OAnB+C,CAAA,IAAA,CAAA;AAAR,iBAiCpB,YAAA,CAjCoB,EAAA,EAkCpC,EAlCoC,EAAA,YAAA,EAAA,MAAA,EAAA,WAAA,EAAA;EAAO,SAAA,WAAA,EAAA,MAAA;EAgB3B,SAAA,WAAU,EAAA,MAG7B;AAcH,CAAA,CAAA,EAIG,OAJmB,CAAA,OAAY,CAAA;AAqBZ,iBAAA,gBAAA,CAGnB,EAAA,EAFG,EAEI,EAAA,KAAA,EAAA;;;;IAAP"}
+{"version":3,"file":"control.d.mts","names":[],"sources":["../src/core/contract-to-schema.ts","../src/core/ddl-formatter.ts","../src/core/filter-evaluator.ts","../src/core/marker-ledger.ts","../src/core/mongo-ops-serializer.ts","../src/core/mongo-planner.ts","../src/core/mongo-runner.ts","../src/core/render-ops.ts","../src/core/render-typescript.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;iBAoDgB,uBAAA,WAAkC,uBAAuB;;;iBC6CzD,qBAAA,sBAA2C;;;cC/C9C,eAAA,YAA2B;;mBAGrB,sBAAsB;cAK3B;YAKF;WAID;YAIC;eAIG;cAKD;AF5Bd;;;iBGrBsB,UAAA,KAAe,KAAK,QAAQ;iBAgB5B,UAAA,KAChB;;;IAEH;iBAcmB,YAAA,KAChB;;;AHbN,CAAA,CAAA,EGgBG,OHhBa,CAAA,OAAA,CAAA;iBGiCM,gBAAA,KAChB;;;EFWU,SAAA,EAAA,EAAA,MAAA;IETb;;;iBC0Ka,kBAAA,iBAAmC;iBAYnC,mBAAA,4BAA+C;iBAI/C,iBAAA,eAAgC;;;KChLpC,eAAA;;kBACoC;;;sBACI;;ALhDpC,cKkDH,qBAAA,YAAiC,gBLlD2B,CAAa,OAAA,EAAA,OAAA,CAAA,CAAA;;;;IC6CtE,SAAA,MAAA,EISK,wBJTsC;kCIUzB,cAAc;MAC1C;;IH1DO,SAAA,QAAgB,EAAA,OAAA;IAGV,SAAA,MAAA,EAAA,OAAA;IAAsB,SAAA,MAAA,EG2KpB,wBH3KoB;IAK3B,SAAA,mBAAA,EGuKoB,aHvKpB,CGuKkC,8BHvKlC,CAAA,OAAA,EAAA,OAAA,CAAA,CAAA;EAKF,CAAA,CAAA,EGmKN,sBHnKM;;;;UI3CK,gBAAA;gBACD,QAAQ;;;;MAIlB;EN2BU,YAAA,CAAA,YAAA,EAAuB,MAAA,EAAA,WAAW,EAAA;;;MMvB7C;ELoEW,gBAAA,CAAA,KAAA,EAAqB;;;;EC/CxB,CAAA,CAAA,EIhBP,OJgBO,CAAA,IAAA,CAAA;;AAG4B,UIhBxB,uBAAA,CJgBwB;EAK3B,SAAA,eAAA,EIpBc,sBJoBd,CIpBqC,OJoBrC,CAAA,IAAA,CAAA,CAAA;EAKF,SAAA,kBAAA,EIxBmB,6BJwBnB,CIxBiD,OJwBjD,CIxByD,MJwBzD,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,CAAA,CAAA;EAID,SAAA,SAAA,EI3BW,gBJ2BX;;AAQI,cIpBF,oBAAA,CJoBE;EAKD,iBAAA,IAAA;EA9B0B,WAAA,CAAA,IAAA,EIMH,uBJNG;EAAkB,OAAA,CAAA,OAAA,EAAA;mBISvC;;qBAEE;IH9BC,SAAU,SAAA,CAAA,EAAA;MAAK,gBAAA,EAAA,EAAA,EGgCT,sBHhCS,CAAA,EAAA,IAAA;MAAa,mBAAA,EAAA,EAAA,EGiCnB,sBHjCmB,CAAA,EAAA,IAAA;IAAR,CAAA;IAAO,SAAA,eAAA,CAAA,EGmClB,8BHnCkB;IAgB3B,SAAU,mBAG7B,EGiB+B,aHjBxB,CGiBsC,8BHjBtC,CAAA,OAAA,EAAA,OAAA,CAAA,CAAA;EAcY,CAAA,CAAA,EGIhB,OHJgB,CGIR,qBHAX,CAAA;EAiBmB,QAAA,cAAgB;;;;AC6KtC;;;iBG9NgB,SAAA,QAAiB,cAAc,iBAAiB;;;UC1B/C,mBAAA;;;;;;iBAOD,gBAAA,QACP,cAAc,uBACd"}