@xformmedia/sdk 0.5.3

package/dist/types.d.ts

@@ -0,0 +1,265 @@
+export type VideoTranscodeStatus = 'pending' | 'processing' | 'ready' | 'failed';
+export type VideoRenditionQuality = '1080p' | '720p' | '480p';
+export interface VideoRendition {
+    quality: VideoRenditionQuality;
+    width: number;
+    height: number;
+    bitrate: number;
+}
+export interface Video {
+    id: string;
+    videoKey: string;
+    originalKey: string;
+    transcodeStatus: VideoTranscodeStatus;
+    renditions?: VideoRendition[];
+    duration?: number;
+    width?: number;
+    height?: number;
+    fileSizeBytes?: number;
+    errorMessage?: string;
+    callbackUrl?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface VideoEvent {
+    id: string;
+    videoKey: string;
+    originalKey: string;
+    transcodeStatus: VideoTranscodeStatus;
+    width?: number;
+    height?: number;
+    duration?: number;
+    /** HLS stream path (available when ready), e.g. `/v/{videoKey}.m3u8` */
+    streamUrl?: string;
+    /** Original file download path, e.g. `/d/{videoKey}` */
+    downloadUrl?: string;
+    /** Thumbnail path (available when ready), e.g. `/v/{videoKey}/thumbnail.jpg` */
+    thumbnailUrl?: string;
+    renditions?: VideoRendition[];
+    errorMessage?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export type VideoEventType = 'video.pending' | 'video.processing' | 'video.ready' | 'video.failed';
+export interface VideoEventStream {
+    on(event: VideoEventType | '*', callback: (data: VideoEvent) => void): this;
+    close(): void;
+}
+export interface IngestResult {
+    id: string;
+    videoKey: string;
+    transcodeStatus: VideoTranscodeStatus;
+    createdAt: string;
+}
+export interface UploadUrlResult {
+    uploadUrl: string;
+    key: string;
+    expiresAt: string;
+}
+export interface ListVideosResult {
+    data: Video[];
+}
+export interface VideoUsageResult {
+    totalVideos: number;
+    totalDurationSeconds: number;
+    totalFileSizeBytes: number;
+}
+export type WebhookEventType = 'video.ready' | 'video.failed' | 'video.renamed';
+export interface WebhookConfig {
+    url: string;
+    secret: string;
+    events: WebhookEventType[];
+}
+export type SourceProvider = 'aws' | 'cloudflare-r2' | 'public-web';
+export type SourceStatus = 'active' | 'inactive' | 'suspended';
+export type BillingCycle = 'monthly' | 'annual';
+export type PlanName = 'Starter' | 'Pro';
+export interface SourceCredentials {
+    bucket?: string;
+    region?: string;
+    endpoint?: string;
+    baseUrl?: string;
+    excludePaths?: string[];
+}
+export type BillingStatus = 'active' | 'trialing' | 'paused' | 'canceled';
+export interface SourcePlan {
+    name: PlanName;
+    priceId: string;
+    billingCycle: BillingCycle;
+    addOns?: {
+        smartCrop?: {
+            priceId: string;
+        };
+        video?: {
+            priceId: string;
+        };
+    };
+}
+export interface SourceBilling {
+    plan: SourcePlan;
+    subscriptionItemId?: string;
+    status: BillingStatus;
+    trialEndsAt?: string;
+}
+export interface Source {
+    _id: string;
+    id: string;
+    organizationId: string;
+    name: string;
+    subdomain: string;
+    provider: SourceProvider;
+    credentials: SourceCredentials;
+    status: SourceStatus;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateSourceInput {
+    name: string;
+    subdomain: string;
+    provider: SourceProvider;
+    credentials: {
+        bucket?: string;
+        region?: string;
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        endpoint?: string;
+        baseUrl?: string;
+        excludePaths?: string[];
+    };
+    cache?: {
+        maxAge?: number;
+        sMaxAge?: number;
+    };
+    plan: {
+        name: PlanName;
+        billingCycle: BillingCycle;
+        addOns?: {
+            smartCrop?: boolean;
+            video?: boolean;
+        };
+    };
+}
+export interface UpdatePlanInput {
+    /** New plan name. Defaults to current plan if omitted. */
+    name?: PlanName;
+    /** New billing cycle. Defaults to current cycle if omitted. */
+    billingCycle?: BillingCycle;
+    /** Add-on toggles. Omit entirely to leave add-ons unchanged. */
+    addOns?: {
+        /** Smart Crop (Starter plan only — Pro includes it by default) */
+        smartCrop?: boolean;
+        /** Video transcoding and HLS streaming */
+        video?: boolean;
+    };
+}
+export interface UpdateSourceInput {
+    name?: string;
+    credentials?: {
+        bucket?: string;
+        region?: string;
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        endpoint?: string;
+        baseUrl?: string;
+        excludePaths?: string[];
+    };
+    cache?: {
+        maxAge?: number;
+        sMaxAge?: number;
+    };
+    status?: SourceStatus;
+    webhook?: {
+        url?: string;
+        secret?: string;
+        events?: WebhookEventType[];
+    } | null;
+}
+export interface SetWebhookInput {
+    url: string;
+    secret: string;
+    events?: WebhookEventType[];
+}
+export interface CheckSubdomainResult {
+    available: boolean;
+    subdomain?: string;
+    error?: string;
+}
+export interface XformClientOptions {
+    /** Your source ID — only required for source-scoped operations */
+    sourceId: string;
+    /** Your organization ID */
+    organizationId: string;
+    /** Your source-scoped API key (e.g. "xfm_...") */
+    apiKey: string;
+    /** Base URL of the xform admin API (e.g. "https://admin.xform.media") */
+    baseUrl: string;
+    /** Base URL of your source's stream domain (e.g. "https://acme.xform.media"). Required for embed() */
+    streamBaseUrl?: string;
+}
+export interface EmbedOptions {
+    autoplay?: boolean;
+    muted?: boolean;
+    startAt?: number;
+    loop?: boolean;
+    controls?: boolean;
+    quality?: '1080p' | '720p' | '480p' | 'auto';
+    logo?: string;
+    color?: string;
+    poster?: boolean;
+    title?: string;
+    captions?: boolean;
+    search?: boolean;
+}
+export interface VideoAnalyticsSummary {
+    totalViews: number;
+    uniqueSessions: number;
+    avgWatchedSeconds: number;
+    avgCompletionRate: number;
+}
+export interface VideoAnalyticsDetailed {
+    summary: VideoAnalyticsSummary;
+    viewsByDay: {
+        date: string;
+        views: number;
+        uniqueSessions: number;
+    }[];
+    referrers: {
+        referrer: string;
+        views: number;
+    }[];
+    events: {
+        event: string;
+        count: number;
+    }[];
+    qualityBreakdown: {
+        quality: string;
+        count: number;
+    }[];
+    recentSessions: {
+        sessionId: string;
+        events: {
+            event: string;
+            timestamp: string;
+            watchedSeconds: number;
+            completionRate: number;
+            currentQuality?: string;
+        }[];
+        referrer?: string | null;
+        userAgent?: string | null;
+    }[];
+}
+export interface VideoAnalyticsOptions {
+    videoKey?: string;
+    since?: string;
+    until?: string;
+    detailed?: boolean;
+}
+export interface XformAdminClientOptions {
+    /** Your organization ID */
+    organizationId: string;
+    /** Your organization-level API key (e.g. "xfm_...") */
+    apiKey: string;
+    /** Base URL of the xform admin API (e.g. "https://admin.xform.media") */
+    baseUrl: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,oBAAoB,GAAG,SAAS,GAAG,YAAY,GAAG,OAAO,GAAG,QAAQ,CAAA;AAEhF,MAAM,MAAM,qBAAqB,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA;AAE7D,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,qBAAqB,CAAA;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,eAAe,EAAE,oBAAoB,CAAA;IACrC,UAAU,CAAC,EAAE,cAAc,EAAE,CAAA;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,EAAE,MAAM,CAAA;IACnB,eAAe,EAAE,oBAAoB,CAAA;IACrC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,wEAAwE;IACxE,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gFAAgF;IAChF,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,UAAU,CAAC,EAAE,cAAc,EAAE,CAAA;IAC7B,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,kBAAkB,GAAG,aAAa,GAAG,cAAc,CAAA;AAElG,MAAM,WAAW,gBAAgB;IAC/B,EAAE,CAAC,KAAK,EAAE,cAAc,GAAG,GAAG,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,UAAU,KAAK,IAAI,GAAG,IAAI,CAAA;IAC3E,KAAK,IAAI,IAAI,CAAA;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,eAAe,EAAE,oBAAoB,CAAA;IACrC,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,KAAK,EAAE,CAAA;CACd;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAA;IACnB,oBAAoB,EAAE,MAAM,CAAA;IAC5B,kBAAkB,EAAE,MAAM,CAAA;CAC3B;AAID,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG,cAAc,GAAG,eAAe,CAAA;AAE/E,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,EAAE,gBAAgB,EAAE,CAAA;CAC3B;AAID,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,eAAe,GAAG,YAAY,CAAA;AACnE,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,UAAU,GAAG,WAAW,CAAA;AAC9D,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,QAAQ,CAAA;AAC/C,MAAM,MAAM,QAAQ,GAAG,SAAS,GAAG,KAAK,CAAA;AAExC,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CAExB;AAED,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAA;AAEzE,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,QAAQ,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,YAAY,CAAA;IAC1B,MAAM,CAAC,EAAE;QACP,SAAS,CAAC,EAAE;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAA;QAC/B,KAAK,CAAC,EAAE;YAAE,OAAO,EAAE,MAAM,CAAA;SAAE,CAAA;KAC5B,CAAA;CACF;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,UAAU,CAAA;IAChB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,MAAM,EAAE,aAAa,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,MAAM;IACrB,GAAG,EAAE,MAAM,CAAA;IACX,EAAE,EAAE,MAAM,CAAA;IACV,cAAc,EAAE,MAAM,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,cAAc,CAAA;IACxB,WAAW,EAAE,iBAAiB,CAAA;IAC9B,MAAM,EAAE,YAAY,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,cAAc,CAAA;IACxB,WAAW,EAAE;QACX,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;KACxB,CAAA;IACD,KAAK,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7C,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ,CAAA;QACd,YAAY,EAAE,YAAY,CAAA;QAC1B,MAAM,CAAC,EAAE;YAAE,SAAS,CAAC,EAAE,OAAO,CAAC;YAAC,KAAK,CAAC,EAAE,OAAO,CAAA;SAAE,CAAA;KAClD,CAAA;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,0DAA0D;IAC1D,IAAI,CAAC,EAAE,QAAQ,CAAA;IACf,+DAA+D;IAC/D,YAAY,CAAC,EAAE,YAAY,CAAA;IAC3B,gEAAgE;IAChE,MAAM,CAAC,EAAE;QACP,kEAAkE;QAClE,SAAS,CAAC,EAAE,OAAO,CAAA;QACnB,0CAA0C;QAC1C,KAAK,CAAC,EAAE,OAAO,CAAA;KAChB,CAAA;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,eAAe,CAAC,EAAE,MAAM,CAAA;QACxB,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;KACxB,CAAA;IACD,KAAK,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7C,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,OAAO,CAAC,EAAE;QACR,GAAG,CAAC,EAAE,MAAM,CAAA;QACZ,MAAM,CAAC,EAAE,MAAM,CAAA;QACf,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAA;KAC5B,GAAG,IAAI,CAAA;CACT;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAA;CAC5B;AAED,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,OAAO,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAID,MAAM,WAAW,kBAAkB;IACjC,kEAAkE;IAClE,QAAQ,EAAE,MAAM,CAAA;IAChB,2BAA2B;IAC3B,cAAc,EAAE,MAAM,CAAA;IACtB,kDAAkD;IAClD,MAAM,EAAE,MAAM,CAAA;IACd,yEAAyE;IACzE,OAAO,EAAE,MAAM,CAAA;IACf,sGAAsG;IACtG,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAID,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;IAC5C,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAID,MAAM,WAAW,qBAAqB;IACpC,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,MAAM,CAAA;IACtB,iBAAiB,EAAE,MAAM,CAAA;IACzB,iBAAiB,EAAE,MAAM,CAAA;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,qBAAqB,CAAA;IAC9B,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,cAAc,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACrE,SAAS,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAChD,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC1C,gBAAgB,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACtD,cAAc,EAAE;QACd,SAAS,EAAE,MAAM,CAAA;QACjB,MAAM,EAAE;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,SAAS,EAAE,MAAM,CAAC;YAAC,cAAc,EAAE,MAAM,CAAC;YAAC,cAAc,EAAE,MAAM,CAAC;YAAC,cAAc,CAAC,EAAE,MAAM,CAAA;SAAE,EAAE,CAAA;QACvH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACxB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAC1B,EAAE,CAAA;CACJ;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB;AAID,MAAM,WAAW,uBAAuB;IACtC,2BAA2B;IAC3B,cAAc,EAAE,MAAM,CAAA;IACtB,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAA;IACd,yEAAyE;IACzE,OAAO,EAAE,MAAM,CAAA;CAChB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+// ─── Video types ────────────────────────────────────────────────────────────
+export {};

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "@xformmedia/sdk",
+  "version": "0.5.3",
+  "description": "Official SDK for the xform.media service",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": ["dist", "README.md"],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "dev": "tsc -p tsconfig.build.json --watch"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}