@templatical/core 0.35.0 → 0.37.0

package/dist/cloud/index.d.ts

@@ -1,5 +1,5 @@
 import { r as UseEditorReturn } from "../editor-Bl4WsPU3.js";
-import { AiChatMessage, AiConfig, AuthConfig, AuthRequestOptions, Block, Collaborator, CommentResponse, CommentsProvider, CustomFont, ExportResult, FontsConfig, HealthCheckResult, McpOperationPayload, MergeTag, PlanConfig, PlanFeatures, RenderProvider, SavedBlock, SavedBlocksProvider, ScoringCategory, ScoringFinding, ScoringResult, SdkAuthConfig, Template, TemplateContent, TemplatePatch, TemplateVersionResponse, TemplatesProvider, TestEmailConfig, TestEmailProvider, UserConfig, VersionHistoryProvider, WebSocketServerConfig } from "@templatical/types";
+import { AiChatMessage, AiConfig, AuthConfig, AuthRequestOptions, Block, Collaborator, CommentResponse, CommentsProvider, CustomFont, ExportResult, FontsConfig, HealthCheckResult, McpOperationPayload, MediaProvider, MergeTag, PlanConfig, PlanFeatures, RenderProvider, SavedBlock, SavedBlocksProvider, ScoringCategory, ScoringFinding, ScoringResult, SdkAuthConfig, Template, TemplateContent, TemplatePatch, TemplateVersionResponse, TemplatesProvider, TestEmailConfig, TestEmailProvider, UserConfig, VersionHistoryProvider, WebSocketServerConfig } from "@templatical/types";
 import { ComputedRef, Ref, ref } from "vue";
 import { Channel, PresenceChannel } from "pusher-js";
 //#region src/cloud/auth.d.ts
