ankka 0.6.4 → 0.7.1

package/README.md

@@ -1,5 +1,7 @@
 # ankka for TypeScript
 
+[![npm](https://img.shields.io/npm/v/ankka?label=npm)](https://www.npmjs.com/package/ankka)
+
 The ankka SDK for services written in TypeScript on Node.js. A service is a process that the ankka
 runtime hosts as a sidecar: the sidecar owns everything durable and distributed, and the process owns
 the decisions. This package speaks the sidecar protocol so your code never does.

package/dist/testkit/index.d.ts

@@ -1,3 +1,3 @@
 export { EventSourcedTestKit, EndpointTestKit, Response, type RequestOptions, type Materialised } from "./unit.ts";
 export { KeyValueTestKit, WorkflowTestKit, ViewTestKit, ConsumerTestKit, TimedActionTestKit, AgentTestKit, ScriptedModel, type WorkflowProgress, type ModelResponse, type ModelCall, } from "./kinds.ts";
-export { AnkkaTestKit, type AnkkaTestKitOptions, type HttpResponse, type Http, type Beside } from "./integration.ts";
+export { AnkkaTestKit, PUBLISHED_SIDECAR, sidecarImage, type AnkkaTestKitOptions, type HttpResponse, type Http, type Beside } from "./integration.ts";

package/dist/testkit/index.js

@@ -3,4 +3,4 @@
 // `testcontainers` and `@testcontainers/postgresql`, are loaded only when `AnkkaTestKit.start` runs.
 export { EventSourcedTestKit, EndpointTestKit, Response } from "./unit.js";
 export { KeyValueTestKit, WorkflowTestKit, ViewTestKit, ConsumerTestKit, TimedActionTestKit, AgentTestKit, ScriptedModel, } from "./kinds.js";
-export { AnkkaTestKit } from "./integration.js";
+export { AnkkaTestKit, PUBLISHED_SIDECAR, sidecarImage } from "./integration.js";

package/dist/testkit/integration.d.ts

@@ -1,7 +1,7 @@
 import type { ComponentClient } from "../client.ts";
 import type { ServiceBuilder } from "../service.ts";
 export interface AnkkaTestKitOptions {
-    /** The sidecar image; `$ANKKA_SIDECAR_IMAGE` or `ankka-sidecar:latest` by default. */
+    /** The sidecar image; `sidecarImage()` by default. */
     readonly image?: string;
     /** Environment for the sidecar container: `ANKKA_MODEL_SCRIPT` scripts its model. */
     readonly env?: Readonly<Record<string, string>>;
@@ -37,6 +37,12 @@ export interface Beside {
     logs(): Promise<string>;
     stop(): Promise<void>;
 }
+export declare const PUBLISHED_SIDECAR = "ghcr.io/thinkmorestupidless/ankka-sidecar";
+/**
+ * The sidecar the testkit starts when it is not told: see the top of this file. A release publishes the SDK
+ * and the sidecar under one version, so a released SDK's own version names the sidecar it was tested with.
+ */
+export declare function sidecarImage(version?: string): string;
 export declare class AnkkaTestKit {
     #private;
     /** The component client every handler in `service` uses, pointed at the sidecar's mapped callback port. */

package/dist/testkit/integration.js

@@ -7,11 +7,15 @@
 // is how a test proves durability rather than caching.
 //
 // Needs Docker, and `testcontainers` with `@testcontainers/postgresql` installed (optional peers of this
-// package). The image is `$ANKKA_SIDECAR_IMAGE` or `ankka-sidecar:latest`.
+// package). The image is `$ANKKA_SIDECAR_IMAGE` when that is set. Otherwise a released SDK uses the sidecar
+// published with it, `ghcr.io/thinkmorestupidless/ankka-sidecar:<this SDK's version>` — public, so Docker
+// pulls it on first use — and an unreleased one (version `0.0.0`, a checkout of the ankka repository) uses
+// `ankka-sidecar:latest`, the image `sbt sidecar/Docker/publishLocal` builds.
 import { execFileSync } from "node:child_process";
 import { chmodSync, mkdtempSync, readdirSync, rmSync, statSync } from "node:fs";
 import { tmpdir } from "node:os";
 import { join } from "node:path";
+import { VERSION } from "../version.js";
 const POSTGRES_IMAGE = "postgres:17-alpine";
 const HTTP_PORT = 9000;
 const CALLBACK_PORT = 9011;
@@ -79,8 +83,16 @@ export class Http {
             .map((line) => JSON.parse(line.slice(5).trim()));
     }
 }
-function sidecarImage() {
-    return process.env.ANKKA_SIDECAR_IMAGE ?? "ankka-sidecar:latest";
+export const PUBLISHED_SIDECAR = "ghcr.io/thinkmorestupidless/ankka-sidecar";
+/**
+ * The sidecar the testkit starts when it is not told: see the top of this file. A release publishes the SDK
+ * and the sidecar under one version, so a released SDK's own version names the sidecar it was tested with.
+ */
+export function sidecarImage(version = VERSION) {
+    const explicit = process.env.ANKKA_SIDECAR_IMAGE;
+    if (explicit)
+        return explicit;
+    return version === "0.0.0" ? "ankka-sidecar:latest" : `${PUBLISHED_SIDECAR}:${version}`;
 }
 /** The DDL as files, from `/opt/docker/ddl` in the sidecar image, without running the image. */
 function copyDdl(image, into) {

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.6.4";
+export declare const VERSION = "0.7.1";

package/dist/version.js

@@ -1,2 +1,2 @@
 // Written by scripts/proto.ts from package.json; do not edit. 0.0.0 in the tree, the tag's version in a release.
-export const VERSION = "0.6.4";
+export const VERSION = "0.7.1";

package/package.json

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