@lokalise/workspaces-api-schemas 5.2.0 → 5.2.2

package/README.md

@@ -1,6 +1,6 @@
 # Workspaces API schemas
 
-This library contains schemas, types and API contracts related to: 
+This library contains schemas, types and API contracts related to:
 * Users
 * Projects
 * Tasks

package/dist/index.d.ts

@@ -29,6 +29,7 @@ export * from './types/permissionTypes.ts';
 export * from './types/projectPermissionTypes.ts';
 export * from './types/projectType.ts';
 export * from './types/projectTypes.ts';
+export * from './types/suggestedContributorTypes.ts';
 export * from './types/tagTypes.ts';
 export * from './types/teamRoleTypes.ts';
 export * from './types/teamTypes.ts';

package/dist/index.js

@@ -29,6 +29,7 @@ export * from "./types/permissionTypes.js";
 export * from "./types/projectPermissionTypes.js";
 export * from "./types/projectType.js";
 export * from "./types/projectTypes.js";
+export * from "./types/suggestedContributorTypes.js";
 export * from "./types/tagTypes.js";
 export * from "./types/teamRoleTypes.js";
 export * from "./types/teamTypes.js";

package/dist/index.js.map

@@ -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,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,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,qBAAqB,CAAA;AACnC,cAAc,0BAA0B,CAAA;AACxC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA"}
+{"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,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,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,sCAAsC,CAAA;AACpD,cAAc,qBAAqB,CAAA;AACnC,cAAc,0BAA0B,CAAA;AACxC,cAAc,sBAAsB,CAAA;AACpC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA"}

package/dist/schemas/objects.d.ts

@@ -92,9 +92,6 @@ export declare const WORKSPACE_USER_SCHEMA: z.ZodObject<{
         readonly Biller: "biller";
         readonly Member: "member";
         readonly PortalMember: "portal_member";
-        readonly WorkspaceAdmin: "Admin";
-        readonly WorkspaceReviewer: "WorkspaceReviewer";
-        readonly Reviewer: "Reviewer";
     }>;
     locales: z.ZodArray<z.ZodString>;
 }, z.core.$strip>;
@@ -124,9 +121,6 @@ export declare const USER_DATA_SCHEMA: z.ZodObject<{
         readonly Biller: "biller";
         readonly Member: "member";
         readonly PortalMember: "portal_member";
-        readonly WorkspaceAdmin: "Admin";
-        readonly WorkspaceReviewer: "WorkspaceReviewer";
-        readonly Reviewer: "Reviewer";
     }>>;
     userIdIntercomHash: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;

package/dist/schemas/workspace/api.d.ts

@@ -13,9 +13,6 @@ export declare const GET_WORKSPACE_USERS_RESPONSE_SCHEMA: z.ZodObject<{
             readonly Biller: "biller";
             readonly Member: "member";
             readonly PortalMember: "portal_member";
-            readonly WorkspaceAdmin: "Admin";
-            readonly WorkspaceReviewer: "WorkspaceReviewer";
-            readonly Reviewer: "Reviewer";
         }>;
         locales: z.ZodArray<z.ZodString>;
     }, z.core.$strip>>;

package/dist/types/suggestedContributorTypes.d.ts

