@kensio/yulin 0.44.0 → 0.47.0

package/dist/service/dynamodb/expression/sim-dynamodb-document-path.d.ts

@@ -0,0 +1,60 @@
+/**
+ * One step of a document path: an attribute of a map.
+ */
+export interface SimDynamoDbAttributeSegment {
+    readonly kind: "attribute";
+    readonly name: string;
+}
+/**
+ * One step of a document path: an element of a list.
+ */
+export interface SimDynamoDbIndexSegment {
+    readonly kind: "index";
+    readonly index: number;
+}
+/**
+ * One step of a document path.
+ */
+export type SimDynamoDbDocumentPathSegment = SimDynamoDbAttributeSegment | SimDynamoDbIndexSegment;
+/**
+ * Where in an item one expression is pointing.
+ *
+ * A path is an attribute name, then any number of further attributes and list
+ * indexes: `address.city`, `lines[0].sku`. It says where to look rather than
+ * what is there, so the same path reads an item that has it and passes over an
+ * item that does not.
+ */
+export declare class SimDynamoDbDocumentPath {
+    readonly segments: readonly SimDynamoDbDocumentPathSegment[];
+    constructor(segments: readonly SimDynamoDbDocumentPathSegment[]);
+    /**
+     * How many levels deep this path reaches.
+     */
+    get depth(): number;
+    /**
+     * What this path names, as text no other path can produce.
+     *
+     * Two paths that print the same are not always the same path: an attribute
+     * whose name carries a dot has to be written as a placeholder, and prints as
+     * though it were two attributes. Anything comparing paths compares this
+     * rather than the printed form.
+     */
+    get identity(): string;
+    /**
+     * Whether this path starts at one named attribute of the item.
+     *
+     * A path into a map or a list is still a path into the attribute it starts
+     * at, so `order.status` starts at `order`. That is what a rule about which
+     * attributes an expression may name is asking about.
+     */
+    startsAt(attributeName: string): boolean;
+    /**
+     * The path written back out, for a refusal to name.
+     *
+     * Placeholders are gone by this point, so this is the path the request meant
+     * rather than the path it wrote.
+     */
+    get text(): string;
+    private segmentText;
+}
+//# sourceMappingURL=sim-dynamodb-document-path.d.ts.map

package/dist/service/dynamodb/expression/sim-dynamodb-document-path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-document-path.d.ts","sourceRoot":"","sources":["../../../../src/service/dynamodb/expression/sim-dynamodb-document-path.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,8BAA8B,GACxC,2BAA2B,GAAG,uBAAuB,CAAC;AAExD;;;;;;;GAOG;AACH,qBAAa,uBAAuB;IAClC,SAAgB,QAAQ,EAAE,SAAS,8BAA8B,EAAE,CAAC;IAEpE,YAAY,QAAQ,EAAE,SAAS,8BAA8B,EAAE,EAE9D;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;;;;;OAOG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAIvC;IAED;;;;;OAKG;IACH,IAAI,IAAI,IAAI,MAAM,CAIjB;IAED,OAAO,CAAC,WAAW;CAcpB"}

package/dist/service/dynamodb/expression/sim-dynamodb-document-path.js

@@ -0,0 +1,64 @@
+import { jsonStringify } from "../../../util/type-guard/json.js";
+/**
+ * Where in an item one expression is pointing.
+ *
+ * A path is an attribute name, then any number of further attributes and list
+ * indexes: `address.city`, `lines[0].sku`. It says where to look rather than
+ * what is there, so the same path reads an item that has it and passes over an
+ * item that does not.
+ */
+export class SimDynamoDbDocumentPath {
+    segments;
+    constructor(segments) {
+        this.segments = segments;
+    }
+    /**
+     * How many levels deep this path reaches.
+     */
+    get depth() {
+        return this.segments.length;
+    }
+    /**
+     * What this path names, as text no other path can produce.
+     *
+     * Two paths that print the same are not always the same path: an attribute
+     * whose name carries a dot has to be written as a placeholder, and prints as
+     * though it were two attributes. Anything comparing paths compares this
+     * rather than the printed form.
+     */
+    get identity() {
+        return jsonStringify(this.segments);
+    }
+    /**
+     * Whether this path starts at one named attribute of the item.
+     *
+     * A path into a map or a list is still a path into the attribute it starts
+     * at, so `order.status` starts at `order`. That is what a rule about which
+     * attributes an expression may name is asking about.
+     */
+    startsAt(attributeName) {
+        const first = this.segments.at(0);
+        return first?.kind === "attribute" && first.name === attributeName;
+    }
+    /**
+     * The path written back out, for a refusal to name.
+     *
+     * Placeholders are gone by this point, so this is the path the request meant
+     * rather than the path it wrote.
+     */
+    get text() {
+        return this.segments
+            .map((segment, index) => this.segmentText(segment, index))
+            .join("");
+    }
+    segmentText(segment, index) {
+        if (segment.kind === "index") {
+            return `[${segment.index.toString()}]`;
+        }
+        if (index === 0) {
+            return segment.name;
+        }
+        return `.${segment.name}`;
+    }
+}
+//# sourceMappingURL=sim-dynamodb-document-path.js.map

