effect-dynamodb 0.1.0

package/dist/DynamoModel.js

@@ -0,0 +1,453 @@
+/**
+ * DynamoModel — Schema annotations, date schemas, and model configuration for effect-dynamodb.
+ *
+ * Provides:
+ * - `configure` — per-field DynamoDB overrides (field rename, storage encoding, immutable, identifier, ref)
+ * - `Hidden` annotation — marks fields as excluded from default decode (asModel/asRecord)
+ * - `DynamoEncoding` annotation — controls how date fields are stored in DynamoDB
+ * - Date schemas — wire ↔ domain ↔ storage transformations for DateTime.Utc, DateTime.Zoned, Date
+ * - `storedAs` modifier — overrides DynamoDB storage format via annotation
+ *
+ * See docs/design-dynamo-model.md for the three-layer model (wire → domain → storage).
+ */
+import { DateTime, Effect, Option, Schema, SchemaAST, SchemaGetter, SchemaIssue } from "effect";
+// ---------------------------------------------------------------------------
+// Identifier annotation
+// ---------------------------------------------------------------------------
+/** Unique symbol for the Identifier annotation */
+const IdentifierId = Symbol.for("effect-dynamodb/Identifier");
+/**
+ * Mark a schema field as the primary identifier for ref resolution.
+ *
+ * Entities that can be referenced via `DynamoModel.ref` must annotate exactly
+ * one field with `identifier`. The annotated field should be a string or
+ * branded string type.
+ */
+export const identifier = (schema) => schema.pipe(Schema.annotate({ [IdentifierId]: true }));
+/**
+ * Check if a schema field has the Identifier annotation.
+ */
+export const isIdentifier = (schema) => SchemaAST.resolve(schema.ast)?.[IdentifierId] ?? false;
+/**
+ * Find the identifier field in a schema with `.fields` (Schema.Class or Schema.Struct).
+ * Checks both schema-level `DynamoModel.identifier` annotations and ConfiguredModel
+ * `identifier: true` overrides.
+ *
+ * Returns the field name and schema, or undefined if no field has the identifier annotation.
+ */
+export const getIdentifierField = (model) => {
+    // Check ConfiguredModel attributes first (configure-level overrides take precedence)
+    if (isConfiguredModel(model)) {
+        const configured = model;
+        for (const [name, attr] of Object.entries(configured.attributes)) {
+            if (attr.identifier) {
+                const rawModel = configured.model;
+                if ("fields" in rawModel &&
+                    typeof rawModel.fields === "object") {
+                    const fields = rawModel
+                        .fields;
+                    const fieldSchema = fields[name];
+                    if (fieldSchema)
+                        return { name, schema: fieldSchema };
+                }
+                // Fallback: return with a generic string schema
+                return { name, schema: Schema.String };
+            }
+        }
+        // Fall through to check schema-level annotations on the inner model
+        return getIdentifierField(configured.model);
+    }
+    if (!("fields" in model) ||
+        typeof model.fields !== "object")
+        return undefined;
+    const fields = model.fields;
+    for (const [name, fieldSchema] of Object.entries(fields)) {
+        if (isIdentifier(fieldSchema))
+            return { name, schema: fieldSchema };
+    }
+    return undefined;
+};
+// ---------------------------------------------------------------------------
+// Ref annotation
+// ---------------------------------------------------------------------------
+/** Unique symbol for the Ref annotation */
+const RefId = Symbol.for("effect-dynamodb/Ref");
+/**
+ * Mark a schema field as a denormalized reference to another entity.
+ *
+ * Ref fields:
+ * - In `Entity.Input`, become ID fields (e.g., `team: Team` → `teamId: string`)
+ * - In `Entity.Record`, remain the full entity domain type
+ * - In `Entity.Update`, become optional ID fields
+ * - In DynamoDB, store the entity's core domain data as an embedded map
+ *
+ * The referenced entity's model must have exactly one `DynamoModel.identifier`-annotated field.
+ */
+export const ref = (schema) => {
+    // Extract Schema.Class identifier if available (e.g., "Team" from Schema.Class<Team>("Team"))
+    // In Effect v4, Schema.Class exposes `identifier` (not `_tag`) as the class name
+    const s = schema;
+    const refSchemaId = "identifier" in schema && typeof s.identifier === "string"
+        ? s.identifier
+        : "_tag" in schema && typeof s._tag === "string"
+            ? s._tag
+            : undefined;
+    return schema.pipe(Schema.annotate({ [RefId]: { _tag: "Ref", refSchemaId } }));
+};
+/**
+ * Check if a schema field has the Ref annotation.
+ */
+export const isRef = (schema) => {
+    const ann = SchemaAST.resolve(schema.ast)?.[RefId];
+    return ann != null && typeof ann === "object" && ann._tag === "Ref";
+};
+/**
+ * Check if a field is a ref, considering both schema-level annotations and
+ * ConfiguredModel overrides. Use this when you have access to the configured model.
+ */
+export const isRefField = (fieldName, model) => {
+    // Check ConfiguredModel attributes
+    if (isConfiguredModel(model)) {
+        const configured = model;
+        if (configured.attributes[fieldName]?.ref)
+            return true;
+        // Fall through to check schema-level annotation on the inner model
+        return isRefField(fieldName, configured.model);
+    }
+    // Check schema-level annotation
+    if ("fields" in model &&
+        typeof model.fields === "object") {
+        const fields = model.fields;
+        const fieldSchema = fields[fieldName];
+        if (fieldSchema)
+            return isRef(fieldSchema);
+    }
+    return false;
+};
+/**
+ * Get the full Ref annotation metadata from a schema field.
+ * Returns undefined if the field is not ref-annotated.
+ */
+export const getRefAnnotation = (schema) => {
+    const ann = SchemaAST.resolve(schema.ast)?.[RefId];
+    if (ann != null && typeof ann === "object" && ann._tag === "Ref") {
+        return ann;
+    }
+    return undefined;
+};
+// ---------------------------------------------------------------------------
+// Hidden annotation
+// ---------------------------------------------------------------------------
+/** Unique symbol for the Hidden annotation */
+const HiddenId = Symbol.for("effect-dynamodb/Hidden");
+/**
+ * Mark a schema field as hidden from default decode modes (asModel, asRecord).
+ *
+ * Hidden fields:
+ * - Stored in DynamoDB normally
+ * - Visible in asItem and asNative decode modes
+ * - Stripped from asModel and asRecord decode modes
+ *
+ * Use for internal/infrastructure fields that shouldn't leak into application code.
+ */
+export const Hidden = (schema) => schema.pipe(Schema.annotate({ [HiddenId]: true }));
+/**
+ * Check if a schema field has the Hidden annotation.
+ */
+export const isHidden = (schema) => SchemaAST.resolve(schema.ast)?.[HiddenId] ?? false;
+// ---------------------------------------------------------------------------
+// DynamoEncoding annotation
+// ---------------------------------------------------------------------------
+/** Unique symbol for the DynamoEncoding annotation */
+export const DynamoEncodingKey = Symbol.for("effect-dynamodb/DynamoEncoding");
+/**
+ * Read the DynamoEncoding annotation from a schema, if present.
+ */
+export const getEncoding = (schema) => SchemaAST.resolve(schema.ast)?.[DynamoEncodingKey];
+// ---------------------------------------------------------------------------
+// Date schemas — DateTime.Utc domain
+// ---------------------------------------------------------------------------
+/**
+ * Wire: ISO 8601 string ↔ Domain: DateTime.Utc
+ *
+ * Default storage: ISO string (`S`).
+ * This is a thin wrapper around `Schema.DateTimeUtcFromString` with the DynamoEncoding annotation.
+ */
+export const DateString = Schema.DateTimeUtcFromString.pipe(Schema.annotate({
+    [DynamoEncodingKey]: { storage: "string", domain: "DateTime.Utc" },
+}));
+/**
+ * Wire: epoch milliseconds (number) ↔ Domain: DateTime.Utc
+ *
+ * Default storage: epoch ms (`N`).
+ */
+export const DateEpochMs = Schema.Number.pipe(Schema.decodeTo(Schema.DateTimeUtc, {
+    decode: SchemaGetter.transform((n) => DateTime.makeUnsafe(n)),
+    encode: SchemaGetter.transform((dt) => DateTime.toEpochMillis(dt)),
+}), Schema.annotate({
+    [DynamoEncodingKey]: { storage: "epochMs", domain: "DateTime.Utc" },
+}));
+/**
+ * Wire: epoch seconds (number) ↔ Domain: DateTime.Utc
+ *
+ * Default storage: epoch seconds (`N`).
+ * DynamoDB TTL requires this format.
+ */
+export const DateEpochSeconds = Schema.Number.pipe(Schema.decodeTo(Schema.DateTimeUtc, {
+    decode: SchemaGetter.transform((n) => DateTime.makeUnsafe(n * 1000)),
+    encode: SchemaGetter.transform((dt) => Math.floor(DateTime.toEpochMillis(dt) / 1000)),
+}), Schema.annotate({
+    [DynamoEncodingKey]: {
+        storage: "epochSeconds",
+        domain: "DateTime.Utc",
+    },
+}));
+/**
+ * Wire: auto-detect epoch ms or seconds ↔ Domain: DateTime.Utc
+ *
+ * Uses a minimum threshold to disambiguate: if the value interpreted as ms
+ * produces a date before `minimum`, it tries seconds instead.
+ *
+ * @param options.minimum - Threshold date for disambiguation
+ * @param options.encode - Epoch schema for wire encoding (default: DateEpochMs)
+ */
+export const DateEpoch = (options) => {
+    const minEpochMs = typeof options.minimum === "string"
+        ? new Date(options.minimum).getTime()
+        : DateTime.toEpochMillis(DateTime.makeUnsafe(options.minimum));
+    const encodeSchema = options.encode ?? DateEpochMs;
+    const encodeEncoding = getEncoding(encodeSchema);
+    return Schema.Number.pipe(Schema.decodeTo(Schema.DateTimeUtc, {
+        decode: SchemaGetter.transformOrFail((n) => {
+            // Try milliseconds first
+            try {
+                const asMs = DateTime.makeUnsafe(n);
+                if (DateTime.toEpochMillis(asMs) >= minEpochMs) {
+                    return Effect.succeed(asMs);
+                }
+            }
+            catch {
+                // fall through
+            }
+            // Fall back to seconds
+            try {
+                const asSec = DateTime.makeUnsafe(n * 1000);
+                if (DateTime.toEpochMillis(asSec) >= minEpochMs) {
+                    return Effect.succeed(asSec);
+                }
+            }
+            catch {
+                // fall through
+            }
+            return Effect.fail(new SchemaIssue.InvalidType(Schema.Number.ast, Option.some(n)));
+        }),
+        encode: SchemaGetter.transform((dt) => Schema.encodeSync(encodeSchema)(dt)),
+    }), Schema.annotate({
+        [DynamoEncodingKey]: {
+            storage: encodeEncoding?.storage ?? "epochMs",
+            domain: "DateTime.Utc",
+        },
+    }));
+};
+// ---------------------------------------------------------------------------
+// Date schemas — DateTime.Zoned domain
+// ---------------------------------------------------------------------------
+/**
+ * Wire: ISO 8601 string with offset/zone ↔ Domain: DateTime.Zoned
+ *
+ * Default storage: extended ISO with zone (`S`).
+ * Format: `2024-01-01T15:00:00+09:00[Asia/Tokyo]`
+ *
+ * Cannot use epoch storage — timezone information would be lost (enforced at type level via storedAs).
+ */
+export const DateTimeZoned = Schema.String.pipe(Schema.decodeTo(Schema.DateTimeZoned, {
+    decode: SchemaGetter.transformOrFail((s) => {
+        // Parse extended ISO format: "2024-01-01T15:00:00+09:00[Asia/Tokyo]"
+        const match = s.match(/^(.+)\[(.+)\]$/);
+        if (match) {
+            const dateStr = match[1];
+            const tzName = match[2];
+            try {
+                const utc = DateTime.makeUnsafe(dateStr);
+                return Effect.succeed(DateTime.makeZonedUnsafe(utc, { timeZone: tzName }));
+            }
+            catch {
+                return Effect.fail(new SchemaIssue.InvalidType(Schema.String.ast, Option.some(s)));
+            }
+        }
+        // Try parsing as offset-only: "2024-01-01T15:00:00+09:00"
+        try {
+            const utc = DateTime.makeUnsafe(s);
+            return Effect.succeed(DateTime.makeZonedUnsafe(utc, { timeZone: "UTC" }));
+        }
+        catch {
+            return Effect.fail(new SchemaIssue.InvalidType(Schema.String.ast, Option.some(s)));
+        }
+    }),
+    encode: SchemaGetter.transform((dt) => DateTime.formatIsoZoned(dt)),
+}), Schema.annotate({
+    [DynamoEncodingKey]: { storage: "string", domain: "DateTime.Zoned" },
+}));
+// ---------------------------------------------------------------------------
+// Unsafe date schemas — native Date domain
+// ---------------------------------------------------------------------------
+/**
+ * Wire: ISO 8601 string ↔ Domain: native Date (mutable)
+ *
+ * Default storage: ISO string (`S`).
+ * For interop with non-Effect code that expects native JS Date objects.
+ */
+export const UnsafeDateString = Schema.String.pipe(Schema.decodeTo(Schema.DateValid, {
+    decode: SchemaGetter.transform((s) => new Date(s)),
+    encode: SchemaGetter.transform((d) => d.toISOString()),
+}), Schema.annotate({
+    [DynamoEncodingKey]: { storage: "string", domain: "Date" },
+}));
+/**
+ * Wire: epoch milliseconds (number) ↔ Domain: native Date (mutable)
+ *
+ * Default storage: epoch ms (`N`).
+ */
+export const UnsafeDateEpochMs = Schema.Number.pipe(Schema.decodeTo(Schema.DateValid, {
+    decode: SchemaGetter.transform((ms) => new Date(ms)),
+    encode: SchemaGetter.transform((d) => d.getTime()),
+}), Schema.annotate({
+    [DynamoEncodingKey]: { storage: "epochMs", domain: "Date" },
+}));
+/**
+ * Wire: epoch seconds (number) ↔ Domain: native Date (mutable)
+ *
+ * Default storage: epoch seconds (`N`).
+ */
+export const UnsafeDateEpochSeconds = Schema.Number.pipe(Schema.decodeTo(Schema.DateValid, {
+    decode: SchemaGetter.transform((s) => new Date(s * 1000)),
+    encode: SchemaGetter.transform((d) => Math.floor(d.getTime() / 1000)),
+}), Schema.annotate({
+    [DynamoEncodingKey]: {
+        storage: "epochSeconds",
+        domain: "Date",
+    },
+}));
+// ---------------------------------------------------------------------------
+// TTL alias
+// ---------------------------------------------------------------------------
+/**
+ * Alias for `DateEpochSeconds`. DynamoDB TTL requires epoch seconds.
+ * A named alias makes intent clear at the call site.
+ */
+export const TTL = DateEpochSeconds;
+// ---------------------------------------------------------------------------
+// storedAs modifier
+// ---------------------------------------------------------------------------
+/**
+ * Override the DynamoDB storage format for a date field.
+ *
+ * `storedAs` reads the DynamoEncoding annotation from the target storage schema
+ * and applies its storage format to the field schema. The domain type must match
+ * (enforced at the type level via the `A` constraint).
+ *
+ * @example
+ * ```typescript
+ * // Wire: ISO string, DynamoDB: epoch seconds (for TTL)
+ * DynamoModel.DateString.pipe(DynamoModel.storedAs(DynamoModel.DateEpochSeconds))
+ *
+ * // Wire: epoch ms, DynamoDB: ISO string
+ * DynamoModel.DateEpochMs.pipe(DynamoModel.storedAs(DynamoModel.DateString))
+ * ```
+ *
+ * Type-safe: incompatible domain types produce a compile error:
+ * ```typescript
+ * // Type error — DateTime.Zoned ≠ DateTime.Utc
+ * DynamoModel.DateTimeZoned.pipe(DynamoModel.storedAs(DynamoModel.DateEpochMs))
+ * ```
+ */
+export const storedAs = (storageSchema) => {
+    const storageEncoding = getEncoding(storageSchema);
+    if (!storageEncoding) {
+        throw new Error("storedAs: target schema has no DynamoEncoding annotation");
+    }
+    return (fieldSchema) => {
+        const currentEncoding = getEncoding(fieldSchema);
+        return fieldSchema.pipe(Schema.annotate({
+            [DynamoEncodingKey]: {
+                storage: storageEncoding.storage,
+                domain: currentEncoding?.domain ?? storageEncoding.domain,
+            },
+        }));
+    };
+};
+// ---------------------------------------------------------------------------
+// ConfiguredModel
+// ---------------------------------------------------------------------------
+/** Unique symbol identifying a ConfiguredModel wrapper */
+export const ConfiguredModelTag = Symbol.for("effect-dynamodb/ConfiguredModel");
+/**
+ * Check if a value is a ConfiguredModel.
+ */
+export const isConfiguredModel = (value) => typeof value === "object" &&
+    value !== null &&
+    value[ConfiguredModelTag] === true;
+/**
+ * Create a configured model with per-field DynamoDB overrides.
+ *
+ * Separates DynamoDB infrastructure (storage format, field renaming) from
+ * the domain model, enabling pure models that work across storage backends.
+ *
+ * @example
+ * ```typescript
+ * class Order extends Schema.Class<Order>("Order")({
+ *   orderId: Schema.String,
+ *   placedAt: Schema.DateTimeUtcFromString,
+ *   expiresAt: Schema.DateTimeUtcFromString,
+ * }) {}
+ *
+ * const OrderModel = DynamoModel.configure(Order, {
+ *   expiresAt: { field: "ttl", storedAs: DynamoModel.DateEpochSeconds },
+ * })
+ * ```
+ */
+export const configure = (model, attributes) => {
+    const resolved = {};
+    for (const [key, config] of Object.entries(attributes)) {
+        const entry = {};
+        if (config.field)
+            entry.field = config.field;
+        if (config.immutable)
+            entry.immutable = true;
+        if (config.identifier)
+            entry.identifier = true;
+        if (config.ref)
+            entry.ref = true;
+        if (config.storedAs) {
+            const encoding = getEncoding(config.storedAs);
+            if (!encoding) {
+                throw new Error(`DynamoModel.configure: storedAs schema for "${key}" has no DynamoEncoding annotation`);
+            }
+            entry.encoding = encoding;
+        }
+        resolved[key] = entry;
+    }
+    // Validate: no field rename targets collide with existing model field names
+    const modelFields = new Set();
+    if ("fields" in model &&
+        typeof model.fields === "object") {
+        for (const fieldName of Object.keys(model.fields)) {
+            modelFields.add(fieldName);
+        }
+    }
+    if (modelFields.size > 0) {
+        for (const [sourceField, config] of Object.entries(resolved)) {
+            if (config.field && config.field !== sourceField && modelFields.has(config.field)) {
+                throw new Error(`[EDD-9007] DynamoModel.configure: renaming "${sourceField}" to "${config.field}" collides with existing model field "${config.field}". ` +
+                    `This would cause both fields to map to the same DynamoDB attribute.`);
+            }
+        }
+    }
+    return {
+        [ConfiguredModelTag]: true,
+        model,
+        _attributes: attributes,
+        attributes: resolved,
+    };
+};
+//# sourceMappingURL=DynamoModel.js.map

