@qpqjs/core 0.0.0-stage → 0.2.1

package/README.md

@@ -1,3 +1,90 @@
-# Temporary Holding Version
+# @qpqjs/core
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The heart of the [quidproquo](https://github.com/qpqjs/quidproquo) framework: the action catalogue, the story runtime, and the config system that everything else builds on.
+
+Most applications should install [`quidproquo`](https://www.npmjs.com/package/quidproquo) instead, which re-exports this package along with `@qpqjs/webserver`. Install this one directly only if you want core without the web server.
+
+```bash
+npm install @qpqjs/core
+```
+
+## How it works
+
+An **action** is a plain object with a type and an optional payload. A **requester** is the `ask*` generator your code calls to yield one. Here is the whole of `askDateNow`:
+
+```typescript
+export function* askDateNow(): DateNowActionRequester {
+  return yield { type: DateActionType.Now };
+}
+```
+
+It never calls `new Date()`. A **story** composes requesters:
+
+```typescript
+function* askGreet(name: string): AskResponse<string> {
+  const now = yield* askDateNow();
+  return `hello ${name}, it is ${now}`;
+}
+```
+
+The **runtime** drives the story, takes each yielded action, looks up the **processor** registered for that action type, awaits the result, and resumes the generator with it. Processors live in the `@qpqjs/actionprocessor-*` packages, one set per platform. Swap the set and the same story runs somewhere else.
+
+Every action that passes through the runtime is recorded, which is where the execution logs, replay, and tracing come from.
+
+## What is in here
+
+**Actions**, grouped by domain in `src/actions/`:
+
+| Domain | Covers |
+| --- | --- |
+| `config` | Parameters, secrets, globals |
+| `keyValueStore` | Key value storage, queries, and streams |
+| `file` | Object storage: read, write, list, signed urls |
+| `userDirectory` | Sign in, sign up, tokens, user management |
+| `eventBus`, `queue` | Publish and subscribe, message queues |
+| `network` | HTTP requests |
+| `graphDatabase` | Graph queries |
+| `ai` | Prompting and streaming completions |
+| `crypto` | Encrypt and decrypt against a managed key |
+| `date`, `guid`, `math` | The non-deterministic primitives a story must not call directly |
+| `log`, `metric`, `event` | Observability |
+| `state` | Reducer-driven state for frontend modules |
+| `stream`, `system`, `platform` | Streams, process, and platform utilities |
+| `dynamicFunctions`, `inlineFunction` | Calling code that is resolved at runtime |
+| `error`, `context` | Error handling and execution context |
+
+**Stories** in `src/stories/`: the composable helpers, including `askCatch` for try/finally semantics and `askRunParallel` for concurrency.
+
+**Config** in `src/config/`: the `define*` helpers that declare resources (key value stores, queues, secrets, and so on). A qpq config is a plain array of settings, which is what the deploy packages read to build infrastructure.
+
+**Testing** in `src/testing/`: `runStory` runs a story with actions mocked by type, so you can assert on behaviour without a runtime or any infrastructure.
+
+```typescript
+import { DateActionType, runStory } from '@qpqjs/core';
+
+const result = runStory(askGreet('world'), {
+  [DateActionType.Now]: '2026-01-01T00:00:00.000Z',
+});
+
+expect(result).toBe('hello world, it is 2026-01-01T00:00:00.000Z');
+```
+
+A mock can be a literal value or a function, and a function mock is re-invoked per matching action, so it can be stateful.
+
+## Conventions worth knowing
+
+- Anything named `ask*` is a generator and must be called with `yield*`. The [ESLint plugin](https://github.com/qpqjs/quidproquo/tree/main/packages/eslint-config) enforces this and auto-fixes a missing `yield*`.
+- Stories must be deterministic. No `Date.now()`, `Math.random()`, or `crypto.randomUUID()`. Yield `askDateNow()` or `askNewGuid()` so logs replay and tests stay stable.
+- Throw with `return yield* askThrowError(...)`, which tells TypeScript that control stops there.
+
+## Status
+
+Pre-1.0. The whole `@qpqjs/*` family releases in lockstep, so versions that share a number were built and tested together. Expect APIs to move between releases, and pin your versions.
+
+## Documentation
+
+[docs.quidproquojs.com](https://docs.quidproquojs.com)
+
+## License
+
+MIT. See [LICENSE](https://github.com/qpqjs/quidproquo/blob/main/LICENSE).

package/lib/commonjs/actions/ai/AiActionType.d.ts

@@ -0,0 +1,5 @@
+export declare enum AiActionType {
+    Prompt = "@quidproquo-core/Ai/Prompt",
+    PromptStream = "@quidproquo-core/Ai/PromptStream",
+    GetModelRegions = "@quidproquo-core/Ai/GetModelRegions"
+}

package/lib/commonjs/actions/ai/AiActionType.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiActionType = void 0;
+var AiActionType;
+(function (AiActionType) {
+    AiActionType["Prompt"] = "@quidproquo-core/Ai/Prompt";
+    AiActionType["PromptStream"] = "@quidproquo-core/Ai/PromptStream";
+    AiActionType["GetModelRegions"] = "@quidproquo-core/Ai/GetModelRegions";
+})(AiActionType || (exports.AiActionType = AiActionType = {}));
+//# sourceMappingURL=AiActionType.js.map

package/lib/commonjs/actions/ai/AiActionType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AiActionType.js","sourceRoot":"","sources":["../../../../src/actions/ai/AiActionType.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,qDAAqC,CAAA;IACrC,iEAAiD,CAAA;IACjD,uEAAuD,CAAA;AACzD,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB","sourcesContent":["export enum AiActionType {\n  Prompt = '@quidproquo-core/Ai/Prompt',\n  PromptStream = '@quidproquo-core/Ai/PromptStream',\n  GetModelRegions = '@quidproquo-core/Ai/GetModelRegions',\n}\n"]}

package/lib/commonjs/actions/ai/AiCacheTtl.d.ts

@@ -0,0 +1,12 @@
+/**
+ * How long a prompt cache entry should live once written. A request, not a guarantee: each
+ * provider maps it onto the lifetimes its models accept. `Dynamic` lets the provider pick the
+ * best lifetime for each cache point; `ProviderDefault` leaves every point on the provider's own
+ * default; the hour costs a dearer write and is only accepted by models that support it.
+ */
+export declare enum AiCacheTtl {
+    Dynamic = "dynamic",
+    ProviderDefault = "default",
+    FiveMinutes = "5m",
+    OneHour = "1h"
+}

package/lib/commonjs/actions/ai/AiCacheTtl.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiCacheTtl = void 0;
+/**
+ * How long a prompt cache entry should live once written. A request, not a guarantee: each
+ * provider maps it onto the lifetimes its models accept. `Dynamic` lets the provider pick the
+ * best lifetime for each cache point; `ProviderDefault` leaves every point on the provider's own
+ * default; the hour costs a dearer write and is only accepted by models that support it.
+ */
+var AiCacheTtl;
+(function (AiCacheTtl) {
+    AiCacheTtl["Dynamic"] = "dynamic";
+    AiCacheTtl["ProviderDefault"] = "default";
+    AiCacheTtl["FiveMinutes"] = "5m";
+    AiCacheTtl["OneHour"] = "1h";
+})(AiCacheTtl || (exports.AiCacheTtl = AiCacheTtl = {}));
+//# sourceMappingURL=AiCacheTtl.js.map

package/lib/commonjs/actions/ai/AiCacheTtl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AiCacheTtl.js","sourceRoot":"","sources":["../../../../src/actions/ai/AiCacheTtl.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,iCAAmB,CAAA;IACnB,yCAA2B,CAAA;IAC3B,gCAAkB,CAAA;IAClB,4BAAc,CAAA;AAChB,CAAC,EALW,UAAU,0BAAV,UAAU,QAKrB","sourcesContent":["/**\n * How long a prompt cache entry should live once written. A request, not a guarantee: each\n * provider maps it onto the lifetimes its models accept. `Dynamic` lets the provider pick the\n * best lifetime for each cache point; `ProviderDefault` leaves every point on the provider's own\n * default; the hour costs a dearer write and is only accepted by models that support it.\n */\nexport enum AiCacheTtl {\n  Dynamic = 'dynamic',\n  ProviderDefault = 'default',\n  FiveMinutes = '5m',\n  OneHour = '1h',\n}\n"]}

package/lib/commonjs/actions/ai/AiDataRegion.d.ts

@@ -0,0 +1,5 @@
+/** Where a model's requests are processed, so a model picker can show where the data goes. */
+export declare enum AiDataRegion {
+    Australia = "australia",
+    Global = "global"
+}

package/lib/commonjs/actions/ai/AiDataRegion.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiDataRegion = void 0;
+/** Where a model's requests are processed, so a model picker can show where the data goes. */
+var AiDataRegion;
+(function (AiDataRegion) {
+    AiDataRegion["Australia"] = "australia";
+    AiDataRegion["Global"] = "global";
+})(AiDataRegion || (exports.AiDataRegion = AiDataRegion = {}));
+//# sourceMappingURL=AiDataRegion.js.map

package/lib/commonjs/actions/ai/AiDataRegion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AiDataRegion.js","sourceRoot":"","sources":["../../../../src/actions/ai/AiDataRegion.ts"],"names":[],"mappings":";;;AAAA,8FAA8F;AAC9F,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,uCAAuB,CAAA;IACvB,iCAAiB,CAAA;AACnB,CAAC,EAHW,YAAY,4BAAZ,YAAY,QAGvB","sourcesContent":["/** Where a model's requests are processed, so a model picker can show where the data goes. */\nexport enum AiDataRegion {\n  Australia = 'australia',\n  Global = 'global',\n}\n"]}

package/lib/commonjs/actions/ai/AiJsonSchema.d.ts

@@ -0,0 +1,5 @@
+/**
+ * A JSON Schema object describing the shape a reply must take. Plain data, so it travels in the
+ * action payload and the log like any other field.
+ */
+export type AiJsonSchema = Record<string, unknown>;

package/lib/commonjs/actions/ai/AiJsonSchema.js

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

package/lib/commonjs/actions/ai/AiJsonSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AiJsonSchema.js","sourceRoot":"","sources":["../../../../src/actions/ai/AiJsonSchema.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * A JSON Schema object describing the shape a reply must take. Plain data, so it travels in the\n * action payload and the log like any other field.\n */\nexport type AiJsonSchema = Record<string, unknown>;\n"]}

package/lib/commonjs/actions/ai/AiMessage.d.ts

@@ -0,0 +1,52 @@
+export interface AiTextPart {
+    type: 'text';
+    text: string;
+}
+export interface AiFileUrlPart {
+    type: 'file';
+    url: string;
+    mediaType: string;
+    filename?: string;
+}
+export interface AiFileDrivePart {
+    type: 'file';
+    drive: string;
+    filepath: string;
+    scope?: string;
+    mediaType: string;
+    filename?: string;
+}
+export type AiFilePart = AiFileUrlPart | AiFileDrivePart;
+export interface AiToolCallPart {
+    type: 'tool-call';
+    toolCallId: string;
+    toolName: string;
+    input: unknown;
+}
+export interface AiReasoningPart {
+    type: 'reasoning';
+    text: string;
+    providerOptions?: Record<string, Record<string, unknown>>;
+}
+export interface AiToolResultPart {
+    type: 'tool-result';
+    toolCallId: string;
+    toolName: string;
+    output: unknown;
+    isError?: boolean;
+}
+export type AiUserMessagePart = AiTextPart | AiFilePart;
+export type AiAssistantMessagePart = AiTextPart | AiFilePart | AiToolCallPart | AiReasoningPart;
+export type AiUserMessage = {
+    role: 'user';
+    content: string | AiUserMessagePart[];
+};
+export type AiAssistantMessage = {
+    role: 'assistant';
+    content: string | AiAssistantMessagePart[];
+};
+export type AiToolMessage = {
+    role: 'tool';
+    content: AiToolResultPart[];
+};
+export type AiMessage = AiUserMessage | AiAssistantMessage | AiToolMessage;

package/lib/commonjs/actions/ai/AiMessage.js

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

package/lib/commonjs/actions/ai/AiMessage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AiMessage.js","sourceRoot":"","sources":["../../../../src/actions/ai/AiMessage.ts"],"names":[],"mappings":"","sourcesContent":["export interface AiTextPart {\n  type: 'text';\n  text: string;\n}\n\nexport interface AiFileUrlPart {\n  type: 'file';\n  url: string;\n  mediaType: string;\n  filename?: string;\n}\n\n// References a file on a storage drive — resolved to file contents by the action\n// processor at prompt time, so no presigned url ever enters logs or session state.\nexport interface AiFileDrivePart {\n  type: 'file';\n  drive: string;\n  filepath: string;\n  // Storage scope the file lives under, for scoped drives. Forwarded to the\n  // file read at resolve time; omit for unscoped drives.\n  scope?: string;\n  mediaType: string;\n  filename?: string;\n}\n\nexport type AiFilePart = AiFileUrlPart | AiFileDrivePart;\n\nexport interface AiToolCallPart {\n  type: 'tool-call';\n  toolCallId: string;\n  toolName: string;\n  input: unknown;\n}\n\nexport interface AiReasoningPart {\n  type: 'reasoning';\n  text: string;\n  providerOptions?: Record<string, Record<string, unknown>>;\n}\n\nexport interface AiToolResultPart {\n  type: 'tool-result';\n  toolCallId: string;\n  toolName: string;\n  output: unknown;\n  isError?: boolean;\n}\n\nexport type AiUserMessagePart = AiTextPart | AiFilePart;\nexport type AiAssistantMessagePart = AiTextPart | AiFilePart | AiToolCallPart | AiReasoningPart;\n\nexport type AiUserMessage = {\n  role: 'user';\n  content: string | AiUserMessagePart[];\n};\n\nexport type AiAssistantMessage = {\n  role: 'assistant';\n  content: string | AiAssistantMessagePart[];\n};\n\nexport type AiToolMessage = {\n  role: 'tool';\n  content: AiToolResultPart[];\n};\n\nexport type AiMessage = AiUserMessage | AiAssistantMessage | AiToolMessage;\n"]}

package/lib/commonjs/actions/ai/AiModel.d.ts

@@ -0,0 +1,19 @@
+export declare enum AiModel {
+    ClaudeHaiku35 = "claude-3-5-haiku",
+    ClaudeSonnet35 = "claude-3-5-sonnet",
+    ClaudeSonnet4 = "claude-sonnet-4",
+    ClaudeOpus4 = "claude-opus-4",
+    ClaudeHaiku45 = "claude-haiku-4-5",
+    ClaudeSonnet45 = "claude-sonnet-4-5",
+    ClaudeOpus45 = "claude-opus-4-5",
+    ClaudeSonnet46 = "claude-sonnet-4-6",
+    ClaudeOpus46 = "claude-opus-4-6",
+    ClaudeOpus47 = "claude-opus-4-7",
+    ClaudeOpus48 = "claude-opus-4-8",
+    ClaudeSonnet5 = "claude-sonnet-5",
+    ClaudeOpus5 = "claude-opus-5",
+    ClaudeOpus55 = "claude-opus-5-5",
+    ClaudeSonnet55 = "claude-sonnet-5-5",
+    ClaudeFable5 = "claude-fable-5",
+    ClaudeFable51 = "claude-fable-5-1"
+}

package/lib/commonjs/actions/ai/AiModel.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiModel = void 0;
+var AiModel;
+(function (AiModel) {
+    AiModel["ClaudeHaiku35"] = "claude-3-5-haiku";
+    AiModel["ClaudeSonnet35"] = "claude-3-5-sonnet";
+    AiModel["ClaudeSonnet4"] = "claude-sonnet-4";
+    AiModel["ClaudeOpus4"] = "claude-opus-4";
+    AiModel["ClaudeHaiku45"] = "claude-haiku-4-5";
+    AiModel["ClaudeSonnet45"] = "claude-sonnet-4-5";
+    AiModel["ClaudeOpus45"] = "claude-opus-4-5";
+    AiModel["ClaudeSonnet46"] = "claude-sonnet-4-6";
+    AiModel["ClaudeOpus46"] = "claude-opus-4-6";
+    AiModel["ClaudeOpus47"] = "claude-opus-4-7";
+    AiModel["ClaudeOpus48"] = "claude-opus-4-8";
+    AiModel["ClaudeSonnet5"] = "claude-sonnet-5";
+    AiModel["ClaudeOpus5"] = "claude-opus-5";
+    AiModel["ClaudeOpus55"] = "claude-opus-5-5";
+    AiModel["ClaudeSonnet55"] = "claude-sonnet-5-5";
+    AiModel["ClaudeFable5"] = "claude-fable-5";
+    AiModel["ClaudeFable51"] = "claude-fable-5-1";
+})(AiModel || (exports.AiModel = AiModel = {}));
+//# sourceMappingURL=AiModel.js.map

package/lib/commonjs/actions/ai/AiModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AiModel.js","sourceRoot":"","sources":["../../../../src/actions/ai/AiModel.ts"],"names":[],"mappings":";;;AAAA,IAAY,OAkBX;AAlBD,WAAY,OAAO;IACjB,6CAAkC,CAAA;IAClC,+CAAoC,CAAA;IACpC,4CAAiC,CAAA;IACjC,wCAA6B,CAAA;IAC7B,6CAAkC,CAAA;IAClC,+CAAoC,CAAA;IACpC,2CAAgC,CAAA;IAChC,+CAAoC,CAAA;IACpC,2CAAgC,CAAA;IAChC,2CAAgC,CAAA;IAChC,2CAAgC,CAAA;IAChC,4CAAiC,CAAA;IACjC,wCAA6B,CAAA;IAC7B,2CAAgC,CAAA;IAChC,+CAAoC,CAAA;IACpC,0CAA+B,CAAA;IAC/B,6CAAkC,CAAA;AACpC,CAAC,EAlBW,OAAO,uBAAP,OAAO,QAkBlB","sourcesContent":["export enum AiModel {\n  ClaudeHaiku35 = 'claude-3-5-haiku',\n  ClaudeSonnet35 = 'claude-3-5-sonnet',\n  ClaudeSonnet4 = 'claude-sonnet-4',\n  ClaudeOpus4 = 'claude-opus-4',\n  ClaudeHaiku45 = 'claude-haiku-4-5',\n  ClaudeSonnet45 = 'claude-sonnet-4-5',\n  ClaudeOpus45 = 'claude-opus-4-5',\n  ClaudeSonnet46 = 'claude-sonnet-4-6',\n  ClaudeOpus46 = 'claude-opus-4-6',\n  ClaudeOpus47 = 'claude-opus-4-7',\n  ClaudeOpus48 = 'claude-opus-4-8',\n  ClaudeSonnet5 = 'claude-sonnet-5',\n  ClaudeOpus5 = 'claude-opus-5',\n  ClaudeOpus55 = 'claude-opus-5-5',\n  ClaudeSonnet55 = 'claude-sonnet-5-5',\n  ClaudeFable5 = 'claude-fable-5',\n  ClaudeFable51 = 'claude-fable-5-1',\n}\n"]}

package/lib/commonjs/actions/ai/AiModelRegionMap.d.ts

@@ -0,0 +1,4 @@
+import { AiDataRegion } from './AiDataRegion';
+import { AiModel } from './AiModel';
+/** The regions each model is offered in on the current platform; a model may be in several. */
+export type AiModelRegionMap = Record<AiModel, AiDataRegion[]>;

package/lib/commonjs/actions/ai/AiModelRegionMap.js

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

package/lib/commonjs/actions/ai/AiModelRegionMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AiModelRegionMap.js","sourceRoot":"","sources":["../../../../src/actions/ai/AiModelRegionMap.ts"],"names":[],"mappings":"","sourcesContent":["import { AiDataRegion } from './AiDataRegion';\nimport { AiModel } from './AiModel';\n\n/** The regions each model is offered in on the current platform; a model may be in several. */\nexport type AiModelRegionMap = Record<AiModel, AiDataRegion[]>;\n"]}

package/lib/commonjs/actions/ai/AiReasoningConfig.d.ts

@@ -0,0 +1,10 @@
+import { AiReasoningEffort } from './AiReasoningEffort';
+/**
+ * Enables extended thinking for a prompt at the given effort. Presence turns thinking on. On
+ * Claude 4.6 and older the platform turns the effort into a thinking token budget; Opus 4.7 and
+ * newer and Sonnet 5 run adaptive thinking and take the effort directly. Reasoning progress is
+ * surfaced as Reasoning* stream parts.
+ */
+export type AiReasoningConfig = {
+    effort: AiReasoningEffort;
+};

package/lib/commonjs/actions/ai/AiReasoningConfig.js

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

package/lib/commonjs/actions/ai/AiReasoningConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AiReasoningConfig.js","sourceRoot":"","sources":["../../../../src/actions/ai/AiReasoningConfig.ts"],"names":[],"mappings":"","sourcesContent":["import { AiReasoningEffort } from './AiReasoningEffort';\n\n/**\n * Enables extended thinking for a prompt at the given effort. Presence turns thinking on. On\n * Claude 4.6 and older the platform turns the effort into a thinking token budget; Opus 4.7 and\n * newer and Sonnet 5 run adaptive thinking and take the effort directly. Reasoning progress is\n * surfaced as Reasoning* stream parts.\n */\nexport type AiReasoningConfig = {\n  effort: AiReasoningEffort;\n};\n"]}

package/lib/commonjs/actions/ai/AiReasoningEffort.d.ts

@@ -0,0 +1,8 @@
+/** How hard a model that runs adaptive thinking may think before it answers. */
+export declare enum AiReasoningEffort {
+    Low = "low",
+    Medium = "medium",
+    High = "high",
+    XHigh = "xhigh",
+    Max = "max"
+}

package/lib/commonjs/actions/ai/AiReasoningEffort.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiReasoningEffort = void 0;
+/** How hard a model that runs adaptive thinking may think before it answers. */
+var AiReasoningEffort;
+(function (AiReasoningEffort) {
+    AiReasoningEffort["Low"] = "low";
+    AiReasoningEffort["Medium"] = "medium";
+    AiReasoningEffort["High"] = "high";
+    AiReasoningEffort["XHigh"] = "xhigh";
+    AiReasoningEffort["Max"] = "max";
+})(AiReasoningEffort || (exports.AiReasoningEffort = AiReasoningEffort = {}));
+//# sourceMappingURL=AiReasoningEffort.js.map

package/lib/commonjs/actions/ai/AiReasoningEffort.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AiReasoningEffort.js","sourceRoot":"","sources":["../../../../src/actions/ai/AiReasoningEffort.ts"],"names":[],"mappings":";;;AAAA,gFAAgF;AAChF,IAAY,iBAMX;AAND,WAAY,iBAAiB;IAC3B,gCAAW,CAAA;IACX,sCAAiB,CAAA;IACjB,kCAAa,CAAA;IACb,oCAAe,CAAA;IACf,gCAAW,CAAA;AACb,CAAC,EANW,iBAAiB,iCAAjB,iBAAiB,QAM5B","sourcesContent":["/** How hard a model that runs adaptive thinking may think before it answers. */\nexport enum AiReasoningEffort {\n  Low = 'low',\n  Medium = 'medium',\n  High = 'high',\n  XHigh = 'xhigh',\n  Max = 'max',\n}\n"]}

package/lib/commonjs/actions/ai/askAiGetModelRegions.d.ts

@@ -0,0 +1,8 @@
+import { AiActionType } from './AiActionType';
+import { AiModelRegionMap } from './AiModelRegionMap';
+/**
+ * The regions every `AiModel` is offered in on the current platform, for a picker that shows
+ * where a request's data goes. The mapping is platform-owned, so a story asks for it rather than
+ * hard-coding it.
+ */
+export declare const askAiGetModelRegions: import("../../types").ActionRequesterFunction<AiActionType.GetModelRegions, [], undefined, AiModelRegionMap, never>;

package/lib/commonjs/actions/ai/askAiGetModelRegions.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.askAiGetModelRegions = void 0;
+const types_1 = require("../../types");
+const AiActionType_1 = require("./AiActionType");
+/**
+ * The regions every `AiModel` is offered in on the current platform, for a picker that shows
+ * where a request's data goes. The mapping is platform-owned, so a story asks for it rather than
+ * hard-coding it.
+ */
+exports.askAiGetModelRegions = (0, types_1.createActionRequester)()({
+    actionType: AiActionType_1.AiActionType.GetModelRegions,
+});
+//# sourceMappingURL=askAiGetModelRegions.js.map

package/lib/commonjs/actions/ai/askAiGetModelRegions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"askAiGetModelRegions.js","sourceRoot":"","sources":["../../../../src/actions/ai/askAiGetModelRegions.ts"],"names":[],"mappings":";;;AAAA,uCAAoD;AACpD,iDAA8C;AAG9C;;;;GAIG;AACU,QAAA,oBAAoB,GAAG,IAAA,6BAAqB,GAAoB,CAAC;IAC5E,UAAU,EAAE,2BAAY,CAAC,eAAe;CACzC,CAAC,CAAC","sourcesContent":["import { createActionRequester } from '../../types';\nimport { AiActionType } from './AiActionType';\nimport { AiModelRegionMap } from './AiModelRegionMap';\n\n/**\n * The regions every `AiModel` is offered in on the current platform, for a picker that shows\n * where a request's data goes. The mapping is platform-owned, so a story asks for it rather than\n * hard-coding it.\n */\nexport const askAiGetModelRegions = createActionRequester<AiModelRegionMap>()({\n  actionType: AiActionType.GetModelRegions,\n});\n"]}

package/lib/commonjs/actions/ai/askAiPrompt.d.ts

@@ -0,0 +1,59 @@
+import { AiStreamUsage } from './types/AiStreamUsage';
+import { AiActionType } from './AiActionType';
+import { AiCacheTtl } from './AiCacheTtl';
+import { AiJsonSchema } from './AiJsonSchema';
+import { AiMessage } from './AiMessage';
+import { AiModel } from './AiModel';
+import { AiReasoningConfig } from './AiReasoningConfig';
+export type AskAiPromptOptions = {
+    system?: string;
+    aiName?: string;
+    messages?: AiMessage[];
+    /** Per-request messages sent after `messages`. They never receive a cache point and the caller
+     *  never persists them; with only `prompt`, the prompt becomes the first user message. */
+    turnContext?: AiMessage[];
+    reasoning?: AiReasoningConfig;
+    caching?: boolean;
+    /** Requested lifetime of the request's cache points. Unset means `AiCacheTtl.Dynamic`. */
+    cacheTtl?: AiCacheTtl;
+    /** Stop the tool loop between steps once this much wall-clock time has passed. The
+     *  turn then finishes with `toolCalls` if the model still wanted to act, so it can be resumed. */
+    maxDurationMs?: number;
+    /** Cap on model/tool steps in one call. Unset means the loop runs until the model stops
+     *  (or `maxDurationMs` trips); client-side tools still halt it immediately. */
+    maxSteps?: number;
+    /** Output token cap per model call. Unset uses the provider default (8192 on Bedrock), which a
+     *  large tool input plus reasoning can exceed; the step then finishes with `length`. */
+    maxOutputTokens?: number;
+    /** The reply must be a JSON value matching this schema. It is checked before it is returned, and
+     *  a reply that does not match is an `Invalid` action error, never a result. */
+    outputSchema?: AiJsonSchema;
+    /** With `outputSchema`: how many times a reply that does not match is shown back to the model with
+     *  the problems listed, to correct. Each is another model call. Unset means none. */
+    outputRepairAttempts?: number;
+};
+export type AiPromptActionResult = {
+    text: string;
+    /** The reply, parsed and checked against `outputSchema`. Set only when a schema was given. */
+    object?: unknown;
+    /** How many repair calls the reply took (see `outputRepairAttempts`). Set only with a schema. */
+    repairs?: number;
+    /** Token usage summed across every step, when the provider reports it. */
+    usage?: AiStreamUsage;
+};
+export declare const askAiPrompt: import("../../types").ActionRequesterFunction<AiActionType.Prompt, [model: AiModel, prompt: string, options?: AskAiPromptOptions | undefined], {
+    model: AiModel;
+    prompt: string;
+    messages: AiMessage[] | undefined;
+    turnContext: AiMessage[] | undefined;
+    system: string | undefined;
+    aiName: string | undefined;
+    reasoning: AiReasoningConfig | undefined;
+    caching: boolean | undefined;
+    cacheTtl: AiCacheTtl | undefined;
+    maxDurationMs: number | undefined;
+    maxSteps: number | undefined;
+    maxOutputTokens: number | undefined;
+    outputSchema: AiJsonSchema | undefined;
+    outputRepairAttempts: number | undefined;
+}, AiPromptActionResult, never>;

package/lib/commonjs/actions/ai/askAiPrompt.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.askAiPrompt = void 0;
+const types_1 = require("../../types");
+const AiActionType_1 = require("./AiActionType");
+exports.askAiPrompt = (0, types_1.createActionRequester)()({
+    actionType: AiActionType_1.AiActionType.Prompt,
+    getPayload: (model, prompt, options) => ({
+        model,
+        prompt,
+        messages: options === null || options === void 0 ? void 0 : options.messages,
+        turnContext: options === null || options === void 0 ? void 0 : options.turnContext,
+        system: options === null || options === void 0 ? void 0 : options.system,
+        aiName: options === null || options === void 0 ? void 0 : options.aiName,
+        reasoning: options === null || options === void 0 ? void 0 : options.reasoning,
+        caching: options === null || options === void 0 ? void 0 : options.caching,
+        cacheTtl: options === null || options === void 0 ? void 0 : options.cacheTtl,
+        maxDurationMs: options === null || options === void 0 ? void 0 : options.maxDurationMs,
+        maxSteps: options === null || options === void 0 ? void 0 : options.maxSteps,
+        maxOutputTokens: options === null || options === void 0 ? void 0 : options.maxOutputTokens,
+        outputSchema: options === null || options === void 0 ? void 0 : options.outputSchema,
+        outputRepairAttempts: options === null || options === void 0 ? void 0 : options.outputRepairAttempts,
+    }),
+});
+//# sourceMappingURL=askAiPrompt.js.map

package/lib/commonjs/actions/ai/askAiPrompt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"askAiPrompt.js","sourceRoot":"","sources":["../../../../src/actions/ai/askAiPrompt.ts"],"names":[],"mappings":";;;AAAA,uCAAoD;AAEpD,iDAA8C;AA6CjC,QAAA,WAAW,GAAG,IAAA,6BAAqB,GAAwB,CAAC;IACvE,UAAU,EAAE,2BAAY,CAAC,MAAM;IAC/B,UAAU,EAAE,CAAC,KAAc,EAAE,MAAc,EAAE,OAA4B,EAAE,EAAE,CAAC,CAAC;QAC7E,KAAK;QACL,MAAM;QACN,QAAQ,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ;QAC3B,WAAW,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW;QACjC,MAAM,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;QACvB,MAAM,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;QACvB,SAAS,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS;QAC7B,OAAO,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO;QACzB,QAAQ,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ;QAC3B,aAAa,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,aAAa;QACrC,QAAQ,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ;QAC3B,eAAe,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe;QACzC,YAAY,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,YAAY;QACnC,oBAAoB,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,oBAAoB;KACpD,CAAC;CACH,CAAC,CAAC","sourcesContent":["import { createActionRequester } from '../../types';\nimport { AiStreamUsage } from './types/AiStreamUsage';\nimport { AiActionType } from './AiActionType';\nimport { AiCacheTtl } from './AiCacheTtl';\nimport { AiJsonSchema } from './AiJsonSchema';\nimport { AiMessage } from './AiMessage';\nimport { AiModel } from './AiModel';\nimport { AiReasoningConfig } from './AiReasoningConfig';\n\nexport type AskAiPromptOptions = {\n  system?: string;\n  aiName?: string;\n  messages?: AiMessage[];\n  /** Per-request messages sent after `messages`. They never receive a cache point and the caller\n   *  never persists them; with only `prompt`, the prompt becomes the first user message. */\n  turnContext?: AiMessage[];\n  reasoning?: AiReasoningConfig;\n  caching?: boolean;\n  /** Requested lifetime of the request's cache points. Unset means `AiCacheTtl.Dynamic`. */\n  cacheTtl?: AiCacheTtl;\n  /** Stop the tool loop between steps once this much wall-clock time has passed. The\n   *  turn then finishes with `toolCalls` if the model still wanted to act, so it can be resumed. */\n  maxDurationMs?: number;\n  /** Cap on model/tool steps in one call. Unset means the loop runs until the model stops\n   *  (or `maxDurationMs` trips); client-side tools still halt it immediately. */\n  maxSteps?: number;\n  /** Output token cap per model call. Unset uses the provider default (8192 on Bedrock), which a\n   *  large tool input plus reasoning can exceed; the step then finishes with `length`. */\n  maxOutputTokens?: number;\n  /** The reply must be a JSON value matching this schema. It is checked before it is returned, and\n   *  a reply that does not match is an `Invalid` action error, never a result. */\n  outputSchema?: AiJsonSchema;\n  /** With `outputSchema`: how many times a reply that does not match is shown back to the model with\n   *  the problems listed, to correct. Each is another model call. Unset means none. */\n  outputRepairAttempts?: number;\n};\n\nexport type AiPromptActionResult = {\n  text: string;\n  /** The reply, parsed and checked against `outputSchema`. Set only when a schema was given. */\n  object?: unknown;\n  /** How many repair calls the reply took (see `outputRepairAttempts`). Set only with a schema. */\n  repairs?: number;\n  /** Token usage summed across every step, when the provider reports it. */\n  usage?: AiStreamUsage;\n};\n\nexport const askAiPrompt = createActionRequester<AiPromptActionResult>()({\n  actionType: AiActionType.Prompt,\n  getPayload: (model: AiModel, prompt: string, options?: AskAiPromptOptions) => ({\n    model,\n    prompt,\n    messages: options?.messages,\n    turnContext: options?.turnContext,\n    system: options?.system,\n    aiName: options?.aiName,\n    reasoning: options?.reasoning,\n    caching: options?.caching,\n    cacheTtl: options?.cacheTtl,\n    maxDurationMs: options?.maxDurationMs,\n    maxSteps: options?.maxSteps,\n    maxOutputTokens: options?.maxOutputTokens,\n    outputSchema: options?.outputSchema,\n    outputRepairAttempts: options?.outputRepairAttempts,\n  }),\n});\n"]}

package/lib/commonjs/actions/ai/askAiPromptStream.d.ts

@@ -0,0 +1,42 @@
+import { StreamHandle } from '../../types/StreamRegistry';
+import { AiActionType } from './AiActionType';
+import { AiCacheTtl } from './AiCacheTtl';
+import { AiMessage } from './AiMessage';
+import { AiModel } from './AiModel';
+import { AiReasoningConfig } from './AiReasoningConfig';
+import { AiStreamPart } from './types';
+export type AskAiPromptStreamOptions = {
+    system?: string;
+    aiName?: string;
+    messages?: AiMessage[];
+    /** Per-request messages sent after `messages`. They never receive a cache point and the caller
+     *  never persists them; with only `prompt`, the prompt becomes the first user message. */
+    turnContext?: AiMessage[];
+    reasoning?: AiReasoningConfig;
+    caching?: boolean;
+    /** Requested lifetime of the request's cache points. Unset means `AiCacheTtl.Dynamic`. */
+    cacheTtl?: AiCacheTtl;
+    /** Stop the tool loop between steps once this much wall-clock time has passed. The
+     *  turn then finishes with `toolCalls` if the model still wanted to act, so it can be resumed. */
+    maxDurationMs?: number;
+    /** Cap on model/tool steps in one call. Unset means the loop runs until the model stops
+     *  (or `maxDurationMs` trips); client-side tools still halt it immediately. */
+    maxSteps?: number;
+    /** Output token cap per model call. Unset uses the provider default (8192 on Bedrock), which a
+     *  large tool input plus reasoning can exceed; the step then finishes with `length`. */
+    maxOutputTokens?: number;
+};
+export declare const askAiPromptStream: import("../../types").ActionRequesterFunction<AiActionType.PromptStream, [model: AiModel, prompt: string, options?: AskAiPromptStreamOptions | undefined], {
+    model: AiModel;
+    prompt: string;
+    messages: AiMessage[] | undefined;
+    turnContext: AiMessage[] | undefined;
+    system: string | undefined;
+    aiName: string | undefined;
+    reasoning: AiReasoningConfig | undefined;
+    caching: boolean | undefined;
+    cacheTtl: AiCacheTtl | undefined;
+    maxDurationMs: number | undefined;
+    maxSteps: number | undefined;
+    maxOutputTokens: number | undefined;
+}, StreamHandle<"json", AiStreamPart>, never>;

package/lib/commonjs/actions/ai/askAiPromptStream.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.askAiPromptStream = void 0;
+const types_1 = require("../../types");
+const AiActionType_1 = require("./AiActionType");
+exports.askAiPromptStream = (0, types_1.createActionRequester)()({
+    actionType: AiActionType_1.AiActionType.PromptStream,
+    getPayload: (model, prompt, options) => ({
+        model,
+        prompt,
+        messages: options === null || options === void 0 ? void 0 : options.messages,
+        turnContext: options === null || options === void 0 ? void 0 : options.turnContext,
+        system: options === null || options === void 0 ? void 0 : options.system,
+        aiName: options === null || options === void 0 ? void 0 : options.aiName,
+        reasoning: options === null || options === void 0 ? void 0 : options.reasoning,
+        caching: options === null || options === void 0 ? void 0 : options.caching,
+        cacheTtl: options === null || options === void 0 ? void 0 : options.cacheTtl,
+        maxDurationMs: options === null || options === void 0 ? void 0 : options.maxDurationMs,
+        maxSteps: options === null || options === void 0 ? void 0 : options.maxSteps,
+        maxOutputTokens: options === null || options === void 0 ? void 0 : options.maxOutputTokens,
+    }),
+});
+//# sourceMappingURL=askAiPromptStream.js.map

package/lib/commonjs/actions/ai/askAiPromptStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"askAiPromptStream.js","sourceRoot":"","sources":["../../../../src/actions/ai/askAiPromptStream.ts"],"names":[],"mappings":";;;AAAA,uCAAoD;AAEpD,iDAA8C;AA6BjC,QAAA,iBAAiB,GAAG,IAAA,6BAAqB,GAAsC,CAAC;IAC3F,UAAU,EAAE,2BAAY,CAAC,YAAY;IACrC,UAAU,EAAE,CAAC,KAAc,EAAE,MAAc,EAAE,OAAkC,EAAE,EAAE,CAAC,CAAC;QACnF,KAAK;QACL,MAAM;QACN,QAAQ,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ;QAC3B,WAAW,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW;QACjC,MAAM,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;QACvB,MAAM,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM;QACvB,SAAS,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,SAAS;QAC7B,OAAO,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO;QACzB,QAAQ,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ;QAC3B,aAAa,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,aAAa;QACrC,QAAQ,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,QAAQ;QAC3B,eAAe,EAAE,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,eAAe;KAC1C,CAAC;CACH,CAAC,CAAC","sourcesContent":["import { createActionRequester } from '../../types';\nimport { StreamHandle } from '../../types/StreamRegistry';\nimport { AiActionType } from './AiActionType';\nimport { AiCacheTtl } from './AiCacheTtl';\nimport { AiMessage } from './AiMessage';\nimport { AiModel } from './AiModel';\nimport { AiReasoningConfig } from './AiReasoningConfig';\nimport { AiStreamPart } from './types';\n\nexport type AskAiPromptStreamOptions = {\n  system?: string;\n  aiName?: string;\n  messages?: AiMessage[];\n  /** Per-request messages sent after `messages`. They never receive a cache point and the caller\n   *  never persists them; with only `prompt`, the prompt becomes the first user message. */\n  turnContext?: AiMessage[];\n  reasoning?: AiReasoningConfig;\n  caching?: boolean;\n  /** Requested lifetime of the request's cache points. Unset means `AiCacheTtl.Dynamic`. */\n  cacheTtl?: AiCacheTtl;\n  /** Stop the tool loop between steps once this much wall-clock time has passed. The\n   *  turn then finishes with `toolCalls` if the model still wanted to act, so it can be resumed. */\n  maxDurationMs?: number;\n  /** Cap on model/tool steps in one call. Unset means the loop runs until the model stops\n   *  (or `maxDurationMs` trips); client-side tools still halt it immediately. */\n  maxSteps?: number;\n  /** Output token cap per model call. Unset uses the provider default (8192 on Bedrock), which a\n   *  large tool input plus reasoning can exceed; the step then finishes with `length`. */\n  maxOutputTokens?: number;\n};\n\nexport const askAiPromptStream = createActionRequester<StreamHandle<'json', AiStreamPart>>()({\n  actionType: AiActionType.PromptStream,\n  getPayload: (model: AiModel, prompt: string, options?: AskAiPromptStreamOptions) => ({\n    model,\n    prompt,\n    messages: options?.messages,\n    turnContext: options?.turnContext,\n    system: options?.system,\n    aiName: options?.aiName,\n    reasoning: options?.reasoning,\n    caching: options?.caching,\n    cacheTtl: options?.cacheTtl,\n    maxDurationMs: options?.maxDurationMs,\n    maxSteps: options?.maxSteps,\n    maxOutputTokens: options?.maxOutputTokens,\n  }),\n});\n"]}

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

@@ -0,0 +1,14 @@
+export * from './AiActionType';
+export * from './AiCacheTtl';
+export * from './AiDataRegion';
+export * from './AiJsonSchema';
+export * from './AiMessage';
+export * from './AiModel';
+export * from './AiModelRegionMap';
+export * from './AiReasoningConfig';
+export * from './AiReasoningEffort';
+export * from './askAiGetModelRegions';
+export * from './askAiPrompt';
+export * from './askAiPromptStream';
+export * from './sumAiStreamUsage';
+export * from './types';

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

@@ -0,0 +1,31 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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("./AiActionType"), exports);
+__exportStar(require("./AiCacheTtl"), exports);
+__exportStar(require("./AiDataRegion"), exports);
+__exportStar(require("./AiJsonSchema"), exports);
+__exportStar(require("./AiMessage"), exports);
+__exportStar(require("./AiModel"), exports);
+__exportStar(require("./AiModelRegionMap"), exports);
+__exportStar(require("./AiReasoningConfig"), exports);
+__exportStar(require("./AiReasoningEffort"), exports);
+__exportStar(require("./askAiGetModelRegions"), exports);
+__exportStar(require("./askAiPrompt"), exports);
+__exportStar(require("./askAiPromptStream"), exports);
+__exportStar(require("./sumAiStreamUsage"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map