package/dist/service/dynamodb/expression/sim-dynamodb-document-path.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-document-path.js","sourceRoot":"","sources":["../../../../src/service/dynamodb/expression/sim-dynamodb-document-path.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,kCAAkC,CAAC;AAwBjE;;;;;;;GAOG;AACH,MAAM,OAAO,uBAAuB;IAClB,QAAQ,CAA4C;IAEpE,YAAY,QAAmD;QAC7D,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,QAAQ;QACV,OAAO,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED;;;;;;OAMG;IACH,QAAQ,CAAC,aAAqB;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAElC,OAAO,KAAK,EAAE,IAAI,KAAK,WAAW,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,CAAC;IACrE,CAAC;IAED;;;;;OAKG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ;aACjB,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;aACzD,IAAI,CAAC,EAAE,CAAC,CAAC;IACd,CAAC;IAEO,WAAW,CACjB,OAAuC,EACvC,KAAa;QAEb,IAAI,OAAO,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YAC7B,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,GAAG,CAAC;QACzC,CAAC;QAED,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YAChB,OAAO,OAAO,CAAC,IAAI,CAAC;QACtB,CAAC;QAED,OAAO,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;CACF"}

package/dist/service/dynamodb/expression/sim-dynamodb-expression-error.d.ts

@@ -0,0 +1,10 @@
+import { SimDynamoDbValidationException } from "../error/dynamodb.error.js";
+/**
+ * Build the error one expression parameter is refused with.
+ *
+ * Real DynamoDB names the parameter that was wrong before saying what was wrong
+ * with it, because a request can carry several expressions at once. Every
+ * refusal here goes through this, so they all read the same way.
+ */
+export declare function simDynamoDbExpressionError(expressionName: string, reason: string): SimDynamoDbValidationException;
+//# sourceMappingURL=sim-dynamodb-expression-error.d.ts.map

package/dist/service/dynamodb/expression/sim-dynamodb-expression-error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-expression-error.d.ts","sourceRoot":"","sources":["../../../../src/service/dynamodb/expression/sim-dynamodb-expression-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAC;AAE5E;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CACxC,cAAc,EAAE,MAAM,EACtB,MAAM,EAAE,MAAM,GACb,8BAA8B,CAIhC"}

package/dist/service/dynamodb/expression/sim-dynamodb-expression-error.js

@@ -0,0 +1,12 @@
+import { SimDynamoDbValidationException } from "../error/dynamodb.error.js";
+/**
+ * Build the error one expression parameter is refused with.
+ *
+ * Real DynamoDB names the parameter that was wrong before saying what was wrong
+ * with it, because a request can carry several expressions at once. Every
+ * refusal here goes through this, so they all read the same way.
+ */
+export function simDynamoDbExpressionError(expressionName, reason) {
+    return new SimDynamoDbValidationException(`Invalid ${expressionName}: ${reason}`);
+}
+//# sourceMappingURL=sim-dynamodb-expression-error.js.map

package/dist/service/dynamodb/expression/sim-dynamodb-expression-error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-expression-error.js","sourceRoot":"","sources":["../../../../src/service/dynamodb/expression/sim-dynamodb-expression-error.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAC;AAE5E;;;;;;GAMG;AACH,MAAM,UAAU,0BAA0B,CACxC,cAAsB,EACtB,MAAc;IAEd,OAAO,IAAI,8BAA8B,CACvC,WAAW,cAAc,KAAK,MAAM,EAAE,CACvC,CAAC;AACJ,CAAC"}

package/dist/service/dynamodb/expression/sim-dynamodb-expression-parameters.d.ts

