@intlayer/backend-contract 0.0.0-stage → 9.7.0

package/dist/cjs/blogComment.cjs

@@ -0,0 +1,98 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_common = require('./common.cjs');
+const require_defineRoute = require('./defineRoute.cjs');
+const require_responseData = require('./responseData.cjs');
+let zod_mini = require("zod/mini");
+
+//#region src/blogComment.ts
+/** Moderation status of a blog comment. */
+const blogCommentStatusSchema = zod_mini.z.enum([
+	"pending",
+	"approved",
+	"rejected"
+]);
+/** Comment as shown publicly (author email stripped). */
+const blogCommentPublicSchema = zod_mini.z.looseObject({
+	id: zod_mini.z.string(),
+	blogSlug: zod_mini.z.string(),
+	authorName: zod_mini.z.string(),
+	content: zod_mini.z.string(),
+	status: blogCommentStatusSchema,
+	createdAt: zod_mini.z.string(),
+	updatedAt: zod_mini.z.string()
+});
+/** Comment as shown to admins. */
+const blogCommentSchema = zod_mini.z.looseObject({
+	...blogCommentPublicSchema.shape,
+	authorEmail: zod_mini.z.string()
+});
+const commentIdParamsSchema = zod_mini.z.object({ commentId: require_common.objectIdSchema });
+/** REST contract of the `/api/blog-comments` routes. */
+const blogCommentContract = require_defineRoute.defineRouteGroup({
+	prefix: "/api/blog-comments",
+	tag: "Blog comment",
+	routes: {
+		submitBlogComment: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/",
+			summary: "Submit a comment on a blog post (moderated)",
+			schemas: {
+				body: zod_mini.z.object({
+					blogSlug: zod_mini.z.string().check(zod_mini.z.minLength(1)),
+					authorName: zod_mini.z.string().check(zod_mini.z.minLength(1)),
+					authorEmail: zod_mini.z.string().check(zod_mini.z.minLength(1)),
+					content: zod_mini.z.string().check(zod_mini.z.minLength(1))
+				}),
+				response: { 201: require_responseData.responseDataSchema(blogCommentPublicSchema) }
+			}
+		}),
+		getAdminBlogComments: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/admin",
+			summary: "Admin only: list comments by status or post",
+			schemas: {
+				querystring: zod_mini.z.object({
+					...require_common.paginationQueryShape,
+					blogSlug: zod_mini.z.optional(zod_mini.z.string()),
+					status: zod_mini.z.optional(blogCommentStatusSchema)
+				}),
+				response: { 200: require_responseData.paginatedResponseSchema(blogCommentSchema) }
+			}
+		}),
+		getApprovedBlogComments: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/:blogSlug",
+			summary: "Approved comments of a blog post",
+			schemas: {
+				params: zod_mini.z.object({ blogSlug: zod_mini.z.string() }),
+				response: { 200: require_responseData.responseDataSchema(zod_mini.z.array(blogCommentPublicSchema)) }
+			}
+		}),
+		updateBlogCommentStatus: require_defineRoute.defineRoute({
+			method: "PATCH",
+			path: "/:commentId/status",
+			summary: "Admin only: approve or reject a comment",
+			schemas: {
+				params: commentIdParamsSchema,
+				body: zod_mini.z.object({ status: blogCommentStatusSchema }),
+				response: { 200: require_responseData.responseDataSchema(blogCommentSchema) }
+			}
+		}),
+		deleteBlogComment: require_defineRoute.defineRoute({
+			method: "DELETE",
+			path: "/:commentId",
+			summary: "Admin only: delete a comment",
+			schemas: {
+				params: commentIdParamsSchema,
+				response: { 200: require_responseData.responseDataSchema(zod_mini.z.null()) }
+			}
+		})
+	}
+});
+
+//#endregion
+exports.blogCommentContract = blogCommentContract;
+exports.blogCommentPublicSchema = blogCommentPublicSchema;
+exports.blogCommentSchema = blogCommentSchema;
+exports.blogCommentStatusSchema = blogCommentStatusSchema;
+//# sourceMappingURL=blogComment.cjs.map

package/dist/cjs/blogComment.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"blogComment.cjs","names":["z","objectIdSchema","defineRouteGroup","defineRoute","responseDataSchema","paginationQueryShape","paginatedResponseSchema"],"sources":["../../src/blogComment.ts"],"sourcesContent":["import { z } from 'zod/mini';\nimport { objectIdSchema, paginationQueryShape } from './common';\nimport {\n  defineRoute,\n  defineRouteGroup,\n  type RouteBodyInput,\n} from './defineRoute';\nimport {\n  type PaginatedResponse,\n  paginatedResponseSchema,\n  type ResponseData,\n  responseDataSchema,\n} from './responseData';\n\n/** Moderation status of a blog comment. */\nexport const blogCommentStatusSchema = z.enum([\n  'pending',\n  'approved',\n  'rejected',\n]);\n\n/** Comment as shown publicly (author email stripped). */\nexport const blogCommentPublicSchema = z.looseObject({\n  id: z.string(),\n  blogSlug: z.string(),\n  authorName: z.string(),\n  content: z.string(),\n  status: blogCommentStatusSchema,\n  createdAt: z.string(),\n  updatedAt: z.string(),\n});\n\n/** Comment as shown to admins. */\nexport const blogCommentSchema = z.looseObject({\n  ...blogCommentPublicSchema.shape,\n  authorEmail: z.string(),\n});\n\nconst commentIdParamsSchema = z.object({ commentId: objectIdSchema });\n\n/** REST contract of the `/api/blog-comments` routes. */\nexport const blogCommentContract = defineRouteGroup({\n  prefix: '/api/blog-comments',\n  tag: 'Blog comment',\n  routes: {\n    submitBlogComment: defineRoute({\n      method: 'POST',\n      path: '/',\n      summary: 'Submit a comment on a blog post (moderated)',\n      schemas: {\n        body: z.object({\n          blogSlug: z.string().check(z.minLength(1)),\n          authorName: z.string().check(z.minLength(1)),\n          authorEmail: z.string().check(z.minLength(1)),\n          content: z.string().check(z.minLength(1)),\n        }),\n        response: { 201: responseDataSchema(blogCommentPublicSchema) },\n      },\n    }),\n    getAdminBlogComments: defineRoute({\n      method: 'GET',\n      path: '/admin',\n      summary: 'Admin only: list comments by status or post',\n      schemas: {\n        querystring: z.object({\n          ...paginationQueryShape,\n          blogSlug: z.optional(z.string()),\n          status: z.optional(blogCommentStatusSchema),\n        }),\n        response: { 200: paginatedResponseSchema(blogCommentSchema) },\n      },\n    }),\n    getApprovedBlogComments: defineRoute({\n      method: 'GET',\n      path: '/:blogSlug',\n      summary: 'Approved comments of a blog post',\n      schemas: {\n        params: z.object({ blogSlug: z.string() }),\n        response: {\n          200: responseDataSchema(z.array(blogCommentPublicSchema)),\n        },\n      },\n    }),\n    updateBlogCommentStatus: defineRoute({\n      method: 'PATCH',\n      path: '/:commentId/status',\n      summary: 'Admin only: approve or reject a comment',\n      schemas: {\n        params: commentIdParamsSchema,\n        body: z.object({ status: blogCommentStatusSchema }),\n        response: { 200: responseDataSchema(blogCommentSchema) },\n      },\n    }),\n    deleteBlogComment: defineRoute({\n      method: 'DELETE',\n      path: '/:commentId',\n      summary: 'Admin only: delete a comment',\n      schemas: {\n        params: commentIdParamsSchema,\n        response: { 200: responseDataSchema(z.null()) },\n      },\n    }),\n  },\n});\n\n/** Route definitions of the `/api/blog-comments` group, by name. */\nexport type BlogCommentRoutes = (typeof blogCommentContract)['routes'];\n\nexport type BlogCommentStatus = z.output<typeof blogCommentStatusSchema>;\nexport type BlogCommentPublicAPI = z.output<typeof blogCommentPublicSchema>;\nexport type BlogCommentAPI = z.output<typeof blogCommentSchema>;\nexport type SubmitBlogCommentBody = RouteBodyInput<\n  BlogCommentRoutes['submitBlogComment']\n>;\nexport type SubmitBlogCommentResult = ResponseData<BlogCommentPublicAPI>;\nexport type GetBlogCommentsResult = ResponseData<BlogCommentPublicAPI[]>;\nexport type GetAdminBlogCommentsResult = PaginatedResponse<BlogCommentAPI>;\nexport type UpdateBlogCommentStatusBody = RouteBodyInput<\n  BlogCommentRoutes['updateBlogCommentStatus']\n>;\nexport type UpdateBlogCommentStatusResult = ResponseData<BlogCommentAPI>;\n"],"mappings":";;;;;;;;AAeA,MAAa,0BAA0BA,WAAE,KAAK;CAC5C;CACA;CACA;AACF,CAAC;;AAGD,MAAa,0BAA0BA,WAAE,YAAY;CACnD,IAAIA,WAAE,OAAO;CACb,UAAUA,WAAE,OAAO;CACnB,YAAYA,WAAE,OAAO;CACrB,SAASA,WAAE,OAAO;CAClB,QAAQ;CACR,WAAWA,WAAE,OAAO;CACpB,WAAWA,WAAE,OAAO;AACtB,CAAC;;AAGD,MAAa,oBAAoBA,WAAE,YAAY;CAC7C,GAAG,wBAAwB;CAC3B,aAAaA,WAAE,OAAO;AACxB,CAAC;AAED,MAAM,wBAAwBA,WAAE,OAAO,EAAE,WAAWC,8BAAe,CAAC;;AAGpE,MAAa,sBAAsBC,qCAAiB;CAClD,QAAQ;CACR,KAAK;CACL,QAAQ;EACN,mBAAmBC,gCAAY;GAC7B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAMH,WAAE,OAAO;KACb,UAAUA,WAAE,OAAO,CAAC,CAAC,MAAMA,WAAE,UAAU,CAAC,CAAC;KACzC,YAAYA,WAAE,OAAO,CAAC,CAAC,MAAMA,WAAE,UAAU,CAAC,CAAC;KAC3C,aAAaA,WAAE,OAAO,CAAC,CAAC,MAAMA,WAAE,UAAU,CAAC,CAAC;KAC5C,SAASA,WAAE,OAAO,CAAC,CAAC,MAAMA,WAAE,UAAU,CAAC,CAAC;IAC1C,CAAC;IACD,UAAU,EAAE,KAAKI,wCAAmB,uBAAuB,EAAE;GAC/D;EACF,CAAC;EACD,sBAAsBD,gCAAY;GAChC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAaH,WAAE,OAAO;KACpB,GAAGK;KACH,UAAUL,WAAE,SAASA,WAAE,OAAO,CAAC;KAC/B,QAAQA,WAAE,SAAS,uBAAuB;IAC5C,CAAC;IACD,UAAU,EAAE,KAAKM,6CAAwB,iBAAiB,EAAE;GAC9D;EACF,CAAC;EACD,yBAAyBH,gCAAY;GACnC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQH,WAAE,OAAO,EAAE,UAAUA,WAAE,OAAO,EAAE,CAAC;IACzC,UAAU,EACR,KAAKI,wCAAmBJ,WAAE,MAAM,uBAAuB,CAAC,EAC1D;GACF;EACF,CAAC;EACD,yBAAyBG,gCAAY;GACnC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,MAAMH,WAAE,OAAO,EAAE,QAAQ,wBAAwB,CAAC;IAClD,UAAU,EAAE,KAAKI,wCAAmB,iBAAiB,EAAE;GACzD;EACF,CAAC;EACD,mBAAmBD,gCAAY;GAC7B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EAAE,KAAKC,wCAAmBJ,WAAE,KAAK,CAAC,EAAE;GAChD;EACF,CAAC;CACH;AACF,CAAC"}

