@rippling/rippling-sdk 0.2.0-alpha.44 → 0.2.0-alpha.46

package/src/lib/manifest/app.ts

@@ -58,9 +58,9 @@ export interface AppProps {
   /**
    * SDUI pages shown as tabs in the app. Tab order matches the array order.
    *
-   * Optional. @default `[]`
+   * Required. Must include at least one page.
    */
-  pages?: AppPage[];
+  pages: AppPage[];
 }
 
 function resolvePage(entry: AppPage): Record<string, any> {
@@ -77,6 +77,20 @@ function resolvePage(entry: AppPage): Record<string, any> {
   };
 }
 
+function resolvePages(pages: AppPage[] | undefined): Record<string, any>[] {
+  if (pages == null || pages.length === 0) {
+    throw new Error('App pages must include at least one page.');
+  }
+  return pages.map(resolvePage);
+}
+
+function clonePages(value: unknown): Record<string, any>[] {
+  if (!Array.isArray(value) || value.length === 0) {
+    throw new Error('App pages must include at least one page.');
+  }
+  return cloneJson(value) as Record<string, any>[];
+}
+
 function cloneJson<T>(value: T): T {
   if (value == null) return value;
   return JSON.parse(JSON.stringify(value)) as T;
@@ -130,7 +144,7 @@ export class App {
     this._description = props.description;
     this._appType = props.appType;
     this._icon = props.icon;
-    this._pages = (props.pages ?? []).map(resolvePage);
+    this._pages = resolvePages(props.pages);
     scope._register(this);
   }
 
@@ -150,7 +164,7 @@ export class App {
       _description: component['description'],
       _appType: component['app_type'],
       _icon: App.appIconFromExistingComponent(component['icon']),
-      _pages: cloneJson(component['pages'] ?? []),
+      _pages: clonePages(component['pages']),
     });
     scope._register(app);
     return app;
@@ -193,7 +207,7 @@ export class App {
       component['icon'] = { s3_bucket: this._icon.s3Bucket, s3_key: this._icon.s3Key };
     }
     if (this._appType != null) component['app_type'] = this._appType;
-    if (this._pages.length > 0) component['pages'] = this._pages.map((p) => ({ ...p }));
+    component['pages'] = this._pages.map((p) => ({ ...p }));
     return component;
   }
 }

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

@@ -32,8 +32,8 @@ export interface CustomObjectFieldSectionProps {
  * Defines a field section and registers it with the manifest.
  *
  * A field section is a named group of fields displayed together on a custom
- * object's detail page. After creating a section, pass it as the `section`
- * prop on any field that should belong to it.
+ * object's detail page. Every custom field must receive one of these sections
+ * through its `section` prop.
  *
  * @example
  * ```ts