@orangelogic/orange-dam-content-browser-sdk 2.2.8 → 2.3.0

package/build/components/content-browser-format-dialog/content-browser-format-dialog.d.ts

@@ -0,0 +1,166 @@
+import { CSSResultGroup, TemplateResult } from 'lit';
+import CortexElement from '../../base/element';
+import { GetAvailableExtensionsResponse } from '../../api/asset/asset.types';
+import { Asset, AssetVersion, AvailableProxy } from '../../types/asset';
+import CxAssetLinkFormat from '@orangelogic/design-system/components/asset-link-format';
+import CxCropper from '@orangelogic/design-system/components/cropper';
+import CxDialog from '@orangelogic/design-system/components/dialog';
+import CxDrawer from '@orangelogic/design-system/components/drawer';
+import CxIconButton from '@orangelogic/design-system/components/icon-button';
+import CxLineClamp from '@orangelogic/design-system/components/line-clamp';
+import CxSpace from '@orangelogic/design-system/components/space';
+import CxSpinner from '@orangelogic/design-system/components/spinner';
+import CxTooltip from '@orangelogic/design-system/components/tooltip';
+import CxTypography from '@orangelogic/design-system/components/typography';
+import CxContentBrowserAssetPreview from '../content-browser-asset-preview/content-browser-asset-preview';
+import CxContentBrowserAssetProxySelector from '../content-browser-asset-proxy-selector/content-browser-asset-proxy-selector';
+import CxContentBrowserAssetVersionHistory from '../content-browser-asset-version-history/content-browser-asset-version-history';
+import { type Parameter, type Transformation, type CtaTextTransform, ContentBrowserFormatDialogVariant } from '../../types/content-browser';
+export default class CxContentBrowserFormatDialog extends CortexElement {
+    static readonly styles: CSSResultGroup;
+    static readonly dependencies: {
+        'cx-asset-link-format': typeof CxAssetLinkFormat;
+        'cx-cropper': typeof CxCropper;
+        'cx-content-browser-asset-preview': typeof CxContentBrowserAssetPreview;
+        'cx-content-browser-asset-proxy-selector': typeof CxContentBrowserAssetProxySelector;
+        'cx-content-browser-asset-version-history': typeof CxContentBrowserAssetVersionHistory;
+        'cx-dialog': typeof CxDialog;
+        'cx-drawer': typeof CxDrawer;
+        'cx-icon-button': typeof CxIconButton;
+        'cx-line-clamp': typeof CxLineClamp;
+        'cx-space': typeof CxSpace;
+        'cx-spinner': typeof CxSpinner;
+        'cx-tooltip': typeof CxTooltip;
+        'cx-typography': typeof CxTypography;
+    };
+    private readonly localize;
+    assetLinkFormat: CxAssetLinkFormat;
+    boundary: HTMLElement;
+    availableExtensions: GetAvailableExtensionsResponse | null;
+    supportedExtensions: string[];
+    supportedRepresentativeSubtypes: string[];
+    autoExtension: string;
+    ctaText: string;
+    ctaTextTransform: CtaTextTransform;
+    canCustomFormat: boolean;
+    canFavorite: boolean;
+    canPinAsset: boolean;
+    canTrack: boolean;
+    canUseProxies: boolean;
+    canViewVersions: boolean;
+    variant: ContentBrowserFormatDialogVariant;
+    loadingFavorites: boolean;
+    loadingPinAsset: boolean;
+    loadingProxies: boolean;
+    disabledConfirm: boolean;
+    token: string;
+    baseUrl: string;
+    asset: Asset & {
+        previewUrl: string;
+    } | undefined;
+    private isOpen;
+    isFavorite: boolean;
+    isAssetPinned: boolean;
+    proxies: AvailableProxy[];
+    showVersionHistory: boolean;
+    showCustomFormat: boolean;
+    loadingVersionHistory: boolean;
+    versions: AssetVersion[];
+    filteredProxies: AvailableProxy[];
+    selectedProxy: string;
+    /**
+     * The proxy id that was active right before switching into Custom Format mode.
+     * `selectedProxy` gets overwritten to `CUSTOM_FORMAT_VALUE` while the custom format panel is
+     * open, so this is what the embedded `cx-asset-link-format` panel's `selected-proxy` attribute
+     * is bound to — otherwise it always resolves to `undefined` and the panel silently defaults
+     * to `proxies[0]` instead of the proxy the user had actually selected (e.g. TRX).
+     */
+    private lastProxyBeforeCustomFormat;
+    confirmedTransformations: Transformation[];
+    confirmedFormat: {
+        width?: number | null;
+        height?: number | null;
+        extension?: string | null;
+    } | undefined;
+    loadingConfirm: boolean;
+    enabledTracking: boolean;
+    trackingParameters: Parameter[];
+    private get shouldAppendAutoExtension();
+    private get canUseATS();
+    handleSupportedExtensionsChange(): void;
+    open({ asset, isFavorite, isAssetPinned, proxies, }: {
+        asset: Asset & {
+            previewUrl: string;
+        };
+        isFavorite: boolean;
+        isAssetPinned?: boolean;
+        proxies: AvailableProxy[];
+    }): void;
+    hide(): void;
+    setVersionHistory(versions: AssetVersion[]): void;
+    setIsFavorite(isFavorite: boolean): void;
+    setIsAssetPinned(isAssetPinned: boolean): void;
+    setLoadingConfirm(loadingConfirm: boolean): void;
+    mapFormatConfirmPayload(asset: Asset, selectedProxy?: AvailableProxy): {
+        asset: Asset;
+        extension: string;
+        parameters: Parameter[] | undefined;
+        proxyPreference: string;
+        sourceProxyMetadata: {
+            cdnName: string | null;
+            extension: string | null;
+            height: number | null;
+            isCustomFormat: null;
+            permanentLink: string | null;
+            proxyLabel: string | null;
+            proxyName: string | null;
+            width: number | null;
+        };
+        transformations: Transformation[];
+        transformedAssetMetadata: {
+            extension: string | null;
+            height: number | null;
+            isCustomFormat: boolean;
+            permanentLink: null;
+            width: number | null;
+        };
+    };
+    mapProxyConfirmPayload(asset: Asset, selectedProxy?: AvailableProxy): {
+        asset: Asset;
+        extension: string;
+        parameters: Parameter[] | undefined;
+        permanentLink: string | undefined;
+        proxyPreference: string;
+        selectedProxyMetadata: {
+            cdnName: string | null;
+            extension: string | null;
+            height: number | null;
+            isCustomFormat: boolean;
+            permanentLink: string | null;
+            proxyLabel: string | null;
+            proxyName: string | null;
+            width: number | null;
+        };
+        useRepresentative: boolean;
+    };
+    private handleCancelCustomFormat;
+    private handleDoneCustomFormat;
+    private handleFavorite;
+    private handlePinAsset;
+    private handleProxyConfirm;
+    private handleVersionHistory;
+    private handleProxySelect;
+    private handleTrackingParametersChange;
+    private renderHeader;
+    private renderBody;
+    private renderFooter;
+    private renderContent;
+    private handleRequestClose;
+    private handleClose;
+    render(): TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'cx-content-browser-format-dialog': CxContentBrowserFormatDialog;
+    }
+}

