@rippling/rippling-sdk 0.2.0-alpha.37 → 0.2.0-alpha.39

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

@@ -1,3 +1,4 @@
+import { ExistingManifestContext, type ExistingManifestSource } from "./existing-manifest-context.js";
 /**
  * Any object that can be included in a manifest.
  *
@@ -7,6 +8,25 @@
 export interface ManifestComponent {
     toDict(): Record<string, any>;
 }
+/**
+ * Wire-level component types supported by the manifest builder.
+ */
+export type ManifestComponentType = 'CUSTOM_APP' | 'CUSTOM_CATEGORY' | 'CUSTOM_OBJECT' | 'CUSTOM_OBJECT_FIELD' | 'CUSTOM_OBJECT_FIELD_SECTION' | 'CUSTOM_OBJECT_LIST_VIEW' | 'CUSTOM_OBJECT_PAGE_LAYOUT' | 'CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW' | 'CUSTOM_OBJECT_VALIDATION_RULE' | 'FUNCTION' | 'SDUI_PAGE';
+/**
+ * Static side of a manifest component class.
+ */
+export interface ManifestComponentClass<TIdentifierInput = unknown> {
+    readonly componentType: ManifestComponentType;
+    toDeletionIdentifier(identifier: TIdentifierInput): ManifestComponentDeletion;
+    new (...args: any[]): ManifestComponent;
+}
+/**
+ * A manifest component reference that should be deleted during install.
+ */
+export interface ManifestComponentDeletion extends Record<string, any> {
+    /** Wire-level component type, e.g. `'CUSTOM_OBJECT'` or `'CUSTOM_OBJECT_FIELD'`. */
+    type: ManifestComponentType;
+}
 /**
  * A scope — anything that can accept child component registrations.
  *
@@ -41,6 +61,14 @@ export interface ManifestBuilderProps {
      */
     description?: string;
 }
+/**
+ * Plain object returned by {@link ManifestBuilder.buildManifest}.
+ */
+export interface BuiltManifest {
+    metadata: Record<string, any>;
+    components: Record<string, any>[];
+    components_to_delete?: ManifestComponentDeletion[];
+}
 /**
  * Root container for a manifest — collects all components and serializes them to JSON.
  *
@@ -60,7 +88,7 @@ export interface ManifestBuilderProps {
  *   description: 'Members, trainers, schedules, and check-in',
  * });
  *
- * const category = new Category(manifest, { apiName: 'gym__c', name: 'Gym' });
+ * const category = new Category(manifest, { apiName: 'gym__c', name: 'Gym', description: 'Gym domain' });
  * const memberObj = new CustomObject(manifest, { apiName: 'gym_member__c', name: 'Member', category });
  * // ... define fields, rules, list views, etc. ...
  *
@@ -72,31 +100,56 @@ export declare class ManifestBuilder implements ManifestScope {
     readonly name: string;
     readonly description: string;
     private readonly _components;
+    private readonly _componentsToDelete;
     /**
      * @param props - Initialization properties.
      * @throws {Error} If `props.key` is empty or missing.
      */
     constructor(props: ManifestBuilderProps);
+    /**
+     * Parses an existing manifest JSON blob, installs it as the active load context,
+     * hydrates every known component, and returns a normal `ManifestBuilder`.
+     */
+    static loadFromExistingJson(source: ExistingManifestSource): ManifestBuilder;
+    /**
+     * Parses an existing manifest JSON blob and installs it as the active lazy-load context.
+     *
+     * After calling this, individual components can be loaded with
+     * `CustomObjectPageLayout.loadFromExisting(...)`, `Field.loadFromExisting(...)`, etc.
+     */
+    static useExistingJson(source: ExistingManifestSource): ExistingManifestContext;
     /**
      * @internal Scope hook invoked by child constructors. Components enter the
      * manifest here — there is no other path.
      */
     _register(component: ManifestComponent): void;
     /**
-     * Returns the manifest as a plain object with `metadata` and a flat `components` array.
+     * Marks a component to be deleted when this manifest is installed.
      *
-     * @returns `{ metadata: { key, name, description? }, components: Record<string, any>[] }`
+     * @param componentClass - Component class, e.g. `CustomObject`.
+     * @param identifier - Component identifier/key, such as an api_name or the component's identifier object.
+     * @returns This builder for chaining.
      */
