@intlayer/backend-contract 0.0.0-stage → 9.7.0

package/dist/cjs/ai.cjs

@@ -0,0 +1,267 @@
+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_tag = require('./tag.cjs');
+let zod_mini = require("zod/mini");
+
+//#region src/ai.ts
+const aiOptionsSchema = require_common.typedValueSchema(require_common.isJSONObject);
+/** Chat message exchanged with the assistants. */
+const chatCompletionRequestMessageSchema = zod_mini.z.object({
+	role: zod_mini.z.enum([
+		"system",
+		"user",
+		"assistant"
+	]),
+	content: zod_mini.z.string(),
+	/** ISO date-time, parsed to a `Date`. */
+	timestamp: zod_mini.z.optional(zod_mini.z.pipe(zod_mini.z.string(), zod_mini.z.transform((value) => new Date(value))))
+});
+const localeSchema = require_common.typedStringSchema();
+const tokenUsedShape = { tokenUsed: zod_mini.z.number() };
+/** Text result of an AI step (translation, audit, query). */
+const fileContentResultSchema = zod_mini.z.object({
+	fileContent: zod_mini.z.string(),
+	...tokenUsedShape
+});
+/** Tag fields rewritten by the tag audit (parsed from the model's JSON). */
+const tagAuditResultSchema = zod_mini.z.object({
+	fileContent: zod_mini.z.looseObject({
+		key: zod_mini.z.optional(zod_mini.z.string()),
+		name: zod_mini.z.optional(zod_mini.z.string()),
+		description: zod_mini.z.optional(zod_mini.z.string()),
+		instructions: zod_mini.z.optional(zod_mini.z.string())
+	}),
+	...tokenUsedShape
+});
+const metadataResultSchema = zod_mini.z.object({
+	fileContent: zod_mini.z.object({
+		title: zod_mini.z.string(),
+		description: zod_mini.z.string(),
+		tags: zod_mini.z.array(zod_mini.z.string())
+	}),
+	...tokenUsedShape
+});
+/** JSON document translated by the AI. */
+const jsonContentSchema = require_common.typedValueSchema();
+const tokenUsageSchema = zod_mini.z.object({
+	inputTokens: zod_mini.z.number(),
+	outputTokens: zod_mini.z.number(),
+	totalTokens: zod_mini.z.number()
+});
+/** Message stored in a discussion. */
+const discussionMessageSchema = zod_mini.z.object({
+	role: zod_mini.z.enum([
+		"user",
+		"assistant",
+		"system"
+	]),
+	content: zod_mini.z.string(),
+	relatedFiles: zod_mini.z.optional(zod_mini.z.array(zod_mini.z.string())),
+	timestamp: require_common.dateTimeSchema
+});
+/** Saved AI discussion (doc assistant or dashboard chat). */
+const discussionSchema = zod_mini.z.looseObject({
+	id: zod_mini.z.string(),
+	/** Generated by the client before the discussion is saved. */
+	discussionId: zod_mini.z.string(),
+	messages: zod_mini.z.optional(zod_mini.z.array(discussionMessageSchema)),
+	numberOfMessages: zod_mini.z.number(),
+	userId: zod_mini.z.optional(zod_mini.z.string()),
+	projectId: zod_mini.z.optional(zod_mini.z.string()),
+	organizationId: zod_mini.z.optional(zod_mini.z.string()),
+	title: zod_mini.z.optional(zod_mini.z.string()),
+	type: zod_mini.z.optional(zod_mini.z.enum(["doc", "dashboard"])),
+	isArchived: zod_mini.z.boolean(),
+	aiModel: zod_mini.z.optional(zod_mini.z.string()),
+	tokenUsage: zod_mini.z.optional(tokenUsageSchema),
+	createdAt: require_common.dateTimeSchema,
+	updatedAt: require_common.dateTimeSchema
+});
+/** Token usage of the project's dashboard discussions, per model. */
+const aiStatsSchema = zod_mini.z.object({
+	projectId: zod_mini.z.string(),
+	generatedAt: zod_mini.z.number(),
+	totalDiscussions: zod_mini.z.number(),
+	totalInputTokens: zod_mini.z.number(),
+	totalOutputTokens: zod_mini.z.number(),
+	totalTokens: zod_mini.z.number(),
+	modelUsage: zod_mini.z.array(zod_mini.z.object({
+		aiModel: zod_mini.z.string(),
+		discussionCount: zod_mini.z.number(),
+		totalInputTokens: zod_mini.z.number(),
+		totalOutputTokens: zod_mini.z.number(),
+		totalTokens: zod_mini.z.number()
+	}))
+});
+const aiOptionsShape = { aiOptions: zod_mini.z.optional(aiOptionsSchema) };
+const tagsKeysShape = { tagsKeys: zod_mini.z.optional(zod_mini.z.array(zod_mini.z.string())) };
+const conversationSchema = zod_mini.z.object({
+	messages: zod_mini.z.array(chatCompletionRequestMessageSchema),
+	discussionId: zod_mini.z.string()
+});
+/** REST contract of the `/api/ai` routes. */
+const aiContract = require_defineRoute.defineRouteGroup({
+	prefix: "/api/ai",
+	tag: "AI",
+	routes: {
+		customQuery: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/",
+			summary: "Run a custom prompt",
+			schemas: {
+				body: zod_mini.z.looseObject({
+					...aiOptionsShape,
+					...tagsKeysShape,
+					/** AI SDK model messages. */
+					messages: require_common.typedValueSchema(Array.isArray),
+					system: zod_mini.z.optional(zod_mini.z.unknown()),
+					applicationContext: zod_mini.z.optional(zod_mini.z.string())
+				}),
+				response: { 200: require_responseData.responseDataSchema(fileContentResultSchema) }
+			}
+		}),
+		translateJSON: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/translate/json",
+			summary: "Translate a JSON document into a locale",
+			schemas: {
+				body: zod_mini.z.object({
+					...aiOptionsShape,
+					...tagsKeysShape,
+					entryFileContent: jsonContentSchema,
+					presetOutputContent: jsonContentSchema,
+					dictionaryDescription: zod_mini.z.optional(zod_mini.z.string()),
+					entryLocale: localeSchema,
+					outputLocale: localeSchema,
+					mode: zod_mini.z.enum(["complete", "review"]),
+					applicationContext: zod_mini.z.optional(zod_mini.z.string())
+				}),
+				response: { 200: require_responseData.responseDataSchema(zod_mini.z.object({
+					fileContent: jsonContentSchema,
+					...tokenUsedShape
+				})) }
+			}
+		}),
+		auditContentDeclaration: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/audit/dictionary",
+			summary: "Audit and complete a content declaration file",
+			schemas: {
+				body: zod_mini.z.object({
+					...aiOptionsShape,
+					...tagsKeysShape,
+					locales: zod_mini.z.array(localeSchema),
+					defaultLocale: localeSchema,
+					fileContent: zod_mini.z.string(),
+					filePath: zod_mini.z.optional(zod_mini.z.string())
+				}),
+				response: { 200: require_responseData.responseDataSchema(metadataResultSchema) }
+			}
+		}),
+		auditContentDeclarationField: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/audit/dictionary/field",
+			summary: "Audit a single field of a content declaration",
+			schemas: {
+				body: zod_mini.z.object({
+					...aiOptionsShape,
+					...tagsKeysShape,
+					locales: zod_mini.z.array(localeSchema),
+					fileContent: zod_mini.z.string(),
+					filePath: zod_mini.z.optional(zod_mini.z.string()),
+					keyPath: zod_mini.z.array(require_common.typedValueSchema())
+				}),
+				response: { 200: require_responseData.responseDataSchema(fileContentResultSchema) }
+			}
+		}),
+		auditContentDeclarationMetadata: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/audit/dictionary/metadata",
+			summary: "Suggest title, description and tags of a dictionary",
+			schemas: {
+				body: zod_mini.z.object({
+					...aiOptionsShape,
+					fileContent: zod_mini.z.string()
+				}),
+				response: { 200: require_responseData.responseDataSchema(metadataResultSchema) }
+			}
+		}),
+		auditTag: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/audit/tag",
+			summary: "Improve the instructions of a tag",
+			schemas: {
+				body: zod_mini.z.object({
+					...aiOptionsShape,
+					tag: require_tag.tagSchema
+				}),
+				response: { 200: require_responseData.responseDataSchema(tagAuditResultSchema) }
+			}
+		}),
+		ask: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/ask",
+			summary: "Ask the documentation assistant (server-sent events stream)",
+			schemas: { body: conversationSchema }
+		}),
+		chat: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/chat",
+			summary: "Chat with the dashboard assistant (server-sent events stream)",
+			schemas: { body: conversationSchema }
+		}),
+		autocomplete: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/autocomplete",
+			summary: "Autocomplete a text being written",
+			schemas: {
+				body: zod_mini.z.object({
+					...aiOptionsShape,
+					text: zod_mini.z.string(),
+					contextBefore: zod_mini.z.optional(zod_mini.z.string()),
+					currentLine: zod_mini.z.optional(zod_mini.z.string()),
+					contextAfter: zod_mini.z.optional(zod_mini.z.string())
+				}),
+				response: { 200: require_responseData.responseDataSchema(zod_mini.z.object({ autocompletion: zod_mini.z.string() })) }
+			}
+		}),
+		getDiscussions: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/discussions",
+			summary: "List AI discussions (own ones, all for admins)",
+			schemas: {
+				querystring: zod_mini.z.looseObject({
+					...require_common.paginationQueryShape,
+					includeMessages: zod_mini.z.optional(zod_mini.z.enum(["true", "false"])),
+					ids: zod_mini.z.optional(require_common.repeatableQueryValueSchema),
+					userId: zod_mini.z.optional(zod_mini.z.string()),
+					userIds: zod_mini.z.optional(require_common.repeatableQueryValueSchema),
+					discussionId: zod_mini.z.optional(zod_mini.z.string()),
+					search: zod_mini.z.optional(zod_mini.z.string()),
+					isArchived: zod_mini.z.optional(zod_mini.z.enum(["true", "false"])),
+					sortBy: zod_mini.z.optional(zod_mini.z.string()),
+					sortOrder: zod_mini.z.optional(zod_mini.z.string()),
+					fetchAll: zod_mini.z.optional(zod_mini.z.enum(["true", "false"]))
+				}),
+				response: { 200: require_responseData.paginatedResponseSchema(discussionSchema) }
+			}
+		}),
+		getAIStats: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/stats",
+			summary: "AI token usage of the selected project",
+			schemas: { response: { 200: require_responseData.responseDataSchema(aiStatsSchema) } }
+		})
+	}
+});
+
+//#endregion
+exports.aiContract = aiContract;
+exports.aiOptionsSchema = aiOptionsSchema;
+exports.aiStatsSchema = aiStatsSchema;
+exports.chatCompletionRequestMessageSchema = chatCompletionRequestMessageSchema;
+exports.discussionMessageSchema = discussionMessageSchema;
+exports.discussionSchema = discussionSchema;
+//# sourceMappingURL=ai.cjs.map