package/build/components/content-browser-format-dialog/content-browser-format-dialog.styles.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("lit").CSSResult;
+export default _default;

package/build/components/content-browser-grid/content-browser-grid.d.ts

@@ -0,0 +1,53 @@
+import '@lit-labs/virtualizer';
+import CortexElement from '../../base/element';
+import { Asset } from '../../types/asset';
+import { GridView } from '../../types/content-browser';
+import CxProgressBar from '@orangelogic/design-system/components/progress-bar';
+import CxResizeObserver from '@orangelogic/design-system/components/resize-observer';
+import CxContentBrowserAssetCard from '../content-browser-asset-card/content-browser-asset-card';
+import CxContentBrowserNoResult from '../content-browser-no-result/content-browser-no-result';
+import type { CSSResultGroup } from 'lit';
+export default class CxContentBrowserGrid extends CortexElement {
+    #private;
+    static readonly styles: CSSResultGroup;
+    static readonly dependencies: {
+        'cx-content-browser-asset-card': typeof CxContentBrowserAssetCard;
+        'cx-content-browser-no-result': typeof CxContentBrowserNoResult;
+        'cx-progress-bar': typeof CxProgressBar;
+        'cx-resize-observer': typeof CxResizeObserver;
+    };
+    private readonly localize;
+    private readonly containerEl;
+    private readonly virtualizerEl;
+    assets: Asset[];
+    empty: boolean;
+    view: GridView;
+    hasMore: boolean;
+    loading: boolean;
+    showTitle: boolean;
+    showSize: boolean;
+    showDimensions: boolean;
+    showTags: boolean;
+    selectedAssetId: string | undefined;
+    assetMap: Map<string, Asset>;
+    columnWidth: number;
+    private readonly scrollAnchorController;
+    constructor();
+    handleViewChange(): void;
+    handleAssetsChange(): void;
+    private handleResize;
+    private readonly debouncedCalculatePageSize;
+    private calculatePageSize;
+    private calculateColumnCount;
+    private handleClick;
+    private renderItem;
+    private handleScroll;
+    private readonly debouncedHandleScrollEnd;
+    private handleScrollEnd;
+    render(): import("lit-html").TemplateResult<1>;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'cx-content-browser-grid': CxContentBrowserGrid;
+    }
+}

