@orangelogic/design-system 3.15.0 → 3.17.0

package/library/packages/services/src/api/asset/asset.d.ts

@@ -1,10 +1,7 @@
-import { GetAllFormatCodesResponse, GetAssetsInFolderRequest, GetAssetsInFolderResponse, GetAssetsRequest, GetAssetsResponse, GetAuthorizedObjectsRequest, GetAuthorizedObjectsResponse, GetAvailableProxiesResponse, GetCropZoneSuggestionRequest, GetCropZoneSuggestionResponse, GetTransformAssetLinkResponse, SearchAssetsItem, SearchAssetsParams, SearchAssetsResponse } from './asset.types';
+import { GetAllFormatCodesResponse, GetAssetsInFolderRequest, GetAssetsInFolderResponse, GetAssetsRequest, GetAssetsResponse, GetAuthorizedObjectsRequest, GetAuthorizedObjectsResponse, GetAvailableProxiesResponse, GetCropZoneSuggestionRequest, GetCropZoneSuggestionResponse, GetTransformAssetLinkResponse, SearchAssetsParams, SearchAssetsResponse } from './asset.types';
 
-export declare const DEFAULT_VIEW_SIZE = "CoreField.LargeSizePreview";
-export declare const FIELD_CORTEX_PATH = "Document.CortexPath";
 export declare const FIELD_DOC_TYPE = "CoreField.DocType";
 export declare const FIELD_DOC_TITLE = "Document.Title";
-export declare const FIELD_DOC_CAPTION_LONG = "Document.CaptionLong";
 export declare const FIELD_EXTENSION = "Document.FileExtension";
 export declare const FIELD_FILE_SIZE = "CoreField.FileSize";
 export declare const FIELD_IDENTIFIER = "CoreField.Identifier";
@@ -13,25 +10,16 @@ export declare const FIELD_MAX_WIDTH = "CoreField.MaxWidth";
 export declare const FIELD_RECORD_ID = "Document.RecordID";
 export declare const FIELD_SUBTYPE = "CoreField.DocSubType";
 export declare const FIELD_TITLE_WITH_FALLBACK = "CoreField.TitleWithFallback";
-export declare const FIELD_HAS_BROWSER_CHILDREN = "Document.HasBrowserChildren";
 export declare const FIELD_ORIGINAL_FILE_NAME = "CoreField.OriginalFileName";
-export declare const FIELD_UPDATED_FILE_NAME = "CoreField.UpdatedFileName";
-export declare const FIELD_LARGE_SIZE_PREVIEW_ID = "Document.DocumentDirectRepresentativeRID";
-export declare const LIBRARY_NAME = "Library";
 /** Appended to a `path_*` key to carry that proxy's rendered width alongside its URI. */
 export declare const MEDIA_FIELD_WIDTH_SUFFIX = "__width";
-export declare const MESSAGE_NEW_LINE = "\n";
-export declare const ORIGINAL_VIEW_SIZE = "CoreField.OriginalPreview";
+/** Same, for the height — a proxy keeps the source aspect ratio, so the pair stands in for it. */
+export declare const MEDIA_FIELD_HEIGHT_SUFFIX = "__height";
 export declare const FIELD_DOC_SUBTYPE = "Document.DocSubType";
 export declare const FIELD_IN_POINT = "Document.InPoint";
 export declare const FIELD_OUT_POINT = "Document.OutPoint";
-export declare const SEARCH_FIELDS: {
-    DEFAULT_VIEW_SIZE: string;
-    FIELD_TITLE_WITH_FALLBACK: string;
-    ORIGINAL_VIEW_SIZE: string;
-};
 export declare function resolveAssetExtraFilters(selectedFacets?: Record<string, string[]>): Record<string, string[]>;
