@cesdk/cesdk-js 1.7.0 → 1.8.0-alpha.0

package/index.d.ts

@@ -23,7 +23,7 @@ export declare class API {
  * Generic asset information
  * @public
  */
-declare interface Asset {
+export declare interface Asset {
     /**
      *  Is a combination of source id, extension pack id (optional), type and asset id
      *  e.g. "extension://ly.img.cesdk.images.samples/ly.img.image/sample.1"
@@ -53,7 +53,7 @@ export declare class AssetAPI {
      * Adds a custom asset source. Its ID has to be unique.
      * @param source - The asset source.
      */
-    addSource(source: AssetSource_2): void;
+    addSource(source: AssetSource): void;
     /**
      * Removes an asset source with the given ID.
      * @param id - The ID to refer to the asset source.
@@ -70,7 +70,7 @@ export declare class AssetAPI {
      * @param query - All the options to filter the search results by.
      * @returns The search results.
      */
-    findAssets(sourceId: string, query: AssetQueryData): Promise<AssetsQueryResult_2>;
+    findAssets(sourceId: string, query: AssetQueryData): Promise<AssetsQueryResult>;
     /**
      * Queries the asset source's groups for a certain asset type.
      * @param id - The ID of the asset source.
@@ -96,6 +96,8 @@ export declare class AssetAPI {
         url: string | undefined;
     } | undefined;
     canManageAssets(sourceId: string): boolean;
+
+
     /**
      * Apply an asset result to the active scene.
      * The default behavior will instantiate a block and configure it according to the asset's properties.
@@ -103,14 +105,20 @@ export declare class AssetAPI {
      * @param sourceId - The ID of the asset source.
      * @param assetResult - A single assetResult of a `findAssets` query.
      */
-    apply(sourceId: string, assetResult: AssetResult_2): Promise<void>;
+    apply(sourceId: string, assetResult: AssetResult): Promise<void>;
+    /**
+     * The default implementation for applying an asset to the scene.
+     * This implementation is used when no `applyAsset` function is provided to `addSource`.
+     * @param assetResult - A single assetResult of a `findAssets` query.
+     */
+    defaultApplyAsset(assetResult: AssetResult): Promise<void>;
 }
 
 /**
  * Definition of an assets used if an asset is added to an asset source.
  * @public
  */
-declare interface AssetDefinition extends Asset {
+export declare interface AssetDefinition extends Asset {
     /**
      * Label used to display in aria-label and as a tooltip.
      * Will be also searched in a query and should be localized
@@ -189,22 +197,22 @@ declare interface AssetLibraryEntryView {
     /**
      * Overwrite the label of a card for a specific asset result
      */
-    cardLabel?: (assetResult: AssetResult_2) => string | undefined;
+    cardLabel?: (assetResult: AssetResult) => string | undefined;
     /**
      * Add custom styles to a card for a specific asset result
      */
-    cardStyle?: (assetResult: AssetResult_2) => Record<string, string | undefined>;
+    cardStyle?: (assetResult: AssetResult) => Record<string, string | undefined>;
     /**
      * Add custom styles to a label for a specific asset result
      */
-    cardLabelStyle?: (assetResult: AssetResult_2) => Record<string, string | undefined>;
+    cardLabelStyle?: (assetResult: AssetResult) => Record<string, string | undefined>;
 }
 
 /**
  * Defines a request for querying assets
  * @public
  */
-declare interface AssetQueryData {
+export declare interface AssetQueryData {
     /** A query string used for (fuzzy) searching of labels and tags */
     query?: string;
     /** The current page queried for paginated views. */
@@ -234,7 +242,36 @@ declare interface AssetQueryData {
  * Single asset result of a query from the engine.
  * @public
  */
-declare interface AssetResult {
+export declare interface AssetResult extends Asset {
+    /** The locale of the label and tags */
+    locale?: Locale;
+    /** The label of the result. Used for description and tooltips. */
+    label?: string;
+    /** The tags of this asset. Used for filtering and free-text searching. */
+    tags?: string[];
+
+    /** Credits for the artist of the asset */
+    credits?: {
+        name: string;
+        url?: string;
+    };
+    /** License for this asset. Overwrites the source license if present */
+    license?: {
+        name: string;
+        url?: string;
+    };
+    /** UTM parameters for the links inside the credits */
+    utm?: {
+        source?: string;
+        medium?: string;
+    };
+}
+
+/**
+ * Single asset result of a query from the engine.
+ * @public
+ */
+declare interface AssetResult_2 {
     /** A unique id of this asset */
     id: string;
     /** URI to a thumbnail of the asset used e.g. in the content library UI */
@@ -270,84 +307,21 @@ declare interface AssetResult {
     };
 }
 
-/**
- * Single asset result of a query from the engine.
- * @public
- */
-declare interface AssetResult_2 extends Asset {
-    /** The locale of the label and tags */
-    locale?: Locale;
-    /** The label of the result. Used for description and tooltips. */
-    label?: string;
-    /** The tags of this asset. Used for filtering and free-text searching. */
-    tags?: string[];
-
-    /** Credits for the artist of the asset */
-    credits?: {
-        name: string;
-        url?: string;
-    };
-    /** License for this asset. Overwrites the source license if present */
-    license?: {
-        name: string;
-        url?: string;
-    };
-    /** UTM parameters for the links inside the credits */
-    utm?: {
-        source?: string;
-        medium?: string;
-    };
-}
-
 /** @public */
 declare interface AssetResultContext {
     sourceId: string;
     createdByRole: string;
 }
 
-/**
- * API to query for assets
- * @public
- */
-declare interface AssetSource {
-    /** Find all asset for the given type and the provided query data.  */
-    findAssets(queryData?: QueryData): Promise<AssetsQueryResult | undefined>;
-    /**
-     * Apply the given asset result to the active scene.
-     * You can override this with custom behavior.
-     */
-    applyAsset?: (asset: AssetResult) => Promise<void>;
-    /** Return every available group */
-    getGroups?: () => Promise<string[]>;
-    /**
-     * Indicates if the asset shall be downloaded to handle the raw data instead
-     * of an URL reference. Do this if you do not want to depend on
-     * a service after adding the asset to the scene. If this is your own API
-     * with your own service, you do not need to set this and avoid downloading /
-     * re-uploading the assets.
-     */
-    downloadAssets?: (asset: AssetResult) => Promise<Blob>;
-    /** Credits for the source/api */
-    credits?: {
-        name: string;
-        url?: string;
-    };
-    /** General license for all asset from this source */
-    license?: {
-        name: string;
-        url?: string;
-    };
-}
-
 /**
  * A source of assets
  * @public
  */
-declare interface AssetSource_2 {
+export declare interface AssetSource {
     /** The unique id of the API */
     id: string;
     /** Find all asset for the given type and the provided query data.  */
-    findAssets(queryData: AssetQueryData): Promise<AssetsQueryResult_2>;
+    findAssets(queryData: AssetQueryData): Promise<AssetsQueryResult>;
     /** Return every available group */
     getGroups?: () => Promise<string[]>;
     /** Credits for the source/api */
@@ -367,11 +341,11 @@ declare interface AssetSource_2 {
      * with your own service, you do not need to set this and avoid downloading /
      * re-uploading the assets.
      */
-    downloadAssets?: (asset: AssetResult_2) => Promise<Blob>;
+    downloadAssets?: (asset: AssetResult) => Promise<Blob>;
     /**
      * @returns the asset or undefined if no asset with the given id could be found
      */
-    getAsset(id: string): Promise<AssetResult_2 | undefined>;
+    getAsset?(id: string): Promise<AssetResult | undefined>;
     /**
      * Can the source add, update and remove assets dynamically? If `false`
      * methods like `addAsset` `updateAsset` and `removeAsset` will throw an
@@ -382,39 +356,73 @@ declare interface AssetSource_2 {
      * Apply the given asset result to the active scene.
      * You can override this with custom behavior.
      */
-    applyAsset?: (asset: AssetResult_2) => Promise<void>;
+    applyAsset?: (asset: AssetResult) => Promise<void>;
     /**
      * Adds the given asset to this source. Throws an error if `canManageAssets`
      * is `false`.
      *
      * @returns the id of the added asset
      */
-    addAsset(asset: AssetDefinition): Promise<string>;
+    addAsset?(asset: AssetDefinition): Promise<string>;
     /**
      * Updates the asset of this source. Throws an error if `canManageAssets`
      * is `false` or no asset with the given id could not be found.
      *
      * @returns the id of the added asset
      */
-    updateAsset(assetId: string, asset: AssetDefinition): Promise<void>;
+    updateAsset?(assetId: string, asset: AssetDefinition): Promise<void>;
     /**
      * Removes the given asset from this source.
      *
      * @returns true if asset was found and removed, and false otherwise
      */
-    removeAsset(assetId: string): Promise<boolean>;
+    removeAsset?(assetId: string): Promise<boolean>;
+}
+
+/**
+ * API to query for assets
+ * @public
+ */
+declare interface AssetSource_2 {
+    /** Find all asset for the given type and the provided query data.  */
+    findAssets(queryData?: QueryData): Promise<AssetsQueryResult_2 | undefined>;
+    /**
+     * Apply the given asset result to the active scene.
+     * You can override this with custom behavior.
+     */
+    applyAsset?: (asset: AssetResult_2) => Promise<void>;
+    /** Return every available group */
+    getGroups?: () => Promise<string[]>;
+    /**
+     * Indicates if the asset shall be downloaded to handle the raw data instead
+     * of an URL reference. Do this if you do not want to depend on
+     * a service after adding the asset to the scene. If this is your own API
+     * with your own service, you do not need to set this and avoid downloading /
+     * re-uploading the assets.
+     */
+    downloadAssets?: (asset: AssetResult_2) => Promise<Blob>;
+    /** Credits for the source/api */
+    credits?: {
+        name: string;
+        url?: string;
+    };
+    /** General license for all asset from this source */
+    license?: {
+        name: string;
+        url?: string;
+    };
 }
 
 /** @public */
 declare type AssetSources = {
-    [id: string]: AssetSource;
+    [id: string]: AssetSource_2;
 };
 
 /**
  * Return type of a `findAssets` query.
  * @public
  */
-declare interface AssetsQueryResult {
+export declare interface AssetsQueryResult {
     /** The assets in the requested page */
     assets: AssetResult[];
     /** The current, requested page */
@@ -461,9 +469,6 @@ declare interface BleedMarginOptions {
  */
 export declare type BlendMode = 'PassThrough' | 'Normal' | 'Darken' | 'Multiply' | 'ColorBurn' | 'Lighten' | 'Screen' | 'ColorDodge' | 'Overlay' | 'SoftLight' | 'HardLight' | 'Difference' | 'Exclusion' | 'Hue' | 'Saturation' | 'Color' | 'Luminosity';
 
-/** @public */
-declare type Block = number;
-
 /**
  * @public
  */
@@ -478,7 +483,7 @@ export declare class BlockAPI {
      * @param options - The options for exporting the block type
      * @returns A promise that resolves with the exported image or is rejected with an error.
      */
-    export(handle: DesignBlockId, mimeType?: MimeType_2, options?: ExportOptions_2): Promise<Blob>;
+    export(handle: DesignBlockId, mimeType?: MimeType_2, options?: EngineExportOptions): Promise<Blob>;
 
     /**
      * Loads existing blocks from the given string.
@@ -1713,17 +1718,9 @@ export declare class BlockAPI {
     isAllowedByScope(id: DesignBlockId, key: string): boolean;
 }
 
-/**
- * @public
- */
-export declare type BlockEvent = {
-    block: DesignBlockId;
-    type: 'Created' | 'Updated' | 'Destroyed';
-};
-
 /** @public */
-declare interface BlockEvent_2 {
-    block: Block;
+export declare interface BlockEvent {
+    block: DesignBlockId;
     type: 'Created' | 'Updated' | 'Destroyed';
 }
 
@@ -2140,6 +2137,13 @@ export declare class EditorAPI {
      * @param resolver - Custom resolution function.
      */
     setURIResolver(resolver: (URI: string) => string): void;
+    /**
+     * This is the default implementation for the URI resolver.
+     * It resolves the given path relative to the `ubq://basePath` setting.
+     * @param relativePath - The relative path that should be resolved.
+     * @returns The resolved absolute URI.
+     */
+    defaultURIResolver(relativePath: string): string;
     /**
      * Resolves the given path.
      * If a custom resolver has been set with `setURIResolver`, it invokes it with the given path.
@@ -2168,9 +2172,9 @@ declare namespace _EngineConfigTypes {
         HexColorString,
         Color,
         AssetSources,
-        AssetSource,
-        AssetResult,
-        AssetsQueryResult,
+        AssetSource_2 as AssetSource,
+        AssetResult_2 as AssetResult,
+        AssetsQueryResult_2 as AssetsQueryResult,
         QueryData,
         Preset,
         VariableDefinition,
@@ -2219,33 +2223,7 @@ export declare interface _EngineConfiguration {
 /**
  * @public
  */
-export declare class EventAPI {
-    #private;
-
-    /**
-     * Subscribe to block life-cycle events.
-     * @param blocks - A list of blocks to filter events by. If the list is empty, events for every block are sent.
-     * @param callback - The event callback. Events are bundled and sent at the end of each engine update.
-     * @returns A method to unsubscribe.
-     */
-    subscribe(blocks: DesignBlockId[], callback: (events: BlockEvent[]) => void): () => void;
-}
-
-/** @public */
-declare type ExportFormat = 'image/png' | 'video/mp4' | 'application/pdf';
-
-/** @public */
-export declare interface ExportOptions extends Pick<ExportOptions_2, 'pngCompressionLevel' | 'jpegQuality'> {
-    /** The mime type of the exported blob */
-    mimeType: MimeType_2;
-    /** The pages to export with the selected page as the default */
-    pages?: number[];
-}
-
-/**
- * @public
- */
-declare type ExportOptions_2 = {
+export declare type EngineExportOptions = {
     /**
      * The PNG compression level to use, when exporting to PNG.
      *
@@ -2276,15 +2254,48 @@ declare type ExportOptions_2 = {
      * size entirely while maintaining its aspect ratio.
      */
     targetHeight?: number;
+    /**
+     * Export the PDF document with a higher compatibility to different PDF viewers.
+     * Bitmap images and some effects like gradients will be rasterized with the DPI
+     * setting instead of embedding them directly.
+     */
+    exportPdfWithHighCompatibility?: boolean;
 };
 
+/**
+ * @public
+ */
+export declare class EventAPI {
+    #private;
+
+    /**
+     * Subscribe to block life-cycle events.
+     * @param blocks - A list of blocks to filter events by. If the list is empty, events for every block are sent.
+     * @param callback - The event callback. Events are bundled and sent at the end of each engine update.
+     * @returns A method to unsubscribe.
+     */
+    subscribe(blocks: DesignBlockId[], callback: (events: BlockEvent[]) => void): () => void;
+}
+
+/** @public */
+declare type ExportFormat = 'image/png' | 'video/mp4' | 'application/pdf';
+
+/** @public */
+export declare interface ExportOptions extends Pick<EngineExportOptions, 'pngCompressionLevel' | 'jpegQuality' | 'exportPdfWithHighCompatibility'> {
+    /** The mime type of the exported blob */
+    mimeType: MimeType_2;
+    /** The pages to export with the selected page as the default */
+    pages?: number[];
+}
+
 /** @public */
-declare interface ExportOptions_3 {
+declare interface ExportOptions_2 {
     jpegQuality: number;
     pngCompressionLevel: number;
     useTargetSize: boolean;
     targetWidth: number;
     targetHeight: number;
+    exportPdfWithHighCompatibility: boolean;
 }
 
 /** @public */
@@ -2480,6 +2491,7 @@ declare type PageFormatDefinition = Preset & {
     unit: DesignUnit;
     dpi?: number;
     bleedMargin?: number;
+    fixedOrientation?: boolean;
 };
 
 /** @public */
@@ -2807,6 +2819,7 @@ export declare interface UserInterface {
 
 /** @public */
 declare interface UserInterfaceAssetLibrary extends UserInterfaceElement {
+    position?: PanelPosition;
 }
 
 /** @public */
@@ -2831,6 +2844,7 @@ declare namespace UserInterfaceElements {
         UserInterfaceElement,
         UserInterfaceInspectorBlocks,
         UserInterfaceInspectorBlock,
+        UserInterfaceInspectorBlockPage,
         UserInterfaceInspectorBlockText,
         UserInterfaceInspectorBlockImage,
         UserInterfaceInspector,
@@ -2912,12 +2926,19 @@ declare interface UserInterfaceInspectorBlockImage extends UserInterfaceInspecto
     blur?: UserInterfaceElement | boolean;
 }
 
+/** @public */
+declare interface UserInterfaceInspectorBlockPage extends UserInterfaceInspectorBlock {
+    format?: UserInterfaceElement | boolean;
+    manage?: UserInterfaceElement | boolean;
+}
+
 /** @public */
 declare interface UserInterfaceInspectorBlocks {
     opacity?: UserInterfaceElement | boolean;
     transform?: UserInterfaceElement | boolean;
     '//ly.img.ubq/image'?: UserInterfaceInspectorBlockImage;
     '//ly.img.ubq/text'?: UserInterfaceInspectorBlockText;
+    '//ly.img.ubq/page'?: UserInterfaceInspectorBlockPage;
 }
 
 /** @public */

package/index.html

@@ -32,11 +32,7 @@
             },
             ui: {
               elements: {
-                view: {
-                  adopter: {
-                    style: 'default'
-                  }
-                },
+              view: 'default',
                 panels: {
                   settings: true
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cesdk/cesdk-js",
-  "version": "1.7.0",
+  "version": "1.8.0-alpha.0",
   "main": "./cesdk.umd.js",
   "types": "./index.d.ts",
   "homepage": "https://www.img.ly",