@ariestools/aries-dapp-core 0.1.7 → 0.1.8

package/dist/node/publication/types.d.ts

@@ -0,0 +1,138 @@
+import type { DappObjectWriter } from '../providers/capabilities.ts';
+import type { GENERATION_MANIFEST_SCHEMA, HEAD_MANIFEST_SCHEMA, INDEXER_STATUS_SCHEMA } from './constants.ts';
+import type { PublicationConflict, PublicationSafety, PublicationTrust } from './safety.ts';
+/** One published object within a generation. */
+export interface GenerationObjectRef {
+    contentType?: string;
+    /** SHA-256 hex of the object body. */
+    hash: string;
+    /** Relative key under the role store (includes `generations/<id>/...`). */
+    key: string;
+    /** Optional public URL when the role has a CDN base configured. */
+    publicUrl?: string;
+    role: 'state' | 'index';
+    size: number;
+}
+/**
+ * Immutable generation manifest. Identifies and hashes every state/index
+ * object in the generation and records source progress plus reducer/schema
+ * versions so clients can verify coherence.
+ */
+export interface GenerationManifest {
+    generation: string;
+    objects: GenerationObjectRef[];
+    publishedAt: string;
+    reducer: {
+        name: string;
+        version?: string;
+    };
+    schema: typeof GENERATION_MANIFEST_SCHEMA;
+    schemaVersion?: string;
+    source: {
+        completedPosition?: string;
+        cursor?: string;
+        floor?: string;
+        observedHead?: string;
+    };
+}
+/**
+ * Small mutable head object written last. Points at one complete generation
+ * so readers never observe a partial publication.
+ */
+export type PublicationLayout = 'full' | 'incremental-cas';
+export interface HeadManifest {
+    generation: string;
+    /** Publication layout; omit/`full` for classic generations/ manifests. */
+    layout?: PublicationLayout;
+    /** SHA-256 of the generation manifest (full) or map root (incremental). */
+    manifestHash: string;
+    /** Relative key of the generation manifest or map root on the state store. */
+    manifestKey: string;
+    /** Prior generation id when this head advances a chain. */
+    previousGeneration?: string;
+    publishedAt: string;
+    /** Monotonic revision when known (1 for first head). */
+    revision?: number;
+    schema: typeof HEAD_MANIFEST_SCHEMA;
+    /** Detached signature over canonical head bytes (signed trust mode). */
+    signature?: string;
+    trust?: 'trusted-origin' | 'signed';
+}
+/**
+ * Machine-readable indexer status published through object storage so a
+ * backend with no inbound listener can still expose progress to operators and
+ * CDN readers.
+ */
+export interface IndexerStatus {
+    consecutiveFailures: number;
+    cursor?: string;
+    floor?: string;
+    generation?: string;
+    /** Relative key or public URL of the generation root/manifest. */
+    generationRoot?: string;
+    lastCompletedPosition?: string;
+    lastError?: string;
+    lastErrorAt?: string;
+    lastSuccessAt?: string;
+    observedSourceHead?: string;
+    schema: typeof INDEXER_STATUS_SCHEMA;
+    updatedAt: string;
+}
+export interface PublishObjectInput {
+    body: string | Uint8Array;
+    contentType?: string;
+    /** Relative path under the generation root (not including `generations/<id>/`). */
+    key: string;
+    metadata?: Record<string, string>;
+}
+export interface PublishGenerationInput {
+    /**
+     * When false, skip the capability probe (tests with known-good stores).
+     * Default true when safety is conditional-head.
+     */
+    assertSafety?: boolean;
+    /**
+     * ETag of the current head for CAS update. Omit when creating the first head
+     * (If-None-Match: *). Required for non-first conditional-head publishes.
+     */
+    expectedHeadEtag?: string;
+    generation?: string;
+    index: DappObjectWriter;
+    indexObjects?: readonly PublishObjectInput[];
+    /** Prior generation id recorded on the new head. */
+    previousGeneration?: string;
+    reducer: {
+        name: string;
+        version?: string;
+    };
+    /** Monotonic revision for the new head (defaults to 1 or previous+1 when known). */
+    revision?: number;
+    /**
+     * Fencing mode. Required for production-safe publication. Use
+     * `{ mode: 'conditional-head' }` when the provider supports CAS, or inject a
+     * lease adapter.
+     */
+    safety: PublicationSafety;
+    schemaVersion?: string;
+    signal?: AbortSignal;
+    source?: GenerationManifest['source'];
+    state: DappObjectWriter;
+    stateObjects?: readonly PublishObjectInput[];
+    trust?: PublicationTrust;
+}
+export interface PublishGenerationSuccess {
+    generation: string;
+    head: HeadManifest;
+    headEtag?: string;
+    headKey: string;
+    manifest: GenerationManifest;
+    manifestHash: string;
+    manifestKey: string;
+    ok: true;
+}
+export interface PublishGenerationConflict {
+    conflict: PublicationConflict;
+    ok: false;
+}
+export type PublishGenerationResult = PublishGenerationSuccess | PublishGenerationConflict;
+//# sourceMappingURL=types.d.ts.map

