@indreamai/client 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,219 @@
+type TExportRatio = '16:9' | '9:16' | '1:1' | '4:3' | '3:4' | 'custom';
+type TExportFormat = 'mp4' | 'webm' | 'gif' | 'mp3' | 'wav' | 'aac';
+type TTaskStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'PAUSED' | 'CANCELED';
+type TExportWebhookEventType = 'EXPORT_STARTED' | 'EXPORT_COMPLETED' | 'EXPORT_FAILED';
+interface IApiProblem {
+    type: string;
+    title: string;
+    status: number;
+    detail: string;
+    errorCode?: string;
+}
+interface IApiEnvelope<T> {
+    data: T;
+    meta: Record<string, unknown>;
+}
+interface ICreateExportRequest {
+    clientTaskId?: string;
+    editorState: Record<string, unknown>;
+    stateVersion?: string;
+    fps: 30 | 60;
+    compositionWidth?: number;
+    compositionHeight?: number;
+    ratio: TExportRatio;
+    scale: number;
+    format: TExportFormat;
+    callbackUrl?: string;
+    callbackHeaders?: Record<string, string>;
+}
+interface ICreateExportResponse {
+    taskId: string;
+    createdAt: string;
+    durationSeconds: number;
+    billedStandardSeconds: number;
+    chargedCredits: string;
+}
+interface IExportTask {
+    taskId: string;
+    createdByApiKeyId: string | null;
+    clientTaskId: string | null;
+    status: TTaskStatus;
+    progress: number;
+    error: string | null;
+    outputUrl: string | null;
+    durationSeconds: number;
+    billedStandardSeconds: number;
+    chargedCredits: string;
+    callbackUrl: string | null;
+    createdAt: string;
+    completedAt: string | null;
+}
+interface IListExportsResponse {
+    items: IExportTask[];
+    nextPageCursor: string | null;
+}
+interface IExportWebhookEvent {
+    eventType: TExportWebhookEventType;
+    occurredAt: string;
+    task: IExportTask;
+}
+interface IEditorCapabilities {
+    version: string;
+    animations: string[];
+    transitions: string[];
+    transitionPresets: Array<{
+        id: string;
+        type: string;
+        label: string;
+        params?: Record<string, string | number | boolean>;
+    }>;
+    effects: string[];
+    effectPresets: Array<{
+        id: string;
+        type: string;
+        label: string;
+        defaultDurationInSeconds?: number;
+        defaultIntensity?: number;
+        params?: Record<string, string | number | boolean>;
+    }>;
+    filters: string[];
+    filterPresets: Array<{
+        id: string;
+        type: string;
+        label: string;
+        defaultDurationInSeconds?: number;
+        defaultIntensity?: number;
+        params?: Record<string, string | number | boolean>;
+    }>;
+    shapes: string[];
+    backgroundPresets: {
+        colors: string[];
+        gradients: string[];
+        images: string[];
+        blurLevels: number[];
+    };
+    illustrations: string[];
+}
+interface IEditorValidationError {
+    code: string;
+    path: string;
+    message: string;
+}
+interface IEditorValidationResult {
+    valid: boolean;
+    errors: IEditorValidationError[];
+}
+interface IClientOptions {
+    apiKey: string;
+    baseURL?: string;
+    timeout?: number;
+    maxRetries?: number;
+    pollIntervalMs?: number;
+    fetch?: typeof fetch;
+}
+interface IRequestOptions {
+    signal?: AbortSignal;
+}
+interface ICreateRequestOptions extends IRequestOptions {
+    idempotencyKey?: string;
+}
+interface IWaitOptions {
+    timeoutMs?: number;
+    pollIntervalMs?: number;
+    signal?: AbortSignal;
+}
+
+declare class ExportsResource {
+    private readonly client;
+    constructor(client: IndreamClient);
+    create(payload: ICreateExportRequest, options?: ICreateRequestOptions): Promise<ICreateExportResponse>;
+    get(taskId: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<IExportTask>;
+    list(params?: {
+        pageSize?: number;
+        pageCursor?: string;
+        createdByApiKeyId?: string;
+        signal?: AbortSignal;
+    }): Promise<IListExportsResponse>;
+    wait(taskId: string, options?: IWaitOptions): Promise<IExportTask>;
+}
+
+declare class EditorResource {
+    private readonly client;
+    constructor(client: IndreamClient);
+    capabilities(options?: IRequestOptions): Promise<IEditorCapabilities>;
+    validate(editorState: Record<string, unknown>, options?: IRequestOptions): Promise<IEditorValidationResult>;
+}
+
+declare class IndreamClient {
+    readonly apiKey: string;
+    readonly baseURL: string;
+    readonly timeout: number;
+    readonly maxRetries: number;
+    readonly pollIntervalMs: number;
+    readonly fetchImpl: typeof fetch;
+    readonly exports: ExportsResource;
+    readonly editor: EditorResource;
+    constructor(options: IClientOptions);
+    request<T>(path: string, init: {
+        method: 'GET' | 'POST';
+        body?: unknown;
+        headers?: Record<string, string>;
+        idempotencyKey?: string;
+        signal?: AbortSignal;
+        skipRetry?: boolean;
+    }): Promise<T>;
+    requestEnvelope<T>(path: string, init: {
+        method: 'GET' | 'POST';
+        body?: unknown;
+        headers?: Record<string, string>;
+        idempotencyKey?: string;
+        signal?: AbortSignal;
+        skipRetry?: boolean;
+    }): Promise<IApiEnvelope<T>>;
+}
+
+declare class APIError extends Error {
+    readonly status: number;
+    readonly type: string;
+    readonly detail: string;
+    readonly errorCode?: string;
+    constructor(problem: IApiProblem);
+}
+declare class AuthError extends APIError {
+    constructor(problem: IApiProblem);
+}
+declare class ValidationError extends APIError {
+    constructor(problem: IApiProblem);
+}
+declare class RateLimitError extends APIError {
+    constructor(problem: IApiProblem);
+}
+declare const toApiProblem: (status: number, payload: unknown) => IApiProblem;
+declare const createApiError: (status: number, payload: unknown) => APIError;
+
+type TWebhookHeaderValue = string | string[] | null | undefined;
+type TWebhookHeaders = Headers | Record<string, TWebhookHeaderValue>;
+interface IVerifyExportWebhookSignatureParams {
+    webhookSecret: string;
+    timestamp: string;
+    rawBody: string;
+    signature: string;
+}
+interface IVerifyExportWebhookRequestParams {
+    webhookSecret: string;
+    rawBody: string;
+    headers: TWebhookHeaders;
+    maxSkewSeconds?: number;
+    nowTimestampSeconds?: number;
+}
+declare const isExportWebhookEventType: (value: unknown) => value is TExportWebhookEventType;
+declare const isTaskStatus: (value: unknown) => value is TTaskStatus;
+declare const isExportTaskSnapshot: (value: unknown) => value is IExportTask;
+declare const isExportWebhookEvent: (value: unknown) => value is IExportWebhookEvent;
+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 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 TExportFormat, type TExportRatio, type TExportWebhookEventType, type TTaskStatus, type TWebhookHeaders, ValidationError, createApiError, isExportTaskSnapshot, isExportWebhookEvent, isExportWebhookEventType, isTaskStatus, parseExportWebhookEvent, toApiProblem, verifyExportWebhookRequest, verifyExportWebhookSignature };