-    buildManifest(): {
-        metadata: Record<string, any>;
-        components: Record<string, any>[];
-    };
+    markComponentForDeletion<TIdentifierInput>(componentClass: ManifestComponentClass<TIdentifierInput>, identifier: TIdentifierInput): this;
+    /**
+     * Returns the manifest as a plain object with `metadata`, a flat `components` array,
+     * and a `components_to_delete` array when deletions are registered.
+     *
+     * @returns `{ metadata: { key, name, description? }, components, components_to_delete? }`
+     */
+    buildManifest(): BuiltManifest;
     /**
      * Returns the flat list of all registered component dicts.
      *
      * @returns An array of wire-format component objects, in registration order.
      */
     componentsList(): Record<string, any>[];
+    /**
+     * Returns the flat list of component deletion references.
+     *
+     * @returns An array of component identifier objects, in registration order.
+     */
+    componentsToDeleteList(): ManifestComponentDeletion[];
     /**
      * Returns the full manifest as a pretty-printed JSON string.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"manifest-builder.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,6EAA6E;IAC7E,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,eAAgB,YAAW,aAAa;IACnD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IAEvD;;;OAGG;gBACS,KAAK,EAAE,oBAAoB;IASvC;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;IAO7C;;;;OAIG;IACH,aAAa,IAAI;QAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;KAAE;IAYrF;;;;OAIG;IACH,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;IAIvC;;;;;;;OAOG;IACH,OAAO,IAAI,MAAM;CAGlB"}
+{"version":3,"file":"manifest-builder.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"OAAO,EAAE,uBAAuB,EAAE,KAAK,sBAAsB,EAAE;AAE/D;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAC7B,YAAY,GACZ,iBAAiB,GACjB,eAAe,GACf,qBAAqB,GACrB,6BAA6B,GAC7B,yBAAyB,GACzB,2BAA2B,GAC3B,qCAAqC,GACrC,+BAA+B,GAC/B,UAAU,GACV,WAAW,CAAC;AAEhB;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,gBAAgB,GAAG,OAAO;IAChE,QAAQ,CAAC,aAAa,EAAE,qBAAqB,CAAC;IAC9C,oBAAoB,CAAC,UAAU,EAAE,gBAAgB,GAAG,yBAAyB,CAAC;IAC9E,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,iBAAiB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IACpE,oFAAoF;IACpF,IAAI,EAAE,qBAAqB,CAAC;CAC7B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,6EAA6E;IAC7E,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC;IAClC,oBAAoB,CAAC,EAAE,yBAAyB,EAAE,CAAC;CACpD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,eAAgB,YAAW,aAAa;IACnD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IACvD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAmC;IAEvE;;;OAGG;gBACS,KAAK,EAAE,oBAAoB;IASvC;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,MAAM,EAAE,sBAAsB,GAAG,eAAe;IAI5E;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,MAAM,EAAE,sBAAsB,GAAG,uBAAuB;IAI/E;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;IAO7C;;;;;;OAMG;IACH,wBAAwB,CAAC,gBAAgB,EACvC,cAAc,EAAE,sBAAsB,CAAC,gBAAgB,CAAC,EACxD,UAAU,EAAE,gBAAgB,GAC3B,IAAI;IAuBP;;;;;OAKG;IACH,aAAa,IAAI,aAAa;IAgB9B;;;;OAIG;IACH,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;IAIvC;;;;OAIG;IACH,sBAAsB,IAAI,yBAAyB,EAAE;IAIrD;;;;;;;OAOG;IACH,OAAO,IAAI,MAAM;CAGlB"}

package/lib/manifest/manifest-builder.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ManifestBuilder = void 0;
+const existing_manifest_context_1 = require("./existing-manifest-context.js");
 /**
  * Root container for a manifest — collects all components and serializes them to JSON.
  *
@@ -20,7 +21,7 @@ exports.ManifestBuilder = void 0;
  *   description: 'Members, trainers, schedules, and check-in',
  * });
  *
- * const category = new Category(manifest, { apiName: 'gym__c', name: 'Gym' });
+ * const category = new Category(manifest, { apiName: 'gym__c', name: 'Gym', description: 'Gym domain' });
  * const memberObj = new CustomObject(manifest, { apiName: 'gym_member__c', name: 'Member', category });
  * // ... define fields, rules, list views, etc. ...
  *
@@ -34,6 +35,7 @@ class ManifestBuilder {
      */
     constructor(props) {
         this._components = [];
+        this._componentsToDelete = [];
         if (!props.key) {
             throw new Error('key is required');
         }
@@ -41,6 +43,22 @@ class ManifestBuilder {
         this.name = props.name || props.key;
         this.description = props.description ?? '';
     }
+    /**
+     * Parses an existing manifest JSON blob, installs it as the active load context,
+     * hydrates every known component, and returns a normal `ManifestBuilder`.
+     */
+    static loadFromExistingJson(source) {
+        return existing_manifest_context_1.ExistingManifestContext.fromJson(source).loadManifestBuilder();
+    }
+    /**
+     * Parses an existing manifest JSON blob and installs it as the active lazy-load context.
+     *
+     * After calling this, individual components can be loaded with
+     * `CustomObjectPageLayout.loadFromExisting(...)`, `Field.loadFromExisting(...)`, etc.
+     */
+    static useExistingJson(source) {
+        return existing_manifest_context_1.ExistingManifestContext.fromJson(source);
+    }
     /**
      * @internal Scope hook invoked by child constructors. Components enter the
      * manifest here — there is no other path.
@@ -52,9 +70,37 @@ class ManifestBuilder {
         this._components.push(component);
     }
     /**
-     * Returns the manifest as a plain object with `metadata` and a flat `components` array.
+     * Marks a component to be deleted when this manifest is installed.
      *
-     * @returns `{ metadata: { key, name, description? }, components: Record<string, any>[] }`
+     * @param componentClass - Component class, e.g. `CustomObject`.
+     * @param identifier - Component identifier/key, such as an api_name or the component's identifier object.
+     * @returns This builder for chaining.
+     */
+    markComponentForDeletion(componentClass, identifier) {
+        if (identifier == null || identifier === '') {
+            throw new Error('identifier is required');
+        }
+        if (!componentClass.componentType) {
+            throw new Error('type is required');
+        }
+        if (typeof componentClass.toDeletionIdentifier !== 'function') {
+            throw new TypeError('Component class must have a toDeletionIdentifier() method');
+        }
+        const deletion = componentClass.toDeletionIdentifier(identifier);
+        if (!deletion.type) {
+            throw new Error('type is required');
+        }
+        if (Object.keys(deletion).length <= 1) {
+            throw new Error('identifier is required');
+        }
+        this._componentsToDelete.push({ ...deletion });
+        return this;
+    }
+    /**
+     * Returns the manifest as a plain object with `metadata`, a flat `components` array,
+     * and a `components_to_delete` array when deletions are registered.
+     *
+     * @returns `{ metadata: { key, name, description? }, components, components_to_delete? }`
      */
     buildManifest() {
         const metadata = {
@@ -65,7 +111,11 @@ class ManifestBuilder {
             metadata['description'] = this.description;
         }
         const components = this._components.map((c) => c.toDict());
-        return { metadata, components };
+        const manifest = { metadata, components };
+        if (this._componentsToDelete.length > 0) {
+            manifest.components_to_delete = this.componentsToDeleteList();
+        }
+        return manifest;
     }
     /**
      * Returns the flat list of all registered component dicts.
@@ -75,6 +125,14 @@ class ManifestBuilder {
     componentsList() {
         return this._components.map((c) => c.toDict());
     }
+    /**
+     * Returns the flat list of component deletion references.
+     *
+     * @returns An array of component identifier objects, in registration order.
+     */
+    componentsToDeleteList() {
+        return this._componentsToDelete.map((component) => ({ ...component }));
+    }
     /**
      * Returns the full manifest as a pretty-printed JSON string.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"manifest-builder.js","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":";;;AA8CA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,eAAe;IAM1B;;;OAGG;IACH,YAAY,KAA2B;QANtB,gBAAW,GAAwB,EAAE,CAAC;QAOrD,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAA4B;QACpC,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,MAAM,QAAQ,GAAwB;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;QACF,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QAC7C,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3D,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;CACF;AAnED,0CAmEC"}
+{"version":3,"file":"manifest-builder.js","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":";;;AAAA,8EAAmG;AA0FnG;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,eAAe;IAO1B;;;OAGG;IACH,YAAY,KAA2B;QAPtB,gBAAW,GAAwB,EAAE,CAAC;QACtC,wBAAmB,GAAgC,EAAE,CAAC;QAOrE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,MAA8B;QACxD,OAAO,mDAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,mBAAmB,EAAE,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,MAA8B;QACnD,OAAO,mDAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAA4B;QACpC,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,wBAAwB,CACtB,cAAwD,EACxD,UAA4B;QAE5B,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,OAAO,cAAc,CAAC,oBAAoB,KAAK,UAAU,EAAE,CAAC;YAC9D,MAAM,IAAI,SAAS,CAAC,2DAA2D,CAAC,CAAC;QACnF,CAAC;QAED,MAAM,QAAQ,GAAG,cAAc,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,aAAa;QACX,MAAM,QAAQ,GAAwB;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;QACF,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QAC7C,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAkB,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;QACzD,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxC,QAAQ,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAChE,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;CACF;AArID,0CAqIC"}

package/lib/manifest/manifest-builder.mjs

@@ -1,3 +1,4 @@
+import { ExistingManifestContext } from "./existing-manifest-context.mjs";
 /**
  * Root container for a manifest — collects all components and serializes them to JSON.
  *
@@ -17,7 +18,7 @@
  *   description: 'Members, trainers, schedules, and check-in',
  * });
  *
- * const category = new Category(manifest, { apiName: 'gym__c', name: 'Gym' });
+ * const category = new Category(manifest, { apiName: 'gym__c', name: 'Gym', description: 'Gym domain' });
  * const memberObj = new CustomObject(manifest, { apiName: 'gym_member__c', name: 'Member', category });
  * // ... define fields, rules, list views, etc. ...
  *
@@ -31,6 +32,7 @@ export class ManifestBuilder {
      */
     constructor(props) {
         this._components = [];
+        this._componentsToDelete = [];
         if (!props.key) {
             throw new Error('key is required');
         }
@@ -38,6 +40,22 @@ export class ManifestBuilder {
         this.name = props.name || props.key;
         this.description = props.description ?? '';
     }
+    /**
+     * Parses an existing manifest JSON blob, installs it as the active load context,
+     * hydrates every known component, and returns a normal `ManifestBuilder`.
+     */
+    static loadFromExistingJson(source) {
+        return ExistingManifestContext.fromJson(source).loadManifestBuilder();
+    }
+    /**
+     * Parses an existing manifest JSON blob and installs it as the active lazy-load context.
+     *
+     * After calling this, individual components can be loaded with
+     * `CustomObjectPageLayout.loadFromExisting(...)`, `Field.loadFromExisting(...)`, etc.
+     */
+    static useExistingJson(source) {
+        return ExistingManifestContext.fromJson(source);
+    }
     /**
      * @internal Scope hook invoked by child constructors. Components enter the
      * manifest here — there is no other path.
@@ -49,9 +67,37 @@ export class ManifestBuilder {
         this._components.push(component);
     }
     /**
-     * Returns the manifest as a plain object with `metadata` and a flat `components` array.
+     * Marks a component to be deleted when this manifest is installed.
      *
-     * @returns `{ metadata: { key, name, description? }, components: Record<string, any>[] }`
+     * @param componentClass - Component class, e.g. `CustomObject`.
+     * @param identifier - Component identifier/key, such as an api_name or the component's identifier object.
+     * @returns This builder for chaining.
+     */
+    markComponentForDeletion(componentClass, identifier) {
+        if (identifier == null || identifier === '') {
+            throw new Error('identifier is required');
+        }
+        if (!componentClass.componentType) {
+            throw new Error('type is required');
+        }
+        if (typeof componentClass.toDeletionIdentifier !== 'function') {
+            throw new TypeError('Component class must have a toDeletionIdentifier() method');
+        }
+        const deletion = componentClass.toDeletionIdentifier(identifier);
+        if (!deletion.type) {
+            throw new Error('type is required');
+        }
+        if (Object.keys(deletion).length <= 1) {
+            throw new Error('identifier is required');
+        }
+        this._componentsToDelete.push({ ...deletion });
+        return this;
+    }
+    /**
+     * Returns the manifest as a plain object with `metadata`, a flat `components` array,
+     * and a `components_to_delete` array when deletions are registered.
+     *
+     * @returns `{ metadata: { key, name, description? }, components, components_to_delete? }`
      */
     buildManifest() {
         const metadata = {
@@ -62,7 +108,11 @@ export class ManifestBuilder {
             metadata['description'] = this.description;
         }
         const components = this._components.map((c) => c.toDict());
-        return { metadata, components };
+        const manifest = { metadata, components };
+        if (this._componentsToDelete.length > 0) {
+            manifest.components_to_delete = this.componentsToDeleteList();
+        }
+        return manifest;
     }
     /**
      * Returns the flat list of all registered component dicts.
@@ -72,6 +122,14 @@ export class ManifestBuilder {
     componentsList() {
         return this._components.map((c) => c.toDict());
     }
+    /**
+     * Returns the flat list of component deletion references.
+     *
+     * @returns An array of component identifier objects, in registration order.
+     */
+    componentsToDeleteList() {
+        return this._componentsToDelete.map((component) => ({ ...component }));
+    }
     /**
      * Returns the full manifest as a pretty-printed JSON string.
      *

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

@@ -1 +1 @@
-{"version":3,"file":"manifest-builder.mjs","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"AA8CA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,eAAe;IAM1B;;;OAGG;IACH,YAAY,KAA2B;QANtB,gBAAW,GAAwB,EAAE,CAAC;QAOrD,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAA4B;QACpC,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,MAAM,QAAQ,GAAwB;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;QACF,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QAC7C,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3D,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;CACF"}
+{"version":3,"file":"manifest-builder.mjs","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"OAAO,EAAE,uBAAuB,EAA+B;AA0F/D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,eAAe;IAO1B;;;OAGG;IACH,YAAY,KAA2B;QAPtB,gBAAW,GAAwB,EAAE,CAAC;QACtC,wBAAmB,GAAgC,EAAE,CAAC;QAOrE,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,MAA8B;QACxD,OAAO,uBAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,mBAAmB,EAAE,CAAC;IACxE,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,eAAe,CAAC,MAA8B;QACnD,OAAO,uBAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAClD,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAA4B;QACpC,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;OAMG;IACH,wBAAwB,CACtB,cAAwD,EACxD,UAA4B;QAE5B,IAAI,UAAU,IAAI,IAAI,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,aAAa,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,OAAO,cAAc,CAAC,oBAAoB,KAAK,UAAU,EAAE,CAAC;YAC9D,MAAM,IAAI,SAAS,CAAC,2DAA2D,CAAC,CAAC;QACnF,CAAC;QAED,MAAM,QAAQ,GAAG,cAAc,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QACD,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,aAAa;QACX,MAAM,QAAQ,GAAwB;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;QACF,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QAC7C,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAkB,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;QACzD,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxC,QAAQ,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAChE,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;OAIG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,SAAS,EAAE,CAAC,CAAC,CAAC;IACzE,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;CACF"}

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

@@ -1,5 +1,6 @@
 import type { FunctionRuntime } from "./_helpers.mjs";
-import type { ManifestScope } from "./manifest-builder.mjs";
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.mjs";
+import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.mjs";
 /**
  * Initialization properties for {@link ManifestFunction}.
  */
@@ -66,8 +67,14 @@ export interface ManifestFunctionProps {
  * Defines a serverless function and registers it with the manifest.
  *
  * A `ManifestFunction` packages TypeScript handler code that runs on Rippling's
- * serverless infrastructure. Functions are the backing implementation for
- * {@link SduiPage} surfaces. The handler must export `onRipplingEvent`.
+ * 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/sdui-builder`) 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.
  *
  * This class is named `ManifestFunction` to avoid collision with the JavaScript
  * built-in `Function`. It is also re-exported as `Function` from the barrel for
@@ -92,6 +99,8 @@ export interface ManifestFunctionProps {
  * @see {@link SduiPage} — wraps a `ManifestFunction` as a navigable UI surface.
  */
 export declare class ManifestFunction {
+    static readonly componentType: "FUNCTION";
+    static toDeletionIdentifier(apiName: string): ManifestComponentDeletion;
     private readonly _apiName;
     private readonly _name;
     private readonly _code;
@@ -105,6 +114,12 @@ export declare class ManifestFunction {
      * @param props - Initialization properties.
      */
     constructor(scope: ManifestScope, props: ManifestFunctionProps);
+    /**
+     * Loads this function from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(apiName: string, options?: ExistingManifestContextOptions): ManifestFunction;
+    /** @internal Hydrates a function from existing manifest wire JSON. */
+    static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>): ManifestFunction;
     /**
      * Returns the api_name of this function (e.g. `'gym_today_schedule_fn'`).
      */

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

@@ -1 +1 @@
-{"version":3,"file":"manifest-function.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,eAAe,EAAE;OACxB,KAAK,EAAE,aAAa,EAAE;AAE7B;;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,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;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;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,gBAAgB;IAC3B,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;IAe9D;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}
+{"version":3,"file":"manifest-function.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,eAAe,EAAE;OACxB,EAA8B,KAAK,8BAA8B,EAAE;OACnE,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE;AAExD;;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,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;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;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;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;IAe9D;;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"}

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

@@ -1,5 +1,6 @@
 import type { FunctionRuntime } from "./_helpers.js";
-import type { ManifestScope } from "./manifest-builder.js";
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.js";
+import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.js";
 /**
  * Initialization properties for {@link ManifestFunction}.
  */
@@ -66,8 +67,14 @@ export interface ManifestFunctionProps {
  * Defines a serverless function and registers it with the manifest.
  *
  * A `ManifestFunction` packages TypeScript handler code that runs on Rippling's
- * serverless infrastructure. Functions are the backing implementation for
- * {@link SduiPage} surfaces. The handler must export `onRipplingEvent`.
+ * 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/sdui-builder`) 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.
  *
  * This class is named `ManifestFunction` to avoid collision with the JavaScript
  * built-in `Function`. It is also re-exported as `Function` from the barrel for
@@ -92,6 +99,8 @@ export interface ManifestFunctionProps {
  * @see {@link SduiPage} — wraps a `ManifestFunction` as a navigable UI surface.
  */
 export declare class ManifestFunction {
+    static readonly componentType: "FUNCTION";
+    static toDeletionIdentifier(apiName: string): ManifestComponentDeletion;
     private readonly _apiName;
     private readonly _name;
     private readonly _code;
@@ -105,6 +114,12 @@ export declare class ManifestFunction {
      * @param props - Initialization properties.
      */
     constructor(scope: ManifestScope, props: ManifestFunctionProps);
+    /**
+     * Loads this function from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(apiName: string, options?: ExistingManifestContextOptions): ManifestFunction;
+    /** @internal Hydrates a function from existing manifest wire JSON. */
+    static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>): ManifestFunction;
     /**
      * Returns the api_name of this function (e.g. `'gym_today_schedule_fn'`).
      */

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":"OAAO,KAAK,EAAE,eAAe,EAAE;OACxB,KAAK,EAAE,aAAa,EAAE;AAE7B;;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,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;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;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,gBAAgB;IAC3B,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;IAe9D;;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":"OAAO,KAAK,EAAE,eAAe,EAAE;OACxB,EAA8B,KAAK,8BAA8B,EAAE;OACnE,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE;AAExD;;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,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;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;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;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;IAe9D;;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"}

package/lib/manifest/manifest-function.js

@@ -1,12 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ManifestFunction = void 0;
+const existing_manifest_context_1 = require("./existing-manifest-context.js");
 /**
  * Defines a serverless function and registers it with the manifest.
  *
  * A `ManifestFunction` packages TypeScript handler code that runs on Rippling's
- * serverless infrastructure. Functions are the backing implementation for
- * {@link SduiPage} surfaces. The handler must export `onRipplingEvent`.
+ * 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/sdui-builder`) 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.
  *
  * This class is named `ManifestFunction` to avoid collision with the JavaScript
  * built-in `Function`. It is also re-exported as `Function` from the barrel for
@@ -31,6 +38,12 @@ exports.ManifestFunction = void 0;
  * @see {@link SduiPage} — wraps a `ManifestFunction` as a navigable UI surface.
  */
 class ManifestFunction {
+    static toDeletionIdentifier(apiName) {
+        return {
+            type: ManifestFunction.componentType,
+            api_name: apiName,
+        };
+    }
     /**
      * @param scope - The manifest to register this function with.
      * @param props - Initialization properties.
@@ -49,6 +62,33 @@ class ManifestFunction {
         this._isAsync = props.isAsync ?? false;
         scope._register(this);
     }
+    /**
+     * Loads this function from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(apiName, options = {}) {
+        return (0, existing_manifest_context_1.getExistingManifestContext)(options).loadFunction(apiName);
+    }
+    /** @internal Hydrates a function from existing manifest wire JSON. */
+    static _fromExistingComponent(scope, component) {
+        const props = {
+            apiName: component['api_name'],
+            name: component['name'] ?? component['api_name'],
+        };
+        if (component['code_draft'] !== undefined)
+            props.code = component['code_draft'];
+        if (component['description'] !== undefined)
+            props.description = component['description'];
+        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);
+    }
     /**
      * Returns the api_name of this function (e.g. `'gym_today_schedule_fn'`).
      */
@@ -62,7 +102,7 @@ class ManifestFunction {
      */
     toDict() {
         const component = {
-            type: 'FUNCTION',
+            type: ManifestFunction.componentType,
             name: this._name,
             api_name: this._apiName,
         };
@@ -82,4 +122,5 @@ class ManifestFunction {
     }
 }
 exports.ManifestFunction = ManifestFunction;
+ManifestFunction.componentType = 'FUNCTION';
 //# sourceMappingURL=manifest-function.js.map

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":";;;AAkEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAa,gBAAgB;IAU3B;;;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,IAAI,EAAE,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,kBAAkB,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QAC3F,CAAC;QACD,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,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,IAAI,CAAC,YAAY;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACpE,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;CACF;AAvDD,4CAuDC"}
+{"version":3,"file":"manifest-function.js","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":";;;AACA,8EAA8G;AAkE9G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;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,IAAI,EAAE,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,kBAAkB,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QAC3F,CAAC;QACD,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,SAAS,CAAC,UAAU,CAAC;YAC9B,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC;SACjD,CAAC;QACF,IAAI,SAAS,CAAC,YAAY,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;QAChF,IAAI,SAAS,CAAC,aAAa,CAAC,KAAK,SAAS;YAAE,KAAK,CAAC,WAAW,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;QACzF,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;SACxB,CAAC;QACF,IAAI,IAAI,CAAC,YAAY;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACpE,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;;AAvFH,4CAwFC;AAvFiB,8BAAa,GAAG,UAAmB,CAAC"}