@esri/hub-web-components 0.2.2 → 0.4.0

package/dist/components/arcgis-text-card/customElement.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="../../index.d.ts" />
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
-import { IConfigurableNode, ILayoutNodeConfig } from '../layouts/types';
+import { IConfigurableLayoutNode, ILayoutNodeConfig } from '../layouts/types';
 
 /**
  * A text card that can be added to an ILayout or leveraged
@@ -9,26 +9,12 @@ import { IConfigurableNode, ILayoutNodeConfig } from '../layouts/types';
  */
 export declare class ArcgisTextCard extends LitElement {
     /**
-     * Whether the text card can be moved or not.
-     * This readonly property is consumed by the
-     * arcgis-layout-node-controls to determine
-     * which layout controls to enable/disable.
-     * TODO: make permissions-based?
-     *
-     * @default false
-     */
-    get canMove(): boolean;
-    /**
-     * Whether the text card can be edited or not.
-     * This readonly property is consumed by the
-     * arcgis-layout-node-controls to determine
-     * which layout controls to enable/disable.
-     * TODO: make permissions-based?
-     *
-     * @default false
+     * The text card is a configurable node in the
+     * layout system. The following read-only property
+     * provides configuration information to the
+     * layout editor.
      */
-    get canEdit(): boolean;
-    get nodeConfig(): ILayoutNodeConfig;
+    get layoutNodeConfig(): ILayoutNodeConfig;
     /**
      * The HTML content to display - this will be
      * sanitized before rendering.

package/dist/components/arcgis-text-card/customElement.js

@@ -4,17 +4,17 @@ import { LitElement as s } from "@arcgis/lumina";
 import { css as o } from "@lit/reactive-element/css-tag.js";
 import { sanitizeHtml as r } from "@esri/hub-components";
 import { getProp as t } from "@esri/hub-common";
-import { u as n } from "../../chunks/useT9n.js";
+import { u as a } from "../../chunks/useT9n.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
-See https://js.arcgis.com/0.2/esri/copyright.txt for details.
-v0.2.2 */
+See https://js.arcgis.com/0.4/esri/copyright.txt for details.
+v0.4.0 */
 const d = o`:host>div>h1:first-child,:host>div>h2:first-child,:host>div>h3:first-child,:host>div>h4:first-child,:host>div>h5:first-child,:host>div>h6:first-child,:host>div>p:first-child{margin-top:0}`;
 class h extends s {
   constructor() {
-    super(...arguments), this._messages = n(), this.html = "";
+    super(...arguments), this._messages = a(), this.html = "";
   }
   static {
-    this.properties = { canMove: 32, canEdit: 32, nodeConfig: 32, html: 1 };
+    this.properties = { layoutNodeConfig: 32, html: 1 };
   }
   static {
     this.styles = d;
@@ -22,22 +22,20 @@ class h extends s {
   get _content() {
     return r(this.html);
   }
-  get canMove() {
-    return !0;
-  }
-  get canEdit() {
-    return !0;
-  }
-  get nodeConfig() {
+  get layoutNodeConfig() {
     return {
       tag: "arcgis-text-card",
+      // TODO: make permissions-based?
+      canEdit: !0,
+      // TODO: make permissions-based?
+      canMove: !0,
       i18n: {
-        label: t(this._messages, "nodeConfig.label"),
-        description: t(this._messages, "nodeConfig.description"),
-        editLabel: t(this._messages, "nodeConfig.edit"),
-        deleteLabel: t(this._messages, "nodeConfig.delete"),
-        repositionUpLabel: t(this._messages, "nodeConfig.up"),
-        repositionDownLabel: t(this._messages, "nodeConfig.down")
+        label: t(this._messages, "layoutNodeConfig.label"),
+        description: t(this._messages, "layoutNodeConfig.description"),
+        editLabel: t(this._messages, "layoutNodeConfig.edit"),
+        deleteLabel: t(this._messages, "layoutNodeConfig.delete"),
+        repositionUpLabel: t(this._messages, "layoutNodeConfig.up"),
+        repositionDownLabel: t(this._messages, "layoutNodeConfig.down")
       },
       valuesProp: "html",
       defaults: {},

package/dist/components/arcgis-text-card/utils/migrateTextCard.d.ts

@@ -0,0 +1,36 @@
+import { MigratableSchemaTransformMap } from '@esri/hub-components';
+import { ILayoutNode } from '../../layouts/types';
+/**
+ * This file defines the schema and migration logic for the
+ * Text Card component. As new schema versions are introduced,
+ * update the transform map and migration functions accordingly.
+ *
+ * NOTE: for now, we only have one schema version (V1), and this
+ * file mainly serves as a template for future migrations.
+ */
+/** A union type of all supported text card schemas */
+export type TextCardSchema = ITextCardSchemaV1;
+/** The latest supported text card schema  */
+export type CurrentTextCardSchema = ITextCardSchemaV1;
+/** The V1 schema for text cards */
+export interface ITextCardSchemaV1 extends Omit<ILayoutNode, "id" | "tag"> {
+    tag?: "arcgis-text-card";
+    properties?: {
+        html?: string;
+    };
+}
+/**
+ * An interface representing a map of supported text
+ * card schema migrations where the key is the schema
+ * version and the value is a transform fn
+ */
+export interface TextCardSchemaTransformMap extends MigratableSchemaTransformMap {
+}
+export declare const textCardTransformMap: TextCardSchemaTransformMap;
+/**
+ * Applies migrations to TextCardSchema objects, ensuring we're
+ * working with the latest supported schema version.
+ * @param schema An TextCardSchema object
+ * @returns a migrated TextCardSchema conforming to latest schema version
+ */
+export declare function migrateTextCard(schema: TextCardSchema): CurrentTextCardSchema;

package/dist/components/layouts/components/layout-node/customElement.js

@@ -1,59 +1,56 @@
-import { html as c } from "lit-html";
-import { safeStyleMap as $, deferLoad as u } from "@arcgis/lumina";
-import { spread as i, spreadProps as o } from "@open-wc/lit-helpers";
-import { getProp as h } from "@esri/hub-common";
+import { html as r } from "lit-html";
+import { safeStyleMap as c, deferLoad as s } from "@arcgis/lumina";
+import { spread as $, spreadProps as i } from "@open-wc/lit-helpers";
+import { getProp as y } from "@esri/hub-common";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
-See https://js.arcgis.com/0.2/esri/copyright.txt for details.
-v0.2.2 */
-function x({ tagName: g, props: s, classes: n, styles: a, children: e, options: l }) {
-  const d = s.onKeyDown, b = s.onMouseLeave, m = s.onMouseEnter, y = h(s, "node.id"), t = {
-    ...s,
-    tabIndex: l.isEditMode ? 0 : void 0
-  }, r = {
-    class: n,
-    "data-node-id": y,
-    label: s.label,
+See https://js.arcgis.com/0.4/esri/copyright.txt for details.
+v0.4.0 */
+function x({ tagName: n, props: u, classes: g, styles: a, children: o, options: d }) {
+  const l = u.onKeyDown, b = u.onMouseLeave, m = u.onMouseEnter, v = y(u, "node.id"), e = {
+    ...u,
+    tabIndex: d.isEditMode ? 0 : void 0
+  }, t = {
+    class: g,
+    "data-node-id": v,
+    label: u.label,
     // label must be an attribute
-    "@keydown": d,
+    "@keydown": l,
     "@mouseleave": b,
     "@mouseenter": m
   };
-  switch (g) {
+  switch (n) {
     case "arcgis-layout-row":
-      return c`<arcgis-layout-row style=${$(a)} ${i(r)} ${o(t)}>${e}</arcgis-layout-row>`;
+      return r`<arcgis-layout-row style=${c(a)} ${$(t)} ${i(e)}>${o}</arcgis-layout-row>`;
     case "calcite-button":
-      return c`<calcite-button style=${$(a)} ${i(r)} ${o(t)}>${e}</calcite-button>`;
+      return r`<calcite-button style=${c(a)} ${$(t)} ${i(e)}>${o}</calcite-button>`;
     case "calcite-chip":
-      return c`<calcite-chip .label=${s.label} style=${$(a)} ${i(r)} ${o(t)}>${e}</calcite-chip>`;
+      return r`<calcite-chip .label=${u.label} style=${c(a)} ${$(t)} ${i(e)}>${o}</calcite-chip>`;
     case "calcite-avatar":
-      return c`<calcite-avatar style=${$(a)} ${i(r)} ${o(t)}>${e}</calcite-avatar>`;
+      return r`<calcite-avatar style=${c(a)} ${$(t)} ${i(e)}>${o}</calcite-avatar>`;
     case "arcgis-text-card":
-      return c`<arcgis-text-card style=${$(a)} ${u} ${i(r)} ${o(t)}>${e}</arcgis-text-card>`;
+      return r`<arcgis-text-card style=${c(a)} ${s} ${$(t)} ${i(e)}>${o}</arcgis-text-card>`;
     case "arcgis-hub-gallery-card":
-      return c`<arcgis-hub-gallery-card style=${$(a)} ${u} ${i(r)} ${o(t)}>${e}</arcgis-hub-gallery-card>`;
-    // TODO: remove this case once the arcgis-hub-gallery-card
-    // supports items (Caleb should be merghing soon)
-    case "arcgis-hub-item-gallery-card":
-      return c`<arcgis-hub-item-gallery-card style=${$(a)} ${u} ${i(r)} ${o(t)}>${e}</arcgis-hub-item-gallery-card>`;
+      return r`<arcgis-hub-gallery-card style=${c(a)} ${s} ${$(t)} ${i(e)}>${o}</arcgis-hub-gallery-card>`;
     case "arcgis-hub-image":
-      return c`<arcgis-hub-image style=${$(a)} ${u} ${i(r)} ${o(t)}>${e}</arcgis-hub-image>`;
+      return r`<arcgis-hub-image style=${c(a)} ${s} ${$(t)} ${i(e)}>${o}</arcgis-hub-image>`;
     case "arcgis-hub-embed-card":
-      return c`<arcgis-hub-embed-card style=${$(a)} ${u} ${i(r)} ${o(t)}>${e}</arcgis-hub-embed-card>`;
+      return r`<arcgis-hub-embed-card style=${c(a)} ${s} ${$(t)} ${i(e)}>${o}</arcgis-hub-embed-card>`;
     case "arcgis-nav-card":
-      return c`<arcgis-nav-card style=${$(a)} ${u} ${i(r)} ${o(t)}>${e}</arcgis-nav-card>`;
+      return r`<arcgis-nav-card style=${c(a)} ${s} ${$(t)} ${i(e)}>${o}</arcgis-nav-card>`;
     case "arcgis-hub-timeline":
-      return c`<arcgis-hub-timeline style=${$(a)} ${u} ${i(r)} ${o(t)}>${e}</arcgis-hub-timeline>`;
+      return r`<arcgis-hub-timeline style=${c(a)} ${s} ${$(t)} ${i(e)}>${o}</arcgis-hub-timeline>`;
     case "arcgis-hub-entity-metadata":
-      return c`<arcgis-hub-entity-metadata style=${$(a)} ${u} ${i(r)} ${o(t)}>${e}</arcgis-hub-entity-metadata>`;
+      return r`<arcgis-hub-entity-metadata style=${c(a)} ${s} ${$(t)} ${i(e)}>${o}</arcgis-hub-entity-metadata>`;
     // TODO: remove this case once we can configure a catalog
     // via the arcgis-hub-gallery-card (e.g. once the gallery
     // card supports optionally showing search & facets)
     case "arcgis-hub-catalog":
-      return c`<arcgis-hub-catalog .catalogs=${s.catalogs} style=${$(a)} ${u} ${i(r)} ${o(t)}>${e}</arcgis-hub-catalog>`;
+      return r`<arcgis-hub-catalog .catalogs=${u.catalogs} style=${c(a)} ${s} ${$(t)} ${i(e)}>${o}</arcgis-hub-catalog>`;
     // Add more cases as needed
     case "div":
+      return r`<div .innerHTML=${u.html ?? ""} style=${c(a)} ${$(t)} ${i(e)}></div>`;
     default:
-      return c`<div style=${$(a)} ${i(r)} ${o(t)}>${e}</div>`;
+      return r`<div style=${c(a)} ${$(t)} ${i(e)}>${o}</div>`;
   }
 }
 export {

package/dist/components/layouts/components/layout-node/index.d.ts

@@ -1,6 +1,5 @@
 import "../../../arcgis-text-card/index.js";
 import "@esri/hub-components/dist/components/arcgis-hub-gallery-card.js";
-import "@esri/hub-components/dist/components/arcgis-hub-item-gallery-card.js";
 import "@esri/hub-components/dist/components/arcgis-hub-image.js";
 import "@esri/hub-components/dist/components/arcgis-hub-embed-card.js";
 import "../../../arcgis-nav-card/index.js";

package/dist/components/layouts/components/layout-node/index.js

@@ -6,7 +6,6 @@ import "@esri/calcite-components/components/calcite-avatar";
 export * from "./customElement.js";
 deferredLoaders.set("arcgis-text-card", () => import("../../../arcgis-text-card/index.js"))
 .set("arcgis-hub-gallery-card", () => import("@esri/hub-components/dist/components/arcgis-hub-gallery-card.js"))
-.set("arcgis-hub-item-gallery-card", () => import("@esri/hub-components/dist/components/arcgis-hub-item-gallery-card.js"))
 .set("arcgis-hub-image", () => import("@esri/hub-components/dist/components/arcgis-hub-image.js"))
 .set("arcgis-hub-embed-card", () => import("@esri/hub-components/dist/components/arcgis-hub-embed-card.js"))
 .set("arcgis-nav-card", () => import("../../../arcgis-nav-card/index.js"))

package/dist/components/layouts/types.d.ts

@@ -1,4 +1,6 @@
-import { HubEntity, IChangeEventDetail, IEntityPermissionPolicy, IHubSite } from '@esri/hub-common';
+import { HubEntity, IChangeEventDetail, IConfigurationSchema, IEntityPermissionPolicy, IHubSite, IUiSchema } from '@esri/hub-common';
+import { IMigratableSchema } from '@esri/hub-components';
+import { ILayoutV1, ILayoutV2 } from './utils/migrations/types';
 /** Type representing supported responsive breakpoints.  */
 export type Breakpoint = "xs" | "sm" | "md" | "lg" | "xl" | "xxl";
 /** Map of breakpoint names to their minimum pixel widths.  */
@@ -83,24 +85,12 @@ export interface ILayoutVariable {
     value: RefOrValue;
 }
 /** Union type of all layout schema versions.  */
-export type LayoutSchema = ILayout;
-/** The latest supported layout schema.  */
-export type CurrentLayoutSchema = ILayout;
-/** Interface representing a layout object. */
-export interface ILayout {
-    /** Schema version for the layout. */
-    schemaVersion: number;
-    /** If true, the entire layout is read-only. */
-    readOnly?: boolean;
-    /** Array of sections in the layout. */
-    sections: SectionOrRef[];
-    /** Array of history entries for the layout. */
-    history: IHistoryEntry[];
-    /** Optional translations for the layout. */
-    translations?: ITranslationMap;
-    /** Optional overrides for layout nodes. */
-    overrides?: INodeOverrides;
-}
+export type Layout = ILayoutV1 | ILayoutV2;
+/**
+ * The latest supported layout schema. This should be
+ * updated whenever a new schema version is released.
+ */
+export type ILayout = ILayoutV2;
 /** Interface representing overrides for layout nodes. */
 export interface INodeOverrides {
     /** Overrides for the node's properties */
@@ -109,7 +99,7 @@ export interface INodeOverrides {
 /** Type representing any node in the layout tree.  */
 export type LayoutNode = IColumn | ILayoutNode | IRow | ISection;
 /** Interface representing a generic layout node. */
-export interface ILayoutNode {
+export interface ILayoutNode extends IMigratableSchema {
     /** Unique identifier for the node. */
     id: string;
     /** Tag name to render for this node. */
@@ -186,30 +176,21 @@ export interface IAccessibleProps {
  * accessibility and layout options.
  */
 export interface ISectionProps extends IAccessibleProps {
-    /** If true, the section is fluid (full width). */
-    fluid?: boolean;
     /** Remove horizontal gutters (column padding) from the section. */
     noGutters?: boolean;
     /**
-     * Responsive maxWidth for the section. Accepts a number
-     * (pixels) or string (e.g. '80%'), or a ResponsiveValue
-     * of those. Example: maxWidth: { sm: 540, md: 720, lg: '80%' }
+     * Responsive full width for the section.
+     * Section will be 100% wide above this breakpoint.
      */
-    maxWidth?: ResponsiveValue<number | string>;
+    fullWidthAt?: Breakpoint | "fluid";
 }
 /**
  * Interface for row-specific properties, including
  * accessibility and layout options.
  */
 export interface IRowProps extends IAccessibleProps {
-    /** Remove horizontal gutters (column padding) from the row. */
-    noGutters?: boolean;
     /** How to align columns vertically (cross axis). */
-    alignItems?: "around" | "between" | "center" | "end" | "start" | "stretch";
-    /** Space between columns (in pixels). Not implemented yet. */
-    gap?: ResponsiveValue<number | string>;
-    /** How to justify columns horizontally (main axis). Not implemented yet. */
-    justifyContent?: ResponsiveValue<"around" | "between" | "center" | "end" | "evenly" | "start">;
+    alignItems?: ResponsiveValue<"around" | "between" | "center" | "end" | "start" | "stretch">;
 }
 /**
  * Interface for column-specific properties, including
@@ -220,16 +201,22 @@ export interface IColumnProps extends IAccessibleProps {
     width?: ResponsiveValue<ColumnWidth>;
     /** Responsive offset (left margin) for the column. */
     offset?: ResponsiveValue<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12>;
-    /** Responsive order for the column. */
-    order?: ResponsiveValue<number>;
     /** Responsive self-alignment for the column. */
-    alignSelf?: "auto" | "baseline" | "center" | "end" | "start" | "stretch";
+    alignSelf?: ResponsiveValue<"auto" | "baseline" | "center" | "end" | "start" | "stretch">;
+    alignItems?: ResponsiveValue<"auto" | "baseline" | "center" | "end" | "start" | "stretch">;
+    /**
+     * Controls horizontal alignment of children within the column.
+     * Accepts standard CSS 'justify-content' values, or responsive values.
+     * Example: 'flex-start', 'center', 'flex-end', 'space-between', etc.
+     */
+    justifyContent?: ResponsiveValue<"around" | "between" | "center" | "end" | "evenly" | "start">;
+    shrink?: boolean;
 }
 /**
  * Interface representing a history entry for a
  * layout node.
  */
-interface IHistoryEntry {
+export interface IHistoryEntry {
     /** Node id for the history entry. */
     nodeId: string;
     /** UTC timestamp for the change. */
@@ -245,11 +232,14 @@ interface IHistoryEntry {
  * should implement this interface to ensure
  * consistency.
  */
-export interface IConfigurableNode {
-    canEdit?: boolean;
-    canMove?: boolean;
-    nodeConfig?: ILayoutNodeConfig;
+export interface IConfigurableLayoutNode {
+    layoutNodeConfig?: ILayoutNodeConfig;
 }
+/**
+ * Type representing an HTML element that extends
+ * the IConfigurableLayoutNode interface.
+ */
+export type HTMLConfigurableLayoutNodeElement = HTMLElement & IConfigurableLayoutNode;
 /**
  * Interface representing the configuration for a
  * layout node.
@@ -257,11 +247,22 @@ export interface IConfigurableNode {
 export interface ILayoutNodeConfig {
     /** Tag of the layout node. */
     tag: LayoutNodeTag;
-    /** Property name for the node's values. */
+    /** Whether the node is editable. */
+    canEdit?: boolean;
+    /** Whether the node is repositionable. */
+    canMove?: boolean;
+    /**
+     * Property name for the node's values - e.g. when the
+     * node is edited, the updated values from the editor
+     * will be set on this property of the node.
+     */
     valuesProp?: string;
     /** Default values for the node's configuration. */
     defaults: Record<string, unknown>;
-    /** Various translation strings to display in the node's UI */
+    /**
+     * Various translation strings to display or use for a11y
+     * purposes in the node's editing UI
+     */
     i18n: {
         label: string;
         description?: string;
@@ -270,23 +271,64 @@ export interface ILayoutNodeConfig {
         repositionUpLabel?: string;
         repositionDownLabel?: string;
     };
-    /** Optional editor configuration for the node. */
-    editor?: {
-        /** Tag of the node's editor component. */
-        tag?: LayoutEditorTag;
-        /** Optional callback to transform values before passing to the editor. */
-        valuesCallback?: (val: unknown) => unknown;
-        /** Additional properties to pass to the editor. */
-        properties?: Record<string, unknown>;
-    };
+    /**
+     * Optional editor configuration for the node. If provided
+     * and the card is editable, an edit control will be enabled
+     * that will open the editing experience defined here.
+     */
+    editor?: LayoutNodeEditorConfig;
 }
+/**
+ * Base type representing common properties for
+ * a layout node's editor configuration.
+ */
+type LayoutNodeEditorConfigBase = {
+    /**
+     * Optional callback to transform values before
+     * passing to the editor.
+     */
+    valuesInCallback?: (val: unknown) => unknown;
+    /**
+     * Optional callback to transform values after
+     * editing, before mapping back to the node's
+     * properties.
+     */
+    valuesOutCallback?: (val: unknown) => unknown;
+    /** Additional properties to pass to the editor. */
+    properties?: Record<string, unknown>;
+};
+/**
+ * Type representing a layout node's editor
+ * configuration. This can be driven by an
+ * editor tag or the full JSON schema and
+ * UI schema defining a generic form-based
+ * editor.
+ */
+export type LayoutNodeEditorConfig = (LayoutNodeEditorConfigBase & {
+    /** Tag of the node's editor component. */
+    tag: LayoutEditorTag;
+    schema?: never;
+    uiSchema?: never;
+}) | (LayoutNodeEditorConfigBase & {
+    tag?: never;
+    /**
+     * JSON schema defining the underlying
+     * properties of the node's editor.
+     */
+    schema: IConfigurationSchema;
+    /**
+     * Optional UI schema defining the UI of the
+     * node's editor.
+     */
+    uiSchema: IUiSchema;
+});
 /**
  * Interface representing the information emitted when
  * a layout node is changed in the layout editor.
  */
 export interface ILayoutNodeChangeEventDetail extends IChangeEventDetail {
     id: string;
-    nodeConfig: ILayoutNodeConfig;
+    layoutNodeConfig: ILayoutNodeConfig;
 }
 /**
  * Type representing layout utility functions that are
@@ -309,14 +351,14 @@ export interface IProcessLayoutOptions {
  * supported by the layout system and can be defined
  * in an ILayout object.
  */
-export declare const layoutNodeTags: readonly ["arcgis-layout-section", "arcgis-layout-row", "arcgis-layout-column", "calcite-button", "calcite-chip", "calcite-avatar", "arcgis-text-card", "arcgis-hub-gallery-card", "arcgis-hub-item-gallery-card", "arcgis-hub-image", "arcgis-hub-embed-card", "arcgis-nav-card", "arcgis-hub-timeline", "arcgis-hub-entity-metadata", "arcgis-hub-catalog", "div"];
+export declare const layoutNodeTags: readonly ["arcgis-layout-section", "arcgis-layout-row", "arcgis-layout-column", "calcite-button", "calcite-chip", "calcite-avatar", "arcgis-text-card", "arcgis-hub-gallery-card", "arcgis-hub-image", "arcgis-hub-embed-card", "arcgis-nav-card", "arcgis-hub-timeline", "arcgis-hub-entity-metadata", "arcgis-hub-catalog", "div"];
 /** Union type of all supported layout node tags.  */
 export type LayoutNodeTag = (typeof layoutNodeTags)[number];
 /**
  * An array of tags representing components that are
  * supported as editors for layout nodes.
  */
-export declare const layoutEditorTags: readonly ["arcgis-hub-gallery-card-editor", "hub-composite-input-embed", "hub-field-input-input", "hub-field-input-rich-text"];
+export declare const layoutEditorTags: readonly ["arcgis-hub-gallery-card-editor", "hub-field-input-input", "hub-field-input-rich-text", "arcgis-hub-embed-card-editor", "arcgis-hub-timeline-editor", "hub-field-input-image-picker"];
 /** Union type of all supported layout editor tags.  */
 export type LayoutEditorTag = (typeof layoutEditorTags)[number];
 export {};

package/dist/components/layouts/utils/getResponsiveClasses.d.ts

@@ -1,6 +1,6 @@
-import { ColumnWidth, IColumnProps, ISectionProps, IRowProps, ResponsiveValue } from '../types';
+import { ColumnWidth, ResponsiveValue, ISection, IRow, IColumn } from '../types';
 export declare function getResponsiveClasses<T>(propName: string, value: ResponsiveValue<T> | undefined, valueMapper?: (val: T) => string): string[];
-export declare function getSectionClasses(props?: ISectionProps): string[];
-export declare function getRowClasses(props?: IRowProps): string[];
+export declare function getSectionClasses(section: ISection): string[];
+export declare function getRowClasses(row: IRow): string[];
 export declare function getColumnWidthClasses(width: ResponsiveValue<ColumnWidth> | undefined): string[];
-export declare function getColumnClasses(props?: IColumnProps): string[];
+export declare function getColumnClasses(column: IColumn): string[];

package/dist/components/layouts/utils/migrations/getLayoutNodeMigrationFn.d.ts

@@ -0,0 +1,13 @@
+import { IMigratableSchema } from '@esri/hub-components';
+import { LayoutNodeTag } from '../../types';
+type NodeMigrationFn = (schema: IMigratableSchema) => IMigratableSchema;
+/**
+ * Dynamically imports and returns the migration function
+ * for a given layout node.
+ *
+ * @param nodeTag - the tag of the layout node
+ * @returns a promise that resolves to the migration
+ * function for the given node type
+ */
+export declare function getLayoutNodeMigrationFn(nodeTag: LayoutNodeTag): Promise<NodeMigrationFn>;
+export {};

package/dist/components/layouts/utils/migrations/migrateLayout.d.ts

@@ -0,0 +1,21 @@
+import { MigratableSchemaTransformMap } from '@esri/hub-components';
+import { Layout, ILayout } from '../../types';
+import { ILayoutV1, ILayoutV2 } from './types';
+/**
+ * An interface representing a map of supported layout
+ * schema migrations where the key is the schema version
+ * and the value is a transform fn
+ */
+export interface LayoutSchemaTransformMap extends MigratableSchemaTransformMap {
+    2: (input: ILayoutV1) => ILayoutV2;
+}
+export declare const layoutTransformMap: LayoutSchemaTransformMap;
+/**
+ * Migrates a layout schema to the latest version, including
+ * recursively migrating all nodes in the layout tree to their
+ * latest schema versions.
+ *
+ * @param schema The layout schema to migrate
+ * @returns The migrated layout schema
+ */
+export declare function migrateLayout(schema: Layout): Promise<ILayout>;

package/dist/components/layouts/utils/migrations/types/ILayoutV1.d.ts

@@ -0,0 +1,12 @@
+import { IMigratableSchema } from '@esri/hub-components';
+/**
+ * Interface representing a V1 layout object (e.g. the
+ * original Ember layout system)
+ *
+ * TODO: flesh out v1 interface for migration purposes
+ */
+export interface ILayoutV1 extends IMigratableSchema {
+    header?: unknown;
+    sections?: unknown;
+    footer?: unknown;
+}

package/dist/components/layouts/utils/migrations/types/ILayoutV2.d.ts

@@ -0,0 +1,17 @@
+import { IMigratableSchema } from '@esri/hub-components';
+import { IHistoryEntry, INodeOverrides, ITranslationMap, SectionOrRef } from '../../../types';
+/** Interface representing a V2 layout object. */
+export interface ILayoutV2 extends IMigratableSchema {
+    /** Schema version for the layout. */
+    schemaVersion: 2;
+    /** If true, the entire layout is read-only. */
+    readOnly?: boolean;
+    /** Array of sections in the layout. */
+    sections: SectionOrRef[];
+    /** Array of history entries for the layout. */
+    history: IHistoryEntry[];
+    /** Optional translations for the layout. */
+    translations?: ITranslationMap;
+    /** Optional overrides for layout nodes. */
+    overrides?: INodeOverrides;
+}

package/dist/components/layouts/utils/migrations/types/index.d.ts

@@ -0,0 +1,2 @@
+export type { ILayoutV1 } from './ILayoutV1';
+export type { ILayoutV2 } from './ILayoutV2';

package/dist/components/layouts/utils/processLayout.d.ts

@@ -1,3 +1,3 @@
 import { IArcGISContext } from '@esri/hub-common';
-import { ILayout, IProcessLayoutOptions } from '../types';
-export declare const processLayout: (layout: ILayout, options: IProcessLayoutOptions, context: IArcGISContext) => Promise<Promise<ILayout>>;
+import { IProcessLayoutOptions } from '../types';
+export declare const processLayout: (layout: import('./migrations/types').ILayoutV2, options: IProcessLayoutOptions, context: IArcGISContext) => Promise<Promise<import('./migrations/types').ILayoutV2>>;