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

package/src/lib/manifest/custom-object.ts

@@ -1,5 +1,6 @@
 import { Category } from './category';
-import type { ManifestComponent, ManifestScope } from './manifest-builder';
+import { getExistingManifestContext, type ExistingManifestContextOptions } from './existing-manifest-context';
+import type { ManifestComponent, ManifestComponentDeletion, ManifestScope } from './manifest-builder';
 
 // ────────────────────────────────────────────────────────────────────────
 // Platform-managed standard fields — mirrors
@@ -113,6 +114,8 @@ const STANDARD_FIELD_SPECS: ReadonlyArray<{
  * (`id`, `created_at`, …) don't carry the custom-field suffix.
  */
 class _StandardField implements ManifestComponent {
+  static readonly componentType = 'CUSTOM_OBJECT_FIELD' as const;
+
   constructor(
     private readonly customObjectApiName: string,
     private readonly spec: (typeof STANDARD_FIELD_SPECS)[number],
@@ -120,7 +123,7 @@ class _StandardField implements ManifestComponent {
 
   toDict(): Record<string, any> {
     return {
-      type: 'CUSTOM_OBJECT_FIELD',
+      type: _StandardField.componentType,
       custom_object_api_name: this.customObjectApiName,
       field_api_name: this.spec.apiName,
       field_display_name: this.spec.displayName,
@@ -297,6 +300,15 @@ export interface CustomObjectProps {
  * can fragment ownership and complicate the permission story.
  */
 export class CustomObject implements ManifestScope {
+  static readonly componentType = 'CUSTOM_OBJECT' as const;
+
+  static toDeletionIdentifier(apiName: string): ManifestComponentDeletion {
+    return {
+      type: CustomObject.componentType,
+      api_name: apiName,
+    };
+  }
+
   private readonly _scope: ManifestScope;
   private readonly _apiName: string;
   private readonly _name: string;
@@ -333,6 +345,49 @@ export class CustomObject implements ManifestScope {
     }
   }
 
+  /**
+   * Loads this custom object from the active existing-manifest JSON context.
+   */
+  static loadFromExisting(apiName: string, options: ExistingManifestContextOptions = {}): CustomObject {
+    return getExistingManifestContext(options).loadCustomObject(apiName);
+  }
+
+  /** @internal Hydrates a custom object from existing manifest wire JSON. */
+  static _fromExistingComponent(
+    scope: ManifestScope,
+    component: Record<string, any>,
+    resolveCategory: (apiName: string) => Category | string,
+  ): CustomObject {
+    const categoryApiName = component['category_api_name'];
+    const props: CustomObjectProps = {
+      apiName: component['api_name'],
+      name: component['name'] ?? component['api_name'],
+      category: typeof categoryApiName === 'string' ? resolveCategory(categoryApiName) : categoryApiName,
+    };
+    if (component['description'] !== undefined) props.description = component['description'];
+    if (component['plural_label'] !== undefined) props.pluralLabel = component['plural_label'];
+    if (component['name_field_details'] !== undefined) {
+      props.nameFieldDetails = component['name_field_details'];
+    }
+    if (component['default_field_section_name'] !== undefined) {
+      props.defaultFieldSectionName = component['default_field_section_name'];
+    }
+    const icon = CustomObject.iconFromExistingComponent(component['icon']);
+    if (icon != null) props.icon = icon;
+    return new CustomObject(scope, props);
+  }
+
+  private static iconFromExistingComponent(value: unknown): IconConfig | undefined {
+    if (value == null || typeof value !== 'object') return undefined;
+    const wire = value as Record<string, any>;
+    const icon: IconConfig = {};
+    if (wire['emoji'] !== undefined) icon.emoji = wire['emoji'];
+    if (wire['rippling_icon'] !== undefined) icon.ripplingIcon = wire['rippling_icon'];
+    if (wire['s3_bucket'] !== undefined) icon.s3Bucket = wire['s3_bucket'];
+    if (wire['s3_key'] !== undefined) icon.s3Key = wire['s3_key'];
+    return Object.keys(icon).length > 0 ? icon : undefined;
+  }
+
   /** @internal Scope hook — forwards child registration up to the root builder. */
   _register(component: ManifestComponent): void {
     this._scope._register(component);
@@ -362,7 +417,7 @@ export class CustomObject implements ManifestScope {
    */
   toDict(): Record<string, any> {
     const component: Record<string, any> = {
-      type: 'CUSTOM_OBJECT',
+      type: CustomObject.componentType,
       api_name: this._apiName,
       name: this._name,
       description: this._description ?? null,