@rippling/rippling-sdk 0.2.0-alpha.82 → 0.2.0-alpha.83

package/examples/manifest/custom-object-creation-workflow/custom-object-creation-workflow.ts

@@ -1,7 +1,7 @@
 /*
- * Custom Object Creation Workflow - a minimal workflow manifest example.
+ * Custom Object Creation Workflow - a minimal typed workflow manifest example.
  *
- * Defines one Custom Object (`intake_request__c`) and one Workflow Studio
+ * Defines one typed custom object (`intake_request__c`) and one Workflow Studio
  * workflow that runs when an intake request record is created.
  *
  * Run:
@@ -9,15 +9,14 @@
  *       > examples/manifest/custom-object-creation-workflow/manifest.json
  */
 
+import { toCustomCategoryApiName } from '@rippling/rippling-sdk/core/platform/custom-objects';
 import {
-  Category,
-  CustomObject,
-  CustomObjectFieldSection,
-  ManifestBuilder,
-  ManifestFunction,
-  RadioField,
-  Workflow,
-} from '@rippling/rippling-sdk/lib/manifest';
+  customObjectLifecycle,
+  defineTypedWorkflowFromFunctionFile,
+  registerManifestCustomObject,
+} from '@rippling/rippling-sdk/core/platform/manifest/custom-objects';
+import { Category, ManifestBuilder } from '@rippling/rippling-sdk/lib/manifest';
+import { INTAKE_CATEGORY, intakeRequestDefinition } from './schema';
 
 const manifest = new ManifestBuilder({
   key: 'custom_object_creation_workflow',
@@ -26,50 +25,33 @@ const manifest = new ManifestBuilder({
 });
 
 const category = new Category(manifest, {
-  apiName: 'intake__c',
+  apiName: toCustomCategoryApiName(INTAKE_CATEGORY),
   name: 'Intake',
   description: 'Intake workflow records',
 });
 
-const intakeRequest = new CustomObject(manifest, {
-  apiName: 'intake_request__c',
-  name: 'Intake request',
-  pluralLabel: 'Intake requests',
+const intakeRequest = registerManifestCustomObject(manifest, {
+  definition: intakeRequestDefinition,
   category,
-  description: 'Request submitted for workflow processing',
 });
 
-const detailsSection = new CustomObjectFieldSection(intakeRequest, {
-  name: 'Details',
-  sectionId: 'sec_intake_request_details',
-});
-
-new RadioField(intakeRequest, {
-  apiName: 'status__c',
-  displayName: 'Status',
-  description: 'Request status',
-  options: ['New', 'In review', 'Complete'],
-  required: true,
-  section: detailsSection,
-});
-
-const workflowFn = new ManifestFunction(manifest, {
-  apiName: 'intake_request_created_fn',
-  name: 'Intake request created function',
-  description: 'Function run when a new intake request is created',
-});
-
-new Workflow(manifest, {
+defineTypedWorkflowFromFunctionFile(manifest, {
+  function: {
+    apiName: 'intake_request_created_fn',
+    name: 'Intake request created function',
+    description: 'Function run when a new intake request is created',
+    codeDirectory: __dirname,
+    codeFilename: 'functions/intake-request-created.ts',
+    dependencies: {
+      '@rippling/rippling-sdk': '^0.2.0-alpha.78',
+    },
+  },
   definitionId: 'intake_request_created_workflow',
   title: 'Intake request created',
   description: 'Runs when a new intake request is created',
-  function: workflowFn,
-  trigger: {
-    automation_event_type: 'AUTOMATION_EVENT_TYPE_RECORD_CHANGE',
-    og_module: 'custom_objects',
-    base_model: intakeRequest.getApiName(),
-    record_change_operation_type: 'RECORD_CHANGE_OPERATION_TYPE_CREATE',
-  },
+  trigger: customObjectLifecycle(intakeRequest)
+    .onCreate()
+    .when((c) => c.where('status').eq('New')),
 });
 
 console.log(manifest.preview());

package/examples/manifest/custom-object-creation-workflow/functions/intake-request-created.ts

@@ -0,0 +1,20 @@
+import { FunctionContext, FunctionEvent, FunctionResponse } from '@rippling/rippling-sdk';
+
+export type Input = FunctionEvent;
+
+export type Output = {
+  ok: true;
+  runId: string;
+};
+
+export async function onRipplingEvent(
+  _event: Input,
+  context: FunctionContext,
+): Promise<FunctionResponse<Output>> {
+  return new FunctionResponse({
+    body: {
+      ok: true,
+      runId: context.function.run_id,
+    },
+  });
+}

package/examples/manifest/custom-object-creation-workflow/schema.ts

@@ -0,0 +1,29 @@
+/**
+ * Typed custom-object schema for the minimal workflow example.
+ */
+
+import { defineCustomObject, radio, section } from '@rippling/rippling-sdk/core/platform/custom-objects';
+
+/** Logical category shared by the intake workflow example. */
+export const INTAKE_CATEGORY = 'intake';
+
+/** Typed intake request schema used by the workflow example. */
+export const intakeRequestDefinition = defineCustomObject({
+  name: 'intake_request',
+  displayName: 'Intake request',
+  pluralLabel: 'Intake requests',
+  category: INTAKE_CATEGORY,
+  description: 'Request submitted for workflow processing.',
+  sections: {
+    details: section('Details', { sectionId: 'sec_intake_request_details' }),
+  },
+  fields: {
+    status: radio({
+      displayName: 'Status',
+      description: 'Request status',
+      options: ['New', 'In review', 'Complete'],
+      required: true,
+      section: 'details',
+    }),
+  },
+});