@@ -0,0 +1,35 @@
+import type { SimDynamoDbAttributeValue } from "../command/item/item.types.js";
+import type { SimDynamoDbValue } from "../item/sim-dynamodb-value.js";
+import { SimDynamoDbExpressionPlaceholders } from "./sim-dynamodb-expression-placeholders.js";
+/**
+ * The two placeholder parameters a request can carry for its expressions.
+ */
+export interface SimDynamoDbExpressionParameterInput {
+    readonly ExpressionAttributeNames?: Readonly<Record<string, string>> | undefined;
+    readonly ExpressionAttributeValues?: Readonly<Record<string, SimDynamoDbAttributeValue>> | undefined;
+}
+/**
+ * The placeholders one request defines for its expressions.
+ *
+ * Every expression kind reads the same two parameters the same way, so they are
+ * held together here rather than assembled per expression. Both are checked
+ * once every expression on the request has been read, so a placeholder used by
+ * any one of them counts as used.
+ */
+export declare class SimDynamoDbExpressionParameters {
+    readonly names: SimDynamoDbExpressionPlaceholders<string>;
+    readonly values: SimDynamoDbExpressionPlaceholders<SimDynamoDbValue>;
+    constructor(input: SimDynamoDbExpressionParameterInput);
+    /**
+     * Refuse placeholders defined for an expression the request does not carry.
+     *
+     * Nothing would ever read them, and a request carrying them has almost
+     * always lost its expression somewhere.
+     */
+    static assertNoneWithout(input: SimDynamoDbExpressionParameterInput): void;
+    /**
+     * Refuse any entry no expression used.
+     */
+    assertAllUsed(): void;
+}
+//# sourceMappingURL=sim-dynamodb-expression-parameters.d.ts.map

package/dist/service/dynamodb/expression/sim-dynamodb-expression-parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-expression-parameters.d.ts","sourceRoot":"","sources":["../../../../src/service/dynamodb/expression/sim-dynamodb-expression-parameters.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAG/E,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAE,iCAAiC,EAAE,MAAM,2CAA2C,CAAC;AAE9F;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD,QAAQ,CAAC,wBAAwB,CAAC,EAChC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,SAAS,CAAC;IAC/C,QAAQ,CAAC,yBAAyB,CAAC,EACjC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAC,GAAG,SAAS,CAAC;CACnE;AAED;;;;;;;GAOG;AACH,qBAAa,+BAA+B;IAC1C,SAAgB,KAAK,EAAE,iCAAiC,CAAC,MAAM,CAAC,CAAC;IACjE,SAAgB,MAAM,EAAE,iCAAiC,CAAC,gBAAgB,CAAC,CAAC;IAE5E,YAAY,KAAK,EAAE,mCAAmC,EAWrD;IAED;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,KAAK,EAAE,mCAAmC,GAAG,IAAI,CAGzE;IAED;;OAEG;IACH,aAAa,IAAI,IAAI,CAGpB;CACF"}

package/dist/service/dynamodb/expression/sim-dynamodb-expression-parameters.js

@@ -0,0 +1,66 @@
+import { SimDynamoDbValidationException } from "../error/dynamodb.error.js";
+import { readSimDynamoDbValue } from "../item/sim-dynamodb-value-reader.js";
+import { SimDynamoDbExpressionPlaceholders } from "./sim-dynamodb-expression-placeholders.js";
+/**
+ * The placeholders one request defines for its expressions.
+ *
+ * Every expression kind reads the same two parameters the same way, so they are
+ * held together here rather than assembled per expression. Both are checked
+ * once every expression on the request has been read, so a placeholder used by
+ * any one of them counts as used.
+ */
+export class SimDynamoDbExpressionParameters {
+    names;
+    values;
+    constructor(input) {
+        this.names = new SimDynamoDbExpressionPlaceholders({
+            parameterName: "ExpressionAttributeNames",
+            marker: "#",
+            entries: input.ExpressionAttributeNames,
+        });
+        this.values = new SimDynamoDbExpressionPlaceholders({
+            parameterName: "ExpressionAttributeValues",
+            marker: ":",
+            entries: storedValues(input.ExpressionAttributeValues),
+        });
+    }
+    /**
+     * Refuse placeholders defined for an expression the request does not carry.
+     *
+     * Nothing would ever read them, and a request carrying them has almost
+     * always lost its expression somewhere.
+     */
+    static assertNoneWithout(input) {
+        assertUnused(input.ExpressionAttributeNames, "Names");
+        assertUnused(input.ExpressionAttributeValues, "Values");
+    }
+    /**
+     * Refuse any entry no expression used.
+     */
+    assertAllUsed() {
+        this.names.assertAllUsed();
+        this.values.assertAllUsed();
+    }
+}
+/**
+ * Read the values a request supplied into the values a table holds.
+ *
+ * Reading them here is what checks them: a value an item could not carry is one
+ * no expression could ever have matched.
+ */
+function storedValues(entries) {
+    return Object.fromEntries(Object.entries(entries ?? {}).map(([placeholder, value]) => [
+        placeholder,
+        readSimDynamoDbValue(value),
+    ]));
+}
+/**
+ * Refuse one parameter supplied with no expression to use it in.
+ */
+function assertUnused(entries, suffix) {
+    if (Object.keys(entries ?? {}).length > 0) {
+        throw new SimDynamoDbValidationException(`ExpressionAttribute${suffix} can only be specified when using ` +
+            `expressions, and this request carries none`);
+    }
+}
+//# sourceMappingURL=sim-dynamodb-expression-parameters.js.map

