@intlayer/backend-contract 0.0.0-stage → 9.7.0

package/dist/types/dictionary.d.ts

@@ -0,0 +1,360 @@
+import { RouteBodyInput, RouteDefinition, RouteGroup, RouteParams, RouteQuerystring } from "./defineRoute.js";
+import { PaginatedResponse, ResponseData } from "./responseData.js";
+import { z } from "zod/mini";
+import { ContentNode, Dictionary } from "@intlayer/types/dictionary";
+//#region src/dictionary.d.ts
+/** Outcome of the last commit of a CMS edit to the source `.content` file. */
+export type DictionarySourceSync = {
+  status: 'committed' | 'pull-request' | 'up-to-date' | 'file-not-found' | 'unsupported' | 'error';
+  /** Commit (or pull request) link on the git provider. */
+  url?: string;
+  commitSha?: string;
+  message?: string;
+  syncedAt: string;
+};
+/** Fields the server adds to a stored dictionary. */
+type DictionaryServerFields = {
+  id: string;
+  projectIds: string[];
+  creatorId: string;
+  /** Content versions, oldest first. */
+  versionList: string[];
+  /** Environment the dictionary belongs to; null = shared by all. */
+  environmentId?: string | null;
+  sourceSync?: DictionarySourceSync;
+  createdAt: string;
+  updatedAt: string;
+};
+/**
+ * Dictionary as returned by the API: the `@intlayer/types` dictionary (the
+ * framework-wide source of truth for content) plus the server fields.
+ */
+export type DictionaryAPI = Omit<Dictionary, keyof DictionaryServerFields> & DictionaryServerFields;
+/** Dictionary as returned by the API (content documented as any JSON). */
+export declare const dictionarySchema: z.ZodMiniCustom<DictionaryAPI, DictionaryAPI>;
+/** Dictionary pushed by the CLI / editor (`@intlayer/types` shape). */
+export declare const localDictionarySchema: z.ZodMiniCustom<Dictionary, Dictionary>;
+/** Content node of a dictionary (`@intlayer/types`). */
+export declare const contentNodeSchema: z.ZodMiniCustom<ContentNode, ContentNode>;
+export declare const pushDictionariesResultSchema: z.ZodMiniObject<{
+  newDictionaries: z.ZodMiniArray<z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    localId: z.ZodMiniString<string>;
+    id: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  }, z.core.$strip>>;
+  updatedDictionaries: z.ZodMiniArray<z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    localId: z.ZodMiniString<string>;
+    id: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  }, z.core.$strip>>;
+  upToDateDictionaries: z.ZodMiniArray<z.ZodMiniObject<{
+    key: z.ZodMiniString<string>;
+    localId: z.ZodMiniString<string>;
+    id: z.ZodMiniOptional<z.ZodMiniString<string>>;
+  }, z.core.$strip>>;
+  error: z.ZodMiniArray<z.ZodMiniObject<{
+    id: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    key: z.ZodMiniString<string>;
+    localId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+    message: z.ZodMiniString<string>;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+/** REST contract of the `/api/dictionary` routes. */
+export declare const dictionaryContract: RouteGroup<"/api/dictionary", {
+  readonly getDictionaries: RouteDefinition<"GET", "/", {
+    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>]>>;
+      ids: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
+      projectId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      projectIds: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
+      organizationId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      organizationIds: 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>>]>>;
+      creatorId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      creatorIds: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
+      title: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      key: z.ZodMiniOptional<z.ZodMiniString<string>>;
+      keys: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
+      tags: z.ZodMiniOptional<z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniArray<z.ZodMiniString<string>>]>>;
+      location: z.ZodMiniOptional<z.ZodMiniEnum<{
+        both: "both";
+        local: "local";
+        none: "none";
+        remote: "remote";
+      }>>;
+    }, 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.ZodMiniCustom<DictionaryAPI, DictionaryAPI>>>;
+        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 getDictionariesKeys: RouteDefinition<"GET", "/keys", {
+    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.ZodMiniString<string>>>;
+        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 getDictionariesUpdateTimestamp: RouteDefinition<"GET", "/update", {
+    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.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniObject<{
+          key: z.ZodMiniString<string>;
+          updatedAt: 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>;
+    };
+  }>;
+  readonly getDictionariesByKeys: RouteDefinition<"GET", "/by-keys", {
+    readonly querystring: z.ZodMiniObject<{
+      keys: z.ZodMiniUnion<readonly [z.ZodMiniString<string>, z.ZodMiniArray<z.ZodMiniString<string>>]>;
+      version: 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.ZodMiniArray<z.ZodMiniCustom<DictionaryAPI, DictionaryAPI>>>;
+        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 getDictionary: RouteDefinition<"GET", "/:dictionaryKey", {
+    readonly params: z.ZodMiniObject<{
+      dictionaryKey: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    readonly querystring: z.ZodMiniObject<{
+      version: 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.ZodMiniCustom<DictionaryAPI, DictionaryAPI>>;
+        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 addDictionary: RouteDefinition<"POST", "/", {
+    readonly body: z.ZodMiniObject<{
+      dictionary: z.ZodMiniObject<{
+        key: z.ZodMiniString<string>;
+        projectIds: z.ZodMiniArray<z.ZodMiniString<string>>;
+        content: z.ZodMiniOptional<z.ZodMiniCustom<ContentNode, ContentNode>>;
+        title: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        description: z.ZodMiniOptional<z.ZodMiniString<string>>;
+        priority: z.ZodMiniOptional<z.ZodMiniNumber<number>>;
+        importMode: z.ZodMiniOptional<z.ZodMiniEnum<{
+          dynamic: "dynamic";
+          fetch: "fetch";
+          static: "static";
+        }>>;
+        tags: z.ZodMiniOptional<z.ZodMiniArray<z.ZodMiniString<string>>>;
+        environmentId: z.ZodMiniOptional<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.ZodMiniCustom<DictionaryAPI, DictionaryAPI>>;
+        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 pushDictionaries: RouteDefinition<"PATCH", "/", {
+    readonly body: z.ZodMiniObject<{
+      dictionaries: z.ZodMiniArray<z.ZodMiniCustom<Dictionary, Dictionary>>;
+    }, 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<{
+          newDictionaries: z.ZodMiniArray<z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            localId: z.ZodMiniString<string>;
+            id: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          }, z.core.$strip>>;
+          updatedDictionaries: z.ZodMiniArray<z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            localId: z.ZodMiniString<string>;
+            id: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          }, z.core.$strip>>;
+          upToDateDictionaries: z.ZodMiniArray<z.ZodMiniObject<{
+            key: z.ZodMiniString<string>;
+            localId: z.ZodMiniString<string>;
+            id: z.ZodMiniOptional<z.ZodMiniString<string>>;
+          }, z.core.$strip>>;
+          error: z.ZodMiniArray<z.ZodMiniObject<{
+            id: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            key: z.ZodMiniString<string>;
+            localId: z.ZodMiniOptional<z.ZodMiniString<string>>;
+            message: 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 updateDictionary: RouteDefinition<"PUT", "/:dictionaryId", {
+    readonly params: z.ZodMiniObject<{
+      dictionaryId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    readonly body: z.ZodMiniCustom<Partial<DictionaryAPI>, Partial<DictionaryAPI>>;
+    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.ZodMiniCustom<DictionaryAPI, DictionaryAPI>>;
+        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 deleteDictionary: RouteDefinition<"DELETE", "/:dictionaryId", {
+    readonly params: z.ZodMiniObject<{
+      dictionaryId: 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.ZodMiniCustom<DictionaryAPI, DictionaryAPI>>;
+        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/dictionary` group, by name. */
+export type DictionaryRoutes = (typeof dictionaryContract)['routes'];
+export type PushDictionariesResultData = z.output<typeof pushDictionariesResultSchema>;
+export type GetDictionariesParams = RouteQuerystring<DictionaryRoutes['getDictionaries']>;
+export type GetDictionariesResult = PaginatedResponse<DictionaryAPI>;
+export type GetDictionariesKeysResult = ResponseData<string[]>;
+export type GetDictionariesUpdateTimestampResult = ResponseData<Record<string, {
+  key: string;
+  updatedAt: number;
+}>>;
+export type GetDictionaryParams = RouteParams<DictionaryRoutes['getDictionary']>;
+export type GetDictionaryQuery = RouteQuerystring<DictionaryRoutes['getDictionary']>;
+export type GetDictionaryResult = ResponseData<DictionaryAPI>;
+export type GetDictionariesByKeysQuery = RouteQuerystring<DictionaryRoutes['getDictionariesByKeys']>;
+export type GetDictionariesByKeysResult = ResponseData<DictionaryAPI[]>;
+export type AddDictionaryBody = RouteBodyInput<DictionaryRoutes['addDictionary']>;
+export type AddDictionaryResult = ResponseData<DictionaryAPI>;
+export type PushDictionariesBody = RouteBodyInput<DictionaryRoutes['pushDictionaries']>;
+export type PushDictionariesResult = ResponseData<PushDictionariesResultData>;
+export type UpdateDictionaryParam = RouteParams<DictionaryRoutes['updateDictionary']>;
+export type UpdateDictionaryBody = RouteBodyInput<DictionaryRoutes['updateDictionary']>;
+export type UpdateDictionaryResult = ResponseData<DictionaryAPI>;
+export type DeleteDictionaryParam = RouteParams<DictionaryRoutes['deleteDictionary']>;
+export type DeleteDictionaryResult = ResponseData<DictionaryAPI>;
+//#endregion
+//# sourceMappingURL=dictionary.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dictionary.d.ts","names":[],"sources":["../../src/dictionary.ts"],"mappings":";;;;;;YAwBY;EACV;;EAQA;EACA;EACA;EACA;;;KAIG;EACH;EACA;EACA;;EAEA;;EAEA;EACA,aAAa;EACb;EACA;;;;;;YAOU,gBAAgB,KAAK,kBAAkB,0BACjD;;qBAOW,kBAAgB,EAAA,cAAA,eAAA;;qBAIhB,uBAAqB,EAAA,cAAA,YAAA;;qBAIrB,mBAAiB,EAAA,cAAA,aAAA;qBASjB,8BAA4B,EAAA;;;;;;;;;;;;;;;;;;;;;;GAYvC,EAAA,KAAA;;qBAKW;4BA2BU;;;;;;;;;;;;;;;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;gCAQA;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;2CASV;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;kCAmBU;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;0BAYA;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;0BAqBA;;;;;;;;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;6BASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;6BAUA;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;6BASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;YAOX,2BAA2B;YAE3B,6BAA6B,EAAE,cAClC;YAEG,wBAAwB,iBAClC;YAEU,wBAAwB,kBAAkB;YAC1C,4BAA4B;YAC5B,uCAAuC,aACjD;EAAiB;EAAa;;YAEpB,sBAAsB,YAChC;YAEU,qBAAqB,iBAC/B;YAEU,sBAAsB,aAAa;YACnC,6BAA6B,iBACvC;YAEU,8BAA8B,aAAa;YAC3C,oBAAoB,eAC9B;YAEU,sBAAsB,aAAa;YACnC,uBAAuB,eACjC;YAEU,yBAAyB,aAAa;YACtC,wBAAwB,YAClC;YAEU,uBAAuB,eACjC;YAEU,yBAAyB,aAAa;YACtC,wBAAwB,YAClC;YAEU,yBAAyB,aAAa"}

package/dist/types/environment.d.ts

@@ -0,0 +1,285 @@
+import { RouteBodyInput, RouteDefinition, RouteGroup, RouteParams } from "./defineRoute.js";
+import { ResponseData } from "./responseData.js";
+import { Locale } from "./intlayer/dist/types/index.js";
+import { EnvironmentAPI, ProjectConfigAI } from "./project.js";
+import { z } from "zod/mini";
+//#region src/environment.d.ts
+/** REST contract of the `/api/project/environment` routes. */
+export declare const environmentContract: RouteGroup<"/api/project/environment", {
+  readonly addEnvironment: RouteDefinition<"POST", "/", {
+    readonly body: z.ZodMiniObject<{
+      name: 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>>;
+    }, 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.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>>>;
+        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 updateEnvironment: RouteDefinition<"PUT", "/:environmentId", {
+    readonly params: z.ZodMiniObject<{
+      environmentId: z.ZodMiniString<string>;
+    }, z.core.$strip>;
+    readonly body: z.ZodMiniObject<{
+      name: z.ZodMiniOptional<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>>;
+    }, 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.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>>>;
+        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 deleteEnvironment: RouteDefinition<"DELETE", "/:environmentId", {
+    readonly params: z.ZodMiniObject<{
+      environmentId: 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.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>>>;
+        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 resetToProductionEnvironment: RouteDefinition<"PUT", "/production/select", {
+    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.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>>>;
+        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 selectEnvironment: RouteDefinition<"PUT", "/:environmentId/select", {
+    readonly params: z.ZodMiniObject<{
+      environmentId: 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<{
+          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>>;
+        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 migrateEnvironment: RouteDefinition<"POST", "/migrate", {
+    readonly body: z.ZodMiniObject<{
+      sourceEnvironmentId: z.ZodMiniString<string>;
+      targetEnvironmentId: z.ZodMiniString<string>;
+      strategy: z.ZodMiniEnum<{
+        "fill-missing": "fill-missing";
+        overwrite: "overwrite";
+      }>;
+      migrateContent: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+      migrateConfiguration: z.ZodMiniOptional<z.ZodMiniBoolean<boolean>>;
+    }, 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<{
+          migratedDictionaries: z.ZodMiniNumber<number>;
+          skippedDictionaries: z.ZodMiniNumber<number>;
+          configurationMigrated: z.ZodMiniBoolean<boolean>;
+        }, 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/project/environment` group, by name. */
+export type EnvironmentRoutes = (typeof environmentContract)['routes'];
+export type AddEnvironmentBody = RouteBodyInput<EnvironmentRoutes['addEnvironment']>;
+export type AddEnvironmentResult = ResponseData<EnvironmentAPI[]>;
+export type UpdateEnvironmentParams = RouteParams<EnvironmentRoutes['updateEnvironment']>;
+export type UpdateEnvironmentBody = RouteBodyInput<EnvironmentRoutes['updateEnvironment']>;
+export type UpdateEnvironmentResult = ResponseData<EnvironmentAPI[]>;
+export type DeleteEnvironmentParams = RouteParams<EnvironmentRoutes['deleteEnvironment']>;
+export type DeleteEnvironmentResult = ResponseData<EnvironmentAPI[]>;
+export type SelectEnvironmentParams = RouteParams<EnvironmentRoutes['selectEnvironment']>;
+export type SelectEnvironmentResult = ResponseData<EnvironmentAPI>;
+export type ResetToProductionEnvironmentResult = ResponseData<EnvironmentAPI | null>;
+export type MigrateEnvironmentBody = RouteBodyInput<EnvironmentRoutes['migrateEnvironment']>;
+export type MigrateEnvironmentResult = ResponseData<{
+  migratedDictionaries: number;
+  skippedDictionaries: number;
+  configurationMigrated: boolean;
+}>;
+//#endregion
+//# sourceMappingURL=environment.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"environment.d.ts","names":[],"sources":["../../src/environment.ts"],"mappings":";;;;;;;qBAuBa;2BAaU;;;;;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BAaA;;;;;;;;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yCAQA;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8BASA;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+BAiBV;;;;;;;;;;;;MAAH,KAAG,EAAA;;;;;;;;;;;;;;;;;;;;;;;;YAcD,4BAA4B;YAE5B,qBAAqB,eAC/B;YAEU,uBAAuB,aAAa;YACpC,0BAA0B,YACpC;YAEU,wBAAwB,eAClC;YAEU,0BAA0B,aAAa;YACvC,0BAA0B,YACpC;YAEU,0BAA0B,aAAa;YACvC,0BAA0B,YACpC;YAEU,0BAA0B,aAAa;YACvC,qCACV,aAAa;YACH,yBAAyB,eACnC;YAEU,2BAA2B;EACrC;EACA;EACA"}