-export declare function apiSearchAssets({ countPerPage, fields, getPermanentAssetsPaths, httpMethod, isSiteBuilder, pageNumber, query, securityByPassToken, siteUrl, sort, token, useSession, }: SearchAssetsParams): Promise<SearchAssetsResponse>;
+export declare function apiSearchAssets({ consistency, countPerPage, fields, getPermanentAssetsPaths, httpMethod, isSiteBuilder, pageNumber, query, securityByPassToken, siteUrl, sort, token, useSession, }: SearchAssetsParams): Promise<SearchAssetsResponse>;
 export declare function apiGetTransformAssetLink({ assetId, extension, format, siteUrl, token, transformations, useSession, }: {
     assetId: string;
     extension?: string;
@@ -41,15 +29,8 @@ export declare function apiGetTransformAssetLink({ assetId, extension, format, s
     transformations?: string;
     useSession?: string;
 }): Promise<GetTransformAssetLinkResponse | null>;
-export declare function apiGetAssets({ extraFields, getPermanentAssetsPaths, isSiteBuilder, recordIds, securityByPassToken, token, }: GetAssetsRequest): Promise<GetAssetsResponse>;
-/**
- * Reads the pixel width a `path_*` proxy field actually has.
- *
- * Each proxy is rendered at its own size, so this is the ceiling for resizing that URL —
- * distinct from `CoreField.MaximumWidth`, which describes the original file.
- */
-export declare function readSearchAssetItemWidth(item: SearchAssetsItem, field: string): number | undefined;
-export declare function apiGetAssetsInFolder({ countPerPage, directParentFolderIdentifier, extraFields, getPermanentAssetsPaths, isSiteBuilder, limitedDocTypes, pageNumber, parentFolderIdentifier, searchTerm, securityByPassToken, sortOrder, token, }: GetAssetsInFolderRequest): Promise<GetAssetsInFolderResponse>;
+export declare function apiGetAssets({ consistency, extraFields, getPermanentAssetsPaths, isSiteBuilder, recordIds, securityByPassToken, token, }: GetAssetsRequest): Promise<GetAssetsResponse>;
+export declare function apiGetAssetsInFolder({ consistency, countPerPage, directParentFolderIdentifier, extraFields, getPermanentAssetsPaths, isSiteBuilder, limitedDocTypes, pageNumber, parentFolderIdentifier, searchTerm, securityByPassToken, sortOrder, token, }: GetAssetsInFolderRequest): Promise<GetAssetsInFolderResponse>;
 export declare function apiGetCropFocusMode({ autoCropMode, cropHeight, cropWidth, imageUrl, useSession, }: GetCropZoneSuggestionRequest): Promise<GetCropZoneSuggestionResponse | null>;
 export declare function apiGetAvailableProxies({ assetRecordId, isSiteBuilder, siteUrl, token, useSession, }: {
     assetRecordId: string;

package/library/packages/tools/src/fetch-image/fetch-image.d.ts

@@ -22,6 +22,8 @@ type FetchImageControllerOptions = {
      * use. Opt in from a surface whose images are actually laid out responsively.
      */
     buildSrcset?: boolean;
+    /** How fresh the fetched values must be. See `SearchAssetsParams.consistency`. */
+    consistency?: string;
     isSiteBuilder?: boolean;
     maxEnd?: number;
     pageSize?: number;
@@ -44,6 +46,8 @@ export declare class FetchImageController implements ReactiveController {
     private readonly autoFormat;
     /** Whether items carry a `srcset` ladder. See `FetchImageControllerOptions`. */
     private readonly buildSrcset;
+    /** See `FetchImageControllerOptions.consistency`. */
+    private readonly consistency;
     private requestEpoch;
     constructor(host: ReactiveElement, options?: FetchImageControllerOptions);
     get totalDataCount(): number;

package/library/packages/tools/src/tiptap/extensions/task-mention/index.d.ts

@@ -0,0 +1,77 @@
+import { PluginKey } from '@tiptap/pm/state';
+import { MentionNodeAttrs, MentionOptions } from '../mention';
+
+export interface TaskMentionNodeAttrs extends MentionNodeAttrs {
+    /**
+     * Snapshot of the task title at insertion time, stored as a `data-title`
+     * attribute. Display-time rendering resolves the current title server-side;
+     * this is only a fallback for plain-text contexts.
+     */
+    title?: string | null;
+}
+/**
+ * A task reference resolved from a pasted permalink.
+ */
+export interface ResolvedTaskMention {
+    id: string;
+    label: string;
+    title?: string;
+}
+export type TaskMentionOptions = MentionOptions<any, TaskMentionNodeAttrs> & {
+    /**
+     * Format of the chip text shown while composing, with `[IDENTIFIER]` and
+     * `[TITLE]` placeholders (mirrors the server's TaskMentionLinkTextTemplate,
+     * which formats the rendered mention links the same way). Mentions without
+     * a title always show the identifier alone. Display-only: the mention
+     * serializes as `{char}{identifier}` regardless of this option, so the
+     * title never becomes part of the stored comment body.
+     */
+    labelTemplate?: string;
+    /**
+     * Resolves a task identifier extracted from a pasted permalink into a
+     * mention item. Return `null` when the identifier matches no task; the
+     * pasted text is then left untouched (rendered as a plain link).
+     * URL paste conversion is disabled while this is unset.
+     */
+    resolveTaskUrl?: (identifier: string) => Promise<ResolvedTaskMention | null>;
+    /**
+     * Site-specific regex source, matched case-insensitively against a pasted
+     * same-origin URL's path, with the task identifier as capture group 1.
+     * Derived server-side from the site's task URL template so paste detection
+     * always follows it. Path-based detection is disabled while unset — only
+     * legacy `?TID={id}` links are recognized then.
+     */
+    urlPattern?: string;
+};
+/**
+ * The plugin key for the task mention plugin.
+ */
+export declare const TaskMentionPluginKey: PluginKey<any>;
+/**
+ * The chip text shown in the editor for a task mention: the trigger character
+ * followed by the label template with `[IDENTIFIER]`/`[TITLE]` filled in, or
+ * by the identifier alone when the mention has no title.
+ */
+export declare function formatTaskMentionText(char: string, labelTemplate: string | undefined, identifier: string, title: string | null | undefined): string;
+/**
+ * Extracts a task identifier from a task permalink pointing at `currentOrigin`.
+ * Path detection follows `sitePattern` (the site's task URL template, compiled
+ * by `compileTaskUrlPattern`); legacy `?TID={identifier}` links are always
+ * recognized. Returns `null` for anything else (foreign origins, non-task
+ * paths, plain text).
+ */
+export declare function findTaskIdentifierInUrl(text: string, currentOrigin: string, sitePattern?: RegExp | null): string | null;
+/**
+ * Compiles the site-specific URL pattern, or returns `null` when unset or
+ * invalid (path-based paste detection then stays disabled).
+ */
+export declare function compileTaskUrlPattern(patternSource: string | undefined): RegExp | null;
+/**
+ * This extension inserts references to other tasks into the editor — the task
+ * counterpart of the contact `Mention` extension. Stored as `span.task-mention`
+ * so the contact-mention parsers never touch it.
+ * Also converts pasted task permalinks into task mentions when
+ * `resolveTaskUrl` is configured; the pasted URL is matched against the
+ * site-provided `urlPattern` (or a legacy `?TID={id}` parameter).
+ */
+export declare const TaskMention: import('@tiptap/core').Node<TaskMentionOptions, any>;

package/library/packages/types/src/gallery-item.d.ts

@@ -30,6 +30,7 @@ export type GalleryItem = {
     header?: string;
     id: string;
     isClone?: boolean;
+    maxHeight?: string;
     maxWidth?: string;
     name?: string;
     objectFit?: ObjectFit;

package/library/packages/types/src/xml-editor.d.ts

@@ -37,7 +37,7 @@ export declare enum XmlEditorNotifyType {
  * as record keys and index-signature values across `TagMap`, `TagActionMap`, `AttributeDefaultValue`, and the tree
  * mutation helpers — an enum would force `String(Tag.X)` conversions at every one of those call sites.
  */
-export type XmlEditorTag = 'Ancestors' | 'Descendants' | 'DescendantsSeeThru' | 'ExtraFilters' | 'FetchRules' | 'Generation' | 'LexicallySimilar' | 'Limit' | 'OrderBy' | 'Packet' | 'Relation' | 'Relations' | 'SameFieldValue' | 'SemanticallySimilar' | 'Self' | 'TypeFilters';
+export type XmlEditorTag = 'Ancestors' | 'Descendants' | 'DescendantsSeeThru' | 'ExtraFilters' | 'FetchRules' | 'Generation' | 'LexicallySimilar' | 'Limit' | 'LinkedOrderProject' | 'OrderBy' | 'Packet' | 'Relation' | 'Relations' | 'SameFieldValue' | 'SemanticallySimilar' | 'Self' | 'TypeFilters';
 /** One Fetch Rules tree element (an `Element` node or a text leaf). */
 export type XmlEditorElement = {
     attributes?: {

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

@@ -33,3 +33,12 @@ export declare function getAttributes(attributes: NamedNodeMap): {
     [id: string]: string;
 };
 export declare function isElementInHorizontalView(container: HTMLElement, el: HTMLElement, offset?: number): boolean;
+/**
+ * How fresh the values behind this element's asset searches have to be, as configured server-side and
+ * stamped onto an ancestor.
+ *
+ * The front end cannot read Cortex parameters (that endpoint is restricted to OrangeLogic users, and a
+ * published page renders for anonymous visitors), so the value travels in the markup. Absent means "not
+ * configured" - the caller sends nothing and the Search API applies its own default, a consistent read.
+ */
+export declare const readSearchConsistency: (element: Element) => string | undefined;

package/library/react-web-component.d.ts

@@ -33,8 +33,8 @@
             export type CxAssetLinkFormatFocusMode = { auto: boolean; label: string; value: string; };
             export type CxAssetLinkFormatProxy = { cdnName: string; extension: string; formatHeight: number; formatWidth: number; height: number; id: string; permanentLink: string; proxyLabel: string; proxyName: string; width: number; };
             export type CxAssetLinkFormatTransformation = { key: 'Crop' | 'Metadata' | 'Proxy' | 'Quality' | 'Resize' | 'Rotate'; value: { disabledSize: boolean; focusMode: string; height: number; isFocusModeAuto: boolean; keepMetadata: boolean; mode: string; position: 'bottom-center' | 'bottom-left' | 'bottom-right' | 'center-center' | 'center-left' | 'center-right' | 'top-center' | 'top-left' | 'top-right'; quality: number; ratioHeight: number; ratioWidth: number; rotation: number; unit: '%' | 'px'; width: number; x: number; y: number; }; };
-            export type CxBentoGridGalleryItem = { additions: string[]; alt: string; cardType: 'asset' | 'folder' | 'link' | 'page' | 'space'; className: string; details: string; docType: '' | 'Album' | 'Audio' | 'Audio segment' | 'Image' | 'Multimedia' | 'ProjectDocument' | 'Story' | 'Video' | 'Widget'; extension: string; filler: boolean; header: string; id: string; isClone: boolean; maxWidth: string; name: string; objectFit: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down'; openInNewTab: boolean; pageId: string; rawId: string; size: string; src: string; srcset: string; url: string; };
-            export type CxCarouselGalleryItem = { additions: string[]; alt: string; cardType: 'asset' | 'folder' | 'link' | 'page' | 'space'; className: string; details: string; docType: '' | 'Album' | 'Audio' | 'Audio segment' | 'Image' | 'Multimedia' | 'ProjectDocument' | 'Story' | 'Video' | 'Widget'; extension: string; filler: boolean; header: string; id: string; isClone: boolean; maxWidth: string; name: string; objectFit: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down'; openInNewTab: boolean; pageId: string; rawId: string; size: string; src: string; srcset: string; url: string; };
+            export type CxBentoGridGalleryItem = { additions: string[]; alt: string; cardType: 'asset' | 'folder' | 'link' | 'page' | 'space'; className: string; details: string; docType: '' | 'Album' | 'Audio' | 'Audio segment' | 'Image' | 'Multimedia' | 'ProjectDocument' | 'Story' | 'Video' | 'Widget'; extension: string; filler: boolean; header: string; id: string; isClone: boolean; maxHeight: string; maxWidth: string; name: string; objectFit: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down'; openInNewTab: boolean; pageId: string; rawId: string; size: string; src: string; srcset: string; url: string; };
+            export type CxCarouselGalleryItem = { additions: string[]; alt: string; cardType: 'asset' | 'folder' | 'link' | 'page' | 'space'; className: string; details: string; docType: '' | 'Album' | 'Audio' | 'Audio segment' | 'Image' | 'Multimedia' | 'ProjectDocument' | 'Story' | 'Video' | 'Widget'; extension: string; filler: boolean; header: string; id: string; isClone: boolean; maxHeight: string; maxWidth: string; name: string; objectFit: 'contain' | 'cover' | 'fill' | 'none' | 'scale-down'; openInNewTab: boolean; pageId: string; rawId: string; size: string; src: string; srcset: string; url: string; };
             export type CxChatbotChatbotEvent = { event: string; excludedFromPurposes: string[]; label: string; };
             export type CxTableTimeFormatterParams = { color: string; fontSize: string; fontWeight: string; inputUnit: string; locale: string; placeholder: string; style: dictionary; unitsFormat: string; displayStyle: string; paramsMapField: string; paramsMap: dictionary; };
             export type CxTableTextFormatParams = { colorMap: dictionary; color: string; };
@@ -7774,6 +7774,34 @@
           * 
         */
         autocompletionViewstate?: string;
+        /**
+          * Query module name for the task mention autocomplete. Task mentions (and task permalink paste conversion) stay disabled while unset.
+        */
+        taskQueryName?: string;
+        /**
+          * Filter module name for the task mention autocomplete.
+        */
+        taskFilterName?: string;
+        /**
+          * Optional filter module name used only to resolve pasted task permalinks, expected to match the pasted identifier exactly (unlike `task-filter-name`, whose fuzzy conditions also match title substrings). While unset, paste resolution runs through `task-filter-name` and keeps only an exact identifier match from its results.
+        */
+        taskPasteFilterName?: string;
+        /**
+          * Minimum query length for the task mention autocomplete. Defaults to 0 so suggestions show as soon as the trigger character is typed.
+        */
+        taskMinQueryLength?: number;
+        /**
+          * The character that triggers the task mention autocomplete. Defaults to `#`.
+        */
+        taskTriggerChar?: string;
+        /**
+          * Format of the task mention chip text while composing, with `[IDENTIFIER]` and `[TITLE]` placeholders — the same template the host uses for the rendered mention links. Display-only: the mention is stored as the identifier alone, so the title never enters the saved comment body.
+        */
+        taskLabelTemplate?: string;
+        /**
+          * Regex source (case-insensitive, capture group 1 = identifier) matched against pasted same-origin URL paths to detect task links. Provided by the host, derived from the site's task URL template. While unset, only legacy `?TID={id}` links are detected on paste.
+        */
+        taskUrlPattern?: string;
         /**
           * 
         */
@@ -7904,6 +7932,34 @@
           * 
         */
         autocompletionViewstate?: string;
+        /**
+          * Query module name for the task mention autocomplete. Task mentions (and task permalink paste conversion) stay disabled while unset.
+        */
+        taskQueryName?: string;
+        /**
+          * Filter module name for the task mention autocomplete.
+        */
+        taskFilterName?: string;
+        /**
+          * Optional filter module name used only to resolve pasted task permalinks, expected to match the pasted identifier exactly (unlike `task-filter-name`, whose fuzzy conditions also match title substrings). While unset, paste resolution runs through `task-filter-name` and keeps only an exact identifier match from its results.
+        */
+        taskPasteFilterName?: string;
+        /**
+          * Minimum query length for the task mention autocomplete. Defaults to 0 so suggestions show as soon as the trigger character is typed.
+        */
+        taskMinQueryLength?: number;
+        /**
+          * The character that triggers the task mention autocomplete. Defaults to `#`.
+        */
+        taskTriggerChar?: string;
+        /**
+          * Format of the task mention chip text while composing, with `[IDENTIFIER]` and `[TITLE]` placeholders — the same template the host uses for the rendered mention links. Display-only: the mention is stored as the identifier alone, so the title never enters the saved comment body.
+        */
+        taskLabelTemplate?: string;
+        /**
+          * Regex source (case-insensitive, capture group 1 = identifier) matched against pasted same-origin URL paths to detect task links. Provided by the host, derived from the site's task URL template. While unset, only legacy `?TID={id}` links are detected on paste.
+        */
+        taskUrlPattern?: string;
         /**
           * 
         */
@@ -9240,6 +9296,34 @@
           * 
         */
         autocompletionViewstate?: string;
+        /**
+          * Query module name for the task mention autocomplete. Task mentions (and task permalink paste conversion) stay disabled while unset.
+        */
+        taskQueryName?: string;
+        /**
+          * Filter module name for the task mention autocomplete.
+        */
+        taskFilterName?: string;
+        /**
+          * Optional filter module name used only to resolve pasted task permalinks, expected to match the pasted identifier exactly (unlike `task-filter-name`, whose fuzzy conditions also match title substrings). While unset, paste resolution runs through `task-filter-name` and keeps only an exact identifier match from its results.
+        */
+        taskPasteFilterName?: string;
+        /**
+          * Minimum query length for the task mention autocomplete. Defaults to 0 so suggestions show as soon as the trigger character is typed.
+        */
+        taskMinQueryLength?: number;
+        /**
+          * The character that triggers the task mention autocomplete. Defaults to `#`.
+        */
+        taskTriggerChar?: string;
+        /**
+          * Format of the task mention chip text while composing, with `[IDENTIFIER]` and `[TITLE]` placeholders — the same template the host uses for the rendered mention links. Display-only: the mention is stored as the identifier alone, so the title never enters the saved comment body.
+        */
+        taskLabelTemplate?: string;
+        /**
+          * Regex source (case-insensitive, capture group 1 = identifier) matched against pasted same-origin URL paths to detect task links. Provided by the host, derived from the site's task URL template. While unset, only legacy `?TID={id}` links are detected on paste.
+        */
+        taskUrlPattern?: string;
         /**
           * 
         */