@prisma-next/mongo-codec 0.5.0-dev.7 → 0.5.0-dev.70

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -4,10 +4,55 @@ Codec interface and registry for MongoDB value serialization.
4
4
 
5
5
  ## Responsibilities
6
6
 
7
- - **Codec interface**: `MongoCodec<Id, TTraits, TWire, TJs>` — defines encode/decode between wire (BSON) and JS representations, with trait annotations (`equality`, `order`, `boolean`, `numeric`, `textual`, `vector`)
8
- - **Codec factory**: `mongoCodec()` — creates frozen codec instances from a config object
9
- - **Codec registry**: `MongoCodecRegistry` and `createMongoCodecRegistry()` — a map-based container that stores and retrieves codecs by ID, with duplicate-ID protection
10
- - **Type-level helpers**: `MongoCodecJsType<T>` and `MongoCodecTraits<T>` for extracting JS types and traits from codec types
7
+ - **Codec interface**: `MongoCodec<Id, TTraits, TWire, TInput>` — declares how a JS value translates to and from the BSON-shaped wire format the Mongo driver exchanges, plus the JSON-safe form stored in contract artifacts. Same four generics as the framework `Codec` base; the codec instance carries only `id` plus the four conversion methods. Trait annotations (`equality`, `order`, `boolean`, `numeric`, `textual`, `vector`) for operator gating live on the unified `CodecDescriptor` (see [ADR 208](../../../../docs/architecture%20docs/adrs/ADR%20208%20-%20Higher-order%20codecs%20for%20parameterized%20types.md)).
8
+ - **Codec factory**: `mongoCodec()` — creates frozen codec instances from a config object. Both `encode` and `decode` are required so `TInput` and `TWire` are always covered by an explicit author function — the factory installs no identity fallback. `encode` and `decode` may be authored as sync or async functions and are lifted to Promise-returning query-time methods automatically. Build-time methods (`encodeJson`, `decodeJson`) are synchronous and default to identity when omitted.
9
+ - **Codec registry**: `MongoCodecRegistry` and `newMongoCodecRegistry()` — a map-based container that stores and retrieves codecs by ID, with duplicate-ID protection
10
+ - **Type-level helper**: `MongoCodecInput<T>` for extracting the JS application type from a codec type. Trait metadata lives on the unified `CodecDescriptor` (see [ADR 208](../../../../docs/architecture%20docs/adrs/ADR%20208%20-%20Higher-order%20codecs%20for%20parameterized%20types.md)).
11
+
12
+ ## Examples
13
+
14
+ ```ts
15
+ // Sync authoring:
16
+ const intCodec = mongoCodec({
17
+ typeId: 'mongo/int@1',
18
+ encode: (v: number) => v,
19
+ decode: (w: number) => w,
20
+ encodeJson: (v: number) => v,
21
+ decodeJson: (j: number) => j,
22
+ });
23
+
24
+ // Async authoring (e.g. KMS-backed encryption): same factory, same shape.
25
+ const secretCodec = mongoCodec({
26
+ typeId: 'mongo/secret@1',
27
+ encode: async (v: string) => encrypt(v, await getKey()),
28
+ decode: async (w: string) => decrypt(w, await getKey()),
29
+ encodeJson: (v: string) => v,
30
+ decodeJson: (j: string) => j,
31
+ });
32
+ ```
33
+
34
+ ### Codec call context (`ctx`)
35
+
36
+ Codecs receive a second `ctx` options argument; you may ignore it. The Mongo runtime allocates one `CodecCallContext` per `mongoRuntime.execute(plan, { signal })` call and threads the same reference to every codec dispatch site as a non-optional argument — when no `signal` is supplied the runtime still threads an empty `{}`, never `undefined`. Mongo uses the framework `CodecCallContext` directly (signal-only); column metadata is SQL-family-specific and isn't part of Mongo's per-call shape today. The internal `MongoCodec` interface declares the parameter as required (`encode(value, ctx: CodecCallContext)` / `decode(wire, ctx: CodecCallContext)`); single-arg author functions `(value) => …` continue to compile via TypeScript's bivariance for trailing parameters, so codec ergonomics are unchanged. The `signal` field on the ctx may be `undefined` when the caller didn't supply one.
37
+
38
+ ```ts
39
+ // Forward ctx.signal to a network SDK so aborted queries stop the round-trip.
40
+ const kmsSecretCodec = mongoCodec({
41
+ typeId: 'mongo/kms-secret@1',
42
+ encode: async (v: string, ctx) =>
43
+ kms.encrypt({ plaintext: v }, { signal: ctx?.signal }),
44
+ decode: async (w: string, ctx) =>
45
+ kms.decrypt({ ciphertext: w }, { signal: ctx?.signal }),
46
+ encodeJson: (v: string) => v,
47
+ decodeJson: (j: string) => j,
48
+ });
49
+ ```
50
+
51
+ > **Note.** Mongo's read path doesn't go through `codec.decode` (per ADR 204 cross-family scope notes), so the `decode` signature above accepts `ctx` for parity with the codec interface but the runtime doesn't currently invoke `decode` on the Mongo read side. Encode-side `ctx.signal` is observed at every recursion level of `resolveValue` so a mid-encode abort surfaces as `RUNTIME.ABORTED { phase: 'encode' }`.
52
+
53
+ Codec bodies that ignore `ctx.signal` complete in the background (cooperative cancellation); aborts still surface to the caller as `RUNTIME.ABORTED`.
54
+
55
+ See [ADR 204 — Single-Path Async Codec Runtime](../../../../docs/architecture%20docs/adrs/ADR%20204%20-%20Single-Path%20Async%20Codec%20Runtime.md) for the codec runtime's async boundary contract, and [ADR 207 — Codec call context: per-query `AbortSignal` and column metadata](../../../../docs/architecture%20docs/adrs/ADR%20207%20-%20Codec%20call%20context%20per-query%20AbortSignal%20and%20column%20metadata.md) for the per-call context shape.
11
56
 
