quidproquo-core 0.1.12 → 0.1.13

package/lib/commonjs/actions/keyValueStore/KeyValueStoreActionType.d.ts

@@ -5,5 +5,6 @@ export declare enum KeyValueStoreActionType {
     Delete = "@quidproquo-core/KeyValueStore/Delete",
     Update = "@quidproquo-core/KeyValueStore/Update",
     Query = "@quidproquo-core/KeyValueStore/Query",
-    Scan = "@quidproquo-core/KeyValueStore/Scan"
+    Scan = "@quidproquo-core/KeyValueStore/Scan",
+    ScanAllScopes = "@quidproquo-core/KeyValueStore/ScanAllScopes"
 }

package/lib/commonjs/actions/keyValueStore/KeyValueStoreActionType.js

@@ -10,5 +10,6 @@ var KeyValueStoreActionType;
     KeyValueStoreActionType["Update"] = "@quidproquo-core/KeyValueStore/Update";
     KeyValueStoreActionType["Query"] = "@quidproquo-core/KeyValueStore/Query";
     KeyValueStoreActionType["Scan"] = "@quidproquo-core/KeyValueStore/Scan";
+    KeyValueStoreActionType["ScanAllScopes"] = "@quidproquo-core/KeyValueStore/ScanAllScopes";
 })(KeyValueStoreActionType || (exports.KeyValueStoreActionType = KeyValueStoreActionType = {}));
 //# sourceMappingURL=KeyValueStoreActionType.js.map

package/lib/commonjs/actions/keyValueStore/KeyValueStoreActionType.js.map

@@ -1 +1 @@
-{"version":3,"file":"KeyValueStoreActionType.js","sourceRoot":"","sources":["../../../../src/actions/keyValueStore/KeyValueStoreActionType.ts"],"names":[],"mappings":";;;AAAA,IAAY,uBAQX;AARD,WAAY,uBAAuB;IACjC,2EAAgD,CAAA;IAChD,qEAA0C,CAAA;IAC1C,2EAAgD,CAAA;IAChD,2EAAgD,CAAA;IAChD,2EAAgD,CAAA;IAChD,yEAA8C,CAAA;IAC9C,uEAA4C,CAAA;AAC9C,CAAC,EARW,uBAAuB,uCAAvB,uBAAuB,QAQlC","sourcesContent":["export enum KeyValueStoreActionType {\n  Upsert = '@quidproquo-core/KeyValueStore/Upsert',\n  Get = '@quidproquo-core/KeyValueStore/Get',\n  GetAll = '@quidproquo-core/KeyValueStore/GetAll',\n  Delete = '@quidproquo-core/KeyValueStore/Delete',\n  Update = '@quidproquo-core/KeyValueStore/Update',\n  Query = '@quidproquo-core/KeyValueStore/Query',\n  Scan = '@quidproquo-core/KeyValueStore/Scan',\n}\n"]}
+{"version":3,"file":"KeyValueStoreActionType.js","sourceRoot":"","sources":["../../../../src/actions/keyValueStore/KeyValueStoreActionType.ts"],"names":[],"mappings":";;;AAAA,IAAY,uBASX;AATD,WAAY,uBAAuB;IACjC,2EAAgD,CAAA;IAChD,qEAA0C,CAAA;IAC1C,2EAAgD,CAAA;IAChD,2EAAgD,CAAA;IAChD,2EAAgD,CAAA;IAChD,yEAA8C,CAAA;IAC9C,uEAA4C,CAAA;IAC5C,yFAA8D,CAAA;AAChE,CAAC,EATW,uBAAuB,uCAAvB,uBAAuB,QASlC","sourcesContent":["export enum KeyValueStoreActionType {\n  Upsert = '@quidproquo-core/KeyValueStore/Upsert',\n  Get = '@quidproquo-core/KeyValueStore/Get',\n  GetAll = '@quidproquo-core/KeyValueStore/GetAll',\n  Delete = '@quidproquo-core/KeyValueStore/Delete',\n  Update = '@quidproquo-core/KeyValueStore/Update',\n  Query = '@quidproquo-core/KeyValueStore/Query',\n  Scan = '@quidproquo-core/KeyValueStore/Scan',\n  ScanAllScopes = '@quidproquo-core/KeyValueStore/ScanAllScopes',\n}\n"]}

package/lib/commonjs/actions/keyValueStore/KeyValueStoreScanAllScopesActionRequester.d.ts

@@ -0,0 +1,32 @@
+import { KeyValueStoreScanAllScopesActionRequester, KeyValueStoreScanAllScopesOptions } from './KeyValueStoreScanAllScopesActionTypes';
+import { KvsQueryOperation } from './types';
+export declare const KeyValueStoreScanAllScopesErrorTypeEnum: {
+    ResourceNotFound: string;
+    ServiceUnavailable: string;
+    StoreNotFound: string;
+};
+/**
+ * Read EVERY row in a store, across every scope, each paired with the scope it lives under.
+ *
+ * This deliberately crosses the tenant boundary that the rest of the KVS layer works hard to
+ * hold. An ordinary unscoped Scan cannot see scoped rows at all: the translator ANDs on a
+ * predicate that excludes them, precisely so one tenant's request can never read another's.
+ * That is the right default and nothing about it changes.
+ *
+ * The exception exists for MIGRATIONS, where the job is "rewrite every row" and any row you
+ * cannot see is data you silently leave behind. The alternative is asking the app to
+ * enumerate its own tenants and loop, which fails quietly the moment that list is incomplete.
+ *
+ * So: reach for this only from a migration or an equivalent whole-store operation, never on a
+ * request path. Nothing in the framework calls it, and a caller with a user's request in hand
+ * has no business using it — scope is what keeps tenants apart, and this steps over it.
+ *
+ * The scope comes back per row rather than being discarded, so a caller can write each row
+ * back where it came from.
+ *
+ * DRAIN THE PAGE KEY: loop until `nextPageKey` comes back undefined. Every backend pages,
+ * including the local one, deliberately so — a backend that returned everything in one call
+ * would let a caller stop after the first page, be right locally, and silently skip most of
+ * the data deployed. A local run has to be able to prove the loop.
+ */
+export declare function askKeyValueStoreScanAllScopes<KvsItem>(keyValueStoreName: string, filterCondition?: KvsQueryOperation, nextPageKey?: string, options?: KeyValueStoreScanAllScopesOptions): KeyValueStoreScanAllScopesActionRequester<KvsItem>;

package/lib/commonjs/actions/keyValueStore/KeyValueStoreScanAllScopesActionRequester.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KeyValueStoreScanAllScopesErrorTypeEnum = void 0;
+exports.askKeyValueStoreScanAllScopes = askKeyValueStoreScanAllScopes;
+const types_1 = require("../../types");
+const KeyValueStoreActionType_1 = require("./KeyValueStoreActionType");
+exports.KeyValueStoreScanAllScopesErrorTypeEnum = (0, types_1.createErrorEnumForAction)(KeyValueStoreActionType_1.KeyValueStoreActionType.ScanAllScopes, [
+    'ServiceUnavailable', // DynamoDB internal error / throttling
+    'ResourceNotFound', // the underlying table does not exist
+    'StoreNotFound', // the store is not declared in the qpq config (misconfiguration)
+]);
+/**
+ * Read EVERY row in a store, across every scope, each paired with the scope it lives under.
+ *
+ * This deliberately crosses the tenant boundary that the rest of the KVS layer works hard to
+ * hold. An ordinary unscoped Scan cannot see scoped rows at all: the translator ANDs on a
+ * predicate that excludes them, precisely so one tenant's request can never read another's.
+ * That is the right default and nothing about it changes.
+ *
+ * The exception exists for MIGRATIONS, where the job is "rewrite every row" and any row you
+ * cannot see is data you silently leave behind. The alternative is asking the app to
+ * enumerate its own tenants and loop, which fails quietly the moment that list is incomplete.
+ *
+ * So: reach for this only from a migration or an equivalent whole-store operation, never on a
+ * request path. Nothing in the framework calls it, and a caller with a user's request in hand
+ * has no business using it — scope is what keeps tenants apart, and this steps over it.
+ *
+ * The scope comes back per row rather than being discarded, so a caller can write each row
+ * back where it came from.
+ *
+ * DRAIN THE PAGE KEY: loop until `nextPageKey` comes back undefined. Every backend pages,
+ * including the local one, deliberately so — a backend that returned everything in one call
+ * would let a caller stop after the first page, be right locally, and silently skip most of
+ * the data deployed. A local run has to be able to prove the loop.
+ */
+function* askKeyValueStoreScanAllScopes(keyValueStoreName, filterCondition, nextPageKey, options) {
+    return yield {
+        type: KeyValueStoreActionType_1.KeyValueStoreActionType.ScanAllScopes,
+        payload: {
+            keyValueStoreName,
+            filterCondition,
+            nextPageKey,
+            options,
+        },
+    };
+}
+//# sourceMappingURL=KeyValueStoreScanAllScopesActionRequester.js.map

