@kravc/dos 1.12.6 → 2.0.0-alpha.0

package/dist/Context/getMutationParameters.d.ts

@@ -0,0 +1,8 @@
+import type { MutationMap, Request } from './Request';
+/** Returns mutation parameters of a request. */
+declare const getMutationParameters: (request: Request) => {
+    bodyJson: string | null;
+    mutation: MutationMap | null;
+};
+export default getMutationParameters;
+//# sourceMappingURL=getMutationParameters.d.ts.map

package/dist/Context/getMutationParameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getMutationParameters.d.ts","sourceRoot":"","sources":["../../src/Context/getMutationParameters.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEtD,gDAAgD;AAChD,QAAA,MAAM,qBAAqB,GAAI,SAAS,OAAO;cAKjC,MAAM,GAAG,IAAI;cACb,WAAW,GAAG,IAAI;CAsB/B,CAAC;AAEF,eAAe,qBAAqB,CAAC"}

package/dist/Context/getMutationParameters.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+/** Returns mutation parameters of a request. */
+const getMutationParameters = (request) => {
+    const result = {
+        bodyJson: null,
+        mutation: null,
+    };
+    const { body } = request;
+    if (!body) {
+        return result;
+    }
+    const isJSON = (0, lodash_1.isString)(body);
+    if (isJSON) {
+        result.bodyJson = body;
+        result.mutation = JSON.parse(body);
+        return result;
+    }
+    result.bodyJson = JSON.stringify(body);
+    result.mutation = body;
+    return result;
+};
+exports.default = getMutationParameters;
+//# sourceMappingURL=getMutationParameters.js.map

package/dist/Context/getMutationParameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getMutationParameters.js","sourceRoot":"","sources":["../../src/Context/getMutationParameters.ts"],"names":[],"mappings":";;AAAA,mCAAkC;AAGlC,gDAAgD;AAChD,MAAM,qBAAqB,GAAG,CAAC,OAAgB,EAAE,EAAE;IACjD,MAAM,MAAM,GAAG;QACb,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,IAAI;KAIf,CAAC;IAEF,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAEzB,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,MAAM,GAAG,IAAA,iBAAQ,EAAC,IAAI,CAAC,CAAC;IAE9B,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;QACvB,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAEnC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACvC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IAEvB,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,kBAAe,qBAAqB,CAAC"}

package/dist/Context/getOperationId.d.ts

@@ -0,0 +1,6 @@
+import { OpenAPIV2 } from 'openapi-types';
+import type { Request } from './Request';
+/** Returns operation ID for a request. */
+declare const getOperationId: (spec: OpenAPIV2.Document, request: Request) => string;
+export default getOperationId;
+//# sourceMappingURL=getOperationId.d.ts.map

package/dist/Context/getOperationId.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOperationId.d.ts","sourceRoot":"","sources":["../../src/Context/getOperationId.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,OAAO,EAAiB,MAAM,WAAW,CAAC;AAIxD,0CAA0C;AAC1C,QAAA,MAAM,cAAc,GAAI,MAAM,SAAS,CAAC,QAAQ,EAAE,SAAS,OAAO,KAAG,MAWpE,CAAC;AAEF,eAAe,cAAc,CAAC"}

package/dist/Context/getOperationId.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const getHttpPath_1 = __importDefault(require("./getHttpPath"));
+const getHttpMethod_1 = __importDefault(require("./getHttpMethod"));
+const UNDEFINED_VALUE = 'undefined';
+/** Returns operation ID for a request. */
+const getOperationId = (spec, request) => {
+    const { operationId } = request;
+    if (operationId) {
+        return operationId;
+    }
+    const httpPath = (0, getHttpPath_1.default)(spec, request);
+    const httpMethod = (0, getHttpMethod_1.default)(spec, request);
+    return (0, lodash_1.get)(spec.paths, `${httpPath}.${httpMethod}.operationId`, UNDEFINED_VALUE);
+};
+exports.default = getOperationId;
+//# sourceMappingURL=getOperationId.js.map

