@lokalise/chatter-api-contracts 0.0.0-stage → 0.0.0

package/README.md

@@ -1,3 +1,19 @@
-# Temporary Holding Version
+# @lokalise/chatter-api-contracts
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+API contracts for `chatter`. Contains the Zod schemas and
+[`@lokalise/api-contracts`](https://www.npmjs.com/package/@lokalise/api-contracts)
+REST contracts that describe the service's public HTTP API.
+
+Publish this package independently so that client applications can consume the
+contracts without pulling in the service itself.
+
+## Usage
+
+```ts
+import { getHelloContract, type GetHelloResponseBody } from '@lokalise/chatter-api-contracts'
+```
+
+## Scripts
+
+- `pnpm run build` — type-check and emit `dist/` (used when publishing)
+- `pnpm run clean` — remove the `dist/` directory

package/dist/api/contracts/comments/delete-comment-reply.d.ts

@@ -0,0 +1,63 @@
+import z from 'zod/v4';
+declare const DELETE_COMMENT_REPLY_PATH_PARAMS_SCHEMA: z.ZodObject<{
+    teamId: z.ZodUUID;
+    commentId: z.ZodUUID;
+    replyId: z.ZodUUID;
+}, z.core.$strip>;
+export type DeleteCommentReplyPathParams = z.infer<typeof DELETE_COMMENT_REPLY_PATH_PARAMS_SCHEMA>;
+export declare const deleteCommentReplyContract: Omit<{
+    readonly method: "delete";
+    readonly visibility: "internal";
+    readonly summary: "Delete a reply";
+    readonly description: "Deletes a reply from the thread of a comment. The rest of the thread is kept.";
+    readonly tags: readonly ["Comments"];
+    readonly requestHeaderSchema: z.ZodObject<{
+        authorization: z.ZodString;
+    }, z.core.$strip>;
+    readonly requestPathParamsSchema: z.ZodObject<{
+        teamId: z.ZodUUID;
+        commentId: z.ZodUUID;
+        replyId: z.ZodUUID;
+    }, z.core.$strip>;
+    readonly pathResolver: ({ teamId, commentId, replyId }: {
+        teamId: string;
+        commentId: string;
+        replyId: string;
+    }) => `/v1/teams/${string}/comments/${string}/replies/${string}`;
+    readonly responsesByStatusCode: {
+        204: import("@lokalise/api-contracts").NoBodyContentResponseEntry;
+        400: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        401: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        403: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        404: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        500: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+    };
+}, "visibility"> & {
+    visibility: import("@lokalise/api-contracts").RouteVisibility;
+};
+export {};

package/dist/api/contracts/comments/delete-comment-reply.js

@@ -0,0 +1,31 @@
+import { defineApiContract, noBodyResponse } from '@lokalise/api-contracts';
+import z from 'zod/v4';
+import { OpenApiTags } from '../../open-api-tags.js';
+import { AUTH_HEADERS, ERROR_RESPONSE_SCHEMA } from '../common.js';
+// ------------------------------------------------------------
+// DELETE /v1/teams/:teamId/comments/:commentId/replies/:replyId
+// ------------------------------------------------------------
+const DELETE_COMMENT_REPLY_PATH_PARAMS_SCHEMA = z.compile(z.object({
+    teamId: z.uuid().describe('Id of the team'),
+    commentId: z.uuid().describe('Id of the comment'),
+    replyId: z.uuid().describe('Id of the reply'),
+}));
+export const deleteCommentReplyContract = defineApiContract({
+    method: 'delete',
+    visibility: 'internal',
+    summary: 'Delete a reply',
+    description: 'Deletes a reply from the thread of a comment. The rest of the thread is kept.',
+    tags: [OpenApiTags.Comments.name],
+    requestHeaderSchema: AUTH_HEADERS,
+    requestPathParamsSchema: DELETE_COMMENT_REPLY_PATH_PARAMS_SCHEMA,
+    pathResolver: ({ teamId, commentId, replyId }) => `/v1/teams/${teamId}/comments/${commentId}/replies/${replyId}`,
+    responsesByStatusCode: {
+        204: noBodyResponse({ description: 'Reply deleted' }),
+        400: ERROR_RESPONSE_SCHEMA,
+        401: ERROR_RESPONSE_SCHEMA,
+        403: ERROR_RESPONSE_SCHEMA,
+        404: ERROR_RESPONSE_SCHEMA,
+        500: ERROR_RESPONSE_SCHEMA,
+    },
+});
+//# sourceMappingURL=delete-comment-reply.js.map

package/dist/api/contracts/comments/delete-comment-reply.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete-comment-reply.js","sourceRoot":"","sources":["../../../../src/api/contracts/comments/delete-comment-reply.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAC3E,OAAO,CAAC,MAAM,QAAQ,CAAA;AACtB,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAElE,+DAA+D;AAC/D,gEAAgE;AAChE,+DAA+D;AAC/D,MAAM,uCAAuC,GAAG,CAAC,CAAC,OAAO,CACvD,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAC3C,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC;IACjD,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC;CAC9C,CAAC,CACH,CAAA;AAGD,MAAM,CAAC,MAAM,0BAA0B,GAAG,iBAAiB,CAAC;IAC1D,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,UAAU;IACtB,OAAO,EAAE,gBAAgB;IACzB,WAAW,EAAE,+EAA+E;IAC5F,IAAI,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC;IACjC,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,uCAAuC;IAChE,YAAY,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,EAAE,CAC/C,aAAa,MAAM,aAAa,SAAS,YAAY,OAAO,EAAE;IAChE,qBAAqB,EAAE;QACrB,GAAG,EAAE,cAAc,CAAC,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC;QACrD,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;KAC3B;CACF,CAAC,CAAA"}

package/dist/api/contracts/comments/delete-comment.d.ts

@@ -0,0 +1,60 @@
+import z from 'zod/v4';
+declare const DELETE_COMMENT_PATH_PARAMS_SCHEMA: z.ZodObject<{
+    teamId: z.ZodUUID;
+    commentId: z.ZodUUID;
+}, z.core.$strip>;
+export type DeleteCommentPathParams = z.infer<typeof DELETE_COMMENT_PATH_PARAMS_SCHEMA>;
+export declare const deleteCommentContract: Omit<{
+    readonly method: "delete";
+    readonly visibility: "internal";
+    readonly summary: "Delete a comment";
+    readonly description: "Deletes a comment and its whole thread, replies included.";
+    readonly tags: readonly ["Comments"];
+    readonly requestHeaderSchema: z.ZodObject<{
+        authorization: z.ZodString;
+    }, z.core.$strip>;
+    readonly requestPathParamsSchema: z.ZodObject<{
+        teamId: z.ZodUUID;
+        commentId: z.ZodUUID;
+    }, z.core.$strip>;
+    readonly pathResolver: ({ teamId, commentId }: {
+        teamId: string;
+        commentId: string;
+    }) => `/v1/teams/${string}/comments/${string}`;
+    readonly responsesByStatusCode: {
+        204: import("@lokalise/api-contracts").NoBodyContentResponseEntry;
+        400: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        401: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        403: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        404: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        500: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+    };
+}, "visibility"> & {
+    visibility: import("@lokalise/api-contracts").RouteVisibility;
+};
+export {};

package/dist/api/contracts/comments/delete-comment.js

@@ -0,0 +1,30 @@
+import { defineApiContract, noBodyResponse } from '@lokalise/api-contracts';
+import z from 'zod/v4';
+import { OpenApiTags } from '../../open-api-tags.js';
+import { AUTH_HEADERS, ERROR_RESPONSE_SCHEMA } from '../common.js';
+// ------------------------------------------------------------
+// DELETE /v1/teams/:teamId/comments/:commentId
+// ------------------------------------------------------------
+const DELETE_COMMENT_PATH_PARAMS_SCHEMA = z.compile(z.object({
+    teamId: z.uuid().describe('Id of the team'),
+    commentId: z.uuid().describe('Id of the comment'),
+}));
+export const deleteCommentContract = defineApiContract({
+    method: 'delete',
+    visibility: 'internal',
+    summary: 'Delete a comment',
+    description: 'Deletes a comment and its whole thread, replies included.',
+    tags: [OpenApiTags.Comments.name],
+    requestHeaderSchema: AUTH_HEADERS,
+    requestPathParamsSchema: DELETE_COMMENT_PATH_PARAMS_SCHEMA,
+    pathResolver: ({ teamId, commentId }) => `/v1/teams/${teamId}/comments/${commentId}`,
+    responsesByStatusCode: {
+        204: noBodyResponse({ description: 'Comment deleted' }),
+        400: ERROR_RESPONSE_SCHEMA,
+        401: ERROR_RESPONSE_SCHEMA,
+        403: ERROR_RESPONSE_SCHEMA,
+        404: ERROR_RESPONSE_SCHEMA,
+        500: ERROR_RESPONSE_SCHEMA,
+    },
+});
+//# sourceMappingURL=delete-comment.js.map

package/dist/api/contracts/comments/delete-comment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete-comment.js","sourceRoot":"","sources":["../../../../src/api/contracts/comments/delete-comment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAA;AAC3E,OAAO,CAAC,MAAM,QAAQ,CAAA;AACtB,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAElE,+DAA+D;AAC/D,+CAA+C;AAC/C,+DAA+D;AAC/D,MAAM,iCAAiC,GAAG,CAAC,CAAC,OAAO,CACjD,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAC3C,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC;CAClD,CAAC,CACH,CAAA;AAGD,MAAM,CAAC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;IACrD,MAAM,EAAE,QAAQ;IAChB,UAAU,EAAE,UAAU;IACtB,OAAO,EAAE,kBAAkB;IAC3B,WAAW,EAAE,2DAA2D;IACxE,IAAI,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC;IACjC,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,iCAAiC;IAC1D,YAAY,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,aAAa,MAAM,aAAa,SAAS,EAAE;IACpF,qBAAqB,EAAE;QACrB,GAAG,EAAE,cAAc,CAAC,EAAE,WAAW,EAAE,iBAAiB,EAAE,CAAC;QACvD,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;KAC3B;CACF,CAAC,CAAA"}

package/dist/api/contracts/comments/get-comment-replies.d.ts

@@ -0,0 +1,138 @@
+import z from 'zod/v4';
+declare const GET_COMMENT_REPLIES_PATH_PARAMS_SCHEMA: z.ZodObject<{
+    teamId: z.ZodUUID;
+    commentId: z.ZodUUID;
+}, z.core.$strip>;
+export type GetCommentRepliesPathParams = z.infer<typeof GET_COMMENT_REPLIES_PATH_PARAMS_SCHEMA>;
+declare const GET_COMMENT_REPLIES_QUERY_SCHEMA: z.ZodObject<{
+    limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+    after: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type GetCommentRepliesQuery = z.infer<typeof GET_COMMENT_REPLIES_QUERY_SCHEMA>;
+declare const GET_COMMENT_REPLIES_RESPONSE_BODY_SCHEMA: z.ZodObject<{
+    data: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        commentId: z.ZodUUID;
+        message: z.ZodObject<{
+            version: z.ZodLiteral<1>;
+            blocks: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                type: z.ZodLiteral<"paragraph">;
+                content: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                    type: z.ZodLiteral<"text">;
+                    text: z.ZodString;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"userMention">;
+                    userId: z.ZodUUID;
+                }, z.core.$strip>, z.ZodObject<{
+                    type: z.ZodLiteral<"link">;
+                    href: z.ZodURL;
+                    text: z.ZodString;
+                }, z.core.$strip>], "type">>;
+            }, z.core.$strip>], "type">>;
+        }, z.core.$strip>;
+        messageUpdatedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+        createdBy: z.ZodUUID;
+        createdAt: z.ZodISODateTime;
+    }, z.core.$strip>>;
+    meta: z.ZodObject<{
+        count: z.ZodNumber;
+        cursor: z.ZodOptional<z.ZodString>;
+        hasMore: z.ZodBoolean;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type GetCommentRepliesResponseBody = z.infer<typeof GET_COMMENT_REPLIES_RESPONSE_BODY_SCHEMA>;
+export declare const getCommentRepliesContract: Omit<{
+    readonly method: "get";
+    readonly visibility: "internal";
+    readonly summary: "List the replies of a comment";
+    readonly description: string;
+    readonly tags: readonly ["Comments"];
+    readonly requestHeaderSchema: z.ZodObject<{
+        authorization: z.ZodString;
+    }, z.core.$strip>;
+    readonly requestPathParamsSchema: z.ZodObject<{
+        teamId: z.ZodUUID;
+        commentId: z.ZodUUID;
+    }, z.core.$strip>;
+    readonly requestQuerySchema: z.ZodObject<{
+        limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
+        after: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    readonly pathResolver: ({ teamId, commentId }: {
+        teamId: string;
+        commentId: string;
+    }) => `/v1/teams/${string}/comments/${string}/replies`;
+    readonly responsesByStatusCode: {
+        200: {
+            content: {
+                'application/json': z.ZodObject<{
+                    data: z.ZodArray<z.ZodObject<{
+                        id: z.ZodUUID;
+                        commentId: z.ZodUUID;
+                        message: z.ZodObject<{
+                            version: z.ZodLiteral<1>;
+                            blocks: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                                type: z.ZodLiteral<"paragraph">;
+                                content: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
+                                    type: z.ZodLiteral<"text">;
+                                    text: z.ZodString;
+                                }, z.core.$strip>, z.ZodObject<{
+                                    type: z.ZodLiteral<"userMention">;
+                                    userId: z.ZodUUID;
+                                }, z.core.$strip>, z.ZodObject<{
+                                    type: z.ZodLiteral<"link">;
+                                    href: z.ZodURL;
+                                    text: z.ZodString;
+                                }, z.core.$strip>], "type">>;
+                            }, z.core.$strip>], "type">>;
+                        }, z.core.$strip>;
+                        messageUpdatedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+                        createdBy: z.ZodUUID;
+                        createdAt: z.ZodISODateTime;
+                    }, z.core.$strip>>;
+                    meta: z.ZodObject<{
+                        count: z.ZodNumber;
+                        cursor: z.ZodOptional<z.ZodString>;
+                        hasMore: z.ZodBoolean;
+                    }, z.core.$strip>;
+                }, z.core.$strip>;
+                'text/event-stream': import("@lokalise/api-contracts").SseBody<{
+                    'comment_reply.created': z.ZodObject<{}, z.core.$strip>;
+                }>;
+            };
+        };
+        400: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        401: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        403: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        404: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        500: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+    };
+}, "visibility"> & {
+    visibility: import("@lokalise/api-contracts").RouteVisibility;
+};
+export {};

