@lokalise/content-type-app-engine-contracts 6.11.0 → 7.0.0

package/dist/schemas/env/envApiSchemas.d.ts

@@ -1,124 +1,95 @@
-import { z } from 'zod/v4';
-export declare const getEnvContract: import("@lokalise/api-contracts").GetRouteDefinition<z.ZodUnion<readonly [z.ZodObject<{
-    defaultLocale: z.ZodString;
-    locales: z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
-        code: z.ZodString;
-    }, z.core.$strip>>;
-    cacheItemStructure: z.ZodRecord<z.ZodString, z.ZodString>;
-    refreshTimestamp: z.ZodNumber;
-    features: z.ZodObject<{
-        showSkipEmptyOptionOnImport: z.ZodOptional<z.ZodBoolean>;
-        supportedImportTags: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            id: z.ZodString;
-            title: z.ZodString;
-        }, z.core.$strip>>>;
-        showImportExport: z.ZodOptional<z.ZodBoolean>;
-        showFieldSelection: z.ZodOptional<z.ZodBoolean>;
-        showIncludeReferencedEntriesOption: z.ZodOptional<z.ZodBoolean>;
-    }, z.core.$strip>;
-}, z.core.$strip>, z.ZodObject<{
-    statusCode: z.ZodNumber;
-    payload: z.ZodObject<{
-        message: z.ZodString;
-        code: z.ZodString;
-        errorCode: z.ZodString;
-        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    }, z.core.$strip>;
-}, z.core.$strip>]>, undefined, undefined, z.ZodObject<{
-    authorization: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>, undefined, false, false, {
-    200: z.ZodObject<{
-        defaultLocale: z.ZodString;
-        locales: z.ZodArray<z.ZodObject<{
-            name: z.ZodString;
-            code: z.ZodString;
-        }, z.core.$strip>>;
-        cacheItemStructure: z.ZodRecord<z.ZodString, z.ZodString>;
-        refreshTimestamp: z.ZodNumber;
-        features: z.ZodObject<{
-            showSkipEmptyOptionOnImport: z.ZodOptional<z.ZodBoolean>;
-            supportedImportTags: z.ZodOptional<z.ZodArray<z.ZodObject<{
-                id: z.ZodString;
-                title: z.ZodString;
-            }, z.core.$strip>>>;
-            showImportExport: z.ZodOptional<z.ZodBoolean>;
-            showFieldSelection: z.ZodOptional<z.ZodBoolean>;
-            showIncludeReferencedEntriesOption: z.ZodOptional<z.ZodBoolean>;
-        }, z.core.$strip>;
-    }, z.core.$strip>;
-    401: z.ZodObject<{
-        statusCode: z.ZodNumber;
-        payload: z.ZodObject<{
-            message: z.ZodString;
-            code: z.ZodString;
-            errorCode: z.ZodString;
-            details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-        }, z.core.$strip>;
-    }, z.core.$strip>;
-    500: z.ZodObject<{
-        statusCode: z.ZodNumber;
-        payload: z.ZodObject<{
-            message: z.ZodString;
-            code: z.ZodString;
-            errorCode: z.ZodString;
-            details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-        }, z.core.$strip>;
-    }, z.core.$strip>;
-}>;
-export declare const getEnvContractV2: import("@lokalise/api-contracts").GetRouteDefinition<z.ZodUnion<readonly [z.ZodObject<{
-    defaultLocale: z.ZodString;
-    locales: z.ZodArray<z.ZodObject<{
-        name: z.ZodString;
-        code: z.ZodString;
-    }, z.core.$strip>>;
-    refreshTimestamp: z.ZodNumber;
-    features: z.ZodObject<{
-        showSkipEmptyOptionOnImport: z.ZodOptional<z.ZodBoolean>;
-        supportedImportTags: z.ZodOptional<z.ZodArray<z.ZodObject<{
-            id: z.ZodString;
-            title: z.ZodString;
-        }, z.core.$strip>>>;
-        showImportExport: z.ZodOptional<z.ZodBoolean>;
-        showFieldSelection: z.ZodOptional<z.ZodBoolean>;
-        showIncludeReferencedEntriesOption: z.ZodOptional<z.ZodBoolean>;
-    }, z.core.$strip>;
-}, z.core.$strip>, z.ZodObject<{
-    message: z.ZodString;
-    code: z.ZodString;
-    errorCode: z.ZodString;
-    details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-}, z.core.$strip>]>, undefined, undefined, z.ZodObject<{
-    authorization: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>, undefined, false, false, {
-    200: z.ZodObject<{
-        defaultLocale: z.ZodString;
-        locales: z.ZodArray<z.ZodObject<{
-            name: z.ZodString;
-            code: z.ZodString;
-        }, z.core.$strip>>;
-        refreshTimestamp: z.ZodNumber;
-        features: z.ZodObject<{
-            showSkipEmptyOptionOnImport: z.ZodOptional<z.ZodBoolean>;
-            supportedImportTags: z.ZodOptional<z.ZodArray<z.ZodObject<{
-                id: z.ZodString;
-                title: z.ZodString;
-            }, z.core.$strip>>>;
-            showImportExport: z.ZodOptional<z.ZodBoolean>;
-            showFieldSelection: z.ZodOptional<z.ZodBoolean>;
-            showIncludeReferencedEntriesOption: z.ZodOptional<z.ZodBoolean>;
-        }, z.core.$strip>;
-    }, z.core.$strip>;
-    401: z.ZodObject<{
-        message: z.ZodString;
-        code: z.ZodString;
-        errorCode: z.ZodString;
-        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    }, z.core.$strip>;
-    500: z.ZodObject<{
-        message: z.ZodString;
-        code: z.ZodString;
-        errorCode: z.ZodString;
-        details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
-    }, z.core.$strip>;
-}>;
+export declare const getEnvContract: Omit<{
+    readonly visibility: "internal";
+    readonly method: "get";
+    readonly pathResolver: () => string;
+    readonly summary: "Get environment details";
+    readonly responsesByStatusCode: {
+        200: import("zod").ZodObject<{
+            defaultLocale: import("zod").ZodString;
+            locales: import("zod").ZodArray<import("zod").ZodObject<{
+                name: import("zod").ZodString;
+                code: import("zod").ZodString;
+            }, import("zod/v4/core").$strip>>;
+            cacheItemStructure: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodString>;
+            refreshTimestamp: import("zod").ZodNumber;
+            features: import("zod").ZodObject<{
+                showSkipEmptyOptionOnImport: import("zod").ZodOptional<import("zod").ZodBoolean>;
+                supportedImportTags: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+                    id: import("zod").ZodString;
+                    title: import("zod").ZodString;
+                }, import("zod/v4/core").$strip>>>;
+                showImportExport: import("zod").ZodOptional<import("zod").ZodBoolean>;
+                showFieldSelection: import("zod").ZodOptional<import("zod").ZodBoolean>;
+                showIncludeReferencedEntriesOption: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            }, import("zod/v4/core").$strip>;
+        }, import("zod/v4/core").$strip>;
+        '4xx': import("zod").ZodObject<{
+            statusCode: import("zod").ZodNumber;
+            payload: import("zod").ZodObject<{
+                message: import("zod").ZodString;
+                code: import("zod").ZodString;
+                errorCode: import("zod").ZodString;
+                details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
+            }, import("zod/v4/core").$strip>;
+        }, import("zod/v4/core").$strip>;
+        '5xx': import("zod").ZodObject<{
+            statusCode: import("zod").ZodNumber;
+            payload: import("zod").ZodObject<{
+                message: import("zod").ZodString;
+                code: import("zod").ZodString;
+                errorCode: import("zod").ZodString;
+                details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
+            }, import("zod/v4/core").$strip>;
+        }, import("zod/v4/core").$strip>;
+    };
+    readonly requestHeaderSchema: import("zod").ZodObject<{
+        authorization: import("zod").ZodOptional<import("zod").ZodString>;
+    }, import("zod/v4/core").$loose>;
+    readonly tags: string[];
+}, "visibility"> & {
+    visibility: import("@lokalise/api-contracts").RouteVisibility;
+};
+export declare const getEnvContractV2: Omit<{
+    readonly visibility: "internal";
+    readonly method: "get";
+    readonly pathResolver: () => string;
+    readonly summary: "Get environment details";
+    readonly responsesByStatusCode: {
+        200: import("zod").ZodObject<{
+            defaultLocale: import("zod").ZodString;
+            locales: import("zod").ZodArray<import("zod").ZodObject<{
+                name: import("zod").ZodString;
+                code: import("zod").ZodString;
+            }, import("zod/v4/core").$strip>>;
+            refreshTimestamp: import("zod").ZodNumber;
+            features: import("zod").ZodObject<{
+                showSkipEmptyOptionOnImport: import("zod").ZodOptional<import("zod").ZodBoolean>;
+                supportedImportTags: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
+                    id: import("zod").ZodString;
+                    title: import("zod").ZodString;
+                }, import("zod/v4/core").$strip>>>;
+                showImportExport: import("zod").ZodOptional<import("zod").ZodBoolean>;
+                showFieldSelection: import("zod").ZodOptional<import("zod").ZodBoolean>;
+                showIncludeReferencedEntriesOption: import("zod").ZodOptional<import("zod").ZodBoolean>;
+            }, import("zod/v4/core").$strip>;
+        }, import("zod/v4/core").$strip>;
+        '4xx': import("zod").ZodObject<{
+            message: import("zod").ZodString;
+            code: import("zod").ZodString;
+            errorCode: import("zod").ZodString;
+            details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
+        }, import("zod/v4/core").$strip>;
+        '5xx': import("zod").ZodObject<{
+            message: import("zod").ZodString;
+            code: import("zod").ZodString;
+            errorCode: import("zod").ZodString;
+            details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
+        }, import("zod/v4/core").$strip>;
+    };
+    readonly requestHeaderSchema: import("zod").ZodObject<{
+        authorization: import("zod").ZodOptional<import("zod").ZodString>;
+    }, import("zod/v4/core").$loose>;
+    readonly tags: string[];
+}, "visibility"> & {
+    visibility: import("@lokalise/api-contracts").RouteVisibility;
+};

