@lokalise/workspaces-api-schemas 2.3.0 → 3.0.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.
Files changed (10) hide show
  1. package/README.md +1 -0
  2. package/dist/index.d.ts +1 -0
  3. package/dist/index.d.ts.map +1 -1
  4. package/dist/index.js +1 -0
  5. package/dist/index.js.map +1 -1
  6. package/dist/schemas/expert/style-guides.d.ts +72 -0
  7. package/dist/schemas/expert/style-guides.d.ts.map +1 -0
  8. package/dist/schemas/expert/style-guides.js +37 -0
  9. package/dist/schemas/expert/style-guides.js.map +1 -0
  10. package/package.json +1 -1
package/README.md CHANGED
@@ -4,6 +4,7 @@ This library contains schemas and types related to:
4
4
  * Users
5
5
  * Projects
6
6
  * Tasks
7
+ * StyleGuides
7
8
  * Workspaces
8
9
  * Permissions
9
10
  * Subscriptions
package/dist/index.d.ts CHANGED
@@ -12,6 +12,7 @@ export * from './schemas/expert/common.ts';
12
12
  export * from './schemas/expert/contributors.ts';
13
13
  export * from './schemas/expert/project-languages.ts';
14
14
  export * from './schemas/expert/projects.ts';
15
+ export * from './schemas/expert/style-guides.ts';
15
16
  export * from './schemas/expert/tasks.ts';
16
17
  export * from './schemas/expert/users.ts';
17
18
  export * from './schemas/external-integration/api.ts';
package/dist/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,4CAA4C,CAAA;AAC1D,cAAc,2CAA2C,CAAA;AACzD,cAAc,wCAAwC,CAAA;AACtD,cAAc,kDAAkD,CAAA;AAChE,cAAc,uCAAuC,CAAA;AACrD,cAAc,mCAAmC,CAAA;AACjD,cAAc,wCAAwC,CAAA;AACtD,cAAc,wCAAwC,CAAA;AACtD,cAAc,0BAA0B,CAAA;AACxC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,kCAAkC,CAAA;AAChD,cAAc,uCAAuC,CAAA;AACrD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,uCAAuC,CAAA;AACrD,cAAc,sBAAsB,CAAA;AACpC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,0BAA0B,CAAA;AACxC,cAAc,uBAAuB,CAAA;AACrC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,0BAA0B,CAAA;AACxC,cAAc,oCAAoC,CAAA;AAClD,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mCAAmC,CAAA;AACjD,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,4CAA4C,CAAA;AAC1D,cAAc,2CAA2C,CAAA;AACzD,cAAc,wCAAwC,CAAA;AACtD,cAAc,kDAAkD,CAAA;AAChE,cAAc,uCAAuC,CAAA;AACrD,cAAc,mCAAmC,CAAA;AACjD,cAAc,wCAAwC,CAAA;AACtD,cAAc,wCAAwC,CAAA;AACtD,cAAc,0BAA0B,CAAA;AACxC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,kCAAkC,CAAA;AAChD,cAAc,uCAAuC,CAAA;AACrD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,kCAAkC,CAAA;AAChD,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,uCAAuC,CAAA;AACrD,cAAc,sBAAsB,CAAA;AACpC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,0BAA0B,CAAA;AACxC,cAAc,uBAAuB,CAAA;AACrC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,0BAA0B,CAAA;AACxC,cAAc,oCAAoC,CAAA;AAClD,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mCAAmC,CAAA;AACjD,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA"}
package/dist/index.js CHANGED
@@ -12,6 +12,7 @@ export * from "./schemas/expert/common.js";
12
12
  export * from "./schemas/expert/contributors.js";
13
13
  export * from "./schemas/expert/project-languages.js";
14
14
  export * from "./schemas/expert/projects.js";
15
+ export * from "./schemas/expert/style-guides.js";
15
16
  export * from "./schemas/expert/tasks.js";
16
17
  export * from "./schemas/expert/users.js";
