@cesdk/engine 1.63.0-rc.0 → 1.63.0-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -5827,6 +5827,11 @@ export declare function _createTrackedProperty<T, U = any>(getter: () => T, sett
5827
5827
  */
5828
5828
  declare class CreativeEngine {
5829
5829
  #private;
5830
+ /**
5831
+ * The version of the CE.SDK package.
5832
+ * @category Engine Management
5833
+ */
5834
+ static readonly version: string;
5830
5835
  /**
5831
5836
  * Manage and interact with assets in the engine.
5832
5837
  * @category Core APIs
@@ -5945,8 +5950,8 @@ declare class CreativeEngine {
5945
5950
  * - `'ly.img.filter.lut'` - LUT effects of various kinds
5946
5951
  * - `'ly.img.filter.duotone'` - Color effects of various kinds
5947
5952
  *
5948
- * These assets are parsed from the IMG.LY CDN at `\{\{base_url\}\}/<id>/content.json`, where
5949
- * `base_url` defaults to 'https://cdn.img.ly/assets/v4'.
5953
+ * These assets are parsed at `\{\{base_url\}\}/<id>/content.json`, where
5954
+ * `base_url` defaults to the IMG.LY CDN.
5950
5955
  * Each source is created via `addLocalSource` and populated with the parsed assets. To modify the available
5951
5956
  * assets, you may either exclude certain IDs via `excludeAssetSourceIds` or alter the sources after creation.
5952
5957
  *
@@ -5955,7 +5960,7 @@ declare class CreativeEngine {
5955
5960
  * @returns A promise that resolves when all asset sources are loaded.
5956
5961
  */
5957
5962
  addDefaultAssetSources({ baseURL, excludeAssetSourceIds }?: {
5958
- /** The source of the asset definitions, must be absolute. Defaults to `'https://cdn.img.ly/assets/v4'`. */
5963
+ /** The source of the asset definitions, must be absolute. Defaults to IMG.LY CDN. */
5959
5964
  baseURL?: string;
5960
5965
  /** A list of IDs, that will be ignored during load. */
5961
5966
  excludeAssetSourceIds?: DefaultAssetSourceId[];
@@ -5978,7 +5983,7 @@ declare class CreativeEngine {
5978
5983
  * @returns A promise that resolves when all demo asset sources are loaded.
5979
5984
  */
5980
5985
  addDemoAssetSources({ baseURL, excludeAssetSourceIds, sceneMode, withUploadAssetSources }?: {
5981
- /** The source of the demo asset definitions, must be absolute. Defaults to `'https://cdn.img.ly/assets/demo/v2'`. */
5986
+ /** The source of the demo asset definitions, must be absolute. Defaults to IMG.LY CDN. */
5982
5987
  baseURL?: string;
5983
5988
  /** A list of IDs, that will be ignored during load */
5984
5989
  excludeAssetSourceIds?: DemoAssetSourceId[];
@@ -5987,6 +5992,22 @@ declare class CreativeEngine {
5987
5992
  /** If 'true' asset sources for uploads are added (default false) */
5988
5993
  withUploadAssetSources?: boolean;
5989
5994
  }): Promise<void>;
5995
+ /**
5996
+ * Returns the configured base URL for the engine's assets.
5997
+ *
5998
+ * @category Engine Management
5999
+ * @returns The absolute base URL configured for this engine instance.
6000
+ *
6001
+ * @example
6002
+ * ```typescript
6003
+ * const engine = await CreativeEngine.init({
6004
+ * baseURL: 'https://my-cdn.example.com/assets/'
6005
+ * });
6006
+ *
6007
+ * console.log(engine.getBaseURL()); // 'https://my-cdn.example.com/assets/'
6008
+ * ```
6009
+ */
6010
+ getBaseURL(): string;
5990
6011
 
5991
6012
 
5992
6013
  }