package/dist/schemas/env/envApiSchemas.js

@@ -1,30 +1,33 @@
-import { buildGetRoute } from '@lokalise/api-contracts';
-import { z } from 'zod/v4';
+import { defineApiContract } from '@lokalise/api-contracts';
 import { AUTHORIZATION_HEADER_SCHEMA, COMMON_ERROR_RESPONSE_SCHEMA, COMMON_ERROR_RESPONSE_SCHEMA_V2, } from '../commonRequestSchemas.js';
 import { GET_ENV_RESPONSE_SCHEMA, GET_ENV_RESPONSE_SCHEMA_V2 } from './envSchemas.js';
 const tags = ['Env'];
-export const getEnvContract = buildGetRoute({
+export const getEnvContract = defineApiContract({
     visibility: 'internal',
+    method: 'get',
     pathResolver: () => '/v1/env',
-    description: 'Get environment details',
-    successResponseBodySchema: z.union([GET_ENV_RESPONSE_SCHEMA, COMMON_ERROR_RESPONSE_SCHEMA]),
-    responseSchemasByStatusCode: {
+    summary: 'Get environment details',
+    responsesByStatusCode: {
         200: GET_ENV_RESPONSE_SCHEMA,
-        401: COMMON_ERROR_RESPONSE_SCHEMA,
-        500: COMMON_ERROR_RESPONSE_SCHEMA,
+        // 401 from auth, 500 when no env could be read, and a failing connector call is relayed
+        // with the status the connector answered.
+        '4xx': COMMON_ERROR_RESPONSE_SCHEMA,
+        '5xx': COMMON_ERROR_RESPONSE_SCHEMA,
     },
     requestHeaderSchema: AUTHORIZATION_HEADER_SCHEMA,
     tags,
 });
-export const getEnvContractV2 = buildGetRoute({
+export const getEnvContractV2 = defineApiContract({
     visibility: 'internal',
+    method: 'get',
     pathResolver: () => '/v2/env',
-    description: 'Get environment details',
-    successResponseBodySchema: z.union([GET_ENV_RESPONSE_SCHEMA_V2, COMMON_ERROR_RESPONSE_SCHEMA_V2]),
-    responseSchemasByStatusCode: {
+    summary: 'Get environment details',
+    responsesByStatusCode: {
         200: GET_ENV_RESPONSE_SCHEMA_V2,
-        401: COMMON_ERROR_RESPONSE_SCHEMA_V2,
-        500: COMMON_ERROR_RESPONSE_SCHEMA_V2,
+        // 401 from auth, 500 when no env could be read, and a failing connector call or a public
+        // error is relayed with its own status.
+        '4xx': COMMON_ERROR_RESPONSE_SCHEMA_V2,
+        '5xx': COMMON_ERROR_RESPONSE_SCHEMA_V2,
     },
     requestHeaderSchema: AUTHORIZATION_HEADER_SCHEMA,
     tags,

package/dist/schemas/env/envApiSchemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"envApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/env/envApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,+BAA+B,GAChC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,uBAAuB,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAA;AAErF,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;AAEpB,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;IAC1C,UAAU,EAAE,UAAU;IACtB,YAAY,EAAE,GAAG,EAAE,CAAC,SAAS;IAC7B,WAAW,EAAE,yBAAyB;IACtC,yBAAyB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,uBAAuB,EAAE,4BAA4B,CAAC,CAAC;IAC3F,2BAA2B,EAAE;QAC3B,GAAG,EAAE,uBAAuB;QAC5B,GAAG,EAAE,4BAA4B;QACjC,GAAG,EAAE,4BAA4B;KAClC;IACD,mBAAmB,EAAE,2BAA2B;IAChD,IAAI;CACL,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAAC;IAC5C,UAAU,EAAE,UAAU;IACtB,YAAY,EAAE,GAAG,EAAE,CAAC,SAAS;IAC7B,WAAW,EAAE,yBAAyB;IACtC,yBAAyB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,0BAA0B,EAAE,+BAA+B,CAAC,CAAC;IACjG,2BAA2B,EAAE;QAC3B,GAAG,EAAE,0BAA0B;QAC/B,GAAG,EAAE,+BAA+B;QACpC,GAAG,EAAE,+BAA+B;KACrC;IACD,mBAAmB,EAAE,2BAA2B;IAChD,IAAI;CACL,CAAC,CAAA"}
+{"version":3,"file":"envApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/env/envApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,+BAA+B,GAChC,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,uBAAuB,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAA;AAErF,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,CAAA;AAEpB,MAAM,CAAC,MAAM,cAAc,GAAG,iBAAiB,CAAC;IAC9C,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,GAAG,EAAE,CAAC,SAAS;IAC7B,OAAO,EAAE,yBAAyB;IAClC,qBAAqB,EAAE;QACrB,GAAG,EAAE,uBAAuB;QAC5B,wFAAwF;QACxF,0CAA0C;QAC1C,KAAK,EAAE,4BAA4B;QACnC,KAAK,EAAE,4BAA4B;KACpC;IACD,mBAAmB,EAAE,2BAA2B;IAChD,IAAI;CACL,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;IAChD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,GAAG,EAAE,CAAC,SAAS;IAC7B,OAAO,EAAE,yBAAyB;IAClC,qBAAqB,EAAE;QACrB,GAAG,EAAE,0BAA0B;QAC/B,yFAAyF;QACzF,wCAAwC;QACxC,KAAK,EAAE,+BAA+B;QACtC,KAAK,EAAE,+BAA+B;KACvC;IACD,mBAAmB,EAAE,2BAA2B;IAChD,IAAI;CACL,CAAC,CAAA"}