package/dist/cjs/ai.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.cjs","names":["typedValueSchema","isJSONObject","z","typedStringSchema","dateTimeSchema","defineRouteGroup","defineRoute","responseDataSchema","tagSchema","paginationQueryShape","repeatableQueryValueSchema","paginatedResponseSchema"],"sources":["../../src/ai.ts"],"sourcesContent":["import type { Locale } from '@intlayer/types/allLocales';\nimport type { AiProviders } from '@intlayer/types/config';\nimport type { KeyPath } from '@intlayer/types/keyPath';\nimport { z } from 'zod/mini';\nimport {\n  dateTimeSchema,\n  isJSONObject,\n  paginationQueryShape,\n  repeatableQueryValueSchema,\n  typedStringSchema,\n  typedValueSchema,\n} from './common';\nimport {\n  defineRoute,\n  defineRouteGroup,\n  type RouteBodyInput,\n  type RouteQuerystring,\n} from './defineRoute';\nimport {\n  type PaginatedResponse,\n  paginatedResponseSchema,\n  type ResponseData,\n  responseDataSchema,\n} from './responseData';\nimport { tagSchema } from './tag';\n\n/**\n * AI settings sent by a client. Provider-specific options (from the AI SDKs)\n * pass through untouched, so the value is only checked to be an object;\n * `@intlayer/ai`'s `AIOptions` is asserted assignable in the backend.\n */\nexport type AIOptions = {\n  provider?: `${AiProviders}`;\n  model?: string;\n  temperature?: number;\n  baseURL?: string;\n  /** Own provider key; omitted to use the project or Intlayer key. */\n  apiKey?: string;\n  applicationContext?: string;\n  dataSerialization?: 'json' | 'toon';\n};\n\nexport const aiOptionsSchema = typedValueSchema<AIOptions>(isJSONObject);\n\n/** Chat message exchanged with the assistants. */\nexport const chatCompletionRequestMessageSchema = z.object({\n  role: z.enum(['system', 'user', 'assistant']),\n  content: z.string(),\n  /** ISO date-time, parsed to a `Date`. */\n  timestamp: z.optional(\n    z.pipe(\n      z.string(),\n      z.transform((value) => new Date(value))\n    )\n  ),\n});\n\nconst localeSchema = typedStringSchema<Locale>();\nconst tokenUsedShape = { tokenUsed: z.number() };\n\n/** Text result of an AI step (translation, audit, query). */\nconst fileContentResultSchema = z.object({\n  fileContent: z.string(),\n  ...tokenUsedShape,\n});\n\n/** Tag fields rewritten by the tag audit (parsed from the model's JSON). */\nconst tagAuditResultSchema = z.object({\n  fileContent: z.looseObject({\n    key: z.optional(z.string()),\n    name: z.optional(z.string()),\n    description: z.optional(z.string()),\n    instructions: z.optional(z.string()),\n  }),\n  ...tokenUsedShape,\n});\n\nconst metadataResultSchema = z.object({\n  fileContent: z.object({\n    title: z.string(),\n    description: z.string(),\n    tags: z.array(z.string()),\n  }),\n  ...tokenUsedShape,\n});\n\n/** JSON document translated by the AI. */\nconst jsonContentSchema = typedValueSchema<Record<string, unknown>>();\n\nconst tokenUsageSchema = z.object({\n  inputTokens: z.number(),\n  outputTokens: z.number(),\n  totalTokens: z.number(),\n});\n\n/** Message stored in a discussion. */\nexport const discussionMessageSchema = z.object({\n  role: z.enum(['user', 'assistant', 'system']),\n  content: z.string(),\n  relatedFiles: z.optional(z.array(z.string())),\n  timestamp: dateTimeSchema,\n});\n\n/** Saved AI discussion (doc assistant or dashboard chat). */\nexport const discussionSchema = z.looseObject({\n  id: z.string(),\n  /** Generated by the client before the discussion is saved. */\n  discussionId: z.string(),\n  messages: z.optional(z.array(discussionMessageSchema)),\n  numberOfMessages: z.number(),\n  userId: z.optional(z.string()),\n  projectId: z.optional(z.string()),\n  organizationId: z.optional(z.string()),\n  title: z.optional(z.string()),\n  type: z.optional(z.enum(['doc', 'dashboard'])),\n  isArchived: z.boolean(),\n  aiModel: z.optional(z.string()),\n  tokenUsage: z.optional(tokenUsageSchema),\n  createdAt: dateTimeSchema,\n  updatedAt: dateTimeSchema,\n});\n\n/** Token usage of the project's dashboard discussions, per model. */\nexport const aiStatsSchema = z.object({\n  projectId: z.string(),\n  generatedAt: z.number(),\n  totalDiscussions: z.number(),\n  totalInputTokens: z.number(),\n  totalOutputTokens: z.number(),\n  totalTokens: z.number(),\n  modelUsage: z.array(\n    z.object({\n      aiModel: z.string(),\n      discussionCount: z.number(),\n      totalInputTokens: z.number(),\n      totalOutputTokens: z.number(),\n      totalTokens: z.number(),\n    })\n  ),\n});\n\nconst aiOptionsShape = { aiOptions: z.optional(aiOptionsSchema) };\nconst tagsKeysShape = { tagsKeys: z.optional(z.array(z.string())) };\nconst conversationSchema = z.object({\n  messages: z.array(chatCompletionRequestMessageSchema),\n  discussionId: z.string(),\n});\n\n/** REST contract of the `/api/ai` routes. */\nexport const aiContract = defineRouteGroup({\n  prefix: '/api/ai',\n  tag: 'AI',\n  routes: {\n    customQuery: defineRoute({\n      method: 'POST',\n      path: '/',\n      summary: 'Run a custom prompt',\n      schemas: {\n        body: z.looseObject({\n          ...aiOptionsShape,\n          ...tagsKeysShape,\n          /** AI SDK model messages. */\n          messages: typedValueSchema<unknown[]>(Array.isArray),\n          system: z.optional(z.unknown()),\n          applicationContext: z.optional(z.string()),\n        }),\n        response: { 200: responseDataSchema(fileContentResultSchema) },\n      },\n    }),\n    translateJSON: defineRoute({\n      method: 'POST',\n      path: '/translate/json',\n      summary: 'Translate a JSON document into a locale',\n      schemas: {\n        body: z.object({\n          ...aiOptionsShape,\n          ...tagsKeysShape,\n          entryFileContent: jsonContentSchema,\n          presetOutputContent: jsonContentSchema,\n          dictionaryDescription: z.optional(z.string()),\n          entryLocale: localeSchema,\n          outputLocale: localeSchema,\n          mode: z.enum(['complete', 'review']),\n          applicationContext: z.optional(z.string()),\n        }),\n        response: {\n          200: responseDataSchema(\n            z.object({ fileContent: jsonContentSchema, ...tokenUsedShape })\n          ),\n        },\n      },\n    }),\n    auditContentDeclaration: defineRoute({\n      method: 'POST',\n      path: '/audit/dictionary',\n      summary: 'Audit and complete a content declaration file',\n      schemas: {\n        body: z.object({\n          ...aiOptionsShape,\n          ...tagsKeysShape,\n          locales: z.array(localeSchema),\n          defaultLocale: localeSchema,\n          fileContent: z.string(),\n          filePath: z.optional(z.string()),\n        }),\n        response: { 200: responseDataSchema(metadataResultSchema) },\n      },\n    }),\n    auditContentDeclarationField: defineRoute({\n      method: 'POST',\n      path: '/audit/dictionary/field',\n      summary: 'Audit a single field of a content declaration',\n      schemas: {\n        body: z.object({\n          ...aiOptionsShape,\n          ...tagsKeysShape,\n          locales: z.array(localeSchema),\n          fileContent: z.string(),\n          filePath: z.optional(z.string()),\n          keyPath: z.array(typedValueSchema<KeyPath>()),\n        }),\n        response: { 200: responseDataSchema(fileContentResultSchema) },\n      },\n    }),\n    auditContentDeclarationMetadata: defineRoute({\n      method: 'POST',\n      path: '/audit/dictionary/metadata',\n      summary: 'Suggest title, description and tags of a dictionary',\n      schemas: {\n        body: z.object({ ...aiOptionsShape, fileContent: z.string() }),\n        response: { 200: responseDataSchema(metadataResultSchema) },\n      },\n    }),\n    auditTag: defineRoute({\n      method: 'POST',\n      path: '/audit/tag',\n      summary: 'Improve the instructions of a tag',\n      schemas: {\n        body: z.object({ ...aiOptionsShape, tag: tagSchema }),\n        response: { 200: responseDataSchema(tagAuditResultSchema) },\n      },\n    }),\n    ask: defineRoute({\n      method: 'POST',\n      path: '/ask',\n      summary: 'Ask the documentation assistant (server-sent events stream)',\n      schemas: { body: conversationSchema },\n    }),\n    chat: defineRoute({\n      method: 'POST',\n      path: '/chat',\n      summary: 'Chat with the dashboard assistant (server-sent events stream)',\n      schemas: { body: conversationSchema },\n    }),\n    autocomplete: defineRoute({\n      method: 'POST',\n      path: '/autocomplete',\n      summary: 'Autocomplete a text being written',\n      schemas: {\n        body: z.object({\n          ...aiOptionsShape,\n          text: z.string(),\n          contextBefore: z.optional(z.string()),\n          currentLine: z.optional(z.string()),\n          contextAfter: z.optional(z.string()),\n        }),\n        response: {\n          200: responseDataSchema(z.object({ autocompletion: z.string() })),\n        },\n      },\n    }),\n    getDiscussions: defineRoute({\n      method: 'GET',\n      path: '/discussions',\n      summary: 'List AI discussions (own ones, all for admins)',\n      schemas: {\n        querystring: z.looseObject({\n          ...paginationQueryShape,\n          includeMessages: z.optional(z.enum(['true', 'false'])),\n          ids: z.optional(repeatableQueryValueSchema),\n          userId: z.optional(z.string()),\n          userIds: z.optional(repeatableQueryValueSchema),\n          discussionId: z.optional(z.string()),\n          search: z.optional(z.string()),\n          isArchived: z.optional(z.enum(['true', 'false'])),\n          sortBy: z.optional(z.string()),\n          sortOrder: z.optional(z.string()),\n          fetchAll: z.optional(z.enum(['true', 'false'])),\n        }),\n        response: { 200: paginatedResponseSchema(discussionSchema) },\n      },\n    }),\n    getAIStats: defineRoute({\n      method: 'GET',\n      path: '/stats',\n      summary: 'AI token usage of the selected project',\n      schemas: {\n        response: { 200: responseDataSchema(aiStatsSchema) },\n      },\n    }),\n  },\n});\n\n/** Route definitions of the `/api/ai` group, by name. */\nexport type AIRoutes = (typeof aiContract)['routes'];\n\n/**\n * Chat message as built by clients: `timestamp` may be a `Date` (serialized\n * to an ISO string on the wire) or already a string.\n */\nexport type ChatCompletionRequestMessage = Omit<\n  z.output<typeof chatCompletionRequestMessageSchema>,\n  'timestamp'\n> & { timestamp?: Date | string };\nexport type DiscussionAPI = z.output<typeof discussionSchema>;\nexport type AIStats = z.output<typeof aiStatsSchema>;\n\nexport type CustomQueryBody = RouteBodyInput<AIRoutes['customQuery']>;\nexport type CustomQueryResult = ResponseData<\n  z.output<typeof fileContentResultSchema>\n>;\nexport type TranslateJSONBody = RouteBodyInput<AIRoutes['translateJSON']>;\nexport type TranslateJSONResult = ResponseData<{\n  fileContent: Record<string, unknown>;\n  tokenUsed: number;\n}>;\nexport type AuditContentDeclarationBody = RouteBodyInput<\n  AIRoutes['auditContentDeclaration']\n>;\nexport type AuditContentDeclarationResult = ResponseData<\n  z.output<typeof metadataResultSchema>\n>;\nexport type AuditContentDeclarationFieldBody = RouteBodyInput<\n  AIRoutes['auditContentDeclarationField']\n>;\nexport type AuditContentDeclarationFieldResult = ResponseData<\n  z.output<typeof fileContentResultSchema>\n>;\nexport type AuditContentDeclarationMetadataBody = RouteBodyInput<\n  AIRoutes['auditContentDeclarationMetadata']\n>;\nexport type AuditContentDeclarationMetadataResult = ResponseData<\n  z.output<typeof metadataResultSchema>\n>;\nexport type AuditTagBody = RouteBodyInput<AIRoutes['auditTag']>;\nexport type AuditTagResultData = z.output<typeof tagAuditResultSchema>;\nexport type AuditTagResult = ResponseData<AuditTagResultData>;\nexport type AskDocQuestionBody = RouteBodyInput<AIRoutes['ask']>;\n/** Final payload of the documentation assistant stream. */\nexport type AskDocQuestionResult = ResponseData<{\n  response: string;\n  relatedFiles: string[];\n}>;\nexport type ChatBody = RouteBodyInput<AIRoutes['chat']>;\n/** Final payload of the dashboard assistant stream. */\nexport type ChatResult = ResponseData<{\n  response: string;\n  tokenUsage?: z.output<typeof tokenUsageSchema>;\n  aiModel?: string;\n}>;\nexport type AutocompleteBody = RouteBodyInput<AIRoutes['autocomplete']>;\nexport type AutocompleteResponse = ResponseData<{ autocompletion: string }>;\nexport type GetDiscussionsParams = RouteQuerystring<AIRoutes['getDiscussions']>;\nexport type GetDiscussionsResult = PaginatedResponse<DiscussionAPI>;\nexport type GetAIStatsResult = ResponseData<AIStats>;\n"],"mappings":";;;;;;;;AA0CA,MAAa,kBAAkBA,gCAA4BC,2BAAY;;AAGvE,MAAa,qCAAqCC,WAAE,OAAO;CACzD,MAAMA,WAAE,KAAK;EAAC;EAAU;EAAQ;CAAW,CAAC;CAC5C,SAASA,WAAE,OAAO;;CAElB,WAAWA,WAAE,SACXA,WAAE,KACAA,WAAE,OAAO,GACTA,WAAE,WAAW,UAAU,IAAI,KAAK,KAAK,CAAC,CACxC,CACF;AACF,CAAC;AAED,MAAM,eAAeC,iCAA0B;AAC/C,MAAM,iBAAiB,EAAE,WAAWD,WAAE,OAAO,EAAE;;AAG/C,MAAM,0BAA0BA,WAAE,OAAO;CACvC,aAAaA,WAAE,OAAO;CACtB,GAAG;AACL,CAAC;;AAGD,MAAM,uBAAuBA,WAAE,OAAO;CACpC,aAAaA,WAAE,YAAY;EACzB,KAAKA,WAAE,SAASA,WAAE,OAAO,CAAC;EAC1B,MAAMA,WAAE,SAASA,WAAE,OAAO,CAAC;EAC3B,aAAaA,WAAE,SAASA,WAAE,OAAO,CAAC;EAClC,cAAcA,WAAE,SAASA,WAAE,OAAO,CAAC;CACrC,CAAC;CACD,GAAG;AACL,CAAC;AAED,MAAM,uBAAuBA,WAAE,OAAO;CACpC,aAAaA,WAAE,OAAO;EACpB,OAAOA,WAAE,OAAO;EAChB,aAAaA,WAAE,OAAO;EACtB,MAAMA,WAAE,MAAMA,WAAE,OAAO,CAAC;CAC1B,CAAC;CACD,GAAG;AACL,CAAC;;AAGD,MAAM,oBAAoBF,gCAA0C;AAEpE,MAAM,mBAAmBE,WAAE,OAAO;CAChC,aAAaA,WAAE,OAAO;CACtB,cAAcA,WAAE,OAAO;CACvB,aAAaA,WAAE,OAAO;AACxB,CAAC;;AAGD,MAAa,0BAA0BA,WAAE,OAAO;CAC9C,MAAMA,WAAE,KAAK;EAAC;EAAQ;EAAa;CAAQ,CAAC;CAC5C,SAASA,WAAE,OAAO;CAClB,cAAcA,WAAE,SAASA,WAAE,MAAMA,WAAE,OAAO,CAAC,CAAC;CAC5C,WAAWE;AACb,CAAC;;AAGD,MAAa,mBAAmBF,WAAE,YAAY;CAC5C,IAAIA,WAAE,OAAO;;CAEb,cAAcA,WAAE,OAAO;CACvB,UAAUA,WAAE,SAASA,WAAE,MAAM,uBAAuB,CAAC;CACrD,kBAAkBA,WAAE,OAAO;CAC3B,QAAQA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC7B,WAAWA,WAAE,SAASA,WAAE,OAAO,CAAC;CAChC,gBAAgBA,WAAE,SAASA,WAAE,OAAO,CAAC;CACrC,OAAOA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC5B,MAAMA,WAAE,SAASA,WAAE,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;CAC7C,YAAYA,WAAE,QAAQ;CACtB,SAASA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC9B,YAAYA,WAAE,SAAS,gBAAgB;CACvC,WAAWE;CACX,WAAWA;AACb,CAAC;;AAGD,MAAa,gBAAgBF,WAAE,OAAO;CACpC,WAAWA,WAAE,OAAO;CACpB,aAAaA,WAAE,OAAO;CACtB,kBAAkBA,WAAE,OAAO;CAC3B,kBAAkBA,WAAE,OAAO;CAC3B,mBAAmBA,WAAE,OAAO;CAC5B,aAAaA,WAAE,OAAO;CACtB,YAAYA,WAAE,MACZA,WAAE,OAAO;EACP,SAASA,WAAE,OAAO;EAClB,iBAAiBA,WAAE,OAAO;EAC1B,kBAAkBA,WAAE,OAAO;EAC3B,mBAAmBA,WAAE,OAAO;EAC5B,aAAaA,WAAE,OAAO;CACxB,CAAC,CACH;AACF,CAAC;AAED,MAAM,iBAAiB,EAAE,WAAWA,WAAE,SAAS,eAAe,EAAE;AAChE,MAAM,gBAAgB,EAAE,UAAUA,WAAE,SAASA,WAAE,MAAMA,WAAE,OAAO,CAAC,CAAC,EAAE;AAClE,MAAM,qBAAqBA,WAAE,OAAO;CAClC,UAAUA,WAAE,MAAM,kCAAkC;CACpD,cAAcA,WAAE,OAAO;AACzB,CAAC;;AAGD,MAAa,aAAaG,qCAAiB;CACzC,QAAQ;CACR,KAAK;CACL,QAAQ;EACN,aAAaC,gCAAY;GACvB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAMJ,WAAE,YAAY;KAClB,GAAG;KACH,GAAG;;KAEH,UAAUF,gCAA4B,MAAM,OAAO;KACnD,QAAQE,WAAE,SAASA,WAAE,QAAQ,CAAC;KAC9B,oBAAoBA,WAAE,SAASA,WAAE,OAAO,CAAC;IAC3C,CAAC;IACD,UAAU,EAAE,KAAKK,wCAAmB,uBAAuB,EAAE;GAC/D;EACF,CAAC;EACD,eAAeD,gCAAY;GACzB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAMJ,WAAE,OAAO;KACb,GAAG;KACH,GAAG;KACH,kBAAkB;KAClB,qBAAqB;KACrB,uBAAuBA,WAAE,SAASA,WAAE,OAAO,CAAC;KAC5C,aAAa;KACb,cAAc;KACd,MAAMA,WAAE,KAAK,CAAC,YAAY,QAAQ,CAAC;KACnC,oBAAoBA,WAAE,SAASA,WAAE,OAAO,CAAC;IAC3C,CAAC;IACD,UAAU,EACR,KAAKK,wCACHL,WAAE,OAAO;KAAE,aAAa;KAAmB,GAAG;IAAe,CAAC,CAChE,EACF;GACF;EACF,CAAC;EACD,yBAAyBI,gCAAY;GACnC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAMJ,WAAE,OAAO;KACb,GAAG;KACH,GAAG;KACH,SAASA,WAAE,MAAM,YAAY;KAC7B,eAAe;KACf,aAAaA,WAAE,OAAO;KACtB,UAAUA,WAAE,SAASA,WAAE,OAAO,CAAC;IACjC,CAAC;IACD,UAAU,EAAE,KAAKK,wCAAmB,oBAAoB,EAAE;GAC5D;EACF,CAAC;EACD,8BAA8BD,gCAAY;GACxC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAMJ,WAAE,OAAO;KACb,GAAG;KACH,GAAG;KACH,SAASA,WAAE,MAAM,YAAY;KAC7B,aAAaA,WAAE,OAAO;KACtB,UAAUA,WAAE,SAASA,WAAE,OAAO,CAAC;KAC/B,SAASA,WAAE,MAAMF,gCAA0B,CAAC;IAC9C,CAAC;IACD,UAAU,EAAE,KAAKO,wCAAmB,uBAAuB,EAAE;GAC/D;EACF,CAAC;EACD,iCAAiCD,gCAAY;GAC3C,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAMJ,WAAE,OAAO;KAAE,GAAG;KAAgB,aAAaA,WAAE,OAAO;IAAE,CAAC;IAC7D,UAAU,EAAE,KAAKK,wCAAmB,oBAAoB,EAAE;GAC5D;EACF,CAAC;EACD,UAAUD,gCAAY;GACpB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAMJ,WAAE,OAAO;KAAE,GAAG;KAAgB,KAAKM;IAAU,CAAC;IACpD,UAAU,EAAE,KAAKD,wCAAmB,oBAAoB,EAAE;GAC5D;EACF,CAAC;EACD,KAAKD,gCAAY;GACf,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EAAE,MAAM,mBAAmB;EACtC,CAAC;EACD,MAAMA,gCAAY;GAChB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EAAE,MAAM,mBAAmB;EACtC,CAAC;EACD,cAAcA,gCAAY;GACxB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,MAAMJ,WAAE,OAAO;KACb,GAAG;KACH,MAAMA,WAAE,OAAO;KACf,eAAeA,WAAE,SAASA,WAAE,OAAO,CAAC;KACpC,aAAaA,WAAE,SAASA,WAAE,OAAO,CAAC;KAClC,cAAcA,WAAE,SAASA,WAAE,OAAO,CAAC;IACrC,CAAC;IACD,UAAU,EACR,KAAKK,wCAAmBL,WAAE,OAAO,EAAE,gBAAgBA,WAAE,OAAO,EAAE,CAAC,CAAC,EAClE;GACF;EACF,CAAC;EACD,gBAAgBI,gCAAY;GAC1B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAaJ,WAAE,YAAY;KACzB,GAAGO;KACH,iBAAiBP,WAAE,SAASA,WAAE,KAAK,CAAC,QAAQ,OAAO,CAAC,CAAC;KACrD,KAAKA,WAAE,SAASQ,yCAA0B;KAC1C,QAAQR,WAAE,SAASA,WAAE,OAAO,CAAC;KAC7B,SAASA,WAAE,SAASQ,yCAA0B;KAC9C,cAAcR,WAAE,SAASA,WAAE,OAAO,CAAC;KACnC,QAAQA,WAAE,SAASA,WAAE,OAAO,CAAC;KAC7B,YAAYA,WAAE,SAASA,WAAE,KAAK,CAAC,QAAQ,OAAO,CAAC,CAAC;KAChD,QAAQA,WAAE,SAASA,WAAE,OAAO,CAAC;KAC7B,WAAWA,WAAE,SAASA,WAAE,OAAO,CAAC;KAChC,UAAUA,WAAE,SAASA,WAAE,KAAK,CAAC,QAAQ,OAAO,CAAC,CAAC;IAChD,CAAC;IACD,UAAU,EAAE,KAAKS,6CAAwB,gBAAgB,EAAE;GAC7D;EACF,CAAC;EACD,YAAYL,gCAAY;GACtB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EAAE,KAAKC,wCAAmB,aAAa,EAAE,EACrD;EACF,CAAC;CACH;AACF,CAAC"}

