@lokalise/connector-api-contracts 1.6.0 → 1.7.1

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.
Files changed (7) hide show
  1. package/dist/contracts/envContracts.d.ts +4 -0
  2. package/dist/contracts/envContracts.js +1 -0
  3. package/dist/contracts/envContracts.js.map +1 -1
  4. package/dist/contracts/itemListContracts.d.ts +2 -0
  5. package/dist/contracts/itemListContracts.js +5 -0
  6. package/dist/contracts/itemListContracts.js.map +1 -1
  7. package/package.json +3 -1
package/dist/contracts/envContracts.d.ts CHANGED
@@ -5,6 +5,7 @@ export declare const localeDefinition: z.ZodObject<{
5
5
  name: z.ZodString;
6
6
  code: z.ZodString;
7
7
  }, z.core.$strip>>;
8
+ supportedContentTypes: z.ZodOptional<z.ZodArray<z.ZodString>>;
8
9
  }, z.core.$strip>;
9
10
  export declare const envResponseBody: z.ZodObject<{
10
11
  defaultLocale: z.ZodString;
@@ -12,6 +13,7 @@ export declare const envResponseBody: z.ZodObject<{
12
13
  name: z.ZodString;
13
14
  code: z.ZodString;
14
15
  }, z.core.$strip>>;
16
+ supportedContentTypes: z.ZodOptional<z.ZodArray<z.ZodString>>;
15
17
  cacheItemStructure: z.ZodRecord<z.ZodString, z.ZodString>;
16
18
  }, z.core.$strip>;
17
19
  export type EnvCacheItemStructure = {
@@ -27,6 +29,7 @@ export declare const getEnvContract: import("@lokalise/api-contracts").GetRouteD
27
29
  name: z.ZodString;
28
30
  code: z.ZodString;
29
31
  }, z.core.$strip>>;
32
+ supportedContentTypes: z.ZodOptional<z.ZodArray<z.ZodString>>;
30
33
  cacheItemStructure: z.ZodRecord<z.ZodString, z.ZodString>;
31
34
  }, z.core.$strip>, undefined, undefined, z.ZodObject<{
32
35
  'ce-config': z.ZodString;
@@ -38,6 +41,7 @@ export declare const getEnvContract: import("@lokalise/api-contracts").GetRouteD
38
41
  name: z.ZodString;
39
42
  code: z.ZodString;
40
43
  }, z.core.$strip>>;
44
+ supportedContentTypes: z.ZodOptional<z.ZodArray<z.ZodString>>;
41
45
  cacheItemStructure: z.ZodRecord<z.ZodString, z.ZodString>;
42
46
  }, z.core.$strip>;
43
47
  403: z.ZodObject<{
package/dist/contracts/envContracts.js CHANGED
@@ -7,6 +7,7 @@ export const localeDefinition = z.object({
7
7
  name: z.string(),
8
8
  code: z.string(),
9
9
  })),
10
+ supportedContentTypes: z.array(z.string()).optional(), // domain content types, e. g. "newsletters", "campaigns", "emails" etc
10
11
  });
