@lokalise/projects-engine-contracts 9.1.3 → 9.1.4

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 (4) hide show
  1. package/dist/apiContracts/projectsContracts.d.ts +95 -2
  2. package/dist/apiContracts/projectsContracts.js +14 -2
  3. package/dist/apiContracts/projectsContracts.js.map +1 -1
  4. package/package.json +1 -1
package/dist/apiContracts/projectsContracts.d.ts CHANGED
@@ -46,7 +46,51 @@ export declare const getProjectContract: import("@lokalise/api-contracts").GetRo
46
46
  }, import("zod/v4/core").$strip>, undefined, import("zod").ZodObject<{
47
47
  authorization: import("zod").ZodString;
48
48
  'content-type': import("zod").ZodOptional<import("zod").ZodString>;
49
- }, import("zod/v4/core").$strip>, undefined, false, false, undefined>;
49
+ }, import("zod/v4/core").$strip>, undefined, false, false, {
50
+ 200: import("zod").ZodObject<{
51
+ data: import("zod").ZodObject<{
52
+ projectId: import("zod").ZodString;
53
+ uuid: import("zod").ZodGUID;
54
+ name: import("zod").ZodString;
55
+ description: import("zod").ZodString;
56
+ baseLanguage: import("zod").ZodObject<{
57
+ projectLanguageId: import("zod").ZodNumber;
58
+ languageId: import("zod").ZodNumber;
59
+ languageIso: import("zod").ZodString;
60
+ projectLanguageUuid: import("zod").ZodGUID;
61
+ }, import("zod/v4/core").$strip>;
62
+ targetLanguages: import("zod").ZodArray<import("zod").ZodObject<{
63
+ projectLanguageId: import("zod").ZodNumber;
64
+ languageId: import("zod").ZodNumber;
65
+ languageIso: import("zod").ZodString;
66
+ projectLanguageUuid: import("zod").ZodGUID;
67
+ }, import("zod/v4/core").$strip>>;
68
+ translationSettings: import("zod").ZodIntersection<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
69
+ workflowType: import("zod").ZodIntersection<import("zod").ZodEnum<{
70
+ readonly AI_ONLY: 'AI_ONLY';
71
+ readonly AI_HUMAN_REVIEW: 'AI_HUMAN_REVIEW';
72
+ }>, import("zod").ZodLiteral<"AI_HUMAN_REVIEW">>;
73
+ reviewThreshold: import("zod").ZodEnum<{
74
+ readonly FULL_REVIEW: 'FULL_REVIEW';
75
+ readonly CRITICAL_MAJOR_MINOR: 'CRITICAL_MAJOR_MINOR';
76
+ readonly CRITICAL_MAJOR: 'CRITICAL_MAJOR';
77
+ readonly CRITICAL: 'CRITICAL';
78
+ }>;
79
+ }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
80
+ workflowType: import("zod").ZodIntersection<import("zod").ZodEnum<{
81
+ readonly AI_ONLY: 'AI_ONLY';
82
+ readonly AI_HUMAN_REVIEW: 'AI_HUMAN_REVIEW';
83
+ }>, import("zod").ZodLiteral<"AI_ONLY">>;
84
+ reviewThreshold: import("zod").ZodNull;
85
+ }, import("zod/v4/core").$strip>]>, import("zod").ZodObject<{
86
+ reviewTurnaroundDays: import("zod").ZodNumber;
87
+ }, import("zod/v4/core").$strip>>;
88
+ contentSourceType: import("zod").ZodNullable<import("zod").ZodString>;
89
+ contentSourceName: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
90
+ projectType: import("zod").ZodString;
91
+ }, import("zod/v4/core").$strip>;
92
+ }, import("zod/v4/core").$strip>;
93
+ }>;
50
94
  export declare const patchProjectContract: import("@lokalise/api-contracts").PayloadRouteDefinition<import("zod").ZodObject<{
51
95
  name: import("zod").ZodString;
52
96
  description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -160,7 +204,56 @@ export declare const getProjectsContract: import("@lokalise/api-contracts").GetR
160
204
  }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
