@rippling/rippling-sdk 0.2.0-alpha.59 → 0.2.0-alpha.61

package/lib/manifest/manifest-function.d.ts

@@ -1,5 +1,6 @@
 import { type ExistingManifestContextOptions } from "./existing-manifest-context.js";
 import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.js";
+export type FunctionCodeFile = `./${string}.ts` | `/${string}.ts`;
 /**
  * Initialization properties for {@link ManifestFunction}.
  */
@@ -17,11 +18,12 @@ export interface ManifestFunctionProps {
      */
     name: string;
     /**
-     * TypeScript handler source code. Must export an `onRipplingEvent` function.
+     * Path to a TypeScript handler source file. The file must export an
+     * `onRipplingEvent` function. Its contents are serialized to `code_draft`.
      *
      * Optional. @default `''`
      */
-    code?: string;
+    codeFile?: FunctionCodeFile;
     /**
      * Human-readable description of what this function does.
      *
@@ -61,9 +63,9 @@ export interface ManifestFunctionProps {
  * serverless infrastructure. The handler must export `onRipplingEvent`.
  *
  * Functions have two primary uses:
- * 1. **Authoring SDUI for Custom Apps** — the function returns an SDUI spec
- *    (built with `@rippling/rippling-sdk/lib/sdui`) that renders as a page tab.
- *    Wrap the function in an {@link SduiPage} and reference it from an {@link App}.
+ * 1. **Rendering SDUI for Custom Apps** — the function returns an SDUI spec
+ *    payload that renders as a page tab. Wrap the function in an {@link SduiPage}
+ *    and reference it from an {@link App}.
  * 2. **Workflow / event handlers** — functions invoked from rules, automations,
  *    or callbacks that do not render UI.
  *
@@ -77,7 +79,7 @@ export interface ManifestFunctionProps {
  *   apiName: 'gym_today_schedule_fn',
  *   name: 'Today\'s schedule (SDUI)',
  *   description: 'Searchable grid of class sessions',
- *   code: handlerSource,
+ *   codeFile: './functions/gym_today_schedule_fn/code.ts',
  *   dependencies: {
  *     '@rippling/rippling-sdk': '^0.2.0-alpha.33',
  *   },
@@ -92,7 +94,8 @@ export declare class ManifestFunction {
     static toDeletionIdentifier(apiName: string): ManifestComponentDeletion;
     private readonly _apiName;
     private readonly _name;
-    private readonly _code;
+    private readonly _codeFile;
+    private _codeDraft;
     private readonly _description;
     private readonly _dependencies;
     private readonly _deploymentOptions;

package/lib/manifest/manifest-function.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-function.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,KAAK,8BAA8B,EAAE,uCAAoC;AAC9G,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,8BAA2B;AAGnF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,gBAAgB;IAC3B,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,UAAU,CAAU;IAEpD,MAAM,CAAC,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,yBAAyB;IAOvE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqC;IACnE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAkC;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IACvD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,qBAAqB;IAY9D;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,gBAAgB;IAIxG,sEAAsE;IACtE,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,gBAAgB;IAgBrG;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}
+{"version":3,"file":"manifest-function.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":"AAEA,OAAO,EAA8B,KAAK,8BAA8B,EAAE,uCAAoC;AAC9G,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,8BAA2B;AAGnF,MAAM,MAAM,gBAAgB,GAAG,KAAK,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,gBAAgB,CAAC;IAC5B;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxC;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,qBAAa,gBAAgB;IAC3B,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,UAAU,CAAU;IAEpD,MAAM,CAAC,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,yBAAyB;IAOvE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA+B;IACzD,OAAO,CAAC,UAAU,CAAqB;IACvC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqC;IACnE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAkC;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IACvD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,qBAAqB;IAY9D;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,gBAAgB;IAIxG,sEAAsE;IACtE,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,gBAAgB;IAkBrG;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAgB9B"}

package/lib/manifest/manifest-function.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ManifestFunction = void 0;
+const tslib_1 = require("../../internal/tslib.js");
+const fs = tslib_1.__importStar(require("node:fs"));
 const existing_manifest_context_1 = require("./existing-manifest-context.js");
 const _existing_component_fields_1 = require("./_existing-component-fields.js");
 /**
@@ -10,9 +12,9 @@ const _existing_component_fields_1 = require("./_existing-component-fields.js");
  * serverless infrastructure. The handler must export `onRipplingEvent`.
  *
  * Functions have two primary uses:
- * 1. **Authoring SDUI for Custom Apps** — the function returns an SDUI spec
- *    (built with `@rippling/rippling-sdk/lib/sdui`) that renders as a page tab.
- *    Wrap the function in an {@link SduiPage} and reference it from an {@link App}.
+ * 1. **Rendering SDUI for Custom Apps** — the function returns an SDUI spec
+ *    payload that renders as a page tab. Wrap the function in an {@link SduiPage}
+ *    and reference it from an {@link App}.
  * 2. **Workflow / event handlers** — functions invoked from rules, automations,
  *    or callbacks that do not render UI.
  *
@@ -26,7 +28,7 @@ const _existing_component_fields_1 = require("./_existing-component-fields.js");
  *   apiName: 'gym_today_schedule_fn',
  *   name: 'Today\'s schedule (SDUI)',
  *   description: 'Searchable grid of class sessions',
- *   code: handlerSource,
+ *   codeFile: './functions/gym_today_schedule_fn/code.ts',
  *   dependencies: {
  *     '@rippling/rippling-sdk': '^0.2.0-alpha.33',
  *   },
@@ -50,7 +52,7 @@ class ManifestFunction {
     constructor(scope, props) {
         this._apiName = props.apiName;
         this._name = props.name;
-        this._code = props.code ?? '';
+        this._codeFile = props.codeFile;
         this._description = props.description;
         this._dependencies = props.dependencies;
         this._deploymentOptions = props.deploymentOptions;
@@ -71,8 +73,7 @@ class ManifestFunction {
             name: (0, _existing_component_fields_1.requireStringComponentField)(component, 'name', ManifestFunction.componentType),
             description: (0, _existing_component_fields_1.optionalStringComponentField)(component, 'description'),
         };
-        if (component['code_draft'] !== undefined)
-            props.code = component['code_draft'];
+        const codeDraft = (0, _existing_component_fields_1.optionalStringComponentField)(component, 'code_draft');
         if (component['dependencies'] !== undefined)
             props.dependencies = component['dependencies'];
         if (component['deployment_options'] !== undefined) {
@@ -82,7 +83,9 @@ class ManifestFunction {
             props.allowedDomains = component['allowed_domains'];
         if (component['is_async'] !== undefined)
             props.isAsync = component['is_async'];
-        return new ManifestFunction(scope, props);
+        const manifestFunction = new ManifestFunction(scope, props);
+        manifestFunction._codeDraft = codeDraft;
+        return manifestFunction;
     }
     /**
      * Returns the api_name of this function (e.g. `'gym_today_schedule_fn'`).
@@ -102,8 +105,9 @@ class ManifestFunction {
             api_name: this._apiName,
             description: this._description,
         };
-        if (this._code)
-            component['code_draft'] = this._code;
+        const codeDraft = this._codeDraft ?? (this._codeFile ? fs.readFileSync(this._codeFile, 'utf-8') : undefined);
+        if (codeDraft)
+            component['code_draft'] = codeDraft;
         if (this._dependencies != null)
             component['dependencies'] = this._dependencies;
         if (this._deploymentOptions != null)

package/lib/manifest/manifest-function.js.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-function.js","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":";;;AAAA,8EAA8G;AAE9G,gFAAyG;AAyDzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAa,gBAAgB;IAG3B,MAAM,CAAC,oBAAoB,CAAC,OAAe;QACzC,OAAO;YACL,IAAI,EAAE,gBAAgB,CAAC,aAAa;YACpC,QAAQ,EAAE,OAAO;SAClB,CAAC;IACJ,CAAC;IAWD;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAA4B;QAC5D,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC;QACvC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAe,EAAE,UAA0C,EAAE;QACnF,OAAO,IAAA,sDAA0B,EAAC,OAAO,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAED,sEAAsE;IACtE,MAAM,CAAC,sBAAsB,CAAC,KAAoB,EAAE,SAA8B;QAChF,MAAM,KAAK,GAA0B;YACnC,OAAO,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,UAAU,EAAE,gBAAgB,CAAC,aAAa,CAAC;YAC3F,IAAI,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,MAAM,EAAE,gBAAgB,CAAC,aAAa,CAAC;YACpF,WAAW,EAAE,IAAA,yDAA4B,EAAC,SAAS,EAAE,aAAa,CAAC;SACpE,CAAC;QACF,IAAI,SAAS,CAAC,YAAY,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;QAChF,IAAI,SAAS,CAAC,cAAc,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;QAC5F,IAAI,SAAS,CAAC,oBAAoB,CAAC,KAAK,SAAS,EAAE,CAAC;YAClD,KAAK,CAAC,iBAAiB,GAAG,SAAS,CAAC,oBAAoB,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,SAAS,CAAC,iBAAiB,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;QACpG,IAAI,SAAS,CAAC,UAAU,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;QAC/E,OAAO,IAAI,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,gBAAgB,CAAC,aAAa;YACpC,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,WAAW,EAAE,IAAI,CAAC,YAAY;SAC/B,CAAC;QACF,IAAI,IAAI,CAAC,KAAK;YAAE,SAAS,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QACrD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,SAAS,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/E,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI;YAAE,SAAS,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC/F,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI;YAAE,SAAS,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QACtF,IAAI,IAAI,CAAC,QAAQ;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAChD,OAAO,SAAS,CAAC;IACnB,CAAC;;AApFH,4CAqFC;AApFiB,8BAAa,GAAG,UAAmB,CAAC"}
+{"version":3,"file":"manifest-function.js","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":";;;;AAAA,oDAA8B;AAE9B,8EAA8G;AAE9G,gFAAyG;AA4DzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAa,gBAAgB;IAG3B,MAAM,CAAC,oBAAoB,CAAC,OAAe;QACzC,OAAO;YACL,IAAI,EAAE,gBAAgB,CAAC,aAAa;YACpC,QAAQ,EAAE,OAAO;SAClB,CAAC;IACJ,CAAC;IAYD;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAA4B;QAC5D,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC;QACvC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAe,EAAE,UAA0C,EAAE;QACnF,OAAO,IAAA,sDAA0B,EAAC,OAAO,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAED,sEAAsE;IACtE,MAAM,CAAC,sBAAsB,CAAC,KAAoB,EAAE,SAA8B;QAChF,MAAM,KAAK,GAA0B;YACnC,OAAO,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,UAAU,EAAE,gBAAgB,CAAC,aAAa,CAAC;YAC3F,IAAI,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,MAAM,EAAE,gBAAgB,CAAC,aAAa,CAAC;YACpF,WAAW,EAAE,IAAA,yDAA4B,EAAC,SAAS,EAAE,aAAa,CAAC;SACpE,CAAC;QACF,MAAM,SAAS,GAAG,IAAA,yDAA4B,EAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACxE,IAAI,SAAS,CAAC,cAAc,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;QAC5F,IAAI,SAAS,CAAC,oBAAoB,CAAC,KAAK,SAAS,EAAE,CAAC;YAClD,KAAK,CAAC,iBAAiB,GAAG,SAAS,CAAC,oBAAoB,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,SAAS,CAAC,iBAAiB,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;QACpG,IAAI,SAAS,CAAC,UAAU,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;QAC/E,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC5D,gBAAgB,CAAC,UAAU,GAAG,SAAS,CAAC;QACxC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,gBAAgB,CAAC,aAAa;YACpC,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,WAAW,EAAE,IAAI,CAAC,YAAY;SAC/B,CAAC;QACF,MAAM,SAAS,GACb,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC7F,IAAI,SAAS;YAAE,SAAS,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;QACnD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,SAAS,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/E,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI;YAAE,SAAS,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC/F,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI;YAAE,SAAS,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QACtF,IAAI,IAAI,CAAC,QAAQ;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAChD,OAAO,SAAS,CAAC;IACnB,CAAC;;AAzFH,4CA0FC;AAzFiB,8BAAa,GAAG,UAAmB,CAAC"}

package/lib/manifest/manifest-function.mjs

@@ -1,3 +1,4 @@
+import * as fs from 'node:fs';
 import { getExistingManifestContext } from "./existing-manifest-context.mjs";
 import { optionalStringComponentField, requireStringComponentField } from "./_existing-component-fields.mjs";
 /**
@@ -7,9 +8,9 @@ import { optionalStringComponentField, requireStringComponentField } from "./_ex
  * serverless infrastructure. The handler must export `onRipplingEvent`.
  *
  * Functions have two primary uses:
- * 1. **Authoring SDUI for Custom Apps** — the function returns an SDUI spec
- *    (built with `@rippling/rippling-sdk/lib/sdui`) that renders as a page tab.
- *    Wrap the function in an {@link SduiPage} and reference it from an {@link App}.
+ * 1. **Rendering SDUI for Custom Apps** — the function returns an SDUI spec
+ *    payload that renders as a page tab. Wrap the function in an {@link SduiPage}
+ *    and reference it from an {@link App}.
  * 2. **Workflow / event handlers** — functions invoked from rules, automations,
  *    or callbacks that do not render UI.
  *
@@ -23,7 +24,7 @@ import { optionalStringComponentField, requireStringComponentField } from "./_ex
  *   apiName: 'gym_today_schedule_fn',
  *   name: 'Today\'s schedule (SDUI)',
  *   description: 'Searchable grid of class sessions',
- *   code: handlerSource,
+ *   codeFile: './functions/gym_today_schedule_fn/code.ts',
  *   dependencies: {
  *     '@rippling/rippling-sdk': '^0.2.0-alpha.33',
  *   },
@@ -47,7 +48,7 @@ export class ManifestFunction {
     constructor(scope, props) {
         this._apiName = props.apiName;
         this._name = props.name;
-        this._code = props.code ?? '';
+        this._codeFile = props.codeFile;
         this._description = props.description;
         this._dependencies = props.dependencies;
         this._deploymentOptions = props.deploymentOptions;
@@ -68,8 +69,7 @@ export class ManifestFunction {
             name: requireStringComponentField(component, 'name', ManifestFunction.componentType),
             description: optionalStringComponentField(component, 'description'),
         };
-        if (component['code_draft'] !== undefined)
-            props.code = component['code_draft'];
+        const codeDraft = optionalStringComponentField(component, 'code_draft');
         if (component['dependencies'] !== undefined)
             props.dependencies = component['dependencies'];
         if (component['deployment_options'] !== undefined) {
@@ -79,7 +79,9 @@ export class ManifestFunction {
             props.allowedDomains = component['allowed_domains'];
         if (component['is_async'] !== undefined)
             props.isAsync = component['is_async'];
-        return new ManifestFunction(scope, props);
+        const manifestFunction = new ManifestFunction(scope, props);
+        manifestFunction._codeDraft = codeDraft;
+        return manifestFunction;
     }
     /**
      * Returns the api_name of this function (e.g. `'gym_today_schedule_fn'`).
@@ -99,8 +101,9 @@ export class ManifestFunction {
             api_name: this._apiName,
             description: this._description,
         };
-        if (this._code)
-            component['code_draft'] = this._code;
+        const codeDraft = this._codeDraft ?? (this._codeFile ? fs.readFileSync(this._codeFile, 'utf-8') : undefined);
+        if (codeDraft)
+            component['code_draft'] = codeDraft;
         if (this._dependencies != null)
             component['dependencies'] = this._dependencies;
         if (this._deploymentOptions != null)

package/lib/manifest/manifest-function.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-function.mjs","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAuC,wCAAoC;AAE9G,OAAO,EAAE,4BAA4B,EAAE,2BAA2B,EAAE,yCAAqC;AAyDzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,OAAO,gBAAgB;IAG3B,MAAM,CAAC,oBAAoB,CAAC,OAAe;QACzC,OAAO;YACL,IAAI,EAAE,gBAAgB,CAAC,aAAa;YACpC,QAAQ,EAAE,OAAO;SAClB,CAAC;IACJ,CAAC;IAWD;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAA4B;QAC5D,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC;QACvC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAe,EAAE,UAA0C,EAAE;QACnF,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAED,sEAAsE;IACtE,MAAM,CAAC,sBAAsB,CAAC,KAAoB,EAAE,SAA8B;QAChF,MAAM,KAAK,GAA0B;YACnC,OAAO,EAAE,2BAA2B,CAAC,SAAS,EAAE,UAAU,EAAE,gBAAgB,CAAC,aAAa,CAAC;YAC3F,IAAI,EAAE,2BAA2B,CAAC,SAAS,EAAE,MAAM,EAAE,gBAAgB,CAAC,aAAa,CAAC;YACpF,WAAW,EAAE,4BAA4B,CAAC,SAAS,EAAE,aAAa,CAAC;SACpE,CAAC;QACF,IAAI,SAAS,CAAC,YAAY,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;QAChF,IAAI,SAAS,CAAC,cAAc,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;QAC5F,IAAI,SAAS,CAAC,oBAAoB,CAAC,KAAK,SAAS,EAAE,CAAC;YAClD,KAAK,CAAC,iBAAiB,GAAG,SAAS,CAAC,oBAAoB,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,SAAS,CAAC,iBAAiB,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;QACpG,IAAI,SAAS,CAAC,UAAU,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;QAC/E,OAAO,IAAI,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,gBAAgB,CAAC,aAAa;YACpC,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,WAAW,EAAE,IAAI,CAAC,YAAY;SAC/B,CAAC;QACF,IAAI,IAAI,CAAC,KAAK;YAAE,SAAS,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QACrD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,SAAS,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/E,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI;YAAE,SAAS,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC/F,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI;YAAE,SAAS,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QACtF,IAAI,IAAI,CAAC,QAAQ;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAChD,OAAO,SAAS,CAAC;IACnB,CAAC;;AAnFe,8BAAa,GAAG,UAAmB,CAAC"}
+{"version":3,"file":"manifest-function.mjs","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAE9B,OAAO,EAAE,0BAA0B,EAAuC,wCAAoC;AAE9G,OAAO,EAAE,4BAA4B,EAAE,2BAA2B,EAAE,yCAAqC;AA4DzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,OAAO,gBAAgB;IAG3B,MAAM,CAAC,oBAAoB,CAAC,OAAe;QACzC,OAAO;YACL,IAAI,EAAE,gBAAgB,CAAC,aAAa;YACpC,QAAQ,EAAE,OAAO;SAClB,CAAC;IACJ,CAAC;IAYD;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAA4B;QAC5D,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC;QACvC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAe,EAAE,UAA0C,EAAE;QACnF,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;IACnE,CAAC;IAED,sEAAsE;IACtE,MAAM,CAAC,sBAAsB,CAAC,KAAoB,EAAE,SAA8B;QAChF,MAAM,KAAK,GAA0B;YACnC,OAAO,EAAE,2BAA2B,CAAC,SAAS,EAAE,UAAU,EAAE,gBAAgB,CAAC,aAAa,CAAC;YAC3F,IAAI,EAAE,2BAA2B,CAAC,SAAS,EAAE,MAAM,EAAE,gBAAgB,CAAC,aAAa,CAAC;YACpF,WAAW,EAAE,4BAA4B,CAAC,SAAS,EAAE,aAAa,CAAC;SACpE,CAAC;QACF,MAAM,SAAS,GAAG,4BAA4B,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QACxE,IAAI,SAAS,CAAC,cAAc,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,YAAY,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;QAC5F,IAAI,SAAS,CAAC,oBAAoB,CAAC,KAAK,SAAS,EAAE,CAAC;YAClD,KAAK,CAAC,iBAAiB,GAAG,SAAS,CAAC,oBAAoB,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,SAAS,CAAC,iBAAiB,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;QACpG,IAAI,SAAS,CAAC,UAAU,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,OAAO,GAAG,SAAS,CAAC,UAAU,CAAC,CAAC;QAC/E,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC5D,gBAAgB,CAAC,UAAU,GAAG,SAAS,CAAC;QACxC,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,gBAAgB,CAAC,aAAa;YACpC,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,WAAW,EAAE,IAAI,CAAC,YAAY;SAC/B,CAAC;QACF,MAAM,SAAS,GACb,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QAC7F,IAAI,SAAS;YAAE,SAAS,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;QACnD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,SAAS,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/E,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI;YAAE,SAAS,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC/F,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI;YAAE,SAAS,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QACtF,IAAI,IAAI,CAAC,QAAQ;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAChD,OAAO,SAAS,CAAC;IACnB,CAAC;;AAxFe,8BAAa,GAAG,UAAmB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rippling/rippling-sdk",
-  "version": "0.2.0-alpha.59",
+  "version": "0.2.0-alpha.61",
   "description": "The official TypeScript library for the Rippling SDK API",
   "author": "Rippling SDK <no-reply@rippling.com>",
   "types": "./index.d.ts",

package/src/lib/manifest/index.ts

@@ -176,6 +176,7 @@ export {
 export {
   ManifestFunction,
   ManifestFunction as Function,
+  type FunctionCodeFile,
   type ManifestFunctionProps,
 } from './manifest-function';
 

package/src/lib/manifest/manifest-function.ts

@@ -1,7 +1,11 @@
+import * as fs from 'node:fs';
+
 import { getExistingManifestContext, type ExistingManifestContextOptions } from './existing-manifest-context';
 import type { ManifestComponentDeletion, ManifestScope } from './manifest-builder';
 import { optionalStringComponentField, requireStringComponentField } from './_existing-component-fields';
 
+export type FunctionCodeFile = `./${string}.ts` | `/${string}.ts`;
+
 /**
  * Initialization properties for {@link ManifestFunction}.
  */
@@ -19,11 +23,12 @@ export interface ManifestFunctionProps {
    */
   name: string;
   /**
-   * TypeScript handler source code. Must export an `onRipplingEvent` function.
+   * Path to a TypeScript handler source file. The file must export an
+   * `onRipplingEvent` function. Its contents are serialized to `code_draft`.
    *
    * Optional. @default `''`
    */
-  code?: string;
+  codeFile?: FunctionCodeFile;
   /**
    * Human-readable description of what this function does.
    *
@@ -64,9 +69,9 @@ export interface ManifestFunctionProps {
  * serverless infrastructure. The handler must export `onRipplingEvent`.
  *
  * Functions have two primary uses:
- * 1. **Authoring SDUI for Custom Apps** — the function returns an SDUI spec
- *    (built with `@rippling/rippling-sdk/lib/sdui`) that renders as a page tab.
- *    Wrap the function in an {@link SduiPage} and reference it from an {@link App}.
+ * 1. **Rendering SDUI for Custom Apps** — the function returns an SDUI spec
+ *    payload that renders as a page tab. Wrap the function in an {@link SduiPage}
+ *    and reference it from an {@link App}.
  * 2. **Workflow / event handlers** — functions invoked from rules, automations,
  *    or callbacks that do not render UI.
  *
@@ -80,7 +85,7 @@ export interface ManifestFunctionProps {
  *   apiName: 'gym_today_schedule_fn',
  *   name: 'Today\'s schedule (SDUI)',
  *   description: 'Searchable grid of class sessions',
- *   code: handlerSource,
+ *   codeFile: './functions/gym_today_schedule_fn/code.ts',
  *   dependencies: {
  *     '@rippling/rippling-sdk': '^0.2.0-alpha.33',
  *   },
@@ -102,7 +107,8 @@ export class ManifestFunction {
 
   private readonly _apiName: string;
   private readonly _name: string;
-  private readonly _code: string;
+  private readonly _codeFile: FunctionCodeFile | undefined;
+  private _codeDraft: string | undefined;
   private readonly _description: string;
   private readonly _dependencies: Record<string, string> | undefined;
   private readonly _deploymentOptions: Record<string, any> | undefined;
@@ -116,7 +122,7 @@ export class ManifestFunction {
   constructor(scope: ManifestScope, props: ManifestFunctionProps) {
     this._apiName = props.apiName;
     this._name = props.name;
-    this._code = props.code ?? '';
+    this._codeFile = props.codeFile;
     this._description = props.description;
     this._dependencies = props.dependencies;
     this._deploymentOptions = props.deploymentOptions;
@@ -139,14 +145,16 @@ export class ManifestFunction {
       name: requireStringComponentField(component, 'name', ManifestFunction.componentType),
       description: optionalStringComponentField(component, 'description'),
     };
-    if (component['code_draft'] !== undefined) props.code = component['code_draft'];
+    const codeDraft = optionalStringComponentField(component, 'code_draft');
     if (component['dependencies'] !== undefined) props.dependencies = component['dependencies'];
     if (component['deployment_options'] !== undefined) {
       props.deploymentOptions = component['deployment_options'];
     }
     if (component['allowed_domains'] !== undefined) props.allowedDomains = component['allowed_domains'];
     if (component['is_async'] !== undefined) props.isAsync = component['is_async'];
-    return new ManifestFunction(scope, props);
+    const manifestFunction = new ManifestFunction(scope, props);
+    manifestFunction._codeDraft = codeDraft;
+    return manifestFunction;
   }
 
   /**
@@ -168,7 +176,9 @@ export class ManifestFunction {
       api_name: this._apiName,
       description: this._description,
     };
-    if (this._code) component['code_draft'] = this._code;
+    const codeDraft =
+      this._codeDraft ?? (this._codeFile ? fs.readFileSync(this._codeFile, 'utf-8') : undefined);
+    if (codeDraft) component['code_draft'] = codeDraft;
     if (this._dependencies != null) component['dependencies'] = this._dependencies;
     if (this._deploymentOptions != null) component['deployment_options'] = this._deploymentOptions;
     if (this._allowedDomains != null) component['allowed_domains'] = this._allowedDomains;

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.2.0-alpha.59'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.61'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.59";
+export declare const VERSION = "0.2.0-alpha.61";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.59";
+export declare const VERSION = "0.2.0-alpha.61";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.2.0-alpha.59'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.61'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.2.0-alpha.59'; // x-release-please-version
+export const VERSION = '0.2.0-alpha.61'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map