@templatical/core 0.51.1 → 0.52.0

package/dist/cloud/index.d.ts

@@ -1,7 +1,6 @@
 import { AuthConfig, AuthRequestOptions, Block, CommentResponse, CommentsProvider, CustomFont, ExportResult, FontsConfig, HealthCheckResult, MediaProvider, PlanConfig, PlanFeatures, RenderProvider, SavedBlock, SavedBlocksProvider, SdkAuthConfig, Template, TemplateContent, TemplatePatch, TemplateVersionResponse, TemplatesProvider, TestEmailConfig, TestEmailProvider, UserConfig, VersionHistoryProvider, WebSocketServerConfig } from "@templatical/types";
 import { ComputedRef, Ref } from "vue";
 import { Channel, PresenceChannel } from "pusher-js";
-//#region src/cloud/auth.d.ts
 /**
  * Whether a token-refresh failure is worth interrupting the user over.
  *
@@ -51,8 +50,6 @@ export declare class AuthManager {
   authenticatedFetch(url: string, options?: RequestInit): Promise<Response>;
 }
 export declare function createSdkAuthManager(config: SdkAuthConfig, onError?: (error: Error) => void): AuthManager;
-//#endregion
-//#region src/cloud/api.d.ts
 export declare class ApiClient {
   private readonly authManager;
   constructor(authManager: AuthManager);
@@ -128,8 +125,6 @@ export declare class ApiClient {
   }>): Promise<SavedBlock>;
   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
@@ -210,8 +205,6 @@ export declare class MediaApiClient {
   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: {
   readonly health: "/api/v1/health";
@@ -251,8 +244,6 @@ export declare const API_ROUTES: {
   readonly "savedModules.update": "/api/v1/projects/{project}/tenants/{tenant}/saved-modules/{savedModule}";
   readonly "savedModules.destroy": "/api/v1/projects/{project}/tenants/{tenant}/saved-modules/{savedModule}";
 };
-//#endregion
-//#region src/cloud/websocket-client.d.ts
 interface WebSocketConfig {
   host: string;
   port: number;
@@ -283,8 +274,6 @@ export declare class WebSocketClient {
   getSocketId(): string | null;
   get isConnected(): boolean;
 }
-//#endregion
-//#region src/cloud/comments-provider.d.ts
 /**
  * The two methods this adapter needs from a Pusher channel, named structurally.
  *
@@ -337,8 +326,6 @@ interface CreateCloudCommentsProviderOptions {
  *   header is fine too.
  */
 export declare function createCloudCommentsProvider(options: CreateCloudCommentsProviderOptions): CommentsProvider;