package/dist/service/dynamodb/expression/sim-dynamodb-expression-parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-expression-parameters.js","sourceRoot":"","sources":["../../../../src/service/dynamodb/expression/sim-dynamodb-expression-parameters.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAC;AAC5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAE5E,OAAO,EAAE,iCAAiC,EAAE,MAAM,2CAA2C,CAAC;AAY9F;;;;;;;GAOG;AACH,MAAM,OAAO,+BAA+B;IAC1B,KAAK,CAA4C;IACjD,MAAM,CAAsD;IAE5E,YAAY,KAA0C;QACpD,IAAI,CAAC,KAAK,GAAG,IAAI,iCAAiC,CAAC;YACjD,aAAa,EAAE,0BAA0B;YACzC,MAAM,EAAE,GAAG;YACX,OAAO,EAAE,KAAK,CAAC,wBAAwB;SACxC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,iCAAiC,CAAC;YAClD,aAAa,EAAE,2BAA2B;YAC1C,MAAM,EAAE,GAAG;YACX,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC,yBAAyB,CAAC;SACvD,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,KAA0C;QACjE,YAAY,CAAC,KAAK,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;QACtD,YAAY,CAAC,KAAK,CAAC,yBAAyB,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED;;OAEG;IACH,aAAa;QACX,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAC;QAC3B,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC;IAC9B,CAAC;CACF;AAED;;;;;GAKG;AACH,SAAS,YAAY,CACnB,OAAwE;IAExE,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC;QAC1D,WAAW;QACX,oBAAoB,CAAC,KAAK,CAAC;KAC5B,CAAC,CACH,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CACnB,OAAoD,EACpD,MAAc;IAEd,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,8BAA8B,CACtC,sBAAsB,MAAM,oCAAoC;YAC9D,4CAA4C,CAC/C,CAAC;IACJ,CAAC;AACH,CAAC"}

package/dist/service/dynamodb/expression/sim-dynamodb-expression-placeholders.d.ts

@@ -0,0 +1,48 @@
+interface SimDynamoDbExpressionPlaceholdersProperties<Value> {
+    /** The request parameter the entries came from, for a refusal to name. */
+    readonly parameterName: string;
+    /** The marker every key of that parameter starts with, `#` or `:`. */
+    readonly marker: string;
+    readonly entries?: Readonly<Record<string, Value>> | undefined;
+}
+/**
+ * The placeholders one request parameter defines for its expressions.
+ *
+ * `ExpressionAttributeNames` and `ExpressionAttributeValues` work the same way:
+ * a map of placeholders to what they stand for, where the expression and the
+ * map have to agree exactly. This holds either of them.
+ *
+ * It fails closed in both directions. A placeholder an expression uses and the
+ * request does not define is refused, and so is an entry the request defines
+ * and no expression uses. Real DynamoDB refuses both, and the unused one is
+ * what a request hits after an expression is edited and the old placeholder is
+ * left behind.
+ */
+export declare class SimDynamoDbExpressionPlaceholders<Value> {
+    private readonly parameterName;
+    private readonly marker;
+    private readonly entries;
+    private readonly used;
+    constructor(properties: SimDynamoDbExpressionPlaceholdersProperties<Value>);
+    /**
+     * What a placeholder stands for, refusing one the request never defined.
+     */
+    required(placeholder: string): Value;
+    /**
+     * Refuse an entry no expression used.
+     *
+     * Called once every expression on the request has been read, so a placeholder
+     * used by any one of them counts as used.
+     */
+    assertAllUsed(): void;
+    /**
+     * Refuse a key that is not a placeholder at all.
+     *
+     * A map keyed by the bare attribute name rather than by `#name` would leave
+     * every placeholder in the expression undefined, which is a confusing way to
+     * find out the key was written wrong.
+     */
+    private assertKeysArePlaceholders;
+}
+export {};
+//# sourceMappingURL=sim-dynamodb-expression-placeholders.d.ts.map