11
12
  export const envResponseBody = localeDefinition.extend({
12
13
  cacheItemStructure: z.record(z.string(), z.string()),
package/dist/contracts/envContracts.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"envContracts.js","sourceRoot":"","sources":["../../src/contracts/envContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,4BAA4B,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAA;AAEnG,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,OAAO,EAAE,CAAC,CAAC,KAAK,CACd,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB,CAAC,CACH;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC;IACrD,kBAAkB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;CACrD,CAAC,CAAA;AAYF,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;IAC1C,YAAY,EAAE,GAAG,EAAE,CAAC,MAAM;IAC1B,WAAW,EACT,uIAAuI;IACzI,yBAAyB,EAAE,eAAe;IAC1C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,eAAe;QACpB,GAAG,EAAE,4BAA4B;KAClC;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA"}
1
+ {"version":3,"file":"envContracts.js","sourceRoot":"","sources":["../../src/contracts/envContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,4BAA4B,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAA;AAEnG,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,OAAO,EAAE,CAAC,CAAC,KAAK,CACd,CAAC,CAAC,MAAM,CAAC;QACP,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;KACjB,CAAC,CACH;IACD,qBAAqB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,uEAAuE;CAC/H,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,gBAAgB,CAAC,MAAM,CAAC;IACrD,kBAAkB,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;CACrD,CAAC,CAAA;AAYF,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;IAC1C,YAAY,EAAE,GAAG,EAAE,CAAC,MAAM;IAC1B,WAAW,EACT,uIAAuI;IACzI,yBAAyB,EAAE,eAAe;IAC1C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,eAAe;QACpB,GAAG,EAAE,4BAA4B;KAClC;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA"}
package/dist/contracts/itemListContracts.d.ts CHANGED
@@ -2,6 +2,7 @@ import { z } from 'zod/v4';
2
2
  export declare const itemListRequestQueryString: z.ZodObject<{
3
3
  limit: z.ZodOptional<z.ZodString>;
4
4
  cursor: z.ZodOptional<z.ZodString>;
5
+ contentTypes: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodArray<z.ZodString>>;
5
6
  }, z.core.$strip>;
6
7
  export declare const itemListEntry: z.ZodObject<{
7
8
  uniqueId: z.ZodString;
@@ -43,6 +44,7 @@ export declare const getItemListContract: import("@lokalise/api-contracts").GetR
43
44
  }, z.core.$strip>, undefined, z.ZodObject<{
44
45
  limit: z.ZodOptional<z.ZodString>;
45
46
  cursor: z.ZodOptional<z.ZodString>;
47
+ contentTypes: z.ZodPipe<z.ZodTransform<unknown, unknown>, z.ZodArray<z.ZodString>>;
46
48
  }, z.core.$strip>, z.ZodObject<{
47
49
  'ce-config': z.ZodString;
48
50
  'ce-auth': z.ZodString;
package/dist/contracts/itemListContracts.js CHANGED
@@ -1,5 +1,6 @@
1
1
  import { paginatedResponseSchema } from '@lokalise/api-common';
2
2
  import { buildGetRoute } from '@lokalise/api-contracts';
3
+ import { toArrayPreprocessor } from '@lokalise/zod-extras';
3
4
  import { z } from 'zod/v4';
4
5
  import { MAX_TITLE_LENGTH } from "./cacheContracts.js";
5
6
  import { COMMON_ERROR_RESPONSE_SCHEMA, CONNECTOR_REQUEST_HEADERS_SCHEMA, ITEM_IDENTIFIER_SCHEMA, } from "./commonSchemas.js";
@@ -15,6 +16,10 @@ export const itemListRequestQueryString = z.object({
15
16
  * For this param you are expected to pass the cursor value returned in the response to the last request.
16
17
  */
17
18
  cursor: z.string().optional(),
19
+ /**
20
+ * Domain content type to filter by, e. g. "newsletters", "campaigns", "emails". In case more than one value is provided, cursor is expected to keep track of what content type it is fetching now.
21
+ */
22
+ contentTypes: z.preprocess(toArrayPreprocessor, z.array(z.string())),
18
23
  });
19
24
  export const itemListEntry = ITEM_IDENTIFIER_SCHEMA.extend({
20
25
  fields: z.looseObject({}),
package/dist/contracts/itemListContracts.js.map CHANGED
@@ -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,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,EACL,4BAA4B,EAC5B,gCAAgC,EAChC,sBAAsB,GACvB,MAAM,oBAAoB,CAAA;AAE3B,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD;;;OAGG;IACH,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B;;;;OAIG;IACH,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAA;AAEF,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;CAC7C,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,aAAa,CAAC,CAAA;AAE1E,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,4BAA4B;KAClC;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA"}
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,mBAAmB,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAA;AACtD,OAAO,EACL,4BAA4B,EAC5B,gCAAgC,EAChC,sBAAsB,GACvB,MAAM,oBAAoB,CAAA;AAE3B,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD;;;OAGG;IACH,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B;;;;OAIG;IACH,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC7B;;OAEG;IACH,YAAY,EAAE,CAAC,CAAC,UAAU,CAAC,mBAAmB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;CACrE,CAAC,CAAA;AAEF,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;CAC7C,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,uBAAuB,CAAC,aAAa,CAAC,CAAA;AAE1E,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,4BAA4B;KAClC;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lokalise/connector-api-contracts",
3
- "version": "1.6.0",
3
+ "version": "1.7.1",
4
4
  "description": "Lokalise Connector API schemas and contracts",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -33,6 +33,7 @@
33
33
  },
34
34
  "peerDependencies": {
35
35
  "@lokalise/api-common": ">=6.1.0",
36
+ "@lokalise/zod-extras": ">=3.0.0",
36
37
  "zod": ">=3.25.76 <5.0.0"
37
38
  },
38
39
  "devDependencies": {
@@ -41,6 +42,7 @@
41
42
  "@lokalise/api-common": "^6.1.0",
42
43
  "@lokalise/biome-config": "^3.1.0",
43
44
  "@lokalise/tsconfig": "^2.0.0",
45
+ "@lokalise/zod-extras": "^3.0.0",
44
46
  "@vitest/coverage-v8": "^3.2.4",
45
47
  "rimraf": "^6.0.1",
46
48
  "typescript": "^5.9.2",