17
18
  export * from "./schemas/external-integration/api.js";
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,4CAA4C,CAAA;AAC1D,cAAc,2CAA2C,CAAA;AACzD,cAAc,wCAAwC,CAAA;AACtD,cAAc,kDAAkD,CAAA;AAChE,cAAc,uCAAuC,CAAA;AACrD,cAAc,mCAAmC,CAAA;AACjD,cAAc,wCAAwC,CAAA;AACtD,cAAc,wCAAwC,CAAA;AACtD,cAAc,0BAA0B,CAAA;AACxC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,kCAAkC,CAAA;AAChD,cAAc,uCAAuC,CAAA;AACrD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,uCAAuC,CAAA;AACrD,cAAc,sBAAsB,CAAA;AACpC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,0BAA0B,CAAA;AACxC,cAAc,uBAAuB,CAAA;AACrC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,0BAA0B,CAAA;AACxC,cAAc,oCAAoC,CAAA;AAClD,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mCAAmC,CAAA;AACjD,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,4CAA4C,CAAA;AAC1D,cAAc,2CAA2C,CAAA;AACzD,cAAc,wCAAwC,CAAA;AACtD,cAAc,kDAAkD,CAAA;AAChE,cAAc,uCAAuC,CAAA;AACrD,cAAc,mCAAmC,CAAA;AACjD,cAAc,wCAAwC,CAAA;AACtD,cAAc,wCAAwC,CAAA;AACtD,cAAc,0BAA0B,CAAA;AACxC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,kCAAkC,CAAA;AAChD,cAAc,uCAAuC,CAAA;AACrD,cAAc,8BAA8B,CAAA;AAC5C,cAAc,kCAAkC,CAAA;AAChD,cAAc,2BAA2B,CAAA;AACzC,cAAc,2BAA2B,CAAA;AACzC,cAAc,uCAAuC,CAAA;AACrD,cAAc,sBAAsB,CAAA;AACpC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,0BAA0B,CAAA;AACxC,cAAc,uBAAuB,CAAA;AACrC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,+BAA+B,CAAA;AAC7C,cAAc,6BAA6B,CAAA;AAC3C,cAAc,0BAA0B,CAAA;AACxC,cAAc,oCAAoC,CAAA;AAClD,cAAc,4BAA4B,CAAA;AAC1C,cAAc,mCAAmC,CAAA;AACjD,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,0BAA0B,CAAA;AACxC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA"}
package/dist/schemas/expert/style-guides.d.ts ADDED
@@ -0,0 +1,72 @@
1
+ import { z } from 'zod/v4';
2
+ export declare const STYLE_GUIDES_PROJECT_SCHEMA: z.ZodObject<{
3
+ id: z.ZodString;
4
+ name: z.ZodString;
5
+ team_id: z.ZodNumber;
6
+ language_id: z.ZodNullable<z.ZodNumber>;
7
+ created_at: z.ZodNullable<z.ZodString>;
8
+ updated_at: z.ZodNullable<z.ZodString>;
9
+ ai_summary: z.ZodNullable<z.ZodString>;
10
+ created_by: z.ZodNullable<z.ZodNumber>;
11
+ }, z.core.$strip>;
12
+ export type ProjectStyleGuide = z.infer<typeof STYLE_GUIDES_PROJECT_SCHEMA>;
13
+ export type ProjectStyleGuides = ProjectStyleGuide[];
14
+ export declare const GET_EXPERT_STYLE_GUIDES_REQUEST_PATH_PARAMS_SCHEMA: z.ZodObject<{
15
+ projectUuid: z.ZodUUID;
16
+ }, z.core.$strip>;
17
+ export declare const GET_EXPERT_STYLE_GUIDES_RESPONSE_SCHEMA: z.ZodObject<{
18
+ project_id: z.ZodString;
19
+ project_uuid: z.ZodUUID;
20
+ project_name: z.ZodString;
21
+ branch_name: z.ZodNullable<z.ZodString>;
22
+ style_guides: z.ZodArray<z.ZodObject<{
23
+ id: z.ZodString;
24
+ name: z.ZodString;
25
+ team_id: z.ZodNumber;
26
+ language_id: z.ZodNullable<z.ZodNumber>;
27
+ created_at: z.ZodNullable<z.ZodString>;
28
+ updated_at: z.ZodNullable<z.ZodString>;
29
+ ai_summary: z.ZodNullable<z.ZodString>;
30
+ created_by: z.ZodNullable<z.ZodNumber>;
31
+ }, z.core.$strip>>;
32
+ }, z.core.$strip>;
33
+ export type GetExpertStyleGuidesResponse = z.infer<typeof GET_EXPERT_STYLE_GUIDES_RESPONSE_SCHEMA>;
34
+ export declare const getExpertStyleGuidesContract: import("@lokalise/api-contracts").GetRouteDefinition<z.ZodObject<{
35
+ project_id: z.ZodString;
36
+ project_uuid: z.ZodUUID;
37
+ project_name: z.ZodString;
38
+ branch_name: z.ZodNullable<z.ZodString>;
39
+ style_guides: z.ZodArray<z.ZodObject<{
40
+ id: z.ZodString;
41
+ name: z.ZodString;
42
+ team_id: z.ZodNumber;
43
+ language_id: z.ZodNullable<z.ZodNumber>;
44
+ created_at: z.ZodNullable<z.ZodString>;
45
+ updated_at: z.ZodNullable<z.ZodString>;
46
+ ai_summary: z.ZodNullable<z.ZodString>;
47
+ created_by: z.ZodNullable<z.ZodNumber>;
48
+ }, z.core.$strip>>;
49
+ }, z.core.$strip>, z.ZodObject<{
50
+ projectUuid: z.ZodUUID;
51
+ }, z.core.$strip>, undefined, z.ZodObject<{
52
+ Authorization: z.ZodString;
53
+ 'Content-Type': z.ZodLiteral<"application/json">;
54
+ }, z.core.$strip>, false, false, {
55
+ 200: z.ZodObject<{
56
+ project_id: z.ZodString;
57
+ project_uuid: z.ZodUUID;
58
+ project_name: z.ZodString;
59
+ branch_name: z.ZodNullable<z.ZodString>;
60
+ style_guides: z.ZodArray<z.ZodObject<{
61
+ id: z.ZodString;
62
+ name: z.ZodString;
63
+ team_id: z.ZodNumber;
64
+ language_id: z.ZodNullable<z.ZodNumber>;
65
+ created_at: z.ZodNullable<z.ZodString>;
66
+ updated_at: z.ZodNullable<z.ZodString>;
67
+ ai_summary: z.ZodNullable<z.ZodString>;
68
+ created_by: z.ZodNullable<z.ZodNumber>;
69
+ }, z.core.$strip>>;
70
+ }, z.core.$strip>;
71
+ }>;
72
+ //# sourceMappingURL=style-guides.d.ts.map
package/dist/schemas/expert/style-guides.d.ts.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"style-guides.d.ts","sourceRoot":"","sources":["../../../src/schemas/expert/style-guides.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAG1B,eAAO,MAAM,2BAA2B;;;;;;;;;iBAStC,CAAA;AAEF,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,CAAA;AAC3E,MAAM,MAAM,kBAAkB,GAAG,iBAAiB,EAAE,CAAA;AAMpD,eAAO,MAAM,kDAAkD;;iBAE7D,CAAA;AAEF,eAAO,MAAM,uCAAuC;;;;;;;;;;;;;;;iBAMlD,CAAA;AACF,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uCAAuC,CAAC,CAAA;AAElG,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EASvC,CAAA"}
package/dist/schemas/expert/style-guides.js ADDED
@@ -0,0 +1,37 @@
1
+ import { buildGetRoute } from '@lokalise/api-contracts';
2
+ import { z } from 'zod/v4';
3
+ import { EXPERT_AUTHORIZATION_HEADER_SCHEMA } from "./common.js";
4
+ export const STYLE_GUIDES_PROJECT_SCHEMA = z.object({
5
+ id: z.string(),
6
+ name: z.string(),
7
+ team_id: z.number(),
8
+ language_id: z.number().nullable(),
9
+ created_at: z.string().nullable(),
10
+ updated_at: z.string().nullable(),
11
+ ai_summary: z.string().nullable(),
12
+ created_by: z.number().nullable(),
13
+ });
14
+ // ---------------------------------------------------
15
+ // GET /api2/projects/:projectUuid/style-guides
16
+ // ---------------------------------------------------
17
+ export const GET_EXPERT_STYLE_GUIDES_REQUEST_PATH_PARAMS_SCHEMA = z.object({
18
+ projectUuid: z.uuid(),
19
+ });
20
+ export const GET_EXPERT_STYLE_GUIDES_RESPONSE_SCHEMA = z.object({
21
+ project_id: z.string(),
22
+ project_uuid: z.uuid(),
23
+ project_name: z.string(),
24
+ branch_name: z.string().nullable(),
25
+ style_guides: z.array(STYLE_GUIDES_PROJECT_SCHEMA),
26
+ });
27
+ export const getExpertStyleGuidesContract = buildGetRoute({
28
+ pathResolver: (params) => `/api2/projects/${params.projectUuid}/style-guides`,
29
+ description: 'Retrieve an information about Style Guides by Project UUID',
30
+ requestPathParamsSchema: GET_EXPERT_STYLE_GUIDES_REQUEST_PATH_PARAMS_SCHEMA,
31
+ successResponseBodySchema: GET_EXPERT_STYLE_GUIDES_RESPONSE_SCHEMA,
32
+ responseSchemasByStatusCode: {
33
+ 200: GET_EXPERT_STYLE_GUIDES_RESPONSE_SCHEMA,
34
+ },
35
+ requestHeaderSchema: EXPERT_AUTHORIZATION_HEADER_SCHEMA,
36
+ });
37
+ //# sourceMappingURL=style-guides.js.map
package/dist/schemas/expert/style-guides.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"style-guides.js","sourceRoot":"","sources":["../../../src/schemas/expert/style-guides.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAC1B,OAAO,EAAE,kCAAkC,EAAE,MAAM,aAAa,CAAA;AAEhE,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAClC,CAAC,CAAA;AAKF,sDAAsD;AACtD,+CAA+C;AAC/C,sDAAsD;AAEtD,MAAM,CAAC,MAAM,kDAAkD,GAAG,CAAC,CAAC,MAAM,CAAC;IACzE,WAAW,EAAE,CAAC,CAAC,IAAI,EAAE;CACtB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,uCAAuC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9D,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,YAAY,EAAE,CAAC,CAAC,IAAI,EAAE;IACtB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,2BAA2B,CAAC;CACnD,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,4BAA4B,GAAG,aAAa,CAAC;IACxD,YAAY,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,MAAM,CAAC,WAAW,eAAe;IAC7E,WAAW,EAAE,4DAA4D;IACzE,uBAAuB,EAAE,kDAAkD;IAC3E,yBAAyB,EAAE,uCAAuC;IAClE,2BAA2B,EAAE;QAC3B,GAAG,EAAE,uCAAuC;KAC7C;IACD,mBAAmB,EAAE,kCAAkC;CACxD,CAAC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lokalise/workspaces-api-schemas",
3
- "version": "2.3.0",
3
+ "version": "3.0.0",
4
4
  "files": [
5
5
  "dist"
6
6
  ],