@lokalise/tm-api-schemas 2.6.0 → 3.0.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.
|
@@ -1,12 +1,17 @@
|
|
|
1
1
|
import { z } from 'zod/v4';
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
2
|
+
declare const TRANSLATION_MEMORY_RECORDS_PAGINATION_PARAMS_SCHEMA: z.ZodObject<{
|
|
3
|
+
after: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<Record<string, unknown> | undefined, string>>, z.ZodOptional<z.ZodObject<{
|
|
4
|
+
sourceLocale: z.ZodString;
|
|
5
|
+
sourceText: z.ZodString;
|
|
6
|
+
sourcePrevContent: z.ZodOptional<z.ZodString>;
|
|
7
|
+
sourceNextContent: z.ZodOptional<z.ZodString>;
|
|
8
|
+
id: z.ZodString;
|
|
9
|
+
}, z.core.$strip>>>>;
|
|
10
|
+
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
8
11
|
}, z.core.$strip>;
|
|
9
|
-
export
|
|
12
|
+
export type TranslationMemoryRecordsPaginationParams = z.infer<typeof TRANSLATION_MEMORY_RECORDS_PAGINATION_PARAMS_SCHEMA>;
|
|
13
|
+
export type TranslationMemoryRecordsPaginationParamsInput = z.input<typeof TRANSLATION_MEMORY_RECORDS_PAGINATION_PARAMS_SCHEMA>;
|
|
14
|
+
export declare const GET_TRANSLATION_MEMORY_RECORDS_QUERY_SCHEMA: z.ZodObject<{
|
|
10
15
|
after: z.ZodOptional<z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<Record<string, unknown> | undefined, string>>, z.ZodOptional<z.ZodObject<{
|
|
11
16
|
sourceLocale: z.ZodString;
|
|
12
17
|
sourceText: z.ZodString;
|
|
@@ -15,9 +20,10 @@ export declare const GET_TRANSLATION_MEMORY_RECORDS_PAGINATION_SCHEMA: z.ZodObje
|
|
|
15
20
|
id: z.ZodString;
|
|
16
21
|
}, z.core.$strip>>>>;
|
|
17
22
|
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
23
|
+
'flex-search-query': z.ZodOptional<z.ZodString>;
|
|
18
24
|
}, z.core.$strip>;
|
|
19
|
-
export type
|
|
20
|
-
export type
|
|
25
|
+
export type GetTranslationMemoryRecordsQuery = z.infer<typeof GET_TRANSLATION_MEMORY_RECORDS_QUERY_SCHEMA>;
|
|
26
|
+
export type GetTranslationMemoryRecordsQueryInput = z.input<typeof GET_TRANSLATION_MEMORY_RECORDS_QUERY_SCHEMA>;
|
|
21
27
|
export declare const GET_TRANSLATION_MEMORY_RECORDS_RESPONSE_SCHEMA: z.ZodObject<{
|
|
22
28
|
data: z.ZodArray<z.ZodObject<{
|
|
23
29
|
id: z.ZodString;
|
|
@@ -73,6 +79,7 @@ export declare const getTranslationMemoryRecordsContract: import("@lokalise/api-
|
|
|
73
79
|
id: z.ZodString;
|
|
74
80
|
}, z.core.$strip>>>>;
|
|
75
81
|
limit: z.ZodDefault<z.ZodCoercedNumber<unknown>>;
|
|
82
|
+
'flex-search-query': z.ZodOptional<z.ZodString>;
|
|
76
83
|
}, z.core.$strip>, z.ZodUnion<[z.ZodObject<{
|
|
77
84
|
'Content-Type': z.ZodOptional<z.ZodLiteral<"application/json">>;
|
|
78
85
|
Authorization: z.ZodOptional<z.ZodString>;
|
|
@@ -103,3 +110,4 @@ export declare const getTranslationMemoryRecordsContract: import("@lokalise/api-
|
|
|
103
110
|
}, z.core.$strip>;
|
|
104
111
|
}, z.core.$strip>;
|
|
105
112
|
}>;
|
|
113
|
+
export {};
|
|
@@ -7,7 +7,7 @@ import { GROUP_REQUEST_PARAMS_SCHEMA, REQUEST_HEADER_SCHEMA } from "./common.js"
|
|
|
7
7
|
// --------------------------------------------
|
|
8
8
|
// GET /v1/groups/:groupId/records
|
|
9
9
|
// --------------------------------------------
|
|
10
|
-
|
|
10
|
+
const TRANSLATION_MEMORY_RECORDS_CURSOR_SCHEMA = z.object({
|
|
11
11
|
sourceLocale: z.string().describe('Translation memory record source locale'),
|
|
12
12
|
sourceText: z.string().describe('Translation memory record source text'),
|
|
13
13
|
sourcePrevContent: z.string().optional().describe('Translation memory record previous context'),
|
|
@@ -15,20 +15,23 @@ export const TRANSLATION_MEMORY_RECORDS_CURSOR_SCHEMA = z.object({
|
|
|
15
15
|
id: z.string().nonempty().describe('Unique translation memory record ID'),
|
|
16
16
|
});
|
|
17
17
|
const MaxRecordsLimit = 100;
|
|
18
|
-
|
|
18
|
+
const TRANSLATION_MEMORY_RECORDS_PAGINATION_PARAMS_SCHEMA = multiCursorOptionalPaginationSchema(TRANSLATION_MEMORY_RECORDS_CURSOR_SCHEMA)
|
|
19
19
|
.omit({ before: true })
|
|
20
|
-
.extend({ limit: z.coerce.number().min(1).max(MaxRecordsLimit).default(MaxRecordsLimit) });
|
|
20
|
+
.extend({ limit: z.coerce.number().int().min(1).max(MaxRecordsLimit).default(MaxRecordsLimit) });
|
|
21
|
+
export const GET_TRANSLATION_MEMORY_RECORDS_QUERY_SCHEMA = TRANSLATION_MEMORY_RECORDS_PAGINATION_PARAMS_SCHEMA.extend({
|
|
22
|
+
'flex-search-query': z.string().nonempty().optional().describe('Flex search query string'),
|
|
23
|
+
});
|
|
21
24
|
export const GET_TRANSLATION_MEMORY_RECORDS_RESPONSE_SCHEMA = z.object({
|
|
22
25
|
data: z.array(TRANSLATION_MEMORY_RECORD_SCHEMA),
|
|
23
26
|
meta: zMeta,
|
|
24
27
|
});
|
|
25
28
|
export const getTranslationMemoryRecordsContract = buildGetRoute({
|
|
26
29
|
requestPathParamsSchema: GROUP_REQUEST_PARAMS_SCHEMA,
|
|
27
|
-
requestQuerySchema:
|
|
30
|
+
requestQuerySchema: GET_TRANSLATION_MEMORY_RECORDS_QUERY_SCHEMA,
|
|
28
31
|
requestHeaderSchema: REQUEST_HEADER_SCHEMA,
|
|
29
32
|
pathResolver: (params) => `/v1/groups/${params.groupId}/records`,
|
|
30
33
|
successResponseBodySchema: GET_TRANSLATION_MEMORY_RECORDS_RESPONSE_SCHEMA,
|
|
31
|
-
description: 'Retrieve TM records for a specific group',
|
|
34
|
+
description: 'Retrieve TM records for a specific group.',
|
|
32
35
|
responseSchemasByStatusCode: {
|
|
33
36
|
...commonErrorResponses,
|
|
34
37
|
200: GET_TRANSLATION_MEMORY_RECORDS_RESPONSE_SCHEMA,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"get-records.js","sourceRoot":"","sources":["../../src/api-schemas/get-records.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mCAAmC,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AACnE,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,gCAAgC,EAAE,MAAM,eAAe,CAAA;AAChE,OAAO,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEhF,+CAA+C;AAC/C,kCAAkC;AAClC,+CAA+C;AAC/C,MAAM,
|
|
1
|
+
{"version":3,"file":"get-records.js","sourceRoot":"","sources":["../../src/api-schemas/get-records.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mCAAmC,EAAE,KAAK,EAAE,MAAM,sBAAsB,CAAA;AACjF,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AACnE,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,gCAAgC,EAAE,MAAM,eAAe,CAAA;AAChE,OAAO,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAEhF,+CAA+C;AAC/C,kCAAkC;AAClC,+CAA+C;AAC/C,MAAM,wCAAwC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;IAC5E,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IACxE,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,4CAA4C,CAAC;IAC/F,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,wCAAwC,CAAC;IAC3F,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC;CAC1E,CAAC,CAAA;AACF,MAAM,eAAe,GAAG,GAAG,CAAA;AAC3B,MAAM,mDAAmD,GAAG,mCAAmC,CAC7F,wCAAwC,CACzC;KACE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;KACtB,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC,CAAA;AAQlG,MAAM,CAAC,MAAM,2CAA2C,GACtD,mDAAmD,CAAC,MAAM,CAAC;IACzD,mBAAmB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,0BAA0B,CAAC;CAC3F,CAAC,CAAA;AAQJ,MAAM,CAAC,MAAM,8CAA8C,GAAG,CAAC,CAAC,MAAM,CAAC;IACrE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,gCAAgC,CAAC;IAC/C,IAAI,EAAE,KAAK;CACZ,CAAC,CAAA;AAKF,MAAM,CAAC,MAAM,mCAAmC,GAAG,aAAa,CAAC;IAC/D,uBAAuB,EAAE,2BAA2B;IACpD,kBAAkB,EAAE,2CAA2C;IAC/D,mBAAmB,EAAE,qBAAqB;IAC1C,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,cAAc,MAAM,CAAC,OAAO,UAAU;IAChE,yBAAyB,EAAE,8CAA8C;IACzE,WAAW,EAAE,2CAA2C;IACxD,2BAA2B,EAAE;QAC3B,GAAG,oBAAoB;QACvB,GAAG,EAAE,8CAA8C;KACpD;CACF,CAAC,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lokalise/tm-api-schemas",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.0.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "Lokalise",
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
"@lokalise/supported-languages": "^3.1.0"
|
|
41
41
|
},
|
|
42
42
|
"peerDependencies": {
|
|
43
|
-
"zod": "
|
|
43
|
+
"zod": "^4.1.12"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
46
|
"@biomejs/biome": "^2.2.4",
|