@rippling/rippling-sdk 0.2.0-alpha.104 → 0.2.0-alpha.105

package/src/lib/manifest/existing-manifest-context.ts

@@ -16,6 +16,7 @@ import { ManifestFunction } from './manifest-function';
 import { Rule } from './rule';
 import { SduiPage } from './sdui-page';
 import { Validation } from './validation';
+import { Workflow } from './workflow';
 import {
   optionalStringComponentField,
   requireObjectComponentField,
@@ -92,6 +93,8 @@ function componentLabel(component: Record<string, any>): string {
     component['source_skill_id'] ??
     component['field_api_name'] ??
     component['section_id'] ??
+    component['definition_id'] ??
+    component['obj_id'] ??
     'unknown';
   return `${type}:${id}`;
 }
@@ -355,6 +358,15 @@ export class ExistingManifestContext {
     return this.loadACPAgentComponent(component);
   }
 
+  loadWorkflow(definitionId: string): Workflow {
+    const component = this.findUnique(
+      'WORKFLOW_DEFINITION',
+      (candidate) => candidate['definition_id'] === definitionId,
+      `WORKFLOW_DEFINITION ${definitionId}`,
+    );
+    return this.loadWorkflowComponent(component);
+  }
+
   private loadComponent(component: Record<string, any>): unknown {
     switch (component['type']) {
       case 'AGENT':
@@ -391,6 +403,8 @@ export class ExistingManifestContext {
         return this.loadSduiPageComponent(component);
       case 'CUSTOM_APP':
         return this.loadAppComponent(component);
+      case 'WORKFLOW_DEFINITION':
+        return this.loadWorkflowComponent(component);
       default:
         return this.loadRawComponent(component);
     }
@@ -626,6 +640,14 @@ export class ExistingManifestContext {
     );
   }
 
+  private loadWorkflowComponent(component: Record<string, any>): Workflow {
+    const definitionId = requireStringComponentField(component, 'definition_id', Workflow.componentType);
+    const cacheKey = this.cacheKey('WORKFLOW_DEFINITION', definitionId);
+    return this.getOrLoad(cacheKey, () =>
+      Workflow._fromExistingComponent(this.getManifestBuilder(), component),
+    );
+  }
+
   private loadRawComponent(component: Record<string, any>): ExistingRawComponent {
     const index = this.componentIndexes.get(component) ?? -1;
     const cacheKey = this.cacheKey('RAW', `${index}:${componentLabel(component)}`);

package/src/lib/manifest/workflow/index.ts

@@ -1,5 +1,10 @@
 import { generateId } from '../_helpers';
 import type { BusinessEventKey } from '../business-event';
+import { requireObjectComponentField, requireStringComponentField } from '../_existing-component-fields';
+import {
+  getExistingManifestContext,
+  type ExistingManifestContextOptions,
+} from '../existing-manifest-context';
 import type { ManifestFunction } from '../manifest-function';
 import type { ManifestComponentDeletion, ManifestScope } from '../manifest-builder';
 import type { WorkflowActionPayloads } from './actions';
@@ -473,6 +478,11 @@ export interface WorkflowProps {
   categories?: WorkflowCategory[];
 }
 
+function cloneJson<T>(value: T): T {
+  if (value == null) return value;
+  return JSON.parse(JSON.stringify(value)) as T;
+}
+
 function assertNonEmptyString(value: unknown, path: string): void {
   if (typeof value !== 'string' || !value.trim()) throw new Error(`${path} is required.`);
 }
@@ -882,6 +892,60 @@ export class Workflow {
     scope._register(this);
   }
 
+  static loadFromExisting(definitionId: string, options: ExistingManifestContextOptions = {}): Workflow {
+    return getExistingManifestContext(options).loadWorkflow(definitionId);
+  }
+
+  /** @internal Hydrates a workflow from existing manifest wire JSON. */
+  static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>): Workflow {
+    const workflowMeta = requireObjectComponentField(component, 'workflow_meta', Workflow.componentType);
+    const definitionId = requireStringComponentField(component, 'definition_id', Workflow.componentType);
+    const props: WorkflowProps = {
+      definitionId,
+      title: requireStringComponentField(
+        { definition_id: definitionId, name: workflowMeta['name'] },
+        'name',
+        Workflow.componentType,
+      ),
+      trigger: cloneJson(
+        requireObjectComponentField(component, 'trigger', Workflow.componentType),
+      ) as WorkflowTrigger,
+    };
+    if (typeof workflowMeta['description'] === 'string') props.description = workflowMeta['description'];
+    if (typeof workflowMeta['recipe_id'] === 'string') props.recipeId = workflowMeta['recipe_id'];
+    if (typeof component['function_api_name'] === 'string') {
+      props.function = component['function_api_name'];
+    }
+    if (typeof component['version_status'] === 'string') {
+      props.versionStatus = component['version_status'] as WorkflowVersionStatus;
+    }
+    if (typeof component['trigger_status'] === 'string') {
+      props.triggerStatus = component['trigger_status'] as WorkflowTriggerStatus;
+    }
+    if (component['graph'] != null) {
+      props.graph = cloneJson(component['graph']) as WorkflowGraph;
+    }
+    if (component['functions_inferred_graph'] != null) {
+      props.functionsInferredGraph = cloneJson(component['functions_inferred_graph']) as WorkflowGraph;
+    }
+    if (component['custom_variables'] != null) {
+      props.customVariables = cloneJson(component['custom_variables']) as Record<
+        string,
+        WorkflowCustomVariable
+      >;
+    }
+    if (component['function_api_names_by_old_id'] != null) {
+      props.functionApiNamesByOldId = cloneJson(component['function_api_names_by_old_id']) as Record<
+        string,
+        string
+      >;
+    }
+    if (component['categories'] != null) {
+      props.categories = cloneJson(component['categories']) as WorkflowCategory[];
+    }
+    return new Workflow(scope, props);
+  }
+
   private _validate(): void {
     assertNonEmptyString(this._title, 'Workflow.workflow_meta.name');
     if (this._props.function !== undefined)