@lokalise/connector-api-contracts 2.9.1 → 3.1.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/contracts/itemListContracts.d.ts +0 -2
- package/dist/contracts/itemListContracts.js +1 -11
- package/dist/contracts/itemListContracts.js.map +1 -1
- package/dist/contracts/manifestContracts.d.ts +24 -0
- package/dist/contracts/manifestContracts.js +3 -3
- package/dist/contracts/manifestContracts.js.map +1 -1
- package/package.json +1 -1
|
@@ -3,7 +3,6 @@ export declare const itemListRequestQueryString: z.ZodObject<{
|
|
|
3
3
|
limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
|
|
4
4
|
cursor: z.ZodOptional<z.ZodString>;
|
|
5
5
|
defaultLocale: z.ZodOptional<z.ZodString>;
|
|
6
|
-
contentTypes: z.ZodOptional<z.ZodPreprocess<z.ZodArray<z.ZodString>>>;
|
|
7
6
|
$filter: z.ZodOptional<z.ZodString>;
|
|
8
7
|
}, z.core.$strip>;
|
|
9
8
|
export type ItemListRequestQueryString = z.infer<typeof itemListRequestQueryString>;
|
|
@@ -52,7 +51,6 @@ export declare const getItemListContract: import("@lokalise/api-contracts").GetR
|
|
|
52
51
|
limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
|
|
53
52
|
cursor: z.ZodOptional<z.ZodString>;
|
|
54
53
|
defaultLocale: z.ZodOptional<z.ZodString>;
|
|
55
|
-
contentTypes: z.ZodOptional<z.ZodPreprocess<z.ZodArray<z.ZodString>>>;
|
|
56
54
|
$filter: z.ZodOptional<z.ZodString>;
|
|
57
55
|
}, z.core.$strip>, z.ZodObject<{
|
|
58
56
|
'ce-config': z.ZodString;
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { paginatedResponseSchema } from '@lokalise/api-common';
|
|
2
2
|
import { buildGetRoute } from '@lokalise/api-contracts';
|
|
3
|
-
import { toArrayPreprocessor } from '@lokalise/zod-extras';
|
|
4
3
|
import { z } from 'zod/v4';
|
|
5
4
|
import { MAX_TITLE_LENGTH } from "./cacheContracts.js";
|
|
6
5
|
import { COMMON_ERROR_RESPONSE_SCHEMA_UNION, CONNECTOR_REQUEST_HEADERS_SCHEMA, DEFAULT_LOCALE_SCHEMA, ITEM_IDENTIFIER_SCHEMA, RATE_LIMIT_RESPONSE_HEADERS_SCHEMA, } from "./commonSchemas.js";
|
|
@@ -24,15 +23,6 @@ export const itemListRequestQueryString = z.object({
|
|
|
24
23
|
* resolving it from third-party configuration, for more reliable locale matching.
|
|
25
24
|
*/
|
|
26
25
|
defaultLocale: DEFAULT_LOCALE_SCHEMA.optional(),
|
|
27
|
-
/**
|
|
28
|
-
* @deprecated Use `$filter=contentType in ('article', 'page')` instead.
|
|
29
|
-
*
|
|
30
|
-
* Domain content type to filter by, e.g. "newsletters", "campaigns", "emails".
|
|
31
|
-
* In case more than one value is provided, cursor is expected to keep track of
|
|
32
|
-
* what content type it is fetching now. If not set, all supported content types
|
|
33
|
-
* will be iterated through.
|
|
34
|
-
*/
|
|
35
|
-
contentTypes: z.preprocess(toArrayPreprocessor, z.array(z.string())).optional(),
|
|
36
26
|
/**
|
|
37
27
|
* OData $filter expression for filtering items.
|
|
38
28
|
* Parsed and validated by the connector adapter.
|
|
@@ -64,7 +54,7 @@ export const itemListRequestQueryString = z.object({
|
|
|
64
54
|
* $filter=parentGroup in ('folder-a', 'folder-b')
|
|
65
55
|
* ```
|
|
66
56
|
*
|
|
67
|
-
* Filter by content types
|
|
57
|
+
* Filter by content types:
|
|
68
58
|
* ```
|
|
69
59
|
* $filter=contentType in ('article', 'page')
|
|
70
60
|
* ```
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"itemListContracts.js","sourceRoot":"","sources":["../../src/contracts/itemListContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"itemListContracts.js","sourceRoot":"","sources":["../../src/contracts/itemListContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,EACL,kCAAkC,EAClC,gCAAgC,EAChC,qBAAqB,EACrB,sBAAsB,EACtB,kCAAkC,GACnC,MAAM,oBAAoB,CAAA;AAE3B,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD;;;;;OAKG;IACH,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IACpD;;;;OAIG;IACH,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B;;;;OAIG;IACH,aAAa,EAAE,qBAAqB,CAAC,QAAQ,EAAE;IAC/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmDG;IACH,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC/B,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,aAAa,GAAG,sBAAsB,CAAC,MAAM,CAAC;IACzD,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;IAC5C,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CACvC,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,aAAa,CAAC,CAAA;AAI1E,MAAM,CAAC,MAAM,mBAAmB,GAAG,aAAa,CAAC;IAC/C,YAAY,EAAE,GAAG,EAAE,CAAC,WAAW;IAC/B,WAAW,EAAE,6BAA6B;IAC1C,kBAAkB,EAAE,0BAA0B;IAC9C,yBAAyB,EAAE,oBAAoB;IAC/C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,oBAAoB;QACzB,GAAG,EAAE,kCAAkC;KACxC;IACD,mBAAmB,EAAE,gCAAgC;IACrD,oBAAoB,EAAE,kCAAkC;CACzD,CAAC,CAAA"}
|
|
@@ -62,6 +62,30 @@ export declare const MANIFEST_SCHEMA: z.ZodObject<{
|
|
|
62
62
|
}, z.core.$strip>>;
|
|
63
63
|
}, z.core.$strip>;
|
|
64
64
|
export type Manifest = z.infer<typeof MANIFEST_SCHEMA>;
|
|
65
|
+
export declare const MANIFESTS_BY_MODE_SCHEMA: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
66
|
+
authentication: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
67
|
+
type: z.ZodLiteral<"oauth">;
|
|
68
|
+
}, z.core.$strip>, z.ZodObject<{
|
|
69
|
+
type: z.ZodLiteral<"credentials">;
|
|
70
|
+
fields: z.ZodArray<z.ZodObject<{
|
|
71
|
+
id: z.ZodString;
|
|
72
|
+
type: z.ZodString;
|
|
73
|
+
}, z.core.$strip>>;
|
|
74
|
+
}, z.core.$strip>], "type">;
|
|
75
|
+
filters: z.ZodArray<z.ZodObject<{
|
|
76
|
+
id: z.ZodString;
|
|
77
|
+
type: z.ZodString;
|
|
78
|
+
query: z.ZodString;
|
|
79
|
+
defaultValue: z.ZodOptional<z.ZodAny>;
|
|
80
|
+
constraintQuery: z.ZodOptional<z.ZodString>;
|
|
81
|
+
dependsOn: z.ZodOptional<z.ZodString>;
|
|
82
|
+
}, z.core.$strip>>;
|
|
83
|
+
capabilities: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
84
|
+
version: z.ZodNumber;
|
|
85
|
+
data: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
|
|
86
|
+
}, z.core.$strip>>;
|
|
87
|
+
}, z.core.$strip>>;
|
|
88
|
+
export type ManifestsByMode = z.infer<typeof MANIFESTS_BY_MODE_SCHEMA>;
|
|
65
89
|
export declare const getManifestContract: import("@lokalise/api-contracts").GetRouteDefinition<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
66
90
|
authentication: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
67
91
|
type: z.ZodLiteral<"oauth">;
|
|
@@ -33,13 +33,13 @@ export const MANIFEST_SCHEMA = z.object({
|
|
|
33
33
|
filters: z.array(FILTER_SCHEMA),
|
|
34
34
|
capabilities: z.record(z.string(), CAPABILITY_SCHEMA),
|
|
35
35
|
});
|
|
36
|
-
const
|
|
36
|
+
export const MANIFESTS_BY_MODE_SCHEMA = z.record(z.string(), MANIFEST_SCHEMA);
|
|
37
37
|
export const getManifestContract = buildGetRoute({
|
|
38
38
|
pathResolver: () => `/manifest`,
|
|
39
39
|
description: 'Get connector manifests for every mode',
|
|
40
|
-
successResponseBodySchema:
|
|
40
|
+
successResponseBodySchema: MANIFESTS_BY_MODE_SCHEMA,
|
|
41
41
|
responseSchemasByStatusCode: {
|
|
42
|
-
200:
|
|
42
|
+
200: MANIFESTS_BY_MODE_SCHEMA,
|
|
43
43
|
403: COMMON_ERROR_RESPONSE_SCHEMA_UNION,
|
|
44
44
|
},
|
|
45
45
|
requestHeaderSchema: CONNECTOR_REQUEST_HEADERS_SCHEMA_PRE_SETUP,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifestContracts.js","sourceRoot":"","sources":["../../src/contracts/manifestContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EACL,kCAAkC,EAClC,0CAA0C,GAC3C,MAAM,oBAAoB,CAAA;AAE3B,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;CACzB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;IAC9B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC;CACnC,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAChE,2BAA2B;IAC3B,iCAAiC;CAClC,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,YAAY,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAChC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACpC,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,cAAc,EAAE,qBAAqB;IACrC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC;IAC/B,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC;CACtD,CAAC,CAAA;AAIF,MAAM,
|
|
1
|
+
{"version":3,"file":"manifestContracts.js","sourceRoot":"","sources":["../../src/contracts/manifestContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EACL,kCAAkC,EAClC,0CAA0C,GAC3C,MAAM,oBAAoB,CAAA;AAE3B,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;CACjB,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;CACzB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;IAC9B,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,iBAAiB,CAAC;CACnC,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,kBAAkB,CAAC,MAAM,EAAE;IAChE,2BAA2B;IAC3B,iCAAiC;CAClC,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,YAAY,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IAChC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACtC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACpC,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;CACnC,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,cAAc,EAAE,qBAAqB;IACrC,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC;IAC/B,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,iBAAiB,CAAC;CACtD,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,eAAe,CAAC,CAAA;AAI7E,MAAM,CAAC,MAAM,mBAAmB,GAAG,aAAa,CAAC;IAC/C,YAAY,EAAE,GAAG,EAAE,CAAC,WAAW;IAC/B,WAAW,EAAE,wCAAwC;IACrD,yBAAyB,EAAE,wBAAwB;IACnD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,wBAAwB;QAC7B,GAAG,EAAE,kCAAkC;KACxC;IACD,mBAAmB,EAAE,0CAA0C;CAChE,CAAC,CAAA"}
|