@brandboostinggmbh/observable-workflows 0.2.2 → 0.3.0

package/dist/index.d.ts

@@ -252,6 +252,7 @@ declare function defineWorkflow<I extends {} | null>(workflow: {
   workflowType: string;
   metadata?: Record<string, any>;
 }, callback: (input: I, ctx: WorkflowContext) => Promise<any>): WorkflowFunction<I>;
+declare function defineWorkflow<I extends {} | null>(workflowType: string, callback: (input: I, ctx: WorkflowContext) => Promise<any>): WorkflowFunction<I>;
 
 //#endregion
 //#region src/observableWorkflows/createWorkflowContext.d.ts
@@ -287,7 +288,7 @@ declare function createQueueWorkflowContext(options: QueueWorkflowContextOptions
 declare const createLogAccessor: (context: {
   D1: D1Database;
   tenantId: string;
-  serializer: Serializer;
+  serializer?: Serializer;
 }) => {
   listSteps: (limit: number, offset: number, instanceId?: string | undefined) => Promise<Step[]>;
   getStep: (instanceId: string, stepName: string) => Promise<Step | null>;
@@ -298,4 +299,15 @@ declare const createLogAccessor: (context: {
 };
 
 //#endregion
-export { ConsoleWrapper, InternalWorkflowContextOptions, Log, PossibleValueTypeNames, PossibleValueTypes, QueueWorkflowContextOptions, Serializer, Step, StepContextOptions, StepCtx, StepWorkflowStatus, ValueTypeMap, WorkflowContext, WorkflowContextOptions, WorkflowFunction, WorkflowProperty, WorkflowPropertyDefinition, WorkflowQueueMessage, WorkflowRun, createLogAccessor, createQueueWorkflowContext, createStepContext, createWorkflowContext, defineWorkflow, ensureTables, finalizeWorkflowRecord, insertStepRecordFull, insertWorkflowRecord, pushLogToDB, tryDeserializeObj, updateWorkflowName, upsertWorkflowProperty, workflowTableRowToWorkflowRun };
+//#region src/observableWorkflows/defaultImplementations.d.ts
+declare const defaultSerializer: {
+  serialize: {
+    (value: any, replacer?: (this: any, key: string, value: any) => any, space?: string | number): string;
+    (value: any, replacer?: (number | string)[] | null, space?: string | number): string;
+  };
+  deserialize: (text: string, reviver?: (this: any, key: string, value: any) => any) => any;
+};
+declare const defaultIdFactory: () => string;
+
+//#endregion
+export { ConsoleWrapper, InternalWorkflowContextOptions, Log, PossibleValueTypeNames, PossibleValueTypes, QueueWorkflowContextOptions, Serializer, Step, StepContextOptions, StepCtx, StepWorkflowStatus, ValueTypeMap, WorkflowContext, WorkflowContextOptions, WorkflowFunction, WorkflowProperty, WorkflowPropertyDefinition, WorkflowQueueMessage, WorkflowRun, createLogAccessor, createQueueWorkflowContext, createStepContext, createWorkflowContext, defaultIdFactory, defaultSerializer, defineWorkflow, ensureTables, finalizeWorkflowRecord, insertStepRecordFull, insertWorkflowRecord, pushLogToDB, tryDeserializeObj, updateWorkflowName, upsertWorkflowProperty, workflowTableRowToWorkflowRun };

package/dist/index.js

@@ -177,9 +177,11 @@ async function upsertWorkflowProperty({ context, instanceId, key, valueType, val
 //#endregion
 //#region src/observableWorkflows/defineWorkflow.ts
 function defineWorkflow(workflow, callback) {
+	const metadata = typeof workflow === "string" ? void 0 : workflow.metadata;
+	const workflowType = typeof workflow === "string" ? workflow : workflow.workflowType;
 	return {
-		workflowType: workflow.workflowType,
-		metadata: workflow.metadata || {},
+		workflowType,
+		metadata: metadata || {},
 		_callback: callback
 	};
 }
@@ -300,17 +302,22 @@ async function createStepContext(context) {
 	return step;
 }
 
+//#endregion
+//#region src/observableWorkflows/defaultImplementations.ts
+const defaultSerializer = {
+	serialize: JSON.stringify,
+	deserialize: JSON.parse
+};
+const defaultIdFactory = () => crypto.randomUUID();
+
 //#endregion
 //#region src/observableWorkflows/createWorkflowContext.ts
 async function createWorkflowContext(options) {
 	await ensureTables(options.D1);
 	const internalContext = {
 		...options,
-		serializer: options.serializer ?? {
-			serialize: JSON.stringify,
-			deserialize: JSON.parse
-		},
-		idFactory: options.idFactory ?? (() => crypto.randomUUID())
+		serializer: options.serializer ?? defaultSerializer,
+		idFactory: options.idFactory ?? defaultIdFactory
 	};
 	const call = async ({ workflow, input, workflowName, tenantId, parentInstanceId }) => {
 		const instanceId = internalContext.idFactory();
@@ -477,6 +484,7 @@ function createQueueWorkflowContext(options) {
 //#endregion
 //#region src/observableWorkflows/createLogAccessor.ts
 const createLogAccessor = (context) => {
+	const internalSerializer = context.serializer ?? defaultSerializer;
 	const listSteps = async (limit, offset, instanceId) => {
 		const result = await context.D1.prepare(
 			/* sql */
@@ -487,12 +495,12 @@ const createLogAccessor = (context) => {
 		return result.results ? result.results.map((row) => ({
 			instanceId: row.instanceId,
 			name: row.stepName,
-			metadata: tryDeserializeObj(row.stepMetadata, context.serializer),
+			metadata: tryDeserializeObj(row.stepMetadata, internalSerializer),
 			status: row.stepStatus,
 			startTime: row.startTime,
 			endTime: row.endTime,
-			result: row.result ? tryDeserializeObj(row.result, context.serializer) : null,
-			error: row.error ? tryDeserializeObj(row.error, context.serializer) : null
+			result: row.result ? tryDeserializeObj(row.result, internalSerializer) : null,
+			error: row.error ? tryDeserializeObj(row.error, internalSerializer) : null
 		})) : [];
 	};
 	const listWorkflows = async (limit, offset) => {
@@ -503,14 +511,14 @@ const createLogAccessor = (context) => {
       WHERE tenantId = ?
       ORDER BY startTime DESC LIMIT ? OFFSET ?`
 ).bind(context.tenantId, limit, offset).all();
-		return result.results ? result.results.map((row) => workflowTableRowToWorkflowRun(row, context.serializer)) : [];
+		return result.results ? result.results.map((row) => workflowTableRowToWorkflowRun(row, internalSerializer)) : [];
 	};
 	const getWorkflowByParentId = async (parentInstanceId) => {
 		const result = await context.D1.prepare(
 			/* sql */
 			`SELECT * FROM WorkflowTable WHERE parentInstanceId = ? AND tenantId = ?`
 ).bind(parentInstanceId, context.tenantId).all();
-		return result.results ? result.results.map((row) => workflowTableRowToWorkflowRun(row, context.serializer)) : null;
+		return result.results ? result.results.map((row) => workflowTableRowToWorkflowRun(row, internalSerializer)) : null;
 	};
 	const getWorkflowTypesByTenantId = async (tenantId) => {
 		const result = await context.D1.prepare(
@@ -529,7 +537,7 @@ const createLogAccessor = (context) => {
 		return result.results.map((row) => ({
 			key: row.key,
 			valueType: row.valueType,
-			value: tryDeserializeObj(row.value, context.serializer)
+			value: tryDeserializeObj(row.value, internalSerializer)
 		}));
 	};
 	/** This function gets the basic data of a workflow, without populating any of it's complex fields */
@@ -539,7 +547,7 @@ const createLogAccessor = (context) => {
 			`SELECT * FROM WorkflowTable WHERE instanceId = ? AND tenantId = ?`
 ).bind(instanceId, context.tenantId).first();
 		if (!result) return null;
-		const workflow = workflowTableRowToWorkflowRun(result, context.serializer);
+		const workflow = workflowTableRowToWorkflowRun(result, internalSerializer);
 		return workflow;
 	};
 	const getWorkflow = async (instanceId) => {
@@ -584,12 +592,12 @@ const createLogAccessor = (context) => {
 		const step = {
 			instanceId: row.instanceId,
 			name: row.stepName,
-			metadata: tryDeserializeObj(row.stepMetadata, context.serializer),
+			metadata: tryDeserializeObj(row.stepMetadata, internalSerializer),
 			status: row.stepStatus,
 			startTime: row.startTime,
 			endTime: row.endTime,
-			result: row.result ? tryDeserializeObj(row.result, context.serializer) : null,
-			error: row.error ? tryDeserializeObj(row.error, context.serializer) : null,
+			result: row.result ? tryDeserializeObj(row.result, internalSerializer) : null,
+			error: row.error ? tryDeserializeObj(row.error, internalSerializer) : null,
 			logs: []
 		};
 		const logResult = await context.D1.prepare(
@@ -630,4 +638,4 @@ const createLogAccessor = (context) => {
 };
 
 //#endregion
-export { createLogAccessor, createQueueWorkflowContext, createStepContext, createWorkflowContext, defineWorkflow, ensureTables, finalizeWorkflowRecord, insertStepRecordFull, insertWorkflowRecord, pushLogToDB, tryDeserializeObj, updateWorkflowName, upsertWorkflowProperty, workflowTableRowToWorkflowRun };
+export { createLogAccessor, createQueueWorkflowContext, createStepContext, createWorkflowContext, defaultIdFactory, defaultSerializer, defineWorkflow, ensureTables, finalizeWorkflowRecord, insertStepRecordFull, insertWorkflowRecord, pushLogToDB, tryDeserializeObj, updateWorkflowName, upsertWorkflowProperty, workflowTableRowToWorkflowRun };

package/package.json

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