package/dist/cjs/cliSessionToken.cjs

@@ -0,0 +1,40 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_common = require('./common.cjs');
+const require_defineRoute = require('./defineRoute.cjs');
+const require_responseData = require('./responseData.cjs');
+const require_project = require('./project.cjs');
+const require_organization = require('./organization.cjs');
+const require_user = require('./user.cjs');
+let zod_mini = require("zod/mini");
+
+//#region src/cliSessionToken.ts
+/** REST contract of the CLI session routes (`intlayer login`). */
+const cliSessionTokenContract = require_defineRoute.defineRouteGroup({
+	prefix: "/api/cli-session",
+	tag: "CLI session",
+	routes: {
+		createCliSessionToken: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/",
+			summary: "Issue a short-lived token for the CLI login handoff",
+			schemas: { response: { 200: require_responseData.responseDataSchema(zod_mini.z.object({
+				token: zod_mini.z.string(),
+				expiresAt: require_common.dateTimeSchema
+			})) } }
+		}),
+		getCliSessionMe: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/me",
+			summary: "User, organization and project bound to the CLI session token",
+			schemas: { response: { 200: require_responseData.responseDataSchema(zod_mini.z.object({
+				project: require_project.projectSchema,
+				user: zod_mini.z.optional(zod_mini.z.nullable(require_user.userSchema)),
+				organization: zod_mini.z.optional(zod_mini.z.nullable(require_organization.organizationSchema))
+			})) } }
+		})
+	}
+});
+
+//#endregion
+exports.cliSessionTokenContract = cliSessionTokenContract;
+//# sourceMappingURL=cliSessionToken.cjs.map

package/dist/cjs/cliSessionToken.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"cliSessionToken.cjs","names":["defineRouteGroup","defineRoute","responseDataSchema","z","dateTimeSchema","projectSchema","userSchema","organizationSchema"],"sources":["../../src/cliSessionToken.ts"],"sourcesContent":["import { z } from 'zod/mini';\nimport { dateTimeSchema } from './common';\nimport { defineRoute, defineRouteGroup } from './defineRoute';\nimport { type OrganizationAPI, organizationSchema } from './organization';\nimport { type ProjectAPI, projectSchema } from './project';\nimport { type ResponseData, responseDataSchema } from './responseData';\nimport { type UserAPI, userSchema } from './user';\n\n/** REST contract of the CLI session routes (`intlayer login`). */\nexport const cliSessionTokenContract = defineRouteGroup({\n  prefix: '/api/cli-session',\n  tag: 'CLI session',\n  routes: {\n    createCliSessionToken: defineRoute({\n      method: 'POST',\n      path: '/',\n      summary: 'Issue a short-lived token for the CLI login handoff',\n      schemas: {\n        response: {\n          200: responseDataSchema(\n            z.object({ token: z.string(), expiresAt: dateTimeSchema })\n          ),\n        },\n      },\n    }),\n    getCliSessionMe: defineRoute({\n      method: 'GET',\n      path: '/me',\n      summary: 'User, organization and project bound to the CLI session token',\n      schemas: {\n        response: {\n          200: responseDataSchema(\n            z.object({\n              project: projectSchema,\n              // Optional: backends before 9.6 only return the project\n              user: z.optional(z.nullable(userSchema)),\n              organization: z.optional(z.nullable(organizationSchema)),\n            })\n          ),\n        },\n      },\n    }),\n  },\n});\n\n/** Route definitions of the CLI session group, by name. */\nexport type CliSessionTokenRoutes = (typeof cliSessionTokenContract)['routes'];\n\nexport type CreateCliSessionTokenResult = ResponseData<{\n  token: string;\n  expiresAt: string;\n}>;\nexport type GetCliSessionMeResult = ResponseData<{\n  project: ProjectAPI;\n  user?: UserAPI | null;\n  organization?: OrganizationAPI | null;\n}>;\n"],"mappings":";;;;;;;;;;;AASA,MAAa,0BAA0BA,qCAAiB;CACtD,QAAQ;CACR,KAAK;CACL,QAAQ;EACN,uBAAuBC,gCAAY;GACjC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EACR,KAAKC,wCACHC,WAAE,OAAO;IAAE,OAAOA,WAAE,OAAO;IAAG,WAAWC;GAAe,CAAC,CAC3D,EACF,EACF;EACF,CAAC;EACD,iBAAiBH,gCAAY;GAC3B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EACR,KAAKC,wCACHC,WAAE,OAAO;IACP,SAASE;IAET,MAAMF,WAAE,SAASA,WAAE,SAASG,uBAAU,CAAC;IACvC,cAAcH,WAAE,SAASA,WAAE,SAASI,uCAAkB,CAAC;GACzD,CAAC,CACH,EACF,EACF;EACF,CAAC;CACH;AACF,CAAC"}

package/dist/cjs/common.cjs