@@ -0,0 +1,146 @@
+import { z } from 'zod/v4';
+export declare const SUGGESTED_CONTRIBUTORS_API_BASE_HEADER_SCHEMA: z.ZodIntersection<z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodObject<{
+    authorization: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    AUTHORIZATION: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    Authorization: z.ZodString;
+}, z.core.$strip>]>, z.ZodUnion<readonly [z.ZodObject<{
+    'X-API-Token': z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    'X-Api-Token': z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    'x-api-token': z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    'X-API-TOKEN': z.ZodString;
+}, z.core.$strip>]>]>, z.ZodUnion<readonly [z.ZodObject<{
+    'X-Lokalise-Plugin': z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    'x-lokalise-plugin': z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    'X-LOKALISE-PLUGIN': z.ZodString;
+}, z.core.$strip>]>>;
+export declare const SUGGESTED_DEFAULT_CONTRIBUTOR_SCHEMA: z.ZodObject<{
+    user_id: z.ZodNumber;
+    user_uuid: z.ZodOptional<z.ZodUUID>;
+    email: z.ZodEmail;
+    fullname: z.ZodString;
+    avatar_url: z.ZodString;
+    languages: z.ZodArray<z.ZodObject<{
+        lang_id: z.ZodNumber;
+        lang_iso: z.ZodString;
+        lang_name: z.ZodString;
+        is_writable: z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>, z.ZodBoolean]>;
+    }, z.core.$strip>>;
+    role_id: z.ZodNullable<z.ZodNumber>;
+    is_owner: z.ZodBoolean;
+    is_admin: z.ZodBoolean;
+    is_pending: z.ZodBoolean;
+    last_logged_in_at: z.ZodNullable<z.ZodISODateTime>;
+    last_logged_in_at_timestamp: z.ZodNullable<z.ZodNumber>;
+    team_role: z.ZodString;
+}, z.core.$strip>;
+export declare const SUGGESTED_CONTRIBUTORS_LANGUAGE_SCHEMA: z.ZodObject<{
+    lang_iso: z.ZodString;
+    lang_iso_bcp47: z.ZodString;
+    contributors: z.ZodArray<z.ZodObject<{
+        user_id: z.ZodNumber;
+        user_uuid: z.ZodOptional<z.ZodUUID>;
+        email: z.ZodEmail;
+        fullname: z.ZodString;
+        avatar_url: z.ZodString;
+        languages: z.ZodArray<z.ZodObject<{
+            lang_id: z.ZodNumber;
+            lang_iso: z.ZodString;
+            lang_name: z.ZodString;
+            is_writable: z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>, z.ZodBoolean]>;
+        }, z.core.$strip>>;
+        role_id: z.ZodNullable<z.ZodNumber>;
+        is_owner: z.ZodBoolean;
+        is_admin: z.ZodBoolean;
+        is_pending: z.ZodBoolean;
+        last_logged_in_at: z.ZodNullable<z.ZodISODateTime>;
+        last_logged_in_at_timestamp: z.ZodNullable<z.ZodNumber>;
+        team_role: z.ZodString;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+}, z.core.$strip>;
+export declare const LIST_SUGGESTED_CONTRIBUTORS_TEAM_PATH_PARAMS_SCHEMA: z.ZodObject<{
+    teamId: z.ZodGUID;
+}, z.core.$strip>;
+export declare const LIST_SUGGESTED_CONTRIBUTORS_PROJECT_PATH_PARAMS_SCHEMA: z.ZodObject<{
+    projectId: z.ZodGUID;
+}, z.core.$strip>;
+export declare const LIST_SUGGESTED_CONTRIBUTORS_REQUEST_BODY_SCHEMA: z.ZodObject<{
+    languages: z.ZodArray<z.ZodString>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    offset: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export declare const LIST_SUGGESTED_CONTRIBUTORS_TEAM_RESPONSE_SCHEMA: z.ZodObject<{
+    languages: z.ZodRecord<z.ZodString, z.ZodObject<{
+        lang_iso: z.ZodString;
+        lang_iso_bcp47: z.ZodString;
+        contributors: z.ZodArray<z.ZodObject<{
+            user_id: z.ZodNumber;
+            user_uuid: z.ZodOptional<z.ZodUUID>;
+            email: z.ZodEmail;
+            fullname: z.ZodString;
+            avatar_url: z.ZodString;
+            languages: z.ZodArray<z.ZodObject<{
+                lang_id: z.ZodNumber;
+                lang_iso: z.ZodString;
+                lang_name: z.ZodString;
+                is_writable: z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>, z.ZodBoolean]>;
+            }, z.core.$strip>>;
+            role_id: z.ZodNullable<z.ZodNumber>;
+            is_owner: z.ZodBoolean;
+            is_admin: z.ZodBoolean;
+            is_pending: z.ZodBoolean;
+            last_logged_in_at: z.ZodNullable<z.ZodISODateTime>;
+            last_logged_in_at_timestamp: z.ZodNullable<z.ZodNumber>;
+            team_role: z.ZodString;
+        }, z.core.$strip>>;
+        total: z.ZodNumber;
+    }, z.core.$strip>>;
+    offset: z.ZodNumber;
+    limit: z.ZodNumber;
+    team_id: z.ZodNumber;
+    team_uuid: z.ZodGUID;
+}, z.core.$strip>;
+export declare const LIST_SUGGESTED_CONTRIBUTORS_PROJECT_RESPONSE_SCHEMA: z.ZodObject<{
+    languages: z.ZodRecord<z.ZodString, z.ZodObject<{
+        lang_iso: z.ZodString;
+        lang_iso_bcp47: z.ZodString;
+        contributors: z.ZodArray<z.ZodObject<{
+            user_id: z.ZodNumber;
+            user_uuid: z.ZodOptional<z.ZodUUID>;
+            email: z.ZodEmail;
+            fullname: z.ZodString;
+            avatar_url: z.ZodString;
+            languages: z.ZodArray<z.ZodObject<{
+                lang_id: z.ZodNumber;
+                lang_iso: z.ZodString;
+                lang_name: z.ZodString;
+                is_writable: z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>, z.ZodBoolean]>;
+            }, z.core.$strip>>;
+            role_id: z.ZodNullable<z.ZodNumber>;
+            is_owner: z.ZodBoolean;
+            is_admin: z.ZodBoolean;
+            is_pending: z.ZodBoolean;
+            last_logged_in_at: z.ZodNullable<z.ZodISODateTime>;
+            last_logged_in_at_timestamp: z.ZodNullable<z.ZodNumber>;
+            team_role: z.ZodString;
+        }, z.core.$strip>>;
+        total: z.ZodNumber;
+    }, z.core.$strip>>;
+    offset: z.ZodNumber;
+    limit: z.ZodNumber;
+    project_uuid: z.ZodGUID;
+}, z.core.$strip>;
+export type SuggestedContributorApiBaseHeader = z.infer<typeof SUGGESTED_CONTRIBUTORS_API_BASE_HEADER_SCHEMA>;
+export type SuggestedDefaultContributor = z.infer<typeof SUGGESTED_DEFAULT_CONTRIBUTOR_SCHEMA>;
+export type ListSuggestedContributorsTeamPathParams = z.infer<typeof LIST_SUGGESTED_CONTRIBUTORS_TEAM_PATH_PARAMS_SCHEMA>;
+export type ListSuggestedContributorsProjectPathParams = z.infer<typeof LIST_SUGGESTED_CONTRIBUTORS_PROJECT_PATH_PARAMS_SCHEMA>;
+export type ListSuggestedContributorsRequestBody = z.infer<typeof LIST_SUGGESTED_CONTRIBUTORS_REQUEST_BODY_SCHEMA>;
+export type ListSuggestedContributorsTeamResponse = z.infer<typeof LIST_SUGGESTED_CONTRIBUTORS_TEAM_RESPONSE_SCHEMA>;
+export type ListSuggestedContributorsProjectResponse = z.infer<typeof LIST_SUGGESTED_CONTRIBUTORS_PROJECT_RESPONSE_SCHEMA>;

