@calmlens/sdk 0.16.2 → 0.17.1

package/cjs/vue.d.ts

@@ -0,0 +1,490 @@
+import { Dt as ViewerClaims, k as CdnTransform, m as AssetModerationStatus, w as CalmLensAppClientOptions } from "./CalmLensTypes-9Vt16pc7.js";
+import "./index-CI4BzN4W.js";
+import { A as CustomUploadResult, B as MediaAsset, C as getDropzoneHint, D as resolveMessages, E as getUploadItemOutcome, G as MediaState, H as MediaOptions, J as resolveMediaProps, K as getMediaState, L as UploadStage, M as UploadController, P as UploadFile, S as formatMessage, T as getUploadItemMessage, U as MediaSettings, V as MediaImageSource, W as MediaSource, _ as UploadItemView, a as createProgressFetch, b as describeUploader, c as IconName, d as UploaderDisplayOptions, g as DEFAULT_MESSAGES, h as CalmLensMessages, i as CALMLENS_STYLES, j as UploadClient, k as CustomUploadContext, l as MediaDisplayOptions, m as getMediaLoadKey, n as CalmLensTheme, o as ICONS, p as getMediaAspectRatio, q as pickMediaSource, r as resolveTheme, s as ICON_ATTRIBUTES, t as CALMLENS_THEME, u as MediaProps, v as UploaderView, w as getMediaUnavailableMessage, x as formatBytes, y as describeUploadItem, z as isFileAccepted } from "./ui-CgZpgpNo.js";
+import { a as UploaderProps, i as UploadSnapshot, n as UploadControllerOptions, r as UploadItem, s as createUploadController, t as CalmLensUpload } from "./BrowserUpload-uZjVFGfP.js";
+import { MaybeRefOrGetter, PropType, ShallowRef } from "vue";
+export interface UseCalmLensUploadResult<F extends UploadFile = File> {
+  snapshot: Readonly<ShallowRef<UploadSnapshot<F>>>;
+  controller: UploadController<F>;
+  addFiles: UploadController<F>["addFiles"];
+  retry: UploadController<F>["retry"];
+  cancel: UploadController<F>["cancel"];
+  remove: UploadController<F>["remove"];
+  clear: UploadController<F>["clear"];
+  start: UploadController<F>["start"];
+}
+/**
+ * Uploads files through an upload preset and keeps `snapshot` up to date as each one uploads and
+ * is checked. Use it to build your own upload UI; `CalmLensUploader` is built on it. Uploads
+ * still running when the component unmounts are cancelled.
+ */
+export declare const useCalmLensUpload: <F extends UploadFile = File>(options: MaybeRefOrGetter<UploadControllerOptions<F>>) => UseCalmLensUploadResult<F>;
+/**
+ * A drop zone and file list that uploads through an upload preset, shows each file's progress
+ * and moderation decision, and emits `uploaded` for finished uploads.
+ */
+export declare const CalmLensUploader: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+  uploadPresetId: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  upload: {
+    type: PropType<((file: File, context: CustomUploadContext) => Promise<CustomUploadResult>) | undefined>;
+    default: undefined;
+  };
+  checkStatus: {
+    type: PropType<((assetId: string, context: {
+      signal: AbortSignal;
+    }) => Promise<AssetModerationStatus | undefined>) | undefined>;
+    default: undefined;
+  };
+  createClient: {
+    type: PropType<((options: CalmLensAppClientOptions) => UploadClient) | undefined>;
+    default: undefined;
+  };
+  token: {
+    type: PropType<string | ((file: File) => string | Promise<string>) | undefined>;
+    default: undefined;
+  };
+  tokenUrl: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  accept: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  maxFileSize: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  autoUpload: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  multiple: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  maxFiles: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  concurrency: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  decisionTimeoutMs: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  baseUrl: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  disabled: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  capture: {
+    type: PropType<"environment" | "user">;
+    default: undefined;
+  };
+  messages: {
+    type: PropType<Partial<CalmLensMessages>>;
+    default: undefined;
+  };
+  controller: {
+    type: PropType<UploadController<File>>;
+    default: undefined;
+  };
+}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+  [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+  uploaded: (_upload: CalmLensUpload) => true;
+  rejected: (_item: UploadItem) => true;
+  failed: (_item: UploadItem) => true;
+  removed: (_item: UploadItem) => true;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+  uploadPresetId: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  upload: {
+    type: PropType<((file: File, context: CustomUploadContext) => Promise<CustomUploadResult>) | undefined>;
+    default: undefined;
+  };
+  checkStatus: {
+    type: PropType<((assetId: string, context: {
+      signal: AbortSignal;
+    }) => Promise<AssetModerationStatus | undefined>) | undefined>;
+    default: undefined;
+  };
+  createClient: {
+    type: PropType<((options: CalmLensAppClientOptions) => UploadClient) | undefined>;
+    default: undefined;
+  };
+  token: {
+    type: PropType<string | ((file: File) => string | Promise<string>) | undefined>;
+    default: undefined;
+  };
+  tokenUrl: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  accept: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  maxFileSize: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  autoUpload: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  multiple: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  maxFiles: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  concurrency: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  decisionTimeoutMs: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  baseUrl: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  disabled: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  capture: {
+    type: PropType<"environment" | "user">;
+    default: undefined;
+  };
+  messages: {
+    type: PropType<Partial<CalmLensMessages>>;
+    default: undefined;
+  };
+  controller: {
+    type: PropType<UploadController<File>>;
+    default: undefined;
+  };
+}>> & Readonly<{
+  onFailed?: ((_item: UploadItem) => any) | undefined;
+  onRejected?: ((_item: UploadItem) => any) | undefined;
+  onRemoved?: ((_item: UploadItem) => any) | undefined;
+  onUploaded?: ((_upload: CalmLensUpload) => any) | undefined;
+}>, {
+  uploadPresetId: string;
+  upload: ((file: File, context: CustomUploadContext) => Promise<CustomUploadResult>) | undefined;
+  checkStatus: ((assetId: string, context: {
+    signal: AbortSignal;
+  }) => Promise<AssetModerationStatus | undefined>) | undefined;
+  createClient: ((options: CalmLensAppClientOptions) => UploadClient) | undefined;
+  token: string | ((file: File) => string | Promise<string>) | undefined;
+  tokenUrl: string;
+  accept: string;
+  maxFileSize: number;
+  autoUpload: boolean;
+  multiple: boolean;
+  maxFiles: number;
+  concurrency: number;
+  decisionTimeoutMs: number;
+  baseUrl: string;
+  disabled: boolean;
+  capture: "environment" | "user";
+  messages: Partial<CalmLensMessages>;
+  controller: UploadController<File>;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+/**
+ * Shows an asset from the CalmLens CDN with responsive widths and a blurred placeholder while
+ * it loads. Age-restricted assets stay behind the placeholder and a reveal button until
+ * `ageConfirmed` is set; blocked and purged assets show an unavailable notice.
+ */
+export declare const CalmLensMedia: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+  /** An asset from the API, which supplies the project, ID, status, type and preview. */
+  asset: {
+    type: PropType<MediaAsset>;
+    default: undefined;
+  };
+  /** Required without `asset`. */
+  projectId: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  /** Required without `asset`. */
+  assetId: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  status: {
+    type: PropType<AssetModerationStatus>;
+    default: undefined;
+  };
+  contentRemoved: {
+    type: PropType<boolean>;
+    default: undefined;
+  };
+  type: {
+    type: PropType<"audio" | "image" | "video">;
+    default: undefined;
+  };
+  resource: {
+    type: PropType<"original" | "rendered">;
+    default: undefined;
+  };
+  lens: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  transform: {
+    type: PropType<CdnTransform>;
+    default: undefined;
+  };
+  widths: {
+    type: PropType<number[]>;
+    default: undefined;
+  };
+  url: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  placeholder: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  placeholderHash: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  placeholderUrl: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  averageColor: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  cdnBaseUrl: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  viewerClaims: {
+    type: PropType<ViewerClaims>;
+    default: undefined;
+  };
+  alt: {
+    type: StringConstructor;
+    default: string;
+  };
+  aspectRatio: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  width: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  height: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  sizes: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  fit: {
+    type: PropType<"contain" | "cover">;
+    default: undefined;
+  };
+  position: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  lazy: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  fetchPriority: {
+    type: PropType<"auto" | "high" | "low">;
+    default: undefined;
+  };
+  controls: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  messages: {
+    type: PropType<Partial<CalmLensMessages>>;
+    default: undefined;
+  };
+  /** Bound by `@reveal`; declared as a prop so the button shows only when something listens. */
+  onReveal: {
+    type: PropType<() => void>;
+    default: undefined;
+  };
+}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+  [key: string]: any;
+}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+  /** An asset from the API, which supplies the project, ID, status, type and preview. */
+  asset: {
+    type: PropType<MediaAsset>;
+    default: undefined;
+  };
+  /** Required without `asset`. */
+  projectId: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  /** Required without `asset`. */
+  assetId: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  status: {
+    type: PropType<AssetModerationStatus>;
+    default: undefined;
+  };
+  contentRemoved: {
+    type: PropType<boolean>;
+    default: undefined;
+  };
+  type: {
+    type: PropType<"audio" | "image" | "video">;
+    default: undefined;
+  };
+  resource: {
+    type: PropType<"original" | "rendered">;
+    default: undefined;
+  };
+  lens: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  transform: {
+    type: PropType<CdnTransform>;
+    default: undefined;
+  };
+  widths: {
+    type: PropType<number[]>;
+    default: undefined;
+  };
+  url: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  placeholder: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  placeholderHash: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  placeholderUrl: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  averageColor: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  cdnBaseUrl: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  viewerClaims: {
+    type: PropType<ViewerClaims>;
+    default: undefined;
+  };
+  alt: {
+    type: StringConstructor;
+    default: string;
+  };
+  aspectRatio: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  width: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  height: {
+    type: PropType<number>;
+    default: undefined;
+  };
+  sizes: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  fit: {
+    type: PropType<"contain" | "cover">;
+    default: undefined;
+  };
+  position: {
+    type: PropType<string>;
+    default: undefined;
+  };
+  lazy: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  fetchPriority: {
+    type: PropType<"auto" | "high" | "low">;
+    default: undefined;
+  };
+  controls: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  messages: {
+    type: PropType<Partial<CalmLensMessages>>;
+    default: undefined;
+  };
+  /** Bound by `@reveal`; declared as a prop so the button shows only when something listens. */
+  onReveal: {
+    type: PropType<() => void>;
+    default: undefined;
+  };
+}>> & Readonly<{}>, {
+  asset: MediaAsset;
+  projectId: string;
+  assetId: string;
+  status: AssetModerationStatus;
+  contentRemoved: boolean;
+  type: "audio" | "image" | "video";
+  resource: "original" | "rendered";
+  lens: string;
+  transform: CdnTransform;
+  widths: number[];
+  url: string;
+  placeholder: boolean;
+  placeholderHash: string;
+  placeholderUrl: string;
+  averageColor: string;
+  cdnBaseUrl: string;
+  viewerClaims: ViewerClaims;
+  alt: string;
+  aspectRatio: number;
+  width: number;
+  height: number;
+  sizes: string;
+  fit: "contain" | "cover";
+  position: string;
+  lazy: boolean;
+  fetchPriority: "auto" | "high" | "low";
+  controls: boolean;
+  messages: Partial<CalmLensMessages>;
+  onReveal: () => void;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export { CALMLENS_STYLES, CALMLENS_THEME, type CalmLensMessages, type CalmLensTheme, type CalmLensUpload, type CustomUploadContext, type CustomUploadResult, DEFAULT_MESSAGES, ICONS, ICON_ATTRIBUTES, type IconName, type MediaAsset, type MediaDisplayOptions, type MediaImageSource, type MediaOptions, type MediaProps, type MediaSettings, type MediaSource, type MediaState, type UploadClient, UploadController, type UploadControllerOptions, type UploadFile, type UploadItem, type UploadItemView, type UploadSnapshot, type UploadStage, type UploaderDisplayOptions, type UploaderProps, type UploaderView, createProgressFetch, createUploadController, describeUploadItem, describeUploader, formatBytes, formatMessage, getDropzoneHint, getMediaAspectRatio, getMediaLoadKey, getMediaState, getMediaUnavailableMessage, getUploadItemMessage, getUploadItemOutcome, isFileAccepted, pickMediaSource, resolveMediaProps, resolveMessages, resolveTheme };