@rippling/rippling-sdk 0.2.0-alpha.38 → 0.2.0-alpha.40

package/examples/manifest/existing-manifest-mutations/existing-manifest-mutations.ts

@@ -0,0 +1,240 @@
+/*
+ * Existing manifest mutations.
+ *
+ * This example keeps the existing manifest JSON inline, hydrates it back into
+ * SDK objects, removes layout content, adds different layout content, and
+ * prints the updated manifest JSON.
+ *
+ * Run:
+ *   yarn -s tsn examples/manifest/existing-manifest-mutations/existing-manifest-mutations.ts \
+ *       > examples/manifest/existing-manifest-mutations/manifest.updated.json
+ */
+
+import {
+  CustomObject,
+  CustomObjectFieldSection,
+  CustomObjectPageLayout,
+  type ExistingManifest,
+  ManifestBuilder,
+  SelectField,
+  TextField,
+} from '@rippling/rippling-sdk/lib/manifest';
+
+const existingManifestJson: ExistingManifest = {
+  metadata: {
+    key: 'gym_membership_management',
+    name: 'Gym Membership Management',
+    description: 'Small inline manifest used by the existing-manifest mutation example',
+  },
+  components: [
+    {
+      type: 'CUSTOM_CATEGORY',
+      api_name: 'gym__c',
+      name: 'Gym',
+      description: 'Memberships, staff, schedules, and attendance',
+    },
+    {
+      type: 'CUSTOM_OBJECT',
+      api_name: 'gym_member__c',
+      name: 'Member',
+      plural_label: 'Members',
+      category_api_name: 'gym__c',
+      description: 'Gym member profile, contact, and membership status',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD_SECTION',
+      section_id: 'sec_gm_profile',
+      model_name: 'gym_member__c',
+      name: 'Profile',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD_SECTION',
+      section_id: 'sec_gm_membership',
+      model_name: 'gym_member__c',
+      name: 'Membership',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD',
+      custom_object_api_name: 'gym_member__c',
+      field_api_name: 'first_name__c',
+      field_display_name: 'First name',
+      data_type: { field_type: 'TEXT', max_length: 80 },
+      is_required: true,
+      is_unique: false,
+      is_indexed: false,
+      is_standard: false,
+      section: 'sec_gm_profile',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD',
+      custom_object_api_name: 'gym_member__c',
+      field_api_name: 'last_name__c',
+      field_display_name: 'Last name',
+      data_type: { field_type: 'TEXT', max_length: 80 },
+      is_required: true,
+      is_unique: false,
+      is_indexed: false,
+      is_standard: false,
+      section: 'sec_gm_profile',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD',
+      custom_object_api_name: 'gym_member__c',
+      field_api_name: 'phone__c',
+      field_display_name: 'Phone',
+      data_type: { field_type: 'PHONE_NUMBER' },
+      is_required: false,
+      is_unique: false,
+      is_indexed: false,
+      is_standard: false,
+      section: 'sec_gm_profile',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD',
+      custom_object_api_name: 'gym_member__c',
+      field_api_name: 'membership_status__c',
+      field_display_name: 'Membership status',
+      data_type: { field_type: 'SELECT', options_list: ['Active', 'Frozen', 'Cancelled', 'Trial'] },
+      is_required: true,
+      is_unique: false,
+      is_indexed: false,
+      is_standard: false,
+      section: 'sec_gm_membership',
+    },
+    {
+      type: 'CUSTOM_OBJECT_FIELD',
+      custom_object_api_name: 'gym_member__c',
+      field_api_name: 'join_date__c',
+      field_display_name: 'Join date',
+      data_type: { field_type: 'DATE' },
+      is_required: false,
+      is_unique: false,
+      is_indexed: false,
+      is_standard: false,
+      section: 'sec_gm_membership',
+    },
+    {
+      type: 'CUSTOM_OBJECT_PAGE_LAYOUT',
+      layout_id: 'layout_gym_member',
+      api_name: 'default',
+      object_rql_name: 'gym_member__c',
+      name: 'Member',
+      system_created: false,
+      tab_edits: {
+        newTabs: [
+          {
+            key: 'member',
+            name: 'Member',
+            type: 'tab_with_sections',
+            sections: [
+              {
+                key: 'profile',
+                name: 'Profile',
+                type: 'fields_section',
+                fields: [
+                  { fieldRqlName: 'first_name__c' },
+                  { fieldRqlName: 'last_name__c' },
+                  { fieldRqlName: 'phone__c' },
+                ],
+              },
+              {
+                key: 'membership',
+                name: 'Membership',
+                type: 'fields_section',
+                fields: [{ fieldRqlName: 'membership_status__c' }, { fieldRqlName: 'join_date__c' }],
+              },
+            ],
+          },
+        ],
+        systemTabEdits: {},
+        tabsOrder: ['member'],
+      },
+      header_edits: {
+        newTitleField: 'first_name__c',
+        newDescriptionField: 'membership_status__c',
+      },
+      visibility_conditions: {},
+      blueprint_key: 'gym_member__c',
+    },
+  ],
+};
+
+const manifest = ManifestBuilder.loadFromExistingJson(existingManifestJson);
+const memberObj = CustomObject.loadFromExisting('gym_member__c');
+const profileSection = CustomObjectFieldSection.loadFromExisting('sec_gm_profile', {
+  customObjectApiName: memberObj.getApiName(),
+});
+const memberLayout = CustomObjectPageLayout.loadFromExisting('layout_gym_member', {
+  customObjectApiName: memberObj.getApiName(),
+});
+
+const preferredName = new TextField(memberObj, {
+  apiName: 'preferred_name__c',
+  displayName: 'Preferred name',
+  maxLength: 80,
+  section: profileSection,
+});
+
+// Remove an existing field from one section, then add a different field there.
+// The removed field component remains in the manifest; only this layout stops
+// rendering it.
+memberLayout
+  .removeField('phone__c', {
+    tabKey: 'member',
+    sectionKey: 'profile',
+    removeAll: false,
+  })
+  .addField(preferredName, {
+    tabKey: 'member',
+    sectionKey: 'profile',
+    fieldSection: profileSection,
+    position: 2,
+  });
+
+const marketingSection = new CustomObjectFieldSection(memberObj, {
+  sectionId: 'sec_gm_marketing',
+  name: 'Marketing',
+});
+const marketingOptIn = new SelectField(memberObj, {
+  apiName: 'marketing_opt_in__c',
+  displayName: 'Marketing opt-in',
+  options: ['Yes', 'No', 'Unknown'],
+  section: marketingSection,
+});
+const referralSource = new TextField(memberObj, {
+  apiName: 'referral_source__c',
+  displayName: 'Referral source',
+  maxLength: 120,
+  section: marketingSection,
+});
+
+// Remove one existing section from the layout, then add a different one.
+// The removed section component and its fields remain in the manifest.
+memberLayout
+  .removeSection('membership', {
+    tabKey: 'member',
+    removeAll: false,
+  })
+  .addSection(
+    {
+      key: 'marketing',
+      name: 'Marketing',
+      type: 'fields_section',
+      section: marketingSection,
+      fields: [marketingOptIn, referralSource],
+      layout: 'two_column',
+    },
+    {
+      tabKey: 'member',
+      position: 'end',
+    },
+  )
+  .addHeaderField(preferredName, {
+    key: 'preferred_name_header',
+    canBeDeleted: true,
+    canBeMoved: true,
+  })
+  .setTitleField(preferredName)
+  .removeDescriptionField();
+
+console.log(manifest.preview());

