@lokalise/connector-api-contracts 1.2.2 → 1.3.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/schemas/authSchemas.d.ts +30 -4
- package/dist/schemas/cacheSchemas.d.ts +51 -0
- package/dist/schemas/cacheSchemas.js +23 -1
- package/dist/schemas/cacheSchemas.js.map +1 -1
- package/dist/schemas/envSchemas.d.ts +18 -1
- package/dist/schemas/itemListContract.d.ts +27 -1
- package/dist/schemas/publishSchemas.d.ts +13 -1
- package/dist/schemas/translateSchemas.d.ts +25 -1
- package/package.json +2 -2
|
@@ -14,7 +14,14 @@ export declare const getAuthContract: import("@lokalise/api-contracts").GetRoute
|
|
|
14
14
|
}, z.core.$strip>, undefined, undefined, z.ZodObject<{
|
|
15
15
|
'ce-config': z.ZodString;
|
|
16
16
|
'ce-auth': z.ZodString;
|
|
17
|
-
}, z.core.$strip>, false, false
|
|
17
|
+
}, z.core.$strip>, false, false, {
|
|
18
|
+
200: z.ZodObject<{
|
|
19
|
+
type: z.ZodEnum<{
|
|
20
|
+
OAuth: "OAuth";
|
|
21
|
+
apiToken: "apiToken";
|
|
22
|
+
}>;
|
|
23
|
+
}, z.core.$strip>;
|
|
24
|
+
}>;
|
|
18
25
|
export declare const postAuthResponseBody: z.ZodObject<{}, z.core.$loose>;
|
|
19
26
|
export type PostAuthResponseBody = Record<string, unknown> & {
|
|
20
27
|
url?: string;
|
|
@@ -22,11 +29,23 @@ export type PostAuthResponseBody = Record<string, unknown> & {
|
|
|
22
29
|
export declare const postAuthContract: import("@lokalise/api-contracts").PayloadRouteDefinition<z.ZodNever, z.ZodObject<{}, z.core.$loose>, undefined, undefined, z.ZodObject<{
|
|
23
30
|
'ce-config': z.ZodString;
|
|
24
31
|
'ce-auth': z.ZodString;
|
|
25
|
-
}, z.core.$strip>, false, false
|
|
32
|
+
}, z.core.$strip>, false, false, {
|
|
33
|
+
200: z.ZodObject<{}, z.core.$loose>;
|
|
34
|
+
403: z.ZodObject<{
|
|
35
|
+
message: z.ZodString;
|
|
36
|
+
statusCode: z.ZodNumber;
|
|
37
|
+
}, z.core.$strip>;
|
|
38
|
+
}>;
|
|
26
39
|
export declare const postAuthRefreshContract: import("@lokalise/api-contracts").PayloadRouteDefinition<z.ZodNever, z.ZodObject<{}, z.core.$loose>, undefined, undefined, z.ZodObject<{
|
|
27
40
|
'ce-config': z.ZodString;
|
|
28
41
|
'ce-auth': z.ZodString;
|
|
29
|
-
}, z.core.$strip>, false, false
|
|
42
|
+
}, z.core.$strip>, false, false, {
|
|
43
|
+
200: z.ZodObject<{}, z.core.$loose>;
|
|
44
|
+
403: z.ZodObject<{
|
|
45
|
+
message: z.ZodString;
|
|
46
|
+
statusCode: z.ZodNumber;
|
|
47
|
+
}, z.core.$strip>;
|
|
48
|
+
}>;
|
|
30
49
|
export declare const postAuthResponseRequestBody: z.ZodObject<{
|
|
31
50
|
query: z.ZodObject<{}, z.core.$loose>;
|
|
32
51
|
body: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
|
|
@@ -42,4 +61,11 @@ export declare const postAuthResponseContract: import("@lokalise/api-contracts")
|
|
|
42
61
|
}, z.core.$strip>, z.ZodObject<{}, z.core.$loose>, undefined, undefined, z.ZodObject<{
|
|
43
62
|
'ce-config': z.ZodString;
|
|
44
63
|
'ce-auth': z.ZodString;
|
|
45
|
-
}, z.core.$strip>, false, false
|
|
64
|
+
}, z.core.$strip>, false, false, {
|
|
65
|
+
200: z.ZodObject<{}, z.core.$loose>;
|
|
66
|
+
403: z.ZodObject<{
|
|
67
|
+
message: z.ZodString;
|
|
68
|
+
errorCode: z.ZodNumber;
|
|
69
|
+
details: z.ZodObject<{}, z.core.$loose>;
|
|
70
|
+
}, z.core.$strip>;
|
|
71
|
+
}>;
|
|
@@ -98,3 +98,54 @@ export type CacheRequestBody = z.infer<typeof cacheRequestBody>;
|
|
|
98
98
|
* @deprecated Use `getItemList` API instead
|
|
99
99
|
*/
|
|
100
100
|
export type CacheResponseBody = z.infer<typeof cacheResponseBody>;
|
|
101
|
+
export declare const getCacheContract: import("@lokalise/api-contracts").GetRouteDefinition<z.ZodObject<{
|
|
102
|
+
items: z.ZodArray<z.ZodObject<{
|
|
103
|
+
uniqueId: z.ZodString;
|
|
104
|
+
groupId: z.ZodString;
|
|
105
|
+
metadata: z.ZodRecord<z.ZodAny, z.ZodAny>;
|
|
106
|
+
}, z.core.$strip>>;
|
|
107
|
+
}, z.core.$strip>, undefined, z.ZodObject<{
|
|
108
|
+
next: z.ZodOptional<z.ZodString>;
|
|
109
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
110
|
+
'ce-config': z.ZodString;
|
|
111
|
+
'ce-auth': z.ZodString;
|
|
112
|
+
}, z.core.$strip>, false, false, {
|
|
113
|
+
200: z.ZodObject<{
|
|
114
|
+
items: z.ZodArray<z.ZodObject<{
|
|
115
|
+
uniqueId: z.ZodString;
|
|
116
|
+
groupId: z.ZodString;
|
|
117
|
+
metadata: z.ZodRecord<z.ZodAny, z.ZodAny>;
|
|
118
|
+
}, z.core.$strip>>;
|
|
119
|
+
next: z.ZodOptional<z.ZodString>;
|
|
120
|
+
}, z.core.$strip>;
|
|
121
|
+
}>;
|
|
122
|
+
export declare const postCacheItemsContract: import("@lokalise/api-contracts").PayloadRouteDefinition<z.ZodObject<{
|
|
123
|
+
items: z.ZodArray<z.ZodObject<{
|
|
124
|
+
uniqueId: z.ZodString;
|
|
125
|
+
groupId: z.ZodString;
|
|
126
|
+
metadata: z.ZodRecord<z.ZodAny, z.ZodAny>;
|
|
127
|
+
}, z.core.$strip>>;
|
|
128
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
129
|
+
items: z.ZodArray<z.ZodObject<{
|
|
130
|
+
uniqueId: z.ZodString;
|
|
131
|
+
groupId: z.ZodString;
|
|
132
|
+
metadata: z.ZodRecord<z.ZodAny, z.ZodAny>;
|
|
133
|
+
fields: z.ZodObject<{}, z.core.$loose>;
|
|
134
|
+
title: z.ZodString;
|
|
135
|
+
groupTitle: z.ZodString;
|
|
136
|
+
}, z.core.$strip>>;
|
|
137
|
+
}, z.core.$strip>, undefined, undefined, z.ZodObject<{
|
|
138
|
+
'ce-config': z.ZodString;
|
|
139
|
+
'ce-auth': z.ZodString;
|
|
140
|
+
}, z.core.$strip>, false, false, {
|
|
141
|
+
200: z.ZodObject<{
|
|
142
|
+
items: z.ZodArray<z.ZodObject<{
|
|
143
|
+
uniqueId: z.ZodString;
|
|
144
|
+
groupId: z.ZodString;
|
|
145
|
+
metadata: z.ZodRecord<z.ZodAny, z.ZodAny>;
|
|
146
|
+
fields: z.ZodObject<{}, z.core.$loose>;
|
|
147
|
+
title: z.ZodString;
|
|
148
|
+
groupTitle: z.ZodString;
|
|
149
|
+
}, z.core.$strip>>;
|
|
150
|
+
}, z.core.$strip>;
|
|
151
|
+
}>;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
+
import { buildGetRoute, buildPayloadRoute } from '@lokalise/api-contracts';
|
|
1
2
|
import { z } from 'zod/v4';
|
|
2
3
|
import { isValidNextParam } from "../utils/nextParamUtils.js";
|
|
3
|
-
import { itemIdentifier } from "./commonSchemas.js";
|
|
4
|
+
import { CONNECTOR_REQUEST_HEADERS_SCHEMA, itemIdentifier } from "./commonSchemas.js";
|
|
4
5
|
export const MAX_TITLE_LENGTH = 256;
|
|
5
6
|
/**
|
|
6
7
|
* @deprecated Use `getItemList` API instead
|
|
@@ -61,4 +62,25 @@ export const parseUniqueId = (uniqueId) => {
|
|
|
61
62
|
const [entryId, fieldId] = uniqueId.split(':');
|
|
62
63
|
return { entryId, fieldId };
|
|
63
64
|
};
|
|
65
|
+
export const getCacheContract = buildGetRoute({
|
|
66
|
+
pathResolver: () => `/cache`,
|
|
67
|
+
description: 'Get the identifiers of translatable items',
|
|
68
|
+
successResponseBodySchema: cacheRequestBody,
|
|
69
|
+
requestQuerySchema: listCacheRequestQueryString,
|
|
70
|
+
responseSchemasByStatusCode: {
|
|
71
|
+
200: listCacheResponseBody,
|
|
72
|
+
},
|
|
73
|
+
requestHeaderSchema: CONNECTOR_REQUEST_HEADERS_SCHEMA,
|
|
74
|
+
});
|
|
75
|
+
export const postCacheItemsContract = buildPayloadRoute({
|
|
76
|
+
method: 'post',
|
|
77
|
+
pathResolver: () => `/cache/items`,
|
|
78
|
+
description: 'Get the translatable items using their identifiers',
|
|
79
|
+
requestBodySchema: cacheRequestBody,
|
|
80
|
+
successResponseBodySchema: cacheResponseBody,
|
|
81
|
+
responseSchemasByStatusCode: {
|
|
82
|
+
200: cacheResponseBody,
|
|
83
|
+
},
|
|
84
|
+
requestHeaderSchema: CONNECTOR_REQUEST_HEADERS_SCHEMA,
|
|
85
|
+
});
|
|
64
86
|
//# sourceMappingURL=cacheSchemas.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"cacheSchemas.js","sourceRoot":"","sources":["../../src/schemas/cacheSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;
|
|
1
|
+
{"version":3,"file":"cacheSchemas.js","sourceRoot":"","sources":["../../src/schemas/cacheSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC1E,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAC7D,OAAO,EAAE,gCAAgC,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAErF,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,CAAA;AAEnC;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC;IAC7C,MAAM,EAAE,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC;IACzB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC;IACvC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,gBAAgB,CAAC;CAC7C,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,SAAS,CAAC,MAAM,CAAC;IAC/C,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC1C,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC;KACzC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,QAAQ,CAAC,GAAG,EAAE;QACb,OAAO,EAAE,wEAAwE;KAClF,CAAC;SACD,QAAQ,EAAE;CACd,CAAC;KACD,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE;IACrD,OAAO,EAAE,6DAA6D;CACvE,CAAC,CAAA;AAEJ;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC;IAC9B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC5B,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC;CAC1B,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC;CAC/B,CAAC,CAAA;AAWF;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,OAAe,EAAE,OAAe,EAAE,EAAE,CAAC,GAAG,OAAO,IAAI,OAAO,EAAE,CAAA;AAC1F;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,EAAE;IAChD,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IAC9C,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,CAAA;AAC7B,CAAC,CAAA;AAoBD,MAAM,CAAC,MAAM,gBAAgB,GAAG,aAAa,CAAC;IAC5C,YAAY,EAAE,GAAG,EAAE,CAAC,QAAQ;IAC5B,WAAW,EAAE,2CAA2C;IACxD,yBAAyB,EAAE,gBAAgB;IAC3C,kBAAkB,EAAE,2BAA2B;IAC/C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,qBAAqB;KAC3B;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;IACtD,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,GAAG,EAAE,CAAC,cAAc;IAClC,WAAW,EAAE,oDAAoD;IACjE,iBAAiB,EAAE,gBAAgB;IACnC,yBAAyB,EAAE,iBAAiB;IAC5C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,iBAAiB;KACvB;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA"}
|
|
@@ -31,4 +31,21 @@ export declare const getEnvContract: import("@lokalise/api-contracts").GetRouteD
|
|
|
31
31
|
}, z.core.$strip>, undefined, undefined, z.ZodObject<{
|
|
32
32
|
'ce-config': z.ZodString;
|
|
33
33
|
'ce-auth': z.ZodString;
|
|
34
|
-
}, z.core.$strip>, false, false
|
|
34
|
+
}, z.core.$strip>, false, false, {
|
|
35
|
+
200: z.ZodObject<{
|
|
36
|
+
defaultLocale: z.ZodString;
|
|
37
|
+
locales: z.ZodArray<z.ZodObject<{
|
|
38
|
+
name: z.ZodString;
|
|
39
|
+
code: z.ZodString;
|
|
40
|
+
}, z.core.$strip>>;
|
|
41
|
+
cacheItemStructure: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
42
|
+
}, z.core.$strip>;
|
|
43
|
+
403: z.ZodObject<{
|
|
44
|
+
statusCode: z.ZodNumber;
|
|
45
|
+
payload: z.ZodObject<{
|
|
46
|
+
message: z.ZodString;
|
|
47
|
+
errorCode: z.ZodString;
|
|
48
|
+
details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
49
|
+
}, z.core.$strip>;
|
|
50
|
+
}, z.core.$strip>;
|
|
51
|
+
}>;
|
|
@@ -50,4 +50,30 @@ export declare const getItemListContract: import("@lokalise/api-contracts").GetR
|
|
|
50
50
|
}, z.core.$strip>, z.ZodObject<{
|
|
51
51
|
'ce-config': z.ZodString;
|
|
52
52
|
'ce-auth': z.ZodString;
|
|
53
|
-
}, z.core.$strip>, false, false
|
|
53
|
+
}, z.core.$strip>, false, false, {
|
|
54
|
+
200: z.ZodObject<{
|
|
55
|
+
data: z.ZodArray<z.ZodObject<{
|
|
56
|
+
items: z.ZodArray<z.ZodObject<{
|
|
57
|
+
uniqueId: z.ZodString;
|
|
58
|
+
groupId: z.ZodString;
|
|
59
|
+
metadata: z.ZodRecord<z.ZodAny, z.ZodAny>;
|
|
60
|
+
fields: z.ZodObject<{}, z.core.$loose>;
|
|
61
|
+
title: z.ZodString;
|
|
62
|
+
groupTitle: z.ZodString;
|
|
63
|
+
}, z.core.$strip>>;
|
|
64
|
+
}, z.core.$strip>>;
|
|
65
|
+
meta: z.ZodObject<{
|
|
66
|
+
count: z.ZodNumber;
|
|
67
|
+
cursor: z.ZodOptional<z.ZodString>;
|
|
68
|
+
hasMore: z.ZodOptional<z.ZodBoolean>;
|
|
69
|
+
}, z.core.$strip>;
|
|
70
|
+
}, z.core.$strip>;
|
|
71
|
+
401: z.ZodObject<{
|
|
72
|
+
statusCode: z.ZodNumber;
|
|
73
|
+
payload: z.ZodObject<{
|
|
74
|
+
message: z.ZodString;
|
|
75
|
+
errorCode: z.ZodString;
|
|
76
|
+
details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
77
|
+
}, z.core.$strip>;
|
|
78
|
+
}, z.core.$strip>;
|
|
79
|
+
}>;
|
|
@@ -42,4 +42,16 @@ export declare const postPublishContract: import("@lokalise/api-contracts").Payl
|
|
|
42
42
|
}, z.core.$strip>, undefined, undefined, z.ZodObject<{
|
|
43
43
|
'ce-config': z.ZodString;
|
|
44
44
|
'ce-auth': z.ZodString;
|
|
45
|
-
}, z.core.$strip>, false, false
|
|
45
|
+
}, z.core.$strip>, false, false, {
|
|
46
|
+
200: z.ZodObject<{
|
|
47
|
+
statusCode: z.ZodNumber;
|
|
48
|
+
message: z.ZodOptional<z.ZodString>;
|
|
49
|
+
payload: z.ZodOptional<z.ZodObject<{
|
|
50
|
+
message: z.ZodString;
|
|
51
|
+
errorCode: z.ZodString;
|
|
52
|
+
details: z.ZodObject<{
|
|
53
|
+
errors: z.ZodArray<z.ZodObject<{}, z.core.$loose>>;
|
|
54
|
+
}, z.core.$strip>;
|
|
55
|
+
}, z.core.$strip>>;
|
|
56
|
+
}, z.core.$strip>;
|
|
57
|
+
}>;
|
|
@@ -51,4 +51,28 @@ export declare const postTranslateContract: import("@lokalise/api-contracts").Pa
|
|
|
51
51
|
}, z.core.$strip>, undefined, undefined, z.ZodObject<{
|
|
52
52
|
'ce-config': z.ZodString;
|
|
53
53
|
'ce-auth': z.ZodString;
|
|
54
|
-
}, z.core.$strip>, false, false
|
|
54
|
+
}, z.core.$strip>, false, false, {
|
|
55
|
+
200: z.ZodObject<{
|
|
56
|
+
items: z.ZodArray<z.ZodObject<{
|
|
57
|
+
uniqueId: z.ZodString;
|
|
58
|
+
groupId: z.ZodString;
|
|
59
|
+
metadata: z.ZodRecord<z.ZodAny, z.ZodAny>;
|
|
60
|
+
translations: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
61
|
+
}, z.core.$strip>>;
|
|
62
|
+
payload: z.ZodOptional<z.ZodObject<{
|
|
63
|
+
message: z.ZodString;
|
|
64
|
+
errorCode: z.ZodString;
|
|
65
|
+
details: z.ZodObject<{
|
|
66
|
+
errors: z.ZodArray<z.ZodObject<{}, z.core.$loose>>;
|
|
67
|
+
}, z.core.$strip>;
|
|
68
|
+
}, z.core.$strip>>;
|
|
69
|
+
}, z.core.$strip>;
|
|
70
|
+
403: z.ZodObject<{
|
|
71
|
+
statusCode: z.ZodNumber;
|
|
72
|
+
payload: z.ZodObject<{
|
|
73
|
+
message: z.ZodString;
|
|
74
|
+
errorCode: z.ZodString;
|
|
75
|
+
details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
76
|
+
}, z.core.$strip>;
|
|
77
|
+
}, z.core.$strip>;
|
|
78
|
+
}>;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@lokalise/connector-api-contracts",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.3.0",
|
|
4
4
|
"description": "Lokalise Connector API schemas and contracts",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"url": "https://github.com/lokalise/service-contracts.git"
|
|
30
30
|
},
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"@lokalise/api-contracts": "^5.
|
|
32
|
+
"@lokalise/api-contracts": "^5.2.0"
|
|
33
33
|
},
|
|
34
34
|
"peerDependencies": {
|
|
35
35
|
"@lokalise/api-common": ">=6.1.0",
|