package/lib/commonjs/actions/keyValueStore/KeyValueStoreScanAllScopesActionRequester.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyValueStoreScanAllScopesActionRequester.js","sourceRoot":"","sources":["../../../../src/actions/keyValueStore/KeyValueStoreScanAllScopesActionRequester.ts"],"names":[],"mappings":";;;AAmCA,sEAkBC;AArDD,uCAAuD;AACvD,uEAAoE;AAIvD,QAAA,uCAAuC,GAAG,IAAA,gCAAwB,EAAC,iDAAuB,CAAC,aAAa,EAAE;IACrH,oBAAoB,EAAE,uCAAuC;IAC7D,kBAAkB,EAAE,sCAAsC;IAC1D,eAAe,EAAE,iEAAiE;CACnF,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,QAAe,CAAC,CAAC,6BAA6B,CAC5C,iBAAyB,EACzB,eAAmC,EACnC,WAAoB,EACpB,OAA2C;IAE3C,OAAO,MAAM;QACX,IAAI,EAAE,iDAAuB,CAAC,aAAa;QAC3C,OAAO,EAAE;YACP,iBAAiB;YAEjB,eAAe;YAEf,WAAW;YAEX,OAAO;SACR;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { createErrorEnumForAction } from '../../types';\nimport { KeyValueStoreActionType } from './KeyValueStoreActionType';\nimport { KeyValueStoreScanAllScopesActionRequester, KeyValueStoreScanAllScopesOptions } from './KeyValueStoreScanAllScopesActionTypes';\nimport { KvsQueryOperation } from './types';\n\nexport const KeyValueStoreScanAllScopesErrorTypeEnum = createErrorEnumForAction(KeyValueStoreActionType.ScanAllScopes, [\n  'ServiceUnavailable', // DynamoDB internal error / throttling\n  'ResourceNotFound', // the underlying table does not exist\n  'StoreNotFound', // the store is not declared in the qpq config (misconfiguration)\n]);\n\n/**\n * Read EVERY row in a store, across every scope, each paired with the scope it lives under.\n *\n * This deliberately crosses the tenant boundary that the rest of the KVS layer works hard to\n * hold. An ordinary unscoped Scan cannot see scoped rows at all: the translator ANDs on a\n * predicate that excludes them, precisely so one tenant's request can never read another's.\n * That is the right default and nothing about it changes.\n *\n * The exception exists for MIGRATIONS, where the job is \"rewrite every row\" and any row you\n * cannot see is data you silently leave behind. The alternative is asking the app to\n * enumerate its own tenants and loop, which fails quietly the moment that list is incomplete.\n *\n * So: reach for this only from a migration or an equivalent whole-store operation, never on a\n * request path. Nothing in the framework calls it, and a caller with a user's request in hand\n * has no business using it — scope is what keeps tenants apart, and this steps over it.\n *\n * The scope comes back per row rather than being discarded, so a caller can write each row\n * back where it came from.\n *\n * DRAIN THE PAGE KEY: loop until `nextPageKey` comes back undefined. Every backend pages,\n * including the local one, deliberately so — a backend that returned everything in one call\n * would let a caller stop after the first page, be right locally, and silently skip most of\n * the data deployed. A local run has to be able to prove the loop.\n */\nexport function* askKeyValueStoreScanAllScopes<KvsItem>(\n  keyValueStoreName: string,\n  filterCondition?: KvsQueryOperation,\n  nextPageKey?: string,\n  options?: KeyValueStoreScanAllScopesOptions,\n): KeyValueStoreScanAllScopesActionRequester<KvsItem> {\n  return yield {\n    type: KeyValueStoreActionType.ScanAllScopes,\n    payload: {\n      keyValueStoreName,\n\n      filterCondition,\n\n      nextPageKey,\n\n      options,\n    },\n  };\n}\n"]}

package/lib/commonjs/actions/keyValueStore/KeyValueStoreScanAllScopesActionTypes.d.ts

@@ -0,0 +1,23 @@
+import { QpqPagedData } from '../../types';
+import { Action, ActionProcessor, ActionRequester } from '../../types/Action';
+import { KeyValueStoreActionType } from './KeyValueStoreActionType';
+import { KvsQueryOperation } from './types';
+export type KvsScopedItem<KvsItem> = {
+    scope?: string;
+    item: KvsItem;
+};
+export interface KeyValueStoreScanAllScopesOptions {
+    limit?: number;
+}
+export interface KeyValueStoreScanAllScopesActionPayload {
+    keyValueStoreName: string;
+    filterCondition?: KvsQueryOperation;
+    nextPageKey?: string;
+    options?: KeyValueStoreScanAllScopesOptions;
+}
+export interface KeyValueStoreScanAllScopesAction extends Action<KeyValueStoreScanAllScopesActionPayload> {
+    type: KeyValueStoreActionType.ScanAllScopes;
+    payload: KeyValueStoreScanAllScopesActionPayload;
+}
+export type KeyValueStoreScanAllScopesActionProcessor<KvsItem> = ActionProcessor<KeyValueStoreScanAllScopesAction, QpqPagedData<KvsScopedItem<KvsItem>>>;
+export type KeyValueStoreScanAllScopesActionRequester<KvsItem> = ActionRequester<KeyValueStoreScanAllScopesAction, QpqPagedData<KvsScopedItem<KvsItem>>>;

package/lib/commonjs/actions/keyValueStore/KeyValueStoreScanAllScopesActionTypes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=KeyValueStoreScanAllScopesActionTypes.js.map

package/lib/commonjs/actions/keyValueStore/KeyValueStoreScanAllScopesActionTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyValueStoreScanAllScopesActionTypes.js","sourceRoot":"","sources":["../../../../src/actions/keyValueStore/KeyValueStoreScanAllScopesActionTypes.ts"],"names":[],"mappings":"","sourcesContent":["import { QpqPagedData } from '../../types';\nimport { Action, ActionProcessor, ActionRequester } from '../../types/Action';\nimport { KeyValueStoreActionType } from './KeyValueStoreActionType';\nimport { KvsQueryOperation } from './types';\n\n// One row and the scope it lives under. `scope` is absent for an unscoped row.\n//\n// The scope is reported rather than dropped BECAUSE this crosses scopes: a caller that reads\n// every tenant's rows in one pass has to know which tenant each belongs to, or anything it\n// writes back lands in the wrong partition. Handing back bare items would make silent\n// cross-tenant corruption the easy mistake.\nexport type KvsScopedItem<KvsItem> = {\n  scope?: string;\n  item: KvsItem;\n};\n\n// Options Type\nexport interface KeyValueStoreScanAllScopesOptions {\n  limit?: number;\n}\n\n// Payload\nexport interface KeyValueStoreScanAllScopesActionPayload {\n  keyValueStoreName: string;\n\n  filterCondition?: KvsQueryOperation;\n\n  nextPageKey?: string;\n\n  options?: KeyValueStoreScanAllScopesOptions;\n}\n\n// Action\nexport interface KeyValueStoreScanAllScopesAction extends Action<KeyValueStoreScanAllScopesActionPayload> {\n  type: KeyValueStoreActionType.ScanAllScopes;\n  payload: KeyValueStoreScanAllScopesActionPayload;\n}\n\n// Function Types\nexport type KeyValueStoreScanAllScopesActionProcessor<KvsItem> = ActionProcessor<\n  KeyValueStoreScanAllScopesAction,\n  QpqPagedData<KvsScopedItem<KvsItem>>\n>;\nexport type KeyValueStoreScanAllScopesActionRequester<KvsItem> = ActionRequester<\n  KeyValueStoreScanAllScopesAction,\n  QpqPagedData<KvsScopedItem<KvsItem>>\n>;\n"]}

package/lib/commonjs/actions/keyValueStore/index.d.ts

@@ -1,3 +1,5 @@
+export * from './KeyValueStoreScanAllScopesActionTypes';
+export * from './KeyValueStoreScanAllScopesActionRequester';
 export * from './KeyValueStoreActionType';
 export * from './KeyValueStoreDeleteActionRequester';
 export * from './KeyValueStoreDeleteActionTypes';

package/lib/commonjs/actions/keyValueStore/index.js

@@ -14,6 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./KeyValueStoreScanAllScopesActionTypes"), exports);
+__exportStar(require("./KeyValueStoreScanAllScopesActionRequester"), exports);
 __exportStar(require("./KeyValueStoreActionType"), exports);
 __exportStar(require("./KeyValueStoreDeleteActionRequester"), exports);
 __exportStar(require("./KeyValueStoreDeleteActionTypes"), exports);

package/lib/commonjs/actions/keyValueStore/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/actions/keyValueStore/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,uEAAqD;AACrD,mEAAiD;AACjD,oEAAkD;AAClD,gEAA8C;AAC9C,uEAAqD;AACrD,mEAAiD;AACjD,sEAAoD;AACpD,kEAAgD;AAChD,qEAAmD;AACnD,iEAA+C;AAC/C,uEAAqD;AACrD,mEAAiD;AACjD,uEAAqD;AACrD,mEAAiD;AACjD,0CAAwB;AACxB,0CAAwB","sourcesContent":["export * from './KeyValueStoreActionType';\nexport * from './KeyValueStoreDeleteActionRequester';\nexport * from './KeyValueStoreDeleteActionTypes';\nexport * from './KeyValueStoreGetActionRequester';\nexport * from './KeyValueStoreGetActionTypes';\nexport * from './KeyValueStoreGetAllActionRequester';\nexport * from './KeyValueStoreGetAllActionTypes';\nexport * from './KeyValueStoreQueryActionRequester';\nexport * from './KeyValueStoreQueryActionTypes';\nexport * from './KeyValueStoreScanActionRequester';\nexport * from './KeyValueStoreScanActionTypes';\nexport * from './KeyValueStoreUpdateActionRequester';\nexport * from './KeyValueStoreUpdateActionTypes';\nexport * from './KeyValueStoreUpsertActionRequester';\nexport * from './KeyValueStoreUpsertActionTypes';\nexport * from './types';\nexport * from './utils';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/actions/keyValueStore/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0EAAwD;AACxD,8EAA4D;AAC5D,4DAA0C;AAC1C,uEAAqD;AACrD,mEAAiD;AACjD,oEAAkD;AAClD,gEAA8C;AAC9C,uEAAqD;AACrD,mEAAiD;AACjD,sEAAoD;AACpD,kEAAgD;AAChD,qEAAmD;AACnD,iEAA+C;AAC/C,uEAAqD;AACrD,mEAAiD;AACjD,uEAAqD;AACrD,mEAAiD;AACjD,0CAAwB;AACxB,0CAAwB","sourcesContent":["export * from './KeyValueStoreScanAllScopesActionTypes';\nexport * from './KeyValueStoreScanAllScopesActionRequester';\nexport * from './KeyValueStoreActionType';\nexport * from './KeyValueStoreDeleteActionRequester';\nexport * from './KeyValueStoreDeleteActionTypes';\nexport * from './KeyValueStoreGetActionRequester';\nexport * from './KeyValueStoreGetActionTypes';\nexport * from './KeyValueStoreGetAllActionRequester';\nexport * from './KeyValueStoreGetAllActionTypes';\nexport * from './KeyValueStoreQueryActionRequester';\nexport * from './KeyValueStoreQueryActionTypes';\nexport * from './KeyValueStoreScanActionRequester';\nexport * from './KeyValueStoreScanActionTypes';\nexport * from './KeyValueStoreUpdateActionRequester';\nexport * from './KeyValueStoreUpdateActionTypes';\nexport * from './KeyValueStoreUpsertActionRequester';\nexport * from './KeyValueStoreUpsertActionTypes';\nexport * from './types';\nexport * from './utils';\n"]}

package/lib/commonjs/actions/keyValueStore/types/KvsQueryOperation.d.ts

@@ -1,9 +1,9 @@
 import { KvsLogicalOperatorType, KvsQueryOperationType } from './KvsQueryOperationType';
 export type KvsCoreDataType = string | number;
 export type KvsBasicDataType = KvsCoreDataType | boolean;
-export type KvsListDataType = KvsBasicDataType[];
+export type KvsListDataType = KvsAdvancedDataType[];
 export interface KvsObjectDataType {
-    [key: string]: KvsAdvancedDataType;
+    [key: string]: KvsAdvancedDataType | undefined;
 }
 export type KvsAdvancedDataType = KvsBasicDataType | KvsListDataType | KvsObjectDataType;
 export type KvsQueryCondition = {

package/lib/commonjs/actions/keyValueStore/types/KvsQueryOperation.js.map

@@ -1 +1 @@
-{"version":3,"file":"KvsQueryOperation.js","sourceRoot":"","sources":["../../../../../src/actions/keyValueStore/types/KvsQueryOperation.ts"],"names":[],"mappings":"","sourcesContent":["import { KvsLogicalOperatorType, KvsQueryOperationType } from './KvsQueryOperationType';\n\nexport type KvsCoreDataType = string | number;\nexport type KvsBasicDataType = KvsCoreDataType | boolean;\nexport type KvsListDataType = KvsBasicDataType[];\n\n// Use an interface for the recursive data type\nexport interface KvsObjectDataType {\n  [key: string]: KvsAdvancedDataType;\n}\n\nexport type KvsAdvancedDataType = KvsBasicDataType | KvsListDataType | KvsObjectDataType;\n\n// Type for individual query conditions\nexport type KvsQueryCondition = {\n  key: string;\n  operation: KvsQueryOperationType;\n  valueA?: KvsAdvancedDataType;\n  valueB?: KvsBasicDataType;\n};\n\n// Type for logical operators\nexport type KvsLogicalOperator = {\n  operation: KvsLogicalOperatorType;\n  conditions: (KvsQueryCondition | KvsLogicalOperator)[];\n};\n\n// Type for the overall query operation\nexport type KvsQueryOperation = KvsQueryCondition | KvsLogicalOperator;\n"]}
+{"version":3,"file":"KvsQueryOperation.js","sourceRoot":"","sources":["../../../../../src/actions/keyValueStore/types/KvsQueryOperation.ts"],"names":[],"mappings":"","sourcesContent":["import { KvsLogicalOperatorType, KvsQueryOperationType } from './KvsQueryOperationType';\n\nexport type KvsCoreDataType = string | number;\nexport type KvsBasicDataType = KvsCoreDataType | boolean;\n\nexport type KvsListDataType = KvsAdvancedDataType[];\n\n// Use an interface for the recursive data type. Members may be undefined so that a\n// domain model with OPTIONAL fields can be written directly; the marshaller drops\n// undefined members, since DynamoDB has no representation for them.\nexport interface KvsObjectDataType {\n  [key: string]: KvsAdvancedDataType | undefined;\n}\n\nexport type KvsAdvancedDataType = KvsBasicDataType | KvsListDataType | KvsObjectDataType;\n\n// Type for individual query conditions\nexport type KvsQueryCondition = {\n  key: string;\n  operation: KvsQueryOperationType;\n  valueA?: KvsAdvancedDataType;\n  valueB?: KvsBasicDataType;\n};\n\n// Type for logical operators\nexport type KvsLogicalOperator = {\n  operation: KvsLogicalOperatorType;\n  conditions: (KvsQueryCondition | KvsLogicalOperator)[];\n};\n\n// Type for the overall query operation\nexport type KvsQueryOperation = KvsQueryCondition | KvsLogicalOperator;\n"]}

package/lib/commonjs/config/settings/keyValueStore.d.ts

@@ -1,4 +1,4 @@
-import { CrossModuleOwner, KeyOf } from '../../types';
+import { CrossModuleOwner, KeyOf, QpqFunctionRuntime } from '../../types';
 import { QPQConfigAdvancedSettings, QPQConfigSetting } from '../QPQConfig';
 export type KvsKeyType = 'string' | 'number' | 'binary';
 export type KvsKey<T extends object = any> = {
@@ -16,6 +16,41 @@ type CompositeCompositeKvsIndex<T extends object = any> = {
     sortKey?: CompositeKvsKey<T>;
 };
 export type CompositeKvsIndex<T extends object = any> = KeyOf<T> | CompositeCompositeKvsIndex<T>;
+/**
+ * Change data capture on a store: the table gets a stream (NEW_AND_OLD_IMAGES) and
+ * `runtime` is invoked with the changes.
+ *
+ * Records arrive in order PER PARTITION KEY, and different partition keys are processed
+ * concurrently. A stream handler therefore gets one-writer-per-item serialisation for
+ * free, which is what makes a stream the natural place to maintain a projection of a table
+ * you only ever append to — no queue, no extra write on the append path, and no trigger to
+ * lose, because the record exists precisely because the write happened.
+ *
+ * Mirrors defineStorageDrive's `onEvent`.
+ */
+export type KvsStreamSettings = {
+    runtime: QpqFunctionRuntime;
+    /**
+     * Collapse each delivered batch down to ONE record per partition key, keeping the latest.
+     *
+     * Off by default: a generic consumer (audit trail, change notifications) needs to see
+     * every change, and the framework should never silently drop records.
+     *
+     * On for a PROJECTION, where the payload that matters is "this key changed" and the
+     * handler re-derives from source anyway. Without it, the batch is fanned back out into
+     * one story run per record and the batching bought nothing: 500 appends to one document
+     * would mean 500 re-derivations, each reading a log that grows as it goes. With it, that
+     * batch is a single re-derivation.
+     */
+    coalesceByPartitionKey?: boolean;
+    /** Records per invocation. DynamoDB streams allow up to 1000; the mapping default is 100. */
+    batchSize?: number;
+    /**
+     * How long to wait accumulating records before invoking, 0 to 300 seconds. Trades
+     * projection latency for far fewer invocations, and gives coalescing more to collapse.
+     */
+    maximumBatchingWindowInSeconds?: number;
+};
 export interface QPQConfigAdvancedKeyValueStoreSettings<T extends object = any> extends QPQConfigAdvancedSettings {
     indexes?: CompositeKvsIndex<T>[];
     global?: boolean;
@@ -23,6 +58,7 @@ export interface QPQConfigAdvancedKeyValueStoreSettings<T extends object = any>
     ttlAttribute?: string;
     disablePointInTimeRecovery?: boolean;
     encryption?: boolean;
+    onStream?: KvsStreamSettings;
 }
 export interface KeyValueStoreQPQConfigSetting<T extends object = any> extends QPQConfigSetting {
     keyValueStoreName: string;
@@ -33,6 +69,7 @@ export interface KeyValueStoreQPQConfigSetting<T extends object = any> extends Q
     ttlAttribute?: string;
     disablePointInTimeRecovery: boolean;
     encryption: boolean;
+    onStream?: KvsStreamSettings;
 }
 export declare const defineKeyValueStore: <T extends object = any>(keyValueStoreName: string, partitionKey: CompositeKvsKey<T>, sortKeys?: CompositeKvsKey<T>[], options?: QPQConfigAdvancedKeyValueStoreSettings<T>) => KeyValueStoreQPQConfigSetting<T>;
 export {};

package/lib/commonjs/config/settings/keyValueStore.js

@@ -43,6 +43,7 @@ const defineKeyValueStore = (keyValueStoreName, partitionKey, sortKeys = [], opt
         ttlAttribute: options === null || options === void 0 ? void 0 : options.ttlAttribute,
         disablePointInTimeRecovery: (_c = options === null || options === void 0 ? void 0 : options.disablePointInTimeRecovery) !== null && _c !== void 0 ? _c : false,
         encryption: (_d = options === null || options === void 0 ? void 0 : options.encryption) !== null && _d !== void 0 ? _d : false,
+        onStream: options === null || options === void 0 ? void 0 : options.onStream,
     });
 };
 exports.defineKeyValueStore = defineKeyValueStore;

package/lib/commonjs/config/settings/keyValueStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"keyValueStore.js","sourceRoot":"","sources":["../../../../src/config/settings/keyValueStore.ts"],"names":[],"mappings":";;;AACA,4CAAqG;AAmB9F,MAAM,MAAM,GAAG,CAAyB,GAAa,EAAE,OAAmB,QAAQ,EAAa,EAAE,CAAC,CAAC;IACxG,GAAG;IACH,IAAI;CACL,CAAC,CAAC;AAHU,QAAA,MAAM,UAGhB;AAWH,MAAM,8BAA8B,GAAG,CAAyB,eAAmC,EAAa,EAAE;IAChH,oBAAoB;IACpB,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,IAAA,cAAM,EAAI,eAA2B,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED,sBAAsB;IACtB,OAAO,eAA4B,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,8CAA8C,GAAG,CACrD,iBAAuC,EACa,EAAE;IACtD,OAAO,OAAO,iBAAiB,KAAK,QAAQ,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,kCAAkC,GAAG,CAAyB,iBAAuC,EAAe,EAAE;IAC1H,IAAI,CAAC,8CAA8C,CAAI,iBAAiB,CAAC,EAAE,CAAC;QAC1E,OAAO;YACL,YAAY,EAAE,IAAA,cAAM,EAAI,iBAAiB,EAAE,QAAQ,CAAC;SACrD,CAAC;IACJ,CAAC;IAED,OAAO;QACL,YAAY,EAAE,8BAA8B,CAAI,iBAAiB,CAAC,YAAY,CAAC;QAC/E,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,8BAA8B,CAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;KAC9G,CAAC;AACJ,CAAC,CAAC;AAkCK,MAAM,mBAAmB,GAAG,CACjC,iBAAyB,EAEzB,YAAgC,EAChC,WAAiC,EAAE,EAEnC,OAAmD,EACjB,EAAE;;IAAC,OAAA,CAAC;QACtC,iBAAiB,EAAE,oCAAwB,CAAC,aAAa;QACzD,SAAS,EAAE,iBAAiB;QAE5B,iBAAiB;QAEjB,YAAY,EAAE,8BAA8B,CAAI,YAAY,CAAC;QAC7D,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,8BAAiC,CAAA,CAAC;QAEzD,OAAO,EAAE,CAAC,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,mCAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAA,kCAAqC,CAAA,CAAC;QAE5E,MAAM,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,KAAK;QAEhC,KAAK,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK;QAErB,YAAY,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;QAEnC,0BAA0B,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,0BAA0B,mCAAI,KAAK;QAExE,UAAU,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,mCAAI,KAAK;KACzC,CAAC,CAAA;CAAA,CAAC;AA3BU,QAAA,mBAAmB,uBA2B7B","sourcesContent":["import { CrossModuleOwner, KeyOf } from '../../types';\nimport { QPQConfigAdvancedSettings, QPQConfigSetting, QPQCoreConfigSettingType } from '../QPQConfig';\n\n// TODO: When we put validation on the QPQConfig, we need to make sure\n// Key Length and Data Type: DynamoDB has limitations on key length and data type.\n// Your KvsKeyType only supports 'string', 'number', and 'binary' types. Make sure\n// that you're validating these in convertKvsKeyToDynamodbAttribute function and\n// also ensure that key length is within DynamoDB's specified limits.\n\nexport type KvsKeyType = 'string' | 'number' | 'binary';\nexport type KvsKey<T extends object = any> = {\n  key: KeyOf<T>;\n  type: KvsKeyType;\n};\n\nexport type KvsIndex<T extends object = any> = {\n  partitionKey: KvsKey<T>;\n  sortKey?: KvsKey<T>;\n};\n\nexport const kvsKey = <T extends object = any>(key: KeyOf<T>, type: KvsKeyType = 'string'): KvsKey<T> => ({\n  key,\n  type,\n});\n\ntype CompositeKvsKey<T extends object = any> = KvsKey<T> | KeyOf<T>;\n\ntype CompositeCompositeKvsIndex<T extends object = any> = {\n  partitionKey: CompositeKvsKey<T>;\n  sortKey?: CompositeKvsKey<T>;\n};\n\nexport type CompositeKvsIndex<T extends object = any> = KeyOf<T> | CompositeCompositeKvsIndex<T>;\n\nconst convertCompositeKvsKeyToKvsKey = <T extends object = any>(compositeKvsKey: CompositeKvsKey<T>): KvsKey<T> => {\n  // Must be a keyof T\n  if (typeof compositeKvsKey === 'string') {\n    return kvsKey<T>(compositeKvsKey as KeyOf<T>, 'string');\n  }\n\n  // must be a KvsKey<T>\n  return compositeKvsKey as KvsKey<T>;\n};\n\nconst isCompositeKvsIndexACompositeCompositeKvsIndex = <T extends object = any>(\n  compositeKvsIndex: CompositeKvsIndex<T>,\n): compositeKvsIndex is CompositeCompositeKvsIndex<T> => {\n  return typeof compositeKvsIndex !== 'string';\n};\n\nconst convertCompositeKvsIndexToKvsIndex = <T extends object = any>(compositeKvsIndex: CompositeKvsIndex<T>): KvsIndex<T> => {\n  if (!isCompositeKvsIndexACompositeCompositeKvsIndex<T>(compositeKvsIndex)) {\n    return {\n      partitionKey: kvsKey<T>(compositeKvsIndex, 'string'),\n    };\n  }\n\n  return {\n    partitionKey: convertCompositeKvsKeyToKvsKey<T>(compositeKvsIndex.partitionKey),\n    sortKey: compositeKvsIndex.sortKey ? convertCompositeKvsKeyToKvsKey<T>(compositeKvsIndex.sortKey) : undefined,\n  };\n};\n\nexport interface QPQConfigAdvancedKeyValueStoreSettings<T extends object = any> extends QPQConfigAdvancedSettings {\n  indexes?: CompositeKvsIndex<T>[];\n\n  global?: boolean;\n\n  owner?: CrossModuleOwner;\n\n  ttlAttribute?: string;\n\n  // Point-in-time recovery (35-day continuous backups) is on by default; set this to opt out.\n  disablePointInTimeRecovery?: boolean;\n\n  encryption?: boolean;\n}\n\nexport interface KeyValueStoreQPQConfigSetting<T extends object = any> extends QPQConfigSetting {\n  keyValueStoreName: string;\n\n  partitionKey: KvsKey<T>;\n  sortKeys: KvsKey<T>[];\n\n  indexes: KvsIndex<T>[];\n\n  global: boolean;\n\n  ttlAttribute?: string;\n\n  disablePointInTimeRecovery: boolean;\n\n  encryption: boolean;\n}\n\nexport const defineKeyValueStore = <T extends object = any>(\n  keyValueStoreName: string,\n\n  partitionKey: CompositeKvsKey<T>,\n  sortKeys: CompositeKvsKey<T>[] = [],\n\n  options?: QPQConfigAdvancedKeyValueStoreSettings<T>,\n): KeyValueStoreQPQConfigSetting<T> => ({\n  configSettingType: QPQCoreConfigSettingType.keyValueStore,\n  uniqueKey: keyValueStoreName,\n\n  keyValueStoreName,\n\n  partitionKey: convertCompositeKvsKeyToKvsKey<T>(partitionKey),\n  sortKeys: sortKeys.map(convertCompositeKvsKeyToKvsKey<T>),\n\n  indexes: (options?.indexes ?? []).map(convertCompositeKvsIndexToKvsIndex<T>),\n\n  global: options?.global ?? false,\n\n  owner: options?.owner,\n\n  ttlAttribute: options?.ttlAttribute,\n\n  disablePointInTimeRecovery: options?.disablePointInTimeRecovery ?? false,\n\n  encryption: options?.encryption ?? false,\n});\n"]}
+{"version":3,"file":"keyValueStore.js","sourceRoot":"","sources":["../../../../src/config/settings/keyValueStore.ts"],"names":[],"mappings":";;;AACA,4CAAqG;AAmB9F,MAAM,MAAM,GAAG,CAAyB,GAAa,EAAE,OAAmB,QAAQ,EAAa,EAAE,CAAC,CAAC;IACxG,GAAG;IACH,IAAI;CACL,CAAC,CAAC;AAHU,QAAA,MAAM,UAGhB;AAWH,MAAM,8BAA8B,GAAG,CAAyB,eAAmC,EAAa,EAAE;IAChH,oBAAoB;IACpB,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,IAAA,cAAM,EAAI,eAA2B,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED,sBAAsB;IACtB,OAAO,eAA4B,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,8CAA8C,GAAG,CACrD,iBAAuC,EACa,EAAE;IACtD,OAAO,OAAO,iBAAiB,KAAK,QAAQ,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,kCAAkC,GAAG,CAAyB,iBAAuC,EAAe,EAAE;IAC1H,IAAI,CAAC,8CAA8C,CAAI,iBAAiB,CAAC,EAAE,CAAC;QAC1E,OAAO;YACL,YAAY,EAAE,IAAA,cAAM,EAAI,iBAAiB,EAAE,QAAQ,CAAC;SACrD,CAAC;IACJ,CAAC;IAED,OAAO;QACL,YAAY,EAAE,8BAA8B,CAAI,iBAAiB,CAAC,YAAY,CAAC;QAC/E,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,8BAA8B,CAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;KAC9G,CAAC;AACJ,CAAC,CAAC;AA+EK,MAAM,mBAAmB,GAAG,CACjC,iBAAyB,EAEzB,YAAgC,EAChC,WAAiC,EAAE,EAEnC,OAAmD,EACjB,EAAE;;IAAC,OAAA,CAAC;QACtC,iBAAiB,EAAE,oCAAwB,CAAC,aAAa;QACzD,SAAS,EAAE,iBAAiB;QAE5B,iBAAiB;QAEjB,YAAY,EAAE,8BAA8B,CAAI,YAAY,CAAC;QAC7D,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,8BAAiC,CAAA,CAAC;QAEzD,OAAO,EAAE,CAAC,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,mCAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAA,kCAAqC,CAAA,CAAC;QAE5E,MAAM,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,mCAAI,KAAK;QAEhC,KAAK,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK;QAErB,YAAY,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;QAEnC,0BAA0B,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,0BAA0B,mCAAI,KAAK;QAExE,UAAU,EAAE,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,mCAAI,KAAK;QAExC,QAAQ,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ;KAC5B,CAAC,CAAA;CAAA,CAAC;AA7BU,QAAA,mBAAmB,uBA6B7B","sourcesContent":["import { CrossModuleOwner, KeyOf, QpqFunctionRuntime } from '../../types';\nimport { QPQConfigAdvancedSettings, QPQConfigSetting, QPQCoreConfigSettingType } from '../QPQConfig';\n\n// TODO: When we put validation on the QPQConfig, we need to make sure\n// Key Length and Data Type: DynamoDB has limitations on key length and data type.\n// Your KvsKeyType only supports 'string', 'number', and 'binary' types. Make sure\n// that you're validating these in convertKvsKeyToDynamodbAttribute function and\n// also ensure that key length is within DynamoDB's specified limits.\n\nexport type KvsKeyType = 'string' | 'number' | 'binary';\nexport type KvsKey<T extends object = any> = {\n  key: KeyOf<T>;\n  type: KvsKeyType;\n};\n\nexport type KvsIndex<T extends object = any> = {\n  partitionKey: KvsKey<T>;\n  sortKey?: KvsKey<T>;\n};\n\nexport const kvsKey = <T extends object = any>(key: KeyOf<T>, type: KvsKeyType = 'string'): KvsKey<T> => ({\n  key,\n  type,\n});\n\ntype CompositeKvsKey<T extends object = any> = KvsKey<T> | KeyOf<T>;\n\ntype CompositeCompositeKvsIndex<T extends object = any> = {\n  partitionKey: CompositeKvsKey<T>;\n  sortKey?: CompositeKvsKey<T>;\n};\n\nexport type CompositeKvsIndex<T extends object = any> = KeyOf<T> | CompositeCompositeKvsIndex<T>;\n\nconst convertCompositeKvsKeyToKvsKey = <T extends object = any>(compositeKvsKey: CompositeKvsKey<T>): KvsKey<T> => {\n  // Must be a keyof T\n  if (typeof compositeKvsKey === 'string') {\n    return kvsKey<T>(compositeKvsKey as KeyOf<T>, 'string');\n  }\n\n  // must be a KvsKey<T>\n  return compositeKvsKey as KvsKey<T>;\n};\n\nconst isCompositeKvsIndexACompositeCompositeKvsIndex = <T extends object = any>(\n  compositeKvsIndex: CompositeKvsIndex<T>,\n): compositeKvsIndex is CompositeCompositeKvsIndex<T> => {\n  return typeof compositeKvsIndex !== 'string';\n};\n\nconst convertCompositeKvsIndexToKvsIndex = <T extends object = any>(compositeKvsIndex: CompositeKvsIndex<T>): KvsIndex<T> => {\n  if (!isCompositeKvsIndexACompositeCompositeKvsIndex<T>(compositeKvsIndex)) {\n    return {\n      partitionKey: kvsKey<T>(compositeKvsIndex, 'string'),\n    };\n  }\n\n  return {\n    partitionKey: convertCompositeKvsKeyToKvsKey<T>(compositeKvsIndex.partitionKey),\n    sortKey: compositeKvsIndex.sortKey ? convertCompositeKvsKeyToKvsKey<T>(compositeKvsIndex.sortKey) : undefined,\n  };\n};\n\n/**\n * Change data capture on a store: the table gets a stream (NEW_AND_OLD_IMAGES) and\n * `runtime` is invoked with the changes.\n *\n * Records arrive in order PER PARTITION KEY, and different partition keys are processed\n * concurrently. A stream handler therefore gets one-writer-per-item serialisation for\n * free, which is what makes a stream the natural place to maintain a projection of a table\n * you only ever append to — no queue, no extra write on the append path, and no trigger to\n * lose, because the record exists precisely because the write happened.\n *\n * Mirrors defineStorageDrive's `onEvent`.\n */\nexport type KvsStreamSettings = {\n  runtime: QpqFunctionRuntime;\n\n  /**\n   * Collapse each delivered batch down to ONE record per partition key, keeping the latest.\n   *\n   * Off by default: a generic consumer (audit trail, change notifications) needs to see\n   * every change, and the framework should never silently drop records.\n   *\n   * On for a PROJECTION, where the payload that matters is \"this key changed\" and the\n   * handler re-derives from source anyway. Without it, the batch is fanned back out into\n   * one story run per record and the batching bought nothing: 500 appends to one document\n   * would mean 500 re-derivations, each reading a log that grows as it goes. With it, that\n   * batch is a single re-derivation.\n   */\n  coalesceByPartitionKey?: boolean;\n\n  /** Records per invocation. DynamoDB streams allow up to 1000; the mapping default is 100. */\n  batchSize?: number;\n\n  /**\n   * How long to wait accumulating records before invoking, 0 to 300 seconds. Trades\n   * projection latency for far fewer invocations, and gives coalescing more to collapse.\n   */\n  maximumBatchingWindowInSeconds?: number;\n};\n\nexport interface QPQConfigAdvancedKeyValueStoreSettings<T extends object = any> extends QPQConfigAdvancedSettings {\n  indexes?: CompositeKvsIndex<T>[];\n\n  global?: boolean;\n\n  owner?: CrossModuleOwner;\n\n  ttlAttribute?: string;\n\n  // Point-in-time recovery (35-day continuous backups) is on by default; set this to opt out.\n  disablePointInTimeRecovery?: boolean;\n\n  encryption?: boolean;\n\n  // Turn on change data capture — see KvsStreamSettings. Absent means no stream is\n  // created at all.\n  onStream?: KvsStreamSettings;\n}\n\nexport interface KeyValueStoreQPQConfigSetting<T extends object = any> extends QPQConfigSetting {\n  keyValueStoreName: string;\n\n  partitionKey: KvsKey<T>;\n  sortKeys: KvsKey<T>[];\n\n  indexes: KvsIndex<T>[];\n\n  global: boolean;\n\n  ttlAttribute?: string;\n\n  disablePointInTimeRecovery: boolean;\n\n  encryption: boolean;\n\n  onStream?: KvsStreamSettings;\n}\n\nexport const defineKeyValueStore = <T extends object = any>(\n  keyValueStoreName: string,\n\n  partitionKey: CompositeKvsKey<T>,\n  sortKeys: CompositeKvsKey<T>[] = [],\n\n  options?: QPQConfigAdvancedKeyValueStoreSettings<T>,\n): KeyValueStoreQPQConfigSetting<T> => ({\n  configSettingType: QPQCoreConfigSettingType.keyValueStore,\n  uniqueKey: keyValueStoreName,\n\n  keyValueStoreName,\n\n  partitionKey: convertCompositeKvsKeyToKvsKey<T>(partitionKey),\n  sortKeys: sortKeys.map(convertCompositeKvsKeyToKvsKey<T>),\n\n  indexes: (options?.indexes ?? []).map(convertCompositeKvsIndexToKvsIndex<T>),\n\n  global: options?.global ?? false,\n\n  owner: options?.owner,\n\n  ttlAttribute: options?.ttlAttribute,\n\n  disablePointInTimeRecovery: options?.disablePointInTimeRecovery ?? false,\n\n  encryption: options?.encryption ?? false,\n\n  onStream: options?.onStream,\n});\n"]}

package/lib/commonjs/logic/scope/scopedKvsValue.d.ts

@@ -1,6 +1,10 @@
 import { KvsCoreDataType, KvsQueryCondition } from '../../actions/keyValueStore/types';
 export declare const KVS_SCOPE_DELIMITER = "@@QPQSCOPE@@";
 export declare function composeScopedKvsValue(scope: string | undefined, rawValue: KvsCoreDataType): KvsCoreDataType;
+export declare const decomposeScopedKvsValue: (composedValue: string) => {
+    scope?: string;
+    rawValue: string;
+};
 export declare function validateRawPkValueForScopeOrThrow(rawValue: KvsCoreDataType): void;
 export declare function stripScopedKvsValue(scope: string | undefined, storedValue: KvsCoreDataType): KvsCoreDataType;
 export declare function validateScopeSupportedForPartitionKeyType(partitionKeyType: string): void;

package/lib/commonjs/logic/scope/scopedKvsValue.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KVS_SCOPE_DELIMITER = void 0;
+exports.decomposeScopedKvsValue = exports.KVS_SCOPE_DELIMITER = void 0;
 exports.composeScopedKvsValue = composeScopedKvsValue;
 exports.validateRawPkValueForScopeOrThrow = validateRawPkValueForScopeOrThrow;
 exports.stripScopedKvsValue = stripScopedKvsValue;
@@ -31,6 +31,24 @@ function composeScopedKvsValue(scope, rawValue) {
     validateRawPkValueForScopeOrThrow(rawValue);
     return `${scope}${exports.KVS_SCOPE_DELIMITER}${rawValue}`;
 }
+// The inverse of composeScopedKvsValue: split a stored partition key value back into the
+// scope it was written under and the caller's raw key.
+//
+// Needed by anything reading a RAW stored key rather than going through a scoped request.
+// Change data capture is the case that forced it: a stream record carries the composed pk,
+// and the consumer has to re-enter the same scope before it can act on the item. An
+// unscoped value has no delimiter and comes back with `scope: undefined`.
+const decomposeScopedKvsValue = (composedValue) => {
+    const at = composedValue.indexOf(exports.KVS_SCOPE_DELIMITER);
+    if (at < 0) {
+        return { rawValue: composedValue };
+    }
+    return {
+        scope: composedValue.slice(0, at),
+        rawValue: composedValue.slice(at + exports.KVS_SCOPE_DELIMITER.length),
+    };
+};
+exports.decomposeScopedKvsValue = decomposeScopedKvsValue;
 // The delimiter is reserved in scoped partition-key values: a raw value
 // carrying it would strip ambiguously and could collide with (or forge)
 // another scope's composed rows. File-partitioned backends call this directly

package/lib/commonjs/logic/scope/scopedKvsValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"scopedKvsValue.js","sourceRoot":"","sources":["../../../../src/logic/scope/scopedKvsValue.ts"],"names":[],"mappings":";;;AAeA,sDAcC;AAOD,8EAOC;AAKD,kDAOC;AAKD,8FAOC;AAMD,0EAMC;AAID,4EAQC;AA3FD,6DAA8G;AAC9G,2DAA+E;AAC/E,iEAA8D;AAE9D,+EAA+E;AAC/E,gFAAgF;AAChF,+EAA+E;AAC/E,0EAA0E;AAC1E,6EAA6E;AAC7E,SAAS;AACI,QAAA,mBAAmB,GAAG,cAAc,CAAC;AAElD,gGAAgG;AAChG,8EAA8E;AAC9E,4EAA4E;AAC5E,SAAgB,qBAAqB,CAAC,KAAyB,EAAE,QAAyB;IACxF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAA,2CAAoB,EAAC,KAAK,CAAC,CAAC;IAE5B,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,MAAM,IAAI,qCAAiB,CAAC,yCAAqB,CAAC,gBAAgB,EAAE,yDAAyD,CAAC,CAAC;IACjI,CAAC;IAED,iCAAiC,CAAC,QAAQ,CAAC,CAAC;IAE5C,OAAO,GAAG,KAAK,GAAG,2BAAmB,GAAG,QAAQ,EAAE,CAAC;AACrD,CAAC;AAED,wEAAwE;AACxE,wEAAwE;AACxE,8EAA8E;AAC9E,yEAAyE;AACzE,eAAe;AACf,SAAgB,iCAAiC,CAAC,QAAyB;IACzE,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,2BAAmB,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,qCAAiB,CACzB,yCAAqB,CAAC,iBAAiB,EACvC,8DAA8D,2BAAmB,IAAI,CACtF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,2EAA2E;AAC3E,8EAA8E;AAC9E,0DAA0D;AAC1D,SAAgB,mBAAmB,CAAC,KAAyB,EAAE,WAA4B;IACzF,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QAC3D,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,MAAM,GAAG,GAAG,KAAK,GAAG,2BAAmB,EAAE,CAAC;IAChD,OAAO,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;AACzF,CAAC;AAED,gFAAgF;AAChF,+EAA+E;AAC/E,gEAAgE;AAChE,SAAgB,yCAAyC,CAAC,gBAAwB;IAChF,IAAI,gBAAgB,KAAK,QAAQ,EAAE,CAAC;QAClC,MAAM,IAAI,qCAAiB,CACzB,yCAAqB,CAAC,gBAAgB,EACtC,uEAAuE,gBAAgB,KAAK,CAC7F,CAAC;IACJ,CAAC;AACH,CAAC;AAED,4EAA4E;AAC5E,gFAAgF;AAChF,6EAA6E;AAC7E,+BAA+B;AAC/B,SAAgB,+BAA+B,CAAC,eAAuB;IACrE,OAAO;QACL,GAAG,EAAE,eAAe;QACpB,SAAS,EAAE,6BAAqB,CAAC,WAAW;QAC5C,MAAM,EAAE,2BAAmB;KAC5B,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,4DAA4D;AAC5D,SAAgB,gCAAgC,CAAC,eAAuB,EAAE,KAAa;IACrF,IAAA,2CAAoB,EAAC,KAAK,CAAC,CAAC;IAE5B,OAAO;QACL,GAAG,EAAE,eAAe;QACpB,SAAS,EAAE,6BAAqB,CAAC,UAAU;QAC3C,MAAM,EAAE,GAAG,KAAK,GAAG,2BAAmB,EAAE;KACzC,CAAC;AACJ,CAAC","sourcesContent":["import { KvsCoreDataType, KvsQueryCondition, KvsQueryOperationType } from '../../actions/keyValueStore/types';\nimport { InvalidScopeError, InvalidScopeErrorCode } from './InvalidScopeError';\nimport { validateScopeSegment } from './validateScopeSegment';\n\n// The delimiter must never occur in legitimate partition key data, because raw\n// values carrying it are rejected outright (see below). '::' is unusable: it is\n// qpq's own function-runtime separator ('src/path::method') and appears inside\n// correlation ids, which the log service stores as partition keys. So the\n// delimiter is a loud qpq-namespaced sentinel instead of a short punctuation\n// token.\nexport const KVS_SCOPE_DELIMITER = '@@QPQSCOPE@@';\n\n// Compose a scope into a partition key value: `${scope}${KVS_SCOPE_DELIMITER}${rawValue}`. Only\n// string keys can carry a scope - a number/binary pk has nowhere to embed the\n// prefix, so scoping such a store is rejected rather than silently coerced.\nexport function composeScopedKvsValue(scope: string | undefined, rawValue: KvsCoreDataType): KvsCoreDataType {\n  if (scope === undefined) {\n    return rawValue;\n  }\n\n  validateScopeSegment(scope);\n\n  if (typeof rawValue !== 'string') {\n    throw new InvalidScopeError(InvalidScopeErrorCode.unsafeCharacters, 'Scope is only supported on string partition key values.');\n  }\n\n  validateRawPkValueForScopeOrThrow(rawValue);\n\n  return `${scope}${KVS_SCOPE_DELIMITER}${rawValue}`;\n}\n\n// The delimiter is reserved in scoped partition-key values: a raw value\n// carrying it would strip ambiguously and could collide with (or forge)\n// another scope's composed rows. File-partitioned backends call this directly\n// for parity - they store values raw, but a value prod rejects must fail\n// locally too.\nexport function validateRawPkValueForScopeOrThrow(rawValue: KvsCoreDataType): void {\n  if (typeof rawValue === 'string' && rawValue.includes(KVS_SCOPE_DELIMITER)) {\n    throw new InvalidScopeError(\n      InvalidScopeErrorCode.reservedDelimiter,\n      `Partition key values must not contain the scope delimiter '${KVS_SCOPE_DELIMITER}'.`,\n    );\n  }\n}\n\n// Undo composeScopedKvsValue on a value read back from storage, so callers\n// never see the composed form. A stored value that doesn't carry the expected\n// prefix is returned unchanged (it was written unscoped).\nexport function stripScopedKvsValue(scope: string | undefined, storedValue: KvsCoreDataType): KvsCoreDataType {\n  if (scope === undefined || typeof storedValue !== 'string') {\n    return storedValue;\n  }\n\n  const prefix = `${scope}${KVS_SCOPE_DELIMITER}`;\n  return storedValue.startsWith(prefix) ? storedValue.slice(prefix.length) : storedValue;\n}\n\n// Scope composes into the partition key's stored string value, so a store whose\n// partition key is number/binary-typed cannot be scoped at all - reject before\n// any read/write happens rather than silently matching nothing.\nexport function validateScopeSupportedForPartitionKeyType(partitionKeyType: string): void {\n  if (partitionKeyType !== 'string') {\n    throw new InvalidScopeError(\n      InvalidScopeErrorCode.unsafeCharacters,\n      `Scope is only supported on stores with a string partition key (got '${partitionKeyType}').`,\n    );\n  }\n}\n\n// The inverse guard for UNSCOPED Scan / GetAll on a value-composed backend:\n// exclude rows whose pk carries the scope delimiter, so unscoped listings never\n// leak other scopes' (composed) rows. File-partitioned backends get this for\n// free from the file boundary.\nexport function buildKvsScopeExclusionCondition(pkAttributeName: string): KvsQueryCondition {\n  return {\n    key: pkAttributeName,\n    operation: KvsQueryOperationType.NotContains,\n    valueA: KVS_SCOPE_DELIMITER,\n  };\n}\n\n// A begins-with predicate on the partition key attribute, for enforcing scope\n// on operations that have no key condition (Scan / GetAll).\nexport function buildKvsScopeBeginsWithCondition(pkAttributeName: string, scope: string): KvsQueryCondition {\n  validateScopeSegment(scope);\n\n  return {\n    key: pkAttributeName,\n    operation: KvsQueryOperationType.BeginsWith,\n    valueA: `${scope}${KVS_SCOPE_DELIMITER}`,\n  };\n}\n"]}
+{"version":3,"file":"scopedKvsValue.js","sourceRoot":"","sources":["../../../../src/logic/scope/scopedKvsValue.ts"],"names":[],"mappings":";;;AAeA,sDAcC;AA2BD,8EAOC;AAKD,kDAOC;AAKD,8FAOC;AAMD,0EAMC;AAID,4EAQC;AA/GD,6DAA8G;AAC9G,2DAA+E;AAC/E,iEAA8D;AAE9D,+EAA+E;AAC/E,gFAAgF;AAChF,+EAA+E;AAC/E,0EAA0E;AAC1E,6EAA6E;AAC7E,SAAS;AACI,QAAA,mBAAmB,GAAG,cAAc,CAAC;AAElD,gGAAgG;AAChG,8EAA8E;AAC9E,4EAA4E;AAC5E,SAAgB,qBAAqB,CAAC,KAAyB,EAAE,QAAyB;IACxF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAA,2CAAoB,EAAC,KAAK,CAAC,CAAC;IAE5B,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,MAAM,IAAI,qCAAiB,CAAC,yCAAqB,CAAC,gBAAgB,EAAE,yDAAyD,CAAC,CAAC;IACjI,CAAC;IAED,iCAAiC,CAAC,QAAQ,CAAC,CAAC;IAE5C,OAAO,GAAG,KAAK,GAAG,2BAAmB,GAAG,QAAQ,EAAE,CAAC;AACrD,CAAC;AAED,yFAAyF;AACzF,uDAAuD;AACvD,EAAE;AACF,0FAA0F;AAC1F,2FAA2F;AAC3F,oFAAoF;AACpF,0EAA0E;AACnE,MAAM,uBAAuB,GAAG,CAAC,aAAqB,EAAwC,EAAE;IACrG,MAAM,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,2BAAmB,CAAC,CAAC;IAEtD,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;IACrC,CAAC;IAED,OAAO;QACL,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;QACjC,QAAQ,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,GAAG,2BAAmB,CAAC,MAAM,CAAC;KAC/D,CAAC;AACJ,CAAC,CAAC;AAXW,QAAA,uBAAuB,2BAWlC;AAEF,wEAAwE;AACxE,wEAAwE;AACxE,8EAA8E;AAC9E,yEAAyE;AACzE,eAAe;AACf,SAAgB,iCAAiC,CAAC,QAAyB;IACzE,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,2BAAmB,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,qCAAiB,CACzB,yCAAqB,CAAC,iBAAiB,EACvC,8DAA8D,2BAAmB,IAAI,CACtF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,2EAA2E;AAC3E,8EAA8E;AAC9E,0DAA0D;AAC1D,SAAgB,mBAAmB,CAAC,KAAyB,EAAE,WAA4B;IACzF,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QAC3D,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,MAAM,GAAG,GAAG,KAAK,GAAG,2BAAmB,EAAE,CAAC;IAChD,OAAO,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;AACzF,CAAC;AAED,gFAAgF;AAChF,+EAA+E;AAC/E,gEAAgE;AAChE,SAAgB,yCAAyC,CAAC,gBAAwB;IAChF,IAAI,gBAAgB,KAAK,QAAQ,EAAE,CAAC;QAClC,MAAM,IAAI,qCAAiB,CACzB,yCAAqB,CAAC,gBAAgB,EACtC,uEAAuE,gBAAgB,KAAK,CAC7F,CAAC;IACJ,CAAC;AACH,CAAC;AAED,4EAA4E;AAC5E,gFAAgF;AAChF,6EAA6E;AAC7E,+BAA+B;AAC/B,SAAgB,+BAA+B,CAAC,eAAuB;IACrE,OAAO;QACL,GAAG,EAAE,eAAe;QACpB,SAAS,EAAE,6BAAqB,CAAC,WAAW;QAC5C,MAAM,EAAE,2BAAmB;KAC5B,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,4DAA4D;AAC5D,SAAgB,gCAAgC,CAAC,eAAuB,EAAE,KAAa;IACrF,IAAA,2CAAoB,EAAC,KAAK,CAAC,CAAC;IAE5B,OAAO;QACL,GAAG,EAAE,eAAe;QACpB,SAAS,EAAE,6BAAqB,CAAC,UAAU;QAC3C,MAAM,EAAE,GAAG,KAAK,GAAG,2BAAmB,EAAE;KACzC,CAAC;AACJ,CAAC","sourcesContent":["import { KvsCoreDataType, KvsQueryCondition, KvsQueryOperationType } from '../../actions/keyValueStore/types';\nimport { InvalidScopeError, InvalidScopeErrorCode } from './InvalidScopeError';\nimport { validateScopeSegment } from './validateScopeSegment';\n\n// The delimiter must never occur in legitimate partition key data, because raw\n// values carrying it are rejected outright (see below). '::' is unusable: it is\n// qpq's own function-runtime separator ('src/path::method') and appears inside\n// correlation ids, which the log service stores as partition keys. So the\n// delimiter is a loud qpq-namespaced sentinel instead of a short punctuation\n// token.\nexport const KVS_SCOPE_DELIMITER = '@@QPQSCOPE@@';\n\n// Compose a scope into a partition key value: `${scope}${KVS_SCOPE_DELIMITER}${rawValue}`. Only\n// string keys can carry a scope - a number/binary pk has nowhere to embed the\n// prefix, so scoping such a store is rejected rather than silently coerced.\nexport function composeScopedKvsValue(scope: string | undefined, rawValue: KvsCoreDataType): KvsCoreDataType {\n  if (scope === undefined) {\n    return rawValue;\n  }\n\n  validateScopeSegment(scope);\n\n  if (typeof rawValue !== 'string') {\n    throw new InvalidScopeError(InvalidScopeErrorCode.unsafeCharacters, 'Scope is only supported on string partition key values.');\n  }\n\n  validateRawPkValueForScopeOrThrow(rawValue);\n\n  return `${scope}${KVS_SCOPE_DELIMITER}${rawValue}`;\n}\n\n// The inverse of composeScopedKvsValue: split a stored partition key value back into the\n// scope it was written under and the caller's raw key.\n//\n// Needed by anything reading a RAW stored key rather than going through a scoped request.\n// Change data capture is the case that forced it: a stream record carries the composed pk,\n// and the consumer has to re-enter the same scope before it can act on the item. An\n// unscoped value has no delimiter and comes back with `scope: undefined`.\nexport const decomposeScopedKvsValue = (composedValue: string): { scope?: string; rawValue: string } => {\n  const at = composedValue.indexOf(KVS_SCOPE_DELIMITER);\n\n  if (at < 0) {\n    return { rawValue: composedValue };\n  }\n\n  return {\n    scope: composedValue.slice(0, at),\n    rawValue: composedValue.slice(at + KVS_SCOPE_DELIMITER.length),\n  };\n};\n\n// The delimiter is reserved in scoped partition-key values: a raw value\n// carrying it would strip ambiguously and could collide with (or forge)\n// another scope's composed rows. File-partitioned backends call this directly\n// for parity - they store values raw, but a value prod rejects must fail\n// locally too.\nexport function validateRawPkValueForScopeOrThrow(rawValue: KvsCoreDataType): void {\n  if (typeof rawValue === 'string' && rawValue.includes(KVS_SCOPE_DELIMITER)) {\n    throw new InvalidScopeError(\n      InvalidScopeErrorCode.reservedDelimiter,\n      `Partition key values must not contain the scope delimiter '${KVS_SCOPE_DELIMITER}'.`,\n    );\n  }\n}\n\n// Undo composeScopedKvsValue on a value read back from storage, so callers\n// never see the composed form. A stored value that doesn't carry the expected\n// prefix is returned unchanged (it was written unscoped).\nexport function stripScopedKvsValue(scope: string | undefined, storedValue: KvsCoreDataType): KvsCoreDataType {\n  if (scope === undefined || typeof storedValue !== 'string') {\n    return storedValue;\n  }\n\n  const prefix = `${scope}${KVS_SCOPE_DELIMITER}`;\n  return storedValue.startsWith(prefix) ? storedValue.slice(prefix.length) : storedValue;\n}\n\n// Scope composes into the partition key's stored string value, so a store whose\n// partition key is number/binary-typed cannot be scoped at all - reject before\n// any read/write happens rather than silently matching nothing.\nexport function validateScopeSupportedForPartitionKeyType(partitionKeyType: string): void {\n  if (partitionKeyType !== 'string') {\n    throw new InvalidScopeError(\n      InvalidScopeErrorCode.unsafeCharacters,\n      `Scope is only supported on stores with a string partition key (got '${partitionKeyType}').`,\n    );\n  }\n}\n\n// The inverse guard for UNSCOPED Scan / GetAll on a value-composed backend:\n// exclude rows whose pk carries the scope delimiter, so unscoped listings never\n// leak other scopes' (composed) rows. File-partitioned backends get this for\n// free from the file boundary.\nexport function buildKvsScopeExclusionCondition(pkAttributeName: string): KvsQueryCondition {\n  return {\n    key: pkAttributeName,\n    operation: KvsQueryOperationType.NotContains,\n    valueA: KVS_SCOPE_DELIMITER,\n  };\n}\n\n// A begins-with predicate on the partition key attribute, for enforcing scope\n// on operations that have no key condition (Scan / GetAll).\nexport function buildKvsScopeBeginsWithCondition(pkAttributeName: string, scope: string): KvsQueryCondition {\n  validateScopeSegment(scope);\n\n  return {\n    key: pkAttributeName,\n    operation: KvsQueryOperationType.BeginsWith,\n    valueA: `${scope}${KVS_SCOPE_DELIMITER}`,\n  };\n}\n"]}

