@lokalise/tm-api-schemas 3.0.0 → 3.2.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/api-schemas/import/confirm-upload-completion.d.ts +26 -0
- package/dist/api-schemas/import/confirm-upload-completion.js +27 -0
- package/dist/api-schemas/import/confirm-upload-completion.js.map +1 -0
- package/dist/api-schemas/import/create-upload-form-data.d.ts +65 -0
- package/dist/api-schemas/import/create-upload-form-data.js +41 -0
- package/dist/api-schemas/import/create-upload-form-data.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { z } from 'zod/v4';
|
|
2
|
+
export declare const CONFIRM_UPLOAD_COMPLETION_BODY_SCHEMA: z.ZodObject<{
|
|
3
|
+
fileId: z.ZodGUID;
|
|
4
|
+
}, z.core.$strip>;
|
|
5
|
+
export type ConfirmUploadCompletionBody = z.infer<typeof CONFIRM_UPLOAD_COMPLETION_BODY_SCHEMA>;
|
|
6
|
+
export declare const CONFIRM_UPLOAD_COMPLETION_RESPONSE_SCHEMA: z.ZodObject<{
|
|
7
|
+
jobId: z.ZodString;
|
|
8
|
+
}, z.core.$strip>;
|
|
9
|
+
export type ConfirmUploadCompletionResponse = z.infer<typeof CONFIRM_UPLOAD_COMPLETION_RESPONSE_SCHEMA>;
|
|
10
|
+
export declare const postConfirmUploadCompletionContract: import("@lokalise/api-contracts").PayloadRouteDefinition<z.ZodObject<{
|
|
11
|
+
fileId: z.ZodGUID;
|
|
12
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
13
|
+
jobId: z.ZodString;
|
|
14
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
15
|
+
groupId: z.ZodString;
|
|
16
|
+
}, z.core.$strip>, undefined, z.ZodUnion<[z.ZodObject<{
|
|
17
|
+
'Content-Type': z.ZodOptional<z.ZodLiteral<"application/json">>;
|
|
18
|
+
Authorization: z.ZodOptional<z.ZodString>;
|
|
19
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
20
|
+
'content-type': z.ZodOptional<z.ZodLiteral<"application/json">>;
|
|
21
|
+
authorization: z.ZodOptional<z.ZodString>;
|
|
22
|
+
}, z.core.$strip>]>, false, false, {
|
|
23
|
+
202: z.ZodObject<{
|
|
24
|
+
jobId: z.ZodString;
|
|
25
|
+
}, z.core.$strip>;
|
|
26
|
+
}>;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { buildPayloadRoute } from '@lokalise/api-contracts';
|
|
2
|
+
import { commonErrorResponses } from '@lokalise/common-api-schemas';
|
|
3
|
+
import { z } from 'zod/v4';
|
|
4
|
+
import { GROUP_REQUEST_PARAMS_SCHEMA, REQUEST_HEADER_SCHEMA } from "../common.js";
|
|
5
|
+
// --------------------------------------------
|
|
6
|
+
// POST /v1/groups/:groupId/import/actions/confirm-upload-completion
|
|
7
|
+
// --------------------------------------------
|
|
8
|
+
export const CONFIRM_UPLOAD_COMPLETION_BODY_SCHEMA = z.object({
|
|
9
|
+
fileId: z.guid(),
|
|
10
|
+
});
|
|
11
|
+
export const CONFIRM_UPLOAD_COMPLETION_RESPONSE_SCHEMA = z.object({
|
|
12
|
+
jobId: z.string(),
|
|
13
|
+
});
|
|
14
|
+
export const postConfirmUploadCompletionContract = buildPayloadRoute({
|
|
15
|
+
method: 'post',
|
|
16
|
+
requestPathParamsSchema: GROUP_REQUEST_PARAMS_SCHEMA,
|
|
17
|
+
requestBodySchema: CONFIRM_UPLOAD_COMPLETION_BODY_SCHEMA,
|
|
18
|
+
requestHeaderSchema: REQUEST_HEADER_SCHEMA,
|
|
19
|
+
pathResolver: (params) => `/v1/groups/${params.groupId}/import/actions/confirm-upload-completion`,
|
|
20
|
+
description: 'Confirm that file was uploaded to FSS',
|
|
21
|
+
successResponseBodySchema: CONFIRM_UPLOAD_COMPLETION_RESPONSE_SCHEMA,
|
|
22
|
+
responseSchemasByStatusCode: {
|
|
23
|
+
...commonErrorResponses,
|
|
24
|
+
202: CONFIRM_UPLOAD_COMPLETION_RESPONSE_SCHEMA,
|
|
25
|
+
},
|
|
26
|
+
});
|
|
27
|
+
//# sourceMappingURL=confirm-upload-completion.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"confirm-upload-completion.js","sourceRoot":"","sources":["../../../src/api-schemas/import/confirm-upload-completion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AACnE,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAEjF,+CAA+C;AAC/C,oEAAoE;AACpE,+CAA+C;AAE/C,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5D,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE;CACjB,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,yCAAyC,GAAG,CAAC,CAAC,MAAM,CAAC;IAChE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAA;AAKF,MAAM,CAAC,MAAM,mCAAmC,GAAG,iBAAiB,CAAC;IACnE,MAAM,EAAE,MAAM;IACd,uBAAuB,EAAE,2BAA2B;IACpD,iBAAiB,EAAE,qCAAqC;IACxD,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,MAAM,CAAC,OAAO,2CAA2C;IACjG,WAAW,EAAE,uCAAuC;IACpD,yBAAyB,EAAE,yCAAyC;IACpE,2BAA2B,EAAE;QAC3B,GAAG,oBAAoB;QACvB,GAAG,EAAE,yCAAyC;KAC/C;CACF,CAAC,CAAA"}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { z } from 'zod/v4';
|
|
2
|
+
export declare const CREATE_UPLOAD_FORM_DATA_BODY_SCHEMA: z.ZodObject<{
|
|
3
|
+
filename: z.ZodString;
|
|
4
|
+
mimeType: z.ZodLiteral<"application/xml" | "application/x-tmx+xml">;
|
|
5
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
6
|
+
size: z.ZodNumber;
|
|
7
|
+
md5: z.ZodString;
|
|
8
|
+
}, z.core.$strip>;
|
|
9
|
+
export type CreateUploadFormDataBody = z.infer<typeof CREATE_UPLOAD_FORM_DATA_BODY_SCHEMA>;
|
|
10
|
+
export declare const UPLOAD_FORM_DATA_SCHEMA: z.ZodObject<{
|
|
11
|
+
url: z.ZodString;
|
|
12
|
+
fields: z.ZodObject<{}, z.core.$loose>;
|
|
13
|
+
}, z.core.$strip>;
|
|
14
|
+
export type UploadFormData = z.infer<typeof UPLOAD_FORM_DATA_SCHEMA>;
|
|
15
|
+
export declare const CREATE_UPLOAD_FORM_DATA_RESULT_SCHEMA: z.ZodObject<{
|
|
16
|
+
fileId: z.ZodString;
|
|
17
|
+
formData: z.ZodObject<{
|
|
18
|
+
url: z.ZodString;
|
|
19
|
+
fields: z.ZodObject<{}, z.core.$loose>;
|
|
20
|
+
}, z.core.$strip>;
|
|
21
|
+
}, z.core.$strip>;
|
|
22
|
+
export type CreateUploadFormDataResult = z.infer<typeof CREATE_UPLOAD_FORM_DATA_RESULT_SCHEMA>;
|
|
23
|
+
export declare const CREATE_UPLOAD_FORM_DATA_RESPONSE_SCHEMA: z.ZodObject<{
|
|
24
|
+
data: z.ZodObject<{
|
|
25
|
+
fileId: z.ZodString;
|
|
26
|
+
formData: z.ZodObject<{
|
|
27
|
+
url: z.ZodString;
|
|
28
|
+
fields: z.ZodObject<{}, z.core.$loose>;
|
|
29
|
+
}, z.core.$strip>;
|
|
30
|
+
}, z.core.$strip>;
|
|
31
|
+
}, z.core.$strip>;
|
|
32
|
+
export type CreateUploadFormDataResponse = z.infer<typeof CREATE_UPLOAD_FORM_DATA_RESPONSE_SCHEMA>;
|
|
33
|
+
export declare const postCreateUploadFormDataContract: import("@lokalise/api-contracts").PayloadRouteDefinition<z.ZodObject<{
|
|
34
|
+
filename: z.ZodString;
|
|
35
|
+
mimeType: z.ZodLiteral<"application/xml" | "application/x-tmx+xml">;
|
|
36
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
37
|
+
size: z.ZodNumber;
|
|
38
|
+
md5: z.ZodString;
|
|
39
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
40
|
+
data: z.ZodObject<{
|
|
41
|
+
fileId: z.ZodString;
|
|
42
|
+
formData: z.ZodObject<{
|
|
43
|
+
url: z.ZodString;
|
|
44
|
+
fields: z.ZodObject<{}, z.core.$loose>;
|
|
45
|
+
}, z.core.$strip>;
|
|
46
|
+
}, z.core.$strip>;
|
|
47
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
48
|
+
groupId: z.ZodString;
|
|
49
|
+
}, z.core.$strip>, undefined, z.ZodUnion<[z.ZodObject<{
|
|
50
|
+
'Content-Type': z.ZodOptional<z.ZodLiteral<"application/json">>;
|
|
51
|
+
Authorization: z.ZodOptional<z.ZodString>;
|
|
52
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
53
|
+
'content-type': z.ZodOptional<z.ZodLiteral<"application/json">>;
|
|
54
|
+
authorization: z.ZodOptional<z.ZodString>;
|
|
55
|
+
}, z.core.$strip>]>, false, false, {
|
|
56
|
+
200: z.ZodObject<{
|
|
57
|
+
data: z.ZodObject<{
|
|
58
|
+
fileId: z.ZodString;
|
|
59
|
+
formData: z.ZodObject<{
|
|
60
|
+
url: z.ZodString;
|
|
61
|
+
fields: z.ZodObject<{}, z.core.$loose>;
|
|
62
|
+
}, z.core.$strip>;
|
|
63
|
+
}, z.core.$strip>;
|
|
64
|
+
}, z.core.$strip>;
|
|
65
|
+
}>;
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { buildPayloadRoute } from '@lokalise/api-contracts';
|
|
2
|
+
import { commonErrorResponses } from '@lokalise/common-api-schemas';
|
|
3
|
+
import { z } from 'zod/v4';
|
|
4
|
+
import { GROUP_REQUEST_PARAMS_SCHEMA, REQUEST_HEADER_SCHEMA } from "../common.js";
|
|
5
|
+
// --------------------------------------------
|
|
6
|
+
// POST /v1/groups/:groupId/import/actions/create-upload-form
|
|
7
|
+
// --------------------------------------------
|
|
8
|
+
export const CREATE_UPLOAD_FORM_DATA_BODY_SCHEMA = z.object({
|
|
9
|
+
filename: z.string(),
|
|
10
|
+
mimeType: z.literal(['application/xml', 'application/x-tmx+xml']),
|
|
11
|
+
metadata: z.record(z.string(), z.string()).optional(),
|
|
12
|
+
size: z.number().describe('File size in bytes'),
|
|
13
|
+
md5: z.string(),
|
|
14
|
+
});
|
|
15
|
+
export const UPLOAD_FORM_DATA_SCHEMA = z.object({
|
|
16
|
+
url: z.string(),
|
|
17
|
+
fields: z
|
|
18
|
+
.looseObject({})
|
|
19
|
+
.describe('On the controller level, the shape is not enforced to reduce maintenance if the field names change.'),
|
|
20
|
+
});
|
|
21
|
+
export const CREATE_UPLOAD_FORM_DATA_RESULT_SCHEMA = z.object({
|
|
22
|
+
fileId: z.string(),
|
|
23
|
+
formData: UPLOAD_FORM_DATA_SCHEMA,
|
|
24
|
+
});
|
|
25
|
+
export const CREATE_UPLOAD_FORM_DATA_RESPONSE_SCHEMA = z.object({
|
|
26
|
+
data: CREATE_UPLOAD_FORM_DATA_RESULT_SCHEMA,
|
|
27
|
+
});
|
|
28
|
+
export const postCreateUploadFormDataContract = buildPayloadRoute({
|
|
29
|
+
method: 'post',
|
|
30
|
+
requestPathParamsSchema: GROUP_REQUEST_PARAMS_SCHEMA,
|
|
31
|
+
requestBodySchema: CREATE_UPLOAD_FORM_DATA_BODY_SCHEMA,
|
|
32
|
+
requestHeaderSchema: REQUEST_HEADER_SCHEMA,
|
|
33
|
+
pathResolver: (params) => `/v1/groups/${params.groupId}/import/actions/create-upload-form`,
|
|
34
|
+
description: 'Create translation memory upload form data',
|
|
35
|
+
successResponseBodySchema: CREATE_UPLOAD_FORM_DATA_RESPONSE_SCHEMA,
|
|
36
|
+
responseSchemasByStatusCode: {
|
|
37
|
+
...commonErrorResponses,
|
|
38
|
+
200: CREATE_UPLOAD_FORM_DATA_RESPONSE_SCHEMA,
|
|
39
|
+
},
|
|
40
|
+
});
|
|
41
|
+
//# sourceMappingURL=create-upload-form-data.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-upload-form-data.js","sourceRoot":"","sources":["../../../src/api-schemas/import/create-upload-form-data.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AACnE,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAEjF,+CAA+C;AAC/C,6DAA6D;AAC7D,+CAA+C;AAE/C,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,QAAQ,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,uBAAuB,CAAC,CAAC;IACjE,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IACrD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;IAC/C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;CAChB,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;IACf,MAAM,EAAE,CAAC;SACN,WAAW,CAAC,EAAE,CAAC;SACf,QAAQ,CACP,qGAAqG,CACtG;CACJ,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5D,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,QAAQ,EAAE,uBAAuB;CAClC,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,uCAAuC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9D,IAAI,EAAE,qCAAqC;CAC5C,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,gCAAgC,GAAG,iBAAiB,CAAC;IAChE,MAAM,EAAE,MAAM;IACd,uBAAuB,EAAE,2BAA2B;IACpD,iBAAiB,EAAE,mCAAmC;IACtD,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,MAAM,CAAC,OAAO,oCAAoC;IAC1F,WAAW,EAAE,4CAA4C;IACzD,yBAAyB,EAAE,uCAAuC;IAClE,2BAA2B,EAAE;QAC3B,GAAG,oBAAoB;QACvB,GAAG,EAAE,uCAAuC;KAC7C;CACF,CAAC,CAAA"}
|
package/dist/index.d.ts
CHANGED
|
@@ -2,6 +2,8 @@ export * from './api-schemas/bulk-find-matches.ts';
|
|
|
2
2
|
export * from './api-schemas/common.ts';
|
|
3
3
|
export * from './api-schemas/get-matches.ts';
|
|
4
4
|
export * from './api-schemas/get-records.ts';
|
|
5
|
+
export * from './api-schemas/import/confirm-upload-completion.ts';
|
|
6
|
+
export * from './api-schemas/import/create-upload-form-data.ts';
|
|
5
7
|
export * from './api-schemas/post-delete-records.ts';
|
|
6
8
|
export * from './api-schemas/put-records.ts';
|
|
7
9
|
export * from './objects.ts';
|
package/dist/index.js
CHANGED
|
@@ -2,6 +2,8 @@ export * from "./api-schemas/bulk-find-matches.js";
|
|
|
2
2
|
export * from "./api-schemas/common.js";
|
|
3
3
|
export * from "./api-schemas/get-matches.js";
|
|
4
4
|
export * from "./api-schemas/get-records.js";
|
|
5
|
+
export * from "./api-schemas/import/confirm-upload-completion.js";
|
|
6
|
+
export * from "./api-schemas/import/create-upload-form-data.js";
|
|
5
7
|
export * from "./api-schemas/post-delete-records.js";
|
|
6
8
|
export * from "./api-schemas/put-records.js";
|
|
7
9
|
export * from "./objects.js";
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oCAAoC,CAAA;AAClD,cAAc,yBAAyB,CAAA;AACvC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,sCAAsC,CAAA;AACpD,cAAc,8BAA8B,CAAA;AAE5C,cAAc,cAAc,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oCAAoC,CAAA;AAClD,cAAc,yBAAyB,CAAA;AACvC,cAAc,8BAA8B,CAAA;AAC5C,cAAc,8BAA8B,CAAA;AAC5C,cAAc,mDAAmD,CAAA;AACjE,cAAc,iDAAiD,CAAA;AAC/D,cAAc,sCAAsC,CAAA;AACpD,cAAc,8BAA8B,CAAA;AAE5C,cAAc,cAAc,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lokalise/tm-api-schemas",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.2.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Lokalise",
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"zod": "^4.1.12"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
|
-
"@biomejs/biome": "^2.
|
|
46
|
+
"@biomejs/biome": "^2.3.1",
|
|
47
47
|
"@lokalise/biome-config": "^3.1.0",
|
|
48
48
|
"@lokalise/tsconfig": "^3.0.0",
|
|
49
49
|
"@types/node": "24.8.1",
|