161
205
  authorization: import("zod").ZodString;
162
206
  'content-type': import("zod").ZodOptional<import("zod").ZodString>;
163
- }, import("zod/v4/core").$strip>, undefined, false, false, undefined>;
207
+ }, import("zod/v4/core").$strip>, undefined, false, false, {
208
+ 200: import("zod").ZodObject<{
209
+ data: import("zod").ZodArray<import("zod").ZodObject<{
210
+ projectId: import("zod").ZodString;
211
+ uuid: import("zod").ZodGUID;
212
+ name: import("zod").ZodString;
213
+ description: import("zod").ZodString;
214
+ baseLanguage: import("zod").ZodObject<{
215
+ projectLanguageId: import("zod").ZodNumber;
216
+ languageId: import("zod").ZodNumber;
217
+ languageIso: import("zod").ZodString;
218
+ projectLanguageUuid: import("zod").ZodGUID;
219
+ }, import("zod/v4/core").$strip>;
220
+ targetLanguages: import("zod").ZodArray<import("zod").ZodObject<{
221
+ projectLanguageId: import("zod").ZodNumber;
222
+ languageId: import("zod").ZodNumber;
223
+ languageIso: import("zod").ZodString;
224
+ projectLanguageUuid: import("zod").ZodGUID;
225
+ }, import("zod/v4/core").$strip>>;
226
+ translationSettings: import("zod").ZodIntersection<import("zod").ZodUnion<readonly [import("zod").ZodObject<{
227
+ workflowType: import("zod").ZodIntersection<import("zod").ZodEnum<{
228
+ readonly AI_ONLY: 'AI_ONLY';
229
+ readonly AI_HUMAN_REVIEW: 'AI_HUMAN_REVIEW';
230
+ }>, import("zod").ZodLiteral<"AI_HUMAN_REVIEW">>;
231
+ reviewThreshold: import("zod").ZodEnum<{
232
+ readonly FULL_REVIEW: 'FULL_REVIEW';
233
+ readonly CRITICAL_MAJOR_MINOR: 'CRITICAL_MAJOR_MINOR';
234
+ readonly CRITICAL_MAJOR: 'CRITICAL_MAJOR';
235
+ readonly CRITICAL: 'CRITICAL';
236
+ }>;
237
+ }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
238
+ workflowType: import("zod").ZodIntersection<import("zod").ZodEnum<{
239
+ readonly AI_ONLY: 'AI_ONLY';
240
+ readonly AI_HUMAN_REVIEW: 'AI_HUMAN_REVIEW';
241
+ }>, import("zod").ZodLiteral<"AI_ONLY">>;
242
+ reviewThreshold: import("zod").ZodNull;
243
+ }, import("zod/v4/core").$strip>]>, import("zod").ZodObject<{
244
+ reviewTurnaroundDays: import("zod").ZodNumber;
245
+ }, import("zod/v4/core").$strip>>;
246
+ contentSourceType: import("zod").ZodNullable<import("zod").ZodString>;
247
+ contentSourceName: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
248
+ projectType: import("zod").ZodString;
249
+ }, import("zod/v4/core").$strip>>;
250
+ meta: import("zod").ZodObject<{
251
+ count: import("zod").ZodNumber;
252
+ cursor: import("zod").ZodOptional<import("zod").ZodString>;
253
+ hasMore: import("zod").ZodBoolean;
254
+ }, import("zod/v4/core").$strip>;
255
+ }, import("zod/v4/core").$strip>;
256
+ }>;
164
257
  /**
165
258
  * Public API router definition for deleting a project within a workspace
166
259
  */
package/dist/apiContracts/projectsContracts.js CHANGED
@@ -2,13 +2,19 @@ import { buildRestContract } from '@lokalise/api-contracts';
2
2
  import { AUTH_HEADERS } from '../schemas/domainSchemas.js';