package/lib/manifest/app.d.mts

@@ -1,5 +1,6 @@
 import { CustomObject } from "./custom-object.mjs";
-import type { ManifestScope } from "./manifest-builder.mjs";
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.mjs";
+import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.mjs";
 import { SduiPage } from "./sdui-page.mjs";
 /**
  * A single page entry in an {@link App}.
@@ -83,6 +84,8 @@ export interface AppProps {
  * @see {@link SduiPage} — SDUI surface tab source.
  */
 export declare class App {
+    static readonly componentType: "CUSTOM_APP";
+    static toDeletionIdentifier(apiName: string): ManifestComponentDeletion;
     private readonly _apiName;
     private readonly _name;
     private readonly _description;
@@ -95,6 +98,13 @@ export declare class App {
      * @param props - Initialization properties.
      */
     constructor(scope: ManifestScope, props: AppProps);
+    /**
+     * Loads this app from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(apiName: string, options?: ExistingManifestContextOptions): App;
+    /** @internal Hydrates an app from existing manifest wire JSON. */
+    static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>): App;
+    private static appIconFromExistingComponent;
     /**
      * Returns the api_name of this app (e.g. `'gym_membership_management_app'`).
      */

package/lib/manifest/app.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"app.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/app.ts"],"names":[],"mappings":"OAAO,EAAE,YAAY,EAAE;OAChB,KAAK,EAAE,aAAa,EAAE;OACtB,EAAE,QAAQ,EAAE;AAEnB;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,YAAY,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;CACnB;AAoBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,GAAG;IACd,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAC5C,2DAA2D;IAC3D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;IAE/C;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ;IAUjD;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}
+{"version":3,"file":"app.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/app.ts"],"names":[],"mappings":"OAAO,EAAE,YAAY,EAAE;OAChB,EAA8B,KAAK,8BAA8B,EAAE;OACnE,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE;OACjD,EAAE,QAAQ,EAAE;AAEnB;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,YAAY,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;CACnB;AAyBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,GAAG;IACd,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,YAAY,CAAU;IAEtD,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,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAC5C,2DAA2D;IAC3D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;IAE/C;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ;IAUjD;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,GAAG;IAI3F,kEAAkE;IAClE,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG;IAcxF,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAO3C;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}

