@esri/hub-web-components 0.36.2 → 0.37.0

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

@@ -1,29 +0,0 @@
-import { ArcgisLayoutContainer } from '../../arcgis-layout-container/customElement.js';
-import { ILayout, IProcessLayoutOptions } from '@esri/hub-common';
-export interface ILayoutContext {
-    /** The base path to layout assets (e.g. images) */
-    assetPath: string;
-    /** Whether the layout is valid */
-    isLayoutValid: boolean;
-    /** the processed layout */
-    layout: ILayout | undefined;
-    /** a reference to the layout node editor panel */
-    layoutNodeEditorRef: HTMLCalcitePanelElement | undefined;
-    /** localized messages from the layout container */
-    messages: ArcgisLayoutContainer["_messages"];
-    /**
-     * Contextual information used to process various
-     * parts of the layout system (e.g. processing the
-     * layout itself, generating addable layout nodes,
-     * etc.)
-     */
-    options: IProcessLayoutOptions;
-}
-/**
- * Lumina Context for sharing layout information from
- * the layout container to child components without
- * needing to prop drill.
- */
-export declare const layoutContext: {
-    __context__: ILayoutContext;
-};

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

@@ -1,9 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-/**
- * Utility that walks through the layout and locks all nodes
- * by setting readOnly to true.
- *
- * @param layout - The layout to lock.
- * @returns The locked layout.
- */
-export declare function lockLayout(layout: ILayout): ILayout;

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

@@ -1,7 +0,0 @@
-/**
- * Simple memoization for async functions.
- *
- * @param fn - The async function to memoize
- * @returns A memoized version of the async function
- */
-export declare function memoizeAsync<T extends (...args: any[]) => Promise<unknown>>(fn: T): (...args: Parameters<T>) => Promise<ReturnType<T>>;

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

@@ -1,12 +0,0 @@
-import { IMigratableSchema, LayoutNodeTag } from '@esri/hub-common';
-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

@@ -1,19 +0,0 @@
-import { MigratableSchemaTransformMap, Layout, ILayout, ILayoutV1, ILayoutV2 } from '@esri/hub-common';
-/**
- * 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/processLayout.d.ts

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

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

@@ -1,11 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-/**
- * Finds and removes a node from the layout by id
- * then checks for any variables that were only referenced by that node
- * and removes them.
- *
- * @param nodeId - The ID of the node to locate within the layout structure.
- * @param layout - The ILayout object to search.
- * @returns {ILayout} The updated layout if the node was removed, or the original layout if not found.
- */
-export declare function removeNode(nodeId: string, layout: ILayout): ILayout;

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

@@ -1,8 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-/**
- * Removes all variables from a layout that have no references in any layout node.
- *
- * @param layout - The layout to inspect.
- * @returns A cloned layout with unreferenced variables removed.
- */
-export declare function removeUnreferencedVariables(layout: ILayout): ILayout;

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

@@ -1,11 +0,0 @@
-import { ILayout, LayoutNode } from '@esri/hub-common';
-/**
- * Moves a leaf LayoutNode up within its column, or to the previous column if at index 0.
- * Returns the new layout with the node moved, or the original (cloned) layout if not moved.
- */
-export declare function moveNodeUp(targetNode: LayoutNode, layout: ILayout): ILayout;
-/**
- * Moves a leaf LayoutNode down within its column, or to the next column if at last index.
- * Returns the new layout with the node moved, or the original (cloned) layout if not moved.
- */
-export declare function moveNodeDown(targetNode: LayoutNode, layout: ILayout): ILayout;

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