3
3
  import { DELETE_PROJECT_PATH_PARAMS_SCHEMA, DELETE_PROJECT_SUCCESS_RESPONSE_BODY, GET_PROJECT_PATH_PARAMS_SCHEMA, GET_PROJECT_SUCCESS_RESPONSE_BODY, GET_PROJECTS_PATH_PARAMS_SCHEMA, GET_PROJECTS_QUERY_SCHEMA, GET_PROJECTS_SUCCESS_RESPONSE_BODY, PATCH_PROJECT_PATH_PARAMS_SCHEMA, PATCH_PROJECT_REQUEST_BODY_SCHEMA, PATCH_PROJECT_SUCCESS_RESPONSE_BODY, } from '../schemas/projectSchemas.js';
4
4
  export const getProjectContract = buildRestContract({
5
- visibility: 'internal',
5
+ visibility: 'public',
6
6
  method: 'get',
7
7
  pathResolver: (params) => `/v1/workspaces/${params.workspaceId}/projects/${params.projectId}`,
8
+ summary: 'Get project',
8
9
  description: 'Get project by ID',
9
10
  requestHeaderSchema: AUTH_HEADERS,
10
11
  requestPathParamsSchema: GET_PROJECT_PATH_PARAMS_SCHEMA,
11
12
  successResponseBodySchema: GET_PROJECT_SUCCESS_RESPONSE_BODY,
13
+ // `successResponseBodySchema` only types the client; the generated OpenAPI document takes
14
+ // its response section from `responseSchemasByStatusCode`, so a public route needs both.
15
+ responseSchemasByStatusCode: {
16
+ 200: GET_PROJECT_SUCCESS_RESPONSE_BODY,
17
+ },
12
18
  });
