@dotbep/core 0.2.14 → 0.2.16

package/dist/index.d.ts

@@ -219,6 +219,11 @@ export declare const BEPSchema: z.ZodObject<{
         description: z.ZodOptional<z.ZodString>;
         image: z.ZodOptional<z.ZodString>;
         websiteUrl: z.ZodOptional<z.ZodURL>;
+        location: z.ZodOptional<z.ZodObject<{
+            address: z.ZodOptional<z.ZodString>;
+            coordinates: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+        }, z.core.$strip>>;
+        customData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     }, z.core.$strip>;
     deliverableNamingConvention: z.ZodOptional<z.ZodObject<{
         delimiter: z.ZodString;
@@ -614,6 +619,7 @@ export declare interface BepTypes {
         eventId: string;
     } & Record<string, unknown>>;
     resolvers: Record<string, (url: string, ...args: any[]) => unknown>;
+    triggers: Record<string, (rawPayload: unknown) => Promise<WorkflowInstance['trackedAsset']>>;
     env: Record<string, string>;
 }
 
@@ -884,7 +890,9 @@ export declare class Engine {
     get runtime(): Runtime<any>;
     /** Namespaced workflow instance operations. */
     readonly workflows: {
-        create(workflowId: string, trackedAsset: WorkflowInstance['trackedAsset'], initiatedBy: string): Promise<WorkflowInstance | null>;
+        create(workflowId: string, trackedAsset: WorkflowInstance['trackedAsset'] | {
+            rawPayload: unknown;
+        }, initiatedBy: string): Promise<WorkflowInstance | null>;
         emit(instanceId: string, event: IncomingEvent): Promise<EventResult>;
         get(instanceId: string): Promise<WorkflowInstance | null>;
         list(filter?: InstanceFilter): Promise<WorkflowInstance[]>;
@@ -1287,21 +1295,6 @@ export declare const FlowDiagramSchema: z.ZodObject<{
     }, z.core.$strip>]>>;
 }, z.core.$strip>;
 
-/**
- * Converts a resolved FlowDiagram to a Mermaid flowchart string.
- * Node IDs are prefixed with `_` to avoid conflicts with Mermaid reserved words
- * (e.g. "end", "start"). Quotes in labels are escaped to `#quot;`.
- *
- * Node order: start always first, end always last. If topologicalSort is enabled,
- * intermediate nodes are ordered via BFS from start for better Dagre layout.
- */
-export declare function flowDiagramToMermaid(diagram: FlowDiagramResolved, raciKey?: RaciKey, options?: FlowDiagramToMermaidOptions): string;
-
-declare interface FlowDiagramToMermaidOptions {
-    raciKey?: RaciKey;
-    topologicalSort?: boolean;
-}
-
 export declare type FlowDirectEdge = z.infer<typeof FlowDirectEdgeSchema>;
 
 export declare const FlowDirectEdgeSchema: z.ZodObject<{
@@ -2113,6 +2106,11 @@ export declare const ProjectSchema: z.ZodObject<{
     description: z.ZodOptional<z.ZodString>;
     image: z.ZodOptional<z.ZodString>;
     websiteUrl: z.ZodOptional<z.ZodURL>;
+    location: z.ZodOptional<z.ZodObject<{
+        address: z.ZodOptional<z.ZodString>;
+        coordinates: z.ZodOptional<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+    }, z.core.$strip>>;
+    customData: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, z.core.$strip>;
 
 export declare type RaciAssignment = {
@@ -2128,8 +2126,6 @@ export declare type RaciEntry = {
     members: Member[];
 };
 
-export declare type RaciKey = 'responsible' | 'accountable' | 'consulted' | 'informed';
-
 /**
  * Resolved RACI assignment for one letter (R/A/C/I) at a node.
  * Three levels of specificity: emails > teams+roles > roles.
@@ -2234,12 +2230,14 @@ export declare class Runtime<T extends {
     effects: Record<string, any>;
     automations: Record<string, any>;
     resolvers: Record<string, any>;
+    triggers: Record<string, any>;
     env: Record<string, any>;
 } = BepTypes> {
     env: T['env'];
     readonly effects: Record<string, EffectHandler>;
     readonly automations: Record<string, AutomationHandler>;
     readonly resolvers: Record<string, ResolverHandler>;
+    readonly triggers: Record<string, TriggerHandler>;
     /** Set by Engine.init() — available inside handlers via this.engine */
     _engine: EngineRef | null;
     get engine(): EngineRef;
@@ -2247,6 +2245,7 @@ export declare class Runtime<T extends {
     protected effect<K extends keyof T['effects'] & string>(key: K, handler: (instance: WorkflowInstance, ...args: Parameters<T['effects'][K]>) => Promise<void>): this;
     protected automation<K extends keyof T['automations'] & string>(key: K, handler: (instance: WorkflowInstance, ...args: Parameters<T['automations'][K]>) => Promise<ReturnType<T['automations'][K]>>): this;
     protected resolver<K extends keyof T['resolvers'] & string>(key: K, handler: (...args: Parameters<T['resolvers'][K]>) => Promise<ReturnType<T['resolvers'][K]>>): this;
+    protected trigger<K extends keyof T['triggers'] & string>(key: K, handler: (rawPayload: unknown) => Promise<WorkflowInstance['trackedAsset']>): this;
     /* Excluded from this release type: _runResolver */
 }
 
@@ -2462,6 +2461,13 @@ export declare interface TransitionStep {
     toNodeId: string;
 }
 
+/**
+ * Handler registered for a specific workflow trigger (keyed by Workflow.id).
+ * Receives a raw payload from an external system and returns the trackedAsset
+ * that the engine will use to create the workflow instance.
+ */
+export declare type TriggerHandler = (rawPayload: unknown) => Promise<WorkflowInstance['trackedAsset']>;
+
 /**
  * Validates all token-bearing entity IDs in a BEP against a naming convention.
  * Used when setting a new convention to ensure all existing data is compatible.