package/lib/commonjs/types/KvsStreamEvent.d.ts

@@ -0,0 +1,14 @@
+export declare enum KvsStreamEventType {
+    Insert = "Insert",
+    Modify = "Modify",
+    Remove = "Remove"
+}
+export type KvsStreamRecord<TItem extends object = any> = {
+    keyValueStoreName: string;
+    eventType: KvsStreamEventType;
+    scope?: string;
+    keys: Record<string, unknown>;
+    newImage?: TItem;
+    oldImage?: TItem;
+};
+export type KvsStreamEventResponse = void;

package/lib/commonjs/types/KvsStreamEvent.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KvsStreamEventType = void 0;
+// One change to a key-value store item, delivered by the store's stream (see
+// defineKeyValueStore's `onStream`).
+//
+// The images are plain objects, not the storage layer's wire format: the action processor
+// unmarshals them, so a stream handler is ordinary story code and never sees a DynamoDB
+// AttributeValue. That also keeps handlers portable to a non-DynamoDB store.
+var KvsStreamEventType;
+(function (KvsStreamEventType) {
+    KvsStreamEventType["Insert"] = "Insert";
+    KvsStreamEventType["Modify"] = "Modify";
+    KvsStreamEventType["Remove"] = "Remove";
+})(KvsStreamEventType || (exports.KvsStreamEventType = KvsStreamEventType = {}));
+//# sourceMappingURL=KvsStreamEvent.js.map

package/lib/commonjs/types/KvsStreamEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KvsStreamEvent.js","sourceRoot":"","sources":["../../../src/types/KvsStreamEvent.ts"],"names":[],"mappings":";;;AAAA,6EAA6E;AAC7E,qCAAqC;AACrC,EAAE;AACF,0FAA0F;AAC1F,wFAAwF;AACxF,6EAA6E;AAC7E,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;AACnB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B","sourcesContent":["// One change to a key-value store item, delivered by the store's stream (see\n// defineKeyValueStore's `onStream`).\n//\n// The images are plain objects, not the storage layer's wire format: the action processor\n// unmarshals them, so a stream handler is ordinary story code and never sees a DynamoDB\n// AttributeValue. That also keeps handlers portable to a non-DynamoDB store.\nexport enum KvsStreamEventType {\n  Insert = 'Insert',\n  Modify = 'Modify',\n  Remove = 'Remove',\n}\n\nexport type KvsStreamRecord<TItem extends object = any> = {\n  keyValueStoreName: string;\n\n  eventType: KvsStreamEventType;\n\n  // The storage scope the item was written under; absent for an unscoped row.\n  //\n  // Scope is composed INTO the partition key value on the way to storage, so the raw stored\n  // key carries it. Every other read path hides that (the scoped translator strips it before\n  // a consumer ever sees it), and a stream record is the one place it would otherwise leak.\n  // Handing it back as its own field keeps that promise: a consumer re-enters the scope by\n  // reading this, instead of having to know the composition format and remember to undo it.\n  // Forgetting to would mean acting on one tenant's data while pointed at another's.\n  scope?: string;\n\n  // The item's key attributes only — always present, including on Remove. RAW: the scope has\n  // been stripped back out of the partition key, so these are the values the caller wrote.\n  keys: Record<string, unknown>;\n\n  // The item after the change, scope stripped like `keys`. Absent on Remove.\n  newImage?: TItem;\n\n  // The item before the change, scope stripped like `keys`. Absent on Insert.\n  oldImage?: TItem;\n};\n\n// Handlers are invoked per record, mirroring how storage drive and queue events are\n// dispatched. Ordering is guaranteed per partition key; records for different partition\n// keys may be processed concurrently.\nexport type KvsStreamEventResponse = void;\n"]}