13
19
  export const patchProjectContract = buildRestContract({
14
20
  visibility: 'internal',
@@ -27,14 +33,20 @@ export const patchProjectContract = buildRestContract({
27
33
  * collection/member pair, and the response is cursor-paginated with the cursor at `meta.cursor`.
28
34
  */
29
35
  export const getProjectsContract = buildRestContract({
30
- visibility: 'internal',
36
+ visibility: 'public',
31
37
  method: 'get',
32
38
  pathResolver: (params) => `/v1/workspaces/${params.workspaceId}/projects`,
39
+ summary: 'List projects',
33
40
  description: 'Get projects',
34
41
  requestHeaderSchema: AUTH_HEADERS,
35
42
  requestPathParamsSchema: GET_PROJECTS_PATH_PARAMS_SCHEMA,
36
43
  requestQuerySchema: GET_PROJECTS_QUERY_SCHEMA,
37
44
  successResponseBodySchema: GET_PROJECTS_SUCCESS_RESPONSE_BODY,
45
+ // `successResponseBodySchema` only types the client; the generated OpenAPI document takes
46
+ // its response section from `responseSchemasByStatusCode`, so a public route needs both.
47
+ responseSchemasByStatusCode: {
48
+ 200: GET_PROJECTS_SUCCESS_RESPONSE_BODY,
49
+ },
38
50
  });
39
51
  /**
40
52
  * Public API router definition for deleting a project within a workspace
package/dist/apiContracts/projectsContracts.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"projectsContracts.js","sourceRoot":"","sources":["../../src/apiContracts/projectsContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EACL,iCAAiC,EACjC,oCAAoC,EACpC,8BAA8B,EAC9B,iCAAiC,EACjC,+BAA+B,EAC/B,yBAAyB,EACzB,kCAAkC,EAClC,gCAAgC,EAChC,iCAAiC,EACjC,mCAAmC,GACpC,MAAM,8BAA8B,CAAA;AAErC,MAAM,CAAC,MAAM,kBAAkB,GAAG,iBAAiB,CAAC;IAClD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,MAAM,CAAC,WAAW,aAAa,MAAM,CAAC,SAAS,EAAE;IAC7F,WAAW,EAAE,mBAAmB;IAChC,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,8BAA8B;IACvD,yBAAyB,EAAE,iCAAiC;CAC7D,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;IACpD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,OAAO;IACf,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,MAAM,CAAC,WAAW,aAAa,MAAM,CAAC,SAAS,EAAE;IAC7F,WAAW,EAAE,uBAAuB;IACpC,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,gCAAgC;IACzD,iBAAiB,EAAE,iCAAiC;IACpD,yBAAyB,EAAE,mCAAmC;CAC/D,CAAC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;IACnD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,MAAM,CAAC,WAAW,WAAW;IACzE,WAAW,EAAE,cAAc;IAC3B,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,+BAA+B;IACxD,kBAAkB,EAAE,yBAAyB;IAC7C,yBAAyB,EAAE,kCAAkC;CAC9D,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;IACrD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,QAAQ;IAChB,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,MAAM,CAAC,WAAW,aAAa,MAAM,CAAC,SAAS,EAAE;IAC7F,WAAW,EAAE,kBAAkB;IAC/B,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,iCAAiC;IAC1D,yBAAyB,EAAE,oCAAoC;IAC/D,uBAAuB,EAAE,KAAK;CAC/B,CAAC,CAAA"}
1
+ {"version":3,"file":"projectsContracts.js","sourceRoot":"","sources":["../../src/apiContracts/projectsContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAA;AAC1D,OAAO,EACL,iCAAiC,EACjC,oCAAoC,EACpC,8BAA8B,EAC9B,iCAAiC,EACjC,+BAA+B,EAC/B,yBAAyB,EACzB,kCAAkC,EAClC,gCAAgC,EAChC,iCAAiC,EACjC,mCAAmC,GACpC,MAAM,8BAA8B,CAAA;AAErC,MAAM,CAAC,MAAM,kBAAkB,GAAG,iBAAiB,CAAC;IAClD,UAAU,EAAE,QAAQ;IACpB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,MAAM,CAAC,WAAW,aAAa,MAAM,CAAC,SAAS,EAAE;IAC7F,OAAO,EAAE,aAAa;IACtB,WAAW,EAAE,mBAAmB;IAChC,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,8BAA8B;IACvD,yBAAyB,EAAE,iCAAiC;IAC5D,0FAA0F;IAC1F,yFAAyF;IACzF,2BAA2B,EAAE;QAC3B,GAAG,EAAE,iCAAiC;KACvC;CACF,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,iBAAiB,CAAC;IACpD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,OAAO;IACf,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,MAAM,CAAC,WAAW,aAAa,MAAM,CAAC,SAAS,EAAE;IAC7F,WAAW,EAAE,uBAAuB;IACpC,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,gCAAgC;IACzD,iBAAiB,EAAE,iCAAiC;IACpD,yBAAyB,EAAE,mCAAmC;CAC/D,CAAC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,iBAAiB,CAAC;IACnD,UAAU,EAAE,QAAQ;IACpB,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,MAAM,CAAC,WAAW,WAAW;IACzE,OAAO,EAAE,eAAe;IACxB,WAAW,EAAE,cAAc;IAC3B,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,+BAA+B;IACxD,kBAAkB,EAAE,yBAAyB;IAC7C,yBAAyB,EAAE,kCAAkC;IAC7D,0FAA0F;IAC1F,yFAAyF;IACzF,2BAA2B,EAAE;QAC3B,GAAG,EAAE,kCAAkC;KACxC;CACF,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;IACrD,UAAU,EAAE,UAAU;IACtB,MAAM,EAAE,QAAQ;IAChB,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,MAAM,CAAC,WAAW,aAAa,MAAM,CAAC,SAAS,EAAE;IAC7F,WAAW,EAAE,kBAAkB;IAC/B,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,iCAAiC;IAC1D,yBAAyB,EAAE,oCAAoC;IAC/D,uBAAuB,EAAE,KAAK;CAC/B,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lokalise/projects-engine-contracts",
3
- "version": "9.1.3",
3
+ "version": "9.1.4",
4
4
  "description": "API contracts and shared schemas for the Projects Engine service",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",