package/dist/cjs/analytics.cjs

@@ -0,0 +1,175 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_defineRoute = require('./defineRoute.cjs');
+const require_responseData = require('./responseData.cjs');
+let zod_mini = require("zod/mini");
+
+//#region src/analytics.ts
+/** Kind of analytics event sent by the SDK. */
+const analyticsEventTypeSchema = zod_mini.z.enum([
+	"page_view",
+	"content_exposure",
+	"conversion"
+]);
+/** One event as sent by the SDK (batched). */
+const incomingAnalyticsEventSchema = zod_mini.z.looseObject({
+	type: analyticsEventTypeSchema,
+	/** Client timestamp (epoch ms). */
+	t: zod_mini.z.number(),
+	locale: zod_mini.z.string(),
+	url: zod_mini.z.string(),
+	ref: zod_mini.z.optional(zod_mini.z.string()),
+	dictionaryKey: zod_mini.z.optional(zod_mini.z.string()),
+	keyPath: zod_mini.z.optional(zod_mini.z.string()),
+	nodeType: zod_mini.z.optional(zod_mini.z.string()),
+	variant: zod_mini.z.optional(zod_mini.z.string()),
+	count: zod_mini.z.optional(zod_mini.z.number()),
+	experimentKey: zod_mini.z.optional(zod_mini.z.string()),
+	goal: zod_mini.z.optional(zod_mini.z.string()),
+	value: zod_mini.z.optional(zod_mini.z.number())
+});
+/** Time windows of the audience report. */
+const audienceRangeSchema = zod_mini.z.enum([
+	"1h",
+	"24h",
+	"7d",
+	"30d",
+	"90d",
+	"6mo",
+	"1y",
+	"3y"
+]);
+const audienceGranularitySchema = zod_mini.z.enum([
+	"minute",
+	"hour",
+	"day",
+	"week",
+	"month"
+]);
+const audienceSeriesPointSchema = zod_mini.z.object({
+	/** ISO bucket start. */
+	bucket: zod_mini.z.string(),
+	users: zod_mini.z.number(),
+	views: zod_mini.z.number()
+});
+const audienceBreakdownRowSchema = zod_mini.z.object({
+	key: zod_mini.z.string(),
+	users: zod_mini.z.number(),
+	views: zod_mini.z.number()
+});
+const audienceStatsSchema = zod_mini.z.object({
+	usersToday: zod_mini.z.number(),
+	usersLast7Days: zod_mini.z.number(),
+	usersInRange: zod_mini.z.number(),
+	viewsInRange: zod_mini.z.number(),
+	range: audienceRangeSchema,
+	rangeHours: zod_mini.z.number(),
+	granularity: audienceGranularitySchema,
+	series: zod_mini.z.array(audienceSeriesPointSchema),
+	byLocale: zod_mini.z.array(audienceBreakdownRowSchema),
+	byCountry: zod_mini.z.array(audienceBreakdownRowSchema),
+	byPage: zod_mini.z.array(audienceBreakdownRowSchema)
+});
+const analyticsOverviewRowSchema = zod_mini.z.object({
+	url: zod_mini.z.string(),
+	locale: zod_mini.z.string(),
+	views: zod_mini.z.number()
+});
+const contentStatRowSchema = zod_mini.z.object({
+	dictionaryKey: zod_mini.z.string(),
+	keyPath: zod_mini.z.string(),
+	locale: zod_mini.z.string(),
+	exposures: zod_mini.z.number()
+});
+const experimentResultSchema = zod_mini.z.object({
+	experimentKey: zod_mini.z.string(),
+	variants: zod_mini.z.array(zod_mini.z.object({
+		variant: zod_mini.z.string(),
+		exposures: zod_mini.z.number(),
+		conversions: zod_mini.z.number(),
+		conversionRate: zod_mini.z.number()
+	})),
+	pValue: zod_mini.z.nullable(zod_mini.z.number()),
+	winner: zod_mini.z.nullable(zod_mini.z.string())
+});
+const pageMetadataSchema = zod_mini.z.object({
+	title: zod_mini.z.optional(zod_mini.z.string()),
+	description: zod_mini.z.optional(zod_mini.z.string())
+});
+/** REST contract of the `/api/analytics` routes. */
+const analyticsContract = require_defineRoute.defineRouteGroup({
+	prefix: "/api/analytics",
+	tag: "Analytics",
+	routes: {
+		ingestAnalyticsEvents: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/events",
+			summary: "Ingest SDK events (public browser token, rate limited)",
+			schemas: {
+				/** Sent as `text/plain` JSON by `navigator.sendBeacon`. */
+				body: zod_mini.z.looseObject({
+					/** Token from `POST /api/public/token` (`analytics:ingest`). */
+					token: zod_mini.z.optional(zod_mini.z.string()),
+					/** @deprecated Superseded by `token`; still accepted. */
+					clientId: zod_mini.z.optional(zod_mini.z.string()),
+					sessionId: zod_mini.z.string(),
+					sdkVersion: zod_mini.z.string(),
+					events: zod_mini.z.array(incomingAnalyticsEventSchema)
+				}),
+				response: { 200: require_responseData.responseDataSchema(zod_mini.z.object({ accepted: zod_mini.z.number() })) }
+			}
+		}),
+		getAnalyticsOverview: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/overview",
+			summary: "Page views per page and locale",
+			schemas: { response: { 200: require_responseData.responseDataSchema(zod_mini.z.array(analyticsOverviewRowSchema)) } }
+		}),
+		getAnalyticsAudience: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/audience",
+			summary: "Audience report over a time window",
+			schemas: {
+				querystring: zod_mini.z.object({
+					range: zod_mini.z.optional(zod_mini.z.string()),
+					/** Legacy: converted to the closest range. */
+					days: zod_mini.z.optional(zod_mini.z.string())
+				}),
+				response: { 200: require_responseData.responseDataSchema(audienceStatsSchema) }
+			}
+		}),
+		getContentStats: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/content-stats",
+			summary: "Content exposures per dictionary key path and locale",
+			schemas: { response: { 200: require_responseData.responseDataSchema(zod_mini.z.array(contentStatRowSchema)) } }
+		}),
+		getExperimentResults: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/experiments/:experimentKey",
+			summary: "A/B test results of an experiment",
+			schemas: {
+				params: zod_mini.z.object({ experimentKey: zod_mini.z.string().check(zod_mini.z.minLength(1)) }),
+				response: { 200: require_responseData.responseDataSchema(experimentResultSchema) }
+			}
+		}),
+		getPageMetadata: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/page-metadata",
+			summary: "Title and description of a page of the project",
+			schemas: {
+				querystring: zod_mini.z.object({ url: zod_mini.z.optional(zod_mini.z.string()) }),
+				response: { 200: require_responseData.responseDataSchema(pageMetadataSchema) }
+			}
+		})
+	}
+});
+
+//#endregion
+exports.analyticsContract = analyticsContract;
+exports.analyticsEventTypeSchema = analyticsEventTypeSchema;
+exports.audienceGranularitySchema = audienceGranularitySchema;
+exports.audienceRangeSchema = audienceRangeSchema;
+exports.audienceSeriesPointSchema = audienceSeriesPointSchema;
+exports.audienceStatsSchema = audienceStatsSchema;
+exports.incomingAnalyticsEventSchema = incomingAnalyticsEventSchema;
+//# sourceMappingURL=analytics.cjs.map