package/dist/Context/getOperationId.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOperationId.js","sourceRoot":"","sources":["../../src/Context/getOperationId.ts"],"names":[],"mappings":";;;;;AAAA,mCAA6B;AAC7B,gEAAwC;AACxC,oEAA4C;AAI5C,MAAM,eAAe,GAAG,WAAW,CAAC;AAEpC,0CAA0C;AAC1C,MAAM,cAAc,GAAG,CAAC,IAAwB,EAAE,OAAgB,EAAU,EAAE;IAC5E,MAAM,EAAE,WAAW,EAAE,GAAG,OAAwB,CAAC;IAEjD,IAAI,WAAW,EAAE,CAAC;QAChB,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,QAAQ,GAAG,IAAA,qBAAW,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,MAAM,UAAU,GAAG,IAAA,uBAAa,EAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEhD,OAAO,IAAA,YAAG,EAAC,IAAI,CAAC,KAAK,EAAE,GAAG,QAAQ,IAAI,UAAU,cAAc,EAAE,eAAe,CAAW,CAAC;AAC7F,CAAC,CAAC;AAEF,kBAAe,cAAc,CAAC"}

package/dist/Context/getQueryParameters.d.ts

@@ -0,0 +1,5 @@
+import type { QueryMap, Request } from './Request';
+/** Returns query parameters of a request. */
+declare const getQueryParameters: (request: Request) => QueryMap;
+export default getQueryParameters;
+//# sourceMappingURL=getQueryParameters.d.ts.map

package/dist/Context/getQueryParameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getQueryParameters.d.ts","sourceRoot":"","sources":["../../src/Context/getQueryParameters.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAInD,6CAA6C;AAC7C,QAAA,MAAM,kBAAkB,GAAI,SAAS,OAAO,KAAG,QAoC9C,CAAC;AAEF,eAAe,kBAAkB,CAAC"}

package/dist/Context/getQueryParameters.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_1 = require("lodash");
+const BASE_URL = 'http://localhost:3000';
+/** Returns query parameters of a request. */
+const getQueryParameters = (request) => {
+    let parameters = {};
+    const url = (0, lodash_1.get)(request, 'url');
+    if (url) {
+        const { searchParams } = new URL(url, BASE_URL);
+        parameters = Object.fromEntries(searchParams);
+    }
+    const queryStringParameters = (0, lodash_1.get)(request, 'queryStringParameters');
+    if (queryStringParameters) {
+        const keys = Object.keys(queryStringParameters);
+        for (const key of keys) {
+            const value = queryStringParameters[key];
+            queryStringParameters[key] = decodeURIComponent(value);
+        }
+        parameters = queryStringParameters;
+    }
+    const queryKeys = Object.keys(parameters);
+    for (const queryKey of queryKeys) {
+        const value = parameters[queryKey];
+        const isArrayOfStrings = `${value}`.startsWith('["');
+        if (isArrayOfStrings) {
+            parameters[queryKey] = JSON.parse(`${value}`);
+        }
+    }
+    return parameters;
+};
+exports.default = getQueryParameters;
+//# sourceMappingURL=getQueryParameters.js.map

package/dist/Context/getQueryParameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getQueryParameters.js","sourceRoot":"","sources":["../../src/Context/getQueryParameters.ts"],"names":[],"mappings":";;AAAA,mCAA6B;AAG7B,MAAM,QAAQ,GAAG,uBAAuB,CAAC;AAEzC,6CAA6C;AAC7C,MAAM,kBAAkB,GAAG,CAAC,OAAgB,EAAY,EAAE;IACxD,IAAI,UAAU,GAAG,EAAc,CAAC;IAEhC,MAAM,GAAG,GAAG,IAAA,YAAG,EAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAEhC,IAAI,GAAG,EAAE,CAAC;QACR,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAChD,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;IAChD,CAAC;IAED,MAAM,qBAAqB,GAAG,IAAA,YAAG,EAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;IAEpE,IAAI,qBAAqB,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAEhD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,MAAM,KAAK,GAAG,qBAAqB,CAAC,GAAG,CAAW,CAAC;YACnD,qBAAqB,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QACzD,CAAC;QAED,UAAU,GAAG,qBAAqB,CAAC;IACrC,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAG1C,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAW,CAAC;QAC7C,MAAM,gBAAgB,GAAG,GAAG,KAAK,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAErD,IAAI,gBAAgB,EAAE,CAAC;YACrB,UAAU,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,kBAAe,kBAAkB,CAAC"}

package/dist/Context/index.d.ts

@@ -0,0 +1,7 @@
+import Context from './Context';
+import withSafeAttributes from './withSafeAttributes';
+export default Context;
+export { Context, withSafeAttributes, };
+export type * from './Context';
+export type * from './Request';
+//# sourceMappingURL=index.d.ts.map

