@lokalise/connector-api-contracts 1.1.1 → 1.2.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/schemas/authSchemas.d.ts +9 -5
  2. package/dist/schemas/authSchemas.js +6 -6
  3. package/dist/schemas/authSchemas.js.map +1 -1
  4. package/dist/schemas/itemListContract.d.ts +16 -10
  5. package/dist/schemas/itemListContract.js +4 -16
  6. package/dist/schemas/itemListContract.js.map +1 -1
  7. package/package.json +3 -1
package/dist/schemas/authSchemas.d.ts CHANGED
@@ -27,15 +27,19 @@ export declare const postAuthRefreshContract: import("@lokalise/api-contracts").
27
27
  'CE-Config': z.ZodString;
28
28
  'CE-Auth': z.ZodString;
29
29
  }, z.core.$strip>, false, false>;
30
- export declare const postAuthResultRequestBody: z.ZodObject<{
30
+ export declare const postAuthResponseRequestBody: z.ZodObject<{
31
31
  query: z.ZodObject<{}, z.core.$loose>;
32
32
  body: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
33
33
  redirectUrl: z.ZodString;
34
34
  }, z.core.$strip>;
35
- export type PostAuthResultRequestBody = z.infer<typeof postAuthResultRequestBody>;
36
- export declare const postAuthResultResponseBody: z.ZodObject<{}, z.core.$loose>;
37
- export type PostAuthResultResponseBody = z.infer<typeof postAuthResultResponseBody>;
38
- export declare const postAuthResponseContract: import("@lokalise/api-contracts").PayloadRouteDefinition<z.ZodNever, z.ZodObject<{}, z.core.$loose>, undefined, undefined, z.ZodObject<{
35
+ export type PostAuthResponseRequestBody = z.infer<typeof postAuthResponseRequestBody>;
36
+ export declare const postAuthResponseResponseBody: z.ZodObject<{}, z.core.$loose>;
37
+ export type PostAuthResponseResponseBody = z.infer<typeof postAuthResponseResponseBody>;
38
+ export declare const postAuthResponseContract: import("@lokalise/api-contracts").PayloadRouteDefinition<z.ZodObject<{
39
+ query: z.ZodObject<{}, z.core.$loose>;
40
+ body: z.ZodOptional<z.ZodObject<{}, z.core.$loose>>;
41
+ redirectUrl: z.ZodString;
42
+ }, z.core.$strip>, z.ZodObject<{}, z.core.$loose>, undefined, undefined, z.ZodObject<{
39
43
  'CE-Config': z.ZodString;
40
44
  'CE-Auth': z.ZodString;
41
45
  }, z.core.$strip>, false, false>;
package/dist/schemas/authSchemas.js CHANGED
@@ -42,21 +42,21 @@ export const postAuthRefreshContract = buildPayloadRoute({
42
42
  },
43
43
  requestHeaderSchema: CONNECTOR_REQUEST_HEADERS_SCHEMA,
44
44
  });
45
- // postAuthResult
46
- export const postAuthResultRequestBody = z.object({
45
+ // postAuthResponse
46
+ export const postAuthResponseRequestBody = z.object({
47
47
  query: z.looseObject({}),
48
48
  body: z.looseObject({}).optional(),
49
49
  redirectUrl: z.string().max(255),
50
50
  });
51
- export const postAuthResultResponseBody = z.looseObject({});
51
+ export const postAuthResponseResponseBody = z.looseObject({});
52
52
  export const postAuthResponseContract = buildPayloadRoute({
53
53
  method: 'post',
54
- requestBodySchema: z.never(),
54
+ requestBodySchema: postAuthResponseRequestBody,
55
55
  pathResolver: () => `/auth/response`,
56
56
  description: 'Get auth configuration (applicable only for "OAuth" type)',
57
- successResponseBodySchema: postAuthResponseBody,
57
+ successResponseBodySchema: postAuthResponseResponseBody,
58
58
  responseSchemasByStatusCode: {
59
- 200: postAuthResponseBody,
59
+ 200: postAuthResponseResponseBody,
60
60
  403: authError,
61
61
  },
62
62
  requestHeaderSchema: CONNECTOR_REQUEST_HEADERS_SCHEMA,
package/dist/schemas/authSchemas.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"authSchemas.js","sourceRoot":"","sources":["../../src/schemas/authSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC1E,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAA;AAE1F,MAAM,oBAAoB,GAAG,CAAC,OAAO,EAAE,UAAU,CAAU,CAAA;AAE3D,UAAU;AAEV,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;CACnC,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,eAAe,GAAG,aAAa,CAAC;IAC3C,YAAY,EAAE,GAAG,EAAE,CAAC,OAAO;IAC3B,WAAW,EAAE,gDAAgD;IAC7D,yBAAyB,EAAE,mBAAmB;IAC9C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,mBAAmB;KACzB;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA;AAEF,WAAW;AAEX,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;AAIrD,MAAM,CAAC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;IAChD,MAAM,EAAE,MAAM;IACd,iBAAiB,EAAE,CAAC,CAAC,KAAK,EAAE;IAC5B,YAAY,EAAE,GAAG,EAAE,CAAC,OAAO;IAC3B,WAAW,EACT,wFAAwF;IAC1F,yBAAyB,EAAE,oBAAoB;IAC/C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,oBAAoB;QACzB,GAAG,EAAE,QAAQ;KACd;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA;AAEF,kBAAkB;AAElB,MAAM,CAAC,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;IACvD,MAAM,EAAE,MAAM;IACd,iBAAiB,EAAE,CAAC,CAAC,KAAK,EAAE;IAC5B,YAAY,EAAE,GAAG,EAAE,CAAC,eAAe;IACnC,WAAW,EAAE,8EAA8E;IAC3F,yBAAyB,EAAE,oBAAoB;IAC/C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,oBAAoB;QACzB,GAAG,EAAE,QAAQ;KACd;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA;AAEF,iBAAiB;AAEjB,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,KAAK,EAAE,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC;IACxB,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;CACjC,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;AAG3D,MAAM,CAAC,MAAM,wBAAwB,GAAG,iBAAiB,CAAC;IACxD,MAAM,EAAE,MAAM;IACd,iBAAiB,EAAE,CAAC,CAAC,KAAK,EAAE;IAC5B,YAAY,EAAE,GAAG,EAAE,CAAC,gBAAgB;IACpC,WAAW,EAAE,2DAA2D;IACxE,yBAAyB,EAAE,oBAAoB;IAC/C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,oBAAoB;QACzB,GAAG,EAAE,SAAS;KACf;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA"}
1
+ {"version":3,"file":"authSchemas.js","sourceRoot":"","sources":["../../src/schemas/authSchemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC1E,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,gCAAgC,EAAE,MAAM,oBAAoB,CAAA;AAE1F,MAAM,oBAAoB,GAAG,CAAC,OAAO,EAAE,UAAU,CAAU,CAAA;AAE3D,UAAU;AAEV,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,oBAAoB,CAAC;CACnC,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,eAAe,GAAG,aAAa,CAAC;IAC3C,YAAY,EAAE,GAAG,EAAE,CAAC,OAAO;IAC3B,WAAW,EAAE,gDAAgD;IAC7D,yBAAyB,EAAE,mBAAmB;IAC9C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,mBAAmB;KACzB;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA;AAEF,WAAW;AAEX,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;AAIrD,MAAM,CAAC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;IAChD,MAAM,EAAE,MAAM;IACd,iBAAiB,EAAE,CAAC,CAAC,KAAK,EAAE;IAC5B,YAAY,EAAE,GAAG,EAAE,CAAC,OAAO;IAC3B,WAAW,EACT,wFAAwF;IAC1F,yBAAyB,EAAE,oBAAoB;IAC/C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,oBAAoB;QACzB,GAAG,EAAE,QAAQ;KACd;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA;AAEF,kBAAkB;AAElB,MAAM,CAAC,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;IACvD,MAAM,EAAE,MAAM;IACd,iBAAiB,EAAE,CAAC,CAAC,KAAK,EAAE;IAC5B,YAAY,EAAE,GAAG,EAAE,CAAC,eAAe;IACnC,WAAW,EAAE,8EAA8E;IAC3F,yBAAyB,EAAE,oBAAoB;IAC/C,2BAA2B,EAAE;QAC3B,GAAG,EAAE,oBAAoB;QACzB,GAAG,EAAE,QAAQ;KACd;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA;AAEF,mBAAmB;AAEnB,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,KAAK,EAAE,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC;IACxB,IAAI,EAAE,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAClC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;CACjC,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;AAG7D,MAAM,CAAC,MAAM,wBAAwB,GAAG,iBAAiB,CAAC;IACxD,MAAM,EAAE,MAAM;IACd,iBAAiB,EAAE,2BAA2B;IAC9C,YAAY,EAAE,GAAG,EAAE,CAAC,gBAAgB;IACpC,WAAW,EAAE,2DAA2D;IACxE,yBAAyB,EAAE,4BAA4B;IACvD,2BAA2B,EAAE;QAC3B,GAAG,EAAE,4BAA4B;QACjC,GAAG,EAAE,SAAS;KACf;IACD,mBAAmB,EAAE,gCAAgC;CACtD,CAAC,CAAA"}
package/dist/schemas/itemListContract.d.ts CHANGED
@@ -12,31 +12,37 @@ export declare const itemListEntry: z.ZodObject<{
12
12
  groupTitle: z.ZodString;
13
13
  }, z.core.$strip>;
14
14
  export declare const itemListResponseBody: z.ZodObject<{
15
- data: z.ZodObject<{
15
+ data: z.ZodArray<z.ZodObject<{
16
16
  items: z.ZodArray<z.ZodObject<{
17
17
  uniqueId: z.ZodString;
18
18
  groupId: z.ZodString;
19
19
  metadata: z.ZodRecord<z.ZodAny, z.ZodAny>;
20
+ fields: z.ZodObject<{}, z.core.$loose>;
21
+ title: z.ZodString;
22
+ groupTitle: z.ZodString;
20
23
  }, z.core.$strip>>;
21
- }, z.core.$strip>;
24
+ }, z.core.$strip>>;
22
25
  meta: z.ZodObject<{
23
- hasMore: z.ZodBoolean;
24
- totalResults: z.ZodOptional<z.ZodNumber>;
25
- nextCursor: z.ZodOptional<z.ZodString>;
26
+ count: z.ZodNumber;
27
+ cursor: z.ZodOptional<z.ZodString>;
28
+ hasMore: z.ZodOptional<z.ZodBoolean>;
26
29
  }, z.core.$strip>;
27
30
  }, z.core.$strip>;
28
31
  export declare const getItemListContract: import("@lokalise/api-contracts").GetRouteDefinition<z.ZodObject<{
29
- data: z.ZodObject<{
32
+ data: z.ZodArray<z.ZodObject<{
30
33
  items: z.ZodArray<z.ZodObject<{
31
34
  uniqueId: z.ZodString;
32
35
  groupId: z.ZodString;
33
36
  metadata: z.ZodRecord<z.ZodAny, z.ZodAny>;
37
+ fields: z.ZodObject<{}, z.core.$loose>;
38
+ title: z.ZodString;
39
+ groupTitle: z.ZodString;
34
40
  }, z.core.$strip>>;
35
- }, z.core.$strip>;
41
+ }, z.core.$strip>>;
36
42
  meta: z.ZodObject<{
37
- hasMore: z.ZodBoolean;
38
- totalResults: z.ZodOptional<z.ZodNumber>;
39
- nextCursor: z.ZodOptional<z.ZodString>;
43
+ count: z.ZodNumber;
44
+ cursor: z.ZodOptional<z.ZodString>;
45
+ hasMore: z.ZodOptional<z.ZodBoolean>;
40
46
  }, z.core.$strip>;
41
47
  }, z.core.$strip>, undefined, z.ZodObject<{
42
48
  limit: z.ZodOptional<z.ZodString>;
package/dist/schemas/itemListContract.js CHANGED
@@ -1,3 +1,4 @@
1
+ import { paginatedResponseSchema } from '@lokalise/api-common';
1
2
  import { buildGetRoute } from '@lokalise/api-contracts';
2
3
  import { z } from 'zod/v4';
3
4
  import { MAX_TITLE_LENGTH } from "./cacheSchemas.js";
@@ -20,22 +21,9 @@ export const itemListEntry = itemIdentifier.extend({
20
21
  title: z.string().max(MAX_TITLE_LENGTH),
21
22
  groupTitle: z.string().max(MAX_TITLE_LENGTH),
22
23
  });
23
- export const itemListResponseBody = z.object({
24
- data: z.object({
25
- items: z.array(itemIdentifier),
26
- }),
27
- meta: z.object({
28
- hasMore: z.boolean(),
29
- /**
30
- * How many items exist overall. Only provided if connector supports it
31
- */
32
- totalResults: z.number().optional(),
33
- /**
34
- * Opaque connector-specific string that can be used to retrieve the next page of items.
35
- */
36
- nextCursor: z.string().optional(),
37
- }),
38
- });
24
+ export const itemListResponseBody = paginatedResponseSchema(z.object({
25
+ items: z.array(itemListEntry),
26
+ }));
39
27
  export const getItemListContract = buildGetRoute({
40
28
  pathResolver: () => `/v1/items`,
41
29
  description: 'Get a list of project items',
package/dist/schemas/itemListContract.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"itemListContract.js","sourceRoot":"","sources":["../../src/schemas/itemListContract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EACL,4BAA4B,EAC5B,gCAAgC,EAChC,cAAc,GACf,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,cAAc,CAAC,MAAM,CAAC;IACjD,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,CAAC,CAAC,MAAM,CAAC;IAC3C,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC;KAC/B,CAAC;IACF,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;QACpB;;WAEG;QACH,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACnC;;WAEG;QACH,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAClC,CAAC;CACH,CAAC,CAAA;AAEF,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":"itemListContract.js","sourceRoot":"","sources":["../../src/schemas/itemListContract.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,mBAAmB,CAAA;AACpD,OAAO,EACL,4BAA4B,EAC5B,gCAAgC,EAChC,cAAc,GACf,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,cAAc,CAAC,MAAM,CAAC;IACjD,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,CACzD,CAAC,CAAC,MAAM,CAAC;IACP,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC;CAC9B,CAAC,CACH,CAAA;AAED,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.1.1",
3
+ "version": "1.2.1",
4
4
  "description": "Lokalise Connector API schemas and contracts",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
@@ -32,11 +32,13 @@
32
32
  "@lokalise/api-contracts": "^5.0.0"
33
33
  },
34
34
  "peerDependencies": {
35
+ "@lokalise/api-common": ">=6.1.0",
35
36
  "zod": ">=3.25.76 <5.0.0"
36
37
  },
37
38
  "devDependencies": {
38
39
  "@types/node": "^22.17.2",
39
40
  "@biomejs/biome": "^2.2.0",
41
+ "@lokalise/api-common": "^6.1.0",
40
42
  "@lokalise/biome-config": "^3.1.0",
41
43
  "@lokalise/tsconfig": "^2.0.0",
42
44
  "@vitest/coverage-v8": "^3.2.4",