@@ -86,34 +86,34 @@ export declare class ApiClient {
   sendTestEmail(templateId: string, payload: {
     recipient: string;
     html: string;
-    allowed_emails: string[];
+    allowedEmails: string[];
     signature: string;
   }): Promise<void>;
   private commentsUrl;
   getComments(templateId: string): Promise<CommentResponse[]>;
   createComment(templateId: string, data: {
     body: string;
-    block_id?: string;
-    parent_id?: string;
-    user_id: string;
-    user_name: string;
-    user_signature: string;
+    blockId?: string;
+    parentId?: string;
+    userId: string;
+    userName: string;
+    userSignature: string;
   }, headers?: Record<string, string>): Promise<CommentResponse>;
   updateComment(templateId: string, commentId: string, data: {
     body: string;
-    user_id: string;
-    user_name: string;
-    user_signature: string;
+    userId: string;
+    userName: string;
+    userSignature: string;
   }, headers?: Record<string, string>): Promise<CommentResponse>;
   deleteComment(templateId: string, commentId: string, data: {
-    user_id: string;
-    user_name: string;
-    user_signature: string;
+    userId: string;
+    userName: string;
+    userSignature: string;
   }, headers?: Record<string, string>): Promise<void>;
   resolveComment(templateId: string, commentId: string, data: {
-    user_id: string;
-    user_name: string;
-    user_signature: string;
+    userId: string;
+    userName: string;
+    userSignature: string;
   }, headers?: Record<string, string>): Promise<CommentResponse>;
   fetchConfig(): Promise<PlanConfig>;
   listModules(search?: string, category?: string): Promise<SavedBlock[]>;
@@ -130,6 +130,88 @@ export declare class ApiClient {
   deleteModule(id: string): Promise<void>;
 }
 //#endregion
+//#region src/cloud/media-api.d.ts
+/**
+ * Cloud's HTTP row for one media file. Same field names as
+ * {@link MediaAsset}. `thumbnailUrl` is optional; omit it and the grid
+ * uses `url`.
+ */
+interface CloudMediaItem {
+  id: string;
+  filename: string;
+  mimeType: string;
+  size: number;
+  url: string;
+  thumbnailUrl?: string | null;
+  folderId: string | null;
+  width: number | null;
+  height: number | null;
+  alt: string;
+  createdAt: string;
+  updatedAt: string;
+}
+/**
+ * Cloud's wire shape for one folder. The index endpoint may return a tree
+ * (`children`) or a flat list (`parentId`); the adapter flattens either.
+ */
+interface CloudMediaFolder {
+  id: string;
+  name: string;
+  parentId?: string | null;
+  children?: CloudMediaFolder[];
+  projectId?: string;
+  createdAt?: string;
+}
+interface CloudMediaBrowseParams {
+  folderId?: string | null;
+  search?: string;
+  category?: string;
+  sort?: string;
+  cursor?: string;
+}
+interface CloudMediaBrowseResponse {
+  data: CloudMediaItem[];
+  meta: {
+    path: string;
+    perPage: number;
+    nextCursor: string | null;
+    prevCursor: string | null;
+  };
+}
+interface CloudMediaUsageInfo {
+  templateCount: number;
+  templateNames: string[];
+}
+interface CloudMediaUsageResponse {
+  data: Record<string, CloudMediaUsageInfo>;
+}
+/**
+ * Cloud's HTTP client for media. Auth and project/tenant scoping come from
+ * {@link AuthManager}. The BYO contract lives on
+ * `createCloudMediaProvider`, which maps this client's rows.
+ */
+export declare class MediaApiClient {
+  private readonly authManager;
+  constructor(authManager: AuthManager);
+  private get projectId();
+  private get tenantSlug();
+  private get baseParams();
+  private request;
+  browseMedia(params: CloudMediaBrowseParams): Promise<CloudMediaBrowseResponse>;
+  uploadMedia(file: File, folderId?: string | null): Promise<CloudMediaItem>;
+  updateMedia(mediaId: string, filename?: string, alt?: string): Promise<CloudMediaItem>;
+  deleteMedia(ids: string[]): Promise<void>;
+  moveMedia(ids: string[], folderId: string | null): Promise<CloudMediaItem[]>;
+  getMediaFolders(): Promise<CloudMediaFolder[]>;
+  createMediaFolder(name: string, parentId?: string | null): Promise<CloudMediaFolder>;
+  renameMediaFolder(folderId: string, name: string): Promise<CloudMediaFolder>;
+  deleteMediaFolder(folderId: string): Promise<void>;
+  checkMediaUsage(ids: string[]): Promise<CloudMediaUsageResponse>;
+  getFrequentlyUsed(): Promise<CloudMediaItem[]>;
+  importFromUrl(url: string, folderId?: string | null): Promise<CloudMediaItem>;
+  replaceMedia(mediaId: string, file: File): Promise<CloudMediaItem>;
+}
+//#endregion
 //#region src/cloud/url-builder.d.ts
 export declare function buildUrl(template: string, params: Record<string, string>): string;
 export declare const API_ROUTES: {
@@ -345,7 +427,7 @@ interface CreateCloudCommentsProviderOptions {
  * Two things about the write payloads are Cloud's alone and stay on this side of
  * the seam:
  *
- * - **The author is signed.** `user_id` / `user_name` / `user_signature` come from
+ * - **The author is signed.** `userId` / `userName` / `userSignature` come from
  *   the JWT, not from the editor's `user` config, so a browser cannot attribute a
  *   comment to someone else. The editor's `user` key still gates the feature and
  *   drives "you wrote this" in the UI; the two agree because `initCloud()` fills
@@ -433,6 +515,27 @@ export declare function useWebSocket(options: UseWebSocketOptions): UseWebSocket
  */
 export declare function createCloudSavedBlocksProvider(authManager: AuthManager): SavedBlocksProvider;
 //#endregion
+//#region src/cloud/media-provider.d.ts
+/**
+ * Cloud-backed {@link MediaProvider} — the Templatical Cloud adapter for the
+ * same DAM contract consumers implement themselves.
+ *
+ * Every method is a function: Cloud's media storage is what the plan pays
+ * for, so there is no Cloud tier that can list but not upload. A consumer
+ * who wants a read-only gallery supplies their own provider with the
+ * mutations set to `false`.
+ *
+ * **Ignores `templateId`.** Cloud's library is project-scoped; a CMS that
+ * scopes a gallery per template reads that param in its own `list`.
+ *
+ * **`storage` / `maxFileSize` / `mimeTypes` are live.** They read
+ * `getPlanConfig()` at call time, because plan config arrives after
+ * construction. Snapshotting at setup would pin `storage()` to `null` and
+ * hide the quota ring for the whole session. A spread of this object
+ * freezes the getters — `initCloud()` must `Object.assign`, never spread.
+ */
+export declare function createCloudMediaProvider(authManager: AuthManager, getPlanConfig?: () => PlanConfig | null): MediaProvider;
+//#endregion
 //#region src/cloud/templates-provider.d.ts
 /**
  * Cloud-backed {@link TemplatesProvider} — the Templatical Cloud adapter for the
@@ -638,5 +741,5 @@ interface UseMcpListenerOptions {
 }
 export declare function useMcpListener(options: UseMcpListenerOptions): void;
 //#endregion
-export type { AuthConfig, AuthRequestOptions, CreateCloudCommentsProviderOptions, CreateCloudRenderProviderOptions, CreateCloudTestEmailProviderOptions, DesignReferenceInput, ExportFontsPayload, PresenceMember, RealtimeChannel, SdkAuthConfig, TestEmailConfig, UseAiChatOptions, UseAiChatReturn, UseAiConfigReturn, UseAiRewriteOptions, UseAiRewriteReturn, UseCollaborationOptions, UseCollaborationReturn, UseDesignReferenceOptions, UseDesignReferenceReturn, UseExportOptions, UseExportReturn, UseMcpListenerOptions, UsePlanConfigOptions, UsePlanConfigReturn, UseTemplateScoringOptions, UseTemplateScoringReturn, UseTestEmailOptions, UseTestEmailReturn, UseWebSocketOptions, UseWebSocketReturn, UserConfig, WebSocketClientOptions, WebSocketConfig };
+export type { AuthConfig, AuthRequestOptions, CloudMediaBrowseParams, CloudMediaBrowseResponse, CloudMediaFolder, CloudMediaItem, CloudMediaUsageInfo, CloudMediaUsageResponse, CreateCloudCommentsProviderOptions, CreateCloudRenderProviderOptions, CreateCloudTestEmailProviderOptions, DesignReferenceInput, ExportFontsPayload, PresenceMember, RealtimeChannel, SdkAuthConfig, TestEmailConfig, UseAiChatOptions, UseAiChatReturn, UseAiConfigReturn, UseAiRewriteOptions, UseAiRewriteReturn, UseCollaborationOptions, UseCollaborationReturn, UseDesignReferenceOptions, UseDesignReferenceReturn, UseExportOptions, UseExportReturn, UseMcpListenerOptions, UsePlanConfigOptions, UsePlanConfigReturn, UseTemplateScoringOptions, UseTemplateScoringReturn, UseTestEmailOptions, UseTestEmailReturn, UseWebSocketOptions, UseWebSocketReturn, UserConfig, WebSocketClientOptions, WebSocketConfig };
 //# sourceMappingURL=index.d.ts.map