package/dist/api/contracts/comments/get-comment-replies.js

@@ -0,0 +1,60 @@
+import { paginatedResponseSchema } from '@lokalise/api-common';
+import { defineApiContract, sseBody } from '@lokalise/api-contracts';
+import z from 'zod/v4';
+import { COMMENT_REPLY_SCHEMA } from '../../objects/index.js';
+import { OpenApiTags } from '../../open-api-tags.js';
+import { AUTH_HEADERS, ERROR_RESPONSE_SCHEMA } from '../common.js';
+// ------------------------------------------------------------
+// GET /v1/teams/:teamId/comments/:commentId/replies
+// ------------------------------------------------------------
+const GET_COMMENT_REPLIES_PATH_PARAMS_SCHEMA = z.compile(z.object({
+    teamId: z.uuid().describe('Id of the team'),
+    commentId: z.uuid().describe('Id of the comment'),
+}));
+const COMMENT_REPLIES_DEFAULT_LIMIT = 100;
+const COMMENT_REPLIES_MAX_LIMIT = 100;
+const GET_COMMENT_REPLIES_QUERY_SCHEMA = z.compile(z.object({
+    limit: z.coerce
+        .number()
+        .int()
+        .min(1)
+        .max(COMMENT_REPLIES_MAX_LIMIT)
+        .default(COMMENT_REPLIES_DEFAULT_LIMIT)
+        .describe('Number of replies to return per page'),
+    after: z
+        .string()
+        .min(1)
+        .optional()
+        .describe('Opaque cursor from the previous response `meta.cursor`. Omit to read the first page'),
+}));
+const GET_COMMENT_REPLIES_RESPONSE_BODY_SCHEMA = paginatedResponseSchema(COMMENT_REPLY_SCHEMA);
+export const getCommentRepliesContract = defineApiContract({
+    method: 'get',
+    visibility: 'internal',
+    summary: 'List the replies of a comment',
+    description: 'Lists the replies of a comment, oldest first, one page at a time, or streams their changes as ' +
+        'Server-Sent Events when the request accepts `text/event-stream`. ' +
+        'Pass `meta.cursor` from a response as `after` to read the next page.',
+    tags: [OpenApiTags.Comments.name],
+    requestHeaderSchema: AUTH_HEADERS,
+    requestPathParamsSchema: GET_COMMENT_REPLIES_PATH_PARAMS_SCHEMA,
+    requestQuerySchema: GET_COMMENT_REPLIES_QUERY_SCHEMA,
+    pathResolver: ({ teamId, commentId }) => `/v1/teams/${teamId}/comments/${commentId}/replies`,
+    responsesByStatusCode: {
+        200: {
+            content: {
+                'application/json': GET_COMMENT_REPLIES_RESPONSE_BODY_SCHEMA,
+                'text/event-stream': sseBody({
+                    // TODO: define the events. A route needs at least one
+                    'comment_reply.created': z.object({}),
+                }),
+            },
+        },
+        400: ERROR_RESPONSE_SCHEMA,
+        401: ERROR_RESPONSE_SCHEMA,
+        403: ERROR_RESPONSE_SCHEMA,
+        404: ERROR_RESPONSE_SCHEMA,
+        500: ERROR_RESPONSE_SCHEMA,
+    },
+});
+//# sourceMappingURL=get-comment-replies.js.map

