@orangelogic/design-system 2.0.0-29DUO2-beta-3 → 2.0.0-29IORR-beta-2

package/library/packages/types/src/table.d.ts

@@ -516,10 +516,13 @@ export interface IComponentFunctionBinder {
 export interface IDataLoader extends ICoreFeature {
     requestOrder: number;
     loading: boolean;
+    externalLoading: boolean;
+    readonly pendingPromise: Promise<void> | null;
     load(data: any, params?: any, config?: any, replace?: any, silent?: any, columnsChanged?: any): Promise<void>;
     mapParams(params: Record<string, any>, map: Record<string, string>): Record<string, any>;
     objectInvert(obj: Record<string, string>): Record<string, string>;
     blockActiveLoad(): void;
+    setExternalLoading(value: boolean): void;
     alertLoader(): void;
     alertError(): void;
     clearAlert(): void;
@@ -894,11 +897,13 @@ export interface IModule extends ICoreFeature {
     popup(menuEl: HTMLElement, menuContainer?: any): any;
     alert(content: any, type?: string): void;
     clearAlert(): void;
+    isLoading(): boolean;
 }
 export interface ITabulatorFull extends ITabulator {
     setSheetData: (lookup: string | SpreadsheetComponent, data: unknown[][]) => void;
     setGroupBy: (groups: GroupArg) => void;
     setGroupHeader: (values: Options['groupHeader']) => void;
+    setGroupLoadMoreMeta: (meta: GroupLoadMoreMeta | undefined) => void;
     setGroupStartOpen: (values: Options['groupStartOpen']) => void;
     setGroupValues: (data: GroupValuesArg) => void;
     setPageSize: (size: number | true) => void;
@@ -953,11 +958,27 @@ export interface ISheetComponent {
     setRows(rows: number): unknown;
     setTitle(title: string): unknown;
 }
+export interface GroupLoadMorePathSegment {
+    field: string | false;
+    key: unknown;
+}
+export interface GroupLoadMoreState {
+    hasMore: boolean;
+    loading?: boolean;
+}
+export type GroupLoadMoreMeta = Record<string, GroupLoadMoreState>;
+export interface GroupLoadMoreEventPayload {
+    path: GroupLoadMorePathSegment[];
+    pathKey: string;
+    rowCount: number;
+}
 export interface IGroupComponent {
     getElement(): HTMLElement | false;
     getField(): string | false;
     getKey(): unknown;
     getParentGroup(): IGroupComponent | false;
+    getPath(): GroupLoadMorePathSegment[];
+    getPathKey(): string;
     getRows(): IRowComponent[];
     getSubGroups(): IGroupComponent[];
     getTable(): unknown;
@@ -1213,7 +1234,7 @@ export interface OptionsPagination {
      *
      *  When using the page size selector like this, if you use the setPageSize function to set the page size to a value not in the list, the list will be regenerated using the new page size as the starting valuer
      */
-    paginationSizeSelector?: true | number[] | any[];
+    pageSizeOptions?: true | number[] | any[];
     /** By default the pagination controls are added to the footer of the table. If you wish the controls to be created in another element pass a DOM node or a CSS selector for that element to the paginationElement option. */
     paginationElement?: HTMLElement | string;
     /**
@@ -1266,6 +1287,8 @@ export interface OptionsPagination {
     paginationShowLast?: boolean;
     /** Whether to show the pagination buttons. */
     showPaginationButtons?: boolean;
+    /** Whether to show an editable input for the current page in the pagination counter. */
+    showPaginationInput?: boolean;
 }
 export type GroupArg = string | string[] | ((data: any) => any) | Array<string | ((data: any) => any)>;
 export interface OptionsRowGrouping {
@@ -1304,6 +1327,8 @@ export interface OptionsRowGrouping {
     groupToggleElement?: 'arrow' | 'header' | false;
     /** show/hide column calculations when group is closed. */
     groupClosedShowCalcs?: boolean;
+    /** Load-more state keyed by serialized group path. */
+    groupLoadMoreMeta?: GroupLoadMoreMeta;
     groupUpdateOnCellEdit?: boolean;
 }
 export type FilterPredicate = (filterVal: any, rowVal: any, rowData: any, filterParams: FilterParams) => boolean;
@@ -2401,6 +2426,14 @@ export interface LabelValue {
     label: string;
     value: string | number | boolean;
 }
+export interface FallbackOption {
+    /** The sentinel value used to match against list items. The original unmatched cell value is preserved for form submission unless the user explicitly changes it. */
+    value: string | number | boolean;
+    /** Sanitized HTML string to render in the `prefix` slot of the fallback `cx-option` (e.g. `'<cx-icon name="plus"></cx-icon>'`). No prefix is shown when omitted. */
+    prefix?: string;
+    /** When true, the divider that separates the fallback option from the rest of the list is hidden. Defaults to false (divider is shown). */
+    hideDivider?: boolean;
+}
 type ListEditorItem = {
     label: string;
     value: string;
@@ -2416,6 +2449,7 @@ export interface ListEditorParams extends SharedEditorParams, SharedSelectAutoCo
     valuesURL?: string;
     valuesLookup?: ListEditorValuesLookup;
     valuesLookupField?: string;
+    fallbackOption?: FallbackOption;
     clearable?: boolean;
     getItemLabel?: (label: string, value: string, item: any, element: HTMLElement) => string;
     sort?: SortDirection;
@@ -2818,6 +2852,7 @@ export interface EventCallBackMethods {
     movableRowsElementDrop: (event: UIEvent, element: Element, row: IRowComponent) => void;
     dataGrouping: () => void;
     dataGrouped: (groups: IGroupComponent[]) => void;
+    groupLoadMore: (detail: GroupLoadMoreEventPayload) => void;
     groupVisibilityChanged: (group: IGroupComponent, visible: boolean) => void;
     localized: (locale: string, lang: any) => void;
     renderStarted: () => void;
@@ -2986,6 +3021,7 @@ export interface HeaderFilterFunc {
 }
 export type LangObject = Record<string, any>;
 export type TableSelector = string | HTMLElement | ITabulator | TableSelector[];
+export declare const DEFAULT_GROUP_INDENT = 36;
 /**
  * @typedef {Object} TrafficFormatterParams
  * @property {Record<any, string>} [colorMap] - Record mapping cell values to colors. Used when the cell value should be mapped to a specific color.

package/library/packages/types/src/textarea.d.ts

@@ -0,0 +1,4 @@
+/** Special value for the `rows` property that makes the textarea fill its parent container height. */
+export declare enum TextareaRows {
+    Max = "max"
+}

package/library/packages/types/src/video-format-picker.d.ts

@@ -0,0 +1,11 @@
+export declare enum AssetVersion {
+    Current = "current",
+    Latest = "latest"
+}
+export interface VideoFormatValue {
+    assetVersion: AssetVersion | string;
+    format: string;
+    formatLabel?: string;
+    versionLabel?: string;
+    videoSrc: string;
+}

package/library/packages/utils/src/actions/asset-click.d.ts

@@ -1,9 +1,7 @@
-import { AssetFormat, ClickAction } from '../../../types/src/asset-click-action';
-import { ClickEvent } from '../../../types/src/gallery';
+import { AssetFormat } from '../../../types/src/asset-click-action';
 
 export declare function openAssetOverview(this: HTMLElement, id: string | null | undefined): void;
 export declare function openFolderOverview(this: HTMLElement, assetId: string | null | undefined): void;
 export declare function openLink(this: HTMLElement, url: string | null | undefined, target?: '_blank' | '_parent' | '_self' | '_top' | undefined): void;
 export declare function shareAsset(this: HTMLElement, assetId: string | null | undefined): void;
 export declare function downloadAsset(this: HTMLElement, assetIds: string[] | null | undefined, formats: AssetFormat | null | undefined): void;
-export declare function toGalleryEventClick(clickAction: ClickAction): ClickEvent | ClickAction;

package/library/packages/utils/src/custom-element/i18n.d.ts

@@ -1,5 +1,5 @@
-import { Translation as DefaultTranslation, LocalizeController as DefaultLocalizationController } from './i18n-utils';
 import { GalleryItemCardType } from '../../../types/src/gallery-item';
+import { Translation as DefaultTranslation, LocalizeController as DefaultLocalizationController } from './i18n-utils';
 
 export declare class LocalizeController extends DefaultLocalizationController<Translation> {
 }
@@ -76,6 +76,7 @@ export interface Translation extends DefaultTranslation {
     ascending: string;
     aspectRatio: string;
     asset: string;
+    assetFormat: string;
     assetInColdStorage: string;
     assetIndexSync: string;
     assetPreview: string;
@@ -206,6 +207,7 @@ export interface Translation extends DefaultTranslation {
     customStyle: string;
     customWidth: string;
     damViewNoAvailableOptionsForThisAsset: string;
+    darkImageFormat: string;
     darkModeImage: string;
     dashSpacing: string;
     dashWidth: string;
@@ -246,6 +248,7 @@ export interface Translation extends DefaultTranslation {
     downloadButton: string;
     downloadCompleted: string;
     downloadFailed: string;
+    downloadFormat: string;
     downloadLocationNoLongerExists: (location: string) => string;
     downloadManager: string;
     downloadNewVersion: string;
@@ -370,6 +373,7 @@ export interface Translation extends DefaultTranslation {
     image: string;
     imageContent: string;
     imageFormat: string;
+    imagesFormat: string;
     import: string;
     importTextFile: string;
     importTextFileDialogConfirm: string;
@@ -388,8 +392,8 @@ export interface Translation extends DefaultTranslation {
     interpretTextAs: string;
     itCanTakeAFewMinutesForThisSettingToTakeEffect: string;
     italic: string;
-    itemOfTotal: (curr: number, total: number) => string;
-    itemRangeOfTotal: (start: number, end: number, total: number) => string;
+    itemOfTotal: (curr: number | string, total: number) => string;
+    itemRangeOfTotal: (start: number | string, end: number | string, total: number) => string;
     itemsGap: string;
     jump: string;
     justify: string;
@@ -553,6 +557,7 @@ export interface Translation extends DefaultTranslation {
     qualityHelpText: string;
     quote: string;
     radixPoint: string;
+    read: string;
     readyToUse: string;
     recent: string;
     redo: string;
@@ -691,6 +696,7 @@ export interface Translation extends DefaultTranslation {
     thickness: string;
     thousandsSeparator: string;
     thumbnail: string;
+    thumbnailFormat: string;
     thumbnailHelpText: string;
     timeBased: string;
     timeFormat: string;
@@ -751,6 +757,7 @@ export interface Translation extends DefaultTranslation {
     video: string;
     videoChaptersEmptyPlaceholder: string;
     videoContent: string;
+    videoFormat: string;
     videoPlayer: string;
     view: string;
     viewAndSort: string;

package/library/packages/utils/src/index.d.ts

@@ -41,5 +41,6 @@ export * from './string';
 export * from './template';
 export * from './time';
 export * from './toast';
+export * from './transformation';
 export * from './url';
 export * from './video';

package/library/packages/utils/src/string/string.d.ts

@@ -93,6 +93,38 @@ export declare function formatSecondsToTime(seconds: number, options?: TimeForma
  * @returns The padded path
  */
 export declare function padPath(path: string): string;
+/**
+ * Splits a `${path}-${id}` rootID string back into its parts.
+ * The separator is a single dash; since paths may contain dashes, only the
+ * last segment is treated as the id.
+ *
+ * @example
+ * extractRootData('Root/Library-2Y1O3RQM3D')
+ * // → { id: '2Y1O3RQM3D', path: 'Root/Library' }
+ */
+export declare function extractRootData(rootID: string): {
+    id: string;
+    path: string;
+};
+/**
+ * Inverse of `extractRootData` — encodes a path + id pair as `${path}-${id}`.
+ *
+ * @example
+ * getRootIDString({ id: '2Y1O3RQM3D', path: 'Root/Library' })
+ * // → 'Root/Library-2Y1O3RQM3D'
+ */
+export declare function getRootIDString({ id, path, }: {
+    id: string;
+    path: string;
+}): string;
+/**
+ * Trims `full` to the segment that's exactly one level below `base`.
+ *
+ * @example
+ * reducePathToDirectChild('Root/A/B/C/D', 'Root/A')
+ * // → 'Root/A/B'
+ */
+export declare function reducePathToDirectChild(full: string, base: string): string;
 /**
  * Parses a time string and converts it to seconds.
  * This function reverses the effect of formatSecondsToTime.
@@ -119,3 +151,4 @@ export declare function sanitizeHTML(html: string): string;
 export declare function safeString(value: any): string;
 export declare function emptyToSpace(value: any): string;
 export declare function isGalleryItemCardType(value: unknown): value is GalleryItemCardType;
+export declare function safeExtension(ext: string | null | undefined): string;

package/library/packages/utils/src/transformation/index.d.ts

@@ -0,0 +1 @@
+export * from './transformation';

package/library/packages/utils/src/url/url.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Returns the relative portion of a URL when it shares the same origin as the
+ * current page (or the provided `origin`). Returns the original value unchanged
+ * when the URL is cross-origin, already relative, or falsy.
+ *
+ * @param url - The URL to normalise.
+ * @param origin - Origin to compare against (defaults to `window.location.origin`).
+ */
+export declare function toRelativeUrl(url: string | null | undefined, origin?: string): string | undefined;
 export declare const appendProtocol: (inputUrl: string, defaultProtocol?: string, ignoreRelativeUrl?: boolean) => string;
 export declare const isValidUrl: (urlString: string) => boolean;
 export declare const RELATIVE_URL_REGEX: string;