package/dist/cjs/analytics.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.cjs","names":["z","defineRouteGroup","defineRoute","responseDataSchema"],"sources":["../../src/analytics.ts"],"sourcesContent":["import { z } from 'zod/mini';\nimport {\n  defineRoute,\n  defineRouteGroup,\n  type RouteBodyInput,\n} from './defineRoute';\nimport { type ResponseData, responseDataSchema } from './responseData';\n\n/** Kind of analytics event sent by the SDK. */\nexport const analyticsEventTypeSchema = z.enum([\n  'page_view',\n  'content_exposure',\n  'conversion',\n]);\n\n/** One event as sent by the SDK (batched). */\nexport const incomingAnalyticsEventSchema = z.looseObject({\n  type: analyticsEventTypeSchema,\n  /** Client timestamp (epoch ms). */\n  t: z.number(),\n  locale: z.string(),\n  url: z.string(),\n  ref: z.optional(z.string()),\n  dictionaryKey: z.optional(z.string()),\n  keyPath: z.optional(z.string()),\n  nodeType: z.optional(z.string()),\n  variant: z.optional(z.string()),\n  count: z.optional(z.number()),\n  experimentKey: z.optional(z.string()),\n  goal: z.optional(z.string()),\n  value: z.optional(z.number()),\n});\n\n/** Time windows of the audience report. */\nexport const audienceRangeSchema = z.enum([\n  '1h',\n  '24h',\n  '7d',\n  '30d',\n  '90d',\n  '6mo',\n  '1y',\n  '3y',\n]);\n\nexport const audienceGranularitySchema = z.enum([\n  'minute',\n  'hour',\n  'day',\n  'week',\n  'month',\n]);\n\nexport const audienceSeriesPointSchema = z.object({\n  /** ISO bucket start. */\n  bucket: z.string(),\n  users: z.number(),\n  views: z.number(),\n});\n\nconst audienceBreakdownRowSchema = z.object({\n  key: z.string(),\n  users: z.number(),\n  views: z.number(),\n});\n\nexport const audienceStatsSchema = z.object({\n  usersToday: z.number(),\n  usersLast7Days: z.number(),\n  usersInRange: z.number(),\n  viewsInRange: z.number(),\n  range: audienceRangeSchema,\n  rangeHours: z.number(),\n  granularity: audienceGranularitySchema,\n  series: z.array(audienceSeriesPointSchema),\n  byLocale: z.array(audienceBreakdownRowSchema),\n  byCountry: z.array(audienceBreakdownRowSchema),\n  byPage: z.array(audienceBreakdownRowSchema),\n});\n\nconst analyticsOverviewRowSchema = z.object({\n  url: z.string(),\n  locale: z.string(),\n  views: z.number(),\n});\n\nconst contentStatRowSchema = z.object({\n  dictionaryKey: z.string(),\n  keyPath: z.string(),\n  locale: z.string(),\n  exposures: z.number(),\n});\n\nconst experimentResultSchema = z.object({\n  experimentKey: z.string(),\n  variants: z.array(\n    z.object({\n      variant: z.string(),\n      exposures: z.number(),\n      conversions: z.number(),\n      conversionRate: z.number(),\n    })\n  ),\n  pValue: z.nullable(z.number()),\n  winner: z.nullable(z.string()),\n});\n\nconst pageMetadataSchema = z.object({\n  title: z.optional(z.string()),\n  description: z.optional(z.string()),\n});\n\n/** REST contract of the `/api/analytics` routes. */\nexport const analyticsContract = defineRouteGroup({\n  prefix: '/api/analytics',\n  tag: 'Analytics',\n  routes: {\n    ingestAnalyticsEvents: defineRoute({\n      method: 'POST',\n      path: '/events',\n      summary: 'Ingest SDK events (public browser token, rate limited)',\n      schemas: {\n        /** Sent as `text/plain` JSON by `navigator.sendBeacon`. */\n        body: z.looseObject({\n          /** Token from `POST /api/public/token` (`analytics:ingest`). */\n          token: z.optional(z.string()),\n          /** @deprecated Superseded by `token`; still accepted. */\n          clientId: z.optional(z.string()),\n          sessionId: z.string(),\n          sdkVersion: z.string(),\n          events: z.array(incomingAnalyticsEventSchema),\n        }),\n        response: {\n          200: responseDataSchema(z.object({ accepted: z.number() })),\n        },\n      },\n    }),\n    getAnalyticsOverview: defineRoute({\n      method: 'GET',\n      path: '/overview',\n      summary: 'Page views per page and locale',\n      schemas: {\n        response: {\n          200: responseDataSchema(z.array(analyticsOverviewRowSchema)),\n        },\n      },\n    }),\n    getAnalyticsAudience: defineRoute({\n      method: 'GET',\n      path: '/audience',\n      summary: 'Audience report over a time window',\n      schemas: {\n        querystring: z.object({\n          range: z.optional(z.string()),\n          /** Legacy: converted to the closest range. */\n          days: z.optional(z.string()),\n        }),\n        response: { 200: responseDataSchema(audienceStatsSchema) },\n      },\n    }),\n    getContentStats: defineRoute({\n      method: 'GET',\n      path: '/content-stats',\n      summary: 'Content exposures per dictionary key path and locale',\n      schemas: {\n        response: { 200: responseDataSchema(z.array(contentStatRowSchema)) },\n      },\n    }),\n    getExperimentResults: defineRoute({\n      method: 'GET',\n      path: '/experiments/:experimentKey',\n      summary: 'A/B test results of an experiment',\n      schemas: {\n        params: z.object({ experimentKey: z.string().check(z.minLength(1)) }),\n        response: { 200: responseDataSchema(experimentResultSchema) },\n      },\n    }),\n    getPageMetadata: defineRoute({\n      method: 'GET',\n      path: '/page-metadata',\n      summary: 'Title and description of a page of the project',\n      schemas: {\n        querystring: z.object({ url: z.optional(z.string()) }),\n        response: { 200: responseDataSchema(pageMetadataSchema) },\n      },\n    }),\n  },\n});\n\n/** Route definitions of the `/api/analytics` group, by name. */\nexport type AnalyticsRoutes = (typeof analyticsContract)['routes'];\n\nexport type AnalyticsEventType = z.output<typeof analyticsEventTypeSchema>;\nexport type IncomingAnalyticsEvent = z.output<\n  typeof incomingAnalyticsEventSchema\n>;\nexport type AudienceRange = z.output<typeof audienceRangeSchema>;\nexport type AudienceGranularity = z.output<typeof audienceGranularitySchema>;\nexport type AudienceSeriesPoint = z.output<typeof audienceSeriesPointSchema>;\nexport type AudienceBreakdownRow = z.output<typeof audienceBreakdownRowSchema>;\nexport type AudienceStats = z.output<typeof audienceStatsSchema>;\nexport type AnalyticsOverviewRow = z.output<typeof analyticsOverviewRowSchema>;\nexport type ContentStatRow = z.output<typeof contentStatRowSchema>;\nexport type ExperimentResult = z.output<typeof experimentResultSchema>;\nexport type PageMetadata = z.output<typeof pageMetadataSchema>;\n\nexport type IngestAnalyticsBody = RouteBodyInput<\n  AnalyticsRoutes['ingestAnalyticsEvents']\n>;\nexport type IngestAnalyticsResult = ResponseData<{ accepted: number }>;\nexport type GetAnalyticsOverviewResult = ResponseData<AnalyticsOverviewRow[]>;\nexport type GetContentStatsResult = ResponseData<ContentStatRow[]>;\nexport type GetExperimentResultsResult = ResponseData<ExperimentResult>;\nexport type GetAudienceResult = ResponseData<AudienceStats>;\nexport type GetPageMetadataResult = ResponseData<PageMetadata>;\n"],"mappings":";;;;;;;AASA,MAAa,2BAA2BA,WAAE,KAAK;CAC7C;CACA;CACA;AACF,CAAC;;AAGD,MAAa,+BAA+BA,WAAE,YAAY;CACxD,MAAM;;CAEN,GAAGA,WAAE,OAAO;CACZ,QAAQA,WAAE,OAAO;CACjB,KAAKA,WAAE,OAAO;CACd,KAAKA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC1B,eAAeA,WAAE,SAASA,WAAE,OAAO,CAAC;CACpC,SAASA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC9B,UAAUA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC/B,SAASA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC9B,OAAOA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC5B,eAAeA,WAAE,SAASA,WAAE,OAAO,CAAC;CACpC,MAAMA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC3B,OAAOA,WAAE,SAASA,WAAE,OAAO,CAAC;AAC9B,CAAC;;AAGD,MAAa,sBAAsBA,WAAE,KAAK;CACxC;CACA;CACA;CACA;CACA;CACA;CACA;CACA;AACF,CAAC;AAED,MAAa,4BAA4BA,WAAE,KAAK;CAC9C;CACA;CACA;CACA;CACA;AACF,CAAC;AAED,MAAa,4BAA4BA,WAAE,OAAO;;CAEhD,QAAQA,WAAE,OAAO;CACjB,OAAOA,WAAE,OAAO;CAChB,OAAOA,WAAE,OAAO;AAClB,CAAC;AAED,MAAM,6BAA6BA,WAAE,OAAO;CAC1C,KAAKA,WAAE,OAAO;CACd,OAAOA,WAAE,OAAO;CAChB,OAAOA,WAAE,OAAO;AAClB,CAAC;AAED,MAAa,sBAAsBA,WAAE,OAAO;CAC1C,YAAYA,WAAE,OAAO;CACrB,gBAAgBA,WAAE,OAAO;CACzB,cAAcA,WAAE,OAAO;CACvB,cAAcA,WAAE,OAAO;CACvB,OAAO;CACP,YAAYA,WAAE,OAAO;CACrB,aAAa;CACb,QAAQA,WAAE,MAAM,yBAAyB;CACzC,UAAUA,WAAE,MAAM,0BAA0B;CAC5C,WAAWA,WAAE,MAAM,0BAA0B;CAC7C,QAAQA,WAAE,MAAM,0BAA0B;AAC5C,CAAC;AAED,MAAM,6BAA6BA,WAAE,OAAO;CAC1C,KAAKA,WAAE,OAAO;CACd,QAAQA,WAAE,OAAO;CACjB,OAAOA,WAAE,OAAO;AAClB,CAAC;AAED,MAAM,uBAAuBA,WAAE,OAAO;CACpC,eAAeA,WAAE,OAAO;CACxB,SAASA,WAAE,OAAO;CAClB,QAAQA,WAAE,OAAO;CACjB,WAAWA,WAAE,OAAO;AACtB,CAAC;AAED,MAAM,yBAAyBA,WAAE,OAAO;CACtC,eAAeA,WAAE,OAAO;CACxB,UAAUA,WAAE,MACVA,WAAE,OAAO;EACP,SAASA,WAAE,OAAO;EAClB,WAAWA,WAAE,OAAO;EACpB,aAAaA,WAAE,OAAO;EACtB,gBAAgBA,WAAE,OAAO;CAC3B,CAAC,CACH;CACA,QAAQA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC7B,QAAQA,WAAE,SAASA,WAAE,OAAO,CAAC;AAC/B,CAAC;AAED,MAAM,qBAAqBA,WAAE,OAAO;CAClC,OAAOA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC5B,aAAaA,WAAE,SAASA,WAAE,OAAO,CAAC;AACpC,CAAC;;AAGD,MAAa,oBAAoBC,qCAAiB;CAChD,QAAQ;CACR,KAAK;CACL,QAAQ;EACN,uBAAuBC,gCAAY;GACjC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;;IAEP,MAAMF,WAAE,YAAY;;KAElB,OAAOA,WAAE,SAASA,WAAE,OAAO,CAAC;;KAE5B,UAAUA,WAAE,SAASA,WAAE,OAAO,CAAC;KAC/B,WAAWA,WAAE,OAAO;KACpB,YAAYA,WAAE,OAAO;KACrB,QAAQA,WAAE,MAAM,4BAA4B;IAC9C,CAAC;IACD,UAAU,EACR,KAAKG,wCAAmBH,WAAE,OAAO,EAAE,UAAUA,WAAE,OAAO,EAAE,CAAC,CAAC,EAC5D;GACF;EACF,CAAC;EACD,sBAAsBE,gCAAY;GAChC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EACR,KAAKC,wCAAmBH,WAAE,MAAM,0BAA0B,CAAC,EAC7D,EACF;EACF,CAAC;EACD,sBAAsBE,gCAAY;GAChC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAaF,WAAE,OAAO;KACpB,OAAOA,WAAE,SAASA,WAAE,OAAO,CAAC;;KAE5B,MAAMA,WAAE,SAASA,WAAE,OAAO,CAAC;IAC7B,CAAC;IACD,UAAU,EAAE,KAAKG,wCAAmB,mBAAmB,EAAE;GAC3D;EACF,CAAC;EACD,iBAAiBD,gCAAY;GAC3B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EAAE,KAAKC,wCAAmBH,WAAE,MAAM,oBAAoB,CAAC,EAAE,EACrE;EACF,CAAC;EACD,sBAAsBE,gCAAY;GAChC,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQF,WAAE,OAAO,EAAE,eAAeA,WAAE,OAAO,CAAC,CAAC,MAAMA,WAAE,UAAU,CAAC,CAAC,EAAE,CAAC;IACpE,UAAU,EAAE,KAAKG,wCAAmB,sBAAsB,EAAE;GAC9D;EACF,CAAC;EACD,iBAAiBD,gCAAY;GAC3B,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAaF,WAAE,OAAO,EAAE,KAAKA,WAAE,SAASA,WAAE,OAAO,CAAC,EAAE,CAAC;IACrD,UAAU,EAAE,KAAKG,wCAAmB,kBAAkB,EAAE;GAC1D;EACF,CAAC;CACH;AACF,CAAC"}