package/dist/service/dynamodb/expression/sim-dynamodb-expression-placeholders.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-expression-placeholders.d.ts","sourceRoot":"","sources":["../../../../src/service/dynamodb/expression/sim-dynamodb-expression-placeholders.ts"],"names":[],"mappings":"AAEA,UAAU,2CAA2C,CAAC,KAAK;IACzD,0EAA0E;IAC1E,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,sEAAsE;IACtE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC;CAChE;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,iCAAiC,CAAC,KAAK;IAClD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA6B;IACrD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAqB;IAE1C,YAAY,UAAU,EAAE,2CAA2C,CAAC,KAAK,CAAC,EAMzE;IAED;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,KAAK,CAanC;IAED;;;;;OAKG;IACH,aAAa,IAAI,IAAI,CAYpB;IAED;;;;;;OAMG;IACH,OAAO,CAAC,yBAAyB;CAUlC"}

package/dist/service/dynamodb/expression/sim-dynamodb-expression-placeholders.js

@@ -0,0 +1,70 @@
+import { SimDynamoDbValidationException } from "../error/dynamodb.error.js";
+/**
+ * The placeholders one request parameter defines for its expressions.
+ *
+ * `ExpressionAttributeNames` and `ExpressionAttributeValues` work the same way:
+ * a map of placeholders to what they stand for, where the expression and the
+ * map have to agree exactly. This holds either of them.
+ *
+ * It fails closed in both directions. A placeholder an expression uses and the
+ * request does not define is refused, and so is an entry the request defines
+ * and no expression uses. Real DynamoDB refuses both, and the unused one is
+ * what a request hits after an expression is edited and the old placeholder is
+ * left behind.
+ */
+export class SimDynamoDbExpressionPlaceholders {
+    parameterName;
+    marker;
+    entries;
+    used = new Set();
+    constructor(properties) {
+        this.parameterName = properties.parameterName;
+        this.marker = properties.marker;
+        this.entries = new Map(Object.entries(properties.entries ?? {}));
+        this.assertKeysArePlaceholders();
+    }
+    /**
+     * What a placeholder stands for, refusing one the request never defined.
+     */
+    required(placeholder) {
+        const value = this.entries.get(placeholder);
+        if (value === undefined) {
+            throw new SimDynamoDbValidationException(`${this.parameterName} does not define ${placeholder}, which an ` +
+                `expression uses`);
+        }
+        this.used.add(placeholder);
+        return value;
+    }
+    /**
+     * Refuse an entry no expression used.
+     *
+     * Called once every expression on the request has been read, so a placeholder
+     * used by any one of them counts as used.
+     */
+    assertAllUsed() {
+        const unused = this.entries
+            .keys()
+            .filter((placeholder) => !this.used.has(placeholder))
+            .toArray();
+        if (unused.length > 0) {
+            throw new SimDynamoDbValidationException(`Value provided in ${this.parameterName} is unused in ` +
+                `expressions: ${unused.join(", ")}`);
+        }
+    }
+    /**
+     * Refuse a key that is not a placeholder at all.
+     *
+     * A map keyed by the bare attribute name rather than by `#name` would leave
+     * every placeholder in the expression undefined, which is a confusing way to
+     * find out the key was written wrong.
+     */
+    assertKeysArePlaceholders() {
+        for (const key of this.entries.keys()) {
+            if (!key.startsWith(this.marker)) {
+                throw new SimDynamoDbValidationException(`${this.parameterName} contains the invalid key ${key}. A ` +
+                    `placeholder starts with '${this.marker}'.`);
+            }
+        }
+    }
+}
+//# sourceMappingURL=sim-dynamodb-expression-placeholders.js.map

