@better-i18n/schemas 0.2.1 → 0.2.3

package/package.json

@@ -1,33 +1,32 @@
 {
   "name": "@better-i18n/schemas",
-  "version": "0.2.1",
-  "description": "Public schemas and types for Better i18n SDK and MCP",
+  "version": "0.2.3",
+  "description": "Shared validation schemas for API and frontend",
   "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
   "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "bun": "./src/index.ts",
-      "default": "./dist/index.js"
-    },
-    "./ai-models": {
-      "types": "./dist/ai-models.d.ts",
-      "bun": "./src/ai-models.ts",
-      "default": "./dist/ai-models.js"
-    }
+    ".": "./src/index.ts",
+    "./projects": "./src/projects/index.ts",
+    "./organizations": "./src/organizations/index.ts",
+    "./languages": "./src/languages/index.ts",
+    "./github": "./src/github.ts",
+    "./translations": "./src/translations.ts"
   },
   "files": [
-    "dist"
+    "src"
   ],
   "scripts": {
-    "build": "tsc",
-    "typecheck": "tsc --noEmit",
-    "clean": "rm -rf dist",
-    "prepublishOnly": "bun run build"
+    "type-check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "zod": "^3.25.76"
   },
   "devDependencies": {
     "typescript": "~5.9.2"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "license": "MIT"
 }

package/src/ai-models.ts