package/dist/cjs/asset.cjs

@@ -0,0 +1,88 @@
+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/asset.ts
+/** Image uploaded to a project (served from the CDN). */
+const assetSchema = zod_mini.z.looseObject({
+	id: zod_mini.z.string(),
+	projectId: zod_mini.z.string(),
+	/** Original file name as provided by the uploader. */
+	originalName: zod_mini.z.string(),
+	/** MIME type (ex: `image/jpeg`). */
+	mimeType: zod_mini.z.string(),
+	/** File size in bytes. */
+	size: zod_mini.z.number(),
+	/** S3 object key. */
+	s3Key: zod_mini.z.string(),
+	/** Publicly accessible CDN URL. */
+	publicUrl: zod_mini.z.string(),
+	alt: zod_mini.z.optional(zod_mini.z.string()),
+	caption: zod_mini.z.optional(zod_mini.z.string()),
+	uploadedBy: zod_mini.z.string(),
+	createdAt: require_common.dateTimeSchema,
+	updatedAt: require_common.dateTimeSchema
+});
+const assetIdParamsSchema = zod_mini.z.object({ assetId: require_common.objectIdSchema });
+const assetResponseSchema = require_responseData.responseDataSchema(assetSchema);
+/** REST contract of the `/api/assets` routes (scoped to the selected project). */
+const assetContract = require_defineRoute.defineRouteGroup({
+	prefix: "/api/assets",
+	tag: "Asset",
+	routes: {
+		getAssets: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/",
+			summary: "List the assets of the selected project",
+			schemas: {
+				querystring: zod_mini.z.object(require_common.paginationQueryShape),
+				response: { 200: require_responseData.paginatedResponseSchema(assetSchema) }
+			}
+		}),
+		getAssetById: require_defineRoute.defineRoute({
+			method: "GET",
+			path: "/:assetId",
+			summary: "Get an asset",
+			schemas: {
+				params: assetIdParamsSchema,
+				response: { 200: assetResponseSchema }
+			}
+		}),
+		uploadAsset: require_defineRoute.defineRoute({
+			method: "POST",
+			path: "/",
+			summary: "Upload an image (raw `image/*` body)",
+			schemas: { response: { 200: assetResponseSchema } }
+		}),
+		updateAsset: require_defineRoute.defineRoute({
+			method: "PATCH",
+			path: "/:assetId",
+			summary: "Update the metadata of an asset",
+			schemas: {
+				params: assetIdParamsSchema,
+				body: zod_mini.z.object({
+					originalName: zod_mini.z.optional(zod_mini.z.string()),
+					alt: zod_mini.z.optional(zod_mini.z.string()),
+					caption: zod_mini.z.optional(zod_mini.z.string())
+				}),
+				response: { 200: assetResponseSchema }
+			}
+		}),
+		deleteAsset: require_defineRoute.defineRoute({
+			method: "DELETE",
+			path: "/:assetId",
+			summary: "Delete an asset (database and CDN)",
+			schemas: {
+				params: assetIdParamsSchema,
+				response: { 200: require_responseData.responseDataSchema(zod_mini.z.null()) }
+			}
+		})
+	}
+});
+
+//#endregion
+exports.assetContract = assetContract;
+exports.assetSchema = assetSchema;
+//# sourceMappingURL=asset.cjs.map