package/dist/DynamoModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DynamoModel.js","sourceRoot":"","sources":["../src/DynamoModel.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AAE/F,8EAA8E;AAC9E,wBAAwB;AACxB,8EAA8E;AAE9E,kDAAkD;AAClD,MAAM,YAAY,GAAkB,MAAM,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAA;AAE5E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAuB,MAAS,EAAK,EAAE,CAC/D,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,EAAE,IAAI,EAAE,CAAC,CAAM,CAAA;AAE7D;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,MAAkB,EAAW,EAAE,CACxD,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAoD,EAAE,CAClF,YAAY,CACD,IAAI,KAAK,CAAA;AAExB;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAChC,KAAiB,EACmD,EAAE;IACtE,qFAAqF;IACrF,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,UAAU,GAAG,KAAoC,CAAA;QACvD,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YACjE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;gBACpB,MAAM,QAAQ,GAAG,UAAU,CAAC,KAAK,CAAA;gBACjC,IACE,QAAQ,IAAI,QAAQ;oBACpB,OAAQ,QAA+C,CAAC,MAAM,KAAK,QAAQ,EAC3E,CAAC;oBACD,MAAM,MAAM,GAAI,QAAyE;yBACtF,MAAM,CAAA;oBACT,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;oBAChC,IAAI,WAAW;wBAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,CAAA;gBACvD,CAAC;gBACD,gDAAgD;gBAChD,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,MAA+B,EAAE,CAAA;YACjE,CAAC;QACH,CAAC;QACD,oEAAoE;QACpE,OAAO,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;IAC7C,CAAC;IAED,IACE,CAAC,CAAC,QAAQ,IAAI,KAAK,CAAC;QACpB,OAAQ,KAA4C,CAAC,MAAM,KAAK,QAAQ;QAExE,OAAO,SAAS,CAAA;IAClB,MAAM,MAAM,GAAI,KAAsE,CAAC,MAAM,CAAA;IAC7F,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACzD,IAAI,YAAY,CAAC,WAAW,CAAC;YAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,CAAA;IACrE,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA;AAED,8EAA8E;AAC9E,iBAAiB;AACjB,8EAA8E;AAE9E,2CAA2C;AAC3C,MAAM,KAAK,GAAkB,MAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAA;AAS9D;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,CAAuB,MAAS,EAAK,EAAE;IACxD,8FAA8F;IAC9F,iFAAiF;IACjF,MAAM,CAAC,GAAG,MAA4C,CAAA;IACtD,MAAM,WAAW,GACf,YAAY,IAAI,MAAM,IAAI,OAAO,CAAC,CAAC,UAAU,KAAK,QAAQ;QACxD,CAAC,CAAC,CAAC,CAAC,UAAU;QACd,CAAC,CAAC,MAAM,IAAI,MAAM,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ;YAC9C,CAAC,CAAC,CAAC,CAAC,IAAI;YACR,CAAC,CAAC,SAAS,CAAA;IACjB,OAAO,MAAM,CAAC,IAAI,CAChB,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAA0B,EAAE,CAAC,CAC9E,CAAA;AACR,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,MAAkB,EAAW,EAAE;IACnD,MAAM,GAAG,GAAI,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAoD,EAAE,CAC7F,KAAK,CACN,CAAA;IACD,OAAO,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAK,GAAqB,CAAC,IAAI,KAAK,KAAK,CAAA;AACxF,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,SAAiB,EAAE,KAAiB,EAAW,EAAE;IAC1E,mCAAmC;IACnC,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,MAAM,UAAU,GAAG,KAAoC,CAAA;QACvD,IAAI,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,GAAG;YAAE,OAAO,IAAI,CAAA;QACtD,mEAAmE;QACnE,OAAO,UAAU,CAAC,SAAS,EAAE,UAAU,CAAC,KAAK,CAAC,CAAA;IAChD,CAAC;IACD,gCAAgC;IAChC,IACE,QAAQ,IAAI,KAAK;QACjB,OAAQ,KAA4C,CAAC,MAAM,KAAK,QAAQ,EACxE,CAAC;QACD,MAAM,MAAM,GAAI,KAAsE,CAAC,MAAM,CAAA;QAC7F,MAAM,WAAW,GAAG,MAAM,CAAC,SAAS,CAAC,CAAA;QACrC,IAAI,WAAW;YAAE,OAAO,KAAK,CAAC,WAAW,CAAC,CAAA;IAC5C,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAkB,EAA6B,EAAE;IAChF,MAAM,GAAG,GAAI,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAoD,EAAE,CAC7F,KAAK,CACN,CAAA;IACD,IAAI,GAAG,IAAI,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAK,GAAqB,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;QACpF,OAAO,GAAoB,CAAA;IAC7B,CAAC;IACD,OAAO,SAAS,CAAA;AAClB,CAAC,CAAA;AAED,8EAA8E;AAC9E,oBAAoB;AACpB,8EAA8E;AAE9E,8CAA8C;AAC9C,MAAM,QAAQ,GAAkB,MAAM,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAA;AAEpE;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAuB,MAAS,EAAK,EAAE,CAC3D,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,CAAC,CAAM,CAAA;AAEzD;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,MAAkB,EAAW,EAAE,CACpD,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAoD,EAAE,CAClF,QAAQ,CACG,IAAI,KAAK,CAAA;AAExB,8EAA8E;AAC9E,4BAA4B;AAC5B,8EAA8E;AAE9E,sDAAsD;AACtD,MAAM,CAAC,MAAM,iBAAiB,GAAkB,MAAM,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAA;AAY5F;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAAkB,EAA8B,EAAE,CAC3E,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAoD,EAAE,CACjF,iBAAiB,CACY,CAAA;AAEjC,8EAA8E;AAC9E,qCAAqC;AACrC,8EAA8E;AAE9E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC,qBAAqB,CAAC,IAAI,CACzD,MAAM,CAAC,QAAQ,CAAC;IACd,CAAC,iBAAiB,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,EAA2B;CAC5F,CAAC,CACH,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAC3C,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE;IAClC,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;IACrE,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,EAAgB,EAAE,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;CACjF,CAAC,EACF,MAAM,CAAC,QAAQ,CAAC;IACd,CAAC,iBAAiB,CAAC,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,cAAc,EAA2B;CAC7F,CAAC,CACH,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAChD,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE;IAClC,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5E,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,EAAgB,EAAE,EAAE,CAClD,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAC9C;CACF,CAAC,EACF,MAAM,CAAC,QAAQ,CAAC;IACd,CAAC,iBAAiB,CAAC,EAAE;QACnB,OAAO,EAAE,cAAc;QACvB,MAAM,EAAE,cAAc;KACE;CAC3B,CAAC,CACH,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,OAGzB,EAAE,EAAE;IACH,MAAM,UAAU,GACd,OAAO,OAAO,CAAC,OAAO,KAAK,QAAQ;QACjC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE;QACrC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAA;IAClE,MAAM,YAAY,GAAG,OAAO,CAAC,MAAM,IAAI,WAAW,CAAA;IAClD,MAAM,cAAc,GAAG,WAAW,CAAC,YAAY,CAAC,CAAA;IAEhD,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CACvB,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,EAAE;QAClC,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC,CAAC,CAAS,EAAE,EAAE;YACjD,yBAAyB;YACzB,IAAI,CAAC;gBACH,MAAM,IAAI,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;gBACnC,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,UAAU,EAAE,CAAC;oBAC/C,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;gBAC7B,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,eAAe;YACjB,CAAC;YACD,uBAAuB;YACvB,IAAI,CAAC;gBACH,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;gBAC3C,IAAI,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,UAAU,EAAE,CAAC;oBAChD,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBAC9B,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,eAAe;YACjB,CAAC;YACD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACpF,CAAC,CAAC;QACF,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,EAAgB,EAAE,EAAE,CAClD,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,EAAS,CAAC,CAC3C;KACF,CAAC,EACF,MAAM,CAAC,QAAQ,CAAC;QACd,CAAC,iBAAiB,CAAC,EAAE;YACnB,OAAO,EAAE,cAAc,EAAE,OAAO,IAAI,SAAS;YAC7C,MAAM,EAAE,cAAc;SACE;KAC3B,CAAC,CACH,CAAA;AACH,CAAC,CAAA;AAED,8EAA8E;AAC9E,uCAAuC;AACvC,8EAA8E;AAE9E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAC7C,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE;IACpC,MAAM,EAAE,YAAY,CAAC,eAAe,CAAC,CAAC,CAAS,EAAE,EAAE;QACjD,qEAAqE;QACrE,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;QACvC,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAE,CAAA;YACzB,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAE,CAAA;YACxB,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,QAAQ,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;gBACxC,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC,CAAA;YAC5E,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACpF,CAAC;QACH,CAAC;QACD,0DAA0D;QAC1D,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAA;YAClC,OAAO,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC,CAAA;QAC3E,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACpF,CAAC;IACH,CAAC,CAAC;IACF,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,EAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;CACpF,CAAC,EACF,MAAM,CAAC,QAAQ,CAAC;IACd,CAAC,iBAAiB,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,gBAAgB,EAA2B;CAC9F,CAAC,CACH,CAAA;AAED,8EAA8E;AAC9E,2CAA2C;AAC3C,8EAA8E;AAE9E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAChD,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE;IAChC,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1D,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,CAAO,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;CAC7D,CAAC,EACF,MAAM,CAAC,QAAQ,CAAC;IACd,CAAC,iBAAiB,CAAC,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAA2B;CACpF,CAAC,CACH,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CACjD,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE;IAChC,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,EAAU,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5D,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,CAAO,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;CACzD,CAAC,EACF,MAAM,CAAC,QAAQ,CAAC;IACd,CAAC,iBAAiB,CAAC,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAA2B;CACrF,CAAC,CACH,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CACtD,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE;IAChC,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACjE,MAAM,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC,CAAO,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;CAC5E,CAAC,EACF,MAAM,CAAC,QAAQ,CAAC;IACd,CAAC,iBAAiB,CAAC,EAAE;QACnB,OAAO,EAAE,cAAc;QACvB,MAAM,EAAE,MAAM;KACU;CAC3B,CAAC,CACH,CAAA;AAED,8EAA8E;AAC9E,YAAY;AACZ,8EAA8E;AAE9E;;;GAGG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,gBAAgB,CAAA;AAEnC,8EAA8E;AAC9E,oBAAoB;AACpB,8EAA8E;AAE9E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CACtB,aAA+B,EACsB,EAAE;IACvD,MAAM,eAAe,GAAG,WAAW,CAAC,aAA2B,CAAC,CAAA;IAChE,IAAI,CAAC,eAAe,EAAE,CAAC;QACrB,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;IAC7E,CAAC;IACD,OAAO,CAA6B,WAAc,EAAK,EAAE;QACvD,MAAM,eAAe,GAAG,WAAW,CAAC,WAAyB,CAAC,CAAA;QAC9D,OAAQ,WAA0B,CAAC,IAAI,CACrC,MAAM,CAAC,QAAQ,CAAC;YACd,CAAC,iBAAiB,CAAC,EAAE;gBACnB,OAAO,EAAE,eAAe,CAAC,OAAO;gBAChC,MAAM,EAAE,eAAe,EAAE,MAAM,IAAI,eAAe,CAAC,MAAM;aACjC;SAC3B,CAAC,CACa,CAAA;IACnB,CAAC,CAAA;AACH,CAAC,CAAA;AAED,8EAA8E;AAC9E,kBAAkB;AAClB,8EAA8E;AAE9E,0DAA0D;AAC1D,MAAM,CAAC,MAAM,kBAAkB,GAAkB,MAAM,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAA;AAsC9F;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAA6C,EAAE,CAC7F,OAAO,KAAK,KAAK,QAAQ;IACzB,KAAK,KAAK,IAAI;IACb,KAA4C,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAA;AA2C5E;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,KAAQ,EACR,UAA6E,EACtD,EAAE;IACzB,MAAM,QAAQ,GASV,EAAE,CAAA;IACN,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CACxC,UAAiE,CAClE,EAAE,CAAC;QACF,MAAM,KAAK,GAMP,EAAE,CAAA;QACN,IAAI,MAAM,CAAC,KAAK;YAAE,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;QAC5C,IAAI,MAAM,CAAC,SAAS;YAAE,KAAK,CAAC,SAAS,GAAG,IAAI,CAAA;QAC5C,IAAI,MAAM,CAAC,UAAU;YAAE,KAAK,CAAC,UAAU,GAAG,IAAI,CAAA;QAC9C,IAAI,MAAM,CAAC,GAAG;YAAE,KAAK,CAAC,GAAG,GAAG,IAAI,CAAA;QAChC,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;YACpB,MAAM,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAC,QAAsB,CAAC,CAAA;YAC3D,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CACb,+CAA+C,GAAG,oCAAoC,CACvF,CAAA;YACH,CAAC;YACD,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAA;QAC3B,CAAC;QACD,QAAQ,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;IACvB,CAAC;IAED,4EAA4E;IAC5E,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAA;IACrC,IACE,QAAQ,IAAI,KAAK;QACjB,OAAQ,KAA4C,CAAC,MAAM,KAAK,QAAQ,EACxE,CAAC;QACD,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAChC,KAAmE,CAAC,MAAM,CAC5E,EAAE,CAAC;YACF,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAC5B,CAAC;IACH,CAAC;IACD,IAAI,WAAW,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QACzB,KAAK,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7D,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,KAAK,WAAW,IAAI,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAClF,MAAM,IAAI,KAAK,CACb,+CAA+C,WAAW,SAAS,MAAM,CAAC,KAAK,yCAAyC,MAAM,CAAC,KAAK,KAAK;oBACvI,qEAAqE,CACxE,CAAA;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,CAAC,kBAAkB,CAAC,EAAE,IAAa;QACnC,KAAK;QACL,WAAW,EAAE,UAAU;QACvB,UAAU,EAAE,QAAQ;KACI,CAAA;AAC5B,CAAC,CAAA"}

