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

package/src/lib/manifest/sdui-page.ts

@@ -1,5 +1,6 @@
+import { getExistingManifestContext, type ExistingManifestContextOptions } from './existing-manifest-context';
 import type { ManifestFunction } from './manifest-function';
-import type { ManifestScope } from './manifest-builder';
+import type { ManifestComponentDeletion, ManifestScope } from './manifest-builder';
 
 /**
  * Initialization properties for {@link SduiPage}.
@@ -59,6 +60,15 @@ export interface SduiPageProps {
  * @see {@link App} — hosts this page as a tab via `pages`.
  */
 export class SduiPage {
+  static readonly componentType = 'SDUI_PAGE' as const;
+
+  static toDeletionIdentifier(sduiPageId: string): ManifestComponentDeletion {
+    return {
+      type: SduiPage.componentType,
+      sdui_page_id: sduiPageId,
+    };
+  }
+
   private readonly _sduiPageId: string;
   private readonly _name: string;
   private readonly _functionApiName: string;
@@ -80,6 +90,31 @@ export class SduiPage {
     scope._register(this);
   }
 
+  /**
+   * Loads this SDUI page from the active existing-manifest JSON context.
+   */
+  static loadFromExisting(sduiPageId: string, options: ExistingManifestContextOptions = {}): SduiPage {
+    return getExistingManifestContext(options).loadSduiPage(sduiPageId);
+  }
+
+  /** @internal Hydrates an SDUI page from existing manifest wire JSON. */
+  static _fromExistingComponent(
+    scope: ManifestScope,
+    component: Record<string, any>,
+    resolveFunction: (apiName: string) => ManifestFunction | string,
+  ): SduiPage {
+    const functionApiName = component['function_api_name'];
+    const props: SduiPageProps = {
+      sduiPageId: component['sdui_page_id'],
+      name: component['name'] ?? component['sdui_page_id'],
+      function: typeof functionApiName === 'string' ? resolveFunction(functionApiName) : functionApiName,
+    };
+    if (component['description'] !== undefined) {
+      props.description = component['description'];
+    }
+    return new SduiPage(scope, props);
+  }
+
   /**
    * Returns the unique page identifier (e.g. `'gym_today_schedule'`).
    */
@@ -108,7 +143,7 @@ export class SduiPage {
    */
   toDict(): Record<string, any> {
     return {
-      type: 'SDUI_PAGE',
+      type: SduiPage.componentType,
       name: this._name,
       sdui_page_id: this._sduiPageId,
       function_api_name: this._functionApiName,

package/src/lib/manifest/validation.ts

@@ -1,6 +1,13 @@
 import { generateId, type ValidationLevel, type ValidationState } from './_helpers';
 import type { CustomObject } from './custom-object';
+import { getExistingManifestContext, type ExistingManifestContextOptions } from './existing-manifest-context';
 import type { Field } from './field';
+import type { ManifestComponentDeletion } from './manifest-builder';
+
+export interface ValidationDeletionIdentifier {
+  ruleId: string;
+  modelRqlName: string;
+}
 
 /**
  * Initialization properties for {@link Validation}.
@@ -59,6 +66,10 @@ export interface ValidationProps {
   fieldRef?: Field;
 }
 
+export interface ValidationLoadFromExistingOptions extends ExistingManifestContextOptions {
+  customObjectApiName?: string;
+}
+
 /**
  * Defines a validation rule and registers it with the manifest.
  *
@@ -85,6 +96,16 @@ export interface ValidationProps {
  * ```
  */
 export class Validation {
+  static readonly componentType = 'CUSTOM_OBJECT_VALIDATION_RULE' as const;
+
+  static toDeletionIdentifier(identifier: ValidationDeletionIdentifier): ManifestComponentDeletion {
+    return {
+      type: Validation.componentType,
+      rule_id: identifier.ruleId,
+      model_rql_name: identifier.modelRqlName,
+    };
+  }
+
   private readonly _ruleId: string;
   private readonly _customObjectApiName: string;
   private readonly _displayName: string;
@@ -112,6 +133,32 @@ export class Validation {
     customObject._register(this);
   }
 
+  /**
+   * Loads this validation rule from the active existing-manifest JSON context.
+   */
+  static loadFromExisting(ruleId: string, options: ValidationLoadFromExistingOptions = {}): Validation {
+    return getExistingManifestContext(options).loadValidation(ruleId, options);
+  }
+
+  /** @internal Hydrates a validation rule from existing manifest wire JSON. */
+  static _fromExistingComponent(
+    customObject: CustomObject,
+    component: Record<string, any>,
+    resolveField: (apiName: string) => Field,
+  ): Validation {
+    const props: ValidationProps = {
+      ruleId: component['rule_id'],
+      displayName: component['display_name'] ?? component['rule_id'],
+      rqlFormula: component['rql_formula'] ?? '',
+      errorMessage: component['custom_error_message'] ?? '',
+      state: component['state'],
+      level: component['level'],
+      ruleDescription: component['rule_description'] ?? '',
+    };
+    if (component['field_rql_name'] != null) props.fieldRef = resolveField(component['field_rql_name']);
+    return new Validation(customObject, props);
+  }
+
   /**
    * Returns the stable identifier for this validation rule (e.g. `'gym_session_end_after_start'`).
    */
@@ -134,7 +181,7 @@ export class Validation {
    */
   toDict(): Record<string, any> {
     const component: Record<string, any> = {
-      type: 'CUSTOM_OBJECT_VALIDATION_RULE',
+      type: Validation.componentType,
       model_rql_name: this._customObjectApiName,
       rule_id: this._ruleId,
       state: this._state,

package/src/version.ts

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

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.2.0-alpha.38";
+export declare const VERSION = "0.2.0-alpha.39";
 //# 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.38'; // x-release-please-version
+exports.VERSION = '0.2.0-alpha.39'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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