package/build/components/content-browser-grid/content-browser-grid.styles.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("lit").CSSResult;
+export default _default;

package/build/components/content-browser-grid/scroll-anchor-controller.d.ts

@@ -0,0 +1,27 @@
+import type { ReactiveController, ReactiveControllerHost } from 'lit';
+type ScrollAnchorContainer = HTMLElement & {
+    layoutComplete?: Promise<unknown>;
+};
+type ScrollAnchorControllerOptions = {
+    getContainer: () => ScrollAnchorContainer | undefined;
+    getItemIndexById: (id: string) => number;
+    itemSelector: string;
+};
+export default class ScrollAnchorController implements ReactiveController {
+    #private;
+    constructor(host: ReactiveControllerHost & {
+        updateComplete: Promise<unknown>;
+    }, options: ScrollAnchorControllerOptions);
+    capture(container?: ScrollAnchorContainer | undefined): void;
+    setLayoutMetrics(options: {
+        columnCount: number;
+        itemHeight: number;
+    }): void;
+    scheduleRestore(): void;
+    restore(): void;
+    private getAnchorRowTop;
+    hostDisconnected(): void;
+    private cancelPendingRestore;
+    private scrollTo;
+}
+export {};

package/build/components/content-browser-header/content-browser-header.d.ts

@@ -0,0 +1,65 @@
+import CxAvatar from '@orangelogic/design-system/components/avatar';
+import CxDivider from '@orangelogic/design-system/components/divider';
+import CxDropdown from '@orangelogic/design-system/components/dropdown';
+import CxIcon from '@orangelogic/design-system/components/icon';
+import CxIconButton from '@orangelogic/design-system/components/icon-button';
+import CxLineClamp from '@orangelogic/design-system/components/line-clamp';
+import CxMenu from '@orangelogic/design-system/components/menu';
+import CxMenuItem from '@orangelogic/design-system/components/menu-item';
+import CxSkeleton from '@orangelogic/design-system/components/skeleton';
+import CxSpace from '@orangelogic/design-system/components/space';
+import CxTypography from '@orangelogic/design-system/components/typography';
+import CortexElement from '../../base/element';
+import type { CSSResultGroup, TemplateResult } from 'lit';
+/**
+ * @summary DAM view header. Converted from ContentBrowserSDK Header React component.
+ *
+ * @event cx-content-browser-header-close - Emitted when the close button is clicked (when shown in popup).
+ * @event cx-content-browser-header-logout - Emitted when the user selects logout.
+ */
+export default class CxContentBrowserHeader extends CortexElement {
+    static readonly styles: CSSResultGroup;
+    static readonly dependencies: {
+        'cx-avatar': typeof CxAvatar;
+        'cx-divider': typeof CxDivider;
+        'cx-dropdown': typeof CxDropdown;
+        'cx-icon': typeof CxIcon;
+        'cx-icon-button': typeof CxIconButton;
+        'cx-line-clamp': typeof CxLineClamp;
+        'cx-menu': typeof CxMenu;
+        'cx-menu-item': typeof CxMenuItem;
+        'cx-skeleton': typeof CxSkeleton;
+        'cx-space': typeof CxSpace;
+        'cx-typography': typeof CxTypography;
+    };
+    private readonly localize;
+    bordered: boolean;
+    /**
+     * Application name shown when no folder is selected.
+     */
+    applicationName: string;
+    loading: boolean;
+    isFetching: boolean;
+    avatar: string;
+    fullName: string;
+    folderTitle: string;
+    /**
+     * When true, show the close button (e.g. when content browser is in a popup).
+     */
+    showCloseButton: boolean;
+    /**
+     * When true, show logout option in user dropdown.
+     */
+    canLogout: boolean;
+    get isLoading(): boolean;
+    private handleCloseClick;
+    private handleMenuSelect;
+    private renderTitle;
+    private renderUserDropdown;
+    render(): TemplateResult;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'cx-content-browser-header': CxContentBrowserHeader;
+    }
+}

