@intlayer/backend-contract 0.0.0-stage → 9.7.0

package/dist/types/search.d.ts

@@ -0,0 +1,55 @@
+import { RouteDefinition, RouteGroup, RouteQuerystring } from "./defineRoute.js";
+import { ResponseData } from "./responseData.js";
+import { z } from "zod/mini";
+//#region src/search.d.ts
+/** One documentation chunk matching a search. */
+export declare const searchDocResultSchema: z.ZodMiniObject<{
+  fileKey: z.ZodMiniString<string>;
+  chunkNumber: z.ZodMiniNumber<number>;
+  content: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  docUrl: z.ZodMiniString<string>;
+  docName: z.ZodMiniString<string>;
+  priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+}, z.core.$strip>;
+/** REST contract of the `/api/search` routes. */
+export declare const searchContract: RouteGroup<"/api/search", {
+  readonly doc: RouteDefinition<"GET", "/doc", {
+    readonly querystring: z.ZodMiniObject<{
+      input: z.ZodMiniString<string>;
+      limit: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      returnContent: 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.ZodMiniUnion<readonly [z.ZodMiniArray<z.ZodMiniString<string>>, z.ZodMiniArray<z.ZodMiniObject<{
+          fileKey: z.ZodMiniString<string>;
+          chunkNumber: z.ZodMiniNumber<number>;
+          content: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          docUrl: z.ZodMiniString<string>;
+          docName: z.ZodMiniString<string>;
+          priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+        }, 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/search` group, by name. */
+export type SearchRoutes = (typeof searchContract)['routes'];
+export type SearchDocResult = z.output<typeof searchDocResultSchema>;
+export type SearchDocUtilParams = RouteQuerystring<SearchRoutes['doc']>;
+export type SearchDocUtilResult = ResponseData<string[] | SearchDocResult[]>;
+//#endregion
+//# sourceMappingURL=search.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","names":[],"sources":["../../src/search.ts"],"mappings":";;;;;qBASa,uBAAqB,EAAA;;;;;;;GAQhC,EAAA,KAAA;;qBAGW;gBAgBA;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;YAUD,uBAAuB;YAEvB,kBAAkB,EAAE,cAAc;YAClC,sBAAsB,iBAAiB;YACvC,sBAAsB,wBAAwB"}

package/dist/types/session.d.ts

@@ -0,0 +1,286 @@
+import { ProjectConfigAI } from "./project.js";
+import { Locale } from "@intlayer/types/allLocales";
+import { z } from "zod/mini";
+//#region src/session.d.ts
+/** Named groupings of privileges granted to a user. */
+export declare const rolesSchema: z.ZodMiniEnum<{
+  admin: "admin";
+  org_admin: "org_admin";
+  org_user: "org_user";
+  project_admin: "project_admin";
+  project_reviewer: "project_reviewer";
+  project_user: "project_user";
+  user: "user";
+}>;
+/** Protected resources and the actions performed on them. */
+type Resource = 'organization' | 'project' | 'dictionary' | 'tag' | 'user';
+type Action = 'read' | 'write' | 'admin';
+/** `resource:action` unit checked at runtime (ex: `project:write`). */
+export type Permission = `${Resource}:${Action}`;
+/** better-auth session record (token excluded from the API shape). */
+export declare const sessionDataSchema: z.ZodMiniObject<{
+  id: z.ZodMiniString<string>;
+  userId: z.ZodMiniString<string>;
+  expiresAt: z.ZodMiniString<string>;
+  createdAt: z.ZodMiniString<string>;
+  updatedAt: z.ZodMiniString<string>;
+  ipAddress: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+  userAgent: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+  activeOrganizationId: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+  activeProjectId: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+  activeEnvironmentId: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+  locale: z.ZodMiniOptional<z.ZodMiniCustom<Locale, Locale>>;
+}, z.core.$loose>;
+/** Session as returned to the dashboard (`get-session`). */
+export declare const sessionSchema: z.ZodMiniObject<{
+  session: z.ZodMiniObject<{
+    id: z.ZodMiniString<string>;
+    userId: z.ZodMiniString<string>;
+    expiresAt: z.ZodMiniString<string>;
+    createdAt: z.ZodMiniString<string>;
+    updatedAt: z.ZodMiniString<string>;
+    ipAddress: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+    userAgent: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+    activeOrganizationId: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+    activeProjectId: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+    activeEnvironmentId: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+    locale: z.ZodMiniOptional<z.ZodMiniCustom<Locale, Locale>>;
+  }, z.core.$loose>;
+  user: z.ZodMiniObject<{
+    id: z.ZodMiniString<string>;
+    email: z.ZodMiniString<string>;
+    emailVerified: z.ZodMiniBoolean<boolean>;
+    name: z.ZodMiniString<string>;
+    image: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+    phone: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    dateOfBirth: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    emailsList: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniEnum<{
+      newsLetter: "newsLetter";
+    }> & z.core.$partial, z.ZodMiniBoolean<boolean>>>;
+    customerId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    role: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+    lastLoginMethod: z.ZodMiniOptional<z.ZodMiniEnum<{
+      email: "email";
+      github: "github";
+      google: "google";
+      passkey: "passkey";
+    }>>;
+    lang: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    lastActiveOrganizationId: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+    lastActiveProjectId: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+    createdAt: z.ZodMiniString<string>;
+    updatedAt: z.ZodMiniString<string>;
+  }, z.core.$loose>;
+  organization: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniObject<{
+    id: z.ZodMiniString<string>;
+    name: z.ZodMiniString<string>;
+    membersIds: z.ZodMiniArray<z.ZodMiniString<string>>;
+    adminsIds: z.ZodMiniArray<z.ZodMiniString<string>>;
+    ssoEnabled: z.ZodMiniBoolean<boolean>;
+    domain: z.ZodMiniString<string>;
+    mailerConfig: z.ZodMiniOptional<z.ZodMiniObject<{
+      isActive: z.ZodMiniBoolean<boolean>;
+      provider: z.ZodMiniEnum<{
+        resend: "resend";
+        smtp: "smtp";
+      }>;
+      fromName: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      fromEmail: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      resend: z.ZodMiniOptional<z.ZodMiniObject<{
+        hasApiKey: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+      }, z.core.$strip>>;
+      smtp: z.ZodMiniOptional<z.ZodMiniObject<{
+        host: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        port: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+        secure: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+        user: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        hasPassword: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+      }, z.core.$strip>>;
+    }, z.core.$strip>>;
+    creatorId: z.ZodMiniString<string>;
+    plan: z.ZodMiniOptional<z.ZodMiniObject<{
+      id: z.ZodMiniString<string>;
+      type: z.ZodMiniEnum<{
+        ENTERPRISE: "ENTERPRISE";
+        FREE: "FREE";
+        LIFETIME: "LIFETIME";
+        PREMIUM: "PREMIUM";
+      }>;
+      creatorId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      subscriptionId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      customerId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      priceId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      status: z.ZodMiniOptional<z.ZodMiniEnum<{
+        active: "active";
+        canceled: "canceled";
+        incomplete: "incomplete";
+        incomplete_expired: "incomplete_expired";
+        past_due: "past_due";
+        paused: "paused";
+        trialing: "trialing";
+        unpaid: "unpaid";
+      }>>;
+      period: z.ZodMiniOptional<z.ZodMiniEnum<{
+        LIFETIME: "LIFETIME";
+        MONTHLY: "MONTHLY";
+        YEARLY: "YEARLY";
+      }>>;
+      createdAt: z.ZodMiniString<string>;
+      updatedAt: z.ZodMiniString<string>;
+    }, z.core.$loose>>;
+    createdAt: z.ZodMiniString<string>;
+    updatedAt: z.ZodMiniString<string>;
+  }, z.core.$loose>>>;
+  project: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniObject<{
+    id: z.ZodMiniString<string>;
+    organizationId: z.ZodMiniString<string>;
+    name: z.ZodMiniString<string>;
+    membersIds: z.ZodMiniArray<z.ZodMiniString<string>>;
+    adminsIds: z.ZodMiniArray<z.ZodMiniString<string>>;
+    viewersIds: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+    memberAccess: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
+      userId: z.ZodMiniString<string>;
+      allowedEnvironmentIds: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniNullable<z.ZodMiniString<string>>>>;
+      allowedLocales: z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniCustom<Locale, Locale>>>;
+    }, z.core.$strip>>>;
+    creatorId: z.ZodMiniString<string>;
+    configuration: z.ZodMiniOptional<z.ZodMiniObject<{
+      internationalization: z.ZodMiniOptional<z.ZodMiniObject<{
+        locales: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniCustom<Locale, Locale>>>;
+        defaultLocale: z.ZodMiniOptional<z.ZodMiniCustom<Locale, Locale>>;
+      }, z.core.$loose>>;
+      editor: z.ZodMiniOptional<z.ZodMiniObject<{
+        applicationURL: z.ZodMiniOptional<z.ZodMiniCustom<import("@intlayer/types").URLType, import("@intlayer/types").URLType>>;
+        cmsURL: z.ZodMiniOptional<z.ZodMiniCustom<import("@intlayer/types").URLType, import("@intlayer/types").URLType>>;
+      }, z.core.$loose>>;
+      ai: z.ZodMiniOptional<z.ZodMiniCustom<ProjectConfigAI, ProjectConfigAI>>;
+    }, z.core.$loose>>;
+    repository: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniDiscriminatedUnion<[z.ZodMiniObject<{
+      owner: z.ZodMiniString<string>;
+      repository: z.ZodMiniString<string>;
+      branch: z.ZodMiniString<string>;
+      url: z.ZodMiniString<string>;
+      configFilePath: z.ZodMiniString<string>;
+      provider: z.ZodMiniLiteral<"github">;
+      installationId: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+    }, z.core.$loose>, z.ZodMiniObject<{
+      owner: z.ZodMiniString<string>;
+      repository: z.ZodMiniString<string>;
+      branch: z.ZodMiniString<string>;
+      url: z.ZodMiniString<string>;
+      configFilePath: z.ZodMiniString<string>;
+      provider: z.ZodMiniLiteral<"gitlab">;
+      projectId: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+      instanceUrl: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$loose>, z.ZodMiniObject<{
+      owner: z.ZodMiniString<string>;
+      repository: z.ZodMiniString<string>;
+      branch: z.ZodMiniString<string>;
+      url: z.ZodMiniString<string>;
+      configFilePath: z.ZodMiniString<string>;
+      provider: z.ZodMiniLiteral<"bitbucket">;
+      workspace: z.ZodMiniString<string>;
+    }, z.core.$loose>, z.ZodMiniObject<{
+      owner: z.ZodMiniString<string>;
+      repository: z.ZodMiniString<string>;
+      branch: z.ZodMiniString<string>;
+      url: z.ZodMiniString<string>;
+      configFilePath: z.ZodMiniString<string>;
+      provider: z.ZodMiniLiteral<"codeberg">;
+    }, z.core.$loose>, z.ZodMiniObject<{
+      owner: z.ZodMiniString<string>;
+      repository: z.ZodMiniString<string>;
+      branch: z.ZodMiniString<string>;
+      url: z.ZodMiniString<string>;
+      configFilePath: z.ZodMiniString<string>;
+      provider: z.ZodMiniLiteral<"gitee">;
+    }, z.core.$loose>], "provider">>>;
+    webhooks: z.ZodMiniOptional<z.ZodMiniObject<{
+      autoTriggerBuilds: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+      autoCommitDictionaries: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+      webhooks: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
+        id: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        name: z.ZodMiniString<string>;
+        url: z.ZodMiniString<string>;
+        enabled: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+        secret: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      }, z.core.$loose>>>;
+    }, z.core.$strip>>;
+    autoFill: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+    imageUrl: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    environments: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniObject<{
+      id: z.ZodMiniString<string>;
+      name: z.ZodMiniString<string>;
+      isDefault: z.ZodMiniBoolean<boolean>;
+      configuration: z.ZodMiniOptional<z.ZodMiniObject<{
+        internationalization: z.ZodMiniOptional<z.ZodMiniObject<{
+          locales: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniCustom<Locale, Locale>>>;
+          defaultLocale: z.ZodMiniOptional<z.ZodMiniCustom<Locale, Locale>>;
+        }, z.core.$loose>>;
+        editor: z.ZodMiniOptional<z.ZodMiniObject<{
+          applicationURL: z.ZodMiniOptional<z.ZodMiniCustom<import("@intlayer/types").URLType, import("@intlayer/types").URLType>>;
+          cmsURL: z.ZodMiniOptional<z.ZodMiniCustom<import("@intlayer/types").URLType, import("@intlayer/types").URLType>>;
+        }, z.core.$loose>>;
+        ai: z.ZodMiniOptional<z.ZodMiniCustom<ProjectConfigAI, ProjectConfigAI>>;
+      }, z.core.$loose>>;
+      createdAt: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      updatedAt: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    }, z.core.$loose>>>;
+    oAuth2Access: z.ZodMiniArray<z.ZodMiniObject<{
+      id: z.ZodMiniString<string>;
+      name: z.ZodMiniString<string>;
+      clientId: z.ZodMiniString<string>;
+      clientSecret: z.ZodMiniString<string>;
+      grants: z.ZodMiniArray<z.ZodMiniString<string>>;
+      userId: z.ZodMiniString<string>;
+      expiresAt: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniString<string>>>;
+      allowedEnvironmentIds: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniNullable<z.ZodMiniString<string>>>>>;
+      allowedLocales: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniCustom<Locale, Locale>>>>;
+      createdAt: z.ZodMiniString<string>;
+      updatedAt: z.ZodMiniString<string>;
+    }, z.core.$loose>>;
+    createdAt: z.ZodMiniString<string>;
+    updatedAt: z.ZodMiniString<string>;
+  }, z.core.$loose>>>;
+  environment: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniObject<{
+    id: z.ZodMiniString<string>;
+    name: z.ZodMiniString<string>;
+    isDefault: z.ZodMiniBoolean<boolean>;
+    configuration: z.ZodMiniOptional<z.ZodMiniObject<{
+      internationalization: z.ZodMiniOptional<z.ZodMiniObject<{
+        locales: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniCustom<Locale, Locale>>>;
+        defaultLocale: z.ZodMiniOptional<z.ZodMiniCustom<Locale, Locale>>;
+      }, z.core.$loose>>;
+      editor: z.ZodMiniOptional<z.ZodMiniObject<{
+        applicationURL: z.ZodMiniOptional<z.ZodMiniCustom<import("@intlayer/types").URLType, import("@intlayer/types").URLType>>;
+        cmsURL: z.ZodMiniOptional<z.ZodMiniCustom<import("@intlayer/types").URLType, import("@intlayer/types").URLType>>;
+      }, z.core.$loose>>;
+      ai: z.ZodMiniOptional<z.ZodMiniCustom<ProjectConfigAI, ProjectConfigAI>>;
+    }, z.core.$loose>>;
+    createdAt: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    updatedAt: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  }, z.core.$loose>>>;
+  id: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  permissions: z.ZodMiniArray<z.ZodMiniCustom<"dictionary:admin" | "dictionary:read" | "dictionary:write" | "organization:admin" | "organization:read" | "organization:write" | "project:admin" | "project:read" | "project:write" | "tag:admin" | "tag:read" | "tag:write" | "user:admin" | "user:read" | "user:write", "dictionary:admin" | "dictionary:read" | "dictionary:write" | "organization:admin" | "organization:read" | "organization:write" | "project:admin" | "project:read" | "project:write" | "tag:admin" | "tag:read" | "tag:write" | "user:admin" | "user:read" | "user:write">>;
+  roles: z.ZodMiniArray<z.ZodMiniEnum<{
+    admin: "admin";
+    org_admin: "org_admin";
+    org_user: "org_user";
+    project_admin: "project_admin";
+    project_reviewer: "project_reviewer";
+    project_user: "project_user";
+    user: "user";
+  }>>;
+  authType: z.ZodMiniNullable<z.ZodMiniEnum<{
+    oauth2: "oauth2";
+    session: "session";
+  }>>;
+  locale: z.ZodMiniOptional<z.ZodMiniCustom<Locale, Locale>>;
+  allowedEnvironmentIds: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniNullable<z.ZodMiniString<string>>>>>;
+  allowedLocales: z.ZodMiniOptional<z.ZodMiniNullable<z.ZodMiniArray<z.ZodMiniCustom<Locale, Locale>>>>;
+}, z.core.$loose>;
+export type Roles = z.output<typeof rolesSchema>;
+export type SessionDataAPI = z.output<typeof sessionDataSchema>;
+export type SessionAPI = z.output<typeof sessionSchema>;
+//#endregion
+//# sourceMappingURL=session.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"session.d.ts","names":[],"sources":["../../src/session.ts"],"mappings":";;;;;qBAQa,aAAW,EAAA;;;;;;;;;;KAWnB;KACA;;YAGO,gBAAgB,YAAY;;qBAK3B,mBAAiB,EAAA;;;;;;;;;;;;GAY5B,EAAA,KAAA;;qBAGW,eAAa,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAexB,EAAA,KAAA;YAEU,QAAQ,EAAE,cAAc;YACxB,iBAAiB,EAAE,cAAc;YACjC,aAAa,EAAE,cAAc"}