@intlayer/backend-contract 0.0.0-stage → 9.6.0

package/dist/types/ai.d.ts

@@ -0,0 +1,549 @@
+import { RouteBodyInput, RouteDefinition, RouteGroup, RouteQuerystring } from "./defineRoute.js";
+import { PaginatedResponse, ResponseData } from "./responseData.js";
+import { Locale } from "@intlayer/types/allLocales";
+import { AiProviders } from "@intlayer/types/config";
+import { KeyPath } from "@intlayer/types/keyPath";
+import { z } from "zod/mini";
+//#region src/ai.d.ts
+/**
+ * AI settings sent by a client. Provider-specific options (from the AI SDKs)
+ * pass through untouched, so the value is only checked to be an object;
+ * `@intlayer/ai`'s `AIOptions` is asserted assignable in the backend.
+ */
+export type AIOptions = {
+  provider?: `${AiProviders}`;
+  model?: string;
+  temperature?: number;
+  baseURL?: string;
+  /** Own provider key; omitted to use the project or Intlayer key. */
+  apiKey?: string;
+  applicationContext?: string;
+  dataSerialization?: 'json' | 'toon';
+};
+export declare const aiOptionsSchema: z.ZodMiniCustom<AIOptions, AIOptions>;
+/** Chat message exchanged with the assistants. */
+export declare const chatCompletionRequestMessageSchema: z.ZodMiniObject<{
+  role: z.ZodMiniEnum<{
+    assistant: "assistant";
+    system: "system";
+    user: "user";
+  }>;
+  content: z.ZodMiniString<string>;
+  timestamp: z.ZodMiniOptional<z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<Date, string>>>;
+}, z.core.$strip>;
+/** Text result of an AI step (translation, audit, query). */
+declare const fileContentResultSchema: z.ZodMiniObject<{
+  tokenUsed: z.ZodMiniNumber<number>;
+  fileContent: z.ZodMiniString<string>;
+}, z.core.$strip>;
+/** Tag fields rewritten by the tag audit (parsed from the model's JSON). */
+declare const tagAuditResultSchema: z.ZodMiniObject<{
+  tokenUsed: z.ZodMiniNumber<number>;
+  fileContent: z.ZodMiniObject<{
+    key: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    instructions: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  }, z.core.$loose>;
+}, z.core.$strip>;
+declare const metadataResultSchema: z.ZodMiniObject<{
+  tokenUsed: z.ZodMiniNumber<number>;
+  fileContent: z.ZodMiniObject<{
+    title: z.ZodMiniString<string>;
+    description: z.ZodMiniString<string>;
+    tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+  }, z.core.$strip>;
+}, z.core.$strip>;
+declare const tokenUsageSchema: z.ZodMiniObject<{
+  inputTokens: z.ZodMiniNumber<number>;
+  outputTokens: z.ZodMiniNumber<number>;
+  totalTokens: z.ZodMiniNumber<number>;
+}, z.core.$strip>;
+/** Message stored in a discussion. */
+export declare const discussionMessageSchema: z.ZodMiniObject<{
+  role: z.ZodMiniEnum<{
+    assistant: "assistant";
+    system: "system";
+    user: "user";
+  }>;
+  content: z.ZodMiniString<string>;
+  relatedFiles: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+  timestamp: z.ZodMiniString<string>;
+}, z.core.$strip>;
+/** Saved AI discussion (doc assistant or dashboard chat). */
+export declare const discussionSchema: z.ZodMiniObject<{
+  id: z.ZodMiniString<string>;
+  discussionId: z.ZodMiniString<string>;
+  messages: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
+    role: z.ZodMiniEnum<{
+      assistant: "assistant";
+      system: "system";
+      user: "user";
+    }>;
+    content: z.ZodMiniString<string>;
+    relatedFiles: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    timestamp: z.ZodMiniString<string>;
+  }, z.core.$strip>>>;
+  numberOfMessages: z.ZodMiniNumber<number>;
+  userId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  projectId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  organizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  title: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  type: z.ZodMiniOptional<z.ZodMiniEnum<{
+    dashboard: "dashboard";
+    doc: "doc";
+  }>>;
+  isArchived: z.ZodMiniBoolean<boolean>;
+  aiModel: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  tokenUsage: z.ZodMiniOptional<z.ZodMiniObject<{
+    inputTokens: z.ZodMiniNumber<number>;
+    outputTokens: z.ZodMiniNumber<number>;
+    totalTokens: z.ZodMiniNumber<number>;
+  }, z.core.$strip>>;
+  createdAt: z.ZodMiniString<string>;
+  updatedAt: z.ZodMiniString<string>;
+}, z.core.$loose>;
+/** Token usage of the project's dashboard discussions, per model. */
+export declare const aiStatsSchema: z.ZodMiniObject<{
+  projectId: z.ZodMiniString<string>;
+  generatedAt: z.ZodMiniNumber<number>;
+  totalDiscussions: z.ZodMiniNumber<number>;
+  totalInputTokens: z.ZodMiniNumber<number>;
+  totalOutputTokens: z.ZodMiniNumber<number>;
+  totalTokens: z.ZodMiniNumber<number>;
+  modelUsage: z.ZodMiniArray<z.ZodMiniObject<{
+    aiModel: z.ZodMiniString<string>;
+    discussionCount: z.ZodMiniNumber<number>;
+    totalInputTokens: z.ZodMiniNumber<number>;
+    totalOutputTokens: z.ZodMiniNumber<number>;
+    totalTokens: z.ZodMiniNumber<number>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+/** REST contract of the `/api/ai` routes. */
+export declare const aiContract: RouteGroup<"/api/ai", {
+  readonly customQuery: RouteDefinition<"POST", "/", {
+    readonly body: z.ZodMiniObject<{
+      aiOptions: z.ZodMiniOptional<z.ZodMiniCustom<AIOptions, AIOptions>>;
+      tagsKeys: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+      messages: z.ZodMiniCustom<unknown[], unknown[]>;
+      system: z.ZodMiniOptional<z.ZodMiniUnknown>;
+      applicationContext: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$loose>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          tokenUsed: z.ZodMiniNumber<number>;
+          fileContent: z.ZodMiniString<string>;
+        }, z.core.$strip>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly translateJSON: RouteDefinition<"POST", "/translate/json", {
+    readonly body: z.ZodMiniObject<{
+      aiOptions: z.ZodMiniOptional<z.ZodMiniCustom<AIOptions, AIOptions>>;
+      tagsKeys: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+      entryFileContent: z.ZodMiniCustom<Record<string, unknown>, Record<string, unknown>>;
+      presetOutputContent: z.ZodMiniCustom<Record<string, unknown>, Record<string, unknown>>;
+      dictionaryDescription: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      entryLocale: z.ZodMiniCustom<Locale, Locale>;
+      outputLocale: z.ZodMiniCustom<Locale, Locale>;
+      mode: z.ZodMiniEnum<{
+        complete: "complete";
+        review: "review";
+      }>;
+      applicationContext: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          tokenUsed: z.ZodMiniNumber<number>;
+          fileContent: z.ZodMiniCustom<Record<string, unknown>, Record<string, unknown>>;
+        }, z.core.$strip>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly auditContentDeclaration: RouteDefinition<"POST", "/audit/dictionary", {
+    readonly body: z.ZodMiniObject<{
+      aiOptions: z.ZodMiniOptional<z.ZodMiniCustom<AIOptions, AIOptions>>;
+      tagsKeys: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+      locales: z.ZodMiniArray<z.ZodMiniCustom<Locale, Locale>>;
+      defaultLocale: z.ZodMiniCustom<Locale, Locale>;
+      fileContent: z.ZodMiniString<string>;
+      filePath: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          tokenUsed: z.ZodMiniNumber<number>;
+          fileContent: z.ZodMiniObject<{
+            title: z.ZodMiniString<string>;
+            description: z.ZodMiniString<string>;
+            tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+          }, z.core.$strip>;
+        }, z.core.$strip>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly auditContentDeclarationField: RouteDefinition<"POST", "/audit/dictionary/field", {
+    readonly body: z.ZodMiniObject<{
+      aiOptions: z.ZodMiniOptional<z.ZodMiniCustom<AIOptions, AIOptions>>;
+      tagsKeys: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+      locales: z.ZodMiniArray<z.ZodMiniCustom<Locale, Locale>>;
+      fileContent: z.ZodMiniString<string>;
+      filePath: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      keyPath: z.ZodMiniArray<z.ZodMiniCustom<KeyPath, KeyPath>>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          tokenUsed: z.ZodMiniNumber<number>;
+          fileContent: z.ZodMiniString<string>;
+        }, z.core.$strip>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly auditContentDeclarationMetadata: RouteDefinition<"POST", "/audit/dictionary/metadata", {
+    readonly body: z.ZodMiniObject<{
+      aiOptions: z.ZodMiniOptional<z.ZodMiniCustom<AIOptions, AIOptions>>;
+      fileContent: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          tokenUsed: z.ZodMiniNumber<number>;
+          fileContent: z.ZodMiniObject<{
+            title: z.ZodMiniString<string>;
+            description: z.ZodMiniString<string>;
+            tags: z.ZodMiniArray<z.ZodMiniString<string>>;
+          }, z.core.$strip>;
+        }, z.core.$strip>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly auditTag: RouteDefinition<"POST", "/audit/tag", {
+    readonly body: z.ZodMiniObject<{
+      aiOptions: z.ZodMiniOptional<z.ZodMiniCustom<AIOptions, AIOptions>>;
+      tag: z.ZodMiniObject<{
+        key: z.ZodMiniString<string>;
+        name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        instructions: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        id: z.ZodMiniString<string>;
+        creatorId: z.ZodMiniString<string>;
+        projectId: z.ZodMiniString<string>;
+        organizationId: z.ZodMiniString<string>;
+        createdAt: z.ZodMiniString<string>;
+        updatedAt: z.ZodMiniString<string>;
+      }, z.core.$loose>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          tokenUsed: z.ZodMiniNumber<number>;
+          fileContent: z.ZodMiniObject<{
+            key: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            name: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            instructions: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          }, z.core.$loose>;
+        }, z.core.$strip>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly ask: RouteDefinition<"POST", "/ask", {
+    readonly body: z.ZodMiniObject<{
+      messages: z.ZodMiniArray<z.ZodMiniObject<{
+        role: z.ZodMiniEnum<{
+          assistant: "assistant";
+          system: "system";
+          user: "user";
+        }>;
+        content: z.ZodMiniString<string>;
+        timestamp: z.ZodMiniOptional<z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<Date, string>>>;
+      }, z.core.$strip>>;
+      discussionId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+  }>;
+  readonly chat: RouteDefinition<"POST", "/chat", {
+    readonly body: z.ZodMiniObject<{
+      messages: z.ZodMiniArray<z.ZodMiniObject<{
+        role: z.ZodMiniEnum<{
+          assistant: "assistant";
+          system: "system";
+          user: "user";
+        }>;
+        content: z.ZodMiniString<string>;
+        timestamp: z.ZodMiniOptional<z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<Date, string>>>;
+      }, z.core.$strip>>;
+      discussionId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+  }>;
+  readonly autocomplete: RouteDefinition<"POST", "/autocomplete", {
+    readonly body: z.ZodMiniObject<{
+      aiOptions: z.ZodMiniOptional<z.ZodMiniCustom<AIOptions, AIOptions>>;
+      text: z.ZodMiniString<string>;
+      contextBefore: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      currentLine: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      contextAfter: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$strip>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          autocompletion: z.ZodMiniString<string>;
+        }, z.core.$strip>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly getDiscussions: RouteDefinition<"GET", "/discussions", {
+    readonly querystring: z.ZodMiniObject<{
+      page: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniNumber<number>]>>;
+      pageSize: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniNumber<number>]>>;
+      includeMessages: z.ZodMiniOptional<z.ZodMiniEnum<{
+        false: "false";
+        true: "true";
+      }>>;
+      ids: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
+      userId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      userIds: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
+      discussionId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      search: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      isArchived: z.ZodMiniOptional<z.ZodMiniEnum<{
+        false: "false";
+        true: "true";
+      }>>;
+      sortBy: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      sortOrder: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      fetchAll: z.ZodMiniOptional<z.ZodMiniEnum<{
+        false: "false";
+        true: "true";
+      }>>;
+    }, z.core.$loose>;
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniObject<{
+          id: z.ZodMiniString<string>;
+          discussionId: z.ZodMiniString<string>;
+          messages: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
+            role: z.ZodMiniEnum<{
+              assistant: "assistant";
+              system: "system";
+              user: "user";
+            }>;
+            content: z.ZodMiniString<string>;
+            relatedFiles: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+            timestamp: z.ZodMiniString<string>;
+          }, z.core.$strip>>>;
+          numberOfMessages: z.ZodMiniNumber<number>;
+          userId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          projectId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          organizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          title: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          type: z.ZodMiniOptional<z.ZodMiniEnum<{
+            dashboard: "dashboard";
+            doc: "doc";
+          }>>;
+          isArchived: z.ZodMiniBoolean<boolean>;
+          aiModel: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          tokenUsage: z.ZodMiniOptional<z.ZodMiniObject<{
+            inputTokens: z.ZodMiniNumber<number>;
+            outputTokens: z.ZodMiniNumber<number>;
+            totalTokens: z.ZodMiniNumber<number>;
+          }, z.core.$strip>>;
+          createdAt: z.ZodMiniString<string>;
+          updatedAt: z.ZodMiniString<string>;
+        }, z.core.$loose>>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+        page: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+        page_size: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+        total_pages: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+        total_items: z.ZodMiniNullable<z.ZodMiniNumber<number>>;
+      }, z.core.$strip>;
+    };
+  }>;
+  readonly getAIStats: RouteDefinition<"GET", "/stats", {
+    readonly response: {
+      200: z.ZodMiniObject<{
+        success: z.ZodMiniBoolean<boolean>;
+        status: z.ZodMiniNumber<number>;
+        message: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        data: z.ZodMiniNullable<z.ZodMiniObject<{
+          projectId: z.ZodMiniString<string>;
+          generatedAt: z.ZodMiniNumber<number>;
+          totalDiscussions: z.ZodMiniNumber<number>;
+          totalInputTokens: z.ZodMiniNumber<number>;
+          totalOutputTokens: z.ZodMiniNumber<number>;
+          totalTokens: z.ZodMiniNumber<number>;
+          modelUsage: z.ZodMiniArray<z.ZodMiniObject<{
+            aiModel: z.ZodMiniString<string>;
+            discussionCount: z.ZodMiniNumber<number>;
+            totalInputTokens: z.ZodMiniNumber<number>;
+            totalOutputTokens: z.ZodMiniNumber<number>;
+            totalTokens: z.ZodMiniNumber<number>;
+          }, z.core.$strip>>;
+        }, z.core.$strip>>;
+        error: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>, z.ZodMiniArray<z.ZodMiniObject<{
+          code: z.ZodMiniString<string>;
+          title: z.ZodMiniString<string>;
+          message: z.ZodMiniString<string>;
+        }, z.core.$loose>>]>>;
+      }, z.core.$strip>;
+    };
+  }>;
+}>;
+/** Route definitions of the `/api/ai` group, by name. */
+export type AIRoutes = (typeof aiContract)['routes'];
+/**
+ * Chat message as built by clients: `timestamp` may be a `Date` (serialized
+ * to an ISO string on the wire) or already a string.
+ */
+export type ChatCompletionRequestMessage = Omit<z.output<typeof chatCompletionRequestMessageSchema>, 'timestamp'> & {
+  timestamp?: Date | string;
+};
+export type DiscussionAPI = z.output<typeof discussionSchema>;
+export type AIStats = z.output<typeof aiStatsSchema>;
+export type CustomQueryBody = RouteBodyInput<AIRoutes['customQuery']>;
+export type CustomQueryResult = ResponseData<z.output<typeof fileContentResultSchema>>;
+export type TranslateJSONBody = RouteBodyInput<AIRoutes['translateJSON']>;
+export type TranslateJSONResult = ResponseData<{
+  fileContent: Record<string, unknown>;
+  tokenUsed: number;
+}>;
+export type AuditContentDeclarationBody = RouteBodyInput<AIRoutes['auditContentDeclaration']>;
+export type AuditContentDeclarationResult = ResponseData<z.output<typeof metadataResultSchema>>;
+export type AuditContentDeclarationFieldBody = RouteBodyInput<AIRoutes['auditContentDeclarationField']>;
+export type AuditContentDeclarationFieldResult = ResponseData<z.output<typeof fileContentResultSchema>>;
+export type AuditContentDeclarationMetadataBody = RouteBodyInput<AIRoutes['auditContentDeclarationMetadata']>;
+export type AuditContentDeclarationMetadataResult = ResponseData<z.output<typeof metadataResultSchema>>;
+export type AuditTagBody = RouteBodyInput<AIRoutes['auditTag']>;
+export type AuditTagResultData = z.output<typeof tagAuditResultSchema>;
+export type AuditTagResult = ResponseData<AuditTagResultData>;
+export type AskDocQuestionBody = RouteBodyInput<AIRoutes['ask']>;
+/** Final payload of the documentation assistant stream. */
+export type AskDocQuestionResult = ResponseData<{
+  response: string;
+  relatedFiles: string[];
+}>;
+export type ChatBody = RouteBodyInput<AIRoutes['chat']>;
+/** Final payload of the dashboard assistant stream. */
+export type ChatResult = ResponseData<{
+  response: string;
+  tokenUsage?: z.output<typeof tokenUsageSchema>;
+  aiModel?: string;
+}>;
+export type AutocompleteBody = RouteBodyInput<AIRoutes['autocomplete']>;
+export type AutocompleteResponse = ResponseData<{
+  autocompletion: string;
+}>;
+export type GetDiscussionsParams = RouteQuerystring<AIRoutes['getDiscussions']>;
+export type GetDiscussionsResult = PaginatedResponse<DiscussionAPI>;
+export type GetAIStatsResult = ResponseData<AIStats>;
+//#endregion
+//# sourceMappingURL=ai.d.ts.map

package/dist/types/ai.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai.d.ts","names":[],"sources":["../../src/ai.ts"],"mappings":";;;;;;;;;;;;YA+BY;EACV,cAAc;EACd;EACA;EACA;;EAEA;EACA;EACA;;qBAGW,iBAAe,EAAA,cAAA,WAAA;;qBAGf,oCAAkC,EAAA;;;;;;;;GAU7C,EAAA,KAAA;;cAMI,yBAAuB,EAAA;;;GAG3B,EAAA,KAAA;;cAGI,sBAAoB,EAAA;;;;;;;;GAQxB,EAAA,KAAA;cAEI,sBAAoB,EAAA;;;;;;;GAOxB,EAAA,KAAA;cAKI,kBAAgB,EAAA;;;;GAIpB,EAAA,KAAA;;qBAGW,yBAAuB,EAAA;;;;;;;;;GAKlC,EAAA,KAAA;;qBAGW,kBAAgB,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgB3B,EAAA,KAAA;;qBAGW,eAAa,EAAA;;;;;;;;;;;;;;GAgBxB,EAAA,KAAA;;qBAUW;wBAiBU;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;0BAoBV;;;;;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;oCAmBU;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;yCAgBA;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;4CASA;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;qBASA;;;;;;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBA4BV;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;2BAsBU;;;;;;;;;;;;;;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBAQA;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAOX,mBAAmB;;;;;YAMnB,+BAA+B,KACzC,EAAE,cAAc;EAEZ,YAAY;;YACN,gBAAgB,EAAE,cAAc;YAChC,UAAU,EAAE,cAAc;YAE1B,kBAAkB,eAAe;YACjC,oBAAoB,aAC9B,EAAE,cAAc;YAEN,oBAAoB,eAAe;YACnC,sBAAsB;EAChC,aAAa;EACb;;YAEU,8BAA8B,eACxC;YAEU,gCAAgC,aAC1C,EAAE,cAAc;YAEN,mCAAmC,eAC7C;YAEU,qCAAqC,aAC/C,EAAE,cAAc;YAEN,sCAAsC,eAChD;YAEU,wCAAwC,aAClD,EAAE,cAAc;YAEN,eAAe,eAAe;YAC9B,qBAAqB,EAAE,cAAc;YACrC,iBAAiB,aAAa;YAC9B,qBAAqB,eAAe;;YAEpC,uBAAuB;EACjC;EACA;;YAEU,WAAW,eAAe;;YAE1B,aAAa;EACvB;EACA,aAAa,EAAE,cAAc;EAC7B;;YAEU,mBAAmB,eAAe;YAClC,uBAAuB;EAAe;;YACtC,uBAAuB,iBAAiB;YACxC,uBAAuB,kBAAkB;YACzC,mBAAmB,aAAa"}