@indreamai/client 0.2.1 → 0.3.0

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 interface components {
     schemas: {
+        /** @description Problem-details style error payload with a stable `errorCode`. */
         Problem: {
             type: string;
             title: string;
@@ -7,6 +8,23 @@ interface components {
             detail: string;
             errorCode?: string;
         };
+        /** @description Request body for creating a persistent editor project. */
+        CreateProjectRequest: {
+            title?: string;
+            description?: string | null;
+            editorState: components["schemas"]["editor-state.v1.schema"];
+            stateVersion?: string;
+        };
+        PatchProjectRequest: {
+            title?: string;
+            description?: string | null;
+        };
+        /** @description Request body for autosave-style editor state sync. */
+        SyncProjectRequest: {
+            editorState: components["schemas"]["editor-state.v1.schema"];
+            stateVersion?: string;
+        };
+        /** @description Request body for stateless export creation. */
         CreateExportRequest: {
             clientTaskId?: string;
             editorState: components["schemas"]["editor-state.v1.schema"];
@@ -25,16 +43,90 @@ interface components {
                 [key: string]: string;
             };
         };
+        /** @description Request body for project-based export creation. */
+        CreateProjectExportRequest: {
+            clientTaskId?: string;
+            /** @enum {integer} */
+            fps: 30 | 60;
+            /** @enum {string} */
+            ratio: "16:9" | "9:16" | "1:1" | "4:3" | "3:4" | "custom";
+            scale: number;
+            /** @enum {string} */
+            format: "mp4" | "webm";
+            callbackUrl?: string;
+            callbackHeaders?: {
+                [key: string]: string;
+            };
+        };
+        AddProjectAssetRequest: {
+            /** Format: uuid */
+            assetId: string;
+        };
+        ProjectSummary: {
+            /** Format: uuid */
+            projectId: string;
+            title: string;
+            description: string | null;
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            updatedAt: string;
+        };
+        /** @description Project detail response, including the latest persisted editor state. */
+        ProjectDetail: components["schemas"]["ProjectSummary"] & {
+            editorState: components["schemas"]["editor-state.v1.schema"];
+            stateVersion: string;
+        };
+        ProjectMetadata: {
+            /** Format: uuid */
+            projectId: string;
+            title: string;
+            description: string | null;
+            /** Format: date-time */
+            updatedAt: string;
+        };
+        SyncProjectResponseData: {
+            /** Format: uuid */
+            projectId: string;
+            stateVersion: string;
+            /** Format: date-time */
+            updatedAt: string;
+        };
+        /**
+         * @description Core asset fields returned by OpenAPI.
+         *     To reference uploaded files in editor JSON, map `fileUrl` to `assets[*].remoteUrl` and `fileKey` to `assets[*].remoteKey`.
+         */
+        Asset: {
+            /** Format: uuid */
+            assetId: string;
+            type: string;
+            source: string | null;
+            filename: string;
+            mimetype: string;
+            size: number | null;
+            fileUrl: string;
+            fileKey: string;
+            width: number | null;
+            height: number | null;
+            duration: number | null;
+        };
+        /** @description Export creation response shared by stateless and project-based export routes. */
         CreateExportResponseData: {
             taskId: string;
+            /** Format: uuid */
+            projectId?: string | null;
             /** Format: date-time */
             createdAt: string;
             durationSeconds: number;
             billedStandardSeconds: number;
             chargedCredits: string;
+            chargedCreditPool?: string;
         };
+        /** @description Export task snapshot returned by task detail, list, and webhook payloads. */
         ExportTask: {
             taskId: string;
+            /** Format: uuid */
+            projectId: string | null;
             createdByApiKeyId: string | null;
             clientTaskId: string | null;
             /** @enum {string} */
@@ -123,6 +215,87 @@ interface components {
             valid: boolean;
             errors: components["schemas"]["EditorValidationError"][];
         };
+        ProjectSummaryEnvelope: {
+            data: components["schemas"]["ProjectSummary"];
+            meta: {
+                [key: string]: unknown;
+            };
+        };
+        ProjectDetailEnvelope: {
+            data: components["schemas"]["ProjectDetail"];
+            meta: {
+                [key: string]: unknown;
+            };
+        };
+        ProjectMetadataEnvelope: {
+            data: components["schemas"]["ProjectMetadata"];
+            meta: {
+                [key: string]: unknown;
+            };
+        };
+        SyncProjectEnvelope: {
+            data: components["schemas"]["SyncProjectResponseData"];
+            meta: {
+                [key: string]: unknown;
+            };
+        };
+        DeleteProjectEnvelope: {
+            data: {
+                /** Format: uuid */
+                projectId: string;
+                deleted: boolean;
+            };
+            meta: {
+                [key: string]: unknown;
+            };
+        };
+        AssetEnvelope: {
+            data: components["schemas"]["Asset"];
+            meta: {
+                [key: string]: unknown;
+            };
+        };
+        ListAssetsResponseEnvelope: {
+            data: components["schemas"]["Asset"][];
+            meta: {
+                nextPageCursor?: string | null;
+            } & {
+                [key: string]: unknown;
+            };
+        };
+        ProjectAssetBindingEnvelope: {
+            data: {
+                /** Format: uuid */
+                projectId: string;
+                /** Format: uuid */
+                assetId: string;
+            };
+            meta: {
+                [key: string]: unknown;
+            };
+        };
+        DeleteProjectAssetEnvelope: {
+            data: {
+                /** Format: uuid */
+                projectId: string;
+                /** Format: uuid */
+                assetId: string;
+                deleted: boolean;
+            };
+            meta: {
+                [key: string]: unknown;
+            };
+        };
+        DeleteAssetEnvelope: {
+            data: {
+                /** Format: uuid */
+                assetId: string;
+                deleted: boolean;
+            };
+            meta: {
+                [key: string]: unknown;
+            };
+        };
         CreateExportResponseEnvelope: {
             data: components["schemas"]["CreateExportResponseData"];
             meta: {
@@ -143,6 +316,14 @@ interface components {
                 [key: string]: unknown;
             };
         };
+        ListProjectsResponseEnvelope: {
+            data: components["schemas"]["ProjectSummary"][];
+            meta: {
+                nextPageCursor?: string | null;
+            } & {
+                [key: string]: unknown;
+            };
+        };
         EditorCapabilitiesResponseEnvelope: {
             data: components["schemas"]["EditorCapabilities"];
             meta: {
@@ -592,7 +773,22 @@ interface components {
             };
         };
     };
-    parameters: never;
+    parameters: {
+        /**
+         * @description Optional idempotency key for create/finalize style POST requests.
+         *     When provided, the server replays the first completed response for the same request payload.
+         */
+        IdempotencyKey: string;
+        ProjectId: string;
+        AssetId: string;
+        /** @description Original filename for the uploaded file. */
+        UploadFileName: string;
+        /** @description Optional project to bind the created asset to. */
+        UploadProjectId: string;
+        PageSize: number;
+        PageSizeAssets: number;
+        PageCursor: string;
+    };
     requestBodies: never;
     headers: never;
     pathItems: never;
@@ -629,13 +825,16 @@ interface ICreateExportRequest {
 }
 interface ICreateExportResponse {
     taskId: string;
+    projectId?: string | null;
     createdAt: string;
     durationSeconds: number;
     billedStandardSeconds: number;
     chargedCredits: string;
+    chargedCreditPool?: string;
 }
 interface IExportTask {
     taskId: string;
+    projectId?: string | null;
     createdByApiKeyId: string | null;
     clientTaskId: string | null;
     status: TTaskStatus;
@@ -735,6 +934,100 @@ interface IWaitOptions {
     pollIntervalMs?: number;
     signal?: AbortSignal;
 }
+interface IProjectSummary {
+    projectId: string;
+    title: string;
+    description: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface IProjectDetail extends IProjectSummary {
+    editorState: TEditorStateV1;
+    stateVersion: string;
+}
+interface ICreateProjectRequest {
+    title?: string;
+    description?: string | null;
+    editorState: TEditorStateV1;
+    stateVersion?: string;
+}
+interface IUpdateProjectRequest {
+    title?: string;
+    description?: string | null;
+}
+interface ISyncProjectRequest {
+    editorState: TEditorStateV1;
+    stateVersion?: string;
+}
+interface IProjectMetadataResponse {
+    projectId: string;
+    title: string;
+    description: string | null;
+    updatedAt: string;
+}
+interface IProjectSyncResponse {
+    projectId: string;
+    stateVersion: string;
+    updatedAt: string;
+}
+interface IDeleteProjectResponse {
+    projectId: string;
+    deleted: boolean;
+}
+interface IListProjectsResponse {
+    items: IProjectSummary[];
+    nextPageCursor: string | null;
+}
+interface IAsset {
+    assetId: string;
+    type: string;
+    source: string | null;
+    filename: string;
+    mimetype: string;
+    size: number | null;
+    fileUrl: string;
+    fileKey: string;
+    width: number | null;
+    height: number | null;
+    duration: number | null;
+}
+interface IListAssetsResponse {
+    items: IAsset[];
+    nextPageCursor: string | null;
+}
+type TUploadBody = Blob | ArrayBuffer | ArrayBufferView | ReadableStream<Uint8Array>;
+interface IUploadOptions extends IRequestOptions {
+    filename?: string;
+    contentType?: string;
+    projectId?: string;
+}
+interface IProjectAssetBindingResponse {
+    projectId: string;
+    assetId: string;
+}
+interface IDeleteProjectAssetResponse extends IProjectAssetBindingResponse {
+    deleted: boolean;
+}
+interface IDeleteAssetResponse {
+    assetId: string;
+    deleted: boolean;
+}
+interface ICreateProjectExportRequest {
+    clientTaskId?: string;
+    fps: 30 | 60;
+    ratio: TExportRatio;
+    scale: number;
+    format: TExportFormat;
+    callbackUrl?: string;
+    callbackHeaders?: Record<string, string>;
+}
+
+declare class AssetsResource {
+    private readonly client;
+    constructor(client: IndreamClient);
+    get(assetId: string, options?: IRequestOptions): Promise<IAsset>;
+    delete(assetId: string, options?: IRequestOptions): Promise<IDeleteAssetResponse>;
+}
 
 declare class ExportsResource {
     private readonly client;
@@ -759,6 +1052,36 @@ declare class EditorResource {
     validate(editorState: TEditorStateV1, options?: IRequestOptions): Promise<IEditorValidationResult>;
 }
 
+declare class ProjectsResource {
+    private readonly client;
+    constructor(client: IndreamClient);
+    create(payload: ICreateProjectRequest, options?: ICreateRequestOptions): Promise<IProjectSummary>;
+    list(params?: {
+        pageSize?: number;
+        pageCursor?: string;
+        signal?: AbortSignal;
+    }): Promise<IListProjectsResponse>;
+    get(projectId: string, options?: IRequestOptions): Promise<IProjectDetail>;
+    update(projectId: string, payload: IUpdateProjectRequest, options?: IRequestOptions): Promise<IProjectMetadataResponse>;
+    sync(projectId: string, payload: ISyncProjectRequest, options?: IRequestOptions): Promise<IProjectSyncResponse>;
+    delete(projectId: string, options?: IRequestOptions): Promise<IDeleteProjectResponse>;
+    listAssets(params: {
+        projectId: string;
+        pageSize?: number;
+        pageCursor?: string;
+        signal?: AbortSignal;
+    }): Promise<IListAssetsResponse>;
+    addAsset(projectId: string, assetId: string, options?: IRequestOptions): Promise<IProjectAssetBindingResponse>;
+    removeAsset(projectId: string, assetId: string, options?: IRequestOptions): Promise<IDeleteProjectAssetResponse>;
+    createExport(projectId: string, payload: ICreateProjectExportRequest, options?: ICreateRequestOptions): Promise<ICreateExportResponse>;
+}
+
+declare class UploadsResource {
+    private readonly client;
+    constructor(client: IndreamClient);
+    upload(body: TUploadBody, options?: IUploadOptions): Promise<IAsset>;
+}
+
 declare class IndreamClient {
     readonly apiKey: string;
     readonly baseURL: string;
@@ -768,9 +1091,12 @@ declare class IndreamClient {
     readonly fetchImpl: typeof fetch;
     readonly exports: ExportsResource;
     readonly editor: EditorResource;
+    readonly projects: ProjectsResource;
+    readonly uploads: UploadsResource;
+    readonly assets: AssetsResource;
     constructor(options: IClientOptions);
     request<T>(path: string, init: {
-        method: 'GET' | 'POST';
+        method: 'GET' | 'POST' | 'PATCH' | 'DELETE';
         body?: unknown;
         headers?: Record<string, string>;
         idempotencyKey?: string;
@@ -778,7 +1104,7 @@ declare class IndreamClient {
         skipRetry?: boolean;
     }): Promise<T>;
     requestEnvelope<T>(path: string, init: {
-        method: 'GET' | 'POST';
+        method: 'GET' | 'POST' | 'PATCH' | 'DELETE';
         body?: unknown;
         headers?: Record<string, string>;
         idempotencyKey?: string;
@@ -829,4 +1155,4 @@ declare const parseExportWebhookEvent: (value: unknown) => IExportWebhookEvent;
 declare const verifyExportWebhookSignature: ({ webhookSecret, timestamp, rawBody, signature, }: IVerifyExportWebhookSignatureParams) => Promise<boolean>;
 declare const verifyExportWebhookRequest: ({ webhookSecret, rawBody, headers, maxSkewSeconds, nowTimestampSeconds, }: IVerifyExportWebhookRequestParams) => Promise<boolean>;
 
-export { APIError, AuthError, type IApiEnvelope, type IApiProblem, type ICaptionAnimationPresetGroups, type ICaptionAnimationPresetItem, type IClientOptions, type ICreateExportRequest, type ICreateExportResponse, type ICreateRequestOptions, type IEditorCapabilities, type IEditorValidationError, type IEditorValidationResult, type IExportTask, type IExportWebhookEvent, type IListExportsResponse, type IRequestOptions, type IVerifyExportWebhookRequestParams, type IVerifyExportWebhookSignatureParams, type IWaitOptions, IndreamClient, RateLimitError, type TEditorStateV1, type TExportFormat, type TExportRatio, type TExportWebhookEventType, type TTaskStatus, type TWebhookHeaders, ValidationError, createApiError, isExportTaskSnapshot, isExportWebhookEvent, isExportWebhookEventType, isTaskStatus, parseExportWebhookEvent, toApiProblem, verifyExportWebhookRequest, verifyExportWebhookSignature };
+export { APIError, AssetsResource, AuthError, EditorResource, ExportsResource, type IApiEnvelope, type IApiProblem, type IAsset, type ICaptionAnimationPresetGroups, type ICaptionAnimationPresetItem, type IClientOptions, type ICreateExportRequest, type ICreateExportResponse, type ICreateProjectExportRequest, type ICreateProjectRequest, type ICreateRequestOptions, type IDeleteAssetResponse, type IDeleteProjectAssetResponse, type IDeleteProjectResponse, type IEditorCapabilities, type IEditorValidationError, type IEditorValidationResult, type IExportTask, type IExportWebhookEvent, type IListAssetsResponse, type IListExportsResponse, type IListProjectsResponse, type IProjectAssetBindingResponse, type IProjectDetail, type IProjectMetadataResponse, type IProjectSummary, type IProjectSyncResponse, type IRequestOptions, type ISyncProjectRequest, type IUpdateProjectRequest, type IUploadOptions, type IVerifyExportWebhookRequestParams, type IVerifyExportWebhookSignatureParams, type IWaitOptions, IndreamClient, ProjectsResource, RateLimitError, type TEditorStateV1, type TExportFormat, type TExportRatio, type TExportWebhookEventType, type TTaskStatus, type TUploadBody, type TWebhookHeaders, UploadsResource, ValidationError, createApiError, isExportTaskSnapshot, isExportWebhookEvent, isExportWebhookEventType, isTaskStatus, parseExportWebhookEvent, toApiProblem, verifyExportWebhookRequest, verifyExportWebhookSignature };