package/dist/DynamoSchema.d.ts

@@ -0,0 +1,137 @@
+/**
+ * DynamoSchema — Application namespace for key prefixing.
+ *
+ * Every generated DynamoDB key starts with `$<schema>#v<version>#` followed by
+ * entity-specific parts. The `$` sentinel identifies ORM-managed keys.
+ */
+export type Casing = "lowercase" | "uppercase" | "preserve";
+export interface DynamoSchema {
+    readonly name: string;
+    readonly version: number;
+    readonly casing: Casing;
+}
+/**
+ * Create a DynamoSchema instance.
+ */
+export declare const make: (config: {
+    readonly name: string;
+    readonly version: number;
+    readonly casing?: Casing | undefined;
+}) => DynamoSchema;
+/**
+ * Apply casing to a key part (structural or composite value).
+ *
+ * Matches ElectroDB behavior: casing is applied to the entire composed key,
+ * including composite attribute values. With the default `"lowercase"` casing,
+ * `"Male"` becomes `"male"` in the key, ensuring case-insensitive key matching.
+ */
+export declare const applyCasing: (value: string, casing: Casing) => string;
+/**
+ * Build the schema prefix: `$<schema>#v<version>`
+ * This is prepended to every generated key.
+ */
+export declare const prefix: (schema: DynamoSchema) => string;
+/**
+ * Compose a full key from schema, entity type, and composite attribute values.
+ *
+ * Format: `$<schema>#v<version>#<entityType>#<attr1>#<attr2>`
+ *
+ * Both the entityType and composite values are cased according to the schema's casing setting.
+ * This matches ElectroDB behavior where the entire key is uniformly cased.
+ */
+export declare const composeKey: (schema: DynamoSchema, entityType: string, composites: ReadonlyArray<string>, options?: {
+    readonly casing?: Casing | undefined;
+    readonly names?: ReadonlyArray<string> | undefined;
+} | undefined) => string;
+/**
+ * Compose a collection key prefix (for clustered collections).
+ *
+ * Format: `$<schema>#v<version>#<collectionName>#<attr1>#<attr2>`
+ */
+export declare const composeCollectionKey: (schema: DynamoSchema, collectionName: string, composites: ReadonlyArray<string>, options?: {
+    readonly casing?: Casing | undefined;
+    readonly names?: ReadonlyArray<string> | undefined;
+} | undefined) => string;
+/**
+ * Compose a sort key for clustered collection indexes.
+ *
+ * Format (single collection):
+ *   `$<schema>#v<version>#<collectionName>#<entityType>_<entityVersion>#<attr1>#<attr2>`
+ *
+ * Format (sub-collection — when `collectionName` is an array):
+ *   `$<schema>#v<version>#<parent>#<child>#<entityType>_<entityVersion>#<attr1>#<attr2>`
+ *
+ * The hierarchy elements are joined with `#` so a `begins_with` query at any level
+ * matches every entity in that subtree.
+ *
+ * The entityVersion is the schema version for the entity type within the collection.
+ * This allows different entity types in a collection to have their own sort key namespace.
+ */
+export declare const composeClusteredSortKey: (schema: DynamoSchema, collectionName: string | ReadonlyArray<string>, entityType: string, entityVersion: number, composites: ReadonlyArray<string>, options?: {
+    readonly casing?: Casing | undefined;
+    readonly names?: ReadonlyArray<string> | undefined;
+} | undefined) => string;
+/**
+ * Compose a sort key for isolated indexes.
+ *
+ * Format: `$<schema>#v<version>#<entityType>_<entityVersion>#<attr1>#<attr2>`
+ */
+export declare const composeIsolatedSortKey: (schema: DynamoSchema, entityType: string, entityVersion: number, composites: ReadonlyArray<string>, options?: {
+    readonly casing?: Casing | undefined;
+    readonly names?: ReadonlyArray<string> | undefined;
+} | undefined) => string;
+/**
+ * Compose a unique constraint sentinel key.
+ *
+ * PK format: `$<schema>#v<version>#<entityType>.<constraintName>#<fieldValues>`
+ * SK format: `$<schema>#v<version>#<entityType>.<constraintName>`
+ */
+export declare const composeUniqueKey: (schema: DynamoSchema, entityType: string, constraintName: string, fieldValues: ReadonlyArray<string>, options?: {
+    readonly casing?: Casing | undefined;
+} | undefined) => {
+    readonly pk: string;
+    readonly sk: string;
+};
+/**
+ * Compose a version snapshot sort key.
+ *
+ * Format: `$<schema>#v<version>#<entityType>#v#<zeroPaddedVersion>`
+ */
+export declare const composeVersionKey: (schema: DynamoSchema, entityType: string, version: number, options?: {
+    readonly casing?: Casing | undefined;
+} | undefined) => string;
+/**
+ * Compose a soft-deleted item sort key.
+ *
+ * Format: `$<schema>#v<version>#<entityType>#deleted#<isoTimestamp>`
+ */
+export declare const composeDeletedKey: (schema: DynamoSchema, entityType: string, timestamp: string, options?: {
+    readonly casing?: Casing | undefined;
+} | undefined) => string;
+/**
+ * Compose the version key prefix for `begins_with` queries.
+ *
+ * Format: `$<schema>#v<version>#<entityType>#v#`
+ */
+export declare const composeVersionKeyPrefix: (schema: DynamoSchema, entityType: string, options?: {
+    readonly casing?: Casing | undefined;
+} | undefined) => string;
+/**
+ * Compose the deleted key prefix for `begins_with` queries.
+ *
+ * Format: `$<schema>#v<version>#<entityType>#deleted#`
+ */
+export declare const composeDeletedKeyPrefix: (schema: DynamoSchema, entityType: string, options?: {
+    readonly casing?: Casing | undefined;
+} | undefined) => string;
+/**
+ * Compose an event version sort key (10-digit zero-padded).
+ *
+ * Format: `$<schema>#v<version>#<entityType>_1#<zeroPaddedVersion>`
+ *
+ * Uses isolated sort key format with 10-digit padding (supports ~10B events per stream).
+ */
+export declare const composeEventVersionKey: (schema: DynamoSchema, entityType: string, version: number, options?: {
+    readonly casing?: Casing | undefined;
+} | undefined) => string;
+//# sourceMappingURL=DynamoSchema.d.ts.map