@@ -0,0 +1,42 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+let zod_mini = require("zod/mini");
+
+//#region src/common.ts
+/** 24-character hexadecimal MongoDB ObjectId, serialized as a string. */
+const objectIdSchema = zod_mini.z.string().check(zod_mini.z.regex(/^[a-fA-F0-9]{24}$/));
+/**
+* Query string value that may be repeated (`?id=a&id=b`): Fastify parses it
+* as a single string or as an array of strings.
+*/
+const repeatableQueryValueSchema = zod_mini.z.union([zod_mini.z.string(), zod_mini.z.array(zod_mini.z.string())]);
+/** Pagination fields shared by every paginated list endpoint. */
+const paginationQueryShape = {
+	page: zod_mini.z.optional(zod_mini.z.union([zod_mini.z.string(), zod_mini.z.number()])),
+	pageSize: zod_mini.z.optional(zod_mini.z.union([zod_mini.z.string(), zod_mini.z.number()]))
+};
+/** Date serialized by `JSON.stringify` (ISO 8601). */
+const dateTimeSchema = zod_mini.z.string();
+/**
+* String narrowed to a type owned by another package (ex: `Locale` from
+* `@intlayer/types`), without duplicating its values. Validated and
+* documented as a plain string.
+*/
+const typedStringSchema = () => zod_mini.z.custom((value) => typeof value === "string");
+/**
+* Value whose type is owned by another package (ex: AI configuration or
+* dictionaries from `@intlayer/types`), documented as any JSON value.
+* @param isValid - Optional shallow runtime check (defaults to accept all).
+*/
+const typedValueSchema = (isValid = () => true) => zod_mini.z.custom(isValid);
+/** Whether a value is a plain JSON object (not null, not an array). */
+const isJSONObject = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
+
+//#endregion
+exports.dateTimeSchema = dateTimeSchema;
+exports.isJSONObject = isJSONObject;
+exports.objectIdSchema = objectIdSchema;
+exports.paginationQueryShape = paginationQueryShape;
+exports.repeatableQueryValueSchema = repeatableQueryValueSchema;
+exports.typedStringSchema = typedStringSchema;
+exports.typedValueSchema = typedValueSchema;
+//# sourceMappingURL=common.cjs.map

package/dist/cjs/common.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.cjs","names":["z"],"sources":["../../src/common.ts"],"sourcesContent":["import { z } from 'zod/mini';\n\n/** 24-character hexadecimal MongoDB ObjectId, serialized as a string. */\nexport const objectIdSchema = z.string().check(z.regex(/^[a-fA-F0-9]{24}$/));\n\n/**\n * Query string value that may be repeated (`?id=a&id=b`): Fastify parses it\n * as a single string or as an array of strings.\n */\nexport const repeatableQueryValueSchema = z.union([\n  z.string(),\n  z.array(z.string()),\n]);\n\n/** Pagination fields shared by every paginated list endpoint. */\nexport const paginationQueryShape = {\n  page: z.optional(z.union([z.string(), z.number()])),\n  pageSize: z.optional(z.union([z.string(), z.number()])),\n};\n\n/** Date serialized by `JSON.stringify` (ISO 8601). */\nexport const dateTimeSchema = z.string();\n\n/**\n * String narrowed to a type owned by another package (ex: `Locale` from\n * `@intlayer/types`), without duplicating its values. Validated and\n * documented as a plain string.\n */\nexport const typedStringSchema = <Value extends string>() =>\n  z.custom<Value>((value) => typeof value === 'string');\n\n/**\n * Value whose type is owned by another package (ex: AI configuration or\n * dictionaries from `@intlayer/types`), documented as any JSON value.\n * @param isValid - Optional shallow runtime check (defaults to accept all).\n */\nexport const typedValueSchema = <Value>(\n  isValid: (value: unknown) => boolean = () => true\n) => z.custom<Value>(isValid);\n\n/** Whether a value is a plain JSON object (not null, not an array). */\nexport const isJSONObject = (\n  value: unknown\n): value is Record<string, unknown> =>\n  typeof value === 'object' && value !== null && !Array.isArray(value);\n"],"mappings":";;;;;AAGA,MAAa,iBAAiBA,WAAE,OAAO,CAAC,CAAC,MAAMA,WAAE,MAAM,mBAAmB,CAAC;;;;;AAM3E,MAAa,6BAA6BA,WAAE,MAAM,CAChDA,WAAE,OAAO,GACTA,WAAE,MAAMA,WAAE,OAAO,CAAC,CACpB,CAAC;;AAGD,MAAa,uBAAuB;CAClC,MAAMA,WAAE,SAASA,WAAE,MAAM,CAACA,WAAE,OAAO,GAAGA,WAAE,OAAO,CAAC,CAAC,CAAC;CAClD,UAAUA,WAAE,SAASA,WAAE,MAAM,CAACA,WAAE,OAAO,GAAGA,WAAE,OAAO,CAAC,CAAC,CAAC;AACxD;;AAGA,MAAa,iBAAiBA,WAAE,OAAO;;;;;;AAOvC,MAAa,0BACXA,WAAE,QAAe,UAAU,OAAO,UAAU,QAAQ;;;;;;AAOtD,MAAa,oBACX,gBAA6C,SAC1CA,WAAE,OAAc,OAAO;;AAG5B,MAAa,gBACX,UAEA,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK"}

package/dist/cjs/defineRoute.cjs

@@ -0,0 +1,26 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+//#region src/defineRoute.ts
+/** Identity helper preserving literal types of a route definition. */
+const defineRoute = (route) => route;
+/** Identity helper preserving literal types of a route group. */
+const defineRouteGroup = (group) => group;
+/** Untyped implementation of {@link buildRouteURL}. */
+const joinRouteURL = (backendURL, prefix, path, params) => {
+	const resolvedPath = path.replace(/:([A-Za-z0-9_]+)/g, (_match, name) => {
+		const value = params?.[name];
+		if (value === void 0) throw new Error(`Missing route param "${name}" for ${path}`);
+		return encodeURIComponent(value);
+	});
+	return `${backendURL}${prefix}${resolvedPath === "/" ? "" : resolvedPath}`;
+};
+/**
+* Builds the absolute URL of a route by joining the backend URL, the group
+* prefix and the path, with `:param` segments replaced and URI-encoded.
+*/
+const buildRouteURL = (backendURL, group, route, ...[params]) => joinRouteURL(backendURL, group.prefix, route.path, params);
+
+//#endregion
+exports.buildRouteURL = buildRouteURL;
+exports.defineRoute = defineRoute;
+exports.defineRouteGroup = defineRouteGroup;
+//# sourceMappingURL=defineRoute.cjs.map

