@brandboostinggmbh/observable-workflows 0.1.0 → 0.2.2

package/README.md

@@ -1,41 +1,15 @@
-# ts-starter [![npm](https://img.shields.io/npm/v/ts-starter.svg)](https://npmjs.com/package/ts-starter)
+# observable-workflows [![npm](https://img.shields.io/npm/v/ts-starter.svg)](https://npmjs.com/package/ts-starter)
 
 [![Unit Test](https://github.com/sxzz/ts-starter/actions/workflows/unit-test.yml/badge.svg)](https://github.com/sxzz/ts-starter/actions/workflows/unit-test.yml)
 
-My awesome typescript library
-
-<!-- Remove belows -->
-
-Forked from [egoist/ts-starter](https://github.com/egoist/ts-starter)
-
-## Using this template
-
-- Search `ts-starter` and replace it with your custom package name.
-- Search `sxzz` and replace it with your name.
-- Remove sponsors below.
-
-Features:
-
-- Package manager [pnpm](https://pnpm.js.org/), safe and fast
-- Bundle with blazing fast [tsdown](https://github.com/sxzz/tsdown)
-- Test with [Vitest](https://vitest.dev)
-
-<!-- Remove aboves -->
+TODO
 
 ## Install
 
 ```bash
-npm i ts-starter
+npm i @brandboostinggmbh/observable-workflows
 ```
 
-## Sponsors
-
-<p align="center">
-  <a href="https://cdn.jsdelivr.net/gh/sxzz/sponsors/sponsors.svg">
-    <img src='https://cdn.jsdelivr.net/gh/sxzz/sponsors/sponsors.svg'/>
-  </a>
-</p>
-
 ## License
 
-[MIT](./LICENSE) License © 2025 [三咲智子 Kevin Deng](https://github.com/sxzz)
+[MIT](./LICENSE) License © 2025 [Tim Stepanov](https://github.com/TimStepanovAtBrandBoosting)

package/dist/index.d.ts

@@ -24,7 +24,8 @@ declare function insertWorkflowRecord(options: InternalWorkflowContextOptions, {
   workflowStatus,
   startTime,
   endTime,
-  parentInstanceId
+  parentInstanceId,
+  tenantId
 }: {
   instanceId: string;
   workflowType: string;
@@ -35,6 +36,7 @@ declare function insertWorkflowRecord(options: InternalWorkflowContextOptions, {
   startTime: number;
   endTime?: number | null;
   parentInstanceId?: string | null;
+  tenantId: string;
 }): Promise<D1Result<Record<string, unknown>>>;
 declare function insertStepRecordFull(context: StepContextOptions, {
   instanceId,
@@ -61,7 +63,8 @@ declare function pushLogToDB(options: InternalWorkflowContextOptions, {
   message,
   timestamp,
   type,
-  logOrder
+  logOrder,
+  tenantId
 }: {
   instanceId: string;
   stepName: string | null;
@@ -69,6 +72,7 @@ declare function pushLogToDB(options: InternalWorkflowContextOptions, {
   timestamp: number;
   type: string;
   logOrder: number;
+  tenantId: string;
 }): Promise<D1Result<Record<string, unknown>>>;
 declare function tryDeserializeObj(obj: string, serializer: Serializer): any;
 /**
@@ -121,13 +125,15 @@ declare function upsertWorkflowProperty<T extends keyof ValueTypeMap>({
   instanceId,
   key,
   valueType,
-  value
+  value,
+  tenantId
 }: {
   context: InternalWorkflowContextOptions;
   instanceId: string;
   key: string;
   valueType: T;
   value: ValueTypeMap[T];
+  tenantId: string;
 }): Promise<boolean>;
 
 //#endregion
@@ -203,7 +209,6 @@ type Serializer = {
 };
 type WorkflowContextOptions = {
   D1: D1Database;
-  tenantId: string;
   idFactory?: () => string;
   serializer?: Serializer;
 };
@@ -251,7 +256,19 @@ declare function defineWorkflow<I extends {} | null>(workflow: {
 //#endregion
 //#region src/observableWorkflows/createWorkflowContext.d.ts
 declare function createWorkflowContext(options: WorkflowContextOptions): Promise<{
-  call: <I>(workflow: WorkflowFunction<I>, input: I, workflowName: string, parentInstanceId?: string | undefined) => Promise<void>;
+  call: <I>({
+    workflow,
+    input,
+    workflowName,
+    tenantId,
+    parentInstanceId
+  }: {
+    workflow: WorkflowFunction<I>;
+    input: I;
+    workflowName: string;
+    tenantId: string;
+    parentInstanceId?: string | undefined;
+  }) => Promise<void>;
   retry: <I>(workflow: WorkflowFunction<I>, retryInstanceId: string) => Promise<void>;
 }>;
 

package/dist/index.js

@@ -7,13 +7,13 @@ function finalizeWorkflowRecord(options, { workflowStatus, endTime, instanceId }
           WHERE instanceId = ?`
 ).bind(workflowStatus, endTime, instanceId).run();
 }
-function insertWorkflowRecord(options, { instanceId, workflowType, workflowName, workflowMetadata, input, workflowStatus, startTime, endTime, parentInstanceId }) {
+function insertWorkflowRecord(options, { instanceId, workflowType, workflowName, workflowMetadata, input, workflowStatus, startTime, endTime, parentInstanceId, tenantId }) {
 	return options.D1.prepare(
 		/* sql */
 		`INSERT INTO WorkflowTable
         (instanceId, workflowType, workflowName, workflowMetadata, input, tenantId, workflowStatus, startTime, endTime, parentInstanceId)
         VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)`
-).bind(instanceId, workflowType, workflowName, options.serializer.serialize(workflowMetadata), options.serializer.serialize(input), options.tenantId, workflowStatus, startTime, endTime ?? null, parentInstanceId ?? null).run();
+).bind(instanceId, workflowType, workflowName, options.serializer.serialize(workflowMetadata), options.serializer.serialize(input), tenantId, workflowStatus, startTime, endTime ?? null, parentInstanceId ?? null).run();
 }
 function insertStepRecordFull(context, { instanceId, name, status, metadata, startTime, endTime, result, error }) {
 	return context.D1.prepare(
@@ -23,13 +23,13 @@ function insertStepRecordFull(context, { instanceId, name, status, metadata, sta
             VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?)`
 ).bind(instanceId, name, status, metadata, startTime, endTime, result, error, context.tenantId).run();
 }
-function pushLogToDB(options, { instanceId, stepName, message, timestamp, type, logOrder }) {
+function pushLogToDB(options, { instanceId, stepName, message, timestamp, type, logOrder, tenantId }) {
 	return options.D1.prepare(
 		/* sql */
 		`INSERT INTO LogTable
            (instanceId, stepName, log, timestamp, type, logOrder, tenantId)
            VALUES (?, ?, ?, ?, ?, ?, ?)`
-).bind(instanceId, stepName, message, timestamp, type, logOrder, options.tenantId).run();
+).bind(instanceId, stepName, message, timestamp, type, logOrder, tenantId).run();
 }
 function tryDeserializeObj(obj, serializer) {
 	try {
@@ -159,14 +159,14 @@ async function updateWorkflowName(context, instanceId, newWorkflowName) {
           WHERE instanceId = ?`
 ).bind(newWorkflowName, instanceId).run();
 }
-async function upsertWorkflowProperty({ context, instanceId, key, valueType, value }) {
+async function upsertWorkflowProperty({ context, instanceId, key, valueType, value, tenantId }) {
 	const serializedValue = valueType === "object" ? JSON.stringify(value) : String(value);
 	const res = await context.D1.prepare(
 		/* sql */
 		`INSERT OR REPLACE INTO WorkflowProperties
           (instanceId, key, value, valueType, tenantId)
           VALUES (?, ?, ?, ?, ?)`
-).bind(instanceId, key, serializedValue, valueType, context.tenantId).run();
+).bind(instanceId, key, serializedValue, valueType, tenantId).run();
 	if (res.error) {
 		console.error("Error inserting workflow property:", res.error);
 		return false;
@@ -239,7 +239,8 @@ async function createStepContext(context) {
 				message,
 				timestamp,
 				type,
-				logOrder
+				logOrder,
+				tenantId: context.tenantId
 			});
 			waitFor.push(logPromise);
 		};
@@ -311,7 +312,7 @@ async function createWorkflowContext(options) {
 		},
 		idFactory: options.idFactory ?? (() => crypto.randomUUID())
 	};
-	const call = async (workflow, input, workflowName, parentInstanceId = void 0) => {
+	const call = async ({ workflow, input, workflowName, tenantId, parentInstanceId }) => {
 		const instanceId = internalContext.idFactory();
 		const startTime = Date.now();
 		await insertWorkflowRecord(internalContext, {
@@ -323,7 +324,8 @@ async function createWorkflowContext(options) {
 			workflowStatus: "pending",
 			startTime,
 			endTime: null,
-			parentInstanceId
+			parentInstanceId,
+			tenantId
 		});
 		let waitFor = [];
 		let logOrder = 0;
@@ -336,13 +338,14 @@ async function createWorkflowContext(options) {
 				message,
 				timestamp,
 				type,
-				logOrder
+				logOrder,
+				tenantId
 			});
 			waitFor.push(logPromise);
 		};
 		const stepContext = await createStepContext({
 			D1: options.D1,
-			tenantId: options.tenantId,
+			tenantId,
 			instanceId,
 			serializer: internalContext.serializer,
 			idFactory: internalContext.idFactory
@@ -373,7 +376,8 @@ async function createWorkflowContext(options) {
 						instanceId,
 						key,
 						valueType,
-						value
+						value,
+						tenantId
 					});
 				}
 			});
@@ -400,13 +404,21 @@ async function createWorkflowContext(options) {
 	const retry = async (workflow, retryInstanceId) => {
 		const oldRun = await options.D1.prepare(
 			/* sql */
-			`SELECT input, workflowName FROM WorkflowTable WHERE instanceId = ? `
+			`SELECT input, workflowName, tenantId FROM WorkflowTable WHERE instanceId = ? `
 ).bind(retryInstanceId).first();
 		const oldWorkflowName = oldRun?.workflowName;
+		const tenantId = oldRun?.tenantId;
+		if (!tenantId) throw new Error(`No tenantId found for instanceId ${retryInstanceId}`);
 		const encodedInput = oldRun?.input;
 		if (!encodedInput) throw new Error(`No input found for instanceId ${retryInstanceId}`);
 		const input = JSON.parse(encodedInput);
-		await call(workflow, input, oldWorkflowName ?? "unknown", retryInstanceId);
+		await call({
+			workflow,
+			input,
+			workflowName: oldWorkflowName ?? "unknown",
+			parentInstanceId: retryInstanceId,
+			tenantId
+		});
 	};
 	return {
 		call,
@@ -439,13 +451,17 @@ function createQueueWorkflowContext(options) {
 		if (!workflowFunction) throw new Error(`Workflow ${message.workflowType} not found`);
 		const wfc = await createWorkflowContext({
 			D1: env.LOG_DB,
-			tenantId: message.tenantId,
 			serializer: options.serializer,
 			idFactory: options.idFactory
 		});
 		if (message.type === "workflow-run") {
 			console.log("running workflow", message.input);
-			await wfc.call(workflowFunction, message.input, message.workflowName);
+			await wfc.call({
+				input: message.input,
+				workflow: workflowFunction,
+				workflowName: message.workflowName,
+				tenantId: message.tenantId
+			});
 		} else if (message.type === "workflow-retry") {
 			console.log("retrying workflow", message.retryInstanceId);
 			await wfc.retry(workflowFunction, message.retryInstanceId);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brandboostinggmbh/observable-workflows",
-  "version": "0.1.0",
+  "version": "0.2.2",
   "description": "My awesome typescript library",
   "type": "module",
   "license": "MIT",