package/dist/DynamoSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DynamoSchema.d.ts","sourceRoot":"","sources":["../src/DynamoSchema.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG,WAAW,GAAG,UAAU,CAAA;AAE3D,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,eAAO,MAAM,IAAI,GAAI,QAAQ;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACrC,KAAG,YAIF,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,WAAW,GAAI,OAAO,MAAM,EAAE,QAAQ,MAAM,KAAG,MAS3D,CAAA;AAyBD;;;GAGG;AACH,eAAO,MAAM,MAAM,GAAI,QAAQ,YAAY,KAAG,MAG7C,CAAA;AAcD;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,GACrB,QAAQ,YAAY,EACpB,YAAY,MAAM,EAClB,YAAY,aAAa,CAAC,MAAM,CAAC,EACjC,UACI;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;CAAE,GAC5F,SAAS,KACZ,MAYF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,GAC/B,QAAQ,YAAY,EACpB,gBAAgB,MAAM,EACtB,YAAY,aAAa,CAAC,MAAM,CAAC,EACjC,UACI;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;CAAE,GAC5F,SAAS,KACZ,MAYF,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,uBAAuB,GAClC,QAAQ,YAAY,EACpB,gBAAgB,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC,EAC9C,YAAY,MAAM,EAClB,eAAe,MAAM,EACrB,YAAY,aAAa,CAAC,MAAM,CAAC,EACjC,UACI;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;CAAE,GAC5F,SAAS,KACZ,MAaF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GACjC,QAAQ,YAAY,EACpB,YAAY,MAAM,EAClB,eAAe,MAAM,EACrB,YAAY,aAAa,CAAC,MAAM,CAAC,EACjC,UACI;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,SAAS,CAAA;CAAE,GAC5F,SAAS,KACZ,MAWF,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,GAC3B,QAAQ,YAAY,EACpB,YAAY,MAAM,EAClB,gBAAgB,MAAM,EACtB,aAAa,aAAa,CAAC,MAAM,CAAC,EAClC,UAAU;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,KAC7D;IAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;CAa5C,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,YAAY,EACpB,YAAY,MAAM,EAClB,SAAS,MAAM,EACf,UAAU;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,KAC7D,MAGF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAC5B,QAAQ,YAAY,EACpB,YAAY,MAAM,EAClB,WAAW,MAAM,EACjB,UAAU;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,KAC7D,MAGF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,GAClC,QAAQ,YAAY,EACpB,YAAY,MAAM,EAClB,UAAU;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,KAC7D,MAGF,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,GAClC,QAAQ,YAAY,EACpB,YAAY,MAAM,EAClB,UAAU;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,KAC7D,MAGF,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,GACjC,QAAQ,YAAY,EACpB,YAAY,MAAM,EAClB,SAAS,MAAM,EACf,UAAU;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,KAC7D,MAGF,CAAA"}