package/dist/cjs/defineRoute.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"defineRoute.cjs","names":[],"sources":["../../src/defineRoute.ts"],"sourcesContent":["import type { $ZodType, input, output } from 'zod/v4/core';\n\n/** HTTP methods exposed by the Intlayer backend. */\nexport type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';\n\n/** Zod schemas describing one route's input and output. */\nexport type RouteSchemas = {\n  params?: $ZodType;\n  querystring?: $ZodType;\n  body?: $ZodType;\n  /** Response schemas keyed by HTTP status code. */\n  response?: Partial<Record<number, $ZodType>>;\n};\n\n/** One REST route: method, path relative to its group prefix, and schemas. */\nexport type RouteDefinition<\n  Method extends HttpMethod = HttpMethod,\n  Path extends string = string,\n  Schemas extends RouteSchemas = RouteSchemas,\n> = {\n  method: Method;\n  /** Fastify-style path, relative to the group prefix (ex: `/:projectId`). */\n  path: Path;\n  /** One-line summary shown in the OpenAPI documentation. */\n  summary: string;\n  description?: string;\n  schemas: Schemas;\n};\n\n/** A set of routes sharing a URL prefix and an OpenAPI tag. */\nexport type RouteGroup<\n  Prefix extends string = string,\n  Routes extends Record<string, RouteDefinition> = Record<\n    string,\n    RouteDefinition\n  >,\n> = {\n  /** Absolute prefix mounted on the backend (ex: `/api/project`). */\n  prefix: Prefix;\n  /** OpenAPI tag grouping the routes in the documentation. */\n  tag: string;\n  routes: Routes;\n};\n\n/** Identity helper preserving literal types of a route definition. */\nexport const defineRoute = <\n  const Method extends HttpMethod,\n  const Path extends string,\n  const Schemas extends RouteSchemas,\n>(\n  route: RouteDefinition<Method, Path, Schemas>\n): RouteDefinition<Method, Path, Schemas> => route;\n\n/** Identity helper preserving literal types of a route group. */\nexport const defineRouteGroup = <\n  const Prefix extends string,\n  const Routes extends Record<string, RouteDefinition>,\n>(\n  group: RouteGroup<Prefix, Routes>\n): RouteGroup<Prefix, Routes> => group;\n\ntype SchemaOutput<Schema> = Schema extends $ZodType ? output<Schema> : never;\ntype SchemaInput<Schema> = Schema extends $ZodType ? input<Schema> : never;\n\n/** Request body as parsed by the backend (after validation). */\nexport type RouteBody<Route extends RouteDefinition> = SchemaOutput<\n  Route['schemas']['body']\n>;\n/** Request body as sent by a client (before validation). */\nexport type RouteBodyInput<Route extends RouteDefinition> = SchemaInput<\n  Route['schemas']['body']\n>;\n/** URL params as parsed by the backend. */\nexport type RouteParams<Route extends RouteDefinition> = SchemaOutput<\n  Route['schemas']['params']\n>;\n/** Query string as parsed by the backend. */\nexport type RouteQuerystring<Route extends RouteDefinition> = SchemaOutput<\n  Route['schemas']['querystring']\n>;\n/** Successful (200) response payload. */\nexport type RouteResponse<Route extends RouteDefinition> =\n  Route['schemas']['response'] extends Record<200, infer Schema>\n    ? SchemaOutput<Schema>\n    : unknown;\n\n/** Method and path of every route, for clients that must not load the schemas. */\nexport type RouteEndpoints<Routes extends Record<string, RouteDefinition>> = {\n  [Name in keyof Routes]: Pick<Routes[Name], 'method' | 'path'>;\n};\n\n/** Extracts `{ name: string }` from a `/:name` path pattern. */\nexport type PathParams<Path extends string> =\n  Path extends `${string}:${infer Name}/${infer Rest}`\n    ? { [Key in Name]: string } & PathParams<`/${Rest}`>\n    : Path extends `${string}:${infer Name}`\n      ? { [Key in Name]: string }\n      : Record<never, never>;\n\n/** Untyped implementation of {@link buildRouteURL}. */\nconst joinRouteURL = (\n  backendURL: string,\n  prefix: string,\n  path: string,\n  params?: Record<string, string>\n): string => {\n  const resolvedPath = path.replace(\n    /:([A-Za-z0-9_]+)/g,\n    (_match, name: string) => {\n      const value = params?.[name];\n\n      if (value === undefined) {\n        throw new Error(`Missing route param \"${name}\" for ${path}`);\n      }\n\n      return encodeURIComponent(value);\n    }\n  );\n  const normalizedPath = resolvedPath === '/' ? '' : resolvedPath;\n\n  return `${backendURL}${prefix}${normalizedPath}`;\n};\n\n/**\n * Builds the absolute URL of a route by joining the backend URL, the group\n * prefix and the path, with `:param` segments replaced and URI-encoded.\n */\nexport const buildRouteURL = <Prefix extends string, Path extends string>(\n  backendURL: string,\n  group: Pick<RouteGroup<Prefix>, 'prefix'>,\n  route: Pick<RouteDefinition<HttpMethod, Path>, 'path'>,\n  ...[params]: keyof PathParams<Path> extends never\n    ? []\n    : [params: PathParams<Path>]\n): string =>\n  joinRouteURL(\n    backendURL,\n    group.prefix,\n    route.path,\n    params as Record<string, string> | undefined\n  );\n"],"mappings":";;;AA6CA,MAAa,eAKX,UAC2C;;AAG7C,MAAa,oBAIX,UAC+B;;AAyCjC,MAAM,gBACJ,YACA,QACA,MACA,WACW;CACX,MAAM,eAAe,KAAK,QACxB,sBACC,QAAQ,SAAiB;EACxB,MAAM,QAAQ,SAAS;EAEvB,IAAI,UAAU,QACZ,MAAM,IAAI,MAAM,wBAAwB,KAAK,QAAQ,MAAM;EAG7D,OAAO,mBAAmB,KAAK;CACjC,CACF;CAGA,OAAO,GAAG,aAAa,SAFA,iBAAiB,MAAM,KAAK;AAGrD;;;;;AAMA,MAAa,iBACX,YACA,OACA,OACA,GAAG,CAAC,YAIJ,aACE,YACA,MAAM,QACN,MAAM,MACN,MACF"}

package/dist/cjs/demo.cjs

@@ -0,0 +1,22 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_defineRoute = require('./defineRoute.cjs');
+let zod_mini = require("zod/mini");
+
+//#region src/demo.ts
+/** REST contract of the `/api/demo` routes (cloud only). */
+const demoContract = require_defineRoute.defineRouteGroup({
+	prefix: "/api/demo",
+	tag: "Demo",
+	routes: { getDemoSession: require_defineRoute.defineRoute({
+		method: "GET",
+		path: "/session",
+		summary: "Sign the browser into the shared read-only demo account",
+		schemas: { 
+		/** Sets the demo session cookie. */
+response: { 200: zod_mini.z.object({ ok: zod_mini.z.boolean() }) } }
+	}) }
+});
+
+//#endregion
+exports.demoContract = demoContract;
+//# sourceMappingURL=demo.cjs.map

package/dist/cjs/demo.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"demo.cjs","names":["defineRouteGroup","defineRoute","z"],"sources":["../../src/demo.ts"],"sourcesContent":["import { z } from 'zod/mini';\nimport { defineRoute, defineRouteGroup } from './defineRoute';\n\n/** REST contract of the `/api/demo` routes (cloud only). */\nexport const demoContract = defineRouteGroup({\n  prefix: '/api/demo',\n  tag: 'Demo',\n  routes: {\n    getDemoSession: defineRoute({\n      method: 'GET',\n      path: '/session',\n      summary: 'Sign the browser into the shared read-only demo account',\n      schemas: {\n        /** Sets the demo session cookie. */\n        response: { 200: z.object({ ok: z.boolean() }) },\n      },\n    }),\n  },\n});\n\n/** Route definitions of the `/api/demo` group, by name. */\nexport type DemoRoutes = (typeof demoContract)['routes'];\n\nexport type GetDemoSessionResult = { ok: boolean };\n"],"mappings":";;;;;;AAIA,MAAa,eAAeA,qCAAiB;CAC3C,QAAQ;CACR,KAAK;CACL,QAAQ,EACN,gBAAgBC,gCAAY;EAC1B,QAAQ;EACR,MAAM;EACN,SAAS;EACT,SAAS;;AAEP,UAAU,EAAE,KAAKC,WAAE,OAAO,EAAE,IAAIA,WAAE,QAAQ,EAAE,CAAC,EAAE,EACjD;CACF,CAAC,EACH;AACF,CAAC"}

package/dist/cjs/dictionary.cjs