package/dist/types/suggestedContributorTypes.js

@@ -0,0 +1,47 @@
+import { BASE_API_ENDPOINT_HEADER_SCHEMA } from '@lokalise/common-api-schemas';
+import { z } from 'zod/v4';
+import { CONTRIBUTOR_SCHEMA } from "./contributorTypes.js";
+export const SUGGESTED_CONTRIBUTORS_API_BASE_HEADER_SCHEMA = BASE_API_ENDPOINT_HEADER_SCHEMA;
+const LOCALE_KEY = z.string().regex(/^[a-z]{2}(_[A-Z]{2})?$/); // e.g. en, fr_FR, etc.
+export const SUGGESTED_DEFAULT_CONTRIBUTOR_SCHEMA = CONTRIBUTOR_SCHEMA.omit({
+    admin_rights: true,
+    permissions: true,
+    is_reinvited: true,
+    is_reviewer: true,
+    created_at: true,
+    created_at_timestamp: true,
+}).extend({
+    last_logged_in_at: z.iso.datetime().nullable(),
+    last_logged_in_at_timestamp: z.number().nullable(),
+    team_role: z.string(),
+});
+export const SUGGESTED_CONTRIBUTORS_LANGUAGE_SCHEMA = z.object({
+    lang_iso: z.string(),
+    lang_iso_bcp47: z.string(),
+    contributors: z.array(SUGGESTED_DEFAULT_CONTRIBUTOR_SCHEMA),
+    total: z.number(),
+});
+export const LIST_SUGGESTED_CONTRIBUTORS_TEAM_PATH_PARAMS_SCHEMA = z.object({
+    teamId: z.guid(),
+});
+export const LIST_SUGGESTED_CONTRIBUTORS_PROJECT_PATH_PARAMS_SCHEMA = z.object({
+    projectId: z.guid(),
+});
+export const LIST_SUGGESTED_CONTRIBUTORS_REQUEST_BODY_SCHEMA = z.object({
+    languages: z.array(LOCALE_KEY),
+    limit: z.number().optional(),
+    offset: z.number().optional(),
+});
+const LIST_SUGGESTED_CONTRIBUTORS_RESPONSE_SCHEMA = z.object({
+    languages: z.record(LOCALE_KEY, SUGGESTED_CONTRIBUTORS_LANGUAGE_SCHEMA),
+    offset: z.number(),
+    limit: z.number(),
+});
+export const LIST_SUGGESTED_CONTRIBUTORS_TEAM_RESPONSE_SCHEMA = LIST_SUGGESTED_CONTRIBUTORS_RESPONSE_SCHEMA.extend({
+    team_id: z.number(),
+    team_uuid: z.guid(),
+});
+export const LIST_SUGGESTED_CONTRIBUTORS_PROJECT_RESPONSE_SCHEMA = LIST_SUGGESTED_CONTRIBUTORS_RESPONSE_SCHEMA.extend({
+    project_uuid: z.guid(),
+});
+//# sourceMappingURL=suggestedContributorTypes.js.map