-//#endregion
-//#region src/cloud/web-socket.d.ts
 interface UseWebSocketOptions {
   authManager: AuthManager;
   onError?: (error: Error) => void;
@@ -351,8 +338,6 @@ interface UseWebSocketReturn {
   getSocketId: () => string | null;
 }
 export declare function useWebSocket(options: UseWebSocketOptions): UseWebSocketReturn;
-//#endregion
-//#region src/cloud/saved-blocks-provider.d.ts
 /**
  * Cloud-backed {@link SavedBlocksProvider} — the Templatical Cloud adapter for
  * the same contract consumers implement themselves.
@@ -374,8 +359,6 @@ export declare function useWebSocket(options: UseWebSocketOptions): UseWebSocket
  * to "no timestamp label, every action allowed" rather than breaking.
  */
 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.
@@ -395,8 +378,6 @@ export declare function createCloudSavedBlocksProvider(authManager: AuthManager)
  * 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
  * same save/load contract consumers implement themselves.
@@ -424,8 +405,6 @@ export declare function createCloudMediaProvider(authManager: AuthManager, getPl
  * degrade all six silently.
  */
 export declare function createCloudTemplatesProvider(authManager: AuthManager): TemplatesProvider;
-//#endregion
-//#region src/cloud/render-provider.d.ts
 interface CreateCloudRenderProviderOptions {
   authManager: AuthManager;
   /** The loaded template's id, or `null` before one exists. */
@@ -463,8 +442,6 @@ interface CreateCloudRenderProviderOptions {
  * compiling.
  */
 export declare function createCloudRenderProvider(options: CreateCloudRenderProviderOptions): RenderProvider;
-//#endregion
-//#region src/cloud/version-history-provider.d.ts
 /**
  * Cloud-backed {@link VersionHistoryProvider} — the Templatical Cloud adapter for
  * the same contract consumers implement themselves.
@@ -479,8 +456,6 @@ export declare function createCloudRenderProvider(options: CreateCloudRenderProv
  * `create` here is for a version a person asked for.
  */
 export declare function createCloudVersionHistoryProvider(authManager: AuthManager): VersionHistoryProvider;
-//#endregion
-//#region src/cloud/test-email.d.ts
 /**
  * Cloud's test-email *configuration* — whether the project has the feature, who
  * may be sent to, and the signature that lets the backend verify that list.
@@ -508,8 +483,6 @@ interface UseTestEmailReturn {
   getSignature: () => string | null;
 }
 export declare function useTestEmail(options: UseTestEmailOptions): UseTestEmailReturn;
-//#endregion
-//#region src/cloud/test-email-provider.d.ts
 interface CreateCloudTestEmailProviderOptions {
   authManager: AuthManager;
   getTemplateId: () => string | null;
@@ -542,8 +515,6 @@ interface CreateCloudTestEmailProviderOptions {
  *   should not spend a render pass producing MJML nobody reads.
  */
 export declare function createCloudTestEmailProvider(options: CreateCloudTestEmailProviderOptions): TestEmailProvider;
-//#endregion
-//#region src/cloud/export.d.ts
 /** The fonts half of an export request, as Cloud's endpoint expects it. */
 interface ExportFontsPayload {
   customFonts: CustomFont[];
@@ -571,8 +542,6 @@ export declare function resolveExportFonts(fonts: FontsConfig | undefined): Expo
  * policy lives.
  */
 export declare function useExport(options: UseExportOptions): UseExportReturn;
-//#endregion
-//#region src/cloud/plan-config.d.ts
 interface UsePlanConfigOptions {
   authManager: AuthManager;
   onError?: (error: Error) => void;
@@ -585,13 +554,10 @@ interface UsePlanConfigReturn {
   fetchConfig: () => Promise<void>;
 }
 export declare function usePlanConfig(options: UsePlanConfigOptions): UsePlanConfigReturn;
-//#endregion
-//#region src/cloud/health-check.d.ts
 interface HealthCheckOptions {
   authManager?: AuthManager;
   baseUrl?: string;
 }
 export declare function performHealthCheck(options?: HealthCheckOptions): Promise<HealthCheckResult>;
-//#endregion
 export type { AuthConfig, AuthRequestOptions, CloudMediaBrowseParams, CloudMediaBrowseResponse, CloudMediaFolder, CloudMediaItem, CloudMediaUsageInfo, CloudMediaUsageResponse, CreateCloudCommentsProviderOptions, CreateCloudRenderProviderOptions, CreateCloudTestEmailProviderOptions, ExportFontsPayload, PresenceMember, RealtimeChannel, SdkAuthConfig, TestEmailConfig, UseExportOptions, UseExportReturn, UsePlanConfigOptions, UsePlanConfigReturn, UseTestEmailOptions, UseTestEmailReturn, UseWebSocketOptions, UseWebSocketReturn, UserConfig, WebSocketClientOptions, WebSocketConfig };
 //# sourceMappingURL=index.d.ts.map

package/dist/cloud/index.js

@@ -1,6 +1,6 @@
 import { SdkError } from "@templatical/types";
 import { computed, ref, watch } from "vue";
-//#region src/cloud/auth.ts
+// src/cloud/auth.ts
 /**
 * Whether a token-refresh failure is worth interrupting the user over.
 *
@@ -171,8 +171,7 @@ function createSdkAuthManager(config, onError) {
 		onError
 	});
 }
-//#endregion
-//#region src/cloud/url-builder.ts
+// src/cloud/url-builder.ts
 function buildUrl(template, params) {
 	return template.replace(/\{(\w+)\}/g, (_, key) => encodeURIComponent(params[key] ?? ""));
 }
@@ -219,8 +218,7 @@ const API_ROUTES = {
 	"savedModules.update": `${MODULES}/{savedModule}`,
 	"savedModules.destroy": `${MODULES}/{savedModule}`
 };
-//#endregion
-//#region src/cloud/api.ts
+// src/cloud/api.ts
 var ApiClient = class {
 	authManager;
 	constructor(authManager) {
@@ -431,8 +429,7 @@ var ApiClient = class {
 		}), { method: "DELETE" });
 	}
 };
-//#endregion
-//#region src/cloud/media-api.ts
+// src/cloud/media-api.ts
 /**
 * Cloud's HTTP client for media. Auth and project/tenant scoping come from
 * {@link AuthManager}. The BYO contract lives on
@@ -603,8 +600,7 @@ var MediaApiClient = class {
 		return (await response.json()).data;
 	}
 };
-//#endregion
-//#region src/cloud/websocket-client.ts
+// src/cloud/websocket-client.ts
 function resolveWebSocketConfig(serverConfig) {
 	return {
 		host: serverConfig.host,
@@ -684,8 +680,7 @@ var WebSocketClient = class {
 		return this.pusher?.connection.state === "connected";
 	}
 };
-//#endregion
-//#region src/cloud/comments-provider.ts
+// src/cloud/comments-provider.ts
 /** The Pusher event Cloud's backend fans comment writes out on. */
 const BROADCAST_EVENT = "comment-broadcast";
 /**
@@ -808,8 +803,7 @@ function createCloudCommentsProvider(options) {
 		}
 	};
 }
-//#endregion
-//#region src/cloud/web-socket.ts
+// src/cloud/web-socket.ts
 function useWebSocket(options) {
 	const { authManager, onError } = options;
 	const channel = ref(null);
@@ -855,8 +849,7 @@ function useWebSocket(options) {
 		getSocketId
 	};
 }
-//#endregion
-//#region src/cloud/saved-blocks-provider.ts
+// src/cloud/saved-blocks-provider.ts
 /**
 * Cloud-backed {@link SavedBlocksProvider} — the Templatical Cloud adapter for
 * the same contract consumers implement themselves.
@@ -894,8 +887,7 @@ function createCloudSavedBlocksProvider(authManager) {
 		}
 	};
 }
-//#endregion
-//#region src/cloud/media-provider.ts
+// src/cloud/media-provider.ts
 /**
 * Cloud's HTTP row → {@link MediaAsset}. Omits null optionals so
 * `thumbnailUrl` / `width` / `height` are absent rather than `null` —
@@ -1040,8 +1032,7 @@ function createCloudMediaProvider(authManager, getPlanConfig) {
 		}
 	};
 }
-//#endregion
-//#region src/cloud/templates-provider.ts
+// src/cloud/templates-provider.ts
 /**
 * How often a save may also record an automatic version. Cloud's storage, Cloud's
 * number — an editor-side default would be guessing on someone else's behalf.
@@ -1108,8 +1099,7 @@ function createCloudTemplatesProvider(authManager) {
 		}
 	};
 }
-//#endregion
-//#region src/cloud/export.ts
+// src/cloud/export.ts
 /**
 * Flatten a {@link FontsConfig} into the export payload.
 *
@@ -1146,8 +1136,7 @@ function useExport(options) {
 		getMjmlSource
 	};
 }
-//#endregion
-//#region src/cloud/render-provider.ts
+// src/cloud/render-provider.ts
 /**
 * Templatical Cloud's renderer, shaped as a {@link RenderProvider} so it plugs
 * into the same editor seam a consumer's own backend would.
@@ -1203,8 +1192,7 @@ function createCloudRenderProvider(options) {
 		}
 	};
 }
-//#endregion
-//#region src/cloud/version-history-provider.ts
+// src/cloud/version-history-provider.ts
 /**
 * Cloud's HTTP row → {@link TemplateVersion}. Copies the contract fields
 * and drops `templateId`.
@@ -1254,8 +1242,7 @@ function createCloudVersionHistoryProvider(authManager) {
 		}
 	};
 }
-//#endregion
-//#region src/cloud/test-email.ts
+// src/cloud/test-email.ts
 function useTestEmail(options) {
 	const { authManager, isAuthReady } = options;
 	const testEmailConfig = ref(null);
@@ -1273,8 +1260,7 @@ function useTestEmail(options) {
 		getSignature
 	};
 }
-//#endregion
-//#region src/cloud/test-email-provider.ts
+// src/cloud/test-email-provider.ts
 /**
 * Templatical Cloud's test-email sender, shaped as a {@link TestEmailProvider}
 * so it plugs into the same editor seam a consumer's own sender would.
@@ -1320,8 +1306,7 @@ function createCloudTestEmailProvider(options) {
 		}
 	};
 }
-//#endregion
-//#region src/cloud/plan-config.ts
+// src/cloud/plan-config.ts
 function usePlanConfig(options) {
 	const { authManager, onError } = options;
 	const config = ref(null);
@@ -1350,8 +1335,7 @@ function usePlanConfig(options) {
 		fetchConfig
 	};
 }
-//#endregion
-//#region src/cloud/health-check.ts
+// src/cloud/health-check.ts
 const WS_HANDSHAKE_TIMEOUT = 5e3;
 function resolveHealthUrl(options) {
 	if (options.authManager) return options.authManager.resolveUrl(API_ROUTES.health);
@@ -1463,7 +1447,6 @@ async function performHealthCheck(options = {}) {
 		overall: result.api.ok && result.auth.ok
 	};
 }
-//#endregion
 export { API_ROUTES, ApiClient, AuthManager, MediaApiClient, WebSocketClient, buildUrl, createCloudCommentsProvider, createCloudMediaProvider, createCloudRenderProvider, createCloudSavedBlocksProvider, createCloudTemplatesProvider, createCloudTestEmailProvider, createCloudVersionHistoryProvider, createSdkAuthManager, isFatalAuthError, performHealthCheck, resolveExportFonts, resolveWebSocketConfig, useExport, usePlanConfig, useTestEmail, useWebSocket };
 
 //# sourceMappingURL=index.js.map