@orangelogic/design-system 2.96.0 → 2.98.0

package/library/packages/types/src/content-builder.d.ts

@@ -40,6 +40,32 @@ export type PropertyConfig<T = Record<string, any>> = Omit<TraitProperties, 'opt
      * It is called right before the record is saved.
      */
     api?: () => Promise<Option[]> | FolderSelectApi;
+    assetFormatPickerConfigs?: {
+        /** The block-attribute key that holds the asset ID. */
+        assetIdKey?: string;
+        /** The block-attribute key that stores the selected asset version. Defaults to 'asset-version'. */
+        assetVersionKey?: string;
+        /** The block-attribute key that stores the human-readable format label. Defaults to 'format-label'. */
+        formatLabelKey?: string;
+        /** The block-attribute key that stores the resolved asset source URL. Defaults to 'format-src'. */
+        formatSrcKey?: string;
+        /** The block-attribute key that stores the human-readable version label. Defaults to 'version-label'. */
+        versionLabelKey?: string;
+    };
+    assetTransformationConfigs?: {
+        assetIdKey?: string;
+        defaultFormat?: string;
+        dialogLabel?: string;
+        formatKey?: string;
+        multiple?: boolean;
+        noCrop?: boolean;
+        noResize?: boolean;
+        noRotate?: boolean;
+        /** The block-attribute key that stores the gallery records array to bulk-resolve src URLs after a format change. */
+        recordsKey?: string;
+        /** The block-attribute key that stores the resolved image source URL. */
+        srcKey?: string;
+    };
     callback?: (params: {
         extraValue?: Record<string, unknown>;
         record: T;
@@ -48,7 +74,7 @@ export type PropertyConfig<T = Record<string, any>> = Omit<TraitProperties, 'opt
     checkedValue?: string | boolean;
     children?: PropertyConfig[];
     clearable?: boolean;
-    controlType: 'bicolor-picker' | 'border-input-group' | 'button-group' | 'checkbox' | 'checkbox-group' | 'color-swatch-picker' | 'corner-position-input-group' | 'download-format-picker' | 'file' | 'folder-picker' | 'gallery-picker' | 'group' | 'group-heading' | 'icon-picker' | 'image-picker' | 'input' | 'list-editor' | 'all-picker' | 'other-picker' | 'padding-input-group' | 'page-picker' | 'placeholder' | 'position-picker' | 'radio-card-group' | 'radio-group' | 'select' | 'shadow-input-group' | 'size-input-group' | 'switch' | 'table' | 'text' | 'video-picker';
+    controlType: 'asset-transformation' | 'bicolor-picker' | 'border-input-group' | 'button-group' | 'checkbox' | 'checkbox-group' | 'color-swatch-picker' | 'corner-position-input-group' | 'download-format-picker' | 'file' | 'folder-picker' | 'gallery-picker' | 'group' | 'group-heading' | 'icon-picker' | 'image-picker' | 'input' | 'list-editor' | 'all-picker' | 'other-picker' | 'padding-input-group' | 'page-picker' | 'placeholder' | 'position-picker' | 'radio-card-group' | 'radio-group' | 'select' | 'shadow-input-group' | 'size-input-group' | 'switch' | 'table' | 'text' | 'asset-format-picker' | 'video-picker';
     cornerStyleKey?: {
         offsetX: string;
         offsetY: string;
@@ -57,13 +83,20 @@ export type PropertyConfig<T = Record<string, any>> = Omit<TraitProperties, 'opt
     disabled?: boolean | ((record: Record<string, unknown>) => boolean);
     disabledTooltip?: string;
     downloadFormatPickerConfigs?: {
+        allowDocTypes?: string[];
         assetIdsKey?: string;
+        isObjectFormat?: boolean;
+        objectIdKey?: string;
     };
     folderPickerConfigs?: {
         useFullPath: boolean;
     };
     galleryPickerConfigs?: {
         dialog: DialogType;
+        /** The block-attribute key for the format used to resolve records' src URLs after picking. */
+        formatKey?: string;
+        transformationRecordIdKey?: string;
+        transformationsKey?: string;
     };
     groupConfigs?: {
         columnGap?: string;
@@ -274,3 +307,6 @@ export declare enum DataSourceId {
     TranslatableAttributes = "TRANSLATABLE_ATTRIBUTES",
     TranslatableTexts = "TRANSLATABLE_TEXTS"
 }
+export type ConfigsOptions = {
+    enableAssetFormatControls?: boolean;
+};

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

@@ -26,12 +26,6 @@ export declare enum ContentType {
     Automatic = "automatic",
     Custom = "custom"
 }
-export declare enum ClickEvent {
-    DoNothing = "do-nothing",
-    OpenAssetInLibrary = "open-asset-in-library",
-    OpenAssetOverview = "open-asset-overview",
-    Zoom = "zoom"
-}
 export type GalleryRecord = {
     id: string;
     objectFit: ObjectFit;

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

@@ -82,6 +82,7 @@ export interface Translation extends DefaultTranslation {
     aside: string;
     aspectRatio: string;
     asset: string;
+    assetFormat: string;
     assetInColdStorage: string;
     assetIndexSync: string;
     assetPreview: string;
@@ -223,6 +224,7 @@ export interface Translation extends DefaultTranslation {
     customWidth: string;
     cut: string;
     damViewNoAvailableOptionsForThisAsset: string;
+    darkImageFormat: string;
     darkModeImage: string;
     dashSpacing: string;
     dashWidth: string;
@@ -265,6 +267,7 @@ export interface Translation extends DefaultTranslation {
     downloadButton: string;
     downloadCompleted: string;
     downloadFailed: string;
+    downloadFormat: string;
     downloadLocationNoLongerExists: (location: string) => string;
     downloadManager: string;
     downloadNewVersion: string;
@@ -406,6 +409,7 @@ export interface Translation extends DefaultTranslation {
     imageSource: string;
     imageSourceInfo: (w: string, h: string, r: string) => string;
     imageUploadStarted: string;
+    imagesFormat: string;
     import: string;
     importTextFile: string;
     importTextFileDialogConfirm: string;
@@ -768,6 +772,7 @@ export interface Translation extends DefaultTranslation {
     thickness: string;
     thousandsSeparator: string;
     thumbnail: string;
+    thumbnailFormat: string;
     thumbnailHelpText: string;
     timeBased: string;
     timeFormat: string;
@@ -830,6 +835,7 @@ export interface Translation extends DefaultTranslation {
     video: string;
     videoChaptersEmptyPlaceholder: string;
     videoContent: string;
+    videoFormat: string;
     videoPlayer: string;
     videoPoster: string;
     videoSource: string;

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

@@ -42,5 +42,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

@@ -151,4 +151,5 @@ 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;
 export declare function parseBooleanString(boolString: string | null | undefined): boolean;

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

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