@@ -0,0 +1,168 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_common = require('./common.cjs');
+const require_defineRoute = require('./defineRoute.cjs');
+const require_responseData = require('./responseData.cjs');
+let zod_mini = require("zod/mini");
+
+//#region src/dictionary.ts
+/** Whether a value looks like a dictionary (object with a string `key`). */
+const isDictionaryLike = (value) => require_common.isJSONObject(value) && typeof value.key === "string";
+/** Dictionary as returned by the API (content documented as any JSON). */
+const dictionarySchema = require_common.typedValueSchema(isDictionaryLike);
+/** Dictionary pushed by the CLI / editor (`@intlayer/types` shape). */
+const localDictionarySchema = require_common.typedValueSchema(isDictionaryLike);
+/** Content node of a dictionary (`@intlayer/types`). */
+const contentNodeSchema = require_common.typedValueSchema();
+/** Result of a push, per dictionary. */
+const pushedDictionarySchema = zod_mini.z.object({
+	key: zod_mini.z.string(),
+	localId: zod_mini.z.string(),
+	id: zod_mini.z.optional(zod_mini.z.string())
+});
+const pushDictionariesResultSchema = zod_mini.z.object({
+	newDictionaries: zod_mini.z.array(pushedDictionarySchema),
+	updatedDictionaries: zod_mini.z.array(pushedDictionarySchema),
+	upToDateDictionaries: zod_mini.z.array(pushedDictionarySchema),
+	error: zod_mini.z.array(zod_mini.z.object({
+		id: zod_mini.z.optional(zod_mini.z.string()),
+		key: zod_mini.z.string(),
+		localId: zod_mini.z.optional(zod_mini.z.string()),
+		message: zod_mini.z.string()
+	}))
+});
+const dictionaryIdParamsSchema = zod_mini.z.object({ dictionaryId: require_common.objectIdSchema });
+/** REST contract of the `/api/dictionary` routes. */
+const dictionaryContract = require_defineRoute.defineRouteGroup({
+	prefix: "/api/dictionary",
+	tag: "Dictionary",
+	routes: {
+		getDictionaries: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/",
+			summary: "List the dictionaries of the selected project",
+			schemas: {
+				querystring: zod_mini.z.looseObject({
+					...require_common.paginationQueryShape,
+					ids: zod_mini.z.optional(require_common.repeatableQueryValueSchema),
+					projectId: zod_mini.z.optional(zod_mini.z.string()),
+					projectIds: zod_mini.z.optional(require_common.repeatableQueryValueSchema),
+					organizationId: zod_mini.z.optional(zod_mini.z.string()),
+					organizationIds: zod_mini.z.optional(require_common.repeatableQueryValueSchema),
+					userId: zod_mini.z.optional(zod_mini.z.string()),
+					userIds: zod_mini.z.optional(require_common.repeatableQueryValueSchema),
+					creatorId: zod_mini.z.optional(zod_mini.z.string()),
+					creatorIds: zod_mini.z.optional(require_common.repeatableQueryValueSchema),
+					title: zod_mini.z.optional(zod_mini.z.string()),
+					description: zod_mini.z.optional(zod_mini.z.string()),
+					key: zod_mini.z.optional(zod_mini.z.string()),
+					keys: zod_mini.z.optional(require_common.repeatableQueryValueSchema),
+					tags: zod_mini.z.optional(require_common.repeatableQueryValueSchema),
+					location: zod_mini.z.optional(zod_mini.z.enum([
+						"remote",
+						"local",
+						"both",
+						"none"
+					]))
+				}),
+				response: { 200: require_responseData.paginatedResponseSchema(dictionarySchema) }
+			}
+		}),
+		getDictionariesKeys: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/keys",
+			summary: "Keys of every dictionary of the selected project",
+			schemas: { response: { 200: require_responseData.responseDataSchema(zod_mini.z.array(zod_mini.z.string())) } }
+		}),
+		getDictionariesUpdateTimestamp: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/update",
+			summary: "Last update time (epoch ms) of each dictionary, by id",
+			schemas: { response: { 200: require_responseData.responseDataSchema(zod_mini.z.record(zod_mini.z.string(), zod_mini.z.object({
+				key: zod_mini.z.string(),
+				updatedAt: zod_mini.z.number()
+			}))) } }
+		}),
+		getDictionariesByKeys: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/by-keys",
+			summary: "Get several dictionaries by key",
+			schemas: {
+				querystring: zod_mini.z.object({
+					/** Comma-separated string or repeated parameter. */
+					keys: require_common.repeatableQueryValueSchema,
+					version: zod_mini.z.optional(zod_mini.z.string())
+				}),
+				response: { 200: require_responseData.responseDataSchema(zod_mini.z.array(dictionarySchema)) }
+			}
+		}),
+		getDictionary: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/:dictionaryKey",
+			summary: "Get a dictionary by key",
+			schemas: {
+				params: zod_mini.z.object({ dictionaryKey: zod_mini.z.string().check(zod_mini.z.minLength(1), zod_mini.z.maxLength(255)) }),
+				querystring: zod_mini.z.object({ version: zod_mini.z.optional(zod_mini.z.string()) }),
+				response: { 200: require_responseData.responseDataSchema(dictionarySchema) }
+			}
+		}),
+		addDictionary: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/",
+			summary: "Create a dictionary in the selected project",
+			schemas: {
+				body: zod_mini.z.object({ dictionary: zod_mini.z.looseObject({
+					key: zod_mini.z.string().check(zod_mini.z.minLength(1)),
+					projectIds: zod_mini.z.array(zod_mini.z.string()),
+					content: zod_mini.z.optional(contentNodeSchema),
+					title: zod_mini.z.optional(zod_mini.z.string()),
+					description: zod_mini.z.optional(zod_mini.z.string()),
+					priority: zod_mini.z.optional(zod_mini.z.number()),
+					importMode: zod_mini.z.optional(zod_mini.z.enum([
+						"static",
+						"dynamic",
+						"fetch"
+					])),
+					tags: zod_mini.z.optional(zod_mini.z.array(zod_mini.z.string())),
+					environmentId: zod_mini.z.optional(zod_mini.z.string())
+				}) }),
+				response: { 200: require_responseData.responseDataSchema(dictionarySchema) }
+			}
+		}),
+		pushDictionaries: require_defineRoute.defineRoute({
+			method: "PATCH",
+			path: "/",
+			summary: "Push local dictionaries (CLI): create or version them",
+			schemas: {
+				body: zod_mini.z.object({ dictionaries: zod_mini.z.array(localDictionarySchema) }),
+				response: { 200: require_responseData.responseDataSchema(pushDictionariesResultSchema) }
+			}
+		}),
+		updateDictionary: require_defineRoute.defineRoute({
+			method: "PUT",
+			path: "/:dictionaryId",
+			summary: "Update a dictionary of the selected project",
+			schemas: {
+				params: dictionaryIdParamsSchema,
+				body: require_common.typedValueSchema(require_common.isJSONObject),
+				response: { 200: require_responseData.responseDataSchema(dictionarySchema) }
+			}
+		}),
+		deleteDictionary: require_defineRoute.defineRoute({
+			method: "DELETE",
+			path: "/:dictionaryId",
+			summary: "Delete a dictionary of the selected project",
+			schemas: {
+				params: dictionaryIdParamsSchema,
+				response: { 200: require_responseData.responseDataSchema(dictionarySchema) }
+			}
+		})
+	}
+});
+
+//#endregion
+exports.contentNodeSchema = contentNodeSchema;
+exports.dictionaryContract = dictionaryContract;
+exports.dictionarySchema = dictionarySchema;
+exports.localDictionarySchema = localDictionarySchema;
+exports.pushDictionariesResultSchema = pushDictionariesResultSchema;
+//# sourceMappingURL=dictionary.cjs.map