package/dist/api/contracts/comments/get-comment-replies.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-comment-replies.js","sourceRoot":"","sources":["../../../../src/api/contracts/comments/get-comment-replies.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAA;AACpE,OAAO,CAAC,MAAM,QAAQ,CAAA;AACtB,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAC7D,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAElE,+DAA+D;AAC/D,oDAAoD;AACpD,+DAA+D;AAC/D,MAAM,sCAAsC,GAAG,CAAC,CAAC,OAAO,CACtD,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IAC3C,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC;CAClD,CAAC,CACH,CAAA;AAGD,MAAM,6BAA6B,GAAG,GAAG,CAAA;AACzC,MAAM,yBAAyB,GAAG,GAAG,CAAA;AACrC,MAAM,gCAAgC,GAAG,CAAC,CAAC,OAAO,CAChD,CAAC,CAAC,MAAM,CAAC;IACP,KAAK,EAAE,CAAC,CAAC,MAAM;SACZ,MAAM,EAAE;SACR,GAAG,EAAE;SACL,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,yBAAyB,CAAC;SAC9B,OAAO,CAAC,6BAA6B,CAAC;SACtC,QAAQ,CAAC,sCAAsC,CAAC;IACnD,KAAK,EAAE,CAAC;SACL,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,QAAQ,EAAE;SACV,QAAQ,CACP,qFAAqF,CACtF;CACJ,CAAC,CACH,CAAA;AAGD,MAAM,wCAAwC,GAAG,uBAAuB,CAAC,oBAAoB,CAAC,CAAA;AAG9F,MAAM,CAAC,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;IACzD,MAAM,EAAE,KAAK;IACb,UAAU,EAAE,UAAU;IACtB,OAAO,EAAE,+BAA+B;IACxC,WAAW,EACT,gGAAgG;QAChG,mEAAmE;QACnE,sEAAsE;IACxE,IAAI,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC;IACjC,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,sCAAsC;IAC/D,kBAAkB,EAAE,gCAAgC;IACpD,YAAY,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,aAAa,MAAM,aAAa,SAAS,UAAU;IAC5F,qBAAqB,EAAE;QACrB,GAAG,EAAE;YACH,OAAO,EAAE;gBACP,kBAAkB,EAAE,wCAAwC;gBAC5D,mBAAmB,EAAE,OAAO,CAAC;oBAC3B,sDAAsD;oBACtD,uBAAuB,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;iBACtC,CAAC;aACH;SACF;QACD,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;KAC3B;CACF,CAAC,CAAA"}