12
57
  ## Dependencies
13
58
 
package/dist/index.d.mts CHANGED
@@ -1,23 +1,40 @@
1
1
  import { JsonValue } from "@prisma-next/contract/types";
2
- import { Codec, CodecTrait } from "@prisma-next/framework-components/codec";
2
+ import { Codec, CodecCallContext, CodecTrait } from "@prisma-next/framework-components/codec";
3
3
 
4
4
  //#region src/codecs.d.ts
5
5
  type MongoCodecTrait = CodecTrait;
6
- interface MongoCodec<Id extends string = string, TTraits$1 extends readonly MongoCodecTrait[] = readonly MongoCodecTrait[], TWire = unknown, TJs = unknown> extends Codec<Id, TTraits$1, TWire, TJs> {
7
- readonly traits: TTraits$1;
8
- }
9
- declare function mongoCodec<Id extends string, const TTraits$1 extends readonly MongoCodecTrait[] = readonly [], TWire = unknown, TJs = unknown>(config: {
6
+ /**
7
+ * A codec for the Mongo target. Translates between an application value and the BSON-shaped wire form the Mongo driver exchanges, and between an application value and the JSON form stored in contract artifacts.
8
+ *
9
+ * Same shape as the framework codec base see `Codec` in `@prisma-next/framework-components/codec` for the contract. Codec-id-keyed static metadata (`traits`, `targetTypes`, `renderOutputType`) lives on the unified {@link import('@prisma-next/framework-components/codec').CodecDescriptor}; Mongo's full migration to descriptor-side registration is tracked under TML-2324.
10
+ */
11
+ interface MongoCodec<Id extends string = string, TTraits extends readonly MongoCodecTrait[] = readonly MongoCodecTrait[], TWire = unknown, TInput = unknown> extends Codec<Id, TTraits, TWire, TInput> {}
12
+ /**
13
+ * Conditional bundle for `encodeJson`/`decodeJson`: when `TInput` is structurally assignable to `JsonValue` the identity defaults are sound and both fields are optional; otherwise both fields are required so an author cannot silently produce a non-JSON-safe contract artifact.
14
+ */
15
+ type JsonRoundTripConfig<TInput> = [TInput] extends [JsonValue] ? {
16
+ encodeJson?: (value: TInput) => JsonValue;
17
+ decodeJson?: (json: JsonValue) => TInput;
18
+ } : {
19
+ encodeJson: (value: TInput) => JsonValue;
20
+ decodeJson: (json: JsonValue) => TInput;
21
+ };
22
+ /**
23
+ * Construct a Mongo codec from author functions.
24
+ *
25
+ * Author `encode` and `decode` as sync or async functions; the factory produces a {@link MongoCodec} whose query-time methods follow the boundary contract documented on the framework {@link BaseCodec}. Authors receive a second `ctx` options argument carrying the per-call context; ignore it if you don't need it.
26
+ *
27
+ * Both `encode` and `decode` are required so `TInput` and `TWire` are always covered by an explicit author function — the factory installs no identity fallback. `encodeJson` and `decodeJson` default to identity **only when `TInput` is assignable to `JsonValue`**; otherwise both are required so the contract artifact stays JSON-safe.
28
+ *
29
+ * Codec-id-keyed static metadata (`traits`, `targetTypes`, `renderOutputType`) lives on the unified `CodecDescriptor` rather than on the codec instance itself (TML-2357).
30
+ */
31
+ declare function mongoCodec<Id extends string, const TTraits extends readonly MongoCodecTrait[] = readonly [], TWire = unknown, TInput = unknown>(config: {
10
32
  typeId: Id;
11
- targetTypes: readonly string[];
12
- traits?: TTraits$1;
13
- encode: (value: TJs) => TWire;
14
- decode: (wire: TWire) => TJs;
15
- encodeJson?: (value: TJs) => JsonValue;
16
- decodeJson?: (json: JsonValue) => TJs;
17
- renderOutputType?: (typeParams: Record<string, unknown>) => string | undefined;
18
- }): MongoCodec<Id, TTraits$1, TWire, TJs>;
19
- type MongoCodecJsType<T> = T extends MongoCodec<string, readonly MongoCodecTrait[], unknown, infer TJs> ? TJs : never;
20
- type MongoCodecTraits<T> = T extends MongoCodec<string, infer TTraits> ? TTraits[number] & MongoCodecTrait : never;
33
+ encode: (value: TInput, ctx: CodecCallContext) => TWire | Promise<TWire>;
34
+ decode: (wire: TWire, ctx: CodecCallContext) => TInput | Promise<TInput>;
35
+ } & JsonRoundTripConfig<TInput>): MongoCodec<Id, TTraits, TWire, TInput>;
36
+ /** Extract the JS application type carried by a Mongo codec — used both as `encode` input and as `decode` output. */
37
+ type MongoCodecInput<T> = T extends MongoCodec<string, readonly MongoCodecTrait[], unknown, infer TInput> ? TInput : never;
21
38
  //#endregion
22
39
  //#region src/codec-registry.d.ts