package/dist/Context/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Context/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAAO,MAAM,WAAW,CAAC;AAChC,OAAO,kBAAkB,MAAM,sBAAsB,CAAC;AAEtD,eAAe,OAAO,CAAC;AAEvB,OAAO,EACL,OAAO,EACP,kBAAkB,GACnB,CAAC;AAEF,mBAAmB,WAAW,CAAC;AAC/B,mBAAmB,WAAW,CAAC"}

package/dist/Context/index.js

@@ -0,0 +1,12 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withSafeAttributes = exports.Context = void 0;
+const Context_1 = __importDefault(require("./Context"));
+exports.Context = Context_1.default;
+const withSafeAttributes_1 = __importDefault(require("./withSafeAttributes"));
+exports.withSafeAttributes = withSafeAttributes_1.default;
+exports.default = Context_1.default;
+//# sourceMappingURL=index.js.map

package/dist/Context/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Context/index.ts"],"names":[],"mappings":";;;;;;AAAA,wDAAgC;AAM9B,kBANK,iBAAO,CAML;AALT,8EAAsD;AAMpD,6BANK,4BAAkB,CAML;AAJpB,kBAAe,iBAAO,CAAC"}

package/dist/Context/withSafeAttributes.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Returns instance of an object with safe attributes.
+ *
+ * ## Intent
+ *
+ * Wraps an object instance in a Proxy that enforces safe attribute access. This function ensures that:
+ * - Properties and methods must exist on the instance before they can be accessed
+ * - Clear, descriptive errors are thrown when accessing undefined properties/methods
+ * - The object cannot be accidentally treated as a Promise (by returning `undefined` for `then`)
+ *
+ * This is particularly useful for component classes where you want to catch typos and undefined
+ * property access early with helpful error messages that include the class name.
+ *
+ * ## Use Cases
+ *
+ * 1. **Component Safety**: Wrap component instances to ensure all property/method accesses are valid
+ * 2. **Early Error Detection**: Catch typos and undefined accesses at runtime with clear error messages
+ * 3. **Promise Prevention**: Prevent objects from being accidentally treated as Promises in async contexts
+ * 4. **Type Safety**: Provide runtime validation complementing TypeScript's compile-time checks
+ */
+declare function withSafeAttributes<T>(targetInstance: T, className: string): T;
+export default withSafeAttributes;
+//# sourceMappingURL=withSafeAttributes.d.ts.map

package/dist/Context/withSafeAttributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withSafeAttributes.d.ts","sourceRoot":"","sources":["../../src/Context/withSafeAttributes.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,iBAAS,kBAAkB,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC,CActE;AAED,eAAe,kBAAkB,CAAC"}

package/dist/Context/withSafeAttributes.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const schema_1 = require("@kravc/schema");
+/**
+ * Returns instance of an object with safe attributes.
+ *
+ * ## Intent
+ *
+ * Wraps an object instance in a Proxy that enforces safe attribute access. This function ensures that:
+ * - Properties and methods must exist on the instance before they can be accessed
+ * - Clear, descriptive errors are thrown when accessing undefined properties/methods
+ * - The object cannot be accidentally treated as a Promise (by returning `undefined` for `then`)
+ *
+ * This is particularly useful for component classes where you want to catch typos and undefined
+ * property access early with helpful error messages that include the class name.
+ *
+ * ## Use Cases
+ *
+ * 1. **Component Safety**: Wrap component instances to ensure all property/method accesses are valid
+ * 2. **Early Error Detection**: Catch typos and undefined accesses at runtime with clear error messages
+ * 3. **Promise Prevention**: Prevent objects from being accidentally treated as Promises in async contexts
+ * 4. **Type Safety**: Provide runtime validation complementing TypeScript's compile-time checks
+ */
+function withSafeAttributes(targetInstance, className) {
+    return new Proxy(targetInstance, {
+        /** Ensures attribute is defined as property or method of the instance. */
+        get(target, prop) {
+            const shouldSkip = ['then'].includes(prop);
+            if (shouldSkip) {
+                return undefined;
+            }
+            const errorTemplate = `"$PATH" property or method is undefined for ${className} instance`;
+            return (0, schema_1.got)(target, prop, errorTemplate);
+        }
+    });
+}
+;
+exports.default = withSafeAttributes;
+//# sourceMappingURL=withSafeAttributes.js.map

