@lokalise/content-exchange-schemas 3.2.0 → 3.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/dist/api/routeContracts/exportProcessContracts.d.ts +3 -0
  2. package/dist/api/routeContracts/exportProcessContracts.js +1 -0
  3. package/dist/api/routeContracts/exportProcessContracts.js.map +1 -1
  4. package/dist/api/schemas/exportProcessSchemas.d.ts +4 -0
  5. package/dist/api/schemas/exportProcessSchemas.js +12 -0
  6. package/dist/api/schemas/exportProcessSchemas.js.map +1 -1
  7. package/package.json +1 -1
package/dist/api/routeContracts/exportProcessContracts.d.ts CHANGED
@@ -9,6 +9,7 @@ export declare const getExportProcessDetailsContract: Omit<{
9
9
  exportProcessId: string;
10
10
  }) => string;
11
11
  readonly summary: "Get export process details";
12
+ readonly description: "Returns the current status of an export. Poll this endpoint until the status is completed or failed. While the export is running, the item counts show its progress. If it fails, failReason tells you why. Responds 404 if the export does not exist in this project.";
12
13
  readonly method: "get";
13
14
  readonly responsesByStatusCode: {
14
15
  readonly 200: import("zod/v4").ZodObject<{
@@ -19,6 +20,8 @@ export declare const getExportProcessDetailsContract: Omit<{
19
20
  readonly FAILED: "failed";
20
21
  }>;
21
22
  failReason: import("zod/v4").ZodOptional<import("zod/v4").ZodNullable<import("zod/v4").ZodString>>;
23
+ totalItemsCount: import("zod/v4").ZodOptional<import("zod/v4").ZodNullable<import("zod/v4").ZodNumber>>;
24
+ processedItemsCount: import("zod/v4").ZodOptional<import("zod/v4").ZodNullable<import("zod/v4").ZodNumber>>;
22
25
  }, import("zod/v4/core").$strip>;
23
26
  }, import("zod/v4/core").$strip>;
24
27
  readonly 400: import("zod/v4").ZodObject<{
package/dist/api/routeContracts/exportProcessContracts.js CHANGED
@@ -7,6 +7,7 @@ export const getExportProcessDetailsContract = defineApiContract({
7
7
  requestPathParamsSchema: GET_EXPORT_PROCESS_DETAILS_PATH_PARAMS_SCHEMA,
8
8
  pathResolver: ({ projectId, exportProcessId }) => `/v1/projects/${projectId}/export-processes/${exportProcessId}`,
9
9
  summary: 'Get export process details',
10
+ description: 'Returns the current status of an export. Poll this endpoint until the status is completed or failed. While the export is running, the item counts show its progress. If it fails, failReason tells you why. Responds 404 if the export does not exist in this project.',
10
11
  method: 'get',
11
12
  responsesByStatusCode: {
12
13
  200: GET_EXPORT_PROCESS_DETAILS_RESPONSE_SCHEMA,
package/dist/api/routeContracts/exportProcessContracts.js.map CHANGED
@@ -1 +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,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"}
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,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,WAAW,EACT,wQAAwQ;IAC1Q,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 CHANGED
@@ -17,6 +17,8 @@ export declare const EXPORT_PROCESS_DETAILS_SCHEMA: z.ZodObject<{
17
17
  readonly FAILED: "failed";
18
18
  }>;
19
19
  failReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
20
+ totalItemsCount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
21
+ processedItemsCount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
20
22
  }, z.core.$strip>;
21
23
  export type ExportProcessDetails = z.infer<typeof EXPORT_PROCESS_DETAILS_SCHEMA>;
22
24
  export declare const GET_EXPORT_PROCESS_DETAILS_RESPONSE_SCHEMA: z.ZodObject<{
@@ -27,6 +29,8 @@ export declare const GET_EXPORT_PROCESS_DETAILS_RESPONSE_SCHEMA: z.ZodObject<{
27
29
  readonly FAILED: "failed";
28
30
  }>;
29
31
  failReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
32
+ totalItemsCount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
33
+ processedItemsCount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
30
34
  }, z.core.$strip>;
31
35
  }, z.core.$strip>;
32
36
  export type GetExportProcessDetailsResponse = z.infer<typeof GET_EXPORT_PROCESS_DETAILS_RESPONSE_SCHEMA>;
package/dist/api/schemas/exportProcessSchemas.js CHANGED
@@ -14,6 +14,18 @@ export const EXPORT_PROCESS_DETAILS_SCHEMA = z.object({
14
14
  .string()
15
15
  .nullish()
16
16
  .describe('Machine-readable failure code. Set only when status is failed.'),
17
+ totalItemsCount: z
18
+ .number()
19
+ .int()
20
+ .nonnegative()
21
+ .nullish()
22
+ .describe('Number of items selected for export. Unknown until data gathering finishes.'),
23
+ processedItemsCount: z
24
+ .number()
25
+ .int()
26
+ .nonnegative()
27
+ .nullish()
28
+ .describe('Number of items delivered to the destination so far.'),
17
29
  });
18
30
  export const GET_EXPORT_PROCESS_DETAILS_RESPONSE_SCHEMA = z.object({
19
31
  data: EXPORT_PROCESS_DETAILS_SCHEMA,
package/dist/api/schemas/exportProcessSchemas.js.map CHANGED
@@ -1 +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;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"}
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;IACvC,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,OAAO,EAAE;SACT,QAAQ,CAAC,gEAAgE,CAAC;IAC7E,eAAe,EAAE,CAAC;SACf,MAAM,EAAE;SACR,GAAG,EAAE;SACL,WAAW,EAAE;SACb,OAAO,EAAE;SACT,QAAQ,CAAC,6EAA6E,CAAC;IAC1F,mBAAmB,EAAE,CAAC;SACnB,MAAM,EAAE;SACR,GAAG,EAAE;SACL,WAAW,EAAE;SACb,OAAO,EAAE;SACT,QAAQ,CAAC,sDAAsD,CAAC;CACpE,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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lokalise/content-exchange-schemas",
3
- "version": "3.2.0",
3
+ "version": "3.3.1",
4
4
  "files": [
5
5
  "dist"
6
6
  ],