@mestra-dev/contract 0.0.12 → 0.0.14

package/README.md

@@ -27,9 +27,18 @@ import { hc } from 'hono/client'
 const client = hc<AppType>('https://api.mestra.chat/')
 
 const res = await client.auth.me.$get()
-const data = await res.json()
+
+if (res.ok) {
+  const data = await res.json()
+} else if (res.status === 403) {
+  const err = await res.json() // { success: false, error: string }
+} else if (res.status === 404) {
+  const err = await res.json()
+}
 ```
 
+`AppType` includes per-route error bodies (400/403/404/…) plus global middleware errors (JWT, workspace access, rate limit → 400/401/403/404/429/500).
+
 Always use `import type` so the bundler never pulls server code.
 
 ## Build (maintainers)

package/dist/index.d.ts

@@ -1,6 +1,12 @@
-import { JwtVariables } from 'hono/jwt';
+import type { ApplyGlobalResponse } from 'hono/client';
+import type { JwtVariables } from 'hono/jwt';
 
 type Variables = JwtVariables;
+/** Shared error body for middleware / HTTPException responses (typed into AppType). */
+export type ApiError = {
+	success: false;
+	error: string;
+};
 declare const routes: import("hono/hono-base").HonoBase<{
 	Variables: Variables;
 }, ({
@@ -20,7 +26,7 @@ declare const routes: import("hono/hono-base").HonoBase<{
 				readonly openapi: "3.0.3";
 				readonly info: {
 					readonly title: "Auth Service API";
-					readonly version: "1.5.2";
+					readonly version: "1.5.3";
 					readonly description: "OpenAPI specification for the Auth, Integrations, Workspace, Tasks, Templates, Tags, Comments, Assignees, Chat, Events, Billings, Files, and Notifications endpoints exposed by the k3-core platform.";
 				};
 				readonly servers: readonly [
@@ -96,7 +102,7 @@ declare const routes: import("hono/hono-base").HonoBase<{
 					},
 					{
 						readonly name: "Notifications";
-						readonly description: "Cursor-based incremental notification sync, plus mark-read and archive. Clients store the sync cursor and pass it on the next call; read/archive bump updated_at so changes propagate via sync.";
+						readonly description: "Cursor-based incremental notification sync, plus mark-read / archive (single or all). Clients store the sync cursor and pass it on the next call; mutations bump updated_at so changes propagate via sync.";
 					}
 				];
 				readonly components: {
@@ -10178,6 +10184,36 @@ declare const routes: import("hono/hono-base").HonoBase<{
 							};
 						};
 					};
+					readonly "/notifications/read-all": {
+						readonly post: {
+							readonly tags: readonly [
+								"Notifications"
+							];
+							readonly summary: "Mark all notifications as read";
+							readonly description: "Sets `read=true` and bumps `updated_at` on every unread notification owned by the authenticated user so the changes are picked up by `/notifications/sync`. Requires a valid access token (no workspace policy check).";
+							readonly security: readonly [
+								never
+							];
+							readonly responses: {
+								readonly 200: {
+									readonly description: "All unread notifications marked as read.";
+									readonly content: {
+										readonly "application/json": {
+											readonly schema: {
+												readonly $ref: "#/components/schemas/SimpleSuccess";
+											};
+										};
+									};
+								};
+								readonly 401: {
+									readonly description: "Unauthorized - Missing or invalid access token.";
+								};
+								readonly 403: {
+									readonly description: "Forbidden - Token issuer is not 'access'.";
+								};
+							};
+						};
+					};
 					readonly "/notifications/archive": {
 						readonly post: {
 							readonly tags: readonly [
@@ -10238,6 +10274,36 @@ declare const routes: import("hono/hono-base").HonoBase<{
 							};
 						};
 					};
+					readonly "/notifications/archive-all": {
+						readonly post: {
+							readonly tags: readonly [
+								"Notifications"
+							];
+							readonly summary: "Archive all notifications";
+							readonly description: "Sets `archive=true` and bumps `updated_at` on every unarchived notification owned by the authenticated user so the changes are picked up by `/notifications/sync`. Requires a valid access token (no workspace policy check).";
+							readonly security: readonly [
+								never
+							];
+							readonly responses: {
+								readonly 200: {
+									readonly description: "All unarchived notifications archived.";
+									readonly content: {
+										readonly "application/json": {
+											readonly schema: {
+												readonly $ref: "#/components/schemas/SimpleSuccess";
+											};
+										};
+									};
+								};
+								readonly 401: {
+									readonly description: "Unauthorized - Missing or invalid access token.";
+								};
+								readonly 403: {
+									readonly description: "Forbidden - Token issuer is not 'access'.";
+								};
+							};
+						};
+					};
 					readonly "/chat/start": {
 						readonly post: {
 							readonly tags: readonly [
@@ -16046,6 +16112,17 @@ declare const routes: import("hono/hono-base").HonoBase<{
 			status: 200;
 		};
 	};
+} & {
+	"/read-all": {
+		$post: {
+			input: {};
+			output: {
+				success: true;
+			};
+			outputFormat: "json";
+			status: 200;
+		};
+	};
 } & {
 	"/archive": {
 		$post: {
@@ -16073,5 +16150,37 @@ declare const routes: import("hono/hono-base").HonoBase<{
 			status: 200;
 		};
 	};
+} & {
+	"/archive-all": {
+		$post: {
+			input: {};
+			output: {
+				success: true;
+			};
+			outputFormat: "json";
+			status: 200;
+		};
+	};
 }, "/notifications">, "/", "/">;
-export type AppType = typeof routes;
+type GlobalErrorResponses = {
+	400: {
+		json: ApiError;
+	};
+	401: {
+		json: ApiError;
+	};
+	403: {
+		json: ApiError;
+	};
+	404: {
+		json: ApiError;
+	};
+	429: {
+		json: ApiError;
+	};
+	500: {
+		json: ApiError;
+	};
+};
+/** AppType for `hc` — includes route responses plus global auth/middleware error statuses. */
+export type AppType = ApplyGlobalResponse<typeof routes, GlobalErrorResponses>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mestra-dev/contract",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "Types-only Hono AppType contract for the Mestra auth API",
   "type": "module",
   "sideEffects": false,