package/dist/index.d.ts

@@ -0,0 +1,219 @@
+type TExportRatio = '16:9' | '9:16' | '1:1' | '4:3' | '3:4' | 'custom';
+type TExportFormat = 'mp4' | 'webm' | 'gif' | 'mp3' | 'wav' | 'aac';
+type TTaskStatus = 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'PAUSED' | 'CANCELED';
+type TExportWebhookEventType = 'EXPORT_STARTED' | 'EXPORT_COMPLETED' | 'EXPORT_FAILED';
+interface IApiProblem {
+    type: string;
+    title: string;
+    status: number;
+    detail: string;
+    errorCode?: string;
+}
+interface IApiEnvelope<T> {
+    data: T;
+    meta: Record<string, unknown>;
+}
+interface ICreateExportRequest {
+    clientTaskId?: string;
+    editorState: Record<string, unknown>;
+    stateVersion?: string;
+    fps: 30 | 60;
+    compositionWidth?: number;
+    compositionHeight?: number;
+    ratio: TExportRatio;
+    scale: number;
+    format: TExportFormat;
+    callbackUrl?: string;
+    callbackHeaders?: Record<string, string>;
+}
+interface ICreateExportResponse {
+    taskId: string;
+    createdAt: string;
+    durationSeconds: number;
+    billedStandardSeconds: number;
+    chargedCredits: string;
+}
+interface IExportTask {
+    taskId: string;
+    createdByApiKeyId: string | null;
+    clientTaskId: string | null;
+    status: TTaskStatus;
+    progress: number;
+    error: string | null;
+    outputUrl: string | null;
+    durationSeconds: number;
+    billedStandardSeconds: number;
+    chargedCredits: string;
+    callbackUrl: string | null;
+    createdAt: string;
+    completedAt: string | null;
+}
+interface IListExportsResponse {
+    items: IExportTask[];
+    nextPageCursor: string | null;
+}
+interface IExportWebhookEvent {
+    eventType: TExportWebhookEventType;
+    occurredAt: string;
+    task: IExportTask;
+}
+interface IEditorCapabilities {
+    version: string;
+    animations: string[];
+    transitions: string[];
+    transitionPresets: Array<{
+        id: string;
+        type: string;
+        label: string;
+        params?: Record<string, string | number | boolean>;
+    }>;
+    effects: string[];
+    effectPresets: Array<{
+        id: string;
+        type: string;
+        label: string;
+        defaultDurationInSeconds?: number;
+        defaultIntensity?: number;
+        params?: Record<string, string | number | boolean>;
+    }>;
+    filters: string[];
+    filterPresets: Array<{
+        id: string;
+        type: string;
+        label: string;
+        defaultDurationInSeconds?: number;
+        defaultIntensity?: number;
+        params?: Record<string, string | number | boolean>;
+    }>;
+    shapes: string[];
+    backgroundPresets: {
+        colors: string[];
+        gradients: string[];
+        images: string[];
+        blurLevels: number[];
+    };
+    illustrations: string[];
+}
+interface IEditorValidationError {
+    code: string;
+    path: string;
+    message: string;
+}
+interface IEditorValidationResult {
+    valid: boolean;
+    errors: IEditorValidationError[];
+}
+interface IClientOptions {
+    apiKey: string;
+    baseURL?: string;
+    timeout?: number;
+    maxRetries?: number;
+    pollIntervalMs?: number;
+    fetch?: typeof fetch;
+}
+interface IRequestOptions {
+    signal?: AbortSignal;
+}
+interface ICreateRequestOptions extends IRequestOptions {
+    idempotencyKey?: string;
+}
+interface IWaitOptions {
+    timeoutMs?: number;
+    pollIntervalMs?: number;
+    signal?: AbortSignal;
+}
+
+declare class ExportsResource {
+    private readonly client;
+    constructor(client: IndreamClient);
+    create(payload: ICreateExportRequest, options?: ICreateRequestOptions): Promise<ICreateExportResponse>;
+    get(taskId: string, options?: {
+        signal?: AbortSignal;
+    }): Promise<IExportTask>;
+    list(params?: {
+        pageSize?: number;
+        pageCursor?: string;
+        createdByApiKeyId?: string;
+        signal?: AbortSignal;
+    }): Promise<IListExportsResponse>;
+    wait(taskId: string, options?: IWaitOptions): Promise<IExportTask>;
+}
+
+declare class EditorResource {
+    private readonly client;
+    constructor(client: IndreamClient);
+    capabilities(options?: IRequestOptions): Promise<IEditorCapabilities>;
+    validate(editorState: Record<string, unknown>, options?: IRequestOptions): Promise<IEditorValidationResult>;
+}
+
+declare class IndreamClient {
+    readonly apiKey: string;
+    readonly baseURL: string;
+    readonly timeout: number;
+    readonly maxRetries: number;
+    readonly pollIntervalMs: number;
+    readonly fetchImpl: typeof fetch;
+    readonly exports: ExportsResource;
+    readonly editor: EditorResource;
+    constructor(options: IClientOptions);
+    request<T>(path: string, init: {
+        method: 'GET' | 'POST';
+        body?: unknown;
+        headers?: Record<string, string>;
+        idempotencyKey?: string;
+        signal?: AbortSignal;
+        skipRetry?: boolean;
+    }): Promise<T>;
+    requestEnvelope<T>(path: string, init: {
+        method: 'GET' | 'POST';
+        body?: unknown;
+        headers?: Record<string, string>;
+        idempotencyKey?: string;
+        signal?: AbortSignal;
+        skipRetry?: boolean;
+    }): Promise<IApiEnvelope<T>>;
+}
+
+declare class APIError extends Error {
+    readonly status: number;
+    readonly type: string;
+    readonly detail: string;
+    readonly errorCode?: string;
+    constructor(problem: IApiProblem);
+}
+declare class AuthError extends APIError {
+    constructor(problem: IApiProblem);
+}
+declare class ValidationError extends APIError {
+    constructor(problem: IApiProblem);
+}
+declare class RateLimitError extends APIError {
+    constructor(problem: IApiProblem);
+}
+declare const toApiProblem: (status: number, payload: unknown) => IApiProblem;
+declare const createApiError: (status: number, payload: unknown) => APIError;
+
+type TWebhookHeaderValue = string | string[] | null | undefined;
+type TWebhookHeaders = Headers | Record<string, TWebhookHeaderValue>;
+interface IVerifyExportWebhookSignatureParams {
+    webhookSecret: string;
+    timestamp: string;
+    rawBody: string;
+    signature: string;
+}
+interface IVerifyExportWebhookRequestParams {
+    webhookSecret: string;
+    rawBody: string;
+    headers: TWebhookHeaders;
+    maxSkewSeconds?: number;
+    nowTimestampSeconds?: number;
+}
+declare const isExportWebhookEventType: (value: unknown) => value is TExportWebhookEventType;
+declare const isTaskStatus: (value: unknown) => value is TTaskStatus;
+declare const isExportTaskSnapshot: (value: unknown) => value is IExportTask;
+declare const isExportWebhookEvent: (value: unknown) => value is IExportWebhookEvent;
+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 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 TExportFormat, type TExportRatio, type TExportWebhookEventType, type TTaskStatus, type TWebhookHeaders, ValidationError, createApiError, isExportTaskSnapshot, isExportWebhookEvent, isExportWebhookEventType, isTaskStatus, parseExportWebhookEvent, toApiProblem, verifyExportWebhookRequest, verifyExportWebhookSignature };