@kravc/dos-dynamodb 1.0.0-alpha.0

package/README.md

@@ -0,0 +1,30 @@
+# @kravc/dos-dynamodb
+
+DynamoDB-backed CRUD layer for [@kravc/dos](https://github.com/alexkravets/dos). Exposes **Document** and **DocumentWithHashId** classes that plug into the dos service: define a schema and partition/sort keys, then use `create`, `get`, `update`, `delete`, and `index` (with GSI/LSI support) against a DynamoDB table.
+
+**Examples** (see `example/`):
+
+- **Asset** — `Document` with status filtering, archive/unarchive, and index queries (LSI/GSI).
+- **Activity** — `Document` usage with activity-specific attributes and indexing.
+- **Organization** — `DocumentWithHashId` with a fixed partition, list/disable/enable and `indexAll`.
+
+Install:
+
+```sh
+npm i --save @kravc/dos-dynamodb
+```
+
+List supported DynamoDB table commands:
+
+```sh
+npx table
+```
+
+## License
+
+ISC
+
+---
+
+Revision: February 21, 2026<br/>
+By: Oleksandr Kravets (@alexkravets)

package/bin/table.js

@@ -0,0 +1,88 @@
+#!/usr/bin/env node
+
+'use strict';
+
+import Table from '../dist/src/Table';
+import { exec } from 'child_process';
+
+const command = process.argv[2];
+const isInvalidCommand = ![ 'up', 'create', 'delete', 'reset' ].includes(command);
+
+if (isInvalidCommand) {
+  console.info('table [create|delete|reset] [ENV=dev|stg|prd]\n');
+  console.info('Commands:');
+  console.info('  create     Create tables defined in configuration');
+  console.info('  delete     Delete tables defined in "/config/default.yaml"');
+  console.info('  reset      Reset tables defined in "/config/default.yaml"');
+  console.info('\nDefault configuration file: "/config/default.yaml".');
+
+  process.exit(1);
+}
+
+const env = process.argv[3];
+
+if (env) {
+  process.env.NODE_ENV = 'serverless';
+  process.env.NODE_APP_INSTANCE = env;
+}
+
+/** Runs an action for a table. */
+const _action = async (methodName) => {
+  const table = new Table({
+    sortKey: 'id',
+    partitionKey: 'partition',
+  });
+
+  const { name: tableName } = table.config;
+
+  try {
+    await table[methodName]();
+    console.info(`Table "${tableName}" ${methodName}d`);
+
+  } catch (dynamoError) {
+    const { name: errorName } = dynamoError;
+
+    if (errorName === 'ResourceInUseException') {
+      console.info(`Table "${tableName}" skipped`);
+
+    } else if (errorName === 'ResourceNotFoundException') {
+      console.info(`Table "${tableName}" not found`);
+
+    } else {
+      console.error(dynamoError);
+      process.exit(1);
+
+    }
+  }
+};
+
+/** Creates a table. */
+const _create = () => _action('create');
+
+/** Deletes a table. */
+const _delete = () => _action('delete');
+
+/** Resets a table. */
+const _reset = async () => {
+  await _delete();
+  await _create();
+};
+
+/** Starts dynamodb in the Docker and runs a command. */
+const run = async callback => {
+  if (env) {
+    return callback();
+  }
+
+  const command = exec('docker compose -f node_modules/@kravc/table/docker-compose.yaml up -d', callback);
+  command.stdout.on('data', data => console.log(data));
+  command.stderr.on('data', data => console.error(data));
+};
+
+const COMMANDS = {
+  reset: _reset,
+  create: _create,
+  delete: _delete,
+};
+
+run(() => COMMANDS[command]());

package/config/default.yaml

@@ -0,0 +1,36 @@
+dynamodb:
+  indexKeys:
+    lsi1:
+      documentName: 'Organization'
+      sk: '#createdAt'
+
+    lsi2:
+      documentName: 'Asset'
+      sk: '#status#createdAt'
+
+    lsi3:
+      documentName: 'Activity'
+      sk: '#createdAt'
+
+    gsi1:
+      Activity:
+        pk: '#partition#userId'
+        sk: '#createdAt'
+
+      Asset:
+        pk: '#partition#createdBy'
+        sk: '#status#createdAt'
+
+      Organization:
+        pk: 'PLATFORM'
+        sk: '#status#createdAt'
+
+    gsi2:
+      Activity:
+        pk: '#partition#operationId'
+        sk: '#createdAt'
+
+idPrefixes:
+  Asset: 'AST'
+  Activity: 'ACT'
+  Organization: 'O'

package/dist/example/Activity.d.ts

@@ -0,0 +1,34 @@
+import { Document } from '../src';
+import { type ActivityAttributes } from './ActivityAttributes';
+import { type Context, type IndexOptions } from '@kravc/dos';
+/** Activity document class. */
+declare class Activity extends Document<ActivityAttributes> {
+    /** Returns index query and index name for parameters. */
+    static _getIndexQueryProps(context: Context, query: {
+        userId?: string;
+        endDate?: string;
+        startDate?: string;
+        operationId?: string;
+        [x: string]: unknown;
+    }): {
+        indexName: string;
+        indexQuery: {
+            [x: string]: unknown;
+        };
+    };
+    /** Returns activities. */
+    static indexWithDateRange(context: Context, query?: {
+        userId?: string;
+        endDate?: string;
+        startDate?: string;
+        operationId?: string;
+        [x: string]: unknown;
+    }, options?: IndexOptions): Promise<{
+        limit: number;
+        count: number;
+        objects: Activity[];
+        lastEvaluatedKey?: string;
+    }>;
+}
+export default Activity;
+//# sourceMappingURL=Activity.d.ts.map

package/dist/example/Activity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Activity.d.ts","sourceRoot":"","sources":["../../example/Activity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAqB,MAAM,QAAQ,CAAC;AACrD,OAAO,EAAU,KAAK,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AACvE,OAAO,EAAO,KAAK,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAElE,+BAA+B;AAC/B,cAAM,QAAS,SAAQ,QAAQ,CAAC,kBAAkB,CAAC;IACjD,yDAAyD;IACzD,MAAM,CAAC,mBAAmB,CACxB,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE;QACL,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB;;;;;;IAiEH,0BAA0B;WACb,kBAAkB,CAC7B,OAAO,EAAE,OAAO,EAChB,KAAK,GAAE;QACL,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACjB,EACN,OAAO,GAAE,YAAiB;;;;;;CA4B7B;AAID,eAAe,QAAQ,CAAC"}

package/dist/example/Activity.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const src_1 = require("../src");
+const ActivityAttributes_1 = require("./ActivityAttributes");
+const dos_1 = require("@kravc/dos");
+/** Activity document class. */
+class Activity extends src_1.Document {
+    /** Returns index query and index name for parameters. */
+    static _getIndexQueryProps(context, query) {
+        const { userId, endDate, startDate, operationId, ...filterQuery } = query;
+        /** Returns query for a global secondary index. */
+        const getGlobalIndexQuery = (indexName, partitionScope) => {
+            const { sortKeyName, partitionKeyName, } = this.getGlobalIndexProps(indexName);
+            const indexQuery = {};
+            const organizationId = (0, dos_1.got)(context.identity, 'organizationId');
+            indexQuery[partitionKeyName] = `${organizationId}#${partitionScope}`;
+            if (startDate) {
+                indexQuery[`${sortKeyName}:${src_1.SortExpressionKey.GE}`] = `#${startDate}T00:00:00.000Z`;
+            }
+            if (endDate) {
+                indexQuery[`${sortKeyName}:${src_1.SortExpressionKey.LE}`] = `#${endDate}T23:59:99.999Z`;
+            }
+            return indexQuery;
+        };
+        if (userId) {
+            const indexName = 'gsi1';
+            const indexQuery = getGlobalIndexQuery(indexName, userId);
+            return { indexName, indexQuery: { ...indexQuery, ...filterQuery } };
+        }
+        if (operationId) {
+            const indexName = 'gsi2';
+            const indexQuery = getGlobalIndexQuery(indexName, operationId);
+            return { indexName, indexQuery: { ...indexQuery, ...filterQuery } };
+        }
+        const { indexName, sortKeyName } = this.getLocalIndexProps('lsi3');
+        const indexQuery = {};
+        if (startDate) {
+            indexQuery[`${sortKeyName}:${src_1.SortExpressionKey.GE}`] = `#${startDate}T00:00:00.000Z`;
+        }
+        if (endDate) {
+            indexQuery[`${sortKeyName}:${src_1.SortExpressionKey.LE}`] = `#${endDate}T23:59:99.999Z`;
+        }
+        return { indexName, indexQuery: { ...indexQuery, ...filterQuery } };
+    }
+    /** Returns activities. */
+    static async indexWithDateRange(context, query = {}, options = {}) {
+        const { userId, endDate, startDate, operationId, } = query;
+        if (userId) {
+            const { indexQuery, indexName } = this._getIndexQueryProps(context, query);
+            return this.index(context, indexQuery, { ...options, indexName });
+        }
+        if (operationId) {
+            const { indexQuery, indexName } = this._getIndexQueryProps(context, query);
+            return this.index(context, indexQuery, { ...options, indexName });
+        }
+        const hasDateRange = !!startDate || !!endDate;
+        if (hasDateRange) {
+            const { indexQuery, indexName } = this._getIndexQueryProps(context, query);
+            return this.index(context, indexQuery, { ...options, indexName });
+        }
+        return this.index(context, query, options);
+    }
+}
+Activity.schema = ActivityAttributes_1.schema;
+exports.default = Activity;
+//# sourceMappingURL=Activity.js.map

package/dist/example/Activity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Activity.js","sourceRoot":"","sources":["../../example/Activity.ts"],"names":[],"mappings":";;AAAA,gCAAqD;AACrD,6DAAuE;AACvE,oCAAkE;AAElE,+BAA+B;AAC/B,MAAM,QAAS,SAAQ,cAA4B;IACjD,yDAAyD;IACzD,MAAM,CAAC,mBAAmB,CACxB,OAAgB,EAChB,KAMC;QAED,MAAM,EACJ,MAAM,EACN,OAAO,EACP,SAAS,EACT,WAAW,EACX,GAAG,WAAW,EACf,GAAG,KAAK,CAAC;QAEV,kDAAkD;QAClD,MAAM,mBAAmB,GAAG,CAAC,SAAiB,EAAE,cAAsB,EAAE,EAAE;YACxE,MAAM,EACJ,WAAW,EACX,gBAAgB,GACjB,GAAG,IAAI,CAAC,mBAAmB,CAAC,SAAS,CAAC,CAAC;YAExC,MAAM,UAAU,GAAG,EAA4B,CAAC;YAEhD,MAAM,cAAc,GAAG,IAAA,SAAG,EAAC,OAAO,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;YAC/D,UAAU,CAAC,gBAAgB,CAAC,GAAG,GAAG,cAAc,IAAI,cAAc,EAAE,CAAC;YAErE,IAAI,SAAS,EAAE,CAAC;gBACd,UAAU,CAAC,GAAG,WAAW,IAAI,uBAAiB,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,SAAS,gBAAgB,CAAC;YACvF,CAAC;YAED,IAAI,OAAO,EAAE,CAAC;gBACZ,UAAU,CAAC,GAAG,WAAW,IAAI,uBAAiB,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,OAAO,gBAAgB,CAAC;YACrF,CAAC;YAED,OAAO,UAAU,CAAC;QACpB,CAAC,CAAC;QAEF,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,SAAS,GAAG,MAAM,CAAC;YACzB,MAAM,UAAU,GAAG,mBAAmB,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YAE1D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,WAAW,EAAE,EAAE,CAAC;QACtE,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,SAAS,GAAG,MAAM,CAAC;YACzB,MAAM,UAAU,GAAG,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAE/D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,WAAW,EAAE,EAAE,CAAC;QACtE,CAAC;QAED,MAAM,EACJ,SAAS,EACT,WAAW,EACZ,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAEpC,MAAM,UAAU,GAAG,EAA4B,CAAC;QAEhD,IAAI,SAAS,EAAE,CAAC;YACd,UAAU,CAAC,GAAG,WAAW,IAAI,uBAAiB,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,SAAS,gBAAgB,CAAC;QACvF,CAAC;QAED,IAAI,OAAO,EAAE,CAAC;YACZ,UAAU,CAAC,GAAG,WAAW,IAAI,uBAAiB,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,OAAO,gBAAgB,CAAC;QACrF,CAAC;QAED,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,WAAW,EAAE,EAAE,CAAC;IACtE,CAAC;IAED,0BAA0B;IAC1B,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAC7B,OAAgB,EAChB,QAMI,EAAE,EACN,UAAwB,EAAE;QAE1B,MAAM,EACJ,MAAM,EACN,OAAO,EACP,SAAS,EACT,WAAW,GACZ,GAAG,KAAK,CAAC;QAEV,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC3E,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC3E,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,YAAY,GAAG,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,OAAO,CAAC;QAE9C,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAC3E,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QACpE,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;CACF;AAED,QAAQ,CAAC,MAAM,GAAG,2BAAM,CAAC;AAEzB,kBAAe,QAAQ,CAAC"}

package/dist/example/ActivityAttributes.d.ts

@@ -0,0 +1,23 @@
+import { Schema } from '@kravc/schema';
+import { DefaultAttributes } from '../src';
+type Identity = {
+    sub: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+    permissions: string[];
+};
+export interface ActivityAttributes extends DefaultAttributes {
+    operationId: string;
+    summaryTemplate: string;
+    parametersJson?: string;
+    resultDocumentJson?: string;
+    userId: string;
+    traceId: string;
+    userAgent: string;
+    ipAddress: string;
+    identity?: Identity;
+}
+export declare const schema: Schema;
+export {};
+//# sourceMappingURL=ActivityAttributes.d.ts.map

package/dist/example/ActivityAttributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActivityAttributes.d.ts","sourceRoot":"","sources":["../../example/ActivityAttributes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAE3C,KAAK,QAAQ,GAAG;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB,CAAA;AAED,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,QAAQ,CAAA;CACpB;AAED,eAAO,MAAM,MAAM,QAgDD,CAAC"}

package/dist/example/ActivityAttributes.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schema = void 0;
+const schema_1 = require("@kravc/schema");
+exports.schema = new schema_1.Schema({
+    operationId: {
+        required: true
+    },
+    summaryTemplate: {
+        required: true
+    },
+    parametersJson: {
+        type: 'string',
+    },
+    resultDocumentJson: {
+        type: 'string',
+    },
+    userId: {
+        required: true
+    },
+    traceId: {
+        required: true
+    },
+    userAgent: {
+        required: true
+    },
+    ipAddress: {
+        required: true
+    },
+    identity: {
+        type: 'object',
+        properties: {
+            sub: {
+                required: true
+            },
+            email: {
+                required: true
+            },
+            firstName: {
+                required: true
+            },
+            lastName: {
+                required: true
+            },
+            permissions: {
+                required: true,
+                items: {
+                    type: 'string'
+                },
+            }
+        }
+    }
+}, 'ActivityBody');
+//# sourceMappingURL=ActivityAttributes.js.map

package/dist/example/ActivityAttributes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ActivityAttributes.js","sourceRoot":"","sources":["../../example/ActivityAttributes.ts"],"names":[],"mappings":";;;AAAA,0CAAuC;AAuB1B,QAAA,MAAM,GAAG,IAAI,eAAM,CAAC;IAC/B,WAAW,EAAE;QACX,QAAQ,EAAE,IAAI;KACf;IACD,eAAe,EAAE;QACf,QAAQ,EAAE,IAAI;KACf;IACD,cAAc,EAAE;QACd,IAAI,EAAE,QAAQ;KACf;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,QAAQ;KACf;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,QAAQ,EAAE,IAAI;KACf;IACD,SAAS,EAAE;QACT,QAAQ,EAAE,IAAI;KACf;IACD,SAAS,EAAE;QACT,QAAQ,EAAE,IAAI;KACf;IACD,QAAQ,EAAE;QACR,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,GAAG,EAAE;gBACH,QAAQ,EAAE,IAAI;aACf;YACD,KAAK,EAAE;gBACL,QAAQ,EAAE,IAAI;aACf;YACD,SAAS,EAAE;gBACT,QAAQ,EAAE,IAAI;aACf;YACD,QAAQ,EAAE;gBACR,QAAQ,EAAE,IAAI;aACf;YACD,WAAW,EAAE;gBACX,QAAQ,EAAE,IAAI;gBACd,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;iBACf;aACF;SACF;KACF;CACF,EAAE,cAAc,CAAC,CAAC"}

package/dist/example/Asset.d.ts

@@ -0,0 +1,36 @@
+import { type AssetAttributes, AssetStatus } from './AssetAttributes';
+import { Document } from '../src';
+import { type Context, type QueryMap, type IndexOptions } from '@kravc/dos';
+/** Asset document class. */
+declare class Asset extends Document<AssetAttributes> {
+    /** Returns props for an index query. */
+    static _getIndexQueryProps(context: Context, query: {
+        createdBy?: string;
+        [x: string]: unknown;
+    }, status: AssetStatus): {
+        indexQuery: {
+            [x: string]: unknown;
+        };
+        indexName: string;
+    };
+    /** Returns active assets. */
+    static indexActiveAssets(context: Context, query?: QueryMap, options?: IndexOptions): Promise<{
+        limit: number;
+        count: number;
+        objects: Asset[];
+        lastEvaluatedKey?: string;
+    }>;
+    /** Returns archived assets. */
+    static indexArchivedAssets(context: Context, query?: QueryMap, options?: IndexOptions): Promise<{
+        limit: number;
+        count: number;
+        objects: Asset[];
+        lastEvaluatedKey?: string;
+    }>;
+    /** Archives an asset. */
+    static archive(context: Context, query: QueryMap): Promise<Asset>;
+    /** Unarchives the asset. */
+    static unarchive(context: Context, query: QueryMap): Promise<Asset>;
+}
+export default Asset;
+//# sourceMappingURL=Asset.d.ts.map

package/dist/example/Asset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Asset.d.ts","sourceRoot":"","sources":["../../example/Asset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,eAAe,EAAE,WAAW,EAAU,MAAM,mBAAmB,CAAC;AAC9E,OAAO,EAAE,QAAQ,EAAoC,MAAM,QAAQ,CAAC;AACpE,OAAO,EAAO,KAAK,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAEjF,4BAA4B;AAC5B,cAAM,KAAM,SAAQ,QAAQ,CAAC,eAAe,CAAC;IAC3C,wCAAwC;IACxC,MAAM,CAAC,mBAAmB,CACxB,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE;QACL,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB,EACD,MAAM,EAAE,WAAW;;;;;;IA2BrB,6BAA6B;WAChB,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,GAAE,QAAa,EAAE,OAAO,GAAE,YAAiB;;;;;;IAKjG,+BAA+B;WAClB,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,GAAE,QAAa,EAAE,OAAO,GAAE,YAAiB;;;;;;IAKnG,yBAAyB;WACZ,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ;IAUtD,4BAA4B;WACf,SAAS,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ;CASzD;AAID,eAAe,KAAK,CAAC"}

package/dist/example/Asset.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const AssetAttributes_1 = require("./AssetAttributes");
+const src_1 = require("../src");
+const dos_1 = require("@kravc/dos");
+/** Asset document class. */
+class Asset extends src_1.Document {
+    /** Returns props for an index query. */
+    static _getIndexQueryProps(context, query, status) {
+        const indexQuery = {};
+        let indexName = 'lsi2';
+        let sortKeyName = this.getLocalIndexSortKeyName(indexName);
+        const { createdBy, ...filterQuery } = query;
+        if (createdBy) {
+            indexName = 'gsi1';
+            sortKeyName = this.getGlobalIndexSortKeyName(indexName);
+            const organizationId = (0, dos_1.got)(context.identity, 'organizationId');
+            const partitionKeyName = this.getGlobalIndexPartitionKeyName(indexName);
+            indexQuery[partitionKeyName] = `${organizationId}#${createdBy}`;
+        }
+        indexQuery[`${sortKeyName}:${src_1.SortExpressionKey.BW}`] = `#${status}`;
+        return {
+            indexQuery: { ...indexQuery, ...filterQuery },
+            indexName,
+        };
+    }
+    /** Returns active assets. */
+    static async indexActiveAssets(context, query = {}, options = {}) {
+        const { indexQuery, indexName } = this._getIndexQueryProps(context, query, AssetAttributes_1.AssetStatus.ACTIVE);
+        return this.index(context, indexQuery, { ...options, indexName });
+    }
+    /** Returns archived assets. */
+    static async indexArchivedAssets(context, query = {}, options = {}) {
+        const { indexQuery, indexName } = this._getIndexQueryProps(context, query, AssetAttributes_1.AssetStatus.ARCHIVED);
+        return this.index(context, indexQuery, { ...options, indexName });
+    }
+    /** Archives an asset. */
+    static async archive(context, query) {
+        query[`status:${src_1.ExpressionKey.NOT}`] = AssetAttributes_1.AssetStatus.ARCHIVED;
+        const mutation = {
+            status: AssetAttributes_1.AssetStatus.ARCHIVED,
+        };
+        return this.update(context, query, mutation);
+    }
+    /** Unarchives the asset. */
+    static async unarchive(context, query) {
+        query[`status:${src_1.ExpressionKey.NOT}`] = AssetAttributes_1.AssetStatus.ACTIVE;
+        const mutation = {
+            status: AssetAttributes_1.AssetStatus.ACTIVE,
+        };
+        return this.update(context, query, mutation);
+    }
+}
+Asset.schema = AssetAttributes_1.schema;
+exports.default = Asset;
+//# sourceMappingURL=Asset.js.map

package/dist/example/Asset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Asset.js","sourceRoot":"","sources":["../../example/Asset.ts"],"names":[],"mappings":";;AAAA,uDAA8E;AAC9E,gCAAoE;AACpE,oCAAiF;AAEjF,4BAA4B;AAC5B,MAAM,KAAM,SAAQ,cAAyB;IAC3C,wCAAwC;IACxC,MAAM,CAAC,mBAAmB,CACxB,OAAgB,EAChB,KAGC,EACD,MAAmB;QAEnB,MAAM,UAAU,GAAG,EAA4B,CAAC;QAEhD,IAAI,SAAS,GAAG,MAAM,CAAC;QACvB,IAAI,WAAW,GAAG,IAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;QAE3D,MAAM,EAAE,SAAS,EAAE,GAAG,WAAW,EAAE,GAAG,KAAK,CAAC;QAE5C,IAAI,SAAS,EAAE,CAAC;YACd,SAAS,GAAG,MAAM,CAAC;YACnB,WAAW,GAAG,IAAI,CAAC,yBAAyB,CAAC,SAAS,CAAC,CAAC;YAExD,MAAM,cAAc,GAAG,IAAA,SAAG,EAAC,OAAO,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;YAC/D,MAAM,gBAAgB,GAAG,IAAI,CAAC,8BAA8B,CAAC,SAAS,CAAC,CAAC;YAExE,UAAU,CAAC,gBAAgB,CAAC,GAAG,GAAG,cAAc,IAAI,SAAS,EAAE,CAAC;QAClE,CAAC;QAED,UAAU,CAAC,GAAG,WAAW,IAAI,uBAAiB,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,MAAM,EAAE,CAAC;QAEpE,OAAO;YACL,UAAU,EAAE,EAAE,GAAG,UAAU,EAAE,GAAG,WAAW,EAAE;YAC7C,SAAS;SACV,CAAC;IACJ,CAAC;IAED,6BAA6B;IAC7B,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,OAAgB,EAAE,QAAkB,EAAE,EAAE,UAAwB,EAAE;QAC/F,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,EAAE,6BAAW,CAAC,MAAM,CAAC,CAAC;QAC/F,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,+BAA+B;IAC/B,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,OAAgB,EAAE,QAAkB,EAAE,EAAE,UAAwB,EAAE;QACjG,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,KAAK,EAAE,6BAAW,CAAC,QAAQ,CAAC,CAAC;QACjG,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;IACpE,CAAC;IAED,yBAAyB;IACzB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,OAAgB,EAAE,KAAe;QACpD,KAAK,CAAC,UAAU,mBAAa,CAAC,GAAG,EAAE,CAAC,GAAG,6BAAW,CAAC,QAAQ,CAAC;QAE5D,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,6BAAW,CAAC,QAAQ;SAC7B,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,4BAA4B;IAC5B,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,OAAgB,EAAE,KAAe;QACtD,KAAK,CAAC,UAAU,mBAAa,CAAC,GAAG,EAAE,CAAC,GAAG,6BAAW,CAAC,MAAM,CAAC;QAE1D,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,6BAAW,CAAC,MAAM;SAC3B,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;CACF;AAED,KAAK,CAAC,MAAM,GAAG,wBAAM,CAAC;AAEtB,kBAAe,KAAK,CAAC"}

package/dist/example/AssetAttributes.d.ts

@@ -0,0 +1,28 @@
+import { Schema } from '@kravc/schema';
+import { DefaultAttributes } from '../src';
+export declare enum AssetType {
+    FILE = "FILE",
+    CONTENT = "CONTENT"
+}
+export declare enum AssetStatus {
+    ACTIVE = "ACTIVE",
+    ARCHIVED = "ARCHIVED"
+}
+export interface AssetAttributes extends DefaultAttributes {
+    name: string;
+    tags: string[];
+    folderId?: string;
+    type: AssetType;
+    status: AssetStatus;
+    content?: string;
+    file?: {
+        url: string;
+        size: number;
+        name: string;
+        mimeType: string;
+        lastModifiedAt: string;
+        thumbnailUrl?: string;
+    };
+}
+export declare const schema: Schema;
+//# sourceMappingURL=AssetAttributes.d.ts.map

package/dist/example/AssetAttributes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetAttributes.d.ts","sourceRoot":"","sources":["../../example/AssetAttributes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC;AAE3C,oBAAY,SAAS;IACnB,IAAI,SAAS;IACb,OAAO,YAAY;CACpB;AAED,oBAAY,WAAW;IACrB,MAAM,WAAW;IACjB,QAAQ,aAAa;CACtB;AAED,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,WAAW,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE;QACL,GAAG,EAAE,MAAM,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,EAAE,MAAM,CAAC;QACvB,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAA;CACF;AAED,eAAO,MAAM,MAAM,QAwDJ,CAAC"}

package/dist/example/AssetAttributes.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.schema = exports.AssetStatus = exports.AssetType = void 0;
+const schema_1 = require("@kravc/schema");
+var AssetType;
+(function (AssetType) {
+    AssetType["FILE"] = "FILE";
+    AssetType["CONTENT"] = "CONTENT";
+})(AssetType || (exports.AssetType = AssetType = {}));
+var AssetStatus;
+(function (AssetStatus) {
+    AssetStatus["ACTIVE"] = "ACTIVE";
+    AssetStatus["ARCHIVED"] = "ARCHIVED";
+})(AssetStatus || (exports.AssetStatus = AssetStatus = {}));
+exports.schema = new schema_1.Schema({
+    name: {
+        required: true
+    },
+    tags: {
+        items: {
+            type: 'string',
+        },
+        required: true
+    },
+    folderId: {
+        type: 'string',
+    },
+    thumbnailUrl: {
+        type: 'string',
+        format: 'url',
+    },
+    type: {
+        enum: [AssetType.FILE, AssetType.CONTENT],
+        required: true,
+    },
+    status: {
+        enum: [AssetStatus.ACTIVE, AssetStatus.ARCHIVED],
+        required: true,
+    },
+    content: {
+        type: 'string'
+    },
+    file: {
+        type: 'object',
+        properties: {
+            url: {
+                type: 'string',
+                format: 'url',
+                required: true,
+            },
+            size: {
+                type: 'integer',
+                min: 0,
+                required: true,
+            },
+            name: {
+                type: 'string',
+                required: true,
+            },
+            mimeType: {
+                type: 'string',
+                required: true,
+            },
+            lastModifiedAt: {
+                type: 'string',
+                format: 'date-time',
+                required: true,
+            },
+        }
+    }
+}, 'AssetBody');
+//# sourceMappingURL=AssetAttributes.js.map

package/dist/example/AssetAttributes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AssetAttributes.js","sourceRoot":"","sources":["../../example/AssetAttributes.ts"],"names":[],"mappings":";;;AAAA,0CAAuC;AAGvC,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,0BAAa,CAAA;IACb,gCAAmB,CAAA;AACrB,CAAC,EAHW,SAAS,yBAAT,SAAS,QAGpB;AAED,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,gCAAiB,CAAA;IACjB,oCAAqB,CAAA;AACvB,CAAC,EAHW,WAAW,2BAAX,WAAW,QAGtB;AAmBY,QAAA,MAAM,GAAG,IAAI,eAAM,CAAC;IAC/B,IAAI,EAAE;QACJ,QAAQ,EAAE,IAAI;KACf;IACD,IAAI,EAAE;QACJ,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;SACf;QACD,QAAQ,EAAE,IAAI;KACf;IACD,QAAQ,EAAE;QACR,IAAI,EAAE,QAAQ;KACf;IACD,YAAY,EAAE;QACZ,IAAI,EAAE,QAAQ;QACd,MAAM,EAAE,KAAK;KACd;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,CAAE,SAAS,CAAC,IAAI,EAAE,SAAS,CAAC,OAAO,CAAE;QAC3C,QAAQ,EAAE,IAAI;KACf;IACD,MAAM,EAAE;QACN,IAAI,EAAE,CAAE,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,QAAQ,CAAE;QAClD,QAAQ,EAAE,IAAI;KACf;IACD,OAAO,EAAE;QACP,IAAI,EAAE,QAAQ;KACf;IACD,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,GAAG,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,KAAK;gBACb,QAAQ,EAAE,IAAI;aACf;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,SAAS;gBACf,GAAG,EAAE,CAAC;gBACN,QAAQ,EAAE,IAAI;aACf;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,IAAI;aACf;YACD,cAAc,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,WAAW;gBACnB,QAAQ,EAAE,IAAI;aACf;SACF;KACF;CACF,EAAE,WAAW,CAAC,CAAC"}

package/dist/example/Organization.d.ts

@@ -0,0 +1,19 @@
+import { DocumentWithHashId } from '../src';
+import { type QueryMap, type Context, type IndexAllOptions } from '@kravc/dos';
+import { type OrganizationAttributes } from './OrganizationAttributes';
+/** Organization document class. */
+declare class Organization extends DocumentWithHashId<OrganizationAttributes> {
+    /** Returns a PLATFORM partition to save a document. */
+    static getPartition(): string;
+    /** Returns active assets. */
+    static listActiveOrganizations(context: Context, query?: QueryMap, options?: IndexAllOptions): Promise<{
+        count: number;
+        objects: Organization[];
+    }>;
+    /** Disables an organization. */
+    static disable(context: Context, query: QueryMap): Promise<Organization>;
+    /** Enables an organization. */
+    static enable(context: Context, query: QueryMap): Promise<Organization>;
+}
+export default Organization;
+//# sourceMappingURL=Organization.d.ts.map

package/dist/example/Organization.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Organization.d.ts","sourceRoot":"","sources":["../../example/Organization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAoC,MAAM,QAAQ,CAAC;AAC9E,OAAO,EAAE,KAAK,QAAQ,EAAE,KAAK,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AAC/E,OAAO,EAA8B,KAAK,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAInG,mCAAmC;AACnC,cAAM,YAAa,SAAQ,kBAAkB,CAAC,sBAAsB,CAAC;IACnE,uDAAuD;IACvD,MAAM,CAAC,YAAY,IAAI,MAAM;IAI7B,6BAA6B;WAChB,uBAAuB,CAClC,OAAO,EAAE,OAAO,EAChB,KAAK,GAAE,QAAa,EACpB,OAAO,GAAE,eAAoB;;;;IAkB/B,gCAAgC;WACnB,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ;IAUtD,+BAA+B;WAClB,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ;CAStD;AAID,eAAe,YAAY,CAAC"}

package/dist/example/Organization.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const src_1 = require("../src");
+const OrganizationAttributes_1 = require("./OrganizationAttributes");
+const PLATFORM_PARTITION = 'PLATFORM';
+/** Organization document class. */
+class Organization extends src_1.DocumentWithHashId {
+    /** Returns a PLATFORM partition to save a document. */
+    static getPartition() {
+        return PLATFORM_PARTITION;
+    }
+    /** Returns active assets. */
+    static async listActiveOrganizations(context, query = {}, options = {}) {
+        const status = OrganizationAttributes_1.OrganizationStatus.ACTIVE;
+        const { indexName, sortKeyName, partitionKeyName, } = this.getGlobalIndexProps('gsi1');
+        const indexQuery = {
+            [partitionKeyName]: PLATFORM_PARTITION,
+            [`${sortKeyName}:${src_1.SortExpressionKey.BW}`]: `#${status}`,
+        };
+        return this.indexAll(context, { ...query, ...indexQuery }, { ...options, indexName });
+    }
+    /** Disables an organization. */
+    static async disable(context, query) {
+        query[`status:${src_1.ExpressionKey.NOT}`] = OrganizationAttributes_1.OrganizationStatus.DISABLED;
+        const mutation = {
+            status: OrganizationAttributes_1.OrganizationStatus.DISABLED,
+        };
+        return this.update(context, query, mutation);
+    }
+    /** Enables an organization. */
+    static async enable(context, query) {
+        query[`status:${src_1.ExpressionKey.NOT}`] = OrganizationAttributes_1.OrganizationStatus.ACTIVE;
+        const mutation = {
+            status: OrganizationAttributes_1.OrganizationStatus.ACTIVE,
+        };
+        return this.update(context, query, mutation);
+    }
+}
+;
+Organization.schema = OrganizationAttributes_1.schema;
+exports.default = Organization;
+//# sourceMappingURL=Organization.js.map

package/dist/example/Organization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Organization.js","sourceRoot":"","sources":["../../example/Organization.ts"],"names":[],"mappings":";;AAAA,gCAA8E;AAE9E,qEAAmG;AAEnG,MAAM,kBAAkB,GAAG,UAAU,CAAC;AAEtC,mCAAmC;AACnC,MAAM,YAAa,SAAQ,wBAA0C;IACnE,uDAAuD;IACvD,MAAM,CAAC,YAAY;QACjB,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,6BAA6B;IAC7B,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAClC,OAAgB,EAChB,QAAkB,EAAE,EACpB,UAA2B,EAAE;QAE7B,MAAM,MAAM,GAAG,2CAAkB,CAAC,MAAM,CAAC;QAEzC,MAAM,EACJ,SAAS,EACT,WAAW,EACX,gBAAgB,GACjB,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAErC,MAAM,UAAU,GAAG;YACjB,CAAC,gBAAgB,CAAC,EAAE,kBAAkB;YACtC,CAAC,GAAG,WAAW,IAAI,uBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,IAAI,MAAM,EAAE;SAC/B,CAAC;QAE5B,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,GAAG,KAAK,EAAE,GAAG,UAAU,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;IACxF,CAAC;IAED,gCAAgC;IAChC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,OAAgB,EAAE,KAAe;QACpD,KAAK,CAAC,UAAU,mBAAa,CAAC,GAAG,EAAE,CAAC,GAAG,2CAAkB,CAAC,QAAQ,CAAC;QAEnE,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,2CAAkB,CAAC,QAAQ;SACpC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,+BAA+B;IAC/B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,OAAgB,EAAE,KAAe;QACnD,KAAK,CAAC,UAAU,mBAAa,CAAC,GAAG,EAAE,CAAC,GAAG,2CAAkB,CAAC,MAAM,CAAC;QAEjE,MAAM,QAAQ,GAAG;YACf,MAAM,EAAE,2CAAkB,CAAC,MAAM;SAClC,CAAC;QAEF,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;CACF;AAAA,CAAC;AAEF,YAAY,CAAC,MAAM,GAAG,+BAAM,CAAC;AAE7B,kBAAe,YAAY,CAAC"}

package/dist/example/OrganizationAttributes.d.ts

@@ -0,0 +1,13 @@
+import { Schema } from '@kravc/schema';
+import { DefaultAttributes } from '../src';
+export declare enum OrganizationStatus {
+    ACTIVE = "ACTIVE",
+    DISABLED = "DISABLED"
+}
+export interface OrganizationAttributes extends DefaultAttributes {
+    name: string;
+    status: OrganizationStatus;
+    number: number;
+}
+export declare const schema: Schema;
+//# sourceMappingURL=OrganizationAttributes.d.ts.map