@templatical/core 0.19.0 → 0.21.0

package/README.md

@@ -50,10 +50,12 @@ watch(editor.content, (next) => {
 - `useAutoSave` — debounced save with onSave callback
 - `useConditionPreview` — display condition preview state
 - `useDataSourceFetch` — fetch helper for custom block data sources
+- `useSavedBlocks` — reactive list/create/update/remove over a `SavedBlocksProvider` (saved blocks)
+- `createLocalStorageSavedBlocksProvider` — bundled browser-local `SavedBlocksProvider`, for demos and prototypes
 
 ## Cloud subpath
 
-The `@templatical/core/cloud` subpath provides Templatical Cloud integrations (Auth, API client, WebSocket, AI chat/rewrite, collaboration, comments, scoring). Used by `@templatical/editor`'s `initCloud()`. See [Cloud docs](https://docs.templatical.com/cloud/).
+The `@templatical/core/cloud` subpath provides Templatical Cloud integrations (Auth, API client, WebSocket, AI chat/rewrite, collaboration, comments, scoring, and `createCloudSavedBlocksProvider`). Used by `@templatical/editor`'s `initCloud()`. See [Cloud docs](https://docs.templatical.com/cloud/).
 
 ## Documentation
 

package/dist/cloud/index.d.ts

@@ -1,5 +1,5 @@
 import { r as UseEditorReturn$1 } from "../editor-BIIsaIoN.js";
-import { AiChatMessage, AiConfig, AuthConfig, AuthRequestOptions, Block, Collaborator, Comment, CommentEvent, CommentThread, CustomFont, EditorState, ExportResult, FontsConfig, HealthCheckResult, McpOperationPayload, MergeTag, PlanConfig, PlanFeatures, SavedModule, ScoringCategory, ScoringFinding, ScoringResult, SdkAuthConfig, Template, TemplateContent, TemplateDefaults, TemplateSettings, TemplateSnapshot, TestEmailConfig, UiTheme, UserConfig, ViewportSize, WebSocketServerConfig } from "@templatical/types";
+import { AiChatMessage, AiConfig, AuthConfig, AuthRequestOptions, Block, Collaborator, Comment, CommentEvent, CommentThread, CustomFont, EditorState, ExportResult, FontsConfig, HealthCheckResult, McpOperationPayload, MergeTag, PlanConfig, PlanFeatures, SavedBlock, SavedBlocksProvider, ScoringCategory, ScoringFinding, ScoringResult, SdkAuthConfig, Template, TemplateContent, TemplateDefaults, TemplateSettings, TemplateSnapshot, TestEmailConfig, UiTheme, UserConfig, ViewportSize, WebSocketServerConfig } from "@templatical/types";
 import { ComputedRef, DeepReadonly, Ref, ref } from "vue";
 import { Channel, PresenceChannel } from "pusher-js";
 //#region src/cloud/auth.d.ts
@@ -91,15 +91,17 @@ declare class ApiClient {
     user_signature: string;
   }, headers?: Record<string, string>): Promise<Comment>;
   fetchConfig(): Promise<PlanConfig>;
-  listModules(search?: string): Promise<SavedModule[]>;
+  listModules(search?: string, category?: string): Promise<SavedBlock[]>;
   createModule(data: {
     name: string;
     content: Block[];
-  }): Promise<SavedModule>;
+    category?: string;
+  }): Promise<SavedBlock>;
   updateModule(id: string, data: Partial<{
     name: string;
     content: Block[];
-  }>): Promise<SavedModule>;
+    category: string;
+  }>): Promise<SavedBlock>;
   deleteModule(id: string): Promise<void>;
 }
 //#endregion
@@ -408,23 +410,27 @@ interface UseWebSocketReturn {
 }
 declare function useWebSocket(options: UseWebSocketOptions): UseWebSocketReturn;
 //#endregion