package/dist/service/dynamodb/expression/sim-dynamodb-expression-placeholders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-expression-placeholders.js","sourceRoot":"","sources":["../../../../src/service/dynamodb/expression/sim-dynamodb-expression-placeholders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAE,MAAM,4BAA4B,CAAC;AAU5E;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,iCAAiC;IAC3B,aAAa,CAAS;IACtB,MAAM,CAAS;IACf,OAAO,CAA6B;IACpC,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAE1C,YAAY,UAA8D;QACxE,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;QAChC,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;QAEjE,IAAI,CAAC,yBAAyB,EAAE,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,WAAmB;QAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAE5C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,8BAA8B,CACtC,GAAG,IAAI,CAAC,aAAa,oBAAoB,WAAW,aAAa;gBAC/D,iBAAiB,CACpB,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QAE3B,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACH,aAAa;QACX,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO;aACxB,IAAI,EAAE;aACN,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;aACpD,OAAO,EAAE,CAAC;QAEb,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,8BAA8B,CACtC,qBAAqB,IAAI,CAAC,aAAa,gBAAgB;gBACrD,gBAAgB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACtC,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACK,yBAAyB;QAC/B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC;YACtC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;gBACjC,MAAM,IAAI,8BAA8B,CACtC,GAAG,IAAI,CAAC,aAAa,6BAA6B,GAAG,MAAM;oBACzD,4BAA4B,IAAI,CAAC,MAAM,IAAI,CAC9C,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;CACF"}

package/dist/service/dynamodb/expression/sim-dynamodb-expression-symbols.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The symbol an expression starts with, or nothing when it starts with a
+ * character no supported expression uses.
+ */
+export declare function readSimDynamoDbSymbol(remaining: string): string | undefined;
+//# sourceMappingURL=sim-dynamodb-expression-symbols.d.ts.map

package/dist/service/dynamodb/expression/sim-dynamodb-expression-symbols.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-expression-symbols.d.ts","sourceRoot":"","sources":["../../../../src/service/dynamodb/expression/sim-dynamodb-expression-symbols.ts"],"names":[],"mappings":"AA+BA;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAc3E"}

package/dist/service/dynamodb/expression/sim-dynamodb-expression-symbols.js

@@ -0,0 +1,45 @@
+/**
+ * The two character operators, which are read before the single characters so
+ * `<=` is one operator rather than a `<` followed by an `=`.
+ */
+const longSymbols = ["<=", ">=", "<>"];
+/**
+ * The single characters that mean something in the expressions supported so
+ * far.
+ *
+ * This set grows as filter expressions arrive. Until then, a character outside
+ * it is refused rather than passed through, so an expression this simulation
+ * cannot evaluate fails rather than half works.
+ *
+ * `+` is here for the arithmetic an update expression can carry, which is read
+ * so that it can be refused by name rather than as an unexpected character.
+ */
+const symbols = new Set([
+    ".",
+    ",",
+    "[",
+    "]",
+    "-",
+    "+",
+    "(",
+    ")",
+    "=",
+    "<",
+    ">",
+]);
+/**
+ * The symbol an expression starts with, or nothing when it starts with a
+ * character no supported expression uses.
+ */
+export function readSimDynamoDbSymbol(remaining) {
+    const operator = longSymbols.find((text) => remaining.startsWith(text));
+    if (operator !== undefined) {
+        return operator;
+    }
+    const character = remaining.slice(0, 1);
+    if (!symbols.has(character)) {
+        return undefined;
+    }
+    return character;
+}
+//# sourceMappingURL=sim-dynamodb-expression-symbols.js.map

package/dist/service/dynamodb/expression/sim-dynamodb-expression-symbols.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-expression-symbols.js","sourceRoot":"","sources":["../../../../src/service/dynamodb/expression/sim-dynamodb-expression-symbols.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,GAAsB,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAE1D;;;;;;;;;;GAUG;AACH,MAAM,OAAO,GAAwB,IAAI,GAAG,CAAC;IAC3C,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;IACH,GAAG;CACJ,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CAAC,SAAiB;IACrD,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;IAExE,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAExC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/service/dynamodb/expression/sim-dynamodb-expression-token-reader.d.ts