package/dist/api/contracts/comments/get-comments.d.ts

@@ -0,0 +1,71 @@
+import z from 'zod/v4';
+declare const GET_COMMENTS_PATH_PARAMS_SCHEMA: z.ZodObject<{
+    teamId: z.ZodUUID;
+}, z.core.$strip>;
+export type GetCommentsPathParams = z.infer<typeof GET_COMMENTS_PATH_PARAMS_SCHEMA>;
+declare const GET_COMMENTS_QUERY_SCHEMA: z.ZodObject<{
+    'filter-projectId': z.ZodUUID;
+    'filter-entityType': z.ZodEnum<{
+        readonly SEGMENT: 'SEGMENT';
+    }>;
+}, z.core.$strip>;
+export type GetCommentsQuery = z.infer<typeof GET_COMMENTS_QUERY_SCHEMA>;
+export declare const getCommentsContract: Omit<{
+    readonly method: "get";
+    readonly visibility: "internal";
+    readonly summary: "Subscribe to comments";
+    readonly description: "Streams live comment changes of a project as Server-Sent Events.";
+    readonly tags: readonly ["Comments"];
+    readonly requestHeaderSchema: z.ZodObject<{
+        authorization: z.ZodString;
+    }, z.core.$strip>;
+    readonly requestPathParamsSchema: z.ZodObject<{
+        teamId: z.ZodUUID;
+    }, z.core.$strip>;
+    readonly requestQuerySchema: z.ZodObject<{
+        'filter-projectId': z.ZodUUID;
+        'filter-entityType': z.ZodEnum<{
+            readonly SEGMENT: 'SEGMENT';
+        }>;
+    }, z.core.$strip>;
+    readonly pathResolver: ({ teamId }: {
+        teamId: string;
+    }) => `/v1/teams/${string}/comments`;
+    readonly responsesByStatusCode: {
+        200: {
+            readonly content: {
+                readonly 'text/event-stream': import("@lokalise/api-contracts").SseBody<{
+                    'comment.created': z.ZodObject<{}, z.core.$strip>;
+                }>;
+            };
+            readonly description?: string | undefined;
+        };
+        400: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        401: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        403: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+        500: z.ZodObject<{
+            message: z.ZodString;
+            code: z.ZodString;
+            errorCode: z.ZodString;
+            details: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$strip>;
+    };
+}, "visibility"> & {
+    visibility: import("@lokalise/api-contracts").RouteVisibility;
+};
+export {};

package/dist/api/contracts/comments/get-comments.js

@@ -0,0 +1,39 @@
+import { defineApiContract, sseResponse } from '@lokalise/api-contracts';
+import z from 'zod/v4';
+import { CommentEntityTypeEnum } from '../../objects/comment.js';
+import { OpenApiTags } from '../../open-api-tags.js';
+import { AUTH_HEADERS, ERROR_RESPONSE_SCHEMA } from '../common.js';
+// ------------------------------------------------------------
+// GET /v1/teams/:teamId/comments
+// ------------------------------------------------------------
+const GET_COMMENTS_PATH_PARAMS_SCHEMA = z.compile(z.object({
+    teamId: z.uuid().describe('Id of the team'),
+}));
+const GET_COMMENTS_QUERY_SCHEMA = z.compile(z.object({
+    'filter-projectId': z.uuid().describe('Only comments of this project'),
+    'filter-entityType': z
+        .enum(CommentEntityTypeEnum)
+        .describe('Only comments on this type of entity'),
+}));
+export const getCommentsContract = defineApiContract({
+    method: 'get',
+    visibility: 'internal',
+    summary: 'Subscribe to comments',
+    description: 'Streams live comment changes of a project as Server-Sent Events.',
+    tags: [OpenApiTags.Comments.name],
+    requestHeaderSchema: AUTH_HEADERS,
+    requestPathParamsSchema: GET_COMMENTS_PATH_PARAMS_SCHEMA,
+    requestQuerySchema: GET_COMMENTS_QUERY_SCHEMA,
+    pathResolver: ({ teamId }) => `/v1/teams/${teamId}/comments`,
+    responsesByStatusCode: {
+        200: sseResponse({
+            // TODO: define the events. A route needs at least one
+            'comment.created': z.object({}),
+        }),
+        400: ERROR_RESPONSE_SCHEMA,
+        401: ERROR_RESPONSE_SCHEMA,
+        403: ERROR_RESPONSE_SCHEMA,
+        500: ERROR_RESPONSE_SCHEMA,
+    },
+});
+//# sourceMappingURL=get-comments.js.map

package/dist/api/contracts/comments/get-comments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-comments.js","sourceRoot":"","sources":["../../../../src/api/contracts/comments/get-comments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AACxE,OAAO,CAAC,MAAM,QAAQ,CAAA;AACtB,OAAO,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAA;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAElE,+DAA+D;AAC/D,iCAAiC;AACjC,+DAA+D;AAC/D,MAAM,+BAA+B,GAAG,CAAC,CAAC,OAAO,CAC/C,CAAC,CAAC,MAAM,CAAC;IACP,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;CAC5C,CAAC,CACH,CAAA;AAGD,MAAM,yBAAyB,GAAG,CAAC,CAAC,OAAO,CACzC,CAAC,CAAC,MAAM,CAAC;IACP,kBAAkB,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IACtE,mBAAmB,EAAE,CAAC;SACnB,IAAI,CAAC,qBAAqB,CAAC;SAC3B,QAAQ,CAAC,sCAAsC,CAAC;CACpD,CAAC,CACH,CAAA;AAGD,MAAM,CAAC,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;IACnD,MAAM,EAAE,KAAK;IACb,UAAU,EAAE,UAAU;IACtB,OAAO,EAAE,uBAAuB;IAChC,WAAW,EAAE,kEAAkE;IAC/E,IAAI,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,CAAC;IACjC,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,+BAA+B;IACxD,kBAAkB,EAAE,yBAAyB;IAC7C,YAAY,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,aAAa,MAAM,WAAW;IAC5D,qBAAqB,EAAE;QACrB,GAAG,EAAE,WAAW,CAAC;YACf,sDAAsD;YACtD,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;SAChC,CAAC;QACF,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;QAC1B,GAAG,EAAE,qBAAqB;KAC3B;CACF,CAAC,CAAA"}