@empyria/restate 0.1.12 → 0.1.14

package/lib/Admin.js

@@ -193,9 +193,19 @@ export async function listHandlers({ restateAdminURL, name }) {
  */
 
 /**
- * Starts a sub-workflow and returns a handle to the invocation.
+ * Starts a sub-workflow and returns a handle to the invocation. Submitting against a
+ * `workflowKey` that already has a running or completed workflow is a safe no-op on
+ * Restate's side (see the SDK's own workflow-submission semantics) — this is the
+ * idiomatic "start if absent, otherwise leave it alone" primitive for a long-running,
+ * once-per-key workflow, not just a plain fire-and-forget call.
  * @template P
- * @param {import('@restatedev/restate-sdk').WorkflowContext} ctx Existing workflow context
+ * @param {import('@restatedev/restate-sdk').Context} ctx Restate context of the CALLING
+ *   handler — any handler type works here (plain service, virtual object, or another
+ *   workflow), not just a workflow's own context. This only needs `ctx.genericSend`,
+ *   which every Context exposes (declared on the base `Context` interface, not
+ *   `WorkflowContext` — verified against the SDK's own type declarations); the earlier
+ *   `WorkflowContext` annotation here reflected this repo's own usages so far
+ *   (workflow-starts-sub-workflow), not an actual restriction.
  * @param {string} workflowName name of the workflow to start
  * @param {string} workflowKey key of the workflow instance to start
  * @param {P} payload payload to pass to the workflow
@@ -215,7 +225,10 @@ export function startSubWorkflow(ctx, workflowName, workflowKey, payload) {
  * Executes a sub-workflow and returns a promise resolving to the result.
  * @template P
  * @template [R=unknown]
- * @param {import('@restatedev/restate-sdk').WorkflowContext} ctx Existing workflow context
+ * @param {import('@restatedev/restate-sdk').Context} ctx Restate context of the CALLING
+ *   handler — any handler type works here (plain service, virtual object, or another
+ *   workflow); see {@link startSubWorkflow}'s own doc for why `Context`, not
+ *   `WorkflowContext`, is the accurate type.
  * @param {string} workflowName name of the workflow to execute
  * @param {string} workflowKey key of the workflow instance to execute
  * @param {P} payload payload to pass to the workflow

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@empyria/restate",
-	"version": "0.1.12",
+	"version": "0.1.14",
 	"description": "Restate.dev helpers for the Empyria nanoservice framework",
 	"license": "MIT",
 	"author": "Imre Fazekas <imre.fazekas@icloud.com>",
@@ -25,7 +25,7 @@
 	},
 	"dependencies": {
 		"@empyria/classification": "0.1.6",
-		"@empyria/common": "0.3.0",
+		"@empyria/common": "0.3.1",
 		"@restatedev/pubsub": "0.3.2",
 		"@restatedev/pubsub-client": "0.3.2",
 		"@restatedev/restate-sdk": "1.17.0",
@@ -34,9 +34,9 @@
 		"croner": "10.0.1"
 	},
 	"devDependencies": {
-		"@restatedev/restate-server": "1.7.9",
-		"oxfmt": "0.67.0",
-		"oxlint": "1.82.0"
+		"@restatedev/restate-server": "1.7.10",
+		"oxfmt": "0.68.0",
+		"oxlint": "1.83.0"
 	},
 	"engines": {
 		"bun": ">=1.4.2",

package/test/Admin.test.js

@@ -136,6 +136,25 @@ describe('startSubWorkflow / callSubWorkflow', () => {
 		expect(calledArgs.key).toBe('wf-key-2')
 		expect(result).toEqual({ done: true })
 	})
+
+	// Both functions only need `ctx.genericSend`/`ctx.genericCall`, which the SDK declares on
+	// the base Context interface — every handler type has it, not just a workflow's own
+	// context. Named explicitly (not just "a ctx mock", like the two tests above already are)
+	// to document that calling these from a plain, unkeyed `restate.service` handler — e.g. to
+	// idempotently start a long-running workflow the moment that service first learns the
+	// workflow's key exists — is a supported, intended use, not an incidental side effect of
+	// duck typing.
+	test('startSubWorkflow works from a plain (non-workflow) service context', () => {
+		let sentArgs
+		/** @type {import('@restatedev/restate-sdk').Context} */
+		const plainServiceCtx = { genericSend: (args) => (sentArgs = args) ?? 'handle' }
+		startSubWorkflow(plainServiceCtx, 'CorporateActionWorkflow', 'CA08841DVCA26', {
+			triggeredBy: 'swift-upstream-sort',
+		})
+		expect(sentArgs.service).toBe('CorporateActionWorkflow')
+		expect(sentArgs.method).toBe('run')
+		expect(sentArgs.key).toBe('CA08841DVCA26')
+	})
 })
 
 describe('listServices', () => {