@@ -0,0 +1,251 @@
+/**
+ * Shared AI Model Configuration
+ * Single source of truth for all AI model definitions used across frontend and backend.
+ */
+
+// Provider types
+export type ModelProvider =
+  | "better-ai"
+  | "openai"
+  | "gemini"
+  | "claude"
+  | "openrouter"
+  | "azure-openai";
+
+// Model categories
+export type ModelCategory =
+  | "flagship"
+  | "reasoning"
+  | "performance"
+  | "specialized"
+  | "legacy";
+
+// Icon types for models
+export type ModelIcon = "OpenAI" | "Gemini" | "Claude" | "BetterAI" | "AzureOpenAI";
+
+// Model color configuration
+export interface ModelColors {
+  /** Background color for UI elements */
+  background: string;
+  /** Hover background color */
+  hover: string;
+  /** Icon/text color */
+  icon: string;
+}
+
+// Complete model configuration
+export interface AIModelConfig {
+  /** UI display ID (e.g., "gpt-5.2", "gemini-3-flash") */
+  id: string;
+  /** Display name for UI (e.g., "ChatGPT 5.2", "Gemini 3 Flash") */
+  name: string;
+  /** Provider identifier */
+  provider: ModelProvider;
+  /** Icon to display for this model (from lucide-react or custom) */
+  icon: ModelIcon;
+  /** Colors for UI elements */
+  colors: ModelColors;
+  /** Actual API model ID to send to provider SDK (e.g., "gpt-5.2", "gemini-2.5-flash") */
+  apiModelId: string;
+  /** Max context window in tokens */
+  contextSize: number;
+  /** Max output tokens */
+  maxOutput: number;
+  /** Model description */
+  description: string;
+  /** Optional badge (e.g., "New", "Fast", "Default") */
+  badge?: string;
+  /** Is this the default model? */
+  isDefault?: boolean;
+  /** Release date info */
+  releaseDate?: string;
+  /** Training data cutoff */
+  trainingData?: string;
+  /** Speed score 0-100 */
+  speed?: number;
+  /** Model category */
+  category?: ModelCategory;
+  /** Whether this model requires user's own API key (not platform key) */
+  requiresUserKey?: boolean;
+}
+
+// Provider configuration (for UI)
+export interface ProviderInfo {
+  id: ModelProvider;
+  name: string;
+  brandColor: string;
+}
+
+/**
+ * All available AI models - Single Source of Truth
+ *
+ * Important: `apiModelId` is the actual model ID sent to the provider's SDK.
+ * This may differ from `id` which is used for UI/selection purposes.
+ *
+ * We keep only the best/flagship models from each provider to avoid clutter.
+ */
+export const AI_MODELS: AIModelConfig[] = [
+  // ============================================
+  // Better AI - Platform Default (Powered by Gemini 3.1 Pro Preview)
+  // ============================================
+  {
+    id: "better-ai",
+    name: "Better AI",
+    provider: "better-ai",
+    icon: "BetterAI",
+    colors: {
+      background: "bg-gray-50 dark:bg-neutral-700",
+      hover: "hover:bg-gray-100 dark:hover:bg-neutral-600",
+      icon: "text-gray-700 dark:text-white",
+    },
+    apiModelId: "gemini-2.5-flash",
+    contextSize: 1_048_576, // 1M tokens
+    maxOutput: 65_536,
+    description:
+      "Powerful AI model powered by Gemini 2.5 Preview. Great for translations.",
+    isDefault: true,
+    badge: "Default",
+    releaseDate: "Jan 2025",
+    trainingData: "Jan 2025",
+    speed: 95,
+    category: "flagship",
+    requiresUserKey: false,
+  },
+
+  // ============================================
+  // Azure OpenAI Models (via Azure credits)
+  // ============================================
+  {
+    id: "gpt-5.3",
+    name: "GPT 5.3",
+    provider: "azure-openai",
+    icon: "AzureOpenAI",
+    colors: {
+      background: "bg-gray-100 dark:bg-neutral-800",
+      hover: "hover:bg-gray-200 dark:hover:bg-neutral-700",
+      icon: "text-gray-700 dark:text-neutral-300",
+    },
+    apiModelId: "gpt-5.3-chat",
+    contextSize: 1_047_576,
+    maxOutput: 128_000,
+    description: "OpenAI's latest and most capable model via Azure.",
+    badge: "New",
+    releaseDate: "2025",
+    trainingData: "2025",
+    speed: 90,
+    category: "flagship",
+    requiresUserKey: false,
+  },
+  {
+    id: "gpt-5.2",
+    name: "GPT 5.2",
+    provider: "azure-openai",
+    icon: "AzureOpenAI",
+    colors: {
+      background: "bg-gray-100 dark:bg-neutral-800",
+      hover: "hover:bg-gray-200 dark:hover:bg-neutral-700",
+      icon: "text-gray-700 dark:text-neutral-300",
+    },
+    apiModelId: "gpt-5.2-chat",
+    contextSize: 1_047_576,
+    maxOutput: 128_000,
+    description: "OpenAI GPT 5.2 via Azure OpenAI.",
+    badge: "Fast",
+    releaseDate: "2025",
+    trainingData: "2025",
+    speed: 95,
+    category: "flagship",
+    requiresUserKey: false,
+  },
+
+  // ============================================
+  // Google Gemini Models
+  // ============================================
+  {
+    id: "gemini-3-pro",
+    name: "Gemini 3 Pro",
+    provider: "gemini",
+    icon: "Gemini",
+    colors: {
+      background: "bg-blue-50 dark:bg-blue-700",
+      hover: "hover:bg-blue-100 dark:hover:bg-blue-600",
+      icon: "text-blue-500 dark:text-blue-100",
+    },
+    apiModelId: "gemini-3-pro-preview",
+    contextSize: 1_048_576, // 1M tokens (verified from Google docs)
+    maxOutput: 65_536,
+    description: "Google's most capable model. Best for complex tasks.",
+    badge: "Pro",
+    releaseDate: "Jan 2025",
+    trainingData: "Jan 2025",
+    speed: 90,
+    category: "flagship",
+    requiresUserKey: false,
+  },
+];
+
+// ============================================
+// Helper Functions
+// ============================================
+
+/**
+ * Get model config by ID
+ */
+export function getModelById(modelId: string): AIModelConfig | undefined {
+  return AI_MODELS.find((m) => m.id === modelId);
+}
+
+/**
+ * Get the actual API model ID for a given UI model ID
+ */
+export function getApiModelId(modelId: string): string {
+  const model = getModelById(modelId);
+  return model?.apiModelId ?? modelId;
+}
+
+/**
+ * Get provider for a model ID
+ */
+export function getModelProvider(modelId: string): ModelProvider {
+  const model = getModelById(modelId);
+  return model?.provider ?? "better-ai";
+}
+
+/**
+ * Get default model
+ */
+export function getDefaultModel(): AIModelConfig {
+  return AI_MODELS.find((m) => m.isDefault) ?? AI_MODELS[0];
+}
+
+/**
+ * Get models by provider
+ */
+export function getModelsByProvider(provider: ModelProvider): AIModelConfig[] {
+  return AI_MODELS.filter((m) => m.provider === provider);
+}
+
+/**
+ * Get models that don't require user API key (platform-provided)
+ */
+export function getPlatformModels(): AIModelConfig[] {
+  return AI_MODELS.filter((m) => !m.requiresUserKey);
+}
+
+/**
+ * Check if a model requires user's own API key
+ */
+export function modelRequiresUserKey(modelId: string): boolean {
+  const model = getModelById(modelId);
+  return model?.requiresUserKey ?? false;
+}
+
+/**
+ * Format context size for display (e.g., "128K", "2M")
+ */
+export function formatContextSize(tokens: number): string {
+  if (tokens >= 1_000_000) {
+    return `${(tokens / 1_000_000).toFixed(0)}M`;
+  }
+  return `${(tokens / 1_000).toFixed(0)}K`;
+}