package/dist/cjs/dictionary.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"dictionary.cjs","names":["isJSONObject","typedValueSchema","z","objectIdSchema","defineRouteGroup","defineRoute","paginationQueryShape","repeatableQueryValueSchema","paginatedResponseSchema","responseDataSchema"],"sources":["../../src/dictionary.ts"],"sourcesContent":["import type { ContentNode, Dictionary } from '@intlayer/types/dictionary';\nimport { z } from 'zod/mini';\nimport {\n  isJSONObject,\n  objectIdSchema,\n  paginationQueryShape,\n  repeatableQueryValueSchema,\n  typedValueSchema,\n} from './common';\nimport {\n  defineRoute,\n  defineRouteGroup,\n  type RouteBodyInput,\n  type RouteParams,\n  type RouteQuerystring,\n} from './defineRoute';\nimport {\n  type PaginatedResponse,\n  paginatedResponseSchema,\n  type ResponseData,\n  responseDataSchema,\n} from './responseData';\n\n/** Outcome of the last commit of a CMS edit to the source `.content` file. */\nexport type DictionarySourceSync = {\n  status:\n    | 'committed'\n    | 'pull-request'\n    | 'up-to-date'\n    | 'file-not-found'\n    | 'unsupported'\n    | 'error';\n  /** Commit (or pull request) link on the git provider. */\n  url?: string;\n  commitSha?: string;\n  message?: string;\n  syncedAt: string;\n};\n\n/** Fields the server adds to a stored dictionary. */\ntype DictionaryServerFields = {\n  id: string;\n  projectIds: string[];\n  creatorId: string;\n  /** Content versions, oldest first. */\n  versionList: string[];\n  /** Environment the dictionary belongs to; null = shared by all. */\n  environmentId?: string | null;\n  sourceSync?: DictionarySourceSync;\n  createdAt: string;\n  updatedAt: string;\n};\n\n/**\n * Dictionary as returned by the API: the `@intlayer/types` dictionary (the\n * framework-wide source of truth for content) plus the server fields.\n */\nexport type DictionaryAPI = Omit<Dictionary, keyof DictionaryServerFields> &\n  DictionaryServerFields;\n\n/** Whether a value looks like a dictionary (object with a string `key`). */\nconst isDictionaryLike = (value: unknown): boolean =>\n  isJSONObject(value) && typeof value.key === 'string';\n\n/** Dictionary as returned by the API (content documented as any JSON). */\nexport const dictionarySchema =\n  typedValueSchema<DictionaryAPI>(isDictionaryLike);\n\n/** Dictionary pushed by the CLI / editor (`@intlayer/types` shape). */\nexport const localDictionarySchema =\n  typedValueSchema<Dictionary>(isDictionaryLike);\n\n/** Content node of a dictionary (`@intlayer/types`). */\nexport const contentNodeSchema = typedValueSchema<ContentNode>();\n\n/** Result of a push, per dictionary. */\nconst pushedDictionarySchema = z.object({\n  key: z.string(),\n  localId: z.string(),\n  id: z.optional(z.string()),\n});\n\nexport const pushDictionariesResultSchema = z.object({\n  newDictionaries: z.array(pushedDictionarySchema),\n  updatedDictionaries: z.array(pushedDictionarySchema),\n  upToDateDictionaries: z.array(pushedDictionarySchema),\n  error: z.array(\n    z.object({\n      id: z.optional(z.string()),\n      key: z.string(),\n      localId: z.optional(z.string()),\n      message: z.string(),\n    })\n  ),\n});\n\nconst dictionaryIdParamsSchema = z.object({ dictionaryId: objectIdSchema });\n\n/** REST contract of the `/api/dictionary` routes. */\nexport const dictionaryContract = defineRouteGroup({\n  prefix: '/api/dictionary',\n  tag: 'Dictionary',\n  routes: {\n    getDictionaries: defineRoute({\n      method: 'GET',\n      path: '/',\n      summary: 'List the dictionaries of the selected project',\n      schemas: {\n        querystring: z.looseObject({\n          ...paginationQueryShape,\n          ids: z.optional(repeatableQueryValueSchema),\n          projectId: z.optional(z.string()),\n          projectIds: z.optional(repeatableQueryValueSchema),\n          organizationId: z.optional(z.string()),\n          organizationIds: z.optional(repeatableQueryValueSchema),\n          userId: z.optional(z.string()),\n          userIds: z.optional(repeatableQueryValueSchema),\n          creatorId: z.optional(z.string()),\n          creatorIds: z.optional(repeatableQueryValueSchema),\n          title: z.optional(z.string()),\n          description: z.optional(z.string()),\n          key: z.optional(z.string()),\n          keys: z.optional(repeatableQueryValueSchema),\n          tags: z.optional(repeatableQueryValueSchema),\n          location: z.optional(z.enum(['remote', 'local', 'both', 'none'])),\n        }),\n        response: { 200: paginatedResponseSchema(dictionarySchema) },\n      },\n    }),\n    getDictionariesKeys: defineRoute({\n      method: 'GET',\n      path: '/keys',\n      summary: 'Keys of every dictionary of the selected project',\n      schemas: {\n        response: { 200: responseDataSchema(z.array(z.string())) },\n      },\n    }),\n    getDictionariesUpdateTimestamp: defineRoute({\n      method: 'GET',\n      path: '/update',\n      summary: 'Last update time (epoch ms) of each dictionary, by id',\n      schemas: {\n        response: {\n          200: responseDataSchema(\n            z.record(\n              z.string(),\n              z.object({ key: z.string(), updatedAt: z.number() })\n            )\n          ),\n        },\n      },\n    }),\n    getDictionariesByKeys: defineRoute({\n      method: 'GET',\n      path: '/by-keys',\n      summary: 'Get several dictionaries by key',\n      schemas: {\n        querystring: z.object({\n          /** Comma-separated string or repeated parameter. */\n          keys: repeatableQueryValueSchema,\n          version: z.optional(z.string()),\n        }),\n        response: { 200: responseDataSchema(z.array(dictionarySchema)) },\n      },\n    }),\n    getDictionary: defineRoute({\n      method: 'GET',\n      path: '/:dictionaryKey',\n      summary: 'Get a dictionary by key',\n      schemas: {\n        params: z.object({\n          dictionaryKey: z.string().check(z.minLength(1), z.maxLength(255)),\n        }),\n        querystring: z.object({ version: z.optional(z.string()) }),\n        response: { 200: responseDataSchema(dictionarySchema) },\n      },\n    }),\n    addDictionary: defineRoute({\n      method: 'POST',\n      path: '/',\n      summary: 'Create a dictionary in the selected project',\n      schemas: {\n        body: z.object({\n          dictionary: z.looseObject({\n            key: z.string().check(z.minLength(1)),\n            projectIds: z.array(z.string()),\n            content: z.optional(contentNodeSchema),\n            title: z.optional(z.string()),\n            description: z.optional(z.string()),\n            priority: z.optional(z.number()),\n            importMode: z.optional(z.enum(['static', 'dynamic', 'fetch'])),\n            tags: z.optional(z.array(z.string())),\n            environmentId: z.optional(z.string()),\n          }),\n        }),\n        response: { 200: responseDataSchema(dictionarySchema) },\n      },\n    }),\n    pushDictionaries: defineRoute({\n      method: 'PATCH',\n      path: '/',\n      summary: 'Push local dictionaries (CLI): create or version them',\n      schemas: {\n        body: z.object({ dictionaries: z.array(localDictionarySchema) }),\n        response: { 200: responseDataSchema(pushDictionariesResultSchema) },\n      },\n    }),\n    updateDictionary: defineRoute({\n      method: 'PUT',\n      path: '/:dictionaryId',\n      summary: 'Update a dictionary of the selected project',\n      schemas: {\n        params: dictionaryIdParamsSchema,\n        body: typedValueSchema<Partial<DictionaryAPI>>(isJSONObject),\n        response: { 200: responseDataSchema(dictionarySchema) },\n      },\n    }),\n    deleteDictionary: defineRoute({\n      method: 'DELETE',\n      path: '/:dictionaryId',\n      summary: 'Delete a dictionary of the selected project',\n      schemas: {\n        params: dictionaryIdParamsSchema,\n        response: { 200: responseDataSchema(dictionarySchema) },\n      },\n    }),\n  },\n});\n\n/** Route definitions of the `/api/dictionary` group, by name. */\nexport type DictionaryRoutes = (typeof dictionaryContract)['routes'];\n\nexport type PushDictionariesResultData = z.output<\n  typeof pushDictionariesResultSchema\n>;\nexport type GetDictionariesParams = RouteQuerystring<\n  DictionaryRoutes['getDictionaries']\n>;\nexport type GetDictionariesResult = PaginatedResponse<DictionaryAPI>;\nexport type GetDictionariesKeysResult = ResponseData<string[]>;\nexport type GetDictionariesUpdateTimestampResult = ResponseData<\n  Record<string, { key: string; updatedAt: number }>\n>;\nexport type GetDictionaryParams = RouteParams<\n  DictionaryRoutes['getDictionary']\n>;\nexport type GetDictionaryQuery = RouteQuerystring<\n  DictionaryRoutes['getDictionary']\n>;\nexport type GetDictionaryResult = ResponseData<DictionaryAPI>;\nexport type GetDictionariesByKeysQuery = RouteQuerystring<\n  DictionaryRoutes['getDictionariesByKeys']\n>;\nexport type GetDictionariesByKeysResult = ResponseData<DictionaryAPI[]>;\nexport type AddDictionaryBody = RouteBodyInput<\n  DictionaryRoutes['addDictionary']\n>;\nexport type AddDictionaryResult = ResponseData<DictionaryAPI>;\nexport type PushDictionariesBody = RouteBodyInput<\n  DictionaryRoutes['pushDictionaries']\n>;\nexport type PushDictionariesResult = ResponseData<PushDictionariesResultData>;\nexport type UpdateDictionaryParam = RouteParams<\n  DictionaryRoutes['updateDictionary']\n>;\nexport type UpdateDictionaryBody = RouteBodyInput<\n  DictionaryRoutes['updateDictionary']\n>;\nexport type UpdateDictionaryResult = ResponseData<DictionaryAPI>;\nexport type DeleteDictionaryParam = RouteParams<\n  DictionaryRoutes['deleteDictionary']\n>;\nexport type DeleteDictionaryResult = ResponseData<DictionaryAPI>;\n"],"mappings":";;;;;;;;AA6DA,MAAM,oBAAoB,UACxBA,4BAAa,KAAK,KAAK,OAAO,MAAM,QAAQ;;AAG9C,MAAa,mBACXC,gCAAgC,gBAAgB;;AAGlD,MAAa,wBACXA,gCAA6B,gBAAgB;;AAG/C,MAAa,oBAAoBA,gCAA8B;;AAG/D,MAAM,yBAAyBC,WAAE,OAAO;CACtC,KAAKA,WAAE,OAAO;CACd,SAASA,WAAE,OAAO;CAClB,IAAIA,WAAE,SAASA,WAAE,OAAO,CAAC;AAC3B,CAAC;AAED,MAAa,+BAA+BA,WAAE,OAAO;CACnD,iBAAiBA,WAAE,MAAM,sBAAsB;CAC/C,qBAAqBA,WAAE,MAAM,sBAAsB;CACnD,sBAAsBA,WAAE,MAAM,sBAAsB;CACpD,OAAOA,WAAE,MACPA,WAAE,OAAO;EACP,IAAIA,WAAE,SAASA,WAAE,OAAO,CAAC;EACzB,KAAKA,WAAE,OAAO;EACd,SAASA,WAAE,SAASA,WAAE,OAAO,CAAC;EAC9B,SAASA,WAAE,OAAO;CACpB,CAAC,CACH;AACF,CAAC;AAED,MAAM,2BAA2BA,WAAE,OAAO,EAAE,cAAcC,8BAAe,CAAC;;AAG1E,MAAa,qBAAqBC,qCAAiB;CACjD,QAAQ;CACR,KAAK;CACL,QAAQ;EACN,iBAAiBC,gCAAY;GAC3B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAaH,WAAE,YAAY;KACzB,GAAGI;KACH,KAAKJ,WAAE,SAASK,yCAA0B;KAC1C,WAAWL,WAAE,SAASA,WAAE,OAAO,CAAC;KAChC,YAAYA,WAAE,SAASK,yCAA0B;KACjD,gBAAgBL,WAAE,SAASA,WAAE,OAAO,CAAC;KACrC,iBAAiBA,WAAE,SAASK,yCAA0B;KACtD,QAAQL,WAAE,SAASA,WAAE,OAAO,CAAC;KAC7B,SAASA,WAAE,SAASK,yCAA0B;KAC9C,WAAWL,WAAE,SAASA,WAAE,OAAO,CAAC;KAChC,YAAYA,WAAE,SAASK,yCAA0B;KACjD,OAAOL,WAAE,SAASA,WAAE,OAAO,CAAC;KAC5B,aAAaA,WAAE,SAASA,WAAE,OAAO,CAAC;KAClC,KAAKA,WAAE,SAASA,WAAE,OAAO,CAAC;KAC1B,MAAMA,WAAE,SAASK,yCAA0B;KAC3C,MAAML,WAAE,SAASK,yCAA0B;KAC3C,UAAUL,WAAE,SAASA,WAAE,KAAK;MAAC;MAAU;MAAS;MAAQ;KAAM,CAAC,CAAC;IAClE,CAAC;IACD,UAAU,EAAE,KAAKM,6CAAwB,gBAAgB,EAAE;GAC7D;EACF,CAAC;EACD,qBAAqBH,gCAAY;GAC/B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EAAE,KAAKI,wCAAmBP,WAAE,MAAMA,WAAE,OAAO,CAAC,CAAC,EAAE,EAC3D;EACF,CAAC;EACD,gCAAgCG,gCAAY;GAC1C,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EACR,KAAKI,wCACHP,WAAE,OACAA,WAAE,OAAO,GACTA,WAAE,OAAO;IAAE,KAAKA,WAAE,OAAO;IAAG,WAAWA,WAAE,OAAO;GAAE,CAAC,CACrD,CACF,EACF,EACF;EACF,CAAC;EACD,uBAAuBG,gCAAY;GACjC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAaH,WAAE,OAAO;;KAEpB,MAAMK;KACN,SAASL,WAAE,SAASA,WAAE,OAAO,CAAC;IAChC,CAAC;IACD,UAAU,EAAE,KAAKO,wCAAmBP,WAAE,MAAM,gBAAgB,CAAC,EAAE;GACjE;EACF,CAAC;EACD,eAAeG,gCAAY;GACzB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQH,WAAE,OAAO,EACf,eAAeA,WAAE,OAAO,CAAC,CAAC,MAAMA,WAAE,UAAU,CAAC,GAAGA,WAAE,UAAU,GAAG,CAAC,EAClE,CAAC;IACD,aAAaA,WAAE,OAAO,EAAE,SAASA,WAAE,SAASA,WAAE,OAAO,CAAC,EAAE,CAAC;IACzD,UAAU,EAAE,KAAKO,wCAAmB,gBAAgB,EAAE;GACxD;EACF,CAAC;EACD,eAAeJ,gCAAY;GACzB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAMH,WAAE,OAAO,EACb,YAAYA,WAAE,YAAY;KACxB,KAAKA,WAAE,OAAO,CAAC,CAAC,MAAMA,WAAE,UAAU,CAAC,CAAC;KACpC,YAAYA,WAAE,MAAMA,WAAE,OAAO,CAAC;KAC9B,SAASA,WAAE,SAAS,iBAAiB;KACrC,OAAOA,WAAE,SAASA,WAAE,OAAO,CAAC;KAC5B,aAAaA,WAAE,SAASA,WAAE,OAAO,CAAC;KAClC,UAAUA,WAAE,SAASA,WAAE,OAAO,CAAC;KAC/B,YAAYA,WAAE,SAASA,WAAE,KAAK;MAAC;MAAU;MAAW;KAAO,CAAC,CAAC;KAC7D,MAAMA,WAAE,SAASA,WAAE,MAAMA,WAAE,OAAO,CAAC,CAAC;KACpC,eAAeA,WAAE,SAASA,WAAE,OAAO,CAAC;IACtC,CAAC,EACH,CAAC;IACD,UAAU,EAAE,KAAKO,wCAAmB,gBAAgB,EAAE;GACxD;EACF,CAAC;EACD,kBAAkBJ,gCAAY;GAC5B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAMH,WAAE,OAAO,EAAE,cAAcA,WAAE,MAAM,qBAAqB,EAAE,CAAC;IAC/D,UAAU,EAAE,KAAKO,wCAAmB,4BAA4B,EAAE;GACpE;EACF,CAAC;EACD,kBAAkBJ,gCAAY;GAC5B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,MAAMJ,gCAAyCD,2BAAY;IAC3D,UAAU,EAAE,KAAKS,wCAAmB,gBAAgB,EAAE;GACxD;EACF,CAAC;EACD,kBAAkBJ,gCAAY;GAC5B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EAAE,KAAKI,wCAAmB,gBAAgB,EAAE;GACxD;EACF,CAAC;CACH;AACF,CAAC"}