package/dist/node/publication/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/publication/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,KAAK,EACV,0BAA0B,EAAE,oBAAoB,EAAE,qBAAqB,EACxE,MAAM,gBAAgB,CAAA;AACvB,OAAO,KAAK,EACV,mBAAmB,EAAE,iBAAiB,EAAE,gBAAgB,EACzD,MAAM,aAAa,CAAA;AAEpB,gDAAgD;AAChD,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,2EAA2E;IAC3E,GAAG,EAAE,MAAM,CAAA;IACX,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,OAAO,GAAG,OAAO,CAAA;IACvB,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,mBAAmB,EAAE,CAAA;IAC9B,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,MAAM,EAAE,OAAO,0BAA0B,CAAA;IACzC,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE;QACN,iBAAiB,CAAC,EAAE,MAAM,CAAA;QAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,YAAY,CAAC,EAAE,MAAM,CAAA;KACtB,CAAA;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,iBAAiB,CAAA;AAE1D,MAAM,WAAW,YAAY;IAC3B,UAAU,EAAE,MAAM,CAAA;IAClB,0EAA0E;IAC1E,MAAM,CAAC,EAAE,iBAAiB,CAAA;IAC1B,2EAA2E;IAC3E,YAAY,EAAE,MAAM,CAAA;IACpB,8EAA8E;IAC9E,WAAW,EAAE,MAAM,CAAA;IACnB,2DAA2D;IAC3D,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,WAAW,EAAE,MAAM,CAAA;IACnB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,OAAO,oBAAoB,CAAA;IACnC,wEAAwE;IACxE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,gBAAgB,GAAG,QAAQ,CAAA;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,kEAAkE;IAClE,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,MAAM,EAAE,OAAO,qBAAqB,CAAA;IACpC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;IACzB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mFAAmF;IACnF,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAClC;AAED,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,gBAAgB,CAAA;IACvB,YAAY,CAAC,EAAE,SAAS,kBAAkB,EAAE,CAAA;IAC5C,oDAAoD;IACpD,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,oFAAoF;IACpF,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;;OAIG;IACH,MAAM,EAAE,iBAAiB,CAAA;IACzB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,MAAM,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC,CAAA;IACrC,KAAK,EAAE,gBAAgB,CAAA;IACvB,YAAY,CAAC,EAAE,SAAS,kBAAkB,EAAE,CAAA;IAC5C,KAAK,CAAC,EAAE,gBAAgB,CAAA;CACzB;AAED,MAAM,WAAW,wBAAwB;IACvC,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,YAAY,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,kBAAkB,CAAA;IAC5B,YAAY,EAAE,MAAM,CAAA;IACpB,WAAW,EAAE,MAAM,CAAA;IACnB,EAAE,EAAE,IAAI,CAAA;CACT;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,mBAAmB,CAAA;IAC7B,EAAE,EAAE,KAAK,CAAA;CACV;AAED,MAAM,MAAM,uBAAuB,GAAG,wBAAwB,GAAG,yBAAyB,CAAA"}

package/dist/node/publication/writeGenerationObjects.d.ts

@@ -0,0 +1,5 @@
+import type { DappObjectWriter } from '../providers/capabilities.ts';
+import type { GenerationObjectRef, PublishObjectInput } from './types.ts';
+export declare function writeImmutableObjects(store: DappObjectWriter, role: 'state' | 'index', generation: string, objects: readonly PublishObjectInput[], signal: AbortSignal | undefined, fenced: boolean): Promise<GenerationObjectRef[]>;
+export declare function writeManifest(store: DappObjectWriter, manifestKey: string, manifestBody: string, fenced: boolean): Promise<void>;
+//# sourceMappingURL=writeGenerationObjects.d.ts.map

package/dist/node/publication/writeGenerationObjects.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"writeGenerationObjects.d.ts","sourceRoot":"","sources":["../../../src/publication/writeGenerationObjects.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAIpE,OAAO,KAAK,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAYzE,wBAAsB,qBAAqB,CACzC,KAAK,EAAE,gBAAgB,EACvB,IAAI,EAAE,OAAO,GAAG,OAAO,EACvB,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,SAAS,kBAAkB,EAAE,EACtC,MAAM,EAAE,WAAW,GAAG,SAAS,EAC/B,MAAM,EAAE,OAAO,GACd,OAAO,CAAC,mBAAmB,EAAE,CAAC,CA8BhC;AAED,wBAAsB,aAAa,CACjC,KAAK,EAAE,gBAAgB,EACvB,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,MAAM,EACpB,MAAM,EAAE,OAAO,GACd,OAAO,CAAC,IAAI,CAAC,CAUf"}

package/dist/node/reducer/DappReducer.d.ts

@@ -1,29 +1,52 @@
 import type { Logger } from '@ariestools/sdk';
