@lokalise/projects-engine-contracts 2.0.10 → 2.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.
@@ -5,19 +5,19 @@ export declare const getProjectsListContract: import("@lokalise/api-contracts").
5
5
  data: import("zod").ZodObject<{
6
6
  projects: import("zod").ZodArray<import("zod").ZodObject<{
7
7
  projectId: import("zod").ZodString;
8
- uuid: import("zod").ZodGUID;
8
+ uuid: import("zod").ZodUUID;
9
9
  name: import("zod").ZodString;
10
10
  baseLanguage: import("zod").ZodObject<{
11
11
  projectLanguageId: import("zod").ZodNumber;
12
12
  languageId: import("zod").ZodNumber;
13
13
  languageIso: import("zod").ZodString;
14
- projectLanguageUuid: import("zod").ZodGUID;
14
+ projectLanguageUuid: import("zod").ZodUUID;
15
15
  }, import("zod/v4/core").$strip>;
16
16
  targetLanguages: import("zod").ZodArray<import("zod").ZodObject<{
17
17
  projectLanguageId: import("zod").ZodNumber;
18
18
  languageId: import("zod").ZodNumber;
19
19
  languageIso: import("zod").ZodString;
20
- projectLanguageUuid: import("zod").ZodGUID;
20
+ projectLanguageUuid: import("zod").ZodUUID;
21
21
  }, import("zod/v4/core").$strip>>;
22
22
  translationSettings: import("zod").ZodUnion<readonly [import("zod").ZodObject<{
23
23
  workflowType: import("zod").ZodIntersection<import("zod").ZodEnum<{
@@ -50,7 +50,22 @@ export declare const getProjectsListContract: import("@lokalise/api-contracts").
50
50
  count: import("zod").ZodNumber;
51
51
  }, import("zod/v4/core").$strip>;
52
52
  }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
53
- workspaceId: import("zod").ZodGUID;
53
+ workspaceId: import("zod").ZodUUID;
54
+ }, import("zod/v4/core").$strip>, undefined, import("zod").ZodObject<{
55
+ authorization: import("zod").ZodString;
56
+ }, import("zod/v4/core").$strip>, undefined, false, false, undefined>;
57
+ /**
58
+ * Public API router definition for deleting a project within a workspace
59
+ */
60
+ export declare const deleteProjectContract: import("@lokalise/api-contracts").DeleteRouteDefinition<import("zod").ZodObject<{
61
+ data: import("zod").ZodObject<{
62
+ projectId: import("zod").ZodString;
63
+ projectUuid: import("zod").ZodUUID;
64
+ projectDeleted: import("zod").ZodBoolean;
65
+ }, import("zod/v4/core").$strip>;
66
+ }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
67
+ workspaceId: import("zod").ZodUUID;
68
+ projectId: import("zod").ZodUUID;
54
69
  }, import("zod/v4/core").$strip>, undefined, import("zod").ZodObject<{
55
70
  authorization: import("zod").ZodString;
56
71
  }, import("zod/v4/core").$strip>, undefined, false, false, undefined>;
@@ -1,13 +1,26 @@
1
- import { buildGetRoute } from '@lokalise/api-contracts';
2
- import { AUTH_HEADERS, GET_PROJECTS_LIST_PATH_PARAMS_SCHEMA, GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY, } from './schemas.js';
1
+ import { buildRestContract } from '@lokalise/api-contracts';
2
+ import { AUTH_HEADERS, DELETE_PROJECT_PATH_PARAMS_SCHEMA, DELETE_PROJECT_SUCCESS_RESPONSE_BODY, GET_PROJECTS_LIST_PATH_PARAMS_SCHEMA, GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY, } from './schemas.js';
3
3
  /**
4
4
  * Public API router definition for getting the list of projects for a given workspace
5
5
  */
6
- export const getProjectsListContract = buildGetRoute({
6
+ export const getProjectsListContract = buildRestContract({
7
+ method: 'get',
7
8
  pathResolver: (params) => `/v1/workspaces/${params.workspaceId}/projects/list`,
8
9
  description: 'Get projects list',
9
10
  requestHeaderSchema: AUTH_HEADERS,
10
11
  requestPathParamsSchema: GET_PROJECTS_LIST_PATH_PARAMS_SCHEMA,
11
12
  successResponseBodySchema: GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY,
12
13
  });
14
+ /**
15
+ * Public API router definition for deleting a project within a workspace
16
+ */
17
+ export const deleteProjectContract = buildRestContract({
18
+ method: 'delete',
19
+ pathResolver: (params) => `/v1/workspaces/${params.workspaceId}/projects/${params.projectId}`,
20
+ description: 'Delete a project',
21
+ requestHeaderSchema: AUTH_HEADERS,
22
+ requestPathParamsSchema: DELETE_PROJECT_PATH_PARAMS_SCHEMA,
23
+ successResponseBodySchema: DELETE_PROJECT_SUCCESS_RESPONSE_BODY,
24
+ isEmptyResponseExpected: false,
25
+ });
13
26
  //# sourceMappingURL=projectsContracts.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"projectsContracts.js","sourceRoot":"","sources":["../../src/apiContracts/projectsContracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EACL,YAAY,EACZ,oCAAoC,EACpC,uCAAuC,GACxC,MAAM,cAAc,CAAA;AAErB;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,aAAa,CAAC;IACnD,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,MAAM,CAAC,WAAW,gBAAgB;IAC9E,WAAW,EAAE,mBAAmB;IAChC,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,oCAAoC;IAC7D,yBAAyB,EAAE,uCAAuC;CACnE,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,EACL,YAAY,EACZ,iCAAiC,EACjC,oCAAoC,EACpC,oCAAoC,EACpC,uCAAuC,GACxC,MAAM,cAAc,CAAA;AAErB;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;IACvD,MAAM,EAAE,KAAK;IACb,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,MAAM,CAAC,WAAW,gBAAgB;IAC9E,WAAW,EAAE,mBAAmB;IAChC,mBAAmB,EAAE,YAAY;IACjC,uBAAuB,EAAE,oCAAoC;IAC7D,yBAAyB,EAAE,uCAAuC;CACnE,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;IACrD,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"}
@@ -4,7 +4,7 @@ export declare const AUTH_HEADERS: z.ZodObject<{
4
4
  }, z.core.$strip>;
5
5
  export type AuthHeaders = z.infer<typeof AUTH_HEADERS>;
6
6
  export declare const GET_PROJECTS_LIST_PATH_PARAMS_SCHEMA: z.ZodObject<{
7
- workspaceId: z.ZodGUID;
7
+ workspaceId: z.ZodUUID;
8
8
  }, z.core.$strip>;
9
9
  export type GetProjectsListPathParams = z.infer<typeof GET_PROJECTS_LIST_PATH_PARAMS_SCHEMA>;
10
10
  export declare const PROJECTS_LIST_RESPONSE_META_SCHEMA: z.ZodObject<{
@@ -15,19 +15,19 @@ export declare const GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY: z.ZodObject<{
15
15
  data: z.ZodObject<{
16
16
  projects: z.ZodArray<z.ZodObject<{
17
17
  projectId: z.ZodString;
18
- uuid: z.ZodGUID;
18
+ uuid: z.ZodUUID;
19
19
  name: z.ZodString;
20
20
  baseLanguage: z.ZodObject<{
21
21
  projectLanguageId: z.ZodNumber;
22
22
  languageId: z.ZodNumber;
23
23
  languageIso: z.ZodString;
24
- projectLanguageUuid: z.ZodGUID;
24
+ projectLanguageUuid: z.ZodUUID;
25
25
  }, z.core.$strip>;
26
26
  targetLanguages: z.ZodArray<z.ZodObject<{
27
27
  projectLanguageId: z.ZodNumber;
28
28
  languageId: z.ZodNumber;
29
29
  languageIso: z.ZodString;
30
- projectLanguageUuid: z.ZodGUID;
30
+ projectLanguageUuid: z.ZodUUID;
31
31
  }, z.core.$strip>>;
32
32
  translationSettings: z.ZodUnion<readonly [z.ZodObject<{
33
33
  workflowType: z.ZodIntersection<z.ZodEnum<{
@@ -61,3 +61,16 @@ export declare const GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY: z.ZodObject<{
61
61
  }, z.core.$strip>;
62
62
  }, z.core.$strip>;
63
63
  export type GetProjectsListSuccessResponse = z.infer<typeof GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY>;
64
+ export declare const DELETE_PROJECT_PATH_PARAMS_SCHEMA: z.ZodObject<{
65
+ workspaceId: z.ZodUUID;
66
+ projectId: z.ZodUUID;
67
+ }, z.core.$strip>;
68
+ export type DeleteProjectPathParams = z.infer<typeof DELETE_PROJECT_PATH_PARAMS_SCHEMA>;
69
+ export declare const DELETE_PROJECT_SUCCESS_RESPONSE_BODY: z.ZodObject<{
70
+ data: z.ZodObject<{
71
+ projectId: z.ZodString;
72
+ projectUuid: z.ZodUUID;
73
+ projectDeleted: z.ZodBoolean;
74
+ }, z.core.$strip>;
75
+ }, z.core.$strip>;
76
+ export type DeleteProjectSuccessResponse = z.infer<typeof DELETE_PROJECT_SUCCESS_RESPONSE_BODY>;
@@ -5,7 +5,7 @@ export const AUTH_HEADERS = z.object({
5
5
  });
6
6
  // GET PROJECTS LIST
7
7
  export const GET_PROJECTS_LIST_PATH_PARAMS_SCHEMA = z.object({
8
- workspaceId: z.guid(),
8
+ workspaceId: z.uuid(),
9
9
  });
10
10
  export const PROJECTS_LIST_RESPONSE_META_SCHEMA = z.object({
11
11
  count: z.number(),
@@ -14,4 +14,16 @@ export const GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY = z.object({
14
14
  data: z.object({ projects: z.array(PROJECT_SCHEMA) }),
15
15
  meta: PROJECTS_LIST_RESPONSE_META_SCHEMA,
16
16
  });
17
+ // DELETE PROJECT
18
+ export const DELETE_PROJECT_PATH_PARAMS_SCHEMA = z.object({
19
+ workspaceId: z.uuid(),
20
+ projectId: z.uuid(),
21
+ });
22
+ export const DELETE_PROJECT_SUCCESS_RESPONSE_BODY = z.object({
23
+ data: z.object({
24
+ projectId: z.string(),
25
+ projectUuid: z.uuid(),
26
+ projectDeleted: z.boolean(),
27
+ }),
28
+ });
17
29
  //# sourceMappingURL=schemas.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../src/apiContracts/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAEtD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;CAC3D,CAAC,CAAA;AAGF,oBAAoB;AACpB,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3D,WAAW,EAAE,CAAC,CAAC,IAAI,EAAE;CACtB,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CAAC;IACzD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,uCAAuC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9D,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,CAAC;IACrD,IAAI,EAAE,kCAAkC;CACzC,CAAC,CAAA"}
1
+ {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../src/apiContracts/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAA;AAEtD,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,sBAAsB,CAAC;CAC3D,CAAC,CAAA;AAGF,oBAAoB;AACpB,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3D,WAAW,EAAE,CAAC,CAAC,IAAI,EAAE;CACtB,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,CAAC,MAAM,CAAC;IACzD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,uCAAuC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9D,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,EAAE,CAAC;IACrD,IAAI,EAAE,kCAAkC;CACzC,CAAC,CAAA;AAGF,iBAAiB;AACjB,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACxD,WAAW,EAAE,CAAC,CAAC,IAAI,EAAE;IACrB,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE;CACpB,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,oCAAoC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3D,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;QACb,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;QACrB,WAAW,EAAE,CAAC,CAAC,IAAI,EAAE;QACrB,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE;KAC5B,CAAC;CACH,CAAC,CAAA"}
@@ -13,24 +13,24 @@ export declare const LANGUAGE_SCHEMA: z.ZodObject<{
13
13
  projectLanguageId: z.ZodNumber;
14
14
  languageId: z.ZodNumber;
15
15
  languageIso: z.ZodString;
16
- projectLanguageUuid: z.ZodGUID;
16
+ projectLanguageUuid: z.ZodUUID;
17
17
  }, z.core.$strip>;
18
18
  export type Language = z.infer<typeof LANGUAGE_SCHEMA>;
19
19
  export declare const PROJECT_SCHEMA: z.ZodObject<{
20
20
  projectId: z.ZodString;
21
- uuid: z.ZodGUID;
21
+ uuid: z.ZodUUID;
22
22
  name: z.ZodString;
23
23
  baseLanguage: z.ZodObject<{
24
24
  projectLanguageId: z.ZodNumber;
25
25
  languageId: z.ZodNumber;
26
26
  languageIso: z.ZodString;
27
- projectLanguageUuid: z.ZodGUID;
27
+ projectLanguageUuid: z.ZodUUID;
28
28
  }, z.core.$strip>;
29
29
  targetLanguages: z.ZodArray<z.ZodObject<{
30
30
  projectLanguageId: z.ZodNumber;
31
31
  languageId: z.ZodNumber;
32
32
  languageIso: z.ZodString;
33
- projectLanguageUuid: z.ZodGUID;
33
+ projectLanguageUuid: z.ZodUUID;
34
34
  }, z.core.$strip>>;
35
35
  translationSettings: z.ZodUnion<readonly [z.ZodObject<{
36
36
  workflowType: z.ZodIntersection<z.ZodEnum<{
@@ -13,11 +13,11 @@ export const LANGUAGE_SCHEMA = z.object({
13
13
  projectLanguageId: z.number(),
14
14
  languageId: z.number(),
15
15
  languageIso: z.string(),
16
- projectLanguageUuid: z.guid(),
16
+ projectLanguageUuid: z.uuid(),
17
17
  });
18
18
  export const PROJECT_SCHEMA = z.object({
19
19
  projectId: z.string(),
20
- uuid: z.guid(),
20
+ uuid: z.uuid(),
21
21
  name: z.string(),
22
22
  baseLanguage: LANGUAGE_SCHEMA,
23
23
  targetLanguages: z.array(LANGUAGE_SCHEMA),
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lokalise/projects-engine-contracts",
3
- "version": "2.0.10",
3
+ "version": "2.1.0",
4
4
  "description": "API contracts and shared schemas for the Projects Engine service",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",