package/dist/cjs/environment.cjs

@@ -0,0 +1,91 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_common = require('./common.cjs');
+const require_defineRoute = require('./defineRoute.cjs');
+const require_responseData = require('./responseData.cjs');
+const require_project = require('./project.cjs');
+let zod_mini = require("zod/mini");
+
+//#region src/environment.ts
+const environmentIdParamsSchema = zod_mini.z.object({ environmentId: require_common.objectIdSchema });
+/** Every environment of the project, production first when virtual. */
+const environmentsResponseSchema = require_responseData.responseDataSchema(zod_mini.z.array(require_project.environmentSchema));
+/** REST contract of the `/api/project/environment` routes. */
+const environmentContract = require_defineRoute.defineRouteGroup({
+	prefix: "/api/project/environment",
+	tag: "Environment",
+	routes: {
+		addEnvironment: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/",
+			summary: "Create an environment in the selected project",
+			schemas: {
+				body: zod_mini.z.object({
+					name: zod_mini.z.string(),
+					configuration: zod_mini.z.optional(require_project.projectConfigurationSchema)
+				}),
+				response: { 200: environmentsResponseSchema }
+			}
+		}),
+		updateEnvironment: require_defineRoute.defineRoute({
+			method: "PUT",
+			path: "/:environmentId",
+			summary: "Rename or reconfigure an environment",
+			schemas: {
+				params: environmentIdParamsSchema,
+				body: zod_mini.z.object({
+					name: zod_mini.z.optional(zod_mini.z.string()),
+					configuration: zod_mini.z.optional(require_project.projectConfigurationSchema)
+				}),
+				response: { 200: environmentsResponseSchema }
+			}
+		}),
+		deleteEnvironment: require_defineRoute.defineRoute({
+			method: "DELETE",
+			path: "/:environmentId",
+			summary: "Delete an environment",
+			schemas: {
+				params: environmentIdParamsSchema,
+				response: { 200: environmentsResponseSchema }
+			}
+		}),
+		resetToProductionEnvironment: require_defineRoute.defineRoute({
+			method: "PUT",
+			path: "/production/select",
+			summary: "Select the production environment for the session",
+			schemas: { response: { 200: require_responseData.responseDataSchema(zod_mini.z.nullable(require_project.environmentSchema)) } }
+		}),
+		selectEnvironment: require_defineRoute.defineRoute({
+			method: "PUT",
+			path: "/:environmentId/select",
+			summary: "Select an environment for the session",
+			schemas: {
+				params: environmentIdParamsSchema,
+				response: { 200: require_responseData.responseDataSchema(require_project.environmentSchema) }
+			}
+		}),
+		migrateEnvironment: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/migrate",
+			summary: "Copy dictionaries and configuration between environments",
+			schemas: {
+				body: zod_mini.z.object({
+					/** Environment id, or `production` for the default environment. */
+					sourceEnvironmentId: zod_mini.z.string(),
+					targetEnvironmentId: zod_mini.z.string(),
+					strategy: zod_mini.z.enum(["overwrite", "fill-missing"]),
+					migrateContent: zod_mini.z.optional(zod_mini.z.boolean()),
+					migrateConfiguration: zod_mini.z.optional(zod_mini.z.boolean())
+				}),
+				response: { 200: require_responseData.responseDataSchema(zod_mini.z.object({
+					migratedDictionaries: zod_mini.z.number(),
+					skippedDictionaries: zod_mini.z.number(),
+					configurationMigrated: zod_mini.z.boolean()
+				})) }
+			}
+		})
+	}
+});
+
+//#endregion
+exports.environmentContract = environmentContract;
+//# sourceMappingURL=environment.cjs.map