package/dist/cjs/asset.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"asset.cjs","names":["z","dateTimeSchema","objectIdSchema","responseDataSchema","defineRouteGroup","defineRoute","paginationQueryShape","paginatedResponseSchema"],"sources":["../../src/asset.ts"],"sourcesContent":["import { z } from 'zod/mini';\nimport { dateTimeSchema, 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/** Image uploaded to a project (served from the CDN). */\nexport const assetSchema = z.looseObject({\n  id: z.string(),\n  projectId: z.string(),\n  /** Original file name as provided by the uploader. */\n  originalName: z.string(),\n  /** MIME type (ex: `image/jpeg`). */\n  mimeType: z.string(),\n  /** File size in bytes. */\n  size: z.number(),\n  /** S3 object key. */\n  s3Key: z.string(),\n  /** Publicly accessible CDN URL. */\n  publicUrl: z.string(),\n  alt: z.optional(z.string()),\n  caption: z.optional(z.string()),\n  uploadedBy: z.string(),\n  createdAt: dateTimeSchema,\n  updatedAt: dateTimeSchema,\n});\n\nconst assetIdParamsSchema = z.object({ assetId: objectIdSchema });\nconst assetResponseSchema = responseDataSchema(assetSchema);\n\n/** REST contract of the `/api/assets` routes (scoped to the selected project). */\nexport const assetContract = defineRouteGroup({\n  prefix: '/api/assets',\n  tag: 'Asset',\n  routes: {\n    getAssets: defineRoute({\n      method: 'GET',\n      path: '/',\n      summary: 'List the assets of the selected project',\n      schemas: {\n        querystring: z.object(paginationQueryShape),\n        response: { 200: paginatedResponseSchema(assetSchema) },\n      },\n    }),\n    getAssetById: defineRoute({\n      method: 'GET',\n      path: '/:assetId',\n      summary: 'Get an asset',\n      schemas: {\n        params: assetIdParamsSchema,\n        response: { 200: assetResponseSchema },\n      },\n    }),\n    uploadAsset: defineRoute({\n      method: 'POST',\n      path: '/',\n      summary: 'Upload an image (raw `image/*` body)',\n      schemas: {\n        response: { 200: assetResponseSchema },\n      },\n    }),\n    updateAsset: defineRoute({\n      method: 'PATCH',\n      path: '/:assetId',\n      summary: 'Update the metadata of an asset',\n      schemas: {\n        params: assetIdParamsSchema,\n        body: z.object({\n          originalName: z.optional(z.string()),\n          alt: z.optional(z.string()),\n          caption: z.optional(z.string()),\n        }),\n        response: { 200: assetResponseSchema },\n      },\n    }),\n    deleteAsset: defineRoute({\n      method: 'DELETE',\n      path: '/:assetId',\n      summary: 'Delete an asset (database and CDN)',\n      schemas: {\n        params: assetIdParamsSchema,\n        response: { 200: responseDataSchema(z.null()) },\n      },\n    }),\n  },\n});\n\n/** Route definitions of the `/api/assets` group, by name. */\nexport type AssetRoutes = (typeof assetContract)['routes'];\n\nexport type AssetAPI = z.output<typeof assetSchema>;\nexport type GetAssetsResult = PaginatedResponse<AssetAPI>;\nexport type GetAssetByIdResult = ResponseData<AssetAPI>;\nexport type UploadAssetResult = ResponseData<AssetAPI>;\nexport type UpdateAssetBody = RouteBodyInput<AssetRoutes['updateAsset']>;\nexport type UpdateAssetResult = ResponseData<AssetAPI>;\nexport type DeleteAssetResult = ResponseData<null>;\n"],"mappings":";;;;;;;;AAeA,MAAa,cAAcA,WAAE,YAAY;CACvC,IAAIA,WAAE,OAAO;CACb,WAAWA,WAAE,OAAO;;CAEpB,cAAcA,WAAE,OAAO;;CAEvB,UAAUA,WAAE,OAAO;;CAEnB,MAAMA,WAAE,OAAO;;CAEf,OAAOA,WAAE,OAAO;;CAEhB,WAAWA,WAAE,OAAO;CACpB,KAAKA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC1B,SAASA,WAAE,SAASA,WAAE,OAAO,CAAC;CAC9B,YAAYA,WAAE,OAAO;CACrB,WAAWC;CACX,WAAWA;AACb,CAAC;AAED,MAAM,sBAAsBD,WAAE,OAAO,EAAE,SAASE,8BAAe,CAAC;AAChE,MAAM,sBAAsBC,wCAAmB,WAAW;;AAG1D,MAAa,gBAAgBC,qCAAiB;CAC5C,QAAQ;CACR,KAAK;CACL,QAAQ;EACN,WAAWC,gCAAY;GACrB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,aAAaL,WAAE,OAAOM,mCAAoB;IAC1C,UAAU,EAAE,KAAKC,6CAAwB,WAAW,EAAE;GACxD;EACF,CAAC;EACD,cAAcF,gCAAY;GACxB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EAAE,KAAK,oBAAoB;GACvC;EACF,CAAC;EACD,aAAaA,gCAAY;GACvB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS,EACP,UAAU,EAAE,KAAK,oBAAoB,EACvC;EACF,CAAC;EACD,aAAaA,gCAAY;GACvB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,MAAML,WAAE,OAAO;KACb,cAAcA,WAAE,SAASA,WAAE,OAAO,CAAC;KACnC,KAAKA,WAAE,SAASA,WAAE,OAAO,CAAC;KAC1B,SAASA,WAAE,SAASA,WAAE,OAAO,CAAC;IAChC,CAAC;IACD,UAAU,EAAE,KAAK,oBAAoB;GACvC;EACF,CAAC;EACD,aAAaK,gCAAY;GACvB,QAAQ;GACR,MAAM;GACN,SAAS;GACT,SAAS;IACP,QAAQ;IACR,UAAU,EAAE,KAAKF,wCAAmBH,WAAE,KAAK,CAAC,EAAE;GAChD;EACF,CAAC;CACH;AACF,CAAC"}