package/lib/manifest/app.d.ts

@@ -1,5 +1,6 @@
 import { CustomObject } from "./custom-object.js";
-import type { ManifestScope } from "./manifest-builder.js";
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.js";
+import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.js";
 import { SduiPage } from "./sdui-page.js";
 /**
  * A single page entry in an {@link App}.
@@ -83,6 +84,8 @@ export interface AppProps {
  * @see {@link SduiPage} — SDUI surface tab source.
  */
 export declare class App {
+    static readonly componentType: "CUSTOM_APP";
+    static toDeletionIdentifier(apiName: string): ManifestComponentDeletion;
     private readonly _apiName;
     private readonly _name;
     private readonly _description;
@@ -95,6 +98,13 @@ export declare class App {
      * @param props - Initialization properties.
      */
     constructor(scope: ManifestScope, props: AppProps);
+    /**
+     * Loads this app from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(apiName: string, options?: ExistingManifestContextOptions): App;
+    /** @internal Hydrates an app from existing manifest wire JSON. */
+    static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>): App;
+    private static appIconFromExistingComponent;
     /**
      * Returns the api_name of this app (e.g. `'gym_membership_management_app'`).
      */

package/lib/manifest/app.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/app.ts"],"names":[],"mappings":"OAAO,EAAE,YAAY,EAAE;OAChB,KAAK,EAAE,aAAa,EAAE;OACtB,EAAE,QAAQ,EAAE;AAEnB;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,YAAY,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;CACnB;AAoBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,GAAG;IACd,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAC5C,2DAA2D;IAC3D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;IAE/C;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ;IAUjD;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/app.ts"],"names":[],"mappings":"OAAO,EAAE,YAAY,EAAE;OAChB,EAA8B,KAAK,8BAA8B,EAAE;OACnE,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE;OACjD,EAAE,QAAQ,EAAE;AAEnB;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,YAAY,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;CACnB;AAyBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,GAAG;IACd,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,YAAY,CAAU;IAEtD,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,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAC5C,2DAA2D;IAC3D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;IAE/C;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ;IAUjD;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,GAAG;IAI3F,kEAAkE;IAClE,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG;IAcxF,OAAO,CAAC,MAAM,CAAC,4BAA4B;IAO3C;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}

package/lib/manifest/app.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.App = void 0;
 const custom_object_1 = require("./custom-object.js");