package/dist/cjs/environment.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.cjs","names":["z","objectIdSchema","responseDataSchema","environmentSchema","defineRouteGroup","defineRoute","projectConfigurationSchema"],"sources":["../../src/environment.ts"],"sourcesContent":["import { z } from 'zod/mini';\nimport { objectIdSchema } from './common';\nimport {\n  defineRoute,\n  defineRouteGroup,\n  type RouteBodyInput,\n  type RouteParams,\n} from './defineRoute';\nimport {\n  type EnvironmentAPI,\n  environmentSchema,\n  projectConfigurationSchema,\n} from './project';\nimport { type ResponseData, responseDataSchema } from './responseData';\n\nconst environmentIdParamsSchema = z.object({ environmentId: objectIdSchema });\n\n/** Every environment of the project, production first when virtual. */\nconst environmentsResponseSchema = responseDataSchema(\n  z.array(environmentSchema)\n);\n\n/** REST contract of the `/api/project/environment` routes. */\nexport const environmentContract = defineRouteGroup({\n  prefix: '/api/project/environment',\n  tag: 'Environment',\n  routes: {\n    addEnvironment: defineRoute({\n      method: 'POST',\n      path: '/',\n      summary: 'Create an environment in the selected project',\n      schemas: {\n        body: z.object({\n          name: z.string(),\n          configuration: z.optional(projectConfigurationSchema),\n        }),\n        response: { 200: environmentsResponseSchema },\n      },\n    }),\n    updateEnvironment: defineRoute({\n      method: 'PUT',\n      path: '/:environmentId',\n      summary: 'Rename or reconfigure an environment',\n      schemas: {\n        params: environmentIdParamsSchema,\n        body: z.object({\n          name: z.optional(z.string()),\n          configuration: z.optional(projectConfigurationSchema),\n        }),\n        response: { 200: environmentsResponseSchema },\n      },\n    }),\n    deleteEnvironment: defineRoute({\n      method: 'DELETE',\n      path: '/:environmentId',\n      summary: 'Delete an environment',\n      schemas: {\n        params: environmentIdParamsSchema,\n        response: { 200: environmentsResponseSchema },\n      },\n    }),\n    resetToProductionEnvironment: defineRoute({\n      method: 'PUT',\n      path: '/production/select',\n      summary: 'Select the production environment for the session',\n      schemas: {\n        response: { 200: responseDataSchema(z.nullable(environmentSchema)) },\n      },\n    }),\n    selectEnvironment: defineRoute({\n      method: 'PUT',\n      path: '/:environmentId/select',\n      summary: 'Select an environment for the session',\n      schemas: {\n        params: environmentIdParamsSchema,\n        response: { 200: responseDataSchema(environmentSchema) },\n      },\n    }),\n    migrateEnvironment: defineRoute({\n      method: 'POST',\n      path: '/migrate',\n      summary: 'Copy dictionaries and configuration between environments',\n      schemas: {\n        body: z.object({\n          /** Environment id, or `production` for the default environment. */\n          sourceEnvironmentId: z.string(),\n          targetEnvironmentId: z.string(),\n          strategy: z.enum(['overwrite', 'fill-missing']),\n          migrateContent: z.optional(z.boolean()),\n          migrateConfiguration: z.optional(z.boolean()),\n        }),\n        response: {\n          200: responseDataSchema(\n            z.object({\n              migratedDictionaries: z.number(),\n              skippedDictionaries: z.number(),\n              configurationMigrated: z.boolean(),\n            })\n          ),\n        },\n      },\n    }),\n  },\n});\n\n/** Route definitions of the `/api/project/environment` group, by name. */\nexport type EnvironmentRoutes = (typeof environmentContract)['routes'];\n\nexport type AddEnvironmentBody = RouteBodyInput<\n  EnvironmentRoutes['addEnvironment']\n>;\nexport type AddEnvironmentResult = ResponseData<EnvironmentAPI[]>;\nexport type UpdateEnvironmentParams = RouteParams<\n  EnvironmentRoutes['updateEnvironment']\n>;\nexport type UpdateEnvironmentBody = RouteBodyInput<\n  EnvironmentRoutes['updateEnvironment']\n>;\nexport type UpdateEnvironmentResult = ResponseData<EnvironmentAPI[]>;\nexport type DeleteEnvironmentParams = RouteParams<\n  EnvironmentRoutes['deleteEnvironment']\n>;\nexport type DeleteEnvironmentResult = ResponseData<EnvironmentAPI[]>;\nexport type SelectEnvironmentParams = RouteParams<\n  EnvironmentRoutes['selectEnvironment']\n>;\nexport type SelectEnvironmentResult = ResponseData<EnvironmentAPI>;\nexport type ResetToProductionEnvironmentResult =\n  ResponseData<EnvironmentAPI | null>;\nexport type MigrateEnvironmentBody = RouteBodyInput<\n  EnvironmentRoutes['migrateEnvironment']\n>;\nexport type MigrateEnvironmentResult = ResponseData<{\n  migratedDictionaries: number;\n  skippedDictionaries: number;\n  configurationMigrated: boolean;\n}>;\n"],"mappings":";;;;;;;;AAeA,MAAM,4BAA4BA,WAAE,OAAO,EAAE,eAAeC,8BAAe,CAAC;;AAG5E,MAAM,6BAA6BC,wCACjCF,WAAE,MAAMG,iCAAiB,CAC3B;;AAGA,MAAa,sBAAsBC,qCAAiB;CAClD,QAAQ;CACR,KAAK;CACL,QAAQ;EACN,gBAAgBC,gCAAY;GAC1B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAML,WAAE,OAAO;KACb,MAAMA,WAAE,OAAO;KACf,eAAeA,WAAE,SAASM,0CAA0B;IACtD,CAAC;IACD,UAAU,EAAE,KAAK,2BAA2B;GAC9C;EACF,CAAC;EACD,mBAAmBD,gCAAY;GAC7B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,MAAML,WAAE,OAAO;KACb,MAAMA,WAAE,SAASA,WAAE,OAAO,CAAC;KAC3B,eAAeA,WAAE,SAASM,0CAA0B;IACtD,CAAC;IACD,UAAU,EAAE,KAAK,2BAA2B;GAC9C;EACF,CAAC;EACD,mBAAmBD,gCAAY;GAC7B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EAAE,KAAK,2BAA2B;GAC9C;EACF,CAAC;EACD,8BAA8BA,gCAAY;GACxC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EAAE,KAAKH,wCAAmBF,WAAE,SAASG,iCAAiB,CAAC,EAAE,EACrE;EACF,CAAC;EACD,mBAAmBE,gCAAY;GAC7B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EAAE,KAAKH,wCAAmBC,iCAAiB,EAAE;GACzD;EACF,CAAC;EACD,oBAAoBE,gCAAY;GAC9B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAML,WAAE,OAAO;;KAEb,qBAAqBA,WAAE,OAAO;KAC9B,qBAAqBA,WAAE,OAAO;KAC9B,UAAUA,WAAE,KAAK,CAAC,aAAa,cAAc,CAAC;KAC9C,gBAAgBA,WAAE,SAASA,WAAE,QAAQ,CAAC;KACtC,sBAAsBA,WAAE,SAASA,WAAE,QAAQ,CAAC;IAC9C,CAAC;IACD,UAAU,EACR,KAAKE,wCACHF,WAAE,OAAO;KACP,sBAAsBA,WAAE,OAAO;KAC/B,qBAAqBA,WAAE,OAAO;KAC9B,uBAAuBA,WAAE,QAAQ;IACnC,CAAC,CACH,EACF;GACF;EACF,CAAC;CACH;AACF,CAAC"}

package/dist/cjs/eventListener.cjs

@@ -0,0 +1,19 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_defineRoute = require('./defineRoute.cjs');
+
+//#region src/eventListener.ts
+/** Live dictionary change stream (server-sent events). */
+const eventListenerContract = require_defineRoute.defineRouteGroup({
+	prefix: "/api/event-listener",
+	tag: "Event listener",
+	routes: { checkDictionaryChangeSSE: require_defineRoute.defineRoute({
+		method: "GET",
+		path: "/",
+		summary: "Stream dictionary changes of the project (server-sent events)",
+		schemas: {}
+	}) }
+});
+
+//#endregion
+exports.eventListenerContract = eventListenerContract;
+//# sourceMappingURL=eventListener.cjs.map

package/dist/cjs/eventListener.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"eventListener.cjs","names":["defineRouteGroup","defineRoute"],"sources":["../../src/eventListener.ts"],"sourcesContent":["import { defineRoute, defineRouteGroup } from './defineRoute';\nimport type { DictionaryAPI } from './dictionary';\n\n/** Live dictionary change stream (server-sent events). */\nexport const eventListenerContract = defineRouteGroup({\n  prefix: '/api/event-listener',\n  tag: 'Event listener',\n  routes: {\n    checkDictionaryChangeSSE: defineRoute({\n      method: 'GET',\n      path: '/',\n      summary: 'Stream dictionary changes of the project (server-sent events)',\n      schemas: {},\n    }),\n  },\n});\n\n/** Route definitions of the event listener group, by name. */\nexport type EventListenerRoutes = (typeof eventListenerContract)['routes'];\n\n/** Message pushed on the dictionary change stream. */\nexport type MessageEventData = {\n  object: 'DICTIONARY';\n  status: 'ADDED' | 'UPDATED' | 'DELETED' | 'CREATED';\n  data: DictionaryAPI;\n};\n"],"mappings":";;;;;AAIA,MAAa,wBAAwBA,qCAAiB;CACpD,QAAQ;CACR,KAAK;CACL,QAAQ,EACN,0BAA0BC,gCAAY;EACpC,QAAQ;EACR,MAAM;EACN,SAAS;EACT,SAAS,CAAC;CACZ,CAAC,EACH;AACF,CAAC"}