@@ -0,0 +1,45 @@
+import type { SimDynamoDbExpressionToken } from "./sim-dynamodb-expression-token.js";
+/**
+ * A token before it is told where in the expression it was found.
+ */
+export type SimDynamoDbUnplacedToken = Omit<SimDynamoDbExpressionToken, "position">;
+/**
+ * Reads the one token an expression starts with.
+ *
+ * This knows what each kind of token looks like. Where the tokens are and what
+ * order they come in is not its business, so it takes whatever is left of an
+ * expression and answers with the first thing in it.
+ */
+export declare class SimDynamoDbExpressionTokenReader {
+    private readonly expressionName;
+    constructor(expressionName: string);
+    /**
+     * Read the token at the start of what is left of an expression.
+     */
+    read(remaining: string): SimDynamoDbUnplacedToken;
+    /**
+     * Read an attribute name written into the expression itself.
+     */
+    private name;
+    /**
+     * Read a placeholder, which is its marker and the word after it.
+     *
+     * A marker with no word after it is refused here rather than read as a
+     * marker on its own, since a bare `#` names nothing.
+     */
+    private placeholder;
+    /**
+     * Read a number, which is its digits and the fraction after them if it has
+     * one.
+     */
+    private number;
+    /**
+     * Read a single character that means something on its own.
+     */
+    private symbol;
+    /**
+     * Build the error the expression being read is refused with.
+     */
+    private error;
+}
+//# sourceMappingURL=sim-dynamodb-expression-token-reader.d.ts.map

package/dist/service/dynamodb/expression/sim-dynamodb-expression-token-reader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-expression-token-reader.d.ts","sourceRoot":"","sources":["../../../../src/service/dynamodb/expression/sim-dynamodb-expression-token-reader.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,0BAA0B,EAE3B,MAAM,oCAAoC,CAAC;AA6B5C;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,IAAI,CACzC,0BAA0B,EAC1B,UAAU,CACX,CAAC;AAOF;;;;;;GAMG;AACH,qBAAa,gCAAgC;IAC3C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IAExC,YAAY,cAAc,EAAE,MAAM,EAEjC;IAED;;OAEG;IACH,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,wBAAwB,CAQhD;IAED;;OAEG;IACH,OAAO,CAAC,IAAI;IAUZ;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAqBnB;;;OAGG;IACH,OAAO,CAAC,MAAM;IAad;;OAEG;IACH,OAAO,CAAC,MAAM;IAYd;;OAEG;IACH,OAAO,CAAC,KAAK;CAGd"}

package/dist/service/dynamodb/expression/sim-dynamodb-expression-token-reader.js

@@ -0,0 +1,105 @@
+import { simDynamoDbExpressionError } from "./sim-dynamodb-expression-error.js";
+import { readSimDynamoDbSymbol } from "./sim-dynamodb-expression-symbols.js";
+/**
+ * An attribute name written into an expression: a letter or underscore, then
+ * letters, numbers and underscores. A name outside that has to be written as an
+ * ExpressionAttributeNames placeholder, on real DynamoDB as well as here.
+ */
+const namePattern = /^[A-Za-z_]\w*/;
+/**
+ * A placeholder, after its leading `#` or `:`.
+ */
+const placeholderPattern = /^\w+/;
+/**
+ * The whole part of a number, which is a list index in the expressions
+ * supported so far.
+ */
+const digitsPattern = /^\d+/;
+/**
+ * The fractional part of a number, read straight after the whole part.
+ *
+ * A fraction is read as one number rather than as a number, a dot and another
+ * number, so an index of `1.5` is refused as a fraction rather than as a
+ * syntax error somewhere after it.
+ */
+const fractionPattern = /^\.\d+/;
+/**
+ * Reads the one token an expression starts with.
+ *
+ * This knows what each kind of token looks like. Where the tokens are and what
+ * order they come in is not its business, so it takes whatever is left of an
+ * expression and answers with the first thing in it.
+ */
+export class SimDynamoDbExpressionTokenReader {
+    expressionName;
+    constructor(expressionName) {
+        this.expressionName = expressionName;
+    }
+    /**
+     * Read the token at the start of what is left of an expression.
+     */
+    read(remaining) {
+        return (this.name(remaining) ??
+            this.placeholder("namePlaceholder", "#", remaining) ??
+            this.placeholder("valuePlaceholder", ":", remaining) ??
+            this.number(remaining) ??
+            this.symbol(remaining));
+    }
+    /**
+     * Read an attribute name written into the expression itself.
+     */
+    name(remaining) {
+        const text = namePattern.exec(remaining)?.[0];
+        if (text === undefined) {
+            return undefined;
+        }
+        return { kind: "name", text };
+    }
+    /**
+     * Read a placeholder, which is its marker and the word after it.
+     *
+     * A marker with no word after it is refused here rather than read as a
+     * marker on its own, since a bare `#` names nothing.
+     */
+    placeholder(kind, marker, remaining) {
+        if (!remaining.startsWith(marker)) {
+            return undefined;
+        }
+        const named = remaining.slice(marker.length);
+        const word = placeholderPattern.exec(named)?.[0];
+        if (word === undefined) {
+            throw this.error(`syntax error; the placeholder marker '${marker}' names nothing`);
+        }
+        return { kind, text: `${marker}${word}` };
+    }
+    /**
+     * Read a number, which is its digits and the fraction after them if it has
+     * one.
+     */
+    number(remaining) {
+        const digits = digitsPattern.exec(remaining)?.[0];
+        if (digits === undefined) {
+            return undefined;
+        }
+        const after = remaining.slice(digits.length);
+        const fraction = fractionPattern.exec(after)?.[0] ?? "";
+        return { kind: "number", text: `${digits}${fraction}` };
+    }
+    /**
+     * Read a single character that means something on its own.
+     */
+    symbol(remaining) {
+        const text = readSimDynamoDbSymbol(remaining);
+        if (text === undefined) {
+            throw this.error(`syntax error; unexpected character '${remaining.slice(0, 1)}'`);
+        }
+        return { kind: "symbol", text };
+    }
+    /**
+     * Build the error the expression being read is refused with.
+     */
+    error(reason) {
+        return simDynamoDbExpressionError(this.expressionName, reason);
+    }
+}
+//# sourceMappingURL=sim-dynamodb-expression-token-reader.js.map