package/build/components/content-browser-header/content-browser-header.styles.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("lit").CSSResult;
+export default _default;

package/build/components/content-browser-loader/content-browser-loader.d.ts

@@ -0,0 +1,25 @@
+import CxButton from '@orangelogic/design-system/components/button';
+import CxSpace from '@orangelogic/design-system/components/space';
+import CxSpinner from '@orangelogic/design-system/components/spinner';
+import CxTypography from '@orangelogic/design-system/components/typography';
+import { TemplateResult } from 'lit';
+import CortexElement from '../../base/element';
+import type { CSSResultGroup } from 'lit';
+export declare const MESSAGE_NEW_LINE = "\n";
+export default class CxContentBrowserLoader extends CortexElement {
+    static readonly styles: CSSResultGroup;
+    static readonly dependencies: {
+        'cx-button': typeof CxButton;
+        'cx-space': typeof CxSpace;
+        'cx-spinner': typeof CxSpinner;
+        'cx-typography': typeof CxTypography;
+    };
+    message: string;
+    private renderMessageLines;
+    render(): TemplateResult;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'cx-content-browser-loader': CxContentBrowserLoader;
+    }
+}

package/build/components/content-browser-loader/content-browser-loader.styles.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("lit").CSSResult;
+export default _default;

package/build/components/content-browser-loader/index.d.ts

@@ -0,0 +1 @@
+export { default } from './content-browser-loader';

package/build/components/content-browser-no-result/content-browser-no-result.d.ts

@@ -0,0 +1,18 @@
+import CxIcon from '@orangelogic/design-system/components/icon';
+import { TemplateResult } from 'lit';
+import CortexElement from '../../base/element';
+import type { CSSResultGroup } from 'lit';
+export default class CxContentBrowserNoResult extends CortexElement {
+    static readonly styles: CSSResultGroup;
+    static readonly dependencies: {
+        'cx-icon': typeof CxIcon;
+    };
+    icon: string;
+    message: string;
+    render(): TemplateResult;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'cx-content-browser-no-result': CxContentBrowserNoResult;
+    }
+}

package/build/components/content-browser-no-result/content-browser-no-result.styles.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("lit").CSSResult;
+export default _default;

package/build/components/content-browser-no-result/index.d.ts

@@ -0,0 +1 @@
+export { default } from './content-browser-no-result';

package/build/content-browser.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Subpath entry: `import CxContentBrowser from '@orangelogic/orange-dam-content-browser-sdk/content-browser'`.
+ * Skips the full Content Browser React bundle and global styles from `index.tsx`.
+ */
+export { default } from './components/content-browser/content-browser';
+export { default as CxContentBrowser } from './components/content-browser/content-browser';
+export { COMPUTED_FIELDS } from './components/content-browser/content-browser';