@imgly/plugin-ai-generation-web 0.1.0-rc.0

package/dist/registerDockComponent.d.ts

@@ -0,0 +1,10 @@
+import CreativeEditorSDK from '@cesdk/cesdk-js';
+/**
+ * Registers a dock component for AI generation that opens
+ * the AI generation panel and closes any other AI panels.
+ */
+declare function registerDockComponent(options: {
+    cesdk: CreativeEditorSDK;
+    panelId: string;
+}): void;
+export default registerDockComponent;

package/dist/utils.d.ts

@@ -0,0 +1,66 @@
+import CreativeEditorSDK, { AssetResult } from '@cesdk/cesdk-js';
+import { GenerationResult, Output } from './generation/provider';
+export declare const AI_PANEL_ID_PREFIX = "ly.img.ai";
+/**
+ * Adding asset to the scene.
+ *
+ * NOTE: Will use a temporary asset source so that
+ * our asset source middleware trigger. This is necessary since there is
+ * a lot of extra logic in the video middlewares regarding trim, position etc.
+ *
+ * These will only trigger via an asset source, not by calling
+ * `defaultApplyAsset` directly.
+ */
+export declare function addAssetToScene(cesdk: CreativeEditorSDK, assetResult: AssetResult): Promise<number | undefined>;
+/**
+ * Returns a consistent panel ID for a provider ID
+ */
+export declare function getPanelId(providerId: string): string;
+export default getPanelId;
+/**
+ * Extracts a readable error message from an unknown error
+ *
+ * @param error The error caught in a try/catch block
+ * @param fallbackMessage Optional fallback message if error is not an Error object
+ * @returns A string representation of the error
+ */
+export declare function extractErrorMessage(error: unknown, fallbackMessage?: string): string;
+/**
+ * Generates a random UUID v4
+ */
+export declare function uuid4(): string;
+/**
+ * Gets the duration of a video from a URL
+ * @param url - The URL of the video
+ * @returns A promise that resolves to the duration of the video in seconds
+ */
+export declare function getDurationForVideo(url: string): Promise<number>;
+/**
+ * Gets a thumbnail image from a video URL
+ * @param url - The URL of the video
+ * @param seekTime - Time in seconds to capture the thumbnail (default: 0)
+ * @param format - Image format for the thumbnail (default: 'image/jpeg')
+ * @param quality - Image quality between 0 and 1 (default: 0.8)
+ * @returns A promise that resolves to the thumbnail data URL
+ */
+export declare function getThumbnailForVideo(url: string, seekTime?: number, format?: string, quality?: number): Promise<string>;
+/**
+ * Converts an ID string to a human-readable label
+ * @param id - The ID string to convert
+ * @returns A human-readable label derived from the ID
+ *
+ * Examples:
+ * - snake_case_id → Snake Case Id
+ * - kebab-case-id → Kebab Case Id
+ * - camelCaseId → Camel Case Id
+ * - PascalCaseId → Pascal Case Id
+ */
+export declare function getLabelFromId(id: string): string;
+/**
+ * Type guard to check if a value is an AsyncGenerator rather than a Promise
+ *
+ * @param value - Value of type Promise<O> | AsyncGenerator<O, C>
+ * @returns Boolean indicating if the value is an AsyncGenerator
+ */
+export declare function isAsyncGenerator<O extends Output, C>(value: GenerationResult<O, C>): value is AsyncGenerator<O, C>;
+export declare function isAbortError(error: unknown): error is Error;

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@imgly/plugin-ai-generation-web",
+  "version": "0.1.0-rc.0",
+  "description": "AI generation plugin for the CE.SDK editor",
+  "keywords": ["CE.SDK", "plugin", "AI", "ai generation"],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/imgly/plugins.git"
+  },
+  "license": "SEE LICENSE IN LICENSE.md",
+  "author": {
+    "name": "IMG.LY GmbH",
+    "email": "support@img.ly",
+    "url": "https://img.ly"
+  },
+  "bugs": {
+    "email": "support@img.ly"
+  },
+  "source": "./src/index.ts",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "homepage": "https://img.ly/products/creative-sdk",
+  "files": ["LICENSE.md", "README.md", "CHANGELOG.md", "dist/", "bin/"],
+  "scripts": {
+    "start": "pnpm run watch",
+    "clean": "pnpm exec rimraf dist",
+    "purge": "pnpm exec rimraf node_modules",
+    "build": "pnpm run clean && pnpm _syncPnpm && pnpm exec node scripts/build.mjs",
+    "publish:latest": "pnpm run build && npm publish --tag latest --access public",
+    "publish:next": "pnpm run build && npm publish --tag next --access public",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "dev": "pnpm --filter \"${npm_package_name}^...\" --parallel run dev:wait && node scripts/watch.mjs",
+    "dev:wait": "pnpm exec wait-on ./dist/index.mjs ./dist/index.d.ts --window 250 --timeout 30000",
+    "check:all": "concurrently -n lint,type,pretty \"pnpm run check:lint\" \"pnpm run check:types\" \"pnpm run check:pretty\"",
+    "check:lint": "eslint --max-warnings 0 './src/**/*.{ts,tsx}'",
+    "check:pretty": "prettier --list-different './src/**/*.{ts,tsx}'",
+    "check:types": "tsc --noEmit",
+    "types:create": "tsc --emitDeclarationOnly",
+    "_syncPnpm": "pnpm sync-dependencies-meta-injected"
+  },
+  "devDependencies": {
+    "@cesdk/cesdk-js": "^1.48.0",
+    "@imgly/plugin-utils": "workspace:*",
+    "esbuild": "^0.19.12",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "openapi-types": "^12.1.3"
+  },
+  "dependenciesMeta": {
+    "@imgly/plugin-utils": {
+      "injected": true
+    }
+  },
+  "peerDependencies": {
+    "@cesdk/cesdk-js": "^1.48.0"
+  }
+}