@mestra-dev/contract 0.0.10 → 0.0.11

package/dist/index.d.ts

@@ -93,6 +93,10 @@ declare const routes: import("hono/hono-base").HonoBase<{
 					{
 						readonly name: "Chat";
 						readonly description: "Matrix (Synapse) chat session bootstrap and chat-tenant collaborator listing; owners get an `owner_` username prefix; caches Matrix access tokens. Requires workspace access and crm::chats read.";
+					},
+					{
+						readonly name: "Notifications";
+						readonly description: "Cursor-based incremental notification sync for the authenticated user. Clients store the returned cursor and pass it on the next call to receive only notifications created or updated since.";
 					}
 				];
 				readonly components: {
@@ -219,6 +223,110 @@ declare const routes: import("hono/hono-base").HonoBase<{
 								};
 							};
 						};
+						readonly Notification: {
+							readonly type: "object";
+							readonly required: readonly [
+								"id",
+								"userId",
+								"workspaceId",
+								"title",
+								"message",
+								"type",
+								"read",
+								"archive",
+								"created_at"
+							];
+							readonly properties: {
+								readonly id: {
+									readonly type: "string";
+									readonly format: "uuid";
+								};
+								readonly userId: {
+									readonly type: "string";
+									readonly format: "uuid";
+								};
+								readonly workspaceId: {
+									readonly type: "string";
+									readonly format: "uuid";
+								};
+								readonly title: {
+									readonly type: "string";
+									readonly maxLength: 256;
+								};
+								readonly message: {
+									readonly type: "string";
+									readonly maxLength: 256;
+								};
+								readonly type: {
+									readonly type: "string";
+									readonly maxLength: 50;
+									readonly description: "Notification category (application-defined).";
+								};
+								readonly read: {
+									readonly type: "boolean";
+								};
+								readonly archive: {
+									readonly type: "boolean";
+								};
+								readonly created_at: {
+									readonly type: "string";
+									readonly format: "date-time";
+								};
+								readonly updated_at: {
+									readonly type: "string";
+									readonly format: "date-time";
+									readonly nullable: true;
+									readonly description: "Set when the notification is marked read or archived.";
+								};
+								readonly deleted_at: {
+									readonly type: "string";
+									readonly format: "date-time";
+									readonly nullable: true;
+								};
+								readonly verified_at: {
+									readonly type: "string";
+									readonly format: "date-time";
+									readonly nullable: true;
+								};
+								readonly suspended_at: {
+									readonly type: "string";
+									readonly format: "date-time";
+									readonly nullable: true;
+								};
+							};
+						};
+						readonly NotificationSyncSuccess: {
+							readonly type: "object";
+							readonly required: readonly [
+								"success",
+								"notifications",
+								"cursor",
+								"hasMore"
+							];
+							readonly properties: {
+								readonly success: {
+									readonly type: "boolean";
+									readonly const: true;
+								};
+								readonly notifications: {
+									readonly type: "array";
+									readonly items: {
+										readonly $ref: "#/components/schemas/Notification";
+									};
+									readonly description: "Notifications created or updated after the request cursor, oldest change first.";
+								};
+								readonly cursor: {
+									readonly type: "string";
+									readonly format: "date-time";
+									readonly nullable: true;
+									readonly description: "Newest change timestamp in this page. Store it and pass it as `cursor` on the next sync. Null only when no cursor was sent and no notifications exist.";
+								};
+								readonly hasMore: {
+									readonly type: "boolean";
+									readonly description: "True when more changes remain; call again immediately with the returned cursor.";
+								};
+							};
+						};
 						readonly CreateWorkspaceSuccess: {
 							readonly type: "object";
 							readonly required: readonly [
@@ -758,6 +866,11 @@ declare const routes: import("hono/hono-base").HonoBase<{
 								readonly workspaceName: {
 									readonly type: "string";
 								};
+								readonly profilePicture: {
+									readonly type: "string";
+									readonly nullable: true;
+									readonly description: "Presigned workspace avatar URL from `workspaces.picture` (7-day expiry); null or empty when unset.";
+								};
 								readonly workspaceCategory: {
 									readonly $ref: "#/components/schemas/WorkspaceCategory";
 								};
@@ -4111,7 +4224,7 @@ declare const routes: import("hono/hono-base").HonoBase<{
 								"Workspace"
 							];
 							readonly summary: "List workspaces for the authenticated user";
-							readonly description: "Returns workspaces the user collaborates on, each with category, role, billing flags, invitation state, and the resource grants effective for the caller.";
+							readonly description: "Returns workspaces the user collaborates on, each with category, role, billing flags, invitation state, workspace profile picture URL, and the resource grants effective for the caller.";
 							readonly security: readonly [
 								never
 							];
@@ -9906,6 +10019,70 @@ declare const routes: import("hono/hono-base").HonoBase<{
 							};
 						};
 					};
+					readonly "/notifications/sync": {
+						readonly get: {
+							readonly tags: readonly [
+								"Notifications"
+							];
+							readonly summary: "Sync notifications incrementally";
+							readonly description: "Returns the authenticated user's notifications created or updated after the given `cursor` (change timestamp = greatest of created_at/updated_at), ordered oldest change first. Without a cursor, returns notifications from the beginning. Responses are paged by `limit`; when `hasMore` is true, call again with the returned cursor until it is false. Marking notifications read or archived bumps their change timestamp, so state changes propagate to all of the user's devices. Requires a valid access token (no workspace policy check).";
+							readonly security: readonly [
+								never
+							];
+							readonly parameters: readonly [
+								{
+									readonly name: "cursor";
+									readonly in: "query";
+									readonly required: false;
+									readonly schema: {
+										readonly type: "string";
+										readonly format: "date-time";
+									};
+									readonly description: "Change timestamp returned by the previous sync call (ISO 8601). Omit for a full initial sync.";
+								},
+								{
+									readonly name: "limit";
+									readonly in: "query";
+									readonly required: false;
+									readonly schema: {
+										readonly type: "integer";
+										readonly minimum: 1;
+										readonly maximum: 200;
+										readonly default: 100;
+									};
+									readonly description: "Maximum notifications per page.";
+								}
+							];
+							readonly responses: {
+								readonly 200: {
+									readonly description: "Changed notifications with the next cursor.";
+									readonly content: {
+										readonly "application/json": {
+											readonly schema: {
+												readonly $ref: "#/components/schemas/NotificationSyncSuccess";
+											};
+										};
+									};
+								};
+								readonly 400: {
+									readonly description: "Invalid cursor or limit query parameter.";
+									readonly content: {
+										readonly "application/json": {
+											readonly schema: {
+												readonly $ref: "#/components/schemas/ErrorResponse";
+											};
+										};
+									};
+								};
+								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 [
@@ -10321,6 +10498,7 @@ declare const routes: import("hono/hono-base").HonoBase<{
 				workspaces: {
 					workspaceId: string;
 					workspaceName: string;
+					profilePicture: string | null;
 					workspaceCategory: string;
 					role: string;
 					maxCollaborators: number;
@@ -10806,9 +10984,10 @@ declare const routes: import("hono/hono-base").HonoBase<{
 			output: {
 				success: true;
 				task: {
-					status: string | null;
 					id: string;
 					workspaceId: string;
+					created_at: string;
+					status: string | null;
 					description: string | null;
 					subject: string;
 					created_by: string;
@@ -10817,7 +10996,6 @@ declare const routes: import("hono/hono-base").HonoBase<{
 					deleted_at: string | null;
 					verified_at: string | null;
 					suspended_at: string | null;
-					created_at: string;
 					priority: string | null;
 					visibility: string | null;
 				};
@@ -11067,16 +11245,16 @@ declare const routes: import("hono/hono-base").HonoBase<{
 			output: {
 				success: true;
 				template: {
-					title: string;
 					id: string;
 					workspaceId: string;
+					title: string;
+					created_at: string;
 					created_by: string;
 					content: string;
 					updated_at: string | null;
 					deleted_at: string | null;
 					verified_at: string | null;
 					suspended_at: string | null;
-					created_at: string;
 				}[];
 			};
 			outputFormat: "json";
@@ -11125,20 +11303,20 @@ declare const routes: import("hono/hono-base").HonoBase<{
 			output: {
 				success: true;
 				service: {
-					name: string;
-					active: boolean | null;
 					id: string;
 					workspaceId: string;
+					type: string | null;
+					created_at: string;
+					name: string;
+					active: boolean | null;
 					description: string | null;
 					price: number | null;
 					stock: number | null;
 					currency: string | null;
-					type: string | null;
 					updated_at: string | null;
 					deleted_at: string | null;
 					verified_at: string | null;
 					suspended_at: string | null;
-					created_at: string;
 					qrCode: string | null;
 				}[];
 			};
@@ -11295,19 +11473,19 @@ declare const routes: import("hono/hono-base").HonoBase<{
 			output: {
 				success: true;
 				customer: {
+					id: string;
+					workspaceId: string;
+					type: string | null;
+					created_at: string;
 					name: string;
 					active: boolean | null;
 					email: string | null;
-					id: string;
-					workspaceId: string;
 					description: string | null;
-					type: string | null;
 					phone: string | null;
 					updated_at: string | null;
 					deleted_at: string | null;
 					verified_at: string | null;
 					suspended_at: string | null;
-					created_at: string;
 					website: string | null;
 					companyPhone: string | null;
 					companyAddress: string | null;
@@ -11527,9 +11705,10 @@ declare const routes: import("hono/hono-base").HonoBase<{
 			output: {
 				success: true;
 				billing: {
-					active: boolean | null;
 					id: string;
 					workspaceId: string;
+					created_at: string;
+					active: boolean | null;
 					country: string;
 					companyName: string;
 					inn: string;
@@ -11544,7 +11723,6 @@ declare const routes: import("hono/hono-base").HonoBase<{
 					deleted_at: string | null;
 					verified_at: string | null;
 					suspended_at: string | null;
-					created_at: string;
 				}[];
 			};
 			outputFormat: "json";
@@ -11765,11 +11943,12 @@ declare const routes: import("hono/hono-base").HonoBase<{
 			output: {
 				success: true;
 				assignee: {
+					id: string;
+					workspaceId: string;
+					created_at: string;
 					startDate: string | null;
 					endDate: string | null;
 					collaboratorId: string;
-					id: string;
-					workspaceId: string;
 					description: string | null;
 					created_by: string;
 					taskId: string;
@@ -11777,7 +11956,6 @@ declare const routes: import("hono/hono-base").HonoBase<{
 					deleted_at: string | null;
 					verified_at: string | null;
 					suspended_at: string | null;
-					created_at: string;
 				};
 			};
 			outputFormat: "json";
@@ -11887,15 +12065,15 @@ declare const routes: import("hono/hono-base").HonoBase<{
 			output: {
 				success: true;
 				tag: {
-					name: string;
 					id: string;
 					workspaceId: string;
+					created_at: string;
+					name: string;
 					description: string | null;
 					updated_at: string | null;
 					deleted_at: string | null;
 					verified_at: string | null;
 					suspended_at: string | null;
-					created_at: string;
 				}[];
 			};
 			outputFormat: "json";
@@ -12828,10 +13006,10 @@ declare const routes: import("hono/hono-base").HonoBase<{
 						"www-authenticate"?: string | undefined | undefined;
 						":status"?: number | undefined | undefined;
 					};
+					readonly type: ResponseType;
 					readonly url: string;
 					readonly status: number;
 					readonly ok: boolean;
-					readonly type: ResponseType;
 					data: {
 						anyoneCanAddSelf?: boolean | null | undefined;
 						attachments?: {
@@ -15632,5 +15810,51 @@ declare const routes: import("hono/hono-base").HonoBase<{
 			status: 200;
 		};
 	};
-}, "/chat">, "/", "/">;
+}, "/chat"> | import("hono/types").MergeSchemaPath<{
+	"/sync": {
+		$get: {
+			input: {};
+			output: {
+				success: false;
+				error: {
+					_errors: string[];
+					limit?: {
+						[x: string]: any;
+						_errors: string[];
+					} | undefined;
+					cursor?: {
+						[x: string]: any;
+						_errors: string[];
+					} | undefined;
+				};
+			};
+			outputFormat: "json";
+			status: 400;
+		} | {
+			input: {};
+			output: {
+				success: true;
+				notifications: {
+					updated_at: string | null;
+					deleted_at: string | null;
+					verified_at: string | null;
+					suspended_at: string | null;
+					created_at: string;
+					id: string;
+					userId: string;
+					workspaceId: string;
+					title: string;
+					message: string;
+					type: string;
+					read: boolean;
+					archive: boolean;
+				}[];
+				cursor: string | null;
+				hasMore: boolean;
+			};
+			outputFormat: "json";
+			status: 200;
+		};
+	};
+}, "/notifications">, "/", "/">;
 export type AppType = typeof routes;

package/package.json

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