package/src/content.ts

@@ -0,0 +1,300 @@
+/**
+ * Zod validation schemas for Content Model CRUD operations.
+ *
+ * Content models are user-defined content types (blog, changelog, legal, etc.)
+ * with custom field definitions. These schemas validate all API inputs.
+ */
+
+import { z } from "zod";
+
+// —————————————————————————————————————————————————————————————————————————————
+// Shared enums
+// —————————————————————————————————————————————————————————————————————————————
+
+export const contentModelFieldTypeEnum = z.enum([
+  "text",
+  "textarea",
+  "richtext",
+  "number",
+  "boolean",
+  "date",
+  "datetime",
+  "enum",
+  "media",
+  "relation",
+]);
+
+export const contentModelKindEnum = z.enum(["collection", "single"]);
+
+// —————————————————————————————————————————————————————————————————————————————
+// Field-level config schemas (must precede model schemas that reference them)
+// —————————————————————————————————————————————————————————————————————————————
+
+/** Single enum option (label displayed to users, value stored in DB) */
+export const enumValueItemSchema = z.object({
+  label: z.string().min(1).max(200),
+  value: z.string().min(1).max(200),
+});
+
+/** Extensible field-level options (Unsplash, AI generation, enum values, etc.) */
+export const fieldOptionsSchema = z.object({
+  unsplash: z.object({ enabled: z.boolean() }).optional(),
+  aiGeneration: z.object({
+    enabled: z.boolean(),
+    prompt: z.string().max(2000).optional(),
+    model: z.string().max(100).optional(),
+  }).optional(),
+  enumValues: z.array(enumValueItemSchema).max(200).optional(),
+  showInTable: z.boolean().optional(),
+}).optional();
+
+/** Type-specific field configuration (e.g., targetModel for relation fields) */
+export const fieldConfigSchema = z.object({
+  targetModel: z.string().optional(),
+}).optional();
+
+// —————————————————————————————————————————————————————————————————————————————
+// Model schemas
+// —————————————————————————————————————————————————————————————————————————————
+
+/** List all content models for a project */
+export const listContentModelsSchema = z.object({
+  projectId: z.string().uuid(),
+});
+
+/** Get a single content model by slug */
+export const getContentModelBySlugSchema = z.object({
+  projectId: z.string().uuid(),
+  slug: z.string().min(1),
+});
+
+/** Get a single content model by ID */
+export const getContentModelSchema = z.object({
+  modelId: z.string().uuid(),
+});
+
+/** Create a content model with fields atomically */
+export const createContentModelSchema = z.object({
+  projectId: z.string().uuid(),
+  organizationId: z.string().uuid(),
+  slug: z
+    .string()
+    .min(1)
+    .max(100)
+    .regex(/^[a-z0-9-]+$/, "Slug must contain only lowercase letters, numbers, and hyphens"),
+  displayName: z.string().min(1).max(200),
+  description: z.string().max(1000).optional(),
+  kind: contentModelKindEnum.default("collection"),
+  icon: z.string().max(50).optional(),
+  enableVersionHistory: z.boolean().default(true),
+  includeBody: z.boolean().default(true),
+  fields: z
+    .array(
+      z.object({
+        name: z
+          .string()
+          .min(1)
+          .max(100)
+          .regex(
+            /^[a-z_][a-z0-9_]*$/,
+            "Field name must be snake_case (lowercase letters, numbers, underscores)",
+          ),
+        displayName: z.string().min(1).max(200),
+        type: contentModelFieldTypeEnum.default("text"),
+        localized: z.boolean().default(false),
+        required: z.boolean().default(false),
+        placeholder: z.string().max(500).optional(),
+        helpText: z.string().max(500).optional(),
+        position: z.number().int().min(0),
+        fieldConfig: fieldConfigSchema,
+        options: fieldOptionsSchema,
+      }),
+    )
+    .default([]),
+});
+
+/** Table settings schema for base field visibility */
+export const contentModelTableSettingsSchema = z.object({
+  baseFields: z.record(z.string(), z.boolean()).optional(),
+}).optional();
+
+/** Update a content model's metadata (not fields) */
+export const updateContentModelSchema = z.object({
+  modelId: z.string().uuid(),
+  displayName: z.string().min(1).max(200).optional(),
+  description: z.string().max(1000).optional(),
+  kind: contentModelKindEnum.optional(),
+  icon: z.string().max(50).optional(),
+  enableVersionHistory: z.boolean().optional(),
+  includeBody: z.boolean().optional(),
+  tableSettings: contentModelTableSettingsSchema,
+});
+
+/** Delete a content model */
+export const deleteContentModelSchema = z.object({
+  modelId: z.string().uuid(),
+});
+
+// —————————————————————————————————————————————————————————————————————————————
+// Field schemas
+// —————————————————————————————————————————————————————————————————————————————
+
+/** Add a field to a content model */
+export const addContentModelFieldSchema = z.object({
+  modelId: z.string().uuid(),
+  name: z
+    .string()
+    .min(1)
+    .max(100)
+    .regex(
+      /^[a-z_][a-z0-9_]*$/,
+      "Field name must be snake_case",
+    ),
+  displayName: z.string().min(1).max(200),
+  type: contentModelFieldTypeEnum.default("text"),
+  localized: z.boolean().default(false),
+  required: z.boolean().default(false),
+  placeholder: z.string().max(500).optional(),
+  helpText: z.string().max(500).optional(),
+  position: z.number().int().min(0).optional(),
+  options: fieldOptionsSchema,
+  fieldConfig: fieldConfigSchema,
+});
+
+/** Update an existing field */
+export const updateContentModelFieldSchema = z.object({
+  fieldId: z.string().uuid(),
+  displayName: z.string().min(1).max(200).optional(),
+  type: contentModelFieldTypeEnum.optional(),
+  localized: z.boolean().optional(),
+  required: z.boolean().optional(),
+  placeholder: z.string().max(500).optional(),
+  helpText: z.string().max(500).optional(),
+  options: fieldOptionsSchema,
+  fieldConfig: fieldConfigSchema,
+});
+
+/** Remove a field from a content model */
+export const removeContentModelFieldSchema = z.object({
+  fieldId: z.string().uuid(),
+});
+
+/** Reorder fields within a content model */
+export const reorderContentModelFieldsSchema = z.object({
+  modelId: z.string().uuid(),
+  fieldIds: z.array(z.string().uuid()).min(1),
+});
+
+// —————————————————————————————————————————————————————————————————————————————
+// Entry schemas
+// —————————————————————————————————————————————————————————————————————————————
+
+export const contentEntryStatusEnum = z.enum(["draft", "published", "archived"]);
+export const contentEntrySortFieldEnum = z.enum(["publishedAt", "createdAt", "updatedAt", "title"]);
+
+/** List content entries with filtering and pagination */
+export const listContentEntriesSchema = z.object({
+  projectId: z.string().uuid(),
+  modelSlug: z.string().optional(),
+  status: contentEntryStatusEnum.optional(),
+  search: z.union([z.string(), z.array(z.string())]).optional(),
+  /** Which languages to search content IN (default: all). Separate from languageCodes which filters BY having translations. */
+  searchLanguageCodes: z.array(z.string().transform(v => v.toLowerCase())).optional(),
+  /** Opt-in body search (default: false, can be slow on large bodies) */
+  searchInBody: z.boolean().default(false).optional(),
+  languageCodes: z.array(z.string().transform(v => v.toLowerCase())).optional(),
+  /** Filter entries that do NOT have a translation for this language code */
+  missingLanguageCode: z.string().transform(v => v.toLowerCase()).optional(),
+  /** Filter by custom field values. Key = field name, value = exact match. */
+  fieldFilters: z.record(z.string(), z.string()).optional(),
+  /** Filter entries by specific IDs */
+  ids: z.array(z.string().uuid()).optional(),
+  sort: contentEntrySortFieldEnum.optional(),
+  order: z.enum(["asc", "desc"]).optional(),
+  page: z.number().int().min(1).default(1),
+  limit: z.number().int().min(1).max(100).default(25),
+});
+
+/** Get a single content entry by ID */
+export const getContentEntrySchema = z.object({
+  entryId: z.string().uuid(),
+});
+
+/** Create a content entry */
+export const createContentEntrySchema = z.object({
+  contentModelId: z.string().uuid(),
+  organizationId: z.string().uuid(),
+  slug: z
+    .string()
+    .min(1)
+    .max(200)
+    .regex(/^[a-z0-9-]+$/, "Slug must contain only lowercase letters, numbers, and hyphens"),
+  sourceLanguageCode: z.string().default("en").transform(v => v.toLowerCase()),
+  title: z.string().min(1).max(500),
+  body: z.unknown().default([]),
+  bodyMarkdown: z.string().optional(),
+  customFields: z.record(z.string(), z.string().nullable()).default({}),
+  status: contentEntryStatusEnum.default("draft"),
+});
+
+/** Update a content entry */
+export const updateContentEntrySchema = z.object({
+  entryId: z.string().uuid(),
+  languageCode: z.string().optional().transform(v => v?.toLowerCase()),
+  title: z.string().min(1).max(500).optional(),
+  body: z.unknown().optional(),
+  bodyMarkdown: z.string().optional(),
+  customFields: z.record(z.string(), z.string().nullable()).optional(),
+  status: contentEntryStatusEnum.optional(),
+  slug: z
+    .string()
+    .min(1)
+    .max(200)
+    .regex(/^[a-z0-9-]+$/, "Slug must contain only lowercase letters, numbers, and hyphens")
+    .optional(),
+  publishedAt: z.string().datetime({ offset: true }).nullable().optional(),
+  translationStatus: z.enum(["draft", "published"]).optional(),
+});
+
+/** Delete a content entry */
+export const deleteContentEntrySchema = z.object({
+  entryId: z.string().uuid(),
+});
+
+/** Publish a content entry */
+export const publishContentEntrySchema = z.object({
+  entryId: z.string().uuid(),
+});
+
+/** Generate AI content for a specific field */
+export const generateFieldContentSchema = z.object({
+  entryId: z.string().uuid(),
+  fieldName: z.string().min(1),
+  languageCode: z.string().min(1).transform(v => v.toLowerCase()),
+  modelId: z.string().max(100).optional(),
+  prompt: z.string().max(4000).optional(),
+});
+
+// —————————————————————————————————————————————————————————————————————————————
+// Type exports
+// —————————————————————————————————————————————————————————————————————————————
+
+export type EnumValueItem = z.infer<typeof enumValueItemSchema>;
+export type ListContentModelsInput = z.infer<typeof listContentModelsSchema>;
+export type GetContentModelBySlugInput = z.infer<typeof getContentModelBySlugSchema>;
+export type GetContentModelInput = z.infer<typeof getContentModelSchema>;
+export type CreateContentModelInput = z.infer<typeof createContentModelSchema>;
+export type UpdateContentModelInput = z.infer<typeof updateContentModelSchema>;
+export type DeleteContentModelInput = z.infer<typeof deleteContentModelSchema>;
+export type AddContentModelFieldInput = z.infer<typeof addContentModelFieldSchema>;
+export type UpdateContentModelFieldInput = z.infer<typeof updateContentModelFieldSchema>;
+export type RemoveContentModelFieldInput = z.infer<typeof removeContentModelFieldSchema>;
+export type ReorderContentModelFieldsInput = z.infer<typeof reorderContentModelFieldsSchema>;
+
+export type ListContentEntriesInput = z.infer<typeof listContentEntriesSchema>;
+export type GetContentEntryInput = z.infer<typeof getContentEntrySchema>;
+export type CreateContentEntryInput = z.infer<typeof createContentEntrySchema>;
+export type UpdateContentEntryInput = z.infer<typeof updateContentEntrySchema>;
+export type DeleteContentEntryInput = z.infer<typeof deleteContentEntrySchema>;
+export type PublishContentEntryInput = z.infer<typeof publishContentEntrySchema>;
+export type GenerateFieldContentInput = z.infer<typeof generateFieldContentSchema>;