23
40
  interface MongoCodecRegistry {
@@ -27,7 +44,10 @@ interface MongoCodecRegistry {
27
44
  [Symbol.iterator](): Iterator<MongoCodec<string>>;
28
45
  values(): IterableIterator<MongoCodec<string>>;
29
46
  }
30
- declare function createMongoCodecRegistry(): MongoCodecRegistry;
47
+ /**
48
+ * Create a new Mongo codec registry. Inline object literal — no class implementation; the registry is just a private `Map` with the documented surface methods.
49
+ */
50
+ declare function newMongoCodecRegistry(): MongoCodecRegistry;
31
51
  //#endregion
32
- export { type MongoCodec, type MongoCodecJsType, type MongoCodecRegistry, type MongoCodecTrait, type MongoCodecTraits, createMongoCodecRegistry, mongoCodec };
52
+ export { type MongoCodec, type MongoCodecInput, type MongoCodecRegistry, type MongoCodecTrait, mongoCodec, newMongoCodecRegistry };
33
53
  //# sourceMappingURL=index.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.mts","names":[],"sources":["../src/codecs.ts","../src/codec-registry.ts"],"sourcesContent":[],"mappings":";;;;KAGY,eAAA,GAAkB;UAEb,kEAEU,6BAA6B,2DAG9C,MAAU,IAAI,WAAS,OAAO;EAP5B,SAAA,MAAA,EAQO,SARQ;AAE3B;AAE2B,iBAOX,UAPW,CAAA,WAAA,MAAA,EAAA,wBAAA,SASM,eATN,EAAA,GAAA,SAAA,EAAA,EAAA,QAAA,OAAA,EAAA,MAAA,OAAA,CAAA,CAAA,MAAA,EAAA;EAA6B,MAAA,EAa9C,EAb8C;EAGpC,WAAA,EAAA,SAAA,MAAA,EAAA;EAAI,MAAA,CAAA,EAYb,SAZa;EAAS,MAAA,EAAA,CAAA,KAAA,EAaf,GAbe,EAAA,GAaP,KAbO;EAAO,MAAA,EAAA,CAAA,IAAA,EAcvB,KAduB,EAAA,GAcb,GAda;EACrB,UAAA,CAAA,EAAA,CAAA,KAAA,EAcI,GAdJ,EAAA,GAcY,SAdZ;EADT,UAAA,CAAA,EAAA,CAAA,IAAA,EAgBY,SAhBZ,EAAA,GAgB0B,GAhB1B;EAAS,gBAAA,CAAA,EAAA,CAAA,UAAA,EAiBe,MAjBf,CAAA,MAAA,EAAA,OAAA,CAAA,EAAA,GAAA,MAAA,GAAA,SAAA;AAInB,CAAA,CAAA,EAcI,UAdY,CAcD,EAdW,EAcP,SAdO,EAcE,KAdF,EAcS,GAdT,CAAA;AAEO,KA6BrB,gBA7BqB,CAAA,CAAA,CAAA,GA8B/B,CA9B+B,SA8BrB,UA9BqB,CAAA,MAAA,EAAA,SA8BO,eA9BP,EAAA,EAAA,OAAA,EAAA,KAAA,IAAA,CAAA,GAAA,GAAA,GAAA,KAAA;AAIvB,KA4BE,gBA5BF,CAAA,CAAA,CAAA,GA6BR,CA7BQ,SA6BE,UA7BF,CAAA,MAAA,EAAA,KAAA,QAAA,CAAA,GA6BsC,OA7BtC,CAAA,MAAA,CAAA,GA6BwD,eA7BxD,GAAA,KAAA;;;UClBO,kBAAA;mBACE;;EDAP,QAAA,CAAA,KAAA,ECEM,UDFS,CAAA,MAAG,CAAA,CAAA,EAAA,IAAU;EAEvB,CAAA,MAAA,CAAA,QAAU,GAAA,ECCJ,QDDI,CCCK,UDDL,CAAA,MAAA,CAAA,CAAA;EAEA,MAAA,EAAA,ECAf,gBDAe,CCAE,UDAF,CAAA,MAAA,CAAA,CAAA;;AAGP,iBC2BJ,wBAAA,CAAA,CD3BI,EC2BwB,kBD3BxB"}
1
+ {"version":3,"file":"index.d.mts","names":[],"sources":["../src/codecs.ts","../src/codec-registry.ts"],"mappings":";;;;KAOY,eAAA,GAAkB,UAAA;;AAA9B;;;;UAOiB,UAAA,sDAEU,eAAA,cAA6B,eAAA,+CAG9C,KAAA,CAAU,EAAA,EAAI,OAAA,EAAS,KAAA,EAAO,MAAA;;;;KAKnC,mBAAA,YAA+B,MAAA,WAAiB,SAAA;EAE/C,UAAA,IAAc,KAAA,EAAO,MAAA,KAAW,SAAA;EAChC,UAAA,IAAc,IAAA,EAAM,SAAA,KAAc,MAAA;AAAA;EAGlC,UAAA,GAAa,KAAA,EAAO,MAAA,KAAW,SAAA;EAC/B,UAAA,GAAa,IAAA,EAAM,SAAA,KAAc,MAAA;AAAA;;;;;;;;;;iBAYvB,UAAA,mDAEiB,eAAA,oDAAA,CAI/B,MAAA;EACE,MAAA,EAAQ,EAAA;EACR,MAAA,GAAS,KAAA,EAAO,MAAA,EAAQ,GAAA,EAAK,gBAAA,KAAqB,KAAA,GAAQ,OAAA,CAAQ,KAAA;EAClE,MAAA,GAAS,IAAA,EAAM,KAAA,EAAO,GAAA,EAAK,gBAAA,KAAqB,MAAA,GAAS,OAAA,CAAQ,MAAA;AAAA,IAC/D,mBAAA,CAAoB,MAAA,IACvB,UAAA,CAAW,EAAA,EAAI,OAAA,EAAS,KAAA,EAAO,MAAA;AAnCgB;AAAA,KAkEtC,eAAA,MACV,CAAA,SAAU,UAAA,kBAA4B,eAAA,6BAA4C,MAAA;;;UCpFnE,kBAAA;EACf,GAAA,CAAI,EAAA,WAAa,UAAA;EACjB,GAAA,CAAI,EAAA;EACJ,QAAA,CAAS,KAAA,EAAO,UAAA;EAAA,CACf,MAAA,CAAO,QAAP,KAAoB,QAAA,CAAS,UAAA;EAC9B,MAAA,IAAU,gBAAA,CAAiB,UAAA;AAAA;;ADO7B;;iBCDgB,qBAAA,CAAA,GAAyB,kBAAA"}
package/dist/index.mjs CHANGED
@@ -1,44 +1,59 @@
1
1
  //#region src/codec-registry.ts
2
- var MongoCodecRegistryImpl = class {
3
- #byId = /* @__PURE__ */ new Map();
4
- get(id) {
5
- return this.#byId.get(id);
6
- }
7
- has(id) {
8
- return this.#byId.has(id);
9
- }
10
- register(codec) {
11
- if (this.#byId.has(codec.id)) throw new Error(`Codec with ID '${codec.id}' is already registered`);
12
- this.#byId.set(codec.id, codec);
13
- }
14
- *[Symbol.iterator]() {
15
- yield* this.#byId.values();
16
- }
17
- values() {
18
- return this.#byId.values();
19
- }
20
- };
21
- function createMongoCodecRegistry() {
22
- return new MongoCodecRegistryImpl();
2
+ /**
3
+ * Create a new Mongo codec registry. Inline object literal — no class implementation; the registry is just a private `Map` with the documented surface methods.
4
+ */
5
+ function newMongoCodecRegistry() {
6
+ const byId = /* @__PURE__ */ new Map();
7
+ return {
8
+ get: (id) => byId.get(id),
9
+ has: (id) => byId.has(id),
10
+ register: (codec) => {
11
+ if (byId.has(codec.id)) throw new Error(`Codec with ID '${codec.id}' is already registered`);
12
+ byId.set(codec.id, codec);
13
+ },
14
+ values: () => byId.values(),
15
+ [Symbol.iterator]: function* () {
16
+ yield* byId.values();
17
+ }
18
+ };
23
19
  }
24
-
25
20
  //#endregion
26
21
  //#region src/codecs.ts
22
+ /**
23
+ * Construct a Mongo codec from author functions.
24
+ *
25
+ * Author `encode` and `decode` as sync or async functions; the factory produces a {@link MongoCodec} whose query-time methods follow the boundary contract documented on the framework {@link BaseCodec}. Authors receive a second `ctx` options argument carrying the per-call context; ignore it if you don't need it.
26
+ *
27
+ * Both `encode` and `decode` are required so `TInput` and `TWire` are always covered by an explicit author function — the factory installs no identity fallback. `encodeJson` and `decodeJson` default to identity **only when `TInput` is assignable to `JsonValue`**; otherwise both are required so the contract artifact stays JSON-safe.
28
+ *
29
+ * Codec-id-keyed static metadata (`traits`, `targetTypes`, `renderOutputType`) lives on the unified `CodecDescriptor` rather than on the codec instance itself (TML-2357).
30
+ */
27
31
  function mongoCodec(config) {
28
- const traits = config.traits ? Object.freeze([...config.traits]) : Object.freeze([]);
29
32
  const identity = (v) => v;
33
+ const userEncode = config.encode;
34
+ const userDecode = config.decode;
35
+ const widenedConfig = config;
30
36
  return {
31
37
  id: config.typeId,
32
- targetTypes: config.targetTypes,
33
- traits,
34
- decode: config.decode,
35
- encode: config.encode,
36
- encodeJson: config.encodeJson ?? identity,
37
- decodeJson: config.decodeJson ?? identity,
38
- ...config.renderOutputType ? { renderOutputType: config.renderOutputType } : {}
38
+ encode: (value, ctx) => {
39
+ try {
40
+ return Promise.resolve(userEncode(value, ctx));
41
+ } catch (error) {
42
+ return Promise.reject(error);
43
+ }
44
+ },
45
+ decode: (wire, ctx) => {
46
+ try {
47
+ return Promise.resolve(userDecode(wire, ctx));
48
+ } catch (error) {
49
+ return Promise.reject(error);
50
+ }
51
+ },
52
+ encodeJson: widenedConfig.encodeJson ?? identity,
53
+ decodeJson: widenedConfig.decodeJson ?? identity
39
54
  };
40
55
  }
41
-
42
56
  //#endregion
43
- export { createMongoCodecRegistry, mongoCodec };
57
+ export { mongoCodec, newMongoCodecRegistry };
58
+
44
59
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","names":["#byId"],"sources":["../src/codec-registry.ts","../src/codecs.ts"],"sourcesContent":["import type { MongoCodec } from './codecs';\n\nexport interface MongoCodecRegistry {\n get(id: string): MongoCodec<string> | undefined;\n has(id: string): boolean;\n register(codec: MongoCodec<string>): void;\n [Symbol.iterator](): Iterator<MongoCodec<string>>;\n values(): IterableIterator<MongoCodec<string>>;\n}\n\nclass MongoCodecRegistryImpl implements MongoCodecRegistry {\n readonly #byId = new Map<string, MongoCodec<string>>();\n\n get(id: string): MongoCodec<string> | undefined {\n return this.#byId.get(id);\n }\n\n has(id: string): boolean {\n return this.#byId.has(id);\n }\n\n register(codec: MongoCodec<string>): void {\n if (this.#byId.has(codec.id)) {\n throw new Error(`Codec with ID '${codec.id}' is already registered`);\n }\n this.#byId.set(codec.id, codec);\n }\n\n *[Symbol.iterator](): Iterator<MongoCodec<string>> {\n yield* this.#byId.values();\n }\n\n values(): IterableIterator<MongoCodec<string>> {\n return this.#byId.values();\n }\n}\n\nexport function createMongoCodecRegistry(): MongoCodecRegistry {\n return new MongoCodecRegistryImpl();\n}\n","import type { JsonValue } from '@prisma-next/contract/types';\nimport type { Codec as BaseCodec, CodecTrait } from '@prisma-next/framework-components/codec';\n\nexport type MongoCodecTrait = CodecTrait;\n\nexport interface MongoCodec<\n Id extends string = string,\n TTraits extends readonly MongoCodecTrait[] = readonly MongoCodecTrait[],\n TWire = unknown,\n TJs = unknown,\n> extends BaseCodec<Id, TTraits, TWire, TJs> {\n readonly traits: TTraits;\n}\n\nexport function mongoCodec<\n Id extends string,\n const TTraits extends readonly MongoCodecTrait[] = readonly [],\n TWire = unknown,\n TJs = unknown,\n>(config: {\n typeId: Id;\n targetTypes: readonly string[];\n traits?: TTraits;\n encode: (value: TJs) => TWire;\n decode: (wire: TWire) => TJs;\n encodeJson?: (value: TJs) => JsonValue;\n decodeJson?: (json: JsonValue) => TJs;\n renderOutputType?: (typeParams: Record<string, unknown>) => string | undefined;\n}): MongoCodec<Id, TTraits, TWire, TJs> {\n const traits = config.traits\n ? (Object.freeze([...config.traits]) as TTraits)\n : (Object.freeze([] as const) as unknown as TTraits);\n const identity = (v: unknown) => v;\n return {\n id: config.typeId,\n targetTypes: config.targetTypes,\n traits,\n decode: config.decode,\n encode: config.encode,\n encodeJson: (config.encodeJson ?? identity) as (value: TJs) => JsonValue,\n decodeJson: (config.decodeJson ?? identity) as (json: JsonValue) => TJs,\n ...(config.renderOutputType ? { renderOutputType: config.renderOutputType } : {}),\n };\n}\n\nexport type MongoCodecJsType<T> =\n T extends MongoCodec<string, readonly MongoCodecTrait[], unknown, infer TJs> ? TJs : never;\n\nexport type MongoCodecTraits<T> =\n T extends MongoCodec<string, infer TTraits> ? TTraits[number] & MongoCodecTrait : never;\n"],"mappings":";AAUA,IAAM,yBAAN,MAA2D;CACzD,CAASA,uBAAQ,IAAI,KAAiC;CAEtD,IAAI,IAA4C;AAC9C,SAAO,MAAKA,KAAM,IAAI,GAAG;;CAG3B,IAAI,IAAqB;AACvB,SAAO,MAAKA,KAAM,IAAI,GAAG;;CAG3B,SAAS,OAAiC;AACxC,MAAI,MAAKA,KAAM,IAAI,MAAM,GAAG,CAC1B,OAAM,IAAI,MAAM,kBAAkB,MAAM,GAAG,yBAAyB;AAEtE,QAAKA,KAAM,IAAI,MAAM,IAAI,MAAM;;CAGjC,EAAE,OAAO,YAA0C;AACjD,SAAO,MAAKA,KAAM,QAAQ;;CAG5B,SAA+C;AAC7C,SAAO,MAAKA,KAAM,QAAQ;;;AAI9B,SAAgB,2BAA+C;AAC7D,QAAO,IAAI,wBAAwB;;;;;ACxBrC,SAAgB,WAKd,QASsC;CACtC,MAAM,SAAS,OAAO,SACjB,OAAO,OAAO,CAAC,GAAG,OAAO,OAAO,CAAC,GACjC,OAAO,OAAO,EAAE,CAAU;CAC/B,MAAM,YAAY,MAAe;AACjC,QAAO;EACL,IAAI,OAAO;EACX,aAAa,OAAO;EACpB;EACA,QAAQ,OAAO;EACf,QAAQ,OAAO;EACf,YAAa,OAAO,cAAc;EAClC,YAAa,OAAO,cAAc;EAClC,GAAI,OAAO,mBAAmB,EAAE,kBAAkB,OAAO,kBAAkB,GAAG,EAAE;EACjF"}
1
+ {"version":3,"file":"index.mjs","names":[],"sources":["../src/codec-registry.ts","../src/codecs.ts"],"sourcesContent":["import type { MongoCodec } from './codecs';\n\nexport interface MongoCodecRegistry {\n get(id: string): MongoCodec<string> | undefined;\n has(id: string): boolean;\n register(codec: MongoCodec<string>): void;\n [Symbol.iterator](): Iterator<MongoCodec<string>>;\n values(): IterableIterator<MongoCodec<string>>;\n}\n\n/**\n * Create a new Mongo codec registry. Inline object literal — no class implementation; the registry is just a private `Map` with the documented surface methods.\n */\nexport function newMongoCodecRegistry(): MongoCodecRegistry {\n const byId = new Map<string, MongoCodec<string>>();\n return {\n get: (id) => byId.get(id),\n has: (id) => byId.has(id),\n register: (codec) => {\n if (byId.has(codec.id)) {\n throw new Error(`Codec with ID '${codec.id}' is already registered`);\n }\n byId.set(codec.id, codec);\n },\n values: () => byId.values(),\n [Symbol.iterator]: function* () {\n yield* byId.values();\n },\n };\n}\n","import type { JsonValue } from '@prisma-next/contract/types';\nimport type {\n Codec as BaseCodec,\n CodecCallContext,\n CodecTrait,\n} from '@prisma-next/framework-components/codec';\n\nexport type MongoCodecTrait = CodecTrait;\n\n/**\n * A codec for the Mongo target. Translates between an application value and the BSON-shaped wire form the Mongo driver exchanges, and between an application value and the JSON form stored in contract artifacts.\n *\n * Same shape as the framework codec base — see `Codec` in `@prisma-next/framework-components/codec` for the contract. Codec-id-keyed static metadata (`traits`, `targetTypes`, `renderOutputType`) lives on the unified {@link import('@prisma-next/framework-components/codec').CodecDescriptor}; Mongo's full migration to descriptor-side registration is tracked under TML-2324.\n */\nexport interface MongoCodec<\n Id extends string = string,\n TTraits extends readonly MongoCodecTrait[] = readonly MongoCodecTrait[],\n TWire = unknown,\n TInput = unknown,\n> extends BaseCodec<Id, TTraits, TWire, TInput> {}\n\n/**\n * Conditional bundle for `encodeJson`/`decodeJson`: when `TInput` is structurally assignable to `JsonValue` the identity defaults are sound and both fields are optional; otherwise both fields are required so an author cannot silently produce a non-JSON-safe contract artifact.\n */\ntype JsonRoundTripConfig<TInput> = [TInput] extends [JsonValue]\n ? {\n encodeJson?: (value: TInput) => JsonValue;\n decodeJson?: (json: JsonValue) => TInput;\n }\n : {\n encodeJson: (value: TInput) => JsonValue;\n decodeJson: (json: JsonValue) => TInput;\n };\n\n/**\n * Construct a Mongo codec from author functions.\n *\n * Author `encode` and `decode` as sync or async functions; the factory produces a {@link MongoCodec} whose query-time methods follow the boundary contract documented on the framework {@link BaseCodec}. Authors receive a second `ctx` options argument carrying the per-call context; ignore it if you don't need it.\n *\n * Both `encode` and `decode` are required so `TInput` and `TWire` are always covered by an explicit author function — the factory installs no identity fallback. `encodeJson` and `decodeJson` default to identity **only when `TInput` is assignable to `JsonValue`**; otherwise both are required so the contract artifact stays JSON-safe.\n *\n * Codec-id-keyed static metadata (`traits`, `targetTypes`, `renderOutputType`) lives on the unified `CodecDescriptor` rather than on the codec instance itself (TML-2357).\n */\nexport function mongoCodec<\n Id extends string,\n const TTraits extends readonly MongoCodecTrait[] = readonly [],\n TWire = unknown,\n TInput = unknown,\n>(\n config: {\n typeId: Id;\n encode: (value: TInput, ctx: CodecCallContext) => TWire | Promise<TWire>;\n decode: (wire: TWire, ctx: CodecCallContext) => TInput | Promise<TInput>;\n } & JsonRoundTripConfig<TInput>,\n): MongoCodec<Id, TTraits, TWire, TInput> {\n const identity = (v: unknown) => v;\n // The runtime allocates one `CodecCallContext` per `runtime.execute()` call (no caller-supplied `signal` produces `{}` instead of `undefined`) and threads it as a non-optional reference to every codec call. The author surface keeps the second parameter optional so single-arg `(value) => …` authors continue to satisfy the signature via TypeScript's bivariance for trailing parameters.\n const userEncode = config.encode;\n const userDecode = config.decode;\n const widenedConfig = config as {\n encodeJson?: (value: TInput) => JsonValue;\n decodeJson?: (json: JsonValue) => TInput;\n };\n return {\n id: config.typeId,\n encode: (value, ctx) => {\n try {\n return Promise.resolve(userEncode(value, ctx));\n } catch (error) {\n return Promise.reject(error);\n }\n },\n decode: (wire, ctx) => {\n try {\n return Promise.resolve(userDecode(wire, ctx));\n } catch (error) {\n return Promise.reject(error);\n }\n },\n encodeJson: (widenedConfig.encodeJson ?? identity) as (value: TInput) => JsonValue,\n decodeJson: (widenedConfig.decodeJson ?? identity) as (json: JsonValue) => TInput,\n };\n}\n\n/** Extract the JS application type carried by a Mongo codec used both as `encode` input and as `decode` output. */\nexport type MongoCodecInput<T> =\n T extends MongoCodec<string, readonly MongoCodecTrait[], unknown, infer TInput> ? TInput : never;\n"],"mappings":";;;;AAaA,SAAgB,wBAA4C;CAC1D,MAAM,uBAAO,IAAI,KAAiC;CAClD,OAAO;EACL,MAAM,OAAO,KAAK,IAAI,GAAG;EACzB,MAAM,OAAO,KAAK,IAAI,GAAG;EACzB,WAAW,UAAU;GACnB,IAAI,KAAK,IAAI,MAAM,GAAG,EACpB,MAAM,IAAI,MAAM,kBAAkB,MAAM,GAAG,yBAAyB;GAEtE,KAAK,IAAI,MAAM,IAAI,MAAM;;EAE3B,cAAc,KAAK,QAAQ;EAC3B,CAAC,OAAO,WAAW,aAAa;GAC9B,OAAO,KAAK,QAAQ;;EAEvB;;;;;;;;;;;;;ACeH,SAAgB,WAMd,QAKwC;CACxC,MAAM,YAAY,MAAe;CAEjC,MAAM,aAAa,OAAO;CAC1B,MAAM,aAAa,OAAO;CAC1B,MAAM,gBAAgB;CAItB,OAAO;EACL,IAAI,OAAO;EACX,SAAS,OAAO,QAAQ;GACtB,IAAI;IACF,OAAO,QAAQ,QAAQ,WAAW,OAAO,IAAI,CAAC;YACvC,OAAO;IACd,OAAO,QAAQ,OAAO,MAAM;;;EAGhC,SAAS,MAAM,QAAQ;GACrB,IAAI;IACF,OAAO,QAAQ,QAAQ,WAAW,MAAM,IAAI,CAAC;YACtC,OAAO;IACd,OAAO,QAAQ,OAAO,MAAM;;;EAGhC,YAAa,cAAc,cAAc;EACzC,YAAa,cAAc,cAAc;EAC1C"}
package/package.json CHANGED
@@ -1,17 +1,19 @@
1
1
  {
2
2
  "name": "@prisma-next/mongo-codec",
3
- "version": "0.5.0-dev.7",
3
+ "version": "0.5.0-dev.70",
4
+ "license": "Apache-2.0",
4
5
  "type": "module",
5
6
  "sideEffects": false,
6
7
  "description": "Codec interface and registry for Prisma Next MongoDB support",
7
8
  "dependencies": {
8
- "@prisma-next/contract": "0.5.0-dev.7",
9
- "@prisma-next/framework-components": "0.5.0-dev.7"
9
+ "@prisma-next/contract": "0.5.0-dev.70",
10
+ "@prisma-next/utils": "0.5.0-dev.70",
11
+ "@prisma-next/framework-components": "0.5.0-dev.70"
10
12
  },
11
13
  "devDependencies": {
12
- "tsdown": "0.18.4",
14
+ "tsdown": "0.22.0",
13
15
  "typescript": "5.9.3",
14
- "vitest": "4.0.17",
16
+ "vitest": "4.1.5",
15
17
  "@prisma-next/test-utils": "0.0.1",
16
18
  "@prisma-next/tsconfig": "0.0.0",
17
19
  "@prisma-next/tsdown": "0.0.0"
@@ -8,33 +8,23 @@ export interface MongoCodecRegistry {
8
8
  values(): IterableIterator<MongoCodec<string>>;
9
9
  }
10
10
 
11
- class MongoCodecRegistryImpl implements MongoCodecRegistry {
12
- readonly #byId = new Map<string, MongoCodec<string>>();
13
-
14
- get(id: string): MongoCodec<string> | undefined {
15
- return this.#byId.get(id);
16
- }
17
-
18
- has(id: string): boolean {
19
- return this.#byId.has(id);
20
- }
21
-
22
- register(codec: MongoCodec<string>): void {
23
- if (this.#byId.has(codec.id)) {
24
- throw new Error(`Codec with ID '${codec.id}' is already registered`);
25
- }
26
- this.#byId.set(codec.id, codec);
27
- }
28
-
29
- *[Symbol.iterator](): Iterator<MongoCodec<string>> {
30
- yield* this.#byId.values();
31
- }
32
-
33
- values(): IterableIterator<MongoCodec<string>> {
34
- return this.#byId.values();
35
- }
36
- }
37
-
38
- export function createMongoCodecRegistry(): MongoCodecRegistry {
39
- return new MongoCodecRegistryImpl();
11
+ /**
12
+ * Create a new Mongo codec registry. Inline object literal — no class implementation; the registry is just a private `Map` with the documented surface methods.
13
+ */
14
+ export function newMongoCodecRegistry(): MongoCodecRegistry {
15
+ const byId = new Map<string, MongoCodec<string>>();
16
+ return {
17
+ get: (id) => byId.get(id),
18
+ has: (id) => byId.has(id),
19
+ register: (codec) => {
20
+ if (byId.has(codec.id)) {
21
+ throw new Error(`Codec with ID '${codec.id}' is already registered`);
22
+ }
23
+ byId.set(codec.id, codec);
24
+ },
25
+ values: () => byId.values(),
26
+ [Symbol.iterator]: function* () {
27
+ yield* byId.values();
28
+ },
29
+ };
40
30
  }
package/src/codecs.ts CHANGED
@@ -1,50 +1,87 @@
1
1
  import type { JsonValue } from '@prisma-next/contract/types';
2
- import type { Codec as BaseCodec, CodecTrait } from '@prisma-next/framework-components/codec';
2
+ import type {
3
+ Codec as BaseCodec,
4
+ CodecCallContext,
5
+ CodecTrait,
6
+ } from '@prisma-next/framework-components/codec';
3
7
 
4
8
  export type MongoCodecTrait = CodecTrait;
5
9
 
10
+ /**
11
+ * A codec for the Mongo target. Translates between an application value and the BSON-shaped wire form the Mongo driver exchanges, and between an application value and the JSON form stored in contract artifacts.
12
+ *
13
+ * Same shape as the framework codec base — see `Codec` in `@prisma-next/framework-components/codec` for the contract. Codec-id-keyed static metadata (`traits`, `targetTypes`, `renderOutputType`) lives on the unified {@link import('@prisma-next/framework-components/codec').CodecDescriptor}; Mongo's full migration to descriptor-side registration is tracked under TML-2324.
14
+ */
6
15
  export interface MongoCodec<
7
16
  Id extends string = string,
8
17
  TTraits extends readonly MongoCodecTrait[] = readonly MongoCodecTrait[],
9
18
  TWire = unknown,
10
- TJs = unknown,
11
- > extends BaseCodec<Id, TTraits, TWire, TJs> {
12
- readonly traits: TTraits;
13
- }
19
+ TInput = unknown,
20
+ > extends BaseCodec<Id, TTraits, TWire, TInput> {}
21
+
22
+ /**
23
+ * Conditional bundle for `encodeJson`/`decodeJson`: when `TInput` is structurally assignable to `JsonValue` the identity defaults are sound and both fields are optional; otherwise both fields are required so an author cannot silently produce a non-JSON-safe contract artifact.
24
+ */
25
+ type JsonRoundTripConfig<TInput> = [TInput] extends [JsonValue]
26
+ ? {
27
+ encodeJson?: (value: TInput) => JsonValue;
28
+ decodeJson?: (json: JsonValue) => TInput;
29
+ }
30
+ : {
31
+ encodeJson: (value: TInput) => JsonValue;
32
+ decodeJson: (json: JsonValue) => TInput;
33
+ };
14
34
 
35
+ /**
36
+ * Construct a Mongo codec from author functions.
37
+ *
38
+ * Author `encode` and `decode` as sync or async functions; the factory produces a {@link MongoCodec} whose query-time methods follow the boundary contract documented on the framework {@link BaseCodec}. Authors receive a second `ctx` options argument carrying the per-call context; ignore it if you don't need it.
39
+ *
40
+ * Both `encode` and `decode` are required so `TInput` and `TWire` are always covered by an explicit author function — the factory installs no identity fallback. `encodeJson` and `decodeJson` default to identity **only when `TInput` is assignable to `JsonValue`**; otherwise both are required so the contract artifact stays JSON-safe.
41
+ *
42
+ * Codec-id-keyed static metadata (`traits`, `targetTypes`, `renderOutputType`) lives on the unified `CodecDescriptor` rather than on the codec instance itself (TML-2357).
43
+ */
15
44
  export function mongoCodec<
16
45
  Id extends string,
17
46
  const TTraits extends readonly MongoCodecTrait[] = readonly [],
18
47
  TWire = unknown,
19
- TJs = unknown,
20
- >(config: {
21
- typeId: Id;
22
- targetTypes: readonly string[];
23
- traits?: TTraits;
24
- encode: (value: TJs) => TWire;
25
- decode: (wire: TWire) => TJs;
26
- encodeJson?: (value: TJs) => JsonValue;
27
- decodeJson?: (json: JsonValue) => TJs;
28
- renderOutputType?: (typeParams: Record<string, unknown>) => string | undefined;
29
- }): MongoCodec<Id, TTraits, TWire, TJs> {
30
- const traits = config.traits
31
- ? (Object.freeze([...config.traits]) as TTraits)
32
- : (Object.freeze([] as const) as unknown as TTraits);
48
+ TInput = unknown,
49
+ >(
50
+ config: {
51
+ typeId: Id;
52
+ encode: (value: TInput, ctx: CodecCallContext) => TWire | Promise<TWire>;
53
+ decode: (wire: TWire, ctx: CodecCallContext) => TInput | Promise<TInput>;
54
+ } & JsonRoundTripConfig<TInput>,
55
+ ): MongoCodec<Id, TTraits, TWire, TInput> {
33
56
  const identity = (v: unknown) => v;
57
+ // The runtime allocates one `CodecCallContext` per `runtime.execute()` call (no caller-supplied `signal` produces `{}` instead of `undefined`) and threads it as a non-optional reference to every codec call. The author surface keeps the second parameter optional so single-arg `(value) => …` authors continue to satisfy the signature via TypeScript's bivariance for trailing parameters.
58
+ const userEncode = config.encode;
59
+ const userDecode = config.decode;
60
+ const widenedConfig = config as {
61
+ encodeJson?: (value: TInput) => JsonValue;
62
+ decodeJson?: (json: JsonValue) => TInput;
63
+ };
34
64
  return {
35
65
  id: config.typeId,
36
- targetTypes: config.targetTypes,
37
- traits,
38
- decode: config.decode,
39
- encode: config.encode,
40
- encodeJson: (config.encodeJson ?? identity) as (value: TJs) => JsonValue,
41
- decodeJson: (config.decodeJson ?? identity) as (json: JsonValue) => TJs,
42
- ...(config.renderOutputType ? { renderOutputType: config.renderOutputType } : {}),
66
+ encode: (value, ctx) => {
67
+ try {
68
+ return Promise.resolve(userEncode(value, ctx));
69
+ } catch (error) {
70
+ return Promise.reject(error);
71
+ }
72
+ },
73
+ decode: (wire, ctx) => {
74
+ try {
75
+ return Promise.resolve(userDecode(wire, ctx));
76
+ } catch (error) {
77
+ return Promise.reject(error);
78
+ }
79
+ },
80
+ encodeJson: (widenedConfig.encodeJson ?? identity) as (value: TInput) => JsonValue,
81
+ decodeJson: (widenedConfig.decodeJson ?? identity) as (json: JsonValue) => TInput,
43
82
  };
44
83
  }
45
84
 
46
- export type MongoCodecJsType<T> =
47
- T extends MongoCodec<string, readonly MongoCodecTrait[], unknown, infer TJs> ? TJs : never;
48
-
49
- export type MongoCodecTraits<T> =
50
- T extends MongoCodec<string, infer TTraits> ? TTraits[number] & MongoCodecTrait : never;
85
+ /** Extract the JS application type carried by a Mongo codec — used both as `encode` input and as `decode` output. */
86
+ export type MongoCodecInput<T> =
87
+ T extends MongoCodec<string, readonly MongoCodecTrait[], unknown, infer TInput> ? TInput : never;
@@ -1,4 +1,4 @@
1
1
  export type { MongoCodecRegistry } from '../codec-registry';
2
- export { createMongoCodecRegistry } from '../codec-registry';
3
- export type { MongoCodec, MongoCodecJsType, MongoCodecTrait, MongoCodecTraits } from '../codecs';
2
+ export { newMongoCodecRegistry } from '../codec-registry';
3
+ export type { MongoCodec, MongoCodecInput, MongoCodecTrait } from '../codecs';
4
4
  export { mongoCodec } from '../codecs';