package/dist/Context/withSafeAttributes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"withSafeAttributes.js","sourceRoot":"","sources":["../../src/Context/withSafeAttributes.ts"],"names":[],"mappings":";;AAAA,0CAAoC;AAEpC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAS,kBAAkB,CAAI,cAAiB,EAAE,SAAiB;IACjE,OAAO,IAAI,KAAK,CAAC,cAAwB,EAAE;QACzC,0EAA0E;QAC1E,GAAG,CAAC,MAA+B,EAAE,IAAY;YAC/C,MAAM,UAAU,GAAG,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAE3C,IAAI,UAAU,EAAE,CAAC;gBACf,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,MAAM,aAAa,GAAG,+CAA+C,SAAS,WAAW,CAAC;YAC1F,OAAO,IAAA,YAAG,EAAC,MAAM,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC;QAC1C,CAAC;KACF,CAAM,CAAC;AACV,CAAC;AAAA,CAAC;AAEF,kBAAe,kBAAkB,CAAC"}

package/dist/Document/Document.d.ts

@@ -0,0 +1,114 @@
+import Component from '../Component';
+import { Schema, type PropertiesSchemaSource } from '@kravc/schema';
+import Context, { type QueryMap, type MutationMap } from '../Context';
+export type IndexOptions = {
+    sort?: 'asc' | 'desc';
+    limit?: number;
+    index?: string;
+    exclusiveStartKey?: string;
+};
+export type IndexAllOptions = {
+    sort?: 'asc' | 'desc';
+    index?: string;
+};
+export type DefaultAttributes = {
+    id: string;
+    createdAt: string;
+    createdBy: string;
+    createdByUserName?: string;
+    updatedAt?: string;
+    updatedBy?: string;
+    updatedByUserName?: string;
+};
+type Constructor<T, D extends Document<T> = Document<T>> = {
+    new (context: Context, attributes: T): D;
+    _index(query: QueryMap, options: IndexOptions): Promise<{
+        count: number;
+        items: T[];
+        lastEvaluatedKey?: string;
+    }>;
+    _indexAll(query: QueryMap, options: IndexAllOptions): Promise<{
+        count: number;
+        items: T[];
+    }>;
+    _read(query: QueryMap, options: unknown): Promise<T>;
+    _create(attributes: T): Promise<void>;
+    _update<T>(query: QueryMap, mutation: MutationMap): Promise<T>;
+    _delete(query: QueryMap): Promise<void>;
+};
+/** Abstract document class. */
+declare class Document<Attributes> extends Component<Attributes> {
+    private static _bodySchema;
+    private _previousAttributes;
+    /** Returns partition key of a document. */
+    static get partitionKey(): string;
+    /** Returns prefix for new IDs. */
+    static get idPrefix(): string;
+    /** Returns attribute name to sort index action results by. */
+    static get indexSortBy(): string;
+    /** Defines default sort direction for index action results. */
+    static get indexDefaultSort(): 'asc' | 'desc';
+    /** Defines default limit for index action. */
+    static get indexDefaultLimit(): number;
+    /** Generates ID for new document unless it's defined in parameters. */
+    static createId(attributes: Record<string, unknown>): string;
+    /** Returns default attributes schema source. */
+    static get defaultAttributesSchemaSource(): PropertiesSchemaSource;
+    /** Extends document schema with default attributes. */
+    static set schema(schema: Schema);
+    /** Returns schema to validate document attributes. */
+    static get schema(): Schema;
+    /** Returns body schema of a document. */
+    static get bodySchema(): Schema;
+    /** Returns schema for document create and update mutations. */
+    static get mutationSchema(): Schema;
+    /** Returns partition to save document based on context and parameters. */
+    static getPartition(_context: Context, _parameters: Record<string, unknown>): string | undefined;
+    /** Extends parameters with partition of a document. */
+    static _extendWithPartition(context: Context, parameters: Record<string, unknown>): void;
+    /** Extends mutation with created stamps. */
+    static _extendWithCreatedStamps(context: Context, mutation: MutationMap): void;
+    /** Extends mutation with updated stamps. */
+    static _extendWithUpdatedStamps(context: Context, mutation: MutationMap): void;
+    /** Returns documents in batches. */
+    static index<T, D extends Document<T> = Document<T>>(this: Constructor<T, D>, context: Context, query?: QueryMap, options?: IndexOptions): Promise<{
+        count: number;
+        objects: D[];
+        lastEvaluatedKey?: string;
+    }>;
+    /** Returns all documents. */
+    static indexAll<T, D extends Document<T> = Document<T>>(this: Constructor<T, D>, context: Context, query?: QueryMap, options?: IndexAllOptions): Promise<{
+        count: number;
+        objects: D[];
+    }>;
+    /** Returns a document by ID attribute. */
+    static read<T, D extends Document<T> = Document<T>>(this: Constructor<T, D>, context: Context, query: QueryMap, options?: unknown): Promise<D>;
+    /** Creates a document. */
+    static create<T, D extends Document<T> = Document<T>>(this: Constructor<T, D>, context: Context, query: QueryMap | MutationMap, mutation?: MutationMap): Promise<D>;
+    /** Before create hook. */
+    static beforeCreate(_context: Context, _query: QueryMap, _mutation: MutationMap): Promise<void>;
+    /** After create hook. */
+    static afterCreate(_context: Context, _query: QueryMap, _mutation: MutationMap, _createdDocument: unknown): Promise<void>;
+    /** Updates a document. */
+    static update<T, D extends Document<T> = Document<T>>(this: Constructor<T, D>, context: Context, query: QueryMap, mutation: MutationMap): Promise<D>;
+    /** Before update hook. */
+    static beforeUpdate(_context: Context, _query: QueryMap, _mutation: MutationMap): Promise<void>;
+    /** After update hook. */
+    static afterUpdate(_context: Context, _query: QueryMap, _mutation: MutationMap, _updatedDocument: unknown): Promise<void>;
+    /** Deletes a document. */
+    static delete<T, D extends Document<T> = Document<T>>(this: Constructor<T, D>, context: Context, query: QueryMap): Promise<D>;
+    /** Before delete hook. */
+    static beforeDelete(_context: Context, _query: QueryMap): Promise<void>;
+    /** After delete hook. */
+    static afterDelete(_context: Context, _query: QueryMap, _deletedDocument: unknown): Promise<void>;
+    /** Returns document ID. */
+    get id(): string;
+    /** Returns previous attributes after update action. */
+    get previousAttributes(): NonNullable<Attributes> | null;
+    /** Flags if document attribute has been changed via update action. */
+    hasAttributeChanged(path: string): boolean;
+    /** Updates document attributes. */
+    update(mutation: MutationMap): Promise<void>;
+}
+export default Document;
+//# sourceMappingURL=Document.d.ts.map