package/lib/commonjs/types/StorySession.d.ts

@@ -72,6 +72,7 @@ export declare enum QpqRuntimeType {
     WEBSOCKET_EVENT = "WEBSOCKET_EVENT",
     DEPLOY_EVENT = "DEPLOY_EVENT",
     STORAGEDRIVE_EVENT = "STORAGEDRIVE_EVENT",
+    KVS_STREAM_EVENT = "KVS_STREAM_EVENT",
     CLOUD_FLARE_DEPLOY = "CLOUD_FLARE_DEPLOY",
     UNIT_TEST = "UNIT_TEST",
     UI = "UI",

package/lib/commonjs/types/StorySession.js

@@ -13,6 +13,7 @@ var QpqRuntimeType;
     QpqRuntimeType["WEBSOCKET_EVENT"] = "WEBSOCKET_EVENT";
     QpqRuntimeType["DEPLOY_EVENT"] = "DEPLOY_EVENT";
     QpqRuntimeType["STORAGEDRIVE_EVENT"] = "STORAGEDRIVE_EVENT";
+    QpqRuntimeType["KVS_STREAM_EVENT"] = "KVS_STREAM_EVENT";
     QpqRuntimeType["CLOUD_FLARE_DEPLOY"] = "CLOUD_FLARE_DEPLOY";
     QpqRuntimeType["UNIT_TEST"] = "UNIT_TEST";
     QpqRuntimeType["UI"] = "UI";

package/lib/commonjs/types/StorySession.js.map

@@ -1 +1 @@
-{"version":3,"file":"StorySession.js","sourceRoot":"","sources":["../../../src/types/StorySession.ts"],"names":[],"mappings":";;;AA8GA,IAAY,cAqBX;AArBD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,iDAA+B,CAAA;IAC/B,+EAA6D,CAAA;IAC7D,2DAAyC,CAAA;IACzC,6CAA2B,CAAA;IAC3B,+CAA6B,CAAA;IAC7B,+DAA6C,CAAA;IAC7C,qDAAmC,CAAA;IACnC,+CAA6B,CAAA;IAC7B,2DAAyC,CAAA;IACzC,2DAAyC,CAAA;IAEzC,yCAAuB,CAAA;IACvB,2BAAS,CAAA;IAET,uDAAqC,CAAA;IAErC,2EAAyD,CAAA;IACzD,2EAAyD,CAAA;IACzD,2EAAyD,CAAA;AAC3D,CAAC,EArBW,cAAc,8BAAd,cAAc,QAqBzB","sourcesContent":["import { Action } from './Action';\nimport { QPQError } from './ErrorTypeEnum';\nimport { QpqContext } from './QpqContextIdentifier';\nimport { QpqFunctionRuntime } from './QpqFunctionRuntime';\n\nexport interface DecodedAccessToken {\n  userId: string;\n  username: string;\n  // Unix timestamp (number of seconds since January 1, 1970 UTC).\n  exp: number;\n  roles?: string[];\n\n  userDirectory: string;\n  wasValid: boolean;\n}\n\nexport interface StorySession {\n  correlation?: string;\n  depth: number;\n\n  // This token is never transfer cross storys\n  // can't access it via events or anything\n  accessToken?: string;\n\n  // Decoded access token + roles token\n  decodedAccessToken?: DecodedAccessToken;\n\n  // Context\n  context: QpqContext<any>;\n\n  // Service-local context, this is never transferred across a service boundary\n  // (queue / event bus / service function), but does flow to in-process sub-runtimes.\n  localContext?: QpqContext<any>;\n\n  // Globals declared on the executing function's QpqFunctionRuntimeAdvanced.\n  // Set per-runtime from qpqFunctionRuntimeInfo; never inherited from the caller.\n  functionGlobals?: Record<string, unknown>;\n}\n\nexport type StorySessionUpdater = (newSession: Partial<StorySession>) => void;\n\nexport type AskResponse<T> = Generator<Action<any>, T, any>;\n\nexport type Story<TArgs extends any[], R> = (...args: TArgs) => AskResponse<R>;\nexport type StoryResolver = <S extends Story<any, any>>(story: S) => (...args: Parameters<S>) => Promise<AskResponseReturnType<ReturnType<S>>>;\n\n// function* test(msg: string): AskResponse<number> {\n//   return parseInt(msg);\n// }\n\n// function DoThing<S extends Story<any, any>>(story: S): (...args: Parameters<S>) => AskResponseReturnType<ReturnType<S>> {\n//   return (...args: Parameters<S>) => {\n//     return (() => {}) as any;\n//   };\n// }\n\n// const runTest = DoThing(test);\n// const num = runTest('a');\n\n/**\n * Utility Type: ExtractGeneratorReturnType\n *\n * This utility type is designed to extract the return type of a Generator without\n * conflating it with the types of values it may yield. Generators in TypeScript are\n * annotated as Generator<YieldType, ReturnType, NextType>, where YieldType is the\n * type of values yielded by the generator, ReturnType is the type the generator returns\n * when it's done, and NextType is the type of the value passed to the generator's `next` method.\n *\n * By leveraging TypeScript's conditional types and the `infer` keyword, ExtractGeneratorReturnType\n * can precisely capture and extract just the ReturnType of any given Generator, providing a clean,\n * type-safe way to understand what a generator ultimately returns upon completion.\n *\n * Usage of `infer` in Conditional Types:\n * The `infer` keyword is used here to declare a type variable R within the conditional type\n * expression. TypeScript will then infer the type R as the generator's ReturnType when the\n * condition `T extends Generator<any, infer R, any>` is met. This inference is based on the\n * actual type passed to ExtractGeneratorReturnType, allowing us to \"pull out\" the ReturnType\n * from within the Generator type.\n *\n * This approach is particularly useful because it directly targets the ReturnType without\n * having to manually sift through or exclude the types of values that might be yielded by\n * the generator, which can often be diverse and not relevant to the final return type we're\n * interested in capturing.\n *\n * The ExtractGeneratorReturnType utility type simplifies the extraction process and ensures\n * that types dependent on the return value of generators are accurately typed, enhancing\n * code readability and maintainability.\n */\n\nexport type ExtractGeneratorReturnType<T extends Generator> = T extends Generator<any, infer R, any> ? R : never;\n\n// Directly extracting the generator's return type for any given AskResponse.\n// By applying ExtractGeneratorReturnType to an AskResponse, we can determine the\n// precise type that the AskResponse generator returns, bypassing the complexities\n// of its yield types. This is particularly useful in scenarios where the return type\n// is distinct from the types of actions or values yielded by the generator, allowing\n// for clear type inference and usage in TypeScript codebases.\nexport type AskResponseReturnType<T extends AskResponse<any>> = ExtractGeneratorReturnType<T>;\n\n// Any generator function that returns an AskResponse\n// qpq runtimes are built on stories\nexport type qpqStory = <T = any>(...args: any[]) => AskResponse<T>;\n\nexport interface ActionHistory<P = any, R = any> {\n  act: Action<P>;\n  res: R;\n  startedAt: string;\n  finishedAt: string;\n}\n\nexport enum QpqRuntimeType {\n  API = 'API',\n  EXECUTE_STORY = 'EXECUTE_STORY',\n  EXECUTE_IMPLEMENTATION_STORY = 'EXECUTE_IMPLEMENTATION_STORY',\n  RECURRING_SCHEDULE = 'RECURRING_SCHEDULE',\n  QUEUE_EVENT = 'QUEUE_EVENT',\n  EVENT_SEO_OR = 'EVENT_SEO_OR',\n  SERVICE_FUNCTION_EXE = 'SERVICE_FUNCTION_EXE',\n  WEBSOCKET_EVENT = 'WEBSOCKET_EVENT',\n  DEPLOY_EVENT = 'DEPLOY_EVENT',\n  STORAGEDRIVE_EVENT = 'STORAGEDRIVE_EVENT',\n  CLOUD_FLARE_DEPLOY = 'CLOUD_FLARE_DEPLOY',\n\n  UNIT_TEST = 'UNIT_TEST',\n  UI = 'UI',\n\n  SEND_EMAIL_EVENT = 'SEND_EMAIL_EVENT',\n\n  AUTH_DEFINE_AUTH_CHALLENGE = 'AUTH_DEFINE_AUTH_CHALLENGE',\n  AUTH_CREATE_AUTH_CHALLENGE = 'AUTH_CREATE_AUTH_CHALLENGE',\n  AUTH_VERIFY_AUTH_CHALLENGE = 'AUTH_VERIFY_AUTH_CHALLENGE',\n}\n\nexport interface qpqConsoleLog {\n  t: string;\n  a: any[];\n}\n\nexport interface StoryResult<TArgs extends Array<any>, TResult = any> {\n  // Params to story\n  input: TArgs;\n\n  // Story Session Data\n  session: StorySession;\n\n  // History of actions\n  history: ActionHistory[];\n\n  // When the story started / finished\n  startedAt: string;\n  finishedAt: string;\n\n  // correlationGuid from the calling story\n  fromCorrelation?: string;\n\n  // correlation for this story (correlates all actions together)\n  correlation: string;\n\n  // For logging, tags to help identify the story\n  tags: string[];\n  moduleName: string;\n\n  // Result of the story result or error not both\n  result?: TResult;\n  error?: QPQError;\n\n  // User specified runtime type\n  runtimeType: QpqRuntimeType;\n\n  // Impure Logs\n  logs?: qpqConsoleLog[];\n\n  // What was the function runtime that this was executed against\n  qpqFunctionRuntimeInfo?: QpqFunctionRuntime;\n}\n\nexport type StoryResultMetadata = {\n  correlation: string;\n  fromCorrelation?: string;\n\n  moduleName: string;\n  runtimeType: QpqRuntimeType;\n\n  startedAt: string;\n\n  generic: string;\n\n  error?: string;\n\n  executionTimeMs: number;\n\n  userInfo?: string;\n\n  qpqFunctionRuntimeInfo?: QpqFunctionRuntime;\n};\n\nexport type StoryResultMetadataWithChildren = StoryResultMetadata & {\n  children: StoryResultMetadataWithChildren[];\n};\n"]}
+{"version":3,"file":"StorySession.js","sourceRoot":"","sources":["../../../src/types/StorySession.ts"],"names":[],"mappings":";;;AA8GA,IAAY,cAsBX;AAtBD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,iDAA+B,CAAA;IAC/B,+EAA6D,CAAA;IAC7D,2DAAyC,CAAA;IACzC,6CAA2B,CAAA;IAC3B,+CAA6B,CAAA;IAC7B,+DAA6C,CAAA;IAC7C,qDAAmC,CAAA;IACnC,+CAA6B,CAAA;IAC7B,2DAAyC,CAAA;IACzC,uDAAqC,CAAA;IACrC,2DAAyC,CAAA;IAEzC,yCAAuB,CAAA;IACvB,2BAAS,CAAA;IAET,uDAAqC,CAAA;IAErC,2EAAyD,CAAA;IACzD,2EAAyD,CAAA;IACzD,2EAAyD,CAAA;AAC3D,CAAC,EAtBW,cAAc,8BAAd,cAAc,QAsBzB","sourcesContent":["import { Action } from './Action';\nimport { QPQError } from './ErrorTypeEnum';\nimport { QpqContext } from './QpqContextIdentifier';\nimport { QpqFunctionRuntime } from './QpqFunctionRuntime';\n\nexport interface DecodedAccessToken {\n  userId: string;\n  username: string;\n  // Unix timestamp (number of seconds since January 1, 1970 UTC).\n  exp: number;\n  roles?: string[];\n\n  userDirectory: string;\n  wasValid: boolean;\n}\n\nexport interface StorySession {\n  correlation?: string;\n  depth: number;\n\n  // This token is never transfer cross storys\n  // can't access it via events or anything\n  accessToken?: string;\n\n  // Decoded access token + roles token\n  decodedAccessToken?: DecodedAccessToken;\n\n  // Context\n  context: QpqContext<any>;\n\n  // Service-local context, this is never transferred across a service boundary\n  // (queue / event bus / service function), but does flow to in-process sub-runtimes.\n  localContext?: QpqContext<any>;\n\n  // Globals declared on the executing function's QpqFunctionRuntimeAdvanced.\n  // Set per-runtime from qpqFunctionRuntimeInfo; never inherited from the caller.\n  functionGlobals?: Record<string, unknown>;\n}\n\nexport type StorySessionUpdater = (newSession: Partial<StorySession>) => void;\n\nexport type AskResponse<T> = Generator<Action<any>, T, any>;\n\nexport type Story<TArgs extends any[], R> = (...args: TArgs) => AskResponse<R>;\nexport type StoryResolver = <S extends Story<any, any>>(story: S) => (...args: Parameters<S>) => Promise<AskResponseReturnType<ReturnType<S>>>;\n\n// function* test(msg: string): AskResponse<number> {\n//   return parseInt(msg);\n// }\n\n// function DoThing<S extends Story<any, any>>(story: S): (...args: Parameters<S>) => AskResponseReturnType<ReturnType<S>> {\n//   return (...args: Parameters<S>) => {\n//     return (() => {}) as any;\n//   };\n// }\n\n// const runTest = DoThing(test);\n// const num = runTest('a');\n\n/**\n * Utility Type: ExtractGeneratorReturnType\n *\n * This utility type is designed to extract the return type of a Generator without\n * conflating it with the types of values it may yield. Generators in TypeScript are\n * annotated as Generator<YieldType, ReturnType, NextType>, where YieldType is the\n * type of values yielded by the generator, ReturnType is the type the generator returns\n * when it's done, and NextType is the type of the value passed to the generator's `next` method.\n *\n * By leveraging TypeScript's conditional types and the `infer` keyword, ExtractGeneratorReturnType\n * can precisely capture and extract just the ReturnType of any given Generator, providing a clean,\n * type-safe way to understand what a generator ultimately returns upon completion.\n *\n * Usage of `infer` in Conditional Types:\n * The `infer` keyword is used here to declare a type variable R within the conditional type\n * expression. TypeScript will then infer the type R as the generator's ReturnType when the\n * condition `T extends Generator<any, infer R, any>` is met. This inference is based on the\n * actual type passed to ExtractGeneratorReturnType, allowing us to \"pull out\" the ReturnType\n * from within the Generator type.\n *\n * This approach is particularly useful because it directly targets the ReturnType without\n * having to manually sift through or exclude the types of values that might be yielded by\n * the generator, which can often be diverse and not relevant to the final return type we're\n * interested in capturing.\n *\n * The ExtractGeneratorReturnType utility type simplifies the extraction process and ensures\n * that types dependent on the return value of generators are accurately typed, enhancing\n * code readability and maintainability.\n */\n\nexport type ExtractGeneratorReturnType<T extends Generator> = T extends Generator<any, infer R, any> ? R : never;\n\n// Directly extracting the generator's return type for any given AskResponse.\n// By applying ExtractGeneratorReturnType to an AskResponse, we can determine the\n// precise type that the AskResponse generator returns, bypassing the complexities\n// of its yield types. This is particularly useful in scenarios where the return type\n// is distinct from the types of actions or values yielded by the generator, allowing\n// for clear type inference and usage in TypeScript codebases.\nexport type AskResponseReturnType<T extends AskResponse<any>> = ExtractGeneratorReturnType<T>;\n\n// Any generator function that returns an AskResponse\n// qpq runtimes are built on stories\nexport type qpqStory = <T = any>(...args: any[]) => AskResponse<T>;\n\nexport interface ActionHistory<P = any, R = any> {\n  act: Action<P>;\n  res: R;\n  startedAt: string;\n  finishedAt: string;\n}\n\nexport enum QpqRuntimeType {\n  API = 'API',\n  EXECUTE_STORY = 'EXECUTE_STORY',\n  EXECUTE_IMPLEMENTATION_STORY = 'EXECUTE_IMPLEMENTATION_STORY',\n  RECURRING_SCHEDULE = 'RECURRING_SCHEDULE',\n  QUEUE_EVENT = 'QUEUE_EVENT',\n  EVENT_SEO_OR = 'EVENT_SEO_OR',\n  SERVICE_FUNCTION_EXE = 'SERVICE_FUNCTION_EXE',\n  WEBSOCKET_EVENT = 'WEBSOCKET_EVENT',\n  DEPLOY_EVENT = 'DEPLOY_EVENT',\n  STORAGEDRIVE_EVENT = 'STORAGEDRIVE_EVENT',\n  KVS_STREAM_EVENT = 'KVS_STREAM_EVENT',\n  CLOUD_FLARE_DEPLOY = 'CLOUD_FLARE_DEPLOY',\n\n  UNIT_TEST = 'UNIT_TEST',\n  UI = 'UI',\n\n  SEND_EMAIL_EVENT = 'SEND_EMAIL_EVENT',\n\n  AUTH_DEFINE_AUTH_CHALLENGE = 'AUTH_DEFINE_AUTH_CHALLENGE',\n  AUTH_CREATE_AUTH_CHALLENGE = 'AUTH_CREATE_AUTH_CHALLENGE',\n  AUTH_VERIFY_AUTH_CHALLENGE = 'AUTH_VERIFY_AUTH_CHALLENGE',\n}\n\nexport interface qpqConsoleLog {\n  t: string;\n  a: any[];\n}\n\nexport interface StoryResult<TArgs extends Array<any>, TResult = any> {\n  // Params to story\n  input: TArgs;\n\n  // Story Session Data\n  session: StorySession;\n\n  // History of actions\n  history: ActionHistory[];\n\n  // When the story started / finished\n  startedAt: string;\n  finishedAt: string;\n\n  // correlationGuid from the calling story\n  fromCorrelation?: string;\n\n  // correlation for this story (correlates all actions together)\n  correlation: string;\n\n  // For logging, tags to help identify the story\n  tags: string[];\n  moduleName: string;\n\n  // Result of the story result or error not both\n  result?: TResult;\n  error?: QPQError;\n\n  // User specified runtime type\n  runtimeType: QpqRuntimeType;\n\n  // Impure Logs\n  logs?: qpqConsoleLog[];\n\n  // What was the function runtime that this was executed against\n  qpqFunctionRuntimeInfo?: QpqFunctionRuntime;\n}\n\nexport type StoryResultMetadata = {\n  correlation: string;\n  fromCorrelation?: string;\n\n  moduleName: string;\n  runtimeType: QpqRuntimeType;\n\n  startedAt: string;\n\n  generic: string;\n\n  error?: string;\n\n  executionTimeMs: number;\n\n  userInfo?: string;\n\n  qpqFunctionRuntimeInfo?: QpqFunctionRuntime;\n};\n\nexport type StoryResultMetadataWithChildren = StoryResultMetadata & {\n  children: StoryResultMetadataWithChildren[];\n};\n"]}

package/lib/commonjs/types/index.d.ts

@@ -13,6 +13,7 @@ export * from './EventMessage';
 export * from './ExcludeKeys';
 export * from './FullyQualifiedResource';
 export * from './KeyOf';
+export * from './KvsStreamEvent';
 export * from './LogLevelEnum';
 export * from './Lookup';
 export * from './NotifyErrorQueueEvent';

package/lib/commonjs/types/index.js

@@ -29,6 +29,7 @@ __exportStar(require("./EventMessage"), exports);
 __exportStar(require("./ExcludeKeys"), exports);
 __exportStar(require("./FullyQualifiedResource"), exports);
 __exportStar(require("./KeyOf"), exports);
+__exportStar(require("./KvsStreamEvent"), exports);
 __exportStar(require("./LogLevelEnum"), exports);
 __exportStar(require("./Lookup"), exports);
 __exportStar(require("./NotifyErrorQueueEvent"), exports);

package/lib/commonjs/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,kDAAgC;AAChC,oDAAkC;AAClC,wDAAsC;AACtC,uDAAqC;AACrC,qDAAmC;AACnC,6DAA2C;AAC3C,qDAAmC;AACnC,gDAA8B;AAC9B,wDAAsC;AACtC,kDAAgC;AAChC,iDAA+B;AAC/B,gDAA8B;AAC9B,2DAAyC;AACzC,0CAAwB;AACxB,iDAA+B;AAC/B,2CAAyB;AACzB,0DAAwC;AACxC,6CAA2B;AAC3B,kDAAgC;AAChC,yDAAuC;AACvC,sDAAoC;AACpC,uDAAqC;AACrC,mDAAiC;AACjC,8CAA4B;AAC5B,iDAA+B;AAC/B,+CAA6B;AAC7B,gDAA8B;AAC9B,mDAAiC;AACjC,iDAA+B;AAC/B,mDAAiC;AACjC,sDAAoC;AACpC,wDAAsC;AACtC,0CAAwB","sourcesContent":["export * from './Action';\nexport * from './authChallenge';\nexport * from './BoundLogicStory';\nexport * from './ConfigUrlDefinition';\nexport * from './CrossModuleMessage';\nexport * from './CrossModuleOwner';\nexport * from './CrossServiceResourceName';\nexport * from './DecomposedString';\nexport * from './DeployEvent';\nexport * from './DynamicModuleLoader';\nexport * from './ErrorTypeEnum';\nexport * from './EventMessage';\nexport * from './ExcludeKeys';\nexport * from './FullyQualifiedResource';\nexport * from './KeyOf';\nexport * from './LogLevelEnum';\nexport * from './Lookup';\nexport * from './NotifyErrorQueueEvent';\nexport * from './Nullable';\nexport * from './QPQBinaryData';\nexport * from './QpqContextIdentifier';\nexport * from './QpqExecutionTrace';\nexport * from './QpqFunctionRuntime';\nexport * from './QpqIsoDateTime';\nexport * from './QpqLogger';\nexport * from './QpqPagedData';\nexport * from './QueueEvent';\nexport * from './Readonlyify';\nexport * from './ScheduledEvent';\nexport * from './StorySession';\nexport * from './StreamRegistry';\nexport * from './UnboundLogicStory';\nexport * from './UnionToIntersection';\nexport * from './utils';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,kDAAgC;AAChC,oDAAkC;AAClC,wDAAsC;AACtC,uDAAqC;AACrC,qDAAmC;AACnC,6DAA2C;AAC3C,qDAAmC;AACnC,gDAA8B;AAC9B,wDAAsC;AACtC,kDAAgC;AAChC,iDAA+B;AAC/B,gDAA8B;AAC9B,2DAAyC;AACzC,0CAAwB;AACxB,mDAAiC;AACjC,iDAA+B;AAC/B,2CAAyB;AACzB,0DAAwC;AACxC,6CAA2B;AAC3B,kDAAgC;AAChC,yDAAuC;AACvC,sDAAoC;AACpC,uDAAqC;AACrC,mDAAiC;AACjC,8CAA4B;AAC5B,iDAA+B;AAC/B,+CAA6B;AAC7B,gDAA8B;AAC9B,mDAAiC;AACjC,iDAA+B;AAC/B,mDAAiC;AACjC,sDAAoC;AACpC,wDAAsC;AACtC,0CAAwB","sourcesContent":["export * from './Action';\nexport * from './authChallenge';\nexport * from './BoundLogicStory';\nexport * from './ConfigUrlDefinition';\nexport * from './CrossModuleMessage';\nexport * from './CrossModuleOwner';\nexport * from './CrossServiceResourceName';\nexport * from './DecomposedString';\nexport * from './DeployEvent';\nexport * from './DynamicModuleLoader';\nexport * from './ErrorTypeEnum';\nexport * from './EventMessage';\nexport * from './ExcludeKeys';\nexport * from './FullyQualifiedResource';\nexport * from './KeyOf';\nexport * from './KvsStreamEvent';\nexport * from './LogLevelEnum';\nexport * from './Lookup';\nexport * from './NotifyErrorQueueEvent';\nexport * from './Nullable';\nexport * from './QPQBinaryData';\nexport * from './QpqContextIdentifier';\nexport * from './QpqExecutionTrace';\nexport * from './QpqFunctionRuntime';\nexport * from './QpqIsoDateTime';\nexport * from './QpqLogger';\nexport * from './QpqPagedData';\nexport * from './QueueEvent';\nexport * from './Readonlyify';\nexport * from './ScheduledEvent';\nexport * from './StorySession';\nexport * from './StreamRegistry';\nexport * from './UnboundLogicStory';\nexport * from './UnionToIntersection';\nexport * from './utils';\n"]}

package/lib/esm/actions/keyValueStore/KeyValueStoreActionType.d.ts

@@ -5,5 +5,6 @@ export declare enum KeyValueStoreActionType {
     Delete = "@quidproquo-core/KeyValueStore/Delete",
     Update = "@quidproquo-core/KeyValueStore/Update",
     Query = "@quidproquo-core/KeyValueStore/Query",
-    Scan = "@quidproquo-core/KeyValueStore/Scan"
+    Scan = "@quidproquo-core/KeyValueStore/Scan",
+    ScanAllScopes = "@quidproquo-core/KeyValueStore/ScanAllScopes"
 }

package/lib/esm/actions/keyValueStore/KeyValueStoreActionType.js

@@ -7,5 +7,6 @@ export var KeyValueStoreActionType;
     KeyValueStoreActionType["Update"] = "@quidproquo-core/KeyValueStore/Update";
     KeyValueStoreActionType["Query"] = "@quidproquo-core/KeyValueStore/Query";
     KeyValueStoreActionType["Scan"] = "@quidproquo-core/KeyValueStore/Scan";
+    KeyValueStoreActionType["ScanAllScopes"] = "@quidproquo-core/KeyValueStore/ScanAllScopes";
 })(KeyValueStoreActionType || (KeyValueStoreActionType = {}));
 //# sourceMappingURL=KeyValueStoreActionType.js.map