@@ -1,25 +0,0 @@
-import { IColumn, IRow, ISection, LayoutNode, Ref, SectionOrRef } from '@esri/hub-common';
-/**
- * Type guard to check if a node is a section.
- * @param node
- * @returns True if the node is a section, false otherwise.
- */
-export declare function isSection(node: LayoutNode): node is ISection;
-/**
- * Type guard to check if a node is a row.
- * @param node
- * @returns True if the node is a row, false otherwise.
- */
-export declare function isRow(node: LayoutNode): node is IRow;
-/**
- * Type guard to check if a node is a column.
- * @param node
- * @returns True if the nod is a column, false otherwise.
- */
-export declare function isColumn(node: LayoutNode): node is IColumn;
-/**
- * Checks if a section is a reference.
- * @param section The section to check.
- * @returns True if the section is a reference, false otherwise.
- */
-export declare function isRef(section: SectionOrRef | undefined): section is Ref;

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

@@ -1,7 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-/**
- * Validates a layout tree for required structure, types,
- * and correct nesting. Returns an array of error messages,
- * or an empty array if valid.
- */
-export declare function validateLayout(layout: ILayout | undefined): string[];

package/dist/controllers/querystring.d.ts

@@ -1,102 +0,0 @@
-import { EventEmitter } from '@arcgis/lumina';
-/**
- * An interface that implements `from` and `to` methods to convert between two generic types
- */
-interface Transform<TypeA, TypeB> {
-    from: (value: TypeB) => TypeA;
-    to: (value: TypeA) => TypeB;
-}
-/**
- * A simple register options object to be used when the component property value
- * and the querystring parameter value are identical, i.e. do not require transforms
- */
-interface SimpleRegisterOption {
-    defaultValue?: string;
-    parameterName?: string;
-}
-/**
- * Querystring transforms to convert between a string (querystring parameter value)
- * and a generic type (usable value)
- */
-export type QuerystringTransform<Type> = Transform<Type, string>;
-/**
- * A register options object to be used when the component property value
- * and the querystring parameter value are not identical, i.e. they require transforms
- */
-type TransformRegisterOption<ParameterType> = Pick<SimpleRegisterOption, "parameterName"> & {
-    defaultValue?: ParameterType;
-    transform: QuerystringTransform<ParameterType>;
-};
-/**
- * A discriminated union of supported interfaces for the QuerystringController register method's options argument
- */
-type RegisterOptions<ParameterType> = SimpleRegisterOption | TransformRegisterOption<ParameterType>;
-/**
- * A record type representing the detail payload of `arcgisQuerystringChange` events
- */
-export type QuerystringChangeEventDetail = {
-    url: string;
-    parameters: Record<string, string | null>;
-};
-/**
- * A record type representing an `arcgisQuerystringChange` event
- */
-export type QuerystringChangeEvent = CustomEvent<QuerystringChangeEventDetail>;
-/**
- * arcgisQuerystringChange event emitter
- */
-type QuerystringChangeEventEmitter = EventEmitter<QuerystringChangeEventDetail>;
-/**
- * Interface components must implement if they desire to initialize state
- * from querystring parameters
- */
-export interface QuerystringComponentProperties {
-    arcgisQuerystringChange: QuerystringChangeEventEmitter;
-    initFromQueryParams: boolean;
-    cid: string;
-}
-/**
- * Querystring Controller exports
- */
-export interface QuerystringControllerExports {
-    /**
-     * A method to configure a component property or state member to initiailize it's value
-     * from a querystring parameter value.
-     * @param options The querystring options
-     * @returns
-     */
-    register: <PropertyType>(options: RegisterOptions<PropertyType>) => PropertyType;
-}
-/**
- * A Lumina Controller to initialize component property values from querystring parameters.
- */
-export declare const useQuerystringsController: (component: QuerystringComponentProperties & import('@arcgis/lumina').LitElement) => QuerystringControllerExports;
-/**
- * Boolean transform map
- */
-export declare const BOOLEAN: {
-    from: (value: string) => boolean;
-    to: (value: boolean) => string;
-};
-/**
- * Number transform map
- */
-export declare const NUMBER: {
-    from: (value: string) => number;
-    to: (value: number) => string;
-};
-/**
- * Timestamp transform map
- */
-export declare const TIMESTAMP: {
-    from: (value: string) => Date;
-    to: (value: Date) => string;
-};
-/**
- * ISO date/time transform map
- */
-export declare const ISO: {
-    from: (value: string) => Date;
-    to: (value: Date) => string;
-};
-export {};