-import type { DappBucketStore } from '../providers/DappBucketStore.ts';
+import type { DappObjectReader, DappObjectWriter } from '../providers/capabilities.ts';
+/**
+ * Optional progress a reducer may return after a successful pass. The actor
+ * uses it to publish durable indexer status; the cursor must not advance past
+ * a fully published generation (the publication helper writes head last).
+ */
+export interface DappReduceProgress {
+    cursor?: string;
+    floor?: string;
+    generation?: string;
+    generationRoot?: string;
+    lastCompletedPosition?: string;
+    observedSourceHead?: string;
+}
 /** What a reducer is handed each pass: the three bucket stores plus a logger. */
 export interface DappReduceContext {
-    /** Immutable source of truth. */
-    data: DappBucketStore;
-    /** Derived, query-optimized views. */
-    index: DappBucketStore;
+    /**
+     * Immutable reducer input / materialization (may be a datalake replica).
+     * Read-only: reducers must not write through this principal.
+     */
+    data: DappObjectReader;
+    /** Derived, query-optimized views (writable). */
+    index: DappObjectWriter;
     logger: Logger;
-    /** Derived current view. */
-    state: DappBucketStore;
+    /**
+     * Abort signal cancelled when the actor stops. Long reducers should check
+     * `signal.aborted` or pass it into fetches so shutdown can bound in-flight work.
+     */
+    signal: AbortSignal;
+    /** Derived current view (writable). */
+    state: DappObjectWriter;
 }
 /**
  * The pluggable unit of dapp logic. The DappActor timer calls `reduce` on an
- * interval; an implementation reads the immutable `data` bucket and rebuilds
- * `state` and `index`. Passes should be idempotent and resume from a watermark
- * so a slow or interrupted pass is safe to repeat.
+ * interval; an implementation reads the immutable `data` bucket (and/or other
+ * authoritative sources) and rebuilds `state` and `index`. Passes should be
+ * idempotent and resume from a watermark so a slow or interrupted pass is safe
+ * to repeat.
  */
 export interface DappReducer {
     readonly name: string;
-    reduce(context: DappReduceContext): Promise<void>;
+    readonly version?: string;
+    reduce(context: DappReduceContext): Promise<void | DappReduceProgress>;
 }
 /**
- * Default reducer: does nothing. The harness runs the full timer/provider
- * spine with this in place; supply a real reducer to derive `state` and
- * `index` from `data`.
+ * Default reducer: does nothing. The local harness runs the full timer/provider
+ * spine with this in place; production entrypoints must supply a real reducer.
+ * **Development only** — not a production indexer.
  */
 export declare const noopReducer: DappReducer;
 //# sourceMappingURL=DappReducer.d.ts.map

package/dist/node/reducer/DappReducer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DappReducer.d.ts","sourceRoot":"","sources":["../../../src/reducer/DappReducer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAE7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AAEtE,iFAAiF;AACjF,MAAM,WAAW,iBAAiB;IAChC,iCAAiC;IACjC,IAAI,EAAE,eAAe,CAAA;IACrB,sCAAsC;IACtC,KAAK,EAAE,eAAe,CAAA;IACtB,MAAM,EAAE,MAAM,CAAA;IACd,4BAA4B;IAC5B,KAAK,EAAE,eAAe,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,MAAM,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAClD;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,EAAE,WAKzB,CAAA"}
+{"version":3,"file":"DappReducer.d.ts","sourceRoot":"","sources":["../../../src/reducer/DappReducer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAE7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAEtF;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,iFAAiF;AACjF,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,IAAI,EAAE,gBAAgB,CAAA;IACtB,iDAAiD;IACjD,KAAK,EAAE,gBAAgB,CAAA;IACvB,MAAM,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,MAAM,EAAE,WAAW,CAAA;IACnB,uCAAuC;IACvC,KAAK,EAAE,gBAAgB,CAAA;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAA;IACzB,MAAM,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,GAAG,kBAAkB,CAAC,CAAA;CACvE;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,EAAE,WAKzB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ariestools/aries-dapp-core",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "description": "Aries dapp backend core: the DappActor (forked xl1 actor pattern), process-wide provider locator, pluggable reducer, and the composed daemon that runs the storage server plus actors",
   "keywords": [
     "ariestools",
@@ -24,6 +24,10 @@
       "types": "./dist/node/index.d.ts",
       "default": "./dist/node/index.mjs"
     },
+    "./consumer": {
+      "types": "./dist/node/consumer.d.ts",
+      "default": "./dist/node/consumer.mjs"
+    },
     "./package.json": "./package.json"
   },
   "bin": {
@@ -33,14 +37,11 @@
     "dist",
     "README.md"
   ],
-  "publishConfig": {
-    "access": "public"
-  },
   "dependencies": {
     "@ariestools/sdk": "~8.1.1",
     "@aws-sdk/client-s3": "~3.1090.0",
     "tslib": "~2.8.1",
-    "@ariestools/aries-dapp-serve": "~0.1.7"
+    "@ariestools/aries-dapp-serve": "~0.1.8"
   },
   "devDependencies": {
     "@ariestools/toolchain": "~8.7.16",
@@ -52,10 +53,16 @@
     "vite": "~8.1.5",
     "vitest": "~4.1.10"
   },
+  "peerDependencies": {
+    "@ariestools/sdk": "^8.1"
+  },
   "engines": {
     "node": ">=18.17.1"
   },
   "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "package-compile": "package-compile-only && rolldown -c rolldown.config.ts"
   }