-//#region src/cloud/saved-modules.d.ts
-interface UseSavedModulesOptions {
-  authManager: AuthManager;
-  onError?: (error: Error) => void;
-}
-interface UseSavedModulesReturn {
-  modules: Ref<SavedModule[]>;
-  isLoading: Ref<boolean>;
-  loadModules: (search?: string) => Promise<void>;
-  createModule: (name: string, content: Block[]) => Promise<SavedModule>;
-  updateModule: (id: string, data: Partial<{
-    name: string;
-    content: Block[];
-  }>) => Promise<SavedModule>;
-  deleteModule: (id: string) => Promise<void>;
-}
-declare function useSavedModules(options: UseSavedModulesOptions): UseSavedModulesReturn;
+//#region src/cloud/saved-blocks-provider.d.ts
+/**
+ * Cloud-backed {@link SavedBlocksProvider} — the Templatical Cloud adapter for
+ * the same contract consumers implement themselves.
+ *
+ * Auth (JWT via {@link AuthManager}) and project/tenant scoping live entirely
+ * on this side of the seam: the shared `useSavedBlocks` composable and the
+ * editor UI never see them. Plan gating is applied by the caller before this
+ * provider is constructed.
+ *
+ * Wraps the existing `ApiClient` saved-module endpoints, so the REST contract
+ * is unchanged from before saved blocks became an open-source feature.
+ *
+ * Rows pass straight through, unmapped: the Cloud endpoints speak the same
+ * `SavedBlock` shape the contract defines, so this adapter only supplies auth
+ * and scoping. That means the payload's field names track the contract — the
+ * backend serialises `category`, `canUpdate`, `canDelete`, `createdAt` and
+ * `updatedAt`. Until it does, those fields simply arrive absent, which degrades
+ * to "no timestamp label, every action allowed" rather than breaking.
+ */
+declare function createCloudSavedBlocksProvider(authManager: AuthManager): SavedBlocksProvider;
 //#endregion
 //#region src/cloud/snapshots.d.ts
 interface UseSnapshotHistoryOptions {
@@ -502,5 +508,5 @@ interface UseMcpListenerOptions {
 }
 declare function useMcpListener(options: UseMcpListenerOptions): void;
 //#endregion
-export { API_ROUTES, ApiClient, type AuthConfig, AuthManager, type AuthRequestOptions, type CommentBroadcastPayload, type DesignReferenceInput, type PresenceMember, type SdkAuthConfig, type TestEmailConfig, type UseAiChatOptions, type UseAiChatReturn, type UseAiConfigReturn, type UseAiRewriteOptions, type UseAiRewriteReturn, type UseCollaborationOptions, type UseCollaborationReturn, type UseCommentListenerOptions, type UseCommentsOptions, type UseCommentsReturn, type UseDesignReferenceOptions, type UseDesignReferenceReturn, type UseEditorOptions, type UseEditorReturn, type UseExportOptions, type UseExportReturn, type UseMcpListenerOptions, type UsePlanConfigOptions, type UsePlanConfigReturn, type UseSavedModulesOptions, type UseSavedModulesReturn, type UseSnapshotHistoryOptions, type UseSnapshotHistoryReturn, type UseTemplateScoringOptions, type UseTemplateScoringReturn, type UseTestEmailOptions, type UseTestEmailReturn, type UseWebSocketOptions, type UseWebSocketReturn, type UserConfig, WebSocketClient, type WebSocketClientOptions, type WebSocketConfig, buildUrl, createSdkAuthManager, handleOperation, performHealthCheck, resolveWebSocketConfig, useAiChat, useAiConfig, useAiRewrite, useCollaboration, useCollaborationBroadcast, useCommentListener, useComments, useDesignReference, useEditor, useExport, useMcpListener, usePlanConfig, useSavedModules, useSnapshotHistory, useTemplateScoring, useTestEmail, useWebSocket };
+export { API_ROUTES, ApiClient, type AuthConfig, AuthManager, type AuthRequestOptions, type CommentBroadcastPayload, type DesignReferenceInput, type PresenceMember, type SdkAuthConfig, type TestEmailConfig, type UseAiChatOptions, type UseAiChatReturn, type UseAiConfigReturn, type UseAiRewriteOptions, type UseAiRewriteReturn, type UseCollaborationOptions, type UseCollaborationReturn, type UseCommentListenerOptions, type UseCommentsOptions, type UseCommentsReturn, type UseDesignReferenceOptions, type UseDesignReferenceReturn, type UseEditorOptions, type UseEditorReturn, type UseExportOptions, type UseExportReturn, type UseMcpListenerOptions, type UsePlanConfigOptions, type UsePlanConfigReturn, type UseSnapshotHistoryOptions, type UseSnapshotHistoryReturn, type UseTemplateScoringOptions, type UseTemplateScoringReturn, type UseTestEmailOptions, type UseTestEmailReturn, type UseWebSocketOptions, type UseWebSocketReturn, type UserConfig, WebSocketClient, type WebSocketClientOptions, type WebSocketConfig, buildUrl, createCloudSavedBlocksProvider, createSdkAuthManager, handleOperation, performHealthCheck, resolveWebSocketConfig, useAiChat, useAiConfig, useAiRewrite, useCollaboration, useCollaborationBroadcast, useCommentListener, useComments, useDesignReference, useEditor, useExport, useMcpListener, usePlanConfig, useSnapshotHistory, useTemplateScoring, useTestEmail, useWebSocket };
 //# sourceMappingURL=index.d.ts.map

package/dist/cloud/index.js

@@ -368,9 +368,12 @@ var ApiClient = class {
 	async fetchConfig() {
 		return this.request(buildUrl(API_ROUTES["projects.config"], this.baseParams));
 	}
-	async listModules(search) {
+	async listModules(search, category) {
 		const url = buildUrl(API_ROUTES["savedModules.index"], this.baseParams);
-		const query = search ? `?search=${encodeURIComponent(search)}` : "";
+		const params = new URLSearchParams();
+		if (search) params.set("search", search);
+		if (category) params.set("category", category);
+		const query = params.size > 0 ? `?${params}` : "";
 		return this.request(`${url}${query}`);
 	}
 	async createModule(data) {
@@ -1912,61 +1915,41 @@ function useWebSocket(options) {
 	};
 }
 //#endregion
-//#region src/cloud/saved-modules.ts
-function useSavedModules(options) {
-	const api = new ApiClient(options.authManager);
-	const modules = ref([]);
-	const isLoading = ref(false);
-	async function loadModules(search) {
-		isLoading.value = true;
-		try {
-			modules.value = await api.listModules(search);
-		} catch (error) {
-			options.onError?.(error);
-			throw error;
-		} finally {
-			isLoading.value = false;
-		}
-	}
-	async function createModule(name, content) {
-		try {
-			const module = await api.createModule({
-				name,
-				content
-			});
-			modules.value = [module, ...modules.value];
-			return module;
-		} catch (error) {
-			options.onError?.(error);
-			throw error;
-		}
-	}
-	async function updateModule(id, data) {
-		try {
-			const updated = await api.updateModule(id, data);
-			modules.value = modules.value.map((m) => m.id === id ? updated : m);
-			return updated;
-		} catch (error) {
-			options.onError?.(error);
-			throw error;
-		}
-	}
-	async function deleteModule(id) {
-		try {
-			await api.deleteModule(id);
-			modules.value = modules.value.filter((m) => m.id !== id);
-		} catch (error) {
-			options.onError?.(error);
-			throw error;
-		}
-	}
+//#region src/cloud/saved-blocks-provider.ts
+/**
+* Cloud-backed {@link SavedBlocksProvider} — the Templatical Cloud adapter for
+* the same contract consumers implement themselves.
+*
+* Auth (JWT via {@link AuthManager}) and project/tenant scoping live entirely
+* on this side of the seam: the shared `useSavedBlocks` composable and the
+* editor UI never see them. Plan gating is applied by the caller before this
+* provider is constructed.
+*
+* Wraps the existing `ApiClient` saved-module endpoints, so the REST contract
+* is unchanged from before saved blocks became an open-source feature.
+*
+* Rows pass straight through, unmapped: the Cloud endpoints speak the same
+* `SavedBlock` shape the contract defines, so this adapter only supplies auth
+* and scoping. That means the payload's field names track the contract — the
+* backend serialises `category`, `canUpdate`, `canDelete`, `createdAt` and
+* `updatedAt`. Until it does, those fields simply arrive absent, which degrades
+* to "no timestamp label, every action allowed" rather than breaking.
+*/
+function createCloudSavedBlocksProvider(authManager) {
+	const api = new ApiClient(authManager);
 	return {
-		modules,
-		isLoading,
-		loadModules,
-		createModule,
-		updateModule,
-		deleteModule
+		list(params) {
+			return api.listModules(params?.search, params?.category);
+		},
+		create(input) {
+			return api.createModule(input);
+		},
+		update(id, patch) {
+			return api.updateModule(id, patch);
+		},
+		delete(id) {
+			return api.deleteModule(id);
+		}
 	};
 }
 //#endregion
@@ -2239,6 +2222,6 @@ function useMcpListener(options) {
 	});
 }
 //#endregion
-export { API_ROUTES, ApiClient, AuthManager, WebSocketClient, buildUrl, createSdkAuthManager, handleOperation, performHealthCheck, resolveWebSocketConfig, useAiChat, useAiConfig, useAiRewrite, useCollaboration, useCollaborationBroadcast, useCommentListener, useComments, useDesignReference, useEditor, useExport, useMcpListener, usePlanConfig, useSavedModules, useSnapshotHistory, useTemplateScoring, useTestEmail, useWebSocket };
+export { API_ROUTES, ApiClient, AuthManager, WebSocketClient, buildUrl, createCloudSavedBlocksProvider, createSdkAuthManager, handleOperation, performHealthCheck, resolveWebSocketConfig, useAiChat, useAiConfig, useAiRewrite, useCollaboration, useCollaborationBroadcast, useCommentListener, useComments, useDesignReference, useEditor, useExport, useMcpListener, usePlanConfig, useSnapshotHistory, useTemplateScoring, useTestEmail, useWebSocket };
 
 //# sourceMappingURL=index.js.map