@lokalise/content-type-app-engine-contracts 5.14.0 → 5.15.0
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.
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/schemas/content/contentExportApiSchemas.d.ts +54 -0
- package/dist/schemas/content/contentExportApiSchemas.js +20 -0
- package/dist/schemas/content/contentExportApiSchemas.js.map +1 -0
- package/dist/schemas/content/contentExportSchemas.d.ts +41 -0
- package/dist/schemas/content/contentExportSchemas.js +28 -0
- package/dist/schemas/content/contentExportSchemas.js.map +1 -0
- package/dist/schemas/schedule/scheduleApiSchemas.d.ts +1 -1
- package/dist/schemas/schedule/scheduleSchemas.d.ts +2 -2
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -10,6 +10,8 @@ export * from './schemas/config/integrationConfigSchemas.ts';
|
|
|
10
10
|
export * from './schemas/connector/connectorApiSchemas.ts';
|
|
11
11
|
export * from './schemas/connector/connectorSchemas.ts';
|
|
12
12
|
export * from './schemas/content/contentApiSchemas.ts';
|
|
13
|
+
export * from './schemas/content/contentExportApiSchemas.ts';
|
|
14
|
+
export * from './schemas/content/contentExportSchemas.ts';
|
|
13
15
|
export * from './schemas/content/contentSchemas.ts';
|
|
14
16
|
export * from './schemas/env/envApiSchemas.ts';
|
|
15
17
|
export * from './schemas/env/envSchemas.ts';
|
package/dist/index.js
CHANGED
|
@@ -10,6 +10,8 @@ export * from "./schemas/config/integrationConfigSchemas.js";
|
|
|
10
10
|
export * from "./schemas/connector/connectorApiSchemas.js";
|
|
11
11
|
export * from "./schemas/connector/connectorSchemas.js";
|
|
12
12
|
export * from "./schemas/content/contentApiSchemas.js";
|
|
13
|
+
export * from "./schemas/content/contentExportApiSchemas.js";
|
|
14
|
+
export * from "./schemas/content/contentExportSchemas.js";
|
|
13
15
|
export * from "./schemas/content/contentSchemas.js";
|
|
14
16
|
export * from "./schemas/env/envApiSchemas.js";
|
|
15
17
|
export * from "./schemas/env/envSchemas.js";
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAA;AAChD,cAAc,+BAA+B,CAAA;AAC7C,cAAc,6CAA6C,CAAA;AAC3D,cAAc,0CAA0C,CAAA;AACxD,cAAc,oCAAoC,CAAA;AAClD,cAAc,iCAAiC,CAAA;AAC/C,cAAc,mCAAmC,CAAA;AACjD,cAAc,iDAAiD,CAAA;AAC/D,cAAc,8CAA8C,CAAA;AAC5D,cAAc,4CAA4C,CAAA;AAC1D,cAAc,yCAAyC,CAAA;AACvD,cAAc,wCAAwC,CAAA;AACtD,cAAc,qCAAqC,CAAA;AACnD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sCAAsC,CAAA;AACpD,cAAc,mCAAmC,CAAA;AACjD,cAAc,gDAAgD,CAAA;AAC9D,cAAc,6CAA6C,CAAA;AAC3D,cAAc,8DAA8D,CAAA;AAC5E,cAAc,2DAA2D,CAAA;AACzE,cAAc,uDAAuD,CAAA;AACrE,cAAc,oDAAoD,CAAA;AAClE,cAAc,gDAAgD,CAAA;AAC9D,cAAc,qDAAqD,CAAA;AACnE,cAAc,kDAAkD,CAAA;AAChE,cAAc,yCAAyC,CAAA;AACvD,cAAc,0CAA0C,CAAA;AACxD,cAAc,uCAAuC,CAAA;AACrD,cAAc,kCAAkC,CAAA;AAChD,cAAc,+BAA+B,CAAA;AAC7C,cAAc,wCAAwC,CAAA;AACtD,cAAc,qCAAqC,CAAA;AACnD,cAAc,0CAA0C,CAAA;AACxD,cAAc,uCAAuC,CAAA;AACrD,cAAc,0CAA0C,CAAA;AACxD,cAAc,uCAAuC,CAAA;AACrD,cAAc,sCAAsC,CAAA;AACpD,cAAc,mCAAmC,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kCAAkC,CAAA;AAChD,cAAc,+BAA+B,CAAA;AAC7C,cAAc,6CAA6C,CAAA;AAC3D,cAAc,0CAA0C,CAAA;AACxD,cAAc,oCAAoC,CAAA;AAClD,cAAc,iCAAiC,CAAA;AAC/C,cAAc,mCAAmC,CAAA;AACjD,cAAc,iDAAiD,CAAA;AAC/D,cAAc,8CAA8C,CAAA;AAC5D,cAAc,4CAA4C,CAAA;AAC1D,cAAc,yCAAyC,CAAA;AACvD,cAAc,wCAAwC,CAAA;AACtD,cAAc,8CAA8C,CAAA;AAC5D,cAAc,2CAA2C,CAAA;AACzD,cAAc,qCAAqC,CAAA;AACnD,cAAc,gCAAgC,CAAA;AAC9C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,sCAAsC,CAAA;AACpD,cAAc,mCAAmC,CAAA;AACjD,cAAc,gDAAgD,CAAA;AAC9D,cAAc,6CAA6C,CAAA;AAC3D,cAAc,8DAA8D,CAAA;AAC5E,cAAc,2DAA2D,CAAA;AACzE,cAAc,uDAAuD,CAAA;AACrE,cAAc,oDAAoD,CAAA;AAClE,cAAc,gDAAgD,CAAA;AAC9D,cAAc,qDAAqD,CAAA;AACnE,cAAc,kDAAkD,CAAA;AAChE,cAAc,yCAAyC,CAAA;AACvD,cAAc,0CAA0C,CAAA;AACxD,cAAc,uCAAuC,CAAA;AACrD,cAAc,kCAAkC,CAAA;AAChD,cAAc,+BAA+B,CAAA;AAC7C,cAAc,wCAAwC,CAAA;AACtD,cAAc,qCAAqC,CAAA;AACnD,cAAc,0CAA0C,CAAA;AACxD,cAAc,uCAAuC,CAAA;AACrD,cAAc,0CAA0C,CAAA;AACxD,cAAc,uCAAuC,CAAA;AACrD,cAAc,sCAAsC,CAAA;AACpD,cAAc,mCAAmC,CAAA"}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Contract for getting export status
|
|
3
|
+
* GET /v1/exports/:exportId/status
|
|
4
|
+
*/
|
|
5
|
+
export declare const getExportStatusContract: import("@lokalise/api-contracts").GetRouteDefinition<import("zod").ZodObject<{
|
|
6
|
+
exportProcessId: import("zod").ZodUUID;
|
|
7
|
+
status: import("zod").ZodNullable<import("zod").ZodEnum<{
|
|
8
|
+
readonly QUEUED: "QUEUED";
|
|
9
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
10
|
+
readonly COMPLETED: "COMPLETED";
|
|
11
|
+
readonly FAILED: "FAILED";
|
|
12
|
+
}>>;
|
|
13
|
+
progress: import("zod").ZodObject<{
|
|
14
|
+
total: import("zod").ZodNumber;
|
|
15
|
+
processed: import("zod").ZodNumber;
|
|
16
|
+
percentage: import("zod").ZodNumber;
|
|
17
|
+
}, import("zod/v4/core").$strip>;
|
|
18
|
+
files: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
19
|
+
fileId: import("zod").ZodString;
|
|
20
|
+
downloadUrl: import("zod").ZodString;
|
|
21
|
+
filename: import("zod").ZodString;
|
|
22
|
+
metadata: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
|
|
23
|
+
}, import("zod/v4/core").$strip>>>;
|
|
24
|
+
error: import("zod").ZodOptional<import("zod").ZodString>;
|
|
25
|
+
}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
|
|
26
|
+
exportId: import("zod").ZodString;
|
|
27
|
+
}, import("zod/v4/core").$strip>, undefined, undefined, undefined, false, false, {
|
|
28
|
+
200: import("zod").ZodObject<{
|
|
29
|
+
exportProcessId: import("zod").ZodUUID;
|
|
30
|
+
status: import("zod").ZodNullable<import("zod").ZodEnum<{
|
|
31
|
+
readonly QUEUED: "QUEUED";
|
|
32
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
33
|
+
readonly COMPLETED: "COMPLETED";
|
|
34
|
+
readonly FAILED: "FAILED";
|
|
35
|
+
}>>;
|
|
36
|
+
progress: import("zod").ZodObject<{
|
|
37
|
+
total: import("zod").ZodNumber;
|
|
38
|
+
processed: import("zod").ZodNumber;
|
|
39
|
+
percentage: import("zod").ZodNumber;
|
|
40
|
+
}, import("zod/v4/core").$strip>;
|
|
41
|
+
files: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
|
|
42
|
+
fileId: import("zod").ZodString;
|
|
43
|
+
downloadUrl: import("zod").ZodString;
|
|
44
|
+
filename: import("zod").ZodString;
|
|
45
|
+
metadata: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnknown>;
|
|
46
|
+
}, import("zod/v4/core").$strip>>>;
|
|
47
|
+
error: import("zod").ZodOptional<import("zod").ZodString>;
|
|
48
|
+
}, import("zod/v4/core").$strip>;
|
|
49
|
+
404: import("zod").ZodObject<{
|
|
50
|
+
message: import("zod").ZodString;
|
|
51
|
+
errorCode: import("zod").ZodString;
|
|
52
|
+
details: import("zod").ZodOptional<import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodAny>>;
|
|
53
|
+
}, import("zod/v4/core").$strip>;
|
|
54
|
+
}>;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { buildRestContract } from '@lokalise/api-contracts';
|
|
2
|
+
import { COMMON_ERROR_RESPONSE_SCHEMA_V2 } from "../commonRequestSchemas.js";
|
|
3
|
+
import { EXPORT_STATUS_PATH_PARAMS_SCHEMA, EXPORT_STATUS_RESPONSE_BODY_SCHEMA, } from "./contentExportSchemas.js";
|
|
4
|
+
/**
|
|
5
|
+
* Contract for getting export status
|
|
6
|
+
* GET /v1/exports/:exportId/status
|
|
7
|
+
*/
|
|
8
|
+
export const getExportStatusContract = buildRestContract({
|
|
9
|
+
method: 'get',
|
|
10
|
+
summary: 'Get export status',
|
|
11
|
+
description: 'Get push-based export status',
|
|
12
|
+
requestPathParamsSchema: EXPORT_STATUS_PATH_PARAMS_SCHEMA,
|
|
13
|
+
successResponseBodySchema: EXPORT_STATUS_RESPONSE_BODY_SCHEMA,
|
|
14
|
+
responseSchemasByStatusCode: {
|
|
15
|
+
200: EXPORT_STATUS_RESPONSE_BODY_SCHEMA,
|
|
16
|
+
404: COMMON_ERROR_RESPONSE_SCHEMA_V2,
|
|
17
|
+
},
|
|
18
|
+
pathResolver: ({ exportId }) => `/v1/exports/${exportId}/status`,
|
|
19
|
+
});
|
|
20
|
+
//# sourceMappingURL=contentExportApiSchemas.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contentExportApiSchemas.js","sourceRoot":"","sources":["../../../src/schemas/content/contentExportApiSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,+BAA+B,EAAE,MAAM,4BAA4B,CAAA;AAC5E,OAAO,EACL,gCAAgC,EAChC,kCAAkC,GACnC,MAAM,2BAA2B,CAAA;AAElC;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;IACvD,MAAM,EAAE,KAAK;IACb,OAAO,EAAE,mBAAmB;IAC5B,WAAW,EAAE,8BAA8B;IAC3C,uBAAuB,EAAE,gCAAgC;IACzD,yBAAyB,EAAE,kCAAkC;IAC7D,2BAA2B,EAAE;QAC3B,GAAG,EAAE,kCAAkC;QACvC,GAAG,EAAE,+BAA+B;KACrC;IACD,YAAY,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,eAAe,QAAQ,SAAS;CACjE,CAAC,CAAA"}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { z } from 'zod/v4';
|
|
2
|
+
export declare const ExportStatusEnum: {
|
|
3
|
+
readonly QUEUED: "QUEUED";
|
|
4
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
5
|
+
readonly COMPLETED: "COMPLETED";
|
|
6
|
+
readonly FAILED: "FAILED";
|
|
7
|
+
};
|
|
8
|
+
export type ExportStatusEnum = (typeof ExportStatusEnum)[keyof typeof ExportStatusEnum];
|
|
9
|
+
export declare const EXPORT_STATUS_PATH_PARAMS_SCHEMA: z.ZodObject<{
|
|
10
|
+
exportId: z.ZodString;
|
|
11
|
+
}, z.core.$strip>;
|
|
12
|
+
export type ExportStatusPathParams = z.infer<typeof EXPORT_STATUS_PATH_PARAMS_SCHEMA>;
|
|
13
|
+
export declare const EXPORT_FILE_INFO_SCHEMA: z.ZodObject<{
|
|
14
|
+
fileId: z.ZodString;
|
|
15
|
+
downloadUrl: z.ZodString;
|
|
16
|
+
filename: z.ZodString;
|
|
17
|
+
metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
18
|
+
}, z.core.$strip>;
|
|
19
|
+
export type ExportFileInfo = z.infer<typeof EXPORT_FILE_INFO_SCHEMA>;
|
|
20
|
+
export declare const EXPORT_STATUS_RESPONSE_BODY_SCHEMA: z.ZodObject<{
|
|
21
|
+
exportProcessId: z.ZodUUID;
|
|
22
|
+
status: z.ZodNullable<z.ZodEnum<{
|
|
23
|
+
readonly QUEUED: "QUEUED";
|
|
24
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
25
|
+
readonly COMPLETED: "COMPLETED";
|
|
26
|
+
readonly FAILED: "FAILED";
|
|
27
|
+
}>>;
|
|
28
|
+
progress: z.ZodObject<{
|
|
29
|
+
total: z.ZodNumber;
|
|
30
|
+
processed: z.ZodNumber;
|
|
31
|
+
percentage: z.ZodNumber;
|
|
32
|
+
}, z.core.$strip>;
|
|
33
|
+
files: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
34
|
+
fileId: z.ZodString;
|
|
35
|
+
downloadUrl: z.ZodString;
|
|
36
|
+
filename: z.ZodString;
|
|
37
|
+
metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
|
|
38
|
+
}, z.core.$strip>>>;
|
|
39
|
+
error: z.ZodOptional<z.ZodString>;
|
|
40
|
+
}, z.core.$strip>;
|
|
41
|
+
export type ExportStatusResponse = z.infer<typeof EXPORT_STATUS_RESPONSE_BODY_SCHEMA>;
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { z } from 'zod/v4';
|
|
2
|
+
export const ExportStatusEnum = {
|
|
3
|
+
QUEUED: 'QUEUED',
|
|
4
|
+
IN_PROGRESS: 'IN_PROGRESS',
|
|
5
|
+
COMPLETED: 'COMPLETED',
|
|
6
|
+
FAILED: 'FAILED',
|
|
7
|
+
};
|
|
8
|
+
export const EXPORT_STATUS_PATH_PARAMS_SCHEMA = z.object({
|
|
9
|
+
exportId: z.string(),
|
|
10
|
+
});
|
|
11
|
+
export const EXPORT_FILE_INFO_SCHEMA = z.object({
|
|
12
|
+
fileId: z.string(),
|
|
13
|
+
downloadUrl: z.string(),
|
|
14
|
+
filename: z.string(),
|
|
15
|
+
metadata: z.record(z.string(), z.unknown()),
|
|
16
|
+
});
|
|
17
|
+
export const EXPORT_STATUS_RESPONSE_BODY_SCHEMA = z.object({
|
|
18
|
+
exportProcessId: z.uuid(),
|
|
19
|
+
status: z.enum(ExportStatusEnum).nullable(),
|
|
20
|
+
progress: z.object({
|
|
21
|
+
total: z.number(),
|
|
22
|
+
processed: z.number(),
|
|
23
|
+
percentage: z.number(),
|
|
24
|
+
}),
|
|
25
|
+
files: z.array(EXPORT_FILE_INFO_SCHEMA).optional(),
|
|
26
|
+
error: z.string().optional(),
|
|
27
|
+
});
|
|
28
|
+
//# sourceMappingURL=contentExportSchemas.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"contentExportSchemas.js","sourceRoot":"","sources":["../../../src/schemas/content/contentExportSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,MAAM,EAAE,QAAQ;IAChB,WAAW,EAAE,aAAa;IAC1B,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;CACR,CAAA;AAIV,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;CACrB,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;CAC5C,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CAAC;IACzD,eAAe,EAAE,CAAC,CAAC,IAAI,EAAE;IACzB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,QAAQ,EAAE;IAC3C,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC;QACjB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;QACrB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;KACvB,CAAC;IACF,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,QAAQ,EAAE;IAClD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAA"}
|
|
@@ -270,9 +270,9 @@ export declare const getScheduleExecutionsContract: import("@lokalise/api-contra
|
|
|
270
270
|
id: import("zod").ZodString;
|
|
271
271
|
scheduleId: import("zod").ZodString;
|
|
272
272
|
status: import("zod").ZodEnum<{
|
|
273
|
-
RUNNING: "RUNNING";
|
|
274
273
|
COMPLETED: "COMPLETED";
|
|
275
274
|
FAILED: "FAILED";
|
|
275
|
+
RUNNING: "RUNNING";
|
|
276
276
|
}>;
|
|
277
277
|
startedAt: import("zod").ZodString;
|
|
278
278
|
completedAt: import("zod").ZodNullable<import("zod").ZodString>;
|
|
@@ -322,9 +322,9 @@ export declare const EXECUTION_ITEM_SCHEMA: z.ZodObject<{
|
|
|
322
322
|
id: z.ZodString;
|
|
323
323
|
scheduleId: z.ZodString;
|
|
324
324
|
status: z.ZodEnum<{
|
|
325
|
-
RUNNING: "RUNNING";
|
|
326
325
|
COMPLETED: "COMPLETED";
|
|
327
326
|
FAILED: "FAILED";
|
|
327
|
+
RUNNING: "RUNNING";
|
|
328
328
|
}>;
|
|
329
329
|
startedAt: z.ZodString;
|
|
330
330
|
completedAt: z.ZodNullable<z.ZodString>;
|
|
@@ -335,9 +335,9 @@ export declare const EXECUTIONS_RESPONSE: z.ZodObject<{
|
|
|
335
335
|
id: z.ZodString;
|
|
336
336
|
scheduleId: z.ZodString;
|
|
337
337
|
status: z.ZodEnum<{
|
|
338
|
-
RUNNING: "RUNNING";
|
|
339
338
|
COMPLETED: "COMPLETED";
|
|
340
339
|
FAILED: "FAILED";
|
|
340
|
+
RUNNING: "RUNNING";
|
|
341
341
|
}>;
|
|
342
342
|
startedAt: z.ZodString;
|
|
343
343
|
completedAt: z.ZodNullable<z.ZodString>;
|