package/dist/controllers/useGlobalContext.d.ts

@@ -1,6 +0,0 @@
-import { LitElement } from '@arcgis/lumina';
-import { IArcGISContext } from '@esri/hub-common';
-/**
- * Controller to manage and expose the global ArcGIS context reflexively to Lumina-based web components.
- */
-export declare const useGlobalContext: (component: import('@esri/hub-components').IWithContext & LitElement) => IArcGISContext;

package/dist/controllers/useT9n.d.ts

@@ -1 +0,0 @@
-export declare const useT9n: import('@arcgis/lumina/controllers').UseT9n;

package/dist/embed-config.d.ts

@@ -1,27 +0,0 @@
-export declare const environments: {
-    production: {
-        compassApiUrl: string;
-        clientId: string;
-        portalUrl: string;
-    };
-    qa: {
-        compassApiUrl: string;
-        clientId: string;
-        portalUrl: string;
-    };
-    qaesri: {
-        compassApiUrl: string;
-        clientId: string;
-        portalUrl: string;
-    };
-    dev: {
-        compassApiUrl: string;
-        clientId: string;
-        portalUrl: string;
-    };
-    local: {
-        compassApiUrl: string;
-        clientId: string;
-        portalUrl: string;
-    };
-};

package/dist/html/arcgis-layout/fixtures/blocks-and-cards-layout.d.ts

@@ -1,2 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-export declare const LAYOUT: ILayout;

package/dist/html/arcgis-layout/fixtures/entity-view-layout.d.ts

@@ -1,2 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-export declare const LAYOUT: ILayout;

package/dist/html/arcgis-layout/fixtures/fluid-section-layout.d.ts

@@ -1,2 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-export declare const LAYOUT: ILayout;

package/dist/html/arcgis-layout/fixtures/holy-grail-layout.d.ts

@@ -1,2 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-export declare const LAYOUT: ILayout;

package/dist/html/arcgis-layout/fixtures/index.d.ts

@@ -1,9 +0,0 @@
-export { LAYOUT as BLOCKS_AND_CARDS_LAYOUT } from './blocks-and-cards-layout';
-export { LAYOUT as ENTITY_VIEW_LAYOUT } from './entity-view-layout';
-export { LAYOUT as FLUID_SECTION_LAYOUT } from './fluid-section-layout';
-export { LAYOUT as HOLY_GRAIL_LAYOUT } from './holy-grail-layout';
-export { LAYOUT as MULTIPLE_COLUMN_LAYOUT } from './multiple-column-layout';
-export { LAYOUT as NESTED_ROWS_COLUMNS_LAYOUT } from './nested-rows-columns-layout';
-export { LAYOUT as SINGLE_COLUMN_LAYOUT } from './single-column-layout';
-export { LAYOUT as TABBED_LAYOUT } from './tabbed-layout';
-export { LAYOUT as NOGUTTERS_ALIGN_OFFSET } from './nogutters-align-offset';

package/dist/html/arcgis-layout/fixtures/multiple-column-layout.d.ts

@@ -1,2 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-export declare const LAYOUT: ILayout;

package/dist/html/arcgis-layout/fixtures/nested-rows-columns-layout.d.ts

@@ -1,2 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-export declare const LAYOUT: ILayout;

package/dist/html/arcgis-layout/fixtures/nogutters-align-offset.d.ts

@@ -1,2 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-export declare const LAYOUT: ILayout;

package/dist/html/arcgis-layout/fixtures/single-column-layout.d.ts

@@ -1,2 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-export declare const LAYOUT: ILayout;

package/dist/html/arcgis-layout/fixtures/tabbed-layout.d.ts