package/lib/esm/actions/keyValueStore/KeyValueStoreActionType.js.map

@@ -1 +1 @@
-{"version":3,"file":"KeyValueStoreActionType.js","sourceRoot":"","sources":["../../../../src/actions/keyValueStore/KeyValueStoreActionType.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,uBAQX;AARD,WAAY,uBAAuB;IACjC,2EAAgD,CAAA;IAChD,qEAA0C,CAAA;IAC1C,2EAAgD,CAAA;IAChD,2EAAgD,CAAA;IAChD,2EAAgD,CAAA;IAChD,yEAA8C,CAAA;IAC9C,uEAA4C,CAAA;AAC9C,CAAC,EARW,uBAAuB,KAAvB,uBAAuB,QAQlC","sourcesContent":["export enum KeyValueStoreActionType {\n  Upsert = '@quidproquo-core/KeyValueStore/Upsert',\n  Get = '@quidproquo-core/KeyValueStore/Get',\n  GetAll = '@quidproquo-core/KeyValueStore/GetAll',\n  Delete = '@quidproquo-core/KeyValueStore/Delete',\n  Update = '@quidproquo-core/KeyValueStore/Update',\n  Query = '@quidproquo-core/KeyValueStore/Query',\n  Scan = '@quidproquo-core/KeyValueStore/Scan',\n}\n"]}
+{"version":3,"file":"KeyValueStoreActionType.js","sourceRoot":"","sources":["../../../../src/actions/keyValueStore/KeyValueStoreActionType.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,uBASX;AATD,WAAY,uBAAuB;IACjC,2EAAgD,CAAA;IAChD,qEAA0C,CAAA;IAC1C,2EAAgD,CAAA;IAChD,2EAAgD,CAAA;IAChD,2EAAgD,CAAA;IAChD,yEAA8C,CAAA;IAC9C,uEAA4C,CAAA;IAC5C,yFAA8D,CAAA;AAChE,CAAC,EATW,uBAAuB,KAAvB,uBAAuB,QASlC","sourcesContent":["export enum KeyValueStoreActionType {\n  Upsert = '@quidproquo-core/KeyValueStore/Upsert',\n  Get = '@quidproquo-core/KeyValueStore/Get',\n  GetAll = '@quidproquo-core/KeyValueStore/GetAll',\n  Delete = '@quidproquo-core/KeyValueStore/Delete',\n  Update = '@quidproquo-core/KeyValueStore/Update',\n  Query = '@quidproquo-core/KeyValueStore/Query',\n  Scan = '@quidproquo-core/KeyValueStore/Scan',\n  ScanAllScopes = '@quidproquo-core/KeyValueStore/ScanAllScopes',\n}\n"]}

package/lib/esm/actions/keyValueStore/KeyValueStoreScanAllScopesActionRequester.d.ts

@@ -0,0 +1,32 @@
+import { KeyValueStoreScanAllScopesActionRequester, KeyValueStoreScanAllScopesOptions } from './KeyValueStoreScanAllScopesActionTypes';
+import { KvsQueryOperation } from './types';
+export declare const KeyValueStoreScanAllScopesErrorTypeEnum: {
+    ResourceNotFound: string;
+    ServiceUnavailable: string;
+    StoreNotFound: string;
+};
+/**
+ * Read EVERY row in a store, across every scope, each paired with the scope it lives under.
+ *
+ * This deliberately crosses the tenant boundary that the rest of the KVS layer works hard to
+ * hold. An ordinary unscoped Scan cannot see scoped rows at all: the translator ANDs on a
+ * predicate that excludes them, precisely so one tenant's request can never read another's.
+ * That is the right default and nothing about it changes.
+ *
+ * The exception exists for MIGRATIONS, where the job is "rewrite every row" and any row you
+ * cannot see is data you silently leave behind. The alternative is asking the app to
+ * enumerate its own tenants and loop, which fails quietly the moment that list is incomplete.
+ *
+ * So: reach for this only from a migration or an equivalent whole-store operation, never on a
+ * request path. Nothing in the framework calls it, and a caller with a user's request in hand
+ * has no business using it — scope is what keeps tenants apart, and this steps over it.
+ *
+ * The scope comes back per row rather than being discarded, so a caller can write each row
+ * back where it came from.
+ *
+ * DRAIN THE PAGE KEY: loop until `nextPageKey` comes back undefined. Every backend pages,
+ * including the local one, deliberately so — a backend that returned everything in one call
+ * would let a caller stop after the first page, be right locally, and silently skip most of
+ * the data deployed. A local run has to be able to prove the loop.
+ */
+export declare function askKeyValueStoreScanAllScopes<KvsItem>(keyValueStoreName: string, filterCondition?: KvsQueryOperation, nextPageKey?: string, options?: KeyValueStoreScanAllScopesOptions): KeyValueStoreScanAllScopesActionRequester<KvsItem>;

package/lib/esm/actions/keyValueStore/KeyValueStoreScanAllScopesActionRequester.js

@@ -0,0 +1,43 @@
+import { createErrorEnumForAction } from '../../types';
+import { KeyValueStoreActionType } from './KeyValueStoreActionType';
+export const KeyValueStoreScanAllScopesErrorTypeEnum = createErrorEnumForAction(KeyValueStoreActionType.ScanAllScopes, [
+    'ServiceUnavailable', // DynamoDB internal error / throttling
+    'ResourceNotFound', // the underlying table does not exist
+    'StoreNotFound', // the store is not declared in the qpq config (misconfiguration)
+]);
+/**
+ * Read EVERY row in a store, across every scope, each paired with the scope it lives under.
+ *
+ * This deliberately crosses the tenant boundary that the rest of the KVS layer works hard to
+ * hold. An ordinary unscoped Scan cannot see scoped rows at all: the translator ANDs on a
+ * predicate that excludes them, precisely so one tenant's request can never read another's.
+ * That is the right default and nothing about it changes.
+ *
+ * The exception exists for MIGRATIONS, where the job is "rewrite every row" and any row you
+ * cannot see is data you silently leave behind. The alternative is asking the app to
+ * enumerate its own tenants and loop, which fails quietly the moment that list is incomplete.
+ *
+ * So: reach for this only from a migration or an equivalent whole-store operation, never on a
+ * request path. Nothing in the framework calls it, and a caller with a user's request in hand
+ * has no business using it — scope is what keeps tenants apart, and this steps over it.
+ *
+ * The scope comes back per row rather than being discarded, so a caller can write each row
+ * back where it came from.
+ *
+ * DRAIN THE PAGE KEY: loop until `nextPageKey` comes back undefined. Every backend pages,
+ * including the local one, deliberately so — a backend that returned everything in one call
+ * would let a caller stop after the first page, be right locally, and silently skip most of
+ * the data deployed. A local run has to be able to prove the loop.
+ */
+export function* askKeyValueStoreScanAllScopes(keyValueStoreName, filterCondition, nextPageKey, options) {
+    return yield {
+        type: KeyValueStoreActionType.ScanAllScopes,
+        payload: {
+            keyValueStoreName,
+            filterCondition,
+            nextPageKey,
+            options,
+        },
+    };
+}
+//# sourceMappingURL=KeyValueStoreScanAllScopesActionRequester.js.map

package/lib/esm/actions/keyValueStore/KeyValueStoreScanAllScopesActionRequester.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyValueStoreScanAllScopesActionRequester.js","sourceRoot":"","sources":["../../../../src/actions/keyValueStore/KeyValueStoreScanAllScopesActionRequester.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAIpE,MAAM,CAAC,MAAM,uCAAuC,GAAG,wBAAwB,CAAC,uBAAuB,CAAC,aAAa,EAAE;IACrH,oBAAoB,EAAE,uCAAuC;IAC7D,kBAAkB,EAAE,sCAAsC;IAC1D,eAAe,EAAE,iEAAiE;CACnF,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,SAAS,CAAC,CAAC,6BAA6B,CAC5C,iBAAyB,EACzB,eAAmC,EACnC,WAAoB,EACpB,OAA2C;IAE3C,OAAO,MAAM;QACX,IAAI,EAAE,uBAAuB,CAAC,aAAa;QAC3C,OAAO,EAAE;YACP,iBAAiB;YAEjB,eAAe;YAEf,WAAW;YAEX,OAAO;SACR;KACF,CAAC;AACJ,CAAC","sourcesContent":["import { createErrorEnumForAction } from '../../types';\nimport { KeyValueStoreActionType } from './KeyValueStoreActionType';\nimport { KeyValueStoreScanAllScopesActionRequester, KeyValueStoreScanAllScopesOptions } from './KeyValueStoreScanAllScopesActionTypes';\nimport { KvsQueryOperation } from './types';\n\nexport const KeyValueStoreScanAllScopesErrorTypeEnum = createErrorEnumForAction(KeyValueStoreActionType.ScanAllScopes, [\n  'ServiceUnavailable', // DynamoDB internal error / throttling\n  'ResourceNotFound', // the underlying table does not exist\n  'StoreNotFound', // the store is not declared in the qpq config (misconfiguration)\n]);\n\n/**\n * Read EVERY row in a store, across every scope, each paired with the scope it lives under.\n *\n * This deliberately crosses the tenant boundary that the rest of the KVS layer works hard to\n * hold. An ordinary unscoped Scan cannot see scoped rows at all: the translator ANDs on a\n * predicate that excludes them, precisely so one tenant's request can never read another's.\n * That is the right default and nothing about it changes.\n *\n * The exception exists for MIGRATIONS, where the job is \"rewrite every row\" and any row you\n * cannot see is data you silently leave behind. The alternative is asking the app to\n * enumerate its own tenants and loop, which fails quietly the moment that list is incomplete.\n *\n * So: reach for this only from a migration or an equivalent whole-store operation, never on a\n * request path. Nothing in the framework calls it, and a caller with a user's request in hand\n * has no business using it — scope is what keeps tenants apart, and this steps over it.\n *\n * The scope comes back per row rather than being discarded, so a caller can write each row\n * back where it came from.\n *\n * DRAIN THE PAGE KEY: loop until `nextPageKey` comes back undefined. Every backend pages,\n * including the local one, deliberately so — a backend that returned everything in one call\n * would let a caller stop after the first page, be right locally, and silently skip most of\n * the data deployed. A local run has to be able to prove the loop.\n */\nexport function* askKeyValueStoreScanAllScopes<KvsItem>(\n  keyValueStoreName: string,\n  filterCondition?: KvsQueryOperation,\n  nextPageKey?: string,\n  options?: KeyValueStoreScanAllScopesOptions,\n): KeyValueStoreScanAllScopesActionRequester<KvsItem> {\n  return yield {\n    type: KeyValueStoreActionType.ScanAllScopes,\n    payload: {\n      keyValueStoreName,\n\n      filterCondition,\n\n      nextPageKey,\n\n      options,\n    },\n  };\n}\n"]}

package/lib/esm/actions/keyValueStore/KeyValueStoreScanAllScopesActionTypes.d.ts

@@ -0,0 +1,23 @@
+import { QpqPagedData } from '../../types';
+import { Action, ActionProcessor, ActionRequester } from '../../types/Action';
+import { KeyValueStoreActionType } from './KeyValueStoreActionType';
+import { KvsQueryOperation } from './types';
+export type KvsScopedItem<KvsItem> = {
+    scope?: string;
+    item: KvsItem;
+};
+export interface KeyValueStoreScanAllScopesOptions {
+    limit?: number;
+}
+export interface KeyValueStoreScanAllScopesActionPayload {
+    keyValueStoreName: string;
+    filterCondition?: KvsQueryOperation;
+    nextPageKey?: string;
+    options?: KeyValueStoreScanAllScopesOptions;
+}
+export interface KeyValueStoreScanAllScopesAction extends Action<KeyValueStoreScanAllScopesActionPayload> {
+    type: KeyValueStoreActionType.ScanAllScopes;
+    payload: KeyValueStoreScanAllScopesActionPayload;
+}
+export type KeyValueStoreScanAllScopesActionProcessor<KvsItem> = ActionProcessor<KeyValueStoreScanAllScopesAction, QpqPagedData<KvsScopedItem<KvsItem>>>;
+export type KeyValueStoreScanAllScopesActionRequester<KvsItem> = ActionRequester<KeyValueStoreScanAllScopesAction, QpqPagedData<KvsScopedItem<KvsItem>>>;

package/lib/esm/actions/keyValueStore/KeyValueStoreScanAllScopesActionTypes.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=KeyValueStoreScanAllScopesActionTypes.js.map

package/lib/esm/actions/keyValueStore/KeyValueStoreScanAllScopesActionTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyValueStoreScanAllScopesActionTypes.js","sourceRoot":"","sources":["../../../../src/actions/keyValueStore/KeyValueStoreScanAllScopesActionTypes.ts"],"names":[],"mappings":"","sourcesContent":["import { QpqPagedData } from '../../types';\nimport { Action, ActionProcessor, ActionRequester } from '../../types/Action';\nimport { KeyValueStoreActionType } from './KeyValueStoreActionType';\nimport { KvsQueryOperation } from './types';\n\n// One row and the scope it lives under. `scope` is absent for an unscoped row.\n//\n// The scope is reported rather than dropped BECAUSE this crosses scopes: a caller that reads\n// every tenant's rows in one pass has to know which tenant each belongs to, or anything it\n// writes back lands in the wrong partition. Handing back bare items would make silent\n// cross-tenant corruption the easy mistake.\nexport type KvsScopedItem<KvsItem> = {\n  scope?: string;\n  item: KvsItem;\n};\n\n// Options Type\nexport interface KeyValueStoreScanAllScopesOptions {\n  limit?: number;\n}\n\n// Payload\nexport interface KeyValueStoreScanAllScopesActionPayload {\n  keyValueStoreName: string;\n\n  filterCondition?: KvsQueryOperation;\n\n  nextPageKey?: string;\n\n  options?: KeyValueStoreScanAllScopesOptions;\n}\n\n// Action\nexport interface KeyValueStoreScanAllScopesAction extends Action<KeyValueStoreScanAllScopesActionPayload> {\n  type: KeyValueStoreActionType.ScanAllScopes;\n  payload: KeyValueStoreScanAllScopesActionPayload;\n}\n\n// Function Types\nexport type KeyValueStoreScanAllScopesActionProcessor<KvsItem> = ActionProcessor<\n  KeyValueStoreScanAllScopesAction,\n  QpqPagedData<KvsScopedItem<KvsItem>>\n>;\nexport type KeyValueStoreScanAllScopesActionRequester<KvsItem> = ActionRequester<\n  KeyValueStoreScanAllScopesAction,\n  QpqPagedData<KvsScopedItem<KvsItem>>\n>;\n"]}

package/lib/esm/actions/keyValueStore/index.d.ts

@@ -1,3 +1,5 @@
+export * from './KeyValueStoreScanAllScopesActionTypes';
+export * from './KeyValueStoreScanAllScopesActionRequester';
 export * from './KeyValueStoreActionType';
 export * from './KeyValueStoreDeleteActionRequester';
 export * from './KeyValueStoreDeleteActionTypes';

package/lib/esm/actions/keyValueStore/index.js

@@ -1,3 +1,5 @@
+export * from './KeyValueStoreScanAllScopesActionTypes';
+export * from './KeyValueStoreScanAllScopesActionRequester';
 export * from './KeyValueStoreActionType';
 export * from './KeyValueStoreDeleteActionRequester';
 export * from './KeyValueStoreDeleteActionTypes';

package/lib/esm/actions/keyValueStore/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/actions/keyValueStore/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sCAAsC,CAAC;AACrD,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AACrD,cAAc,kCAAkC,CAAC;AACjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,iCAAiC,CAAC;AAChD,cAAc,oCAAoC,CAAC;AACnD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,kCAAkC,CAAC;AACjD,cAAc,sCAAsC,CAAC;AACrD,cAAc,kCAAkC,CAAC;AACjD,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC","sourcesContent":["export * from './KeyValueStoreActionType';\nexport * from './KeyValueStoreDeleteActionRequester';\nexport * from './KeyValueStoreDeleteActionTypes';\nexport * from './KeyValueStoreGetActionRequester';\nexport * from './KeyValueStoreGetActionTypes';\nexport * from './KeyValueStoreGetAllActionRequester';\nexport * from './KeyValueStoreGetAllActionTypes';\nexport * from './KeyValueStoreQueryActionRequester';\nexport * from './KeyValueStoreQueryActionTypes';\nexport * from './KeyValueStoreScanActionRequester';\nexport * from './KeyValueStoreScanActionTypes';\nexport * from './KeyValueStoreUpdateActionRequester';\nexport * from './KeyValueStoreUpdateActionTypes';\nexport * from './KeyValueStoreUpsertActionRequester';\nexport * from './KeyValueStoreUpsertActionTypes';\nexport * from './types';\nexport * from './utils';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/actions/keyValueStore/index.ts"],"names":[],"mappings":"AAAA,cAAc,yCAAyC,CAAC;AACxD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sCAAsC,CAAC;AACrD,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,sCAAsC,CAAC;AACrD,cAAc,kCAAkC,CAAC;AACjD,cAAc,qCAAqC,CAAC;AACpD,cAAc,iCAAiC,CAAC;AAChD,cAAc,oCAAoC,CAAC;AACnD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sCAAsC,CAAC;AACrD,cAAc,kCAAkC,CAAC;AACjD,cAAc,sCAAsC,CAAC;AACrD,cAAc,kCAAkC,CAAC;AACjD,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC","sourcesContent":["export * from './KeyValueStoreScanAllScopesActionTypes';\nexport * from './KeyValueStoreScanAllScopesActionRequester';\nexport * from './KeyValueStoreActionType';\nexport * from './KeyValueStoreDeleteActionRequester';\nexport * from './KeyValueStoreDeleteActionTypes';\nexport * from './KeyValueStoreGetActionRequester';\nexport * from './KeyValueStoreGetActionTypes';\nexport * from './KeyValueStoreGetAllActionRequester';\nexport * from './KeyValueStoreGetAllActionTypes';\nexport * from './KeyValueStoreQueryActionRequester';\nexport * from './KeyValueStoreQueryActionTypes';\nexport * from './KeyValueStoreScanActionRequester';\nexport * from './KeyValueStoreScanActionTypes';\nexport * from './KeyValueStoreUpdateActionRequester';\nexport * from './KeyValueStoreUpdateActionTypes';\nexport * from './KeyValueStoreUpsertActionRequester';\nexport * from './KeyValueStoreUpsertActionTypes';\nexport * from './types';\nexport * from './utils';\n"]}

package/lib/esm/actions/keyValueStore/types/KvsQueryOperation.d.ts

@@ -1,9 +1,9 @@
 import { KvsLogicalOperatorType, KvsQueryOperationType } from './KvsQueryOperationType';
 export type KvsCoreDataType = string | number;
 export type KvsBasicDataType = KvsCoreDataType | boolean;
-export type KvsListDataType = KvsBasicDataType[];
+export type KvsListDataType = KvsAdvancedDataType[];
 export interface KvsObjectDataType {
-    [key: string]: KvsAdvancedDataType;
+    [key: string]: KvsAdvancedDataType | undefined;
 }
 export type KvsAdvancedDataType = KvsBasicDataType | KvsListDataType | KvsObjectDataType;
 export type KvsQueryCondition = {

package/lib/esm/actions/keyValueStore/types/KvsQueryOperation.js.map

@@ -1 +1 @@
-{"version":3,"file":"KvsQueryOperation.js","sourceRoot":"","sources":["../../../../../src/actions/keyValueStore/types/KvsQueryOperation.ts"],"names":[],"mappings":"","sourcesContent":["import { KvsLogicalOperatorType, KvsQueryOperationType } from './KvsQueryOperationType';\n\nexport type KvsCoreDataType = string | number;\nexport type KvsBasicDataType = KvsCoreDataType | boolean;\nexport type KvsListDataType = KvsBasicDataType[];\n\n// Use an interface for the recursive data type\nexport interface KvsObjectDataType {\n  [key: string]: KvsAdvancedDataType;\n}\n\nexport type KvsAdvancedDataType = KvsBasicDataType | KvsListDataType | KvsObjectDataType;\n\n// Type for individual query conditions\nexport type KvsQueryCondition = {\n  key: string;\n  operation: KvsQueryOperationType;\n  valueA?: KvsAdvancedDataType;\n  valueB?: KvsBasicDataType;\n};\n\n// Type for logical operators\nexport type KvsLogicalOperator = {\n  operation: KvsLogicalOperatorType;\n  conditions: (KvsQueryCondition | KvsLogicalOperator)[];\n};\n\n// Type for the overall query operation\nexport type KvsQueryOperation = KvsQueryCondition | KvsLogicalOperator;\n"]}
+{"version":3,"file":"KvsQueryOperation.js","sourceRoot":"","sources":["../../../../../src/actions/keyValueStore/types/KvsQueryOperation.ts"],"names":[],"mappings":"","sourcesContent":["import { KvsLogicalOperatorType, KvsQueryOperationType } from './KvsQueryOperationType';\n\nexport type KvsCoreDataType = string | number;\nexport type KvsBasicDataType = KvsCoreDataType | boolean;\n\nexport type KvsListDataType = KvsAdvancedDataType[];\n\n// Use an interface for the recursive data type. Members may be undefined so that a\n// domain model with OPTIONAL fields can be written directly; the marshaller drops\n// undefined members, since DynamoDB has no representation for them.\nexport interface KvsObjectDataType {\n  [key: string]: KvsAdvancedDataType | undefined;\n}\n\nexport type KvsAdvancedDataType = KvsBasicDataType | KvsListDataType | KvsObjectDataType;\n\n// Type for individual query conditions\nexport type KvsQueryCondition = {\n  key: string;\n  operation: KvsQueryOperationType;\n  valueA?: KvsAdvancedDataType;\n  valueB?: KvsBasicDataType;\n};\n\n// Type for logical operators\nexport type KvsLogicalOperator = {\n  operation: KvsLogicalOperatorType;\n  conditions: (KvsQueryCondition | KvsLogicalOperator)[];\n};\n\n// Type for the overall query operation\nexport type KvsQueryOperation = KvsQueryCondition | KvsLogicalOperator;\n"]}

package/lib/esm/config/settings/keyValueStore.d.ts

@@ -1,4 +1,4 @@
-import { CrossModuleOwner, KeyOf } from '../../types';
+import { CrossModuleOwner, KeyOf, QpqFunctionRuntime } from '../../types';
 import { QPQConfigAdvancedSettings, QPQConfigSetting } from '../QPQConfig';
 export type KvsKeyType = 'string' | 'number' | 'binary';
 export type KvsKey<T extends object = any> = {
@@ -16,6 +16,41 @@ type CompositeCompositeKvsIndex<T extends object = any> = {
     sortKey?: CompositeKvsKey<T>;
 };
 export type CompositeKvsIndex<T extends object = any> = KeyOf<T> | CompositeCompositeKvsIndex<T>;
+/**
+ * Change data capture on a store: the table gets a stream (NEW_AND_OLD_IMAGES) and
+ * `runtime` is invoked with the changes.
+ *
+ * Records arrive in order PER PARTITION KEY, and different partition keys are processed
+ * concurrently. A stream handler therefore gets one-writer-per-item serialisation for
+ * free, which is what makes a stream the natural place to maintain a projection of a table
+ * you only ever append to — no queue, no extra write on the append path, and no trigger to
+ * lose, because the record exists precisely because the write happened.
+ *
+ * Mirrors defineStorageDrive's `onEvent`.
+ */
+export type KvsStreamSettings = {
+    runtime: QpqFunctionRuntime;
+    /**
+     * Collapse each delivered batch down to ONE record per partition key, keeping the latest.
+     *
+     * Off by default: a generic consumer (audit trail, change notifications) needs to see
+     * every change, and the framework should never silently drop records.
+     *
+     * On for a PROJECTION, where the payload that matters is "this key changed" and the
+     * handler re-derives from source anyway. Without it, the batch is fanned back out into
+     * one story run per record and the batching bought nothing: 500 appends to one document
+     * would mean 500 re-derivations, each reading a log that grows as it goes. With it, that
+     * batch is a single re-derivation.
+     */
+    coalesceByPartitionKey?: boolean;
+    /** Records per invocation. DynamoDB streams allow up to 1000; the mapping default is 100. */
+    batchSize?: number;
+    /**
+     * How long to wait accumulating records before invoking, 0 to 300 seconds. Trades
+     * projection latency for far fewer invocations, and gives coalescing more to collapse.
+     */
+    maximumBatchingWindowInSeconds?: number;
+};
 export interface QPQConfigAdvancedKeyValueStoreSettings<T extends object = any> extends QPQConfigAdvancedSettings {
     indexes?: CompositeKvsIndex<T>[];
     global?: boolean;
@@ -23,6 +58,7 @@ export interface QPQConfigAdvancedKeyValueStoreSettings<T extends object = any>
     ttlAttribute?: string;
     disablePointInTimeRecovery?: boolean;
     encryption?: boolean;
+    onStream?: KvsStreamSettings;
 }
 export interface KeyValueStoreQPQConfigSetting<T extends object = any> extends QPQConfigSetting {
     keyValueStoreName: string;
@@ -33,6 +69,7 @@ export interface KeyValueStoreQPQConfigSetting<T extends object = any> extends Q
     ttlAttribute?: string;
     disablePointInTimeRecovery: boolean;
     encryption: boolean;
+    onStream?: KvsStreamSettings;
 }
 export declare const defineKeyValueStore: <T extends object = any>(keyValueStoreName: string, partitionKey: CompositeKvsKey<T>, sortKeys?: CompositeKvsKey<T>[], options?: QPQConfigAdvancedKeyValueStoreSettings<T>) => KeyValueStoreQPQConfigSetting<T>;
 export {};

package/lib/esm/config/settings/keyValueStore.js

@@ -37,5 +37,6 @@ export const defineKeyValueStore = (keyValueStoreName, partitionKey, sortKeys =
     ttlAttribute: options?.ttlAttribute,
     disablePointInTimeRecovery: options?.disablePointInTimeRecovery ?? false,
     encryption: options?.encryption ?? false,
+    onStream: options?.onStream,
 });
 //# sourceMappingURL=keyValueStore.js.map

package/lib/esm/config/settings/keyValueStore.js.map

@@ -1 +1 @@
-{"version":3,"file":"keyValueStore.js","sourceRoot":"","sources":["../../../../src/config/settings/keyValueStore.ts"],"names":[],"mappings":"AACA,OAAO,EAA+C,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAmBrG,MAAM,CAAC,MAAM,MAAM,GAAG,CAAyB,GAAa,EAAE,OAAmB,QAAQ,EAAa,EAAE,CAAC,CAAC;IACxG,GAAG;IACH,IAAI;CACL,CAAC,CAAC;AAWH,MAAM,8BAA8B,GAAG,CAAyB,eAAmC,EAAa,EAAE;IAChH,oBAAoB;IACpB,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,MAAM,CAAI,eAA2B,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED,sBAAsB;IACtB,OAAO,eAA4B,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,8CAA8C,GAAG,CACrD,iBAAuC,EACa,EAAE;IACtD,OAAO,OAAO,iBAAiB,KAAK,QAAQ,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,kCAAkC,GAAG,CAAyB,iBAAuC,EAAe,EAAE;IAC1H,IAAI,CAAC,8CAA8C,CAAI,iBAAiB,CAAC,EAAE,CAAC;QAC1E,OAAO;YACL,YAAY,EAAE,MAAM,CAAI,iBAAiB,EAAE,QAAQ,CAAC;SACrD,CAAC;IACJ,CAAC;IAED,OAAO;QACL,YAAY,EAAE,8BAA8B,CAAI,iBAAiB,CAAC,YAAY,CAAC;QAC/E,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,8BAA8B,CAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;KAC9G,CAAC;AACJ,CAAC,CAAC;AAkCF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,iBAAyB,EAEzB,YAAgC,EAChC,WAAiC,EAAE,EAEnC,OAAmD,EACjB,EAAE,CAAC,CAAC;IACtC,iBAAiB,EAAE,wBAAwB,CAAC,aAAa;IACzD,SAAS,EAAE,iBAAiB;IAE5B,iBAAiB;IAEjB,YAAY,EAAE,8BAA8B,CAAI,YAAY,CAAC;IAC7D,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,8BAAiC,CAAA,CAAC;IAEzD,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAA,kCAAqC,CAAA,CAAC;IAE5E,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK;IAEhC,KAAK,EAAE,OAAO,EAAE,KAAK;IAErB,YAAY,EAAE,OAAO,EAAE,YAAY;IAEnC,0BAA0B,EAAE,OAAO,EAAE,0BAA0B,IAAI,KAAK;IAExE,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,KAAK;CACzC,CAAC,CAAC","sourcesContent":["import { CrossModuleOwner, KeyOf } from '../../types';\nimport { QPQConfigAdvancedSettings, QPQConfigSetting, QPQCoreConfigSettingType } from '../QPQConfig';\n\n// TODO: When we put validation on the QPQConfig, we need to make sure\n// Key Length and Data Type: DynamoDB has limitations on key length and data type.\n// Your KvsKeyType only supports 'string', 'number', and 'binary' types. Make sure\n// that you're validating these in convertKvsKeyToDynamodbAttribute function and\n// also ensure that key length is within DynamoDB's specified limits.\n\nexport type KvsKeyType = 'string' | 'number' | 'binary';\nexport type KvsKey<T extends object = any> = {\n  key: KeyOf<T>;\n  type: KvsKeyType;\n};\n\nexport type KvsIndex<T extends object = any> = {\n  partitionKey: KvsKey<T>;\n  sortKey?: KvsKey<T>;\n};\n\nexport const kvsKey = <T extends object = any>(key: KeyOf<T>, type: KvsKeyType = 'string'): KvsKey<T> => ({\n  key,\n  type,\n});\n\ntype CompositeKvsKey<T extends object = any> = KvsKey<T> | KeyOf<T>;\n\ntype CompositeCompositeKvsIndex<T extends object = any> = {\n  partitionKey: CompositeKvsKey<T>;\n  sortKey?: CompositeKvsKey<T>;\n};\n\nexport type CompositeKvsIndex<T extends object = any> = KeyOf<T> | CompositeCompositeKvsIndex<T>;\n\nconst convertCompositeKvsKeyToKvsKey = <T extends object = any>(compositeKvsKey: CompositeKvsKey<T>): KvsKey<T> => {\n  // Must be a keyof T\n  if (typeof compositeKvsKey === 'string') {\n    return kvsKey<T>(compositeKvsKey as KeyOf<T>, 'string');\n  }\n\n  // must be a KvsKey<T>\n  return compositeKvsKey as KvsKey<T>;\n};\n\nconst isCompositeKvsIndexACompositeCompositeKvsIndex = <T extends object = any>(\n  compositeKvsIndex: CompositeKvsIndex<T>,\n): compositeKvsIndex is CompositeCompositeKvsIndex<T> => {\n  return typeof compositeKvsIndex !== 'string';\n};\n\nconst convertCompositeKvsIndexToKvsIndex = <T extends object = any>(compositeKvsIndex: CompositeKvsIndex<T>): KvsIndex<T> => {\n  if (!isCompositeKvsIndexACompositeCompositeKvsIndex<T>(compositeKvsIndex)) {\n    return {\n      partitionKey: kvsKey<T>(compositeKvsIndex, 'string'),\n    };\n  }\n\n  return {\n    partitionKey: convertCompositeKvsKeyToKvsKey<T>(compositeKvsIndex.partitionKey),\n    sortKey: compositeKvsIndex.sortKey ? convertCompositeKvsKeyToKvsKey<T>(compositeKvsIndex.sortKey) : undefined,\n  };\n};\n\nexport interface QPQConfigAdvancedKeyValueStoreSettings<T extends object = any> extends QPQConfigAdvancedSettings {\n  indexes?: CompositeKvsIndex<T>[];\n\n  global?: boolean;\n\n  owner?: CrossModuleOwner;\n\n  ttlAttribute?: string;\n\n  // Point-in-time recovery (35-day continuous backups) is on by default; set this to opt out.\n  disablePointInTimeRecovery?: boolean;\n\n  encryption?: boolean;\n}\n\nexport interface KeyValueStoreQPQConfigSetting<T extends object = any> extends QPQConfigSetting {\n  keyValueStoreName: string;\n\n  partitionKey: KvsKey<T>;\n  sortKeys: KvsKey<T>[];\n\n  indexes: KvsIndex<T>[];\n\n  global: boolean;\n\n  ttlAttribute?: string;\n\n  disablePointInTimeRecovery: boolean;\n\n  encryption: boolean;\n}\n\nexport const defineKeyValueStore = <T extends object = any>(\n  keyValueStoreName: string,\n\n  partitionKey: CompositeKvsKey<T>,\n  sortKeys: CompositeKvsKey<T>[] = [],\n\n  options?: QPQConfigAdvancedKeyValueStoreSettings<T>,\n): KeyValueStoreQPQConfigSetting<T> => ({\n  configSettingType: QPQCoreConfigSettingType.keyValueStore,\n  uniqueKey: keyValueStoreName,\n\n  keyValueStoreName,\n\n  partitionKey: convertCompositeKvsKeyToKvsKey<T>(partitionKey),\n  sortKeys: sortKeys.map(convertCompositeKvsKeyToKvsKey<T>),\n\n  indexes: (options?.indexes ?? []).map(convertCompositeKvsIndexToKvsIndex<T>),\n\n  global: options?.global ?? false,\n\n  owner: options?.owner,\n\n  ttlAttribute: options?.ttlAttribute,\n\n  disablePointInTimeRecovery: options?.disablePointInTimeRecovery ?? false,\n\n  encryption: options?.encryption ?? false,\n});\n"]}
+{"version":3,"file":"keyValueStore.js","sourceRoot":"","sources":["../../../../src/config/settings/keyValueStore.ts"],"names":[],"mappings":"AACA,OAAO,EAA+C,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAmBrG,MAAM,CAAC,MAAM,MAAM,GAAG,CAAyB,GAAa,EAAE,OAAmB,QAAQ,EAAa,EAAE,CAAC,CAAC;IACxG,GAAG;IACH,IAAI;CACL,CAAC,CAAC;AAWH,MAAM,8BAA8B,GAAG,CAAyB,eAAmC,EAAa,EAAE;IAChH,oBAAoB;IACpB,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE,CAAC;QACxC,OAAO,MAAM,CAAI,eAA2B,EAAE,QAAQ,CAAC,CAAC;IAC1D,CAAC;IAED,sBAAsB;IACtB,OAAO,eAA4B,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,8CAA8C,GAAG,CACrD,iBAAuC,EACa,EAAE;IACtD,OAAO,OAAO,iBAAiB,KAAK,QAAQ,CAAC;AAC/C,CAAC,CAAC;AAEF,MAAM,kCAAkC,GAAG,CAAyB,iBAAuC,EAAe,EAAE;IAC1H,IAAI,CAAC,8CAA8C,CAAI,iBAAiB,CAAC,EAAE,CAAC;QAC1E,OAAO;YACL,YAAY,EAAE,MAAM,CAAI,iBAAiB,EAAE,QAAQ,CAAC;SACrD,CAAC;IACJ,CAAC;IAED,OAAO;QACL,YAAY,EAAE,8BAA8B,CAAI,iBAAiB,CAAC,YAAY,CAAC;QAC/E,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,8BAA8B,CAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS;KAC9G,CAAC;AACJ,CAAC,CAAC;AA+EF,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,iBAAyB,EAEzB,YAAgC,EAChC,WAAiC,EAAE,EAEnC,OAAmD,EACjB,EAAE,CAAC,CAAC;IACtC,iBAAiB,EAAE,wBAAwB,CAAC,aAAa;IACzD,SAAS,EAAE,iBAAiB;IAE5B,iBAAiB;IAEjB,YAAY,EAAE,8BAA8B,CAAI,YAAY,CAAC;IAC7D,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAA,8BAAiC,CAAA,CAAC;IAEzD,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAA,kCAAqC,CAAA,CAAC;IAE5E,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,KAAK;IAEhC,KAAK,EAAE,OAAO,EAAE,KAAK;IAErB,YAAY,EAAE,OAAO,EAAE,YAAY;IAEnC,0BAA0B,EAAE,OAAO,EAAE,0BAA0B,IAAI,KAAK;IAExE,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,KAAK;IAExC,QAAQ,EAAE,OAAO,EAAE,QAAQ;CAC5B,CAAC,CAAC","sourcesContent":["import { CrossModuleOwner, KeyOf, QpqFunctionRuntime } from '../../types';\nimport { QPQConfigAdvancedSettings, QPQConfigSetting, QPQCoreConfigSettingType } from '../QPQConfig';\n\n// TODO: When we put validation on the QPQConfig, we need to make sure\n// Key Length and Data Type: DynamoDB has limitations on key length and data type.\n// Your KvsKeyType only supports 'string', 'number', and 'binary' types. Make sure\n// that you're validating these in convertKvsKeyToDynamodbAttribute function and\n// also ensure that key length is within DynamoDB's specified limits.\n\nexport type KvsKeyType = 'string' | 'number' | 'binary';\nexport type KvsKey<T extends object = any> = {\n  key: KeyOf<T>;\n  type: KvsKeyType;\n};\n\nexport type KvsIndex<T extends object = any> = {\n  partitionKey: KvsKey<T>;\n  sortKey?: KvsKey<T>;\n};\n\nexport const kvsKey = <T extends object = any>(key: KeyOf<T>, type: KvsKeyType = 'string'): KvsKey<T> => ({\n  key,\n  type,\n});\n\ntype CompositeKvsKey<T extends object = any> = KvsKey<T> | KeyOf<T>;\n\ntype CompositeCompositeKvsIndex<T extends object = any> = {\n  partitionKey: CompositeKvsKey<T>;\n  sortKey?: CompositeKvsKey<T>;\n};\n\nexport type CompositeKvsIndex<T extends object = any> = KeyOf<T> | CompositeCompositeKvsIndex<T>;\n\nconst convertCompositeKvsKeyToKvsKey = <T extends object = any>(compositeKvsKey: CompositeKvsKey<T>): KvsKey<T> => {\n  // Must be a keyof T\n  if (typeof compositeKvsKey === 'string') {\n    return kvsKey<T>(compositeKvsKey as KeyOf<T>, 'string');\n  }\n\n  // must be a KvsKey<T>\n  return compositeKvsKey as KvsKey<T>;\n};\n\nconst isCompositeKvsIndexACompositeCompositeKvsIndex = <T extends object = any>(\n  compositeKvsIndex: CompositeKvsIndex<T>,\n): compositeKvsIndex is CompositeCompositeKvsIndex<T> => {\n  return typeof compositeKvsIndex !== 'string';\n};\n\nconst convertCompositeKvsIndexToKvsIndex = <T extends object = any>(compositeKvsIndex: CompositeKvsIndex<T>): KvsIndex<T> => {\n  if (!isCompositeKvsIndexACompositeCompositeKvsIndex<T>(compositeKvsIndex)) {\n    return {\n      partitionKey: kvsKey<T>(compositeKvsIndex, 'string'),\n    };\n  }\n\n  return {\n    partitionKey: convertCompositeKvsKeyToKvsKey<T>(compositeKvsIndex.partitionKey),\n    sortKey: compositeKvsIndex.sortKey ? convertCompositeKvsKeyToKvsKey<T>(compositeKvsIndex.sortKey) : undefined,\n  };\n};\n\n/**\n * Change data capture on a store: the table gets a stream (NEW_AND_OLD_IMAGES) and\n * `runtime` is invoked with the changes.\n *\n * Records arrive in order PER PARTITION KEY, and different partition keys are processed\n * concurrently. A stream handler therefore gets one-writer-per-item serialisation for\n * free, which is what makes a stream the natural place to maintain a projection of a table\n * you only ever append to — no queue, no extra write on the append path, and no trigger to\n * lose, because the record exists precisely because the write happened.\n *\n * Mirrors defineStorageDrive's `onEvent`.\n */\nexport type KvsStreamSettings = {\n  runtime: QpqFunctionRuntime;\n\n  /**\n   * Collapse each delivered batch down to ONE record per partition key, keeping the latest.\n   *\n   * Off by default: a generic consumer (audit trail, change notifications) needs to see\n   * every change, and the framework should never silently drop records.\n   *\n   * On for a PROJECTION, where the payload that matters is \"this key changed\" and the\n   * handler re-derives from source anyway. Without it, the batch is fanned back out into\n   * one story run per record and the batching bought nothing: 500 appends to one document\n   * would mean 500 re-derivations, each reading a log that grows as it goes. With it, that\n   * batch is a single re-derivation.\n   */\n  coalesceByPartitionKey?: boolean;\n\n  /** Records per invocation. DynamoDB streams allow up to 1000; the mapping default is 100. */\n  batchSize?: number;\n\n  /**\n   * How long to wait accumulating records before invoking, 0 to 300 seconds. Trades\n   * projection latency for far fewer invocations, and gives coalescing more to collapse.\n   */\n  maximumBatchingWindowInSeconds?: number;\n};\n\nexport interface QPQConfigAdvancedKeyValueStoreSettings<T extends object = any> extends QPQConfigAdvancedSettings {\n  indexes?: CompositeKvsIndex<T>[];\n\n  global?: boolean;\n\n  owner?: CrossModuleOwner;\n\n  ttlAttribute?: string;\n\n  // Point-in-time recovery (35-day continuous backups) is on by default; set this to opt out.\n  disablePointInTimeRecovery?: boolean;\n\n  encryption?: boolean;\n\n  // Turn on change data capture — see KvsStreamSettings. Absent means no stream is\n  // created at all.\n  onStream?: KvsStreamSettings;\n}\n\nexport interface KeyValueStoreQPQConfigSetting<T extends object = any> extends QPQConfigSetting {\n  keyValueStoreName: string;\n\n  partitionKey: KvsKey<T>;\n  sortKeys: KvsKey<T>[];\n\n  indexes: KvsIndex<T>[];\n\n  global: boolean;\n\n  ttlAttribute?: string;\n\n  disablePointInTimeRecovery: boolean;\n\n  encryption: boolean;\n\n  onStream?: KvsStreamSettings;\n}\n\nexport const defineKeyValueStore = <T extends object = any>(\n  keyValueStoreName: string,\n\n  partitionKey: CompositeKvsKey<T>,\n  sortKeys: CompositeKvsKey<T>[] = [],\n\n  options?: QPQConfigAdvancedKeyValueStoreSettings<T>,\n): KeyValueStoreQPQConfigSetting<T> => ({\n  configSettingType: QPQCoreConfigSettingType.keyValueStore,\n  uniqueKey: keyValueStoreName,\n\n  keyValueStoreName,\n\n  partitionKey: convertCompositeKvsKeyToKvsKey<T>(partitionKey),\n  sortKeys: sortKeys.map(convertCompositeKvsKeyToKvsKey<T>),\n\n  indexes: (options?.indexes ?? []).map(convertCompositeKvsIndexToKvsIndex<T>),\n\n  global: options?.global ?? false,\n\n  owner: options?.owner,\n\n  ttlAttribute: options?.ttlAttribute,\n\n  disablePointInTimeRecovery: options?.disablePointInTimeRecovery ?? false,\n\n  encryption: options?.encryption ?? false,\n\n  onStream: options?.onStream,\n});\n"]}

package/lib/esm/logic/scope/scopedKvsValue.d.ts

@@ -1,6 +1,10 @@
 import { KvsCoreDataType, KvsQueryCondition } from '../../actions/keyValueStore/types';
 export declare const KVS_SCOPE_DELIMITER = "@@QPQSCOPE@@";
 export declare function composeScopedKvsValue(scope: string | undefined, rawValue: KvsCoreDataType): KvsCoreDataType;
+export declare const decomposeScopedKvsValue: (composedValue: string) => {
+    scope?: string;
+    rawValue: string;
+};
 export declare function validateRawPkValueForScopeOrThrow(rawValue: KvsCoreDataType): void;
 export declare function stripScopedKvsValue(scope: string | undefined, storedValue: KvsCoreDataType): KvsCoreDataType;
 export declare function validateScopeSupportedForPartitionKeyType(partitionKeyType: string): void;

package/lib/esm/logic/scope/scopedKvsValue.js

@@ -22,6 +22,23 @@ export function composeScopedKvsValue(scope, rawValue) {
     validateRawPkValueForScopeOrThrow(rawValue);
     return `${scope}${KVS_SCOPE_DELIMITER}${rawValue}`;
 }
+// The inverse of composeScopedKvsValue: split a stored partition key value back into the
+// scope it was written under and the caller's raw key.
+//
+// Needed by anything reading a RAW stored key rather than going through a scoped request.
+// Change data capture is the case that forced it: a stream record carries the composed pk,
+// and the consumer has to re-enter the same scope before it can act on the item. An
+// unscoped value has no delimiter and comes back with `scope: undefined`.
+export const decomposeScopedKvsValue = (composedValue) => {
+    const at = composedValue.indexOf(KVS_SCOPE_DELIMITER);
+    if (at < 0) {
+        return { rawValue: composedValue };
+    }
+    return {
+        scope: composedValue.slice(0, at),
+        rawValue: composedValue.slice(at + KVS_SCOPE_DELIMITER.length),
+    };
+};
 // The delimiter is reserved in scoped partition-key values: a raw value
 // carrying it would strip ambiguously and could collide with (or forge)
 // another scope's composed rows. File-partitioned backends call this directly

package/lib/esm/logic/scope/scopedKvsValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"scopedKvsValue.js","sourceRoot":"","sources":["../../../../src/logic/scope/scopedKvsValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsC,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC9G,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,+EAA+E;AAC/E,gFAAgF;AAChF,+EAA+E;AAC/E,0EAA0E;AAC1E,6EAA6E;AAC7E,SAAS;AACT,MAAM,CAAC,MAAM,mBAAmB,GAAG,cAAc,CAAC;AAElD,gGAAgG;AAChG,8EAA8E;AAC9E,4EAA4E;AAC5E,MAAM,UAAU,qBAAqB,CAAC,KAAyB,EAAE,QAAyB;IACxF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE5B,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,MAAM,IAAI,iBAAiB,CAAC,qBAAqB,CAAC,gBAAgB,EAAE,yDAAyD,CAAC,CAAC;IACjI,CAAC;IAED,iCAAiC,CAAC,QAAQ,CAAC,CAAC;IAE5C,OAAO,GAAG,KAAK,GAAG,mBAAmB,GAAG,QAAQ,EAAE,CAAC;AACrD,CAAC;AAED,wEAAwE;AACxE,wEAAwE;AACxE,8EAA8E;AAC9E,yEAAyE;AACzE,eAAe;AACf,MAAM,UAAU,iCAAiC,CAAC,QAAyB;IACzE,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,iBAAiB,CACzB,qBAAqB,CAAC,iBAAiB,EACvC,8DAA8D,mBAAmB,IAAI,CACtF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,2EAA2E;AAC3E,8EAA8E;AAC9E,0DAA0D;AAC1D,MAAM,UAAU,mBAAmB,CAAC,KAAyB,EAAE,WAA4B;IACzF,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QAC3D,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,MAAM,GAAG,GAAG,KAAK,GAAG,mBAAmB,EAAE,CAAC;IAChD,OAAO,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;AACzF,CAAC;AAED,gFAAgF;AAChF,+EAA+E;AAC/E,gEAAgE;AAChE,MAAM,UAAU,yCAAyC,CAAC,gBAAwB;IAChF,IAAI,gBAAgB,KAAK,QAAQ,EAAE,CAAC;QAClC,MAAM,IAAI,iBAAiB,CACzB,qBAAqB,CAAC,gBAAgB,EACtC,uEAAuE,gBAAgB,KAAK,CAC7F,CAAC;IACJ,CAAC;AACH,CAAC;AAED,4EAA4E;AAC5E,gFAAgF;AAChF,6EAA6E;AAC7E,+BAA+B;AAC/B,MAAM,UAAU,+BAA+B,CAAC,eAAuB;IACrE,OAAO;QACL,GAAG,EAAE,eAAe;QACpB,SAAS,EAAE,qBAAqB,CAAC,WAAW;QAC5C,MAAM,EAAE,mBAAmB;KAC5B,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,4DAA4D;AAC5D,MAAM,UAAU,gCAAgC,CAAC,eAAuB,EAAE,KAAa;IACrF,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE5B,OAAO;QACL,GAAG,EAAE,eAAe;QACpB,SAAS,EAAE,qBAAqB,CAAC,UAAU;QAC3C,MAAM,EAAE,GAAG,KAAK,GAAG,mBAAmB,EAAE;KACzC,CAAC;AACJ,CAAC","sourcesContent":["import { KvsCoreDataType, KvsQueryCondition, KvsQueryOperationType } from '../../actions/keyValueStore/types';\nimport { InvalidScopeError, InvalidScopeErrorCode } from './InvalidScopeError';\nimport { validateScopeSegment } from './validateScopeSegment';\n\n// The delimiter must never occur in legitimate partition key data, because raw\n// values carrying it are rejected outright (see below). '::' is unusable: it is\n// qpq's own function-runtime separator ('src/path::method') and appears inside\n// correlation ids, which the log service stores as partition keys. So the\n// delimiter is a loud qpq-namespaced sentinel instead of a short punctuation\n// token.\nexport const KVS_SCOPE_DELIMITER = '@@QPQSCOPE@@';\n\n// Compose a scope into a partition key value: `${scope}${KVS_SCOPE_DELIMITER}${rawValue}`. Only\n// string keys can carry a scope - a number/binary pk has nowhere to embed the\n// prefix, so scoping such a store is rejected rather than silently coerced.\nexport function composeScopedKvsValue(scope: string | undefined, rawValue: KvsCoreDataType): KvsCoreDataType {\n  if (scope === undefined) {\n    return rawValue;\n  }\n\n  validateScopeSegment(scope);\n\n  if (typeof rawValue !== 'string') {\n    throw new InvalidScopeError(InvalidScopeErrorCode.unsafeCharacters, 'Scope is only supported on string partition key values.');\n  }\n\n  validateRawPkValueForScopeOrThrow(rawValue);\n\n  return `${scope}${KVS_SCOPE_DELIMITER}${rawValue}`;\n}\n\n// The delimiter is reserved in scoped partition-key values: a raw value\n// carrying it would strip ambiguously and could collide with (or forge)\n// another scope's composed rows. File-partitioned backends call this directly\n// for parity - they store values raw, but a value prod rejects must fail\n// locally too.\nexport function validateRawPkValueForScopeOrThrow(rawValue: KvsCoreDataType): void {\n  if (typeof rawValue === 'string' && rawValue.includes(KVS_SCOPE_DELIMITER)) {\n    throw new InvalidScopeError(\n      InvalidScopeErrorCode.reservedDelimiter,\n      `Partition key values must not contain the scope delimiter '${KVS_SCOPE_DELIMITER}'.`,\n    );\n  }\n}\n\n// Undo composeScopedKvsValue on a value read back from storage, so callers\n// never see the composed form. A stored value that doesn't carry the expected\n// prefix is returned unchanged (it was written unscoped).\nexport function stripScopedKvsValue(scope: string | undefined, storedValue: KvsCoreDataType): KvsCoreDataType {\n  if (scope === undefined || typeof storedValue !== 'string') {\n    return storedValue;\n  }\n\n  const prefix = `${scope}${KVS_SCOPE_DELIMITER}`;\n  return storedValue.startsWith(prefix) ? storedValue.slice(prefix.length) : storedValue;\n}\n\n// Scope composes into the partition key's stored string value, so a store whose\n// partition key is number/binary-typed cannot be scoped at all - reject before\n// any read/write happens rather than silently matching nothing.\nexport function validateScopeSupportedForPartitionKeyType(partitionKeyType: string): void {\n  if (partitionKeyType !== 'string') {\n    throw new InvalidScopeError(\n      InvalidScopeErrorCode.unsafeCharacters,\n      `Scope is only supported on stores with a string partition key (got '${partitionKeyType}').`,\n    );\n  }\n}\n\n// The inverse guard for UNSCOPED Scan / GetAll on a value-composed backend:\n// exclude rows whose pk carries the scope delimiter, so unscoped listings never\n// leak other scopes' (composed) rows. File-partitioned backends get this for\n// free from the file boundary.\nexport function buildKvsScopeExclusionCondition(pkAttributeName: string): KvsQueryCondition {\n  return {\n    key: pkAttributeName,\n    operation: KvsQueryOperationType.NotContains,\n    valueA: KVS_SCOPE_DELIMITER,\n  };\n}\n\n// A begins-with predicate on the partition key attribute, for enforcing scope\n// on operations that have no key condition (Scan / GetAll).\nexport function buildKvsScopeBeginsWithCondition(pkAttributeName: string, scope: string): KvsQueryCondition {\n  validateScopeSegment(scope);\n\n  return {\n    key: pkAttributeName,\n    operation: KvsQueryOperationType.BeginsWith,\n    valueA: `${scope}${KVS_SCOPE_DELIMITER}`,\n  };\n}\n"]}
+{"version":3,"file":"scopedKvsValue.js","sourceRoot":"","sources":["../../../../src/logic/scope/scopedKvsValue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsC,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC9G,OAAO,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAE9D,+EAA+E;AAC/E,gFAAgF;AAChF,+EAA+E;AAC/E,0EAA0E;AAC1E,6EAA6E;AAC7E,SAAS;AACT,MAAM,CAAC,MAAM,mBAAmB,GAAG,cAAc,CAAC;AAElD,gGAAgG;AAChG,8EAA8E;AAC9E,4EAA4E;AAC5E,MAAM,UAAU,qBAAqB,CAAC,KAAyB,EAAE,QAAyB;IACxF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE5B,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,MAAM,IAAI,iBAAiB,CAAC,qBAAqB,CAAC,gBAAgB,EAAE,yDAAyD,CAAC,CAAC;IACjI,CAAC;IAED,iCAAiC,CAAC,QAAQ,CAAC,CAAC;IAE5C,OAAO,GAAG,KAAK,GAAG,mBAAmB,GAAG,QAAQ,EAAE,CAAC;AACrD,CAAC;AAED,yFAAyF;AACzF,uDAAuD;AACvD,EAAE;AACF,0FAA0F;AAC1F,2FAA2F;AAC3F,oFAAoF;AACpF,0EAA0E;AAC1E,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,aAAqB,EAAwC,EAAE;IACrG,MAAM,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEtD,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;QACX,OAAO,EAAE,QAAQ,EAAE,aAAa,EAAE,CAAC;IACrC,CAAC;IAED,OAAO;QACL,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC;QACjC,QAAQ,EAAE,aAAa,CAAC,KAAK,CAAC,EAAE,GAAG,mBAAmB,CAAC,MAAM,CAAC;KAC/D,CAAC;AACJ,CAAC,CAAC;AAEF,wEAAwE;AACxE,wEAAwE;AACxE,8EAA8E;AAC9E,yEAAyE;AACzE,eAAe;AACf,MAAM,UAAU,iCAAiC,CAAC,QAAyB;IACzE,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,CAAC,QAAQ,CAAC,mBAAmB,CAAC,EAAE,CAAC;QAC3E,MAAM,IAAI,iBAAiB,CACzB,qBAAqB,CAAC,iBAAiB,EACvC,8DAA8D,mBAAmB,IAAI,CACtF,CAAC;IACJ,CAAC;AACH,CAAC;AAED,2EAA2E;AAC3E,8EAA8E;AAC9E,0DAA0D;AAC1D,MAAM,UAAU,mBAAmB,CAAC,KAAyB,EAAE,WAA4B;IACzF,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;QAC3D,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,MAAM,MAAM,GAAG,GAAG,KAAK,GAAG,mBAAmB,EAAE,CAAC;IAChD,OAAO,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC;AACzF,CAAC;AAED,gFAAgF;AAChF,+EAA+E;AAC/E,gEAAgE;AAChE,MAAM,UAAU,yCAAyC,CAAC,gBAAwB;IAChF,IAAI,gBAAgB,KAAK,QAAQ,EAAE,CAAC;QAClC,MAAM,IAAI,iBAAiB,CACzB,qBAAqB,CAAC,gBAAgB,EACtC,uEAAuE,gBAAgB,KAAK,CAC7F,CAAC;IACJ,CAAC;AACH,CAAC;AAED,4EAA4E;AAC5E,gFAAgF;AAChF,6EAA6E;AAC7E,+BAA+B;AAC/B,MAAM,UAAU,+BAA+B,CAAC,eAAuB;IACrE,OAAO;QACL,GAAG,EAAE,eAAe;QACpB,SAAS,EAAE,qBAAqB,CAAC,WAAW;QAC5C,MAAM,EAAE,mBAAmB;KAC5B,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,4DAA4D;AAC5D,MAAM,UAAU,gCAAgC,CAAC,eAAuB,EAAE,KAAa;IACrF,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAE5B,OAAO;QACL,GAAG,EAAE,eAAe;QACpB,SAAS,EAAE,qBAAqB,CAAC,UAAU;QAC3C,MAAM,EAAE,GAAG,KAAK,GAAG,mBAAmB,EAAE;KACzC,CAAC;AACJ,CAAC","sourcesContent":["import { KvsCoreDataType, KvsQueryCondition, KvsQueryOperationType } from '../../actions/keyValueStore/types';\nimport { InvalidScopeError, InvalidScopeErrorCode } from './InvalidScopeError';\nimport { validateScopeSegment } from './validateScopeSegment';\n\n// The delimiter must never occur in legitimate partition key data, because raw\n// values carrying it are rejected outright (see below). '::' is unusable: it is\n// qpq's own function-runtime separator ('src/path::method') and appears inside\n// correlation ids, which the log service stores as partition keys. So the\n// delimiter is a loud qpq-namespaced sentinel instead of a short punctuation\n// token.\nexport const KVS_SCOPE_DELIMITER = '@@QPQSCOPE@@';\n\n// Compose a scope into a partition key value: `${scope}${KVS_SCOPE_DELIMITER}${rawValue}`. Only\n// string keys can carry a scope - a number/binary pk has nowhere to embed the\n// prefix, so scoping such a store is rejected rather than silently coerced.\nexport function composeScopedKvsValue(scope: string | undefined, rawValue: KvsCoreDataType): KvsCoreDataType {\n  if (scope === undefined) {\n    return rawValue;\n  }\n\n  validateScopeSegment(scope);\n\n  if (typeof rawValue !== 'string') {\n    throw new InvalidScopeError(InvalidScopeErrorCode.unsafeCharacters, 'Scope is only supported on string partition key values.');\n  }\n\n  validateRawPkValueForScopeOrThrow(rawValue);\n\n  return `${scope}${KVS_SCOPE_DELIMITER}${rawValue}`;\n}\n\n// The inverse of composeScopedKvsValue: split a stored partition key value back into the\n// scope it was written under and the caller's raw key.\n//\n// Needed by anything reading a RAW stored key rather than going through a scoped request.\n// Change data capture is the case that forced it: a stream record carries the composed pk,\n// and the consumer has to re-enter the same scope before it can act on the item. An\n// unscoped value has no delimiter and comes back with `scope: undefined`.\nexport const decomposeScopedKvsValue = (composedValue: string): { scope?: string; rawValue: string } => {\n  const at = composedValue.indexOf(KVS_SCOPE_DELIMITER);\n\n  if (at < 0) {\n    return { rawValue: composedValue };\n  }\n\n  return {\n    scope: composedValue.slice(0, at),\n    rawValue: composedValue.slice(at + KVS_SCOPE_DELIMITER.length),\n  };\n};\n\n// The delimiter is reserved in scoped partition-key values: a raw value\n// carrying it would strip ambiguously and could collide with (or forge)\n// another scope's composed rows. File-partitioned backends call this directly\n// for parity - they store values raw, but a value prod rejects must fail\n// locally too.\nexport function validateRawPkValueForScopeOrThrow(rawValue: KvsCoreDataType): void {\n  if (typeof rawValue === 'string' && rawValue.includes(KVS_SCOPE_DELIMITER)) {\n    throw new InvalidScopeError(\n      InvalidScopeErrorCode.reservedDelimiter,\n      `Partition key values must not contain the scope delimiter '${KVS_SCOPE_DELIMITER}'.`,\n    );\n  }\n}\n\n// Undo composeScopedKvsValue on a value read back from storage, so callers\n// never see the composed form. A stored value that doesn't carry the expected\n// prefix is returned unchanged (it was written unscoped).\nexport function stripScopedKvsValue(scope: string | undefined, storedValue: KvsCoreDataType): KvsCoreDataType {\n  if (scope === undefined || typeof storedValue !== 'string') {\n    return storedValue;\n  }\n\n  const prefix = `${scope}${KVS_SCOPE_DELIMITER}`;\n  return storedValue.startsWith(prefix) ? storedValue.slice(prefix.length) : storedValue;\n}\n\n// Scope composes into the partition key's stored string value, so a store whose\n// partition key is number/binary-typed cannot be scoped at all - reject before\n// any read/write happens rather than silently matching nothing.\nexport function validateScopeSupportedForPartitionKeyType(partitionKeyType: string): void {\n  if (partitionKeyType !== 'string') {\n    throw new InvalidScopeError(\n      InvalidScopeErrorCode.unsafeCharacters,\n      `Scope is only supported on stores with a string partition key (got '${partitionKeyType}').`,\n    );\n  }\n}\n\n// The inverse guard for UNSCOPED Scan / GetAll on a value-composed backend:\n// exclude rows whose pk carries the scope delimiter, so unscoped listings never\n// leak other scopes' (composed) rows. File-partitioned backends get this for\n// free from the file boundary.\nexport function buildKvsScopeExclusionCondition(pkAttributeName: string): KvsQueryCondition {\n  return {\n    key: pkAttributeName,\n    operation: KvsQueryOperationType.NotContains,\n    valueA: KVS_SCOPE_DELIMITER,\n  };\n}\n\n// A begins-with predicate on the partition key attribute, for enforcing scope\n// on operations that have no key condition (Scan / GetAll).\nexport function buildKvsScopeBeginsWithCondition(pkAttributeName: string, scope: string): KvsQueryCondition {\n  validateScopeSegment(scope);\n\n  return {\n    key: pkAttributeName,\n    operation: KvsQueryOperationType.BeginsWith,\n    valueA: `${scope}${KVS_SCOPE_DELIMITER}`,\n  };\n}\n"]}

package/lib/esm/types/KvsStreamEvent.d.ts

@@ -0,0 +1,14 @@
+export declare enum KvsStreamEventType {
+    Insert = "Insert",
+    Modify = "Modify",
+    Remove = "Remove"
+}
+export type KvsStreamRecord<TItem extends object = any> = {
+    keyValueStoreName: string;
+    eventType: KvsStreamEventType;
+    scope?: string;
+    keys: Record<string, unknown>;
+    newImage?: TItem;
+    oldImage?: TItem;
+};
+export type KvsStreamEventResponse = void;

package/lib/esm/types/KvsStreamEvent.js

@@ -0,0 +1,13 @@
+// One change to a key-value store item, delivered by the store's stream (see
+// defineKeyValueStore's `onStream`).
+//
+// The images are plain objects, not the storage layer's wire format: the action processor
+// unmarshals them, so a stream handler is ordinary story code and never sees a DynamoDB
+// AttributeValue. That also keeps handlers portable to a non-DynamoDB store.
+export var KvsStreamEventType;
+(function (KvsStreamEventType) {
+    KvsStreamEventType["Insert"] = "Insert";
+    KvsStreamEventType["Modify"] = "Modify";
+    KvsStreamEventType["Remove"] = "Remove";
+})(KvsStreamEventType || (KvsStreamEventType = {}));
+//# sourceMappingURL=KvsStreamEvent.js.map

package/lib/esm/types/KvsStreamEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KvsStreamEvent.js","sourceRoot":"","sources":["../../../src/types/KvsStreamEvent.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,qCAAqC;AACrC,EAAE;AACF,0FAA0F;AAC1F,wFAAwF;AACxF,6EAA6E;AAC7E,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;IACjB,uCAAiB,CAAA;AACnB,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B","sourcesContent":["// One change to a key-value store item, delivered by the store's stream (see\n// defineKeyValueStore's `onStream`).\n//\n// The images are plain objects, not the storage layer's wire format: the action processor\n// unmarshals them, so a stream handler is ordinary story code and never sees a DynamoDB\n// AttributeValue. That also keeps handlers portable to a non-DynamoDB store.\nexport enum KvsStreamEventType {\n  Insert = 'Insert',\n  Modify = 'Modify',\n  Remove = 'Remove',\n}\n\nexport type KvsStreamRecord<TItem extends object = any> = {\n  keyValueStoreName: string;\n\n  eventType: KvsStreamEventType;\n\n  // The storage scope the item was written under; absent for an unscoped row.\n  //\n  // Scope is composed INTO the partition key value on the way to storage, so the raw stored\n  // key carries it. Every other read path hides that (the scoped translator strips it before\n  // a consumer ever sees it), and a stream record is the one place it would otherwise leak.\n  // Handing it back as its own field keeps that promise: a consumer re-enters the scope by\n  // reading this, instead of having to know the composition format and remember to undo it.\n  // Forgetting to would mean acting on one tenant's data while pointed at another's.\n  scope?: string;\n\n  // The item's key attributes only — always present, including on Remove. RAW: the scope has\n  // been stripped back out of the partition key, so these are the values the caller wrote.\n  keys: Record<string, unknown>;\n\n  // The item after the change, scope stripped like `keys`. Absent on Remove.\n  newImage?: TItem;\n\n  // The item before the change, scope stripped like `keys`. Absent on Insert.\n  oldImage?: TItem;\n};\n\n// Handlers are invoked per record, mirroring how storage drive and queue events are\n// dispatched. Ordering is guaranteed per partition key; records for different partition\n// keys may be processed concurrently.\nexport type KvsStreamEventResponse = void;\n"]}

package/lib/esm/types/StorySession.d.ts

@@ -72,6 +72,7 @@ export declare enum QpqRuntimeType {
     WEBSOCKET_EVENT = "WEBSOCKET_EVENT",
     DEPLOY_EVENT = "DEPLOY_EVENT",
     STORAGEDRIVE_EVENT = "STORAGEDRIVE_EVENT",
+    KVS_STREAM_EVENT = "KVS_STREAM_EVENT",
     CLOUD_FLARE_DEPLOY = "CLOUD_FLARE_DEPLOY",
     UNIT_TEST = "UNIT_TEST",
     UI = "UI",

package/lib/esm/types/StorySession.js

@@ -10,6 +10,7 @@ export var QpqRuntimeType;
     QpqRuntimeType["WEBSOCKET_EVENT"] = "WEBSOCKET_EVENT";
     QpqRuntimeType["DEPLOY_EVENT"] = "DEPLOY_EVENT";
     QpqRuntimeType["STORAGEDRIVE_EVENT"] = "STORAGEDRIVE_EVENT";
+    QpqRuntimeType["KVS_STREAM_EVENT"] = "KVS_STREAM_EVENT";
     QpqRuntimeType["CLOUD_FLARE_DEPLOY"] = "CLOUD_FLARE_DEPLOY";
     QpqRuntimeType["UNIT_TEST"] = "UNIT_TEST";
     QpqRuntimeType["UI"] = "UI";

package/lib/esm/types/StorySession.js.map

@@ -1 +1 @@
-{"version":3,"file":"StorySession.js","sourceRoot":"","sources":["../../../src/types/StorySession.ts"],"names":[],"mappings":"AA8GA,MAAM,CAAN,IAAY,cAqBX;AArBD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,iDAA+B,CAAA;IAC/B,+EAA6D,CAAA;IAC7D,2DAAyC,CAAA;IACzC,6CAA2B,CAAA;IAC3B,+CAA6B,CAAA;IAC7B,+DAA6C,CAAA;IAC7C,qDAAmC,CAAA;IACnC,+CAA6B,CAAA;IAC7B,2DAAyC,CAAA;IACzC,2DAAyC,CAAA;IAEzC,yCAAuB,CAAA;IACvB,2BAAS,CAAA;IAET,uDAAqC,CAAA;IAErC,2EAAyD,CAAA;IACzD,2EAAyD,CAAA;IACzD,2EAAyD,CAAA;AAC3D,CAAC,EArBW,cAAc,KAAd,cAAc,QAqBzB","sourcesContent":["import { Action } from './Action';\nimport { QPQError } from './ErrorTypeEnum';\nimport { QpqContext } from './QpqContextIdentifier';\nimport { QpqFunctionRuntime } from './QpqFunctionRuntime';\n\nexport interface DecodedAccessToken {\n  userId: string;\n  username: string;\n  // Unix timestamp (number of seconds since January 1, 1970 UTC).\n  exp: number;\n  roles?: string[];\n\n  userDirectory: string;\n  wasValid: boolean;\n}\n\nexport interface StorySession {\n  correlation?: string;\n  depth: number;\n\n  // This token is never transfer cross storys\n  // can't access it via events or anything\n  accessToken?: string;\n\n  // Decoded access token + roles token\n  decodedAccessToken?: DecodedAccessToken;\n\n  // Context\n  context: QpqContext<any>;\n\n  // Service-local context, this is never transferred across a service boundary\n  // (queue / event bus / service function), but does flow to in-process sub-runtimes.\n  localContext?: QpqContext<any>;\n\n  // Globals declared on the executing function's QpqFunctionRuntimeAdvanced.\n  // Set per-runtime from qpqFunctionRuntimeInfo; never inherited from the caller.\n  functionGlobals?: Record<string, unknown>;\n}\n\nexport type StorySessionUpdater = (newSession: Partial<StorySession>) => void;\n\nexport type AskResponse<T> = Generator<Action<any>, T, any>;\n\nexport type Story<TArgs extends any[], R> = (...args: TArgs) => AskResponse<R>;\nexport type StoryResolver = <S extends Story<any, any>>(story: S) => (...args: Parameters<S>) => Promise<AskResponseReturnType<ReturnType<S>>>;\n\n// function* test(msg: string): AskResponse<number> {\n//   return parseInt(msg);\n// }\n\n// function DoThing<S extends Story<any, any>>(story: S): (...args: Parameters<S>) => AskResponseReturnType<ReturnType<S>> {\n//   return (...args: Parameters<S>) => {\n//     return (() => {}) as any;\n//   };\n// }\n\n// const runTest = DoThing(test);\n// const num = runTest('a');\n\n/**\n * Utility Type: ExtractGeneratorReturnType\n *\n * This utility type is designed to extract the return type of a Generator without\n * conflating it with the types of values it may yield. Generators in TypeScript are\n * annotated as Generator<YieldType, ReturnType, NextType>, where YieldType is the\n * type of values yielded by the generator, ReturnType is the type the generator returns\n * when it's done, and NextType is the type of the value passed to the generator's `next` method.\n *\n * By leveraging TypeScript's conditional types and the `infer` keyword, ExtractGeneratorReturnType\n * can precisely capture and extract just the ReturnType of any given Generator, providing a clean,\n * type-safe way to understand what a generator ultimately returns upon completion.\n *\n * Usage of `infer` in Conditional Types:\n * The `infer` keyword is used here to declare a type variable R within the conditional type\n * expression. TypeScript will then infer the type R as the generator's ReturnType when the\n * condition `T extends Generator<any, infer R, any>` is met. This inference is based on the\n * actual type passed to ExtractGeneratorReturnType, allowing us to \"pull out\" the ReturnType\n * from within the Generator type.\n *\n * This approach is particularly useful because it directly targets the ReturnType without\n * having to manually sift through or exclude the types of values that might be yielded by\n * the generator, which can often be diverse and not relevant to the final return type we're\n * interested in capturing.\n *\n * The ExtractGeneratorReturnType utility type simplifies the extraction process and ensures\n * that types dependent on the return value of generators are accurately typed, enhancing\n * code readability and maintainability.\n */\n\nexport type ExtractGeneratorReturnType<T extends Generator> = T extends Generator<any, infer R, any> ? R : never;\n\n// Directly extracting the generator's return type for any given AskResponse.\n// By applying ExtractGeneratorReturnType to an AskResponse, we can determine the\n// precise type that the AskResponse generator returns, bypassing the complexities\n// of its yield types. This is particularly useful in scenarios where the return type\n// is distinct from the types of actions or values yielded by the generator, allowing\n// for clear type inference and usage in TypeScript codebases.\nexport type AskResponseReturnType<T extends AskResponse<any>> = ExtractGeneratorReturnType<T>;\n\n// Any generator function that returns an AskResponse\n// qpq runtimes are built on stories\nexport type qpqStory = <T = any>(...args: any[]) => AskResponse<T>;\n\nexport interface ActionHistory<P = any, R = any> {\n  act: Action<P>;\n  res: R;\n  startedAt: string;\n  finishedAt: string;\n}\n\nexport enum QpqRuntimeType {\n  API = 'API',\n  EXECUTE_STORY = 'EXECUTE_STORY',\n  EXECUTE_IMPLEMENTATION_STORY = 'EXECUTE_IMPLEMENTATION_STORY',\n  RECURRING_SCHEDULE = 'RECURRING_SCHEDULE',\n  QUEUE_EVENT = 'QUEUE_EVENT',\n  EVENT_SEO_OR = 'EVENT_SEO_OR',\n  SERVICE_FUNCTION_EXE = 'SERVICE_FUNCTION_EXE',\n  WEBSOCKET_EVENT = 'WEBSOCKET_EVENT',\n  DEPLOY_EVENT = 'DEPLOY_EVENT',\n  STORAGEDRIVE_EVENT = 'STORAGEDRIVE_EVENT',\n  CLOUD_FLARE_DEPLOY = 'CLOUD_FLARE_DEPLOY',\n\n  UNIT_TEST = 'UNIT_TEST',\n  UI = 'UI',\n\n  SEND_EMAIL_EVENT = 'SEND_EMAIL_EVENT',\n\n  AUTH_DEFINE_AUTH_CHALLENGE = 'AUTH_DEFINE_AUTH_CHALLENGE',\n  AUTH_CREATE_AUTH_CHALLENGE = 'AUTH_CREATE_AUTH_CHALLENGE',\n  AUTH_VERIFY_AUTH_CHALLENGE = 'AUTH_VERIFY_AUTH_CHALLENGE',\n}\n\nexport interface qpqConsoleLog {\n  t: string;\n  a: any[];\n}\n\nexport interface StoryResult<TArgs extends Array<any>, TResult = any> {\n  // Params to story\n  input: TArgs;\n\n  // Story Session Data\n  session: StorySession;\n\n  // History of actions\n  history: ActionHistory[];\n\n  // When the story started / finished\n  startedAt: string;\n  finishedAt: string;\n\n  // correlationGuid from the calling story\n  fromCorrelation?: string;\n\n  // correlation for this story (correlates all actions together)\n  correlation: string;\n\n  // For logging, tags to help identify the story\n  tags: string[];\n  moduleName: string;\n\n  // Result of the story result or error not both\n  result?: TResult;\n  error?: QPQError;\n\n  // User specified runtime type\n  runtimeType: QpqRuntimeType;\n\n  // Impure Logs\n  logs?: qpqConsoleLog[];\n\n  // What was the function runtime that this was executed against\n  qpqFunctionRuntimeInfo?: QpqFunctionRuntime;\n}\n\nexport type StoryResultMetadata = {\n  correlation: string;\n  fromCorrelation?: string;\n\n  moduleName: string;\n  runtimeType: QpqRuntimeType;\n\n  startedAt: string;\n\n  generic: string;\n\n  error?: string;\n\n  executionTimeMs: number;\n\n  userInfo?: string;\n\n  qpqFunctionRuntimeInfo?: QpqFunctionRuntime;\n};\n\nexport type StoryResultMetadataWithChildren = StoryResultMetadata & {\n  children: StoryResultMetadataWithChildren[];\n};\n"]}
+{"version":3,"file":"StorySession.js","sourceRoot":"","sources":["../../../src/types/StorySession.ts"],"names":[],"mappings":"AA8GA,MAAM,CAAN,IAAY,cAsBX;AAtBD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,iDAA+B,CAAA;IAC/B,+EAA6D,CAAA;IAC7D,2DAAyC,CAAA;IACzC,6CAA2B,CAAA;IAC3B,+CAA6B,CAAA;IAC7B,+DAA6C,CAAA;IAC7C,qDAAmC,CAAA;IACnC,+CAA6B,CAAA;IAC7B,2DAAyC,CAAA;IACzC,uDAAqC,CAAA;IACrC,2DAAyC,CAAA;IAEzC,yCAAuB,CAAA;IACvB,2BAAS,CAAA;IAET,uDAAqC,CAAA;IAErC,2EAAyD,CAAA;IACzD,2EAAyD,CAAA;IACzD,2EAAyD,CAAA;AAC3D,CAAC,EAtBW,cAAc,KAAd,cAAc,QAsBzB","sourcesContent":["import { Action } from './Action';\nimport { QPQError } from './ErrorTypeEnum';\nimport { QpqContext } from './QpqContextIdentifier';\nimport { QpqFunctionRuntime } from './QpqFunctionRuntime';\n\nexport interface DecodedAccessToken {\n  userId: string;\n  username: string;\n  // Unix timestamp (number of seconds since January 1, 1970 UTC).\n  exp: number;\n  roles?: string[];\n\n  userDirectory: string;\n  wasValid: boolean;\n}\n\nexport interface StorySession {\n  correlation?: string;\n  depth: number;\n\n  // This token is never transfer cross storys\n  // can't access it via events or anything\n  accessToken?: string;\n\n  // Decoded access token + roles token\n  decodedAccessToken?: DecodedAccessToken;\n\n  // Context\n  context: QpqContext<any>;\n\n  // Service-local context, this is never transferred across a service boundary\n  // (queue / event bus / service function), but does flow to in-process sub-runtimes.\n  localContext?: QpqContext<any>;\n\n  // Globals declared on the executing function's QpqFunctionRuntimeAdvanced.\n  // Set per-runtime from qpqFunctionRuntimeInfo; never inherited from the caller.\n  functionGlobals?: Record<string, unknown>;\n}\n\nexport type StorySessionUpdater = (newSession: Partial<StorySession>) => void;\n\nexport type AskResponse<T> = Generator<Action<any>, T, any>;\n\nexport type Story<TArgs extends any[], R> = (...args: TArgs) => AskResponse<R>;\nexport type StoryResolver = <S extends Story<any, any>>(story: S) => (...args: Parameters<S>) => Promise<AskResponseReturnType<ReturnType<S>>>;\n\n// function* test(msg: string): AskResponse<number> {\n//   return parseInt(msg);\n// }\n\n// function DoThing<S extends Story<any, any>>(story: S): (...args: Parameters<S>) => AskResponseReturnType<ReturnType<S>> {\n//   return (...args: Parameters<S>) => {\n//     return (() => {}) as any;\n//   };\n// }\n\n// const runTest = DoThing(test);\n// const num = runTest('a');\n\n/**\n * Utility Type: ExtractGeneratorReturnType\n *\n * This utility type is designed to extract the return type of a Generator without\n * conflating it with the types of values it may yield. Generators in TypeScript are\n * annotated as Generator<YieldType, ReturnType, NextType>, where YieldType is the\n * type of values yielded by the generator, ReturnType is the type the generator returns\n * when it's done, and NextType is the type of the value passed to the generator's `next` method.\n *\n * By leveraging TypeScript's conditional types and the `infer` keyword, ExtractGeneratorReturnType\n * can precisely capture and extract just the ReturnType of any given Generator, providing a clean,\n * type-safe way to understand what a generator ultimately returns upon completion.\n *\n * Usage of `infer` in Conditional Types:\n * The `infer` keyword is used here to declare a type variable R within the conditional type\n * expression. TypeScript will then infer the type R as the generator's ReturnType when the\n * condition `T extends Generator<any, infer R, any>` is met. This inference is based on the\n * actual type passed to ExtractGeneratorReturnType, allowing us to \"pull out\" the ReturnType\n * from within the Generator type.\n *\n * This approach is particularly useful because it directly targets the ReturnType without\n * having to manually sift through or exclude the types of values that might be yielded by\n * the generator, which can often be diverse and not relevant to the final return type we're\n * interested in capturing.\n *\n * The ExtractGeneratorReturnType utility type simplifies the extraction process and ensures\n * that types dependent on the return value of generators are accurately typed, enhancing\n * code readability and maintainability.\n */\n\nexport type ExtractGeneratorReturnType<T extends Generator> = T extends Generator<any, infer R, any> ? R : never;\n\n// Directly extracting the generator's return type for any given AskResponse.\n// By applying ExtractGeneratorReturnType to an AskResponse, we can determine the\n// precise type that the AskResponse generator returns, bypassing the complexities\n// of its yield types. This is particularly useful in scenarios where the return type\n// is distinct from the types of actions or values yielded by the generator, allowing\n// for clear type inference and usage in TypeScript codebases.\nexport type AskResponseReturnType<T extends AskResponse<any>> = ExtractGeneratorReturnType<T>;\n\n// Any generator function that returns an AskResponse\n// qpq runtimes are built on stories\nexport type qpqStory = <T = any>(...args: any[]) => AskResponse<T>;\n\nexport interface ActionHistory<P = any, R = any> {\n  act: Action<P>;\n  res: R;\n  startedAt: string;\n  finishedAt: string;\n}\n\nexport enum QpqRuntimeType {\n  API = 'API',\n  EXECUTE_STORY = 'EXECUTE_STORY',\n  EXECUTE_IMPLEMENTATION_STORY = 'EXECUTE_IMPLEMENTATION_STORY',\n  RECURRING_SCHEDULE = 'RECURRING_SCHEDULE',\n  QUEUE_EVENT = 'QUEUE_EVENT',\n  EVENT_SEO_OR = 'EVENT_SEO_OR',\n  SERVICE_FUNCTION_EXE = 'SERVICE_FUNCTION_EXE',\n  WEBSOCKET_EVENT = 'WEBSOCKET_EVENT',\n  DEPLOY_EVENT = 'DEPLOY_EVENT',\n  STORAGEDRIVE_EVENT = 'STORAGEDRIVE_EVENT',\n  KVS_STREAM_EVENT = 'KVS_STREAM_EVENT',\n  CLOUD_FLARE_DEPLOY = 'CLOUD_FLARE_DEPLOY',\n\n  UNIT_TEST = 'UNIT_TEST',\n  UI = 'UI',\n\n  SEND_EMAIL_EVENT = 'SEND_EMAIL_EVENT',\n\n  AUTH_DEFINE_AUTH_CHALLENGE = 'AUTH_DEFINE_AUTH_CHALLENGE',\n  AUTH_CREATE_AUTH_CHALLENGE = 'AUTH_CREATE_AUTH_CHALLENGE',\n  AUTH_VERIFY_AUTH_CHALLENGE = 'AUTH_VERIFY_AUTH_CHALLENGE',\n}\n\nexport interface qpqConsoleLog {\n  t: string;\n  a: any[];\n}\n\nexport interface StoryResult<TArgs extends Array<any>, TResult = any> {\n  // Params to story\n  input: TArgs;\n\n  // Story Session Data\n  session: StorySession;\n\n  // History of actions\n  history: ActionHistory[];\n\n  // When the story started / finished\n  startedAt: string;\n  finishedAt: string;\n\n  // correlationGuid from the calling story\n  fromCorrelation?: string;\n\n  // correlation for this story (correlates all actions together)\n  correlation: string;\n\n  // For logging, tags to help identify the story\n  tags: string[];\n  moduleName: string;\n\n  // Result of the story result or error not both\n  result?: TResult;\n  error?: QPQError;\n\n  // User specified runtime type\n  runtimeType: QpqRuntimeType;\n\n  // Impure Logs\n  logs?: qpqConsoleLog[];\n\n  // What was the function runtime that this was executed against\n  qpqFunctionRuntimeInfo?: QpqFunctionRuntime;\n}\n\nexport type StoryResultMetadata = {\n  correlation: string;\n  fromCorrelation?: string;\n\n  moduleName: string;\n  runtimeType: QpqRuntimeType;\n\n  startedAt: string;\n\n  generic: string;\n\n  error?: string;\n\n  executionTimeMs: number;\n\n  userInfo?: string;\n\n  qpqFunctionRuntimeInfo?: QpqFunctionRuntime;\n};\n\nexport type StoryResultMetadataWithChildren = StoryResultMetadata & {\n  children: StoryResultMetadataWithChildren[];\n};\n"]}

package/lib/esm/types/index.d.ts

@@ -13,6 +13,7 @@ export * from './EventMessage';
 export * from './ExcludeKeys';
 export * from './FullyQualifiedResource';
 export * from './KeyOf';
+export * from './KvsStreamEvent';
 export * from './LogLevelEnum';
 export * from './Lookup';
 export * from './NotifyErrorQueueEvent';

package/lib/esm/types/index.js

@@ -13,6 +13,7 @@ export * from './EventMessage';
 export * from './ExcludeKeys';
 export * from './FullyQualifiedResource';
 export * from './KeyOf';
+export * from './KvsStreamEvent';
 export * from './LogLevelEnum';
 export * from './Lookup';
 export * from './NotifyErrorQueueEvent';

package/lib/esm/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,SAAS,CAAC;AACxB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,SAAS,CAAC","sourcesContent":["export * from './Action';\nexport * from './authChallenge';\nexport * from './BoundLogicStory';\nexport * from './ConfigUrlDefinition';\nexport * from './CrossModuleMessage';\nexport * from './CrossModuleOwner';\nexport * from './CrossServiceResourceName';\nexport * from './DecomposedString';\nexport * from './DeployEvent';\nexport * from './DynamicModuleLoader';\nexport * from './ErrorTypeEnum';\nexport * from './EventMessage';\nexport * from './ExcludeKeys';\nexport * from './FullyQualifiedResource';\nexport * from './KeyOf';\nexport * from './LogLevelEnum';\nexport * from './Lookup';\nexport * from './NotifyErrorQueueEvent';\nexport * from './Nullable';\nexport * from './QPQBinaryData';\nexport * from './QpqContextIdentifier';\nexport * from './QpqExecutionTrace';\nexport * from './QpqFunctionRuntime';\nexport * from './QpqIsoDateTime';\nexport * from './QpqLogger';\nexport * from './QpqPagedData';\nexport * from './QueueEvent';\nexport * from './Readonlyify';\nexport * from './ScheduledEvent';\nexport * from './StorySession';\nexport * from './StreamRegistry';\nexport * from './UnboundLogicStory';\nexport * from './UnionToIntersection';\nexport * from './utils';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,eAAe,CAAC;AAC9B,cAAc,uBAAuB,CAAC;AACtC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,0BAA0B,CAAC;AACzC,cAAc,SAAS,CAAC;AACxB,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,yBAAyB,CAAC;AACxC,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,SAAS,CAAC","sourcesContent":["export * from './Action';\nexport * from './authChallenge';\nexport * from './BoundLogicStory';\nexport * from './ConfigUrlDefinition';\nexport * from './CrossModuleMessage';\nexport * from './CrossModuleOwner';\nexport * from './CrossServiceResourceName';\nexport * from './DecomposedString';\nexport * from './DeployEvent';\nexport * from './DynamicModuleLoader';\nexport * from './ErrorTypeEnum';\nexport * from './EventMessage';\nexport * from './ExcludeKeys';\nexport * from './FullyQualifiedResource';\nexport * from './KeyOf';\nexport * from './KvsStreamEvent';\nexport * from './LogLevelEnum';\nexport * from './Lookup';\nexport * from './NotifyErrorQueueEvent';\nexport * from './Nullable';\nexport * from './QPQBinaryData';\nexport * from './QpqContextIdentifier';\nexport * from './QpqExecutionTrace';\nexport * from './QpqFunctionRuntime';\nexport * from './QpqIsoDateTime';\nexport * from './QpqLogger';\nexport * from './QpqPagedData';\nexport * from './QueueEvent';\nexport * from './Readonlyify';\nexport * from './ScheduledEvent';\nexport * from './StorySession';\nexport * from './StreamRegistry';\nexport * from './UnboundLogicStory';\nexport * from './UnionToIntersection';\nexport * from './utils';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quidproquo-core",
-  "version": "0.1.12",
+  "version": "0.1.13",
   "description": "",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/esm/index.js",
@@ -33,7 +33,7 @@
   "homepage": "https://github.com/joe-coady/quidproquo#readme",
   "devDependencies": {
     "@types/node": "^24.2.1",
-    "quidproquo-tsconfig": "0.1.12",
+    "quidproquo-tsconfig": "0.1.13",
     "typescript": "^5.8.2"
   },
   "dependencies": {