package/dist/types/suggestedContributorTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggestedContributorTypes.js","sourceRoot":"","sources":["../../src/types/suggestedContributorTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,8BAA8B,CAAA;AAC9E,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAE1D,MAAM,CAAC,MAAM,6CAA6C,GAAG,+BAA+B,CAAA;AAE5F,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAA,CAAC,uBAAuB;AAErF,MAAM,CAAC,MAAM,oCAAoC,GAAG,kBAAkB,CAAC,IAAI,CAAC;IAC1E,YAAY,EAAE,IAAI;IAClB,WAAW,EAAE,IAAI;IACjB,YAAY,EAAE,IAAI;IAClB,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,IAAI;IAChB,oBAAoB,EAAE,IAAI;CAC3B,CAAC,CAAC,MAAM,CAAC;IACR,iBAAiB,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;IAC9C,2BAA2B,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClD,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;CACtB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,sCAAsC,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7D,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE;IAC1B,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC,oCAAoC,CAAC;IAC3D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,mDAAmD,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1E,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE;CACjB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,sDAAsD,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7E,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE;CACpB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,+CAA+C,GAAG,CAAC,CAAC,MAAM,CAAC;IACtE,SAAS,EAAE,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC;IAC9B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC5B,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC9B,CAAC,CAAA;AAEF,MAAM,2CAA2C,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3D,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,UAAU,EAAE,sCAAsC,CAAC;IACvE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;CAClB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,gDAAgD,GAC3D,2CAA2C,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IACnB,SAAS,EAAE,CAAC,CAAC,IAAI,EAAE;CACpB,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,mDAAmD,GAC9D,2CAA2C,CAAC,MAAM,CAAC;IACjD,YAAY,EAAE,CAAC,CAAC,IAAI,EAAE;CACvB,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/workspaces-api-schemas",
-    "version": "5.2.0",
+    "version": "5.2.2",
     "files": [
         "dist"
     ],