@@ -1,2 +0,0 @@
-import { ILayout } from '@esri/hub-common';
-export declare const LAYOUT: ILayout;

package/dist/runtime.d.ts

@@ -1,6 +0,0 @@
-export declare const runtime: import('@arcgis/lumina').Runtime;
-/**
- * "customElement" needs to be exported - it will be used by the build system.
- * You should not call it directly.
- */
-export declare const customElement: (tagName: string, component: typeof import('@arcgis/lumina').LitElement) => void, getAssetPath: (suffix: string) => string, setAssetPath: (path: URL | string) => void;

package/dist/util/getTranslatedString.d.ts

@@ -1,15 +0,0 @@
-import { ITranslationMap } from '@esri/hub-common';
-/**
- * Util to get a translated string from either
- * a customer-provided string hash, or from
- * the hub-provided translations, falling back to
- * the key (which could already be a translated
- * string).
- *
- * @param key The translation key
- * @param locale The current locale
- * @param defaultTranslations The default translations
- * @param customTranslations The customer provided translations
- * @returns
- */
-export declare function getTranslatedString<T extends Record<string, unknown>>(key: string, locale: string, defaultTranslations: T, customTranslations: ITranslationMap): string;

package/dist/util/interpolate-translations.d.ts

@@ -1,18 +0,0 @@
-/**
- * Utility to recursively interpolate translations into an
- * object using adlib's interpolate functionality with a
- * custom transform. As such, strings that are intended to be
- * translated must be in the `{{abc.xyz...:translate}}` format.
- *
- * Variables can be passed into the translation strings using
- * the `{{abc.xyz...|key1=value1|key2=value2:translate}}` format.
- *
- * NOTE: If a translation value contains a special character,
- * it _must_ be url encoded before adding it to the string:
- * `{{abc.xyz...|key1=https%3A%2F%2Fmy-url.com%3Fquery%3Dstring:translate}}`
- *
- * @param intl The intl service
- * @param object Object to be translated
- * @returns An object with translated strings that are intended to be translated
- */
-export declare function interpolateTranslations<T extends Record<string, unknown>, K>(messages: T, object: K): K;

package/dist/util/interpolate.d.ts

@@ -1,16 +0,0 @@
-/**
- * A thin wrapper around the hub-common interpolate
- * function (which is a thin wrapper around adlib's
- * interpolate function) that adds UI-specific transforms
- * (e.g. a "translate" transform to handle i18n, etc.).
- * This should be used in any Lumina-specific context
- * where interpolation is needed.
- *
- * @param template The object to interpolate
- * @param settings hash of values to use for interpolation
- * @param opts additional options to be used in transforms
- * @returns The interpolated object
- */
-export declare function interpolate<M extends Record<string, unknown>, T, S>(template: T, settings: S, opts?: {
-    messages?: M;
-}): T;

package/dist/util/querySelectorAllDeep.d.ts

@@ -1,7 +0,0 @@
-/**
- * Recursively finds all elements matching a selector, traversing multiple levels of shadow DOM.
- * @param root The root node to start searching from (Document, ShadowRoot, or Element)
- * @param selector The CSS selector to search for
- * @returns An array of matching elements
- */
-export declare function querySelectorAllDeep<T extends Element = Element>(root: Node, selector: string): T[];

package/dist/util/state.d.ts

@@ -1,7 +0,0 @@
-import { IWithContext as _IWithContext } from '@esri/hub-components';
-export declare const getGlobalContext: () => import('@esri/hub-common').IArcGISContext | undefined;
-export declare const setGlobalContext: (context?: import('@esri/hub-common').IArcGISContext) => void;
-export declare const getCurrentSite: () => import('@esri/hub-common').IHubSite | undefined;
-export declare const setCurrentSite: (site?: import('@esri/hub-common').IHubSite) => void;
-export declare const connectContext: (component: _IWithContext) => void;
-export type IWithContext = _IWithContext;