@lokalise/content-exchange-schemas 3.0.0 → 3.2.0

package/dist/api/routeContracts/exportProcessContracts.d.ts

@@ -1,5 +1,5 @@
 export declare const getExportProcessDetailsContract: Omit<{
-    readonly visibility: "internal";
+    readonly visibility: "public";
     readonly requestPathParamsSchema: import("zod/v4").ZodObject<{
         projectId: import("zod/v4").ZodGUID;
         exportProcessId: import("zod/v4").ZodGUID;
@@ -18,6 +18,7 @@ export declare const getExportProcessDetailsContract: Omit<{
                     readonly COMPLETED: "completed";
                     readonly FAILED: "failed";
                 }>;
+                failReason: import("zod/v4").ZodOptional<import("zod/v4").ZodNullable<import("zod/v4").ZodString>>;
             }, import("zod/v4/core").$strip>;
         }, import("zod/v4/core").$strip>;
         readonly 400: import("zod/v4").ZodObject<{
@@ -37,3 +38,44 @@ export declare const getExportProcessDetailsContract: Omit<{
 }, "visibility"> & {
     visibility: import("@lokalise/api-contracts").RouteVisibility;
 };
+export declare const getExportProcessDownloadUrlContract: Omit<{
+    readonly visibility: "public";
+    readonly requestPathParamsSchema: import("zod/v4").ZodObject<{
+        projectId: import("zod/v4").ZodGUID;
+        exportProcessId: import("zod/v4").ZodGUID;
+    }, import("zod/v4/core").$strip>;
+    readonly pathResolver: ({ projectId, exportProcessId }: {
+        projectId: string;
+        exportProcessId: string;
+    }) => string;
+    readonly summary: "Get export download link";
+    readonly description: "Returns a time-limited link to download the file of a completed export. Call it once the export process status is completed. Responds 409 while the export is still running and 404 if the export is not found in this project or did not produce a downloadable file.";
+    readonly method: "get";
+    readonly responsesByStatusCode: {
+        readonly 200: import("zod/v4").ZodObject<{
+            data: import("zod/v4").ZodObject<{
+                downloadUrl: import("zod/v4").ZodURL;
+            }, import("zod/v4/core").$strip>;
+        }, import("zod/v4/core").$strip>;
+        readonly 400: import("zod/v4").ZodObject<{
+            message: import("zod/v4").ZodString;
+            errorCode: import("zod/v4").ZodString;
+            details: import("zod/v4").ZodOptional<import("zod/v4").ZodAny>;
+        }, import("zod/v4/core").$strip>;
+        readonly 404: import("zod/v4").ZodObject<{
+            message: import("zod/v4").ZodString;
+            errorCode: import("zod/v4").ZodString;
+            details: import("zod/v4").ZodOptional<import("zod/v4").ZodAny>;
+        }, import("zod/v4/core").$strip>;
+        readonly 409: import("zod/v4").ZodObject<{
+            message: import("zod/v4").ZodString;
+            errorCode: import("zod/v4").ZodString;
+            details: import("zod/v4").ZodOptional<import("zod/v4").ZodAny>;
+        }, import("zod/v4/core").$strip>;
+    };
+    readonly requestHeaderSchema: import("zod/v4").ZodObject<{
+        authorization: import("zod/v4").ZodString;
+    }, import("zod/v4/core").$strip>;
+}, "visibility"> & {
+    visibility: import("@lokalise/api-contracts").RouteVisibility;
+};

package/dist/api/routeContracts/exportProcessContracts.js

@@ -1,9 +1,9 @@
 import { COMMON_ERROR_RESPONSE_SCHEMA } from '@lokalise/api-common';
 import { defineApiContract } from '@lokalise/api-contracts';
 import { AUTHORIZATION_HEADER_SCHEMA } from "../schemas/commonSchemas.js";
-import { GET_EXPORT_PROCESS_DETAILS_PATH_PARAMS_SCHEMA, GET_EXPORT_PROCESS_DETAILS_RESPONSE_SCHEMA, } from "../schemas/exportProcessSchemas.js";
+import { GET_EXPORT_PROCESS_DETAILS_PATH_PARAMS_SCHEMA, GET_EXPORT_PROCESS_DETAILS_RESPONSE_SCHEMA, GET_EXPORT_PROCESS_DOWNLOAD_URL_RESPONSE_SCHEMA, } from "../schemas/exportProcessSchemas.js";
 export const getExportProcessDetailsContract = defineApiContract({
-    visibility: 'internal',
+    visibility: 'public',
     requestPathParamsSchema: GET_EXPORT_PROCESS_DETAILS_PATH_PARAMS_SCHEMA,
     pathResolver: ({ projectId, exportProcessId }) => `/v1/projects/${projectId}/export-processes/${exportProcessId}`,
     summary: 'Get export process details',
@@ -15,4 +15,19 @@ export const getExportProcessDetailsContract = defineApiContract({
     },
     requestHeaderSchema: AUTHORIZATION_HEADER_SCHEMA,
 });
+export const getExportProcessDownloadUrlContract = defineApiContract({
+    visibility: 'public',
+    requestPathParamsSchema: GET_EXPORT_PROCESS_DETAILS_PATH_PARAMS_SCHEMA,
+    pathResolver: ({ projectId, exportProcessId }) => `/v1/projects/${projectId}/export-processes/${exportProcessId}/download-url`,
+    summary: 'Get export download link',
+    description: 'Returns a time-limited link to download the file of a completed export. Call it once the export process status is completed. Responds 409 while the export is still running and 404 if the export is not found in this project or did not produce a downloadable file.',
+    method: 'get',
+    responsesByStatusCode: {
+        200: GET_EXPORT_PROCESS_DOWNLOAD_URL_RESPONSE_SCHEMA,
+        400: COMMON_ERROR_RESPONSE_SCHEMA,
+        404: COMMON_ERROR_RESPONSE_SCHEMA,
+        409: COMMON_ERROR_RESPONSE_SCHEMA,
+    },
+    requestHeaderSchema: AUTHORIZATION_HEADER_SCHEMA,
+});
 //# sourceMappingURL=exportProcessContracts.js.map

package/dist/api/routeContracts/exportProcessContracts.js.map

@@ -1 +1 @@
-{"version":3,"file":"exportProcessContracts.js","sourceRoot":"","sources":["../../../src/api/routeContracts/exportProcessContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAA;AACzE,OAAO,EACL,6CAA6C,EAC7C,0CAA0C,GAC3C,MAAM,oCAAoC,CAAA;AAE3C,MAAM,CAAC,MAAM,+BAA+B,GAAG,iBAAiB,CAAC;IAC/D,UAAU,EAAE,UAAU;IACtB,uBAAuB,EAAE,6CAA6C;IACtE,YAAY,EAAE,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,EAAE,EAAE,CAC/C,gBAAgB,SAAS,qBAAqB,eAAe,EAAE;IACjE,OAAO,EAAE,4BAA4B;IACrC,MAAM,EAAE,KAAK;IACb,qBAAqB,EAAE;QACrB,GAAG,EAAE,0CAA0C;QAC/C,GAAG,EAAE,4BAA4B;QACjC,GAAG,EAAE,4BAA4B;KAClC;IACD,mBAAmB,EAAE,2BAA2B;CACjD,CAAC,CAAA"}
+{"version":3,"file":"exportProcessContracts.js","sourceRoot":"","sources":["../../../src/api/routeContracts/exportProcessContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,sBAAsB,CAAA;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,2BAA2B,EAAE,MAAM,6BAA6B,CAAA;AACzE,OAAO,EACL,6CAA6C,EAC7C,0CAA0C,EAC1C,+CAA+C,GAChD,MAAM,oCAAoC,CAAA;AAE3C,MAAM,CAAC,MAAM,+BAA+B,GAAG,iBAAiB,CAAC;IAC/D,UAAU,EAAE,QAAQ;IACpB,uBAAuB,EAAE,6CAA6C;IACtE,YAAY,EAAE,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,EAAE,EAAE,CAC/C,gBAAgB,SAAS,qBAAqB,eAAe,EAAE;IACjE,OAAO,EAAE,4BAA4B;IACrC,MAAM,EAAE,KAAK;IACb,qBAAqB,EAAE;QACrB,GAAG,EAAE,0CAA0C;QAC/C,GAAG,EAAE,4BAA4B;QACjC,GAAG,EAAE,4BAA4B;KAClC;IACD,mBAAmB,EAAE,2BAA2B;CACjD,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,mCAAmC,GAAG,iBAAiB,CAAC;IACnE,UAAU,EAAE,QAAQ;IACpB,uBAAuB,EAAE,6CAA6C;IACtE,YAAY,EAAE,CAAC,EAAE,SAAS,EAAE,eAAe,EAAE,EAAE,EAAE,CAC/C,gBAAgB,SAAS,qBAAqB,eAAe,eAAe;IAC9E,OAAO,EAAE,0BAA0B;IACnC,WAAW,EACT,wQAAwQ;IAC1Q,MAAM,EAAE,KAAK;IACb,qBAAqB,EAAE;QACrB,GAAG,EAAE,+CAA+C;QACpD,GAAG,EAAE,4BAA4B;QACjC,GAAG,EAAE,4BAA4B;QACjC,GAAG,EAAE,4BAA4B;KAClC;IACD,mBAAmB,EAAE,2BAA2B;CACjD,CAAC,CAAA"}

package/dist/api/schemas/exportProcessSchemas.d.ts

@@ -16,6 +16,7 @@ export declare const EXPORT_PROCESS_DETAILS_SCHEMA: z.ZodObject<{
         readonly COMPLETED: "completed";
         readonly FAILED: "failed";
     }>;
+    failReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 export type ExportProcessDetails = z.infer<typeof EXPORT_PROCESS_DETAILS_SCHEMA>;
 export declare const GET_EXPORT_PROCESS_DETAILS_RESPONSE_SCHEMA: z.ZodObject<{
@@ -25,6 +26,17 @@ export declare const GET_EXPORT_PROCESS_DETAILS_RESPONSE_SCHEMA: z.ZodObject<{
             readonly COMPLETED: "completed";
             readonly FAILED: "failed";
         }>;
+        failReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 export type GetExportProcessDetailsResponse = z.infer<typeof GET_EXPORT_PROCESS_DETAILS_RESPONSE_SCHEMA>;
+export declare const EXPORT_PROCESS_DOWNLOAD_URL_SCHEMA: z.ZodObject<{
+    downloadUrl: z.ZodURL;
+}, z.core.$strip>;
+export type ExportProcessDownloadUrl = z.infer<typeof EXPORT_PROCESS_DOWNLOAD_URL_SCHEMA>;
+export declare const GET_EXPORT_PROCESS_DOWNLOAD_URL_RESPONSE_SCHEMA: z.ZodObject<{
+    data: z.ZodObject<{
+        downloadUrl: z.ZodURL;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type GetExportProcessDownloadUrlResponse = z.infer<typeof GET_EXPORT_PROCESS_DOWNLOAD_URL_RESPONSE_SCHEMA>;

package/dist/api/schemas/exportProcessSchemas.js

@@ -10,8 +10,20 @@ export const ExportProcessStatusEnum = {
 };
 export const EXPORT_PROCESS_DETAILS_SCHEMA = z.object({
     status: z.enum(ExportProcessStatusEnum),
+    failReason: z
+        .string()
+        .nullish()
+        .describe('Machine-readable failure code. Set only when status is failed.'),
 });
 export const GET_EXPORT_PROCESS_DETAILS_RESPONSE_SCHEMA = z.object({
     data: EXPORT_PROCESS_DETAILS_SCHEMA,
 });
+export const EXPORT_PROCESS_DOWNLOAD_URL_SCHEMA = z.object({
+    downloadUrl: z
+        .url()
+        .describe('Time-limited link to download the exported file. Request a new one after it expires.'),
+});
+export const GET_EXPORT_PROCESS_DOWNLOAD_URL_RESPONSE_SCHEMA = z.object({
+    data: EXPORT_PROCESS_DOWNLOAD_URL_SCHEMA,
+});
 //# sourceMappingURL=exportProcessSchemas.js.map

package/dist/api/schemas/exportProcessSchemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"exportProcessSchemas.js","sourceRoot":"","sources":["../../../src/api/schemas/exportProcessSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,MAAM,CAAC,MAAM,6CAA6C,GAAG,CAAC,CAAC,MAAM,CAAC;IACpE,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE;IACnB,eAAe,EAAE,CAAC,CAAC,IAAI,EAAE;CAC1B,CAAC,CAAA;AAMF,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;CACR,CAAA;AAKV,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC;CACxC,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,0CAA0C,GAAG,CAAC,CAAC,MAAM,CAAC;IACjE,IAAI,EAAE,6BAA6B;CACpC,CAAC,CAAA"}
+{"version":3,"file":"exportProcessSchemas.js","sourceRoot":"","sources":["../../../src/api/schemas/exportProcessSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,MAAM,CAAC,MAAM,6CAA6C,GAAG,CAAC,CAAC,MAAM,CAAC;IACpE,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE;IACnB,eAAe,EAAE,CAAC,CAAC,IAAI,EAAE;CAC1B,CAAC,CAAA;AAMF,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;CACR,CAAA;AAKV,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC;IACvC,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,OAAO,EAAE;SACT,QAAQ,CAAC,gEAAgE,CAAC;CAC9E,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,0CAA0C,GAAG,CAAC,CAAC,MAAM,CAAC;IACjE,IAAI,EAAE,6BAA6B;CACpC,CAAC,CAAA;AAMF,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CAAC;IACzD,WAAW,EAAE,CAAC;SACX,GAAG,EAAE;SACL,QAAQ,CACP,sFAAsF,CACvF;CACJ,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,+CAA+C,GAAG,CAAC,CAAC,MAAM,CAAC;IACtE,IAAI,EAAE,kCAAkC;CACzC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/content-exchange-schemas",
-    "version": "3.0.0",
+    "version": "3.2.0",
     "files": [
         "dist"
     ],