package/dist/service/dynamodb/expression/sim-dynamodb-expression-token-reader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sim-dynamodb-expression-token-reader.js","sourceRoot":"","sources":["../../../../src/service/dynamodb/expression/sim-dynamodb-expression-token-reader.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAE,qBAAqB,EAAE,MAAM,sCAAsC,CAAC;AAM7E;;;;GAIG;AACH,MAAM,WAAW,GAAG,eAAe,CAAC;AAEpC;;GAEG;AACH,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAElC;;;GAGG;AACH,MAAM,aAAa,GAAG,MAAM,CAAC;AAE7B;;;;;;GAMG;AACH,MAAM,eAAe,GAAG,QAAQ,CAAC;AAejC;;;;;;GAMG;AACH,MAAM,OAAO,gCAAgC;IAC1B,cAAc,CAAS;IAExC,YAAY,cAAsB;QAChC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;IACvC,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,SAAiB;QACpB,OAAO,CACL,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;YACpB,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,GAAG,EAAE,SAAS,CAAC;YACnD,IAAI,CAAC,WAAW,CAAC,kBAAkB,EAAE,GAAG,EAAE,SAAS,CAAC;YACpD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;YACtB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CACvB,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,IAAI,CAAC,SAAiB;QAC5B,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAE9C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;IAChC,CAAC;IAED;;;;;OAKG;IACK,WAAW,CACjB,IAAoC,EACpC,MAAc,EACd,SAAiB;QAEjB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAEjD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,CAAC,KAAK,CACd,yCAAyC,MAAM,iBAAiB,CACjE,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,MAAM,GAAG,IAAI,EAAE,EAAE,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACK,MAAM,CAAC,SAAiB;QAC9B,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAElD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAExD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,MAAM,GAAG,QAAQ,EAAE,EAAE,CAAC;IAC1D,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,SAAiB;QAC9B,MAAM,IAAI,GAAG,qBAAqB,CAAC,SAAS,CAAC,CAAC;QAE9C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,CAAC,KAAK,CACd,uCAAuC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAChE,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,MAAc;QAC1B,OAAO,0BAA0B,CAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACjE,CAAC;CACF"}

package/dist/service/dynamodb/expression/sim-dynamodb-expression-token.d.ts

@@ -0,0 +1,19 @@
+/**
+ * What one piece of a DynamoDB expression is.
+ *
+ * A placeholder keeps its `#` or `:` in its text, so an error can name it the
+ * way the request wrote it.
+ */
+export type SimDynamoDbExpressionTokenKind = "name" | "namePlaceholder" | "valuePlaceholder" | "number" | "symbol";
+/**
+ * One piece of a DynamoDB expression.
+ *
+ * The position is where the token starts in the expression text, so a refusal
+ * can say where it went wrong rather than only what was wrong.
+ */
+export interface SimDynamoDbExpressionToken {
+    readonly kind: SimDynamoDbExpressionTokenKind;
+    readonly text: string;
+    readonly position: number;
+}
+//# sourceMappingURL=sim-dynamodb-expression-token.d.ts.map