+const existing_manifest_context_1 = require("./existing-manifest-context.js");
 function resolvePage(entry) {
     if (entry instanceof custom_object_1.CustomObject) {
         const apiName = entry.getApiName();
@@ -20,6 +21,11 @@ function resolvePage(entry) {
         };
     }
 }
+function cloneJson(value) {
+    if (value == null)
+        return value;
+    return JSON.parse(JSON.stringify(value));
+}
 /**
  * Defines a Rippling app and registers it with the manifest.
  *
@@ -43,6 +49,12 @@ function resolvePage(entry) {
  * @see {@link SduiPage} — SDUI surface tab source.
  */
 class App {
+    static toDeletionIdentifier(apiName) {
+        return {
+            type: App.componentType,
+            api_name: apiName,
+        };
+    }
     /**
      * @param scope - The manifest to register this app with.
      * @param props - Initialization properties.
@@ -56,6 +68,34 @@ class App {
         this._pages = (props.pages ?? []).map(resolvePage);
         scope._register(this);
     }
+    /**
+     * Loads this app from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(apiName, options = {}) {
+        return (0, existing_manifest_context_1.getExistingManifestContext)(options).loadApp(apiName);
+    }
+    /** @internal Hydrates an app from existing manifest wire JSON. */
+    static _fromExistingComponent(scope, component) {
+        const app = Object.create(App.prototype);
+        Object.assign(app, {
+            _apiName: component['api_name'],
+            _name: component['name'] ?? component['api_name'],
+            _description: component['description'],
+            _appType: component['app_type'],
+            _icon: App.appIconFromExistingComponent(component['icon']),
+            _pages: cloneJson(component['pages'] ?? []),
+        });
+        scope._register(app);
+        return app;
+    }
+    static appIconFromExistingComponent(value) {
+        if (value == null || typeof value !== 'object')
+            return undefined;
+        const wire = value;
+        if (typeof wire['s3_bucket'] !== 'string' || typeof wire['s3_key'] !== 'string')
+            return undefined;
+        return { s3Bucket: wire['s3_bucket'], s3Key: wire['s3_key'] };
+    }
     /**
      * Returns the api_name of this app (e.g. `'gym_membership_management_app'`).
      */
@@ -75,7 +115,7 @@ class App {
      */
     toDict() {
         const component = {
-            type: 'CUSTOM_APP',
+            type: App.componentType,
             api_name: this._apiName,
             name: this._name,
         };
@@ -92,4 +132,5 @@ class App {
     }
 }
 exports.App = App;
+App.componentType = 'CUSTOM_APP';
 //# sourceMappingURL=app.js.map

package/lib/manifest/app.js.map

@@ -1 +1 @@
-{"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/lib/manifest/app.ts"],"names":[],"mappings":";;;AAAA,sDAA+C;AAkE/C,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,KAAK,YAAY,4BAAY,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QACnC,OAAO;YACL,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,aAAa;YACxB,eAAe,EAAE,OAAO;SACzB,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,MAAM,UAAU,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;QACzC,OAAO;YACL,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,GAAG;IASd;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAAe;QAC/C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACnD,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5E,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACvB,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnF,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACpF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAxDD,kBAwDC"}
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/lib/manifest/app.ts"],"names":[],"mappings":";;;AAAA,sDAA+C;AAC/C,8EAA8G;AAkE9G,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,KAAK,YAAY,4BAAY,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QACnC,OAAO;YACL,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,aAAa;YACxB,eAAe,EAAE,OAAO;SACzB,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,MAAM,UAAU,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;QACzC,OAAO;YACL,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAI,KAAQ;IAC5B,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAM,CAAC;AAChD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,GAAG;IAGd,MAAM,CAAC,oBAAoB,CAAC,OAAe;QACzC,OAAO;YACL,IAAI,EAAE,GAAG,CAAC,aAAa;YACvB,QAAQ,EAAE,OAAO;SAClB,CAAC;IACJ,CAAC;IAUD;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAAe;QAC/C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACnD,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,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED,kEAAkE;IAClE,MAAM,CAAC,sBAAsB,CAAC,KAAoB,EAAE,SAA8B;QAChF,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAQ,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,GAA0B,EAAE;YACxC,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC;YAC/B,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC;YACjD,YAAY,EAAE,SAAS,CAAC,aAAa,CAAC;YACtC,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC;YAC/B,KAAK,EAAE,GAAG,CAAC,4BAA4B,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC1D,MAAM,EAAE,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;SAC5C,CAAC,CAAC;QACH,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACrB,OAAO,GAAG,CAAC;IACb,CAAC;IAEO,MAAM,CAAC,4BAA4B,CAAC,KAAc;QACxD,IAAI,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QACjE,MAAM,IAAI,GAAG,KAA4B,CAAC;QAC1C,IAAI,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QAClG,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,GAAG,CAAC,aAAa;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5E,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACvB,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnF,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACpF,OAAO,SAAS,CAAC;IACnB,CAAC;;AA7FH,kBA8FC;AA7FiB,iBAAa,GAAG,YAAqB,CAAC"}

package/lib/manifest/app.mjs

@@ -1,4 +1,5 @@
 import { CustomObject } from "./custom-object.mjs";
+import { getExistingManifestContext } from "./existing-manifest-context.mjs";
 function resolvePage(entry) {
     if (entry instanceof CustomObject) {
         const apiName = entry.getApiName();
@@ -17,6 +18,11 @@ function resolvePage(entry) {
         };
     }
 }
+function cloneJson(value) {
+    if (value == null)
+        return value;
+    return JSON.parse(JSON.stringify(value));
+}
 /**
  * Defines a Rippling app and registers it with the manifest.
  *
@@ -40,6 +46,12 @@ function resolvePage(entry) {
  * @see {@link SduiPage} — SDUI surface tab source.
  */
 export class App {
+    static toDeletionIdentifier(apiName) {
+        return {
+            type: App.componentType,
+            api_name: apiName,
+        };
+    }
     /**
      * @param scope - The manifest to register this app with.
      * @param props - Initialization properties.
@@ -53,6 +65,34 @@ export class App {
         this._pages = (props.pages ?? []).map(resolvePage);
         scope._register(this);
     }
+    /**
+     * Loads this app from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(apiName, options = {}) {
+        return getExistingManifestContext(options).loadApp(apiName);
+    }
+    /** @internal Hydrates an app from existing manifest wire JSON. */
+    static _fromExistingComponent(scope, component) {
+        const app = Object.create(App.prototype);
+        Object.assign(app, {
+            _apiName: component['api_name'],
+            _name: component['name'] ?? component['api_name'],
+            _description: component['description'],
+            _appType: component['app_type'],
+            _icon: App.appIconFromExistingComponent(component['icon']),
+            _pages: cloneJson(component['pages'] ?? []),
+        });
+        scope._register(app);
+        return app;
+    }
+    static appIconFromExistingComponent(value) {
+        if (value == null || typeof value !== 'object')
+            return undefined;
+        const wire = value;
+        if (typeof wire['s3_bucket'] !== 'string' || typeof wire['s3_key'] !== 'string')
+            return undefined;
+        return { s3Bucket: wire['s3_bucket'], s3Key: wire['s3_key'] };
+    }
     /**
      * Returns the api_name of this app (e.g. `'gym_membership_management_app'`).
      */
@@ -72,7 +112,7 @@ export class App {
      */
     toDict() {
         const component = {
-            type: 'CUSTOM_APP',
+            type: App.componentType,
             api_name: this._apiName,
             name: this._name,
         };
@@ -88,4 +128,5 @@ export class App {
         return component;
     }
 }
+App.componentType = 'CUSTOM_APP';
 //# sourceMappingURL=app.mjs.map

package/lib/manifest/app.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"app.mjs","sourceRoot":"","sources":["../../src/lib/manifest/app.ts"],"names":[],"mappings":"OAAO,EAAE,YAAY,EAAE;AAkEvB,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QACnC,OAAO;YACL,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,aAAa;YACxB,eAAe,EAAE,OAAO;SACzB,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,MAAM,UAAU,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;QACzC,OAAO;YACL,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,GAAG;IASd;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAAe;QAC/C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACnD,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5E,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACvB,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnF,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACpF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}
+{"version":3,"file":"app.mjs","sourceRoot":"","sources":["../../src/lib/manifest/app.ts"],"names":[],"mappings":"OAAO,EAAE,YAAY,EAAE;OAChB,EAAE,0BAA0B,EAAuC;AAkE1E,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QACnC,OAAO;YACL,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,aAAa;YACxB,eAAe,EAAE,OAAO;SACzB,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,MAAM,UAAU,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;QACzC,OAAO;YACL,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAI,KAAQ;IAC5B,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAM,CAAC;AAChD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,GAAG;IAGd,MAAM,CAAC,oBAAoB,CAAC,OAAe;QACzC,OAAO;YACL,IAAI,EAAE,GAAG,CAAC,aAAa;YACvB,QAAQ,EAAE,OAAO;SAClB,CAAC;IACJ,CAAC;IAUD;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAAe;QAC/C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACnD,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,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED,kEAAkE;IAClE,MAAM,CAAC,sBAAsB,CAAC,KAAoB,EAAE,SAA8B;QAChF,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAQ,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,GAA0B,EAAE;YACxC,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC;YAC/B,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC;YACjD,YAAY,EAAE,SAAS,CAAC,aAAa,CAAC;YACtC,QAAQ,EAAE,SAAS,CAAC,UAAU,CAAC;YAC/B,KAAK,EAAE,GAAG,CAAC,4BAA4B,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;YAC1D,MAAM,EAAE,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;SAC5C,CAAC,CAAC;QACH,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACrB,OAAO,GAAG,CAAC;IACb,CAAC;IAEO,MAAM,CAAC,4BAA4B,CAAC,KAAc;QACxD,IAAI,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QACjE,MAAM,IAAI,GAAG,KAA4B,CAAC;QAC1C,IAAI,OAAO,IAAI,CAAC,WAAW,CAAC,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;QAClG,OAAO,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,GAAG,CAAC,aAAa;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5E,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACvB,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnF,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACpF,OAAO,SAAS,CAAC;IACnB,CAAC;;AA5Fe,iBAAa,GAAG,YAAqB,CAAC"}

package/lib/manifest/category.d.mts

@@ -1,4 +1,5 @@
-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 Category}.
  */
@@ -55,6 +56,8 @@ export interface CategoryProps {
  * @see {@link CustomObject} — references this category via instance or api_name string.
  */
 export declare class Category {
+    static readonly componentType: "CUSTOM_CATEGORY";
+    static toDeletionIdentifier(apiName: string): ManifestComponentDeletion;
     private readonly _apiName;
     private readonly _name;
     private readonly _description;
@@ -63,6 +66,12 @@ export declare class Category {
      * @param props - Initialization properties.
      */
     constructor(scope: ManifestScope, props: CategoryProps);
+    /**
+     * Loads this category from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(apiName: string, options?: ExistingManifestContextOptions): Category;
+    /** @internal Hydrates a category from existing manifest wire JSON. */
+    static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>): Category;
     /**
      * Returns the api_name of this category (e.g. `'gym__c'`).
      */

package/lib/manifest/category.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"category.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,aAAa,EAAE;AAE7B;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IAEtC;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAOtD;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}
+{"version":3,"file":"category.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":"OAAO,EAA8B,KAAK,8BAA8B,EAAE;OACnE,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE;AAExD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,QAAQ;IACnB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,iBAAiB,CAAU;IAE3D,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,YAAY,CAAS;IAEtC;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAOtD;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,QAAQ;IAIhG,sEAAsE;IACtE,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,QAAQ;IAQ7F;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}

package/lib/manifest/category.d.ts

@@ -1,4 +1,5 @@
-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 Category}.
  */
@@ -55,6 +56,8 @@ export interface CategoryProps {
  * @see {@link CustomObject} — references this category via instance or api_name string.
  */
 export declare class Category {
+    static readonly componentType: "CUSTOM_CATEGORY";
+    static toDeletionIdentifier(apiName: string): ManifestComponentDeletion;
     private readonly _apiName;
     private readonly _name;
     private readonly _description;
@@ -63,6 +66,12 @@ export declare class Category {
      * @param props - Initialization properties.
      */
     constructor(scope: ManifestScope, props: CategoryProps);
+    /**
+     * Loads this category from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(apiName: string, options?: ExistingManifestContextOptions): Category;
+    /** @internal Hydrates a category from existing manifest wire JSON. */
+    static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>): Category;
     /**
      * Returns the api_name of this category (e.g. `'gym__c'`).
      */

package/lib/manifest/category.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"category.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,aAAa,EAAE;AAE7B;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IAEtC;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAOtD;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}
+{"version":3,"file":"category.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":"OAAO,EAA8B,KAAK,8BAA8B,EAAE;OACnE,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE;AAExD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,QAAQ;IACnB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,iBAAiB,CAAU;IAE3D,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,YAAY,CAAS;IAEtC;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAOtD;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,QAAQ;IAIhG,sEAAsE;IACtE,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,QAAQ;IAQ7F;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}

package/lib/manifest/category.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Category = void 0;
+const existing_manifest_context_1 = require("./existing-manifest-context.js");
 /**
  * Defines a category and registers it with the manifest.
  *
@@ -32,6 +33,12 @@ exports.Category = void 0;
  * @see {@link CustomObject} — references this category via instance or api_name string.
  */
 class Category {
+    static toDeletionIdentifier(apiName) {
+        return {
+            type: Category.componentType,
+            api_name: apiName,
+        };
+    }
     /**
      * @param scope - The manifest to register this category with.
      * @param props - Initialization properties.
@@ -42,6 +49,20 @@ class Category {
         this._description = props.description;
         scope._register(this);
     }
+    /**
+     * Loads this category from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(apiName, options = {}) {
+        return (0, existing_manifest_context_1.getExistingManifestContext)(options).loadCategory(apiName);
+    }
+    /** @internal Hydrates a category from existing manifest wire JSON. */
+    static _fromExistingComponent(scope, component) {
+        return new Category(scope, {
+            apiName: component['api_name'],
+            name: component['name'] ?? component['api_name'],
+            description: component['description'] ?? '',
+        });
+    }
     /**
      * Returns the api_name of this category (e.g. `'gym__c'`).
      */
@@ -61,7 +82,7 @@ class Category {
      */
     toDict() {
         return {
-            type: 'CUSTOM_CATEGORY',
+            type: Category.componentType,
             api_name: this._apiName,
             name: this._name,
             description: this._description,
@@ -69,4 +90,5 @@ class Category {
     }
 }
 exports.Category = Category;
+Category.componentType = 'CUSTOM_CATEGORY';
 //# sourceMappingURL=category.js.map

package/lib/manifest/category.js.map

@@ -1 +1 @@
-{"version":3,"file":"category.js","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":";;;AA4BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAa,QAAQ;IAKnB;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,iBAAiB;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,WAAW,EAAE,IAAI,CAAC,YAAY;SAC/B,CAAC;IACJ,CAAC;CACF;AA3CD,4BA2CC"}
+{"version":3,"file":"category.js","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":";;;AAAA,8EAA8G;AA6B9G;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAa,QAAQ;IAGnB,MAAM,CAAC,oBAAoB,CAAC,OAAe;QACzC,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,QAAQ,EAAE,OAAO;SAClB,CAAC;IACJ,CAAC;IAMD;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,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,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE;YACzB,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC;YAC9B,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC;YAChD,WAAW,EAAE,SAAS,CAAC,aAAa,CAAC,IAAI,EAAE;SAC5C,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,WAAW,EAAE,IAAI,CAAC,YAAY;SAC/B,CAAC;IACJ,CAAC;;AAnEH,4BAoEC;AAnEiB,sBAAa,GAAG,iBAA0B,CAAC"}