ankka 0.11.0 → 0.13.0

package/dist/view.d.ts

@@ -5,6 +5,7 @@ import type { Metadata } from "./effects/common.ts";
 import type { ComponentClient } from "./client.ts";
 import type { ComponentRef } from "./client.ts";
 import { ViewEffects, type ViewEffect } from "./effects/stateless.ts";
+import type { Standing } from "./standing.ts";
 type MaybePromise<T> = T | Promise<T>;
 /**
  * A question a view can be asked by name: one SQL statement over the view's own table, whose values
@@ -16,9 +17,16 @@ type MaybePromise<T> = T | Promise<T>;
 export interface DeclaredQuery {
     readonly name: string;
     readonly statement: string;
+    /** Whether it may be watched: its statement selects `row_key` beside `payload`, with no limit and no aggregate. */
+    readonly watched?: boolean;
 }
-/** Declares a query for a view's `static declared`. The SDK sends the statement as written. */
-export declare function declaredQuery(name: string, statement: string): DeclaredQuery;
+/**
+ * Declares a query for a view's `static declared`. The SDK sends the statement as written.
+ * `{ watched: true }` declares that it may also be watched, which the platform checks at start.
+ */
+export declare function declaredQuery(name: string, statement: string, options?: {
+    readonly watched?: boolean;
+}): DeclaredQuery;
 /** The table a view's rows are kept in, for a declared query's statement to name. */
 export declare function tableOf(componentId: string): string;
 export declare abstract class View<E, Row> {
@@ -30,6 +38,8 @@ export declare abstract class View<E, Row> {
     get metadata(): Metadata;
     /** The id of the source instance the change came from. */
     get subject(): string;
+    /** Of a change from a workflow: where it stood once the effect that recorded the state was applied. `undefined` for a change from an entity or a topic. */
+    get standing(): Standing | undefined;
     get client(): ComponentClient;
     /** @internal */
     get _kind(): "view";
@@ -38,7 +48,7 @@ export declare abstract class View<E, Row> {
     /** The source was deleted. The row goes with it unless this says otherwise — an order history keeps a checked-out cart's row. */
     onDelete(): MaybePromise<ViewEffect<Row>>;
     /** @internal */
-    _bind(row: Row | null, metadata: Metadata, client: ComponentClient): void;
+    _bind(row: Row | null, metadata: Metadata, client: ComponentClient, standing?: Standing): void;
 }
 export interface ViewClass<E = unknown, Row = unknown, C extends View<E, Row> = View<E, Row>> {
     new (): C;
@@ -57,6 +67,11 @@ export interface ViewClass<E = unknown, Row = unknown, C extends View<E, Row> =
     readonly contract?: Contract;
     /** The declared broker the topic read is on; absent is the installation's. */
     readonly broker?: string;
+    /**
+     * Another project's topic (1.15): the id of the project whose topic `topic` is. The broker serves it
+     * while that project grants this service consume on it.
+     */
+    readonly project?: string;
     /** Whether the partitions an instance holds are handled at once, each in order. */
     readonly parallel?: boolean;
     readonly events: Shape<E>;

package/dist/view.js

@@ -9,9 +9,12 @@
 //     onChange(event) { ... return this.effects.updateRow(...) }
 //   }
 import { ViewEffects } from "./effects/stateless.js";
-/** Declares a query for a view's `static declared`. The SDK sends the statement as written. */
-export function declaredQuery(name, statement) {
-    return Object.freeze({ name, statement });
+/**
+ * Declares a query for a view's `static declared`. The SDK sends the statement as written.
+ * `{ watched: true }` declares that it may also be watched, which the platform checks at start.
+ */
+export function declaredQuery(name, statement, options = {}) {
+    return Object.freeze({ name, statement, watched: options.watched ?? false });
 }
 /** The table a view's rows are kept in, for a declared query's statement to name. */
 export function tableOf(componentId) {
@@ -21,6 +24,7 @@ export class View {
     effects = new ViewEffects();
     #row = null;
     #metadata = {};
+    #standing = undefined;
     #client;
     #bound = false;
     /** The current row, or `null` when there is none yet. */
@@ -37,6 +41,10 @@ export class View {
     get subject() {
         return this.#metadata["ce-subject"] ?? "";
     }
+    /** Of a change from a workflow: where it stood once the effect that recorded the state was applied. `undefined` for a change from an entity or a topic. */
+    get standing() {
+        return this.#standing;
+    }
     get client() {
         if (!this.#client)
             throw new Error("client is only available inside onChange or onDelete");
@@ -51,9 +59,10 @@ export class View {
         return this.effects.deleteRow();
     }
     /** @internal */
-    _bind(row, metadata, client) {
+    _bind(row, metadata, client, standing) {
         this.#row = row;
         this.#metadata = metadata;
+        this.#standing = standing;
         this.#client = client;
         this.#bound = true;
     }

package/dist/workflow.d.ts

@@ -4,6 +4,7 @@ import type { HandlerTable } from "./handlers.ts";
 import { type ComponentClient, type Secrets } from "./client.ts";
 import { StepEffects, WorkflowEffects, type WorkflowSettings } from "./effects/workflow.ts";
 import { type Services } from "./services.ts";
+import { type Buckets } from "./storage.ts";
 export declare abstract class Workflow<S> {
     #private;
     /** Inside a command handler. */
@@ -21,6 +22,13 @@ export declare abstract class Workflow<S> {
     get secrets(): Secrets;
     /** A unit test's store in place of the runtime's. */
     set secrets(store: Secrets);
+    /**
+     * The service's buckets, in a step. A command handler is refused: a wait on a store would hold the
+     * workflow's other commands behind it.
+     */
+    get storage(): Buckets;
+    /** A unit test's store in place of the runtime's. */
+    set storage(buckets: Buckets);
     /**
      * Other services, called as this one, in a step. A command handler is refused, as for the secret
      * store: it would block the workflow's other commands behind another service.

package/dist/workflow.js

@@ -9,6 +9,7 @@ import { secretsFor } from "./client.js";
 import { CommandError } from "./effects/common.js";
 import { StepEffects, WorkflowEffects } from "./effects/workflow.js";
 import { servicesFor } from "./services.js";
+import { processStorage, StorageRefusals } from "./storage.js";
 export class Workflow {
     /** Inside a command handler. */
     effects = new WorkflowEffects();
@@ -55,6 +56,20 @@ export class Workflow {
     set secrets(store) {
         this.#secrets = store;
     }
+    #storage;
+    /**
+     * The service's buckets, in a step. A command handler is refused: a wait on a store would hold the
+     * workflow's other commands behind it.
+     */
+    get storage() {
+        if (!this.#inStep)
+            throw StorageRefusals.stepsOnly();
+        return this.#storage ?? processStorage();
+    }
+    /** A unit test's store in place of the runtime's. */
+    set storage(buckets) {
+        this.#storage = buckets;
+    }
     #services;
     /**
      * Other services, called as this one, in a step. A command handler is refused, as for the secret

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ankka",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "description": "Build services on ankka in TypeScript: entities, views, workflows, agents and endpoints hosted by the ankka sidecar.",
   "license": "Apache-2.0",
   "type": "module",