package/dist/Document/Document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document.d.ts","sourceRoot":"","sources":["../../src/Document/Document.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,MAAM,EAAE,KAAK,sBAAsB,EAAO,MAAM,eAAe,CAAC;AACzE,OAAO,OAAO,EAAE,EAAE,KAAK,QAAQ,EAAE,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAOtE,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,KAAK,WAAW,CAAC,CAAC,EAAE,CAAC,SAAS,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI;IACzD,KAAI,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC;IAExC,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC;QACtD,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,CAAC,EAAE,CAAC;QACX,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC;QAC5D,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE,CAAC,EAAE,CAAC;KACZ,CAAC,CAAC;IAEH,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAErD,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtC,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAE/D,OAAO,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzC,CAAC;AAEF,+BAA+B;AAC/B,cAAM,QAAQ,CAAC,UAAU,CAAE,SAAQ,SAAS,CAAC,UAAU,CAAC;IACtD,OAAO,CAAC,MAAM,CAAC,WAAW,CAAS;IAEnC,OAAO,CAAC,mBAAmB,CAAyB;IAEpD,2CAA2C;IAC3C,MAAM,KAAK,YAAY,IAAI,MAAM,CAEhC;IAED,kCAAkC;IAClC,MAAM,KAAK,QAAQ,IAAI,MAAM,CAE5B;IAED,8DAA8D;IAC9D,MAAM,KAAK,WAAW,IAAI,MAAM,CAE/B;IAED,+DAA+D;IAC/D,MAAM,KAAK,gBAAgB,IAAI,KAAK,GAAG,MAAM,CAE5C;IAED,8CAA8C;IAC9C,MAAM,KAAK,iBAAiB,IAAI,MAAM,CAErC;IAED,uEAAuE;IACvE,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAW5D,gDAAgD;IAChD,MAAM,KAAK,6BAA6B,IAAI,sBAAsB,CA+BjE;IAED,uDAAuD;IACvD,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,EAG/B;IAED,sDAAsD;IACtD,MAAM,KAAK,MAAM,IAAI,MAAM,CAM1B;IAED,yCAAyC;IACzC,MAAM,KAAK,UAAU,WAEpB;IAED,+DAA+D;IAC/D,MAAM,KAAK,cAAc,IAAI,MAAM,CAElC;IAED,0EAA0E;IAE1E,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,SAAS;IAIhG,uDAAuD;IACvD,MAAM,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAgBxF,4CAA4C;IAC5C,MAAM,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW;IAQvE,4CAA4C;IAC5C,MAAM,CAAC,wBAAwB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW;IAQvE,oCAAoC;WACvB,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACvD,IAAI,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACvB,OAAO,EAAE,OAAO,EAChB,KAAK,GAAE,QAAa,EACpB,OAAO,GAAE,YAAiB,GACzB,OAAO,CAAC;QACT,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,CAAC,EAAE,CAAC;QACb,gBAAgB,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IAkBF,6BAA6B;WAChB,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EAC1D,IAAI,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACvB,OAAO,EAAE,OAAO,EAChB,KAAK,GAAE,QAAa,EACpB,OAAO,GAAE,eAAoB,GAC5B,OAAO,CAAC;QACT,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,CAAC,EAAE,CAAC;KACd,CAAC;IAcF,0CAA0C;WAC7B,IAAI,CAAC,CAAC,EAAE,CAAC,SAAS,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACtD,IAAI,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACvB,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,QAAQ,EACf,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,CAAC,CAAC;IAUb,0BAA0B;WACb,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACxD,IAAI,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACvB,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,QAAQ,GAAG,WAAW,EAC7B,QAAQ,CAAC,EAAE,WAAW,GACrB,OAAO,CAAC,CAAC,CAAC;IAsCb,0BAA0B;WAEb,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrG,yBAAyB;WAEZ,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/H,0BAA0B;WACb,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACxD,IAAI,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACvB,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,QAAQ,EACf,QAAQ,EAAE,WAAW,GACpB,OAAO,CAAC,CAAC,CAAC;IAkCb,0BAA0B;WAEb,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrG,yBAAyB;WAEZ,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAI/H,0BAA0B;WACb,MAAM,CAAC,CAAC,EAAE,CAAC,SAAS,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,EACxD,IAAI,EAAE,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,EACvB,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,QAAQ,GACd,OAAO,CAAC,CAAC,CAAC;IAiBb,0BAA0B;WAEb,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7E,yBAAyB;WAEZ,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvG,2BAA2B;IAC3B,IAAI,EAAE,IAAI,MAAM,CAGf;IAED,uDAAuD;IACvD,IAAI,kBAAkB,mCAErB;IAED,sEAAsE;IACtE,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAa1C,mCAAmC;IAC7B,MAAM,CAAC,QAAQ,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;CAYnD;AAED,eAAe,QAAQ,CAAC"}

package/dist/Document/Document.js

@@ -0,0 +1,285 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ulid_1 = require("ulid");
+const Component_1 = __importDefault(require("../Component"));
+const schema_1 = require("@kravc/schema");
+const lodash_1 = require("lodash");
+const DEFAULT_INDEX_SORT = 'desc';
+const DEFAULT_INDEX_LIMIT = 300;
+const DEFAULT_PARTITION_KEY = 'partition';
+/** Abstract document class. */
+class Document extends Component_1.default {
+    static _bodySchema;
+    _previousAttributes;
+    /** Returns partition key of a document. */
+    static get partitionKey() {
+        return DEFAULT_PARTITION_KEY;
+    }
+    /** Returns prefix for new IDs. */
+    static get idPrefix() {
+        return this.name;
+    }
+    /** Returns attribute name to sort index action results by. */
+    static get indexSortBy() {
+        return this.idKey;
+    }
+    /** Defines default sort direction for index action results. */
+    static get indexDefaultSort() {
+        return DEFAULT_INDEX_SORT;
+    }
+    /** Defines default limit for index action. */
+    static get indexDefaultLimit() {
+        return DEFAULT_INDEX_LIMIT;
+    }
+    /** Generates ID for new document unless it's defined in parameters. */
+    static createId(attributes) {
+        const id = (0, lodash_1.get)(attributes, this.idKey);
+        const hasId = !!id;
+        if (hasId) {
+            return id;
+        }
+        return `${this.idPrefix}_` + (0, ulid_1.ulid)();
+    }
+    /** Returns default attributes schema source. */
+    static get defaultAttributesSchemaSource() {
+        const documentTitle = this.getTitle(false);
+        return {
+            id: {
+                description: (0, lodash_1.capitalize)(documentTitle) + ' ID',
+                required: true
+            },
+            createdAt: {
+                description: `Date and time when ${documentTitle} was created`,
+                format: 'date-time',
+                required: true
+            },
+            createdBy: {
+                description: `ID of a user who created ${documentTitle}`,
+                required: true
+            },
+            createdByUserName: {
+                description: `Name of a user who created ${documentTitle}`
+            },
+            updatedAt: {
+                description: `Date and time when ${documentTitle} was updated`,
+                format: 'date-time'
+            },
+            updatedBy: {
+                description: `ID of a user who updated ${documentTitle}`
+            },
+            updatedByUserName: {
+                description: `Name of a user who updated ${documentTitle}`
+            }
+        };
+    }
+    /** Extends document schema with default attributes. */
+    static set schema(schema) {
+        this._schema = schema.extend(this.defaultAttributesSchemaSource, this.id);
+        this._bodySchema = schema.clone(`${this.id}Body`);
+    }
+    /** Returns schema to validate document attributes. */
+    static get schema() {
+        if (!this._schema) {
+            throw new Error(`Schema is not set for "${this.id}"`);
+        }
+        return this._schema;
+    }
+    /** Returns body schema of a document. */
+    static get bodySchema() {
+        return this._bodySchema;
+    }
+    /** Returns schema for document create and update mutations. */
+    static get mutationSchema() {
+        return this.bodySchema;
+    }
+    /** Returns partition to save document based on context and parameters. */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    static getPartition(_context, _parameters) {
+        return undefined;
+    }
+    /** Extends parameters with partition of a document. */
+    static _extendWithPartition(context, parameters) {
+        const hasPartition = !!(0, lodash_1.get)(parameters, this.partitionKey);
+        if (hasPartition) {
+            return;
+        }
+        const partition = this.getPartition(context, parameters);
+        if (!partition) {
+            return;
+        }
+        (0, lodash_1.set)(parameters, this.partitionKey, partition);
+    }
+    /** Extends mutation with created stamps. */
+    static _extendWithCreatedStamps(context, mutation) {
+        const timestamp = new Date().toJSON();
+        mutation.createdAt = timestamp;
+        mutation.createdBy = context.identityId;
+        mutation.createdByUserName = context.identityName;
+    }
+    /** Extends mutation with updated stamps. */
+    static _extendWithUpdatedStamps(context, mutation) {
+        const timestamp = new Date().toJSON();
+        mutation.updatedAt = timestamp;
+        mutation.updatedBy = context.identityId;
+        mutation.updatedByUserName = context.identityName;
+    }
+    /** Returns documents in batches. */
+    static async index(context, query = {}, options = {}) {
+        const _this = this;
+        _this._extendWithPartition(context, query);
+        if (!options.limit) {
+            options.limit = _this.indexDefaultLimit;
+        }
+        if (!options.sort) {
+            options.sort = _this.indexDefaultSort;
+        }
+        const { items, count, lastEvaluatedKey, ...otherPagination } = await this._index(query, options);
+        const objects = items.map(attributes => new this(context, attributes));
+        return { objects, count, lastEvaluatedKey, ...otherPagination };
+    }
+    /** Returns all documents. */
+    static async indexAll(context, query = {}, options = {}) {
+        const _this = this;
+        _this._extendWithPartition(context, query);
+        if (!options.sort) {
+            options.sort = _this.indexDefaultSort;
+        }
+        const { items, count } = await this._indexAll(query, options);
+        const objects = items.map(attributes => new this(context, attributes));
+        return { objects, count };
+    }
+    /** Returns a document by ID attribute. */
+    static async read(context, query, options) {
+        const _this = this;
+        _this._extendWithPartition(context, query);
+        const attributes = await this._read(query, options);
+        const object = new this(context, attributes);
+        return object;
+    }
+    /** Creates a document. */
+    static async create(context, query, mutation) {
+        const _this = this;
+        // NOTE: This allows implementing the create-unless-exists flow, which first
+        //       checks existence of the document via before hooks. If it does
+        //       exist, they add it to the context. Then the operation's action
+        //       method would do nothing and just return the document from the context.
+        const createdDocument = context.get('createdDocument');
+        const shouldNotCreate = createdDocument?.componentId === this.name;
+        if (shouldNotCreate) {
+            return createdDocument;
+        }
+        if (!mutation) {
+            mutation = query;
+            query = {};
+        }
+        const { validator } = context;
+        const attributes = validator.normalize(mutation, _this.id);
+        const idValue = _this.createId(attributes);
+        (0, lodash_1.set)(attributes, _this.idKey, idValue);
+        _this._extendWithCreatedStamps(context, attributes);
+        _this._extendWithPartition(context, attributes);
+        await _this.beforeCreate(context, query, attributes);
+        await this._create(attributes);
+        const object = new this(context, attributes);
+        await _this.afterCreate(context, query, mutation, object);
+        return object;
+    }
+    /** Before create hook. */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    static async beforeCreate(_context, _query, _mutation) {
+        return;
+    }
+    /** After create hook. */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    static async afterCreate(_context, _query, _mutation, _createdDocument) {
+        return;
+    }
+    /** Updates a document. */
+    static async update(context, query, mutation) {
+        const _this = this;
+        mutation = (0, lodash_1.omit)(mutation, Object.keys(_this.defaultAttributesSchemaSource));
+        _this._extendWithUpdatedStamps(context, mutation);
+        _this._extendWithPartition(context, query);
+        await _this.beforeUpdate(context, query, mutation);
+        /* NOTE: In some workflows operation before action helper may be doing
+                 some verifications with the document to be updated. Here we
+                 allow to cache it in the context. */
+        const idValue = (0, schema_1.got)(query, _this.idKey, 'Query parameter "$PATH" is required');
+        const previousDocument = context.get(idValue);
+        let previousAttributes = previousDocument?.attributes;
+        /* NOTE: Ensure that document to be updated exists and save it in the
+                 context so can be referenced in the after action helper. */
+        if (!previousAttributes) {
+            previousAttributes = await this._read(query, {});
+        }
+        const updatedAttributes = await this._update(query, mutation);
+        const object = new this(context, updatedAttributes);
+        object._previousAttributes = previousAttributes;
+        await _this.afterUpdate(context, query, mutation, object);
+        return object;
+    }
+    /** Before update hook. */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    static async beforeUpdate(_context, _query, _mutation) {
+        return;
+    }
+    /** After update hook. */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    static async afterUpdate(_context, _query, _mutation, _updatedDocument) {
+        return;
+    }
+    /** Deletes a document. */
+    static async delete(context, query) {
+        const _this = this;
+        _this._extendWithPartition(context, query);
+        await _this.beforeDelete(context, query);
+        const attributes = await this._read(query, {});
+        const object = new this(context, attributes);
+        await this._delete(query);
+        await _this.afterDelete(context, query, object);
+        return object;
+    }
+    /** Before delete hook. */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    static async beforeDelete(_context, _query) {
+        return;
+    }
+    /** After delete hook. */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    static async afterDelete(_context, _query, _deletedDocument) {
+        return;
+    }
+    /** Returns document ID. */
+    get id() {
+        const klass = this.constructor;
+        return (0, schema_1.got)(this.attributes, klass.idKey);
+    }
+    /** Returns previous attributes after update action. */
+    get previousAttributes() {
+        return this._previousAttributes || null;
+    }
+    /** Flags if document attribute has been changed via update action. */
+    hasAttributeChanged(path) {
+        if (!this.previousAttributes) {
+            throw Error(`${this.componentId} ${this.id} has not been updated`);
+        }
+        const currentValue = (0, lodash_1.get)(this.attributes, path);
+        const previousValue = (0, lodash_1.get)(this.previousAttributes, path);
+        const hasChanged = previousValue !== currentValue;
+        return hasChanged;
+    }
+    /** Updates document attributes. */
+    async update(mutation) {
+        const klass = this.constructor;
+        this.context.set(this.id, this);
+        const query = (0, lodash_1.pick)(this.attributes, [klass.idKey, klass.partitionKey]);
+        const object = await klass.update(this.context, query, mutation);
+        this._previousAttributes = (0, lodash_1.cloneDeep)(this.attributes);
+        (0, lodash_1.set)(this, '_attributes', object.attributes);
+    }
+}
+exports.default = Document;
+//# sourceMappingURL=Document.js.map