@lokalise/projects-engine-contracts 2.0.3 → 2.0.10

package/README.md

@@ -17,15 +17,19 @@ Shared API contracts and domain schemas for the Projects Engine service.
 
 This package is published to NPM automatically when a PR that modifies `packages/**` is merged to `main`. The version bump is driven by the PR label:
 
-| Label | Effect |
-|---|---|
-| `major` | Bumps major version and publishes |
-| `minor` | Bumps minor version and publishes |
-| `patch` | Bumps patch version and publishes |
-| `skip-release` | Skips publishing entirely |
+| Label          | Effect                            |
+|----------------|-----------------------------------|
+| `major`        | Bumps major version and publishes |
+| `minor`        | Bumps minor version and publishes |
+| `patch`        | Bumps patch version and publishes |
+| `skip-release` | Skips publishing entirely         |
 
 Every PR touching this package **must** carry exactly one of these labels (enforced by CI).
 
+## Peer dependencies
+
+This package requires `zod@^4.0.0` as a peer dependency.
+
 ## Installation
 
 ```bash

package/dist/apiContracts/projectsContracts.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Public API router definition for getting the list of projects for a given workspace
+ */
+export declare const getProjectsListContract: import("@lokalise/api-contracts").GetRouteDefinition<import("zod").ZodObject<{
+    data: import("zod").ZodObject<{
+        projects: import("zod").ZodArray<import("zod").ZodObject<{
+            projectId: import("zod").ZodString;
+            uuid: import("zod").ZodGUID;
+            name: import("zod").ZodString;
+            baseLanguage: import("zod").ZodObject<{
+                projectLanguageId: import("zod").ZodNumber;
+                languageId: import("zod").ZodNumber;
+                languageIso: import("zod").ZodString;
+                projectLanguageUuid: import("zod").ZodGUID;
+            }, import("zod/v4/core").$strip>;
+            targetLanguages: import("zod").ZodArray<import("zod").ZodObject<{
+                projectLanguageId: import("zod").ZodNumber;
+                languageId: import("zod").ZodNumber;
+                languageIso: import("zod").ZodString;
+                projectLanguageUuid: import("zod").ZodGUID;
+            }, import("zod/v4/core").$strip>>;
+            translationSettings: import("zod").ZodUnion<readonly [import("zod").ZodObject<{
+                workflowType: import("zod").ZodIntersection<import("zod").ZodEnum<{
+                    readonly AI_ONLY: "AI_ONLY";
+                    readonly AI_HUMAN_REVIEW: "AI_HUMAN_REVIEW";
+                }>, import("zod").ZodLiteral<"AI_HUMAN_REVIEW">>;
+                reviewThreshold: import("zod").ZodEnum<{
+                    readonly FULL_REVIEW: "FULL_REVIEW";
+                    readonly CRITICAL_MAJOR_MINOR: "CRITICAL_MAJOR_MINOR";
+                    readonly CRITICAL_MAJOR: "CRITICAL_MAJOR";
+                    readonly CRITICAL: "CRITICAL";
+                }>;
+            }, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+                workflowType: import("zod").ZodIntersection<import("zod").ZodEnum<{
+                    readonly AI_ONLY: "AI_ONLY";
+                    readonly AI_HUMAN_REVIEW: "AI_HUMAN_REVIEW";
+                }>, import("zod").ZodLiteral<"AI_ONLY">>;
+                reviewThreshold: import("zod").ZodNull;
+            }, import("zod/v4/core").$strip>]>;
+            contentSourceType: import("zod").ZodEnum<{
+                readonly contentful: "contentful-native";
+                readonly googleDrive: "google-drive";
+                readonly strapi: "strapi";
+                readonly webflowNew: "webflow-new";
+                readonly FILE: "file";
+            }>;
+        }, import("zod/v4/core").$strip>>;
+    }, import("zod/v4/core").$strip>;
+    meta: import("zod").ZodObject<{
+        count: import("zod").ZodNumber;
+    }, import("zod/v4/core").$strip>;
+}, import("zod/v4/core").$strip>, import("zod").ZodObject<{
+    workspaceId: import("zod").ZodGUID;
+}, import("zod/v4/core").$strip>, undefined, import("zod").ZodObject<{
+    authorization: import("zod").ZodString;
+}, import("zod/v4/core").$strip>, undefined, false, false, undefined>;

package/dist/apiContracts/projectsContracts.js

@@ -0,0 +1,13 @@
+import { buildGetRoute } from '@lokalise/api-contracts';
+import { AUTH_HEADERS, GET_PROJECTS_LIST_PATH_PARAMS_SCHEMA, GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY, } from './schemas.js';
+/**
+ * Public API router definition for getting the list of projects for a given workspace
+ */
+export const getProjectsListContract = buildGetRoute({
+    pathResolver: (params) => `/v1/workspaces/${params.workspaceId}/projects/list`,
+    description: 'Get projects list',
+    requestHeaderSchema: AUTH_HEADERS,
+    requestPathParamsSchema: GET_PROJECTS_LIST_PATH_PARAMS_SCHEMA,
+    successResponseBodySchema: GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY,
+});
+//# sourceMappingURL=projectsContracts.js.map

package/dist/apiContracts/projectsContracts.js.map

@@ -0,0 +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"}

package/dist/apiContracts/schemas.d.ts

@@ -0,0 +1,63 @@
+import { z } from 'zod/v4';
+export declare const AUTH_HEADERS: z.ZodObject<{
+    authorization: z.ZodString;
+}, z.core.$strip>;
+export type AuthHeaders = z.infer<typeof AUTH_HEADERS>;
+export declare const GET_PROJECTS_LIST_PATH_PARAMS_SCHEMA: z.ZodObject<{
+    workspaceId: z.ZodGUID;
+}, z.core.$strip>;
+export type GetProjectsListPathParams = z.infer<typeof GET_PROJECTS_LIST_PATH_PARAMS_SCHEMA>;
+export declare const PROJECTS_LIST_RESPONSE_META_SCHEMA: z.ZodObject<{
+    count: z.ZodNumber;
+}, z.core.$strip>;
+export type ProjectsListResponseMeta = z.infer<typeof PROJECTS_LIST_RESPONSE_META_SCHEMA>;
+export declare const GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY: z.ZodObject<{
+    data: z.ZodObject<{
+        projects: z.ZodArray<z.ZodObject<{
+            projectId: z.ZodString;
+            uuid: z.ZodGUID;
+            name: z.ZodString;
+            baseLanguage: z.ZodObject<{
+                projectLanguageId: z.ZodNumber;
+                languageId: z.ZodNumber;
+                languageIso: z.ZodString;
+                projectLanguageUuid: z.ZodGUID;
+            }, z.core.$strip>;
+            targetLanguages: z.ZodArray<z.ZodObject<{
+                projectLanguageId: z.ZodNumber;
+                languageId: z.ZodNumber;
+                languageIso: z.ZodString;
+                projectLanguageUuid: z.ZodGUID;
+            }, z.core.$strip>>;
+            translationSettings: z.ZodUnion<readonly [z.ZodObject<{
+                workflowType: z.ZodIntersection<z.ZodEnum<{
+                    readonly AI_ONLY: "AI_ONLY";
+                    readonly AI_HUMAN_REVIEW: "AI_HUMAN_REVIEW";
+                }>, z.ZodLiteral<"AI_HUMAN_REVIEW">>;
+                reviewThreshold: z.ZodEnum<{
+                    readonly FULL_REVIEW: "FULL_REVIEW";
+                    readonly CRITICAL_MAJOR_MINOR: "CRITICAL_MAJOR_MINOR";
+                    readonly CRITICAL_MAJOR: "CRITICAL_MAJOR";
+                    readonly CRITICAL: "CRITICAL";
+                }>;
+            }, z.core.$strip>, z.ZodObject<{
+                workflowType: z.ZodIntersection<z.ZodEnum<{
+                    readonly AI_ONLY: "AI_ONLY";
+                    readonly AI_HUMAN_REVIEW: "AI_HUMAN_REVIEW";
+                }>, z.ZodLiteral<"AI_ONLY">>;
+                reviewThreshold: z.ZodNull;
+            }, z.core.$strip>]>;
+            contentSourceType: z.ZodEnum<{
+                readonly contentful: "contentful-native";
+                readonly googleDrive: "google-drive";
+                readonly strapi: "strapi";
+                readonly webflowNew: "webflow-new";
+                readonly FILE: "file";
+            }>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    meta: z.ZodObject<{
+        count: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type GetProjectsListSuccessResponse = z.infer<typeof GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY>;

package/dist/apiContracts/schemas.js

@@ -0,0 +1,17 @@
+import { z } from 'zod/v4';
+import { PROJECT_SCHEMA } from '../project/schemas.js';
+export const AUTH_HEADERS = z.object({
+    authorization: z.string().describe('Authorization header'),
+});
+// GET PROJECTS LIST
+export const GET_PROJECTS_LIST_PATH_PARAMS_SCHEMA = z.object({
+    workspaceId: z.guid(),
+});
+export const PROJECTS_LIST_RESPONSE_META_SCHEMA = z.object({
+    count: z.number(),
+});
+export const GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY = z.object({
+    data: z.object({ projects: z.array(PROJECT_SCHEMA) }),
+    meta: PROJECTS_LIST_RESPONSE_META_SCHEMA,
+});
+//# sourceMappingURL=schemas.js.map

package/dist/apiContracts/schemas.js.map

@@ -0,0 +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"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './apiContracts/projectsContracts.js';
+export * from './apiContracts/schemas.js';
+export * from './project/schemas.js';

package/dist/index.js

@@ -0,0 +1,4 @@
+export * from './apiContracts/projectsContracts.js';
+export * from './apiContracts/schemas.js';
+export * from './project/schemas.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qCAAqC,CAAA;AACnD,cAAc,2BAA2B,CAAA;AACzC,cAAc,sBAAsB,CAAA"}

package/dist/project/schemas.d.ts

@@ -0,0 +1,61 @@
+import { WorkflowTypeEnum } from '@lokalise/translation-storage-api-schemas';
+import { z } from 'zod/v4';
+export { WorkflowTypeEnum };
+export declare const ContentSourceEnum: {
+    readonly contentful: "contentful-native";
+    readonly googleDrive: "google-drive";
+    readonly strapi: "strapi";
+    readonly webflowNew: "webflow-new";
+    readonly FILE: "file";
+};
+export type ContentSourceType = (typeof ContentSourceEnum)[keyof typeof ContentSourceEnum];
+export declare const LANGUAGE_SCHEMA: z.ZodObject<{
+    projectLanguageId: z.ZodNumber;
+    languageId: z.ZodNumber;
+    languageIso: z.ZodString;
+    projectLanguageUuid: z.ZodGUID;
+}, z.core.$strip>;
+export type Language = z.infer<typeof LANGUAGE_SCHEMA>;
+export declare const PROJECT_SCHEMA: z.ZodObject<{
+    projectId: z.ZodString;
+    uuid: z.ZodGUID;
+    name: z.ZodString;
+    baseLanguage: z.ZodObject<{
+        projectLanguageId: z.ZodNumber;
+        languageId: z.ZodNumber;
+        languageIso: z.ZodString;
+        projectLanguageUuid: z.ZodGUID;
+    }, z.core.$strip>;
+    targetLanguages: z.ZodArray<z.ZodObject<{
+        projectLanguageId: z.ZodNumber;
+        languageId: z.ZodNumber;
+        languageIso: z.ZodString;
+        projectLanguageUuid: z.ZodGUID;
+    }, z.core.$strip>>;
+    translationSettings: z.ZodUnion<readonly [z.ZodObject<{
+        workflowType: z.ZodIntersection<z.ZodEnum<{
+            readonly AI_ONLY: "AI_ONLY";
+            readonly AI_HUMAN_REVIEW: "AI_HUMAN_REVIEW";
+        }>, z.ZodLiteral<"AI_HUMAN_REVIEW">>;
+        reviewThreshold: z.ZodEnum<{
+            readonly FULL_REVIEW: "FULL_REVIEW";
+            readonly CRITICAL_MAJOR_MINOR: "CRITICAL_MAJOR_MINOR";
+            readonly CRITICAL_MAJOR: "CRITICAL_MAJOR";
+            readonly CRITICAL: "CRITICAL";
+        }>;
+    }, z.core.$strip>, z.ZodObject<{
+        workflowType: z.ZodIntersection<z.ZodEnum<{
+            readonly AI_ONLY: "AI_ONLY";
+            readonly AI_HUMAN_REVIEW: "AI_HUMAN_REVIEW";
+        }>, z.ZodLiteral<"AI_ONLY">>;
+        reviewThreshold: z.ZodNull;
+    }, z.core.$strip>]>;
+    contentSourceType: z.ZodEnum<{
+        readonly contentful: "contentful-native";
+        readonly googleDrive: "google-drive";
+        readonly strapi: "strapi";
+        readonly webflowNew: "webflow-new";
+        readonly FILE: "file";
+    }>;
+}, z.core.$strip>;
+export type Project = z.infer<typeof PROJECT_SCHEMA>;

package/dist/project/schemas.js

@@ -0,0 +1,36 @@
+import { IntegrationEnum } from '@lokalise/content-type-app-engine-contracts';
+import { REVIEW_THRESHOLD_SCHEMA, WORKFLOW_TYPE_SCHEMA, WorkflowTypeEnum, } from '@lokalise/translation-storage-api-schemas';
+import { z } from 'zod/v4';
+// =============================================================================
+// BASE SCHEMAS - Reusable building blocks
+// =============================================================================
+export { WorkflowTypeEnum };
+export const ContentSourceEnum = {
+    FILE: 'file',
+    ...IntegrationEnum,
+};
+export const LANGUAGE_SCHEMA = z.object({
+    projectLanguageId: z.number(),
+    languageId: z.number(),
+    languageIso: z.string(),
+    projectLanguageUuid: z.guid(),
+});
+export const PROJECT_SCHEMA = z.object({
+    projectId: z.string(),
+    uuid: z.guid(),
+    name: z.string(),
+    baseLanguage: LANGUAGE_SCHEMA,
+    targetLanguages: z.array(LANGUAGE_SCHEMA),
+    translationSettings: z.union([
+        z.object({
+            workflowType: WORKFLOW_TYPE_SCHEMA.and(z.literal(WorkflowTypeEnum.AI_HUMAN_REVIEW)),
+            reviewThreshold: REVIEW_THRESHOLD_SCHEMA,
+        }),
+        z.object({
+            workflowType: WORKFLOW_TYPE_SCHEMA.and(z.literal(WorkflowTypeEnum.AI_ONLY)),
+            reviewThreshold: z.null(),
+        }),
+    ]),
+    contentSourceType: z.enum(ContentSourceEnum),
+});
+//# sourceMappingURL=schemas.js.map

package/dist/project/schemas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../src/project/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,6CAA6C,CAAA;AAC7E,OAAO,EACL,uBAAuB,EACvB,oBAAoB,EACpB,gBAAgB,GACjB,MAAM,2CAA2C,CAAA;AAClD,OAAO,EAAE,CAAC,EAAE,MAAM,QAAQ,CAAA;AAE1B,gFAAgF;AAChF,0CAA0C;AAC1C,gFAAgF;AAEhF,OAAO,EAAE,gBAAgB,EAAE,CAAA;AAE3B,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,IAAI,EAAE,MAAM;IACZ,GAAG,eAAe;CACV,CAAA;AAGV,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE;IAC7B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,mBAAmB,EAAE,CAAC,CAAC,IAAI,EAAE;CAC9B,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE;IACd,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,YAAY,EAAE,eAAe;IAC7B,eAAe,EAAE,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC;IACzC,mBAAmB,EAAE,CAAC,CAAC,KAAK,CAAC;QAC3B,CAAC,CAAC,MAAM,CAAC;YACP,YAAY,EAAE,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;YACnF,eAAe,EAAE,uBAAuB;SACzC,CAAC;QACF,CAAC,CAAC,MAAM,CAAC;YACP,YAAY,EAAE,oBAAoB,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;YAC3E,eAAe,EAAE,CAAC,CAAC,IAAI,EAAE;SAC1B,CAAC;KACH,CAAC;IACF,iBAAiB,EAAE,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC;CAC7C,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@lokalise/projects-engine-contracts",
-    "version": "2.0.3",
+    "version": "2.0.10",
     "description": "API contracts and shared schemas for the Projects Engine service",
     "type": "module",
     "main": "./dist/index.js",
@@ -11,10 +11,19 @@
         ".": "./dist/index.js",
         "./package.json": "./package.json"
     },
+    "license": "Apache-2.0",
     "private": false,
     "publishConfig": {
-        "access": "public"
+        "access": "public",
+        "provenance": false
     },
+    "homepage": "https://github.com/lokalise/projects-engine",
+    "keywords": [
+        "projects",
+        "contracts",
+        "api",
+        "schemas"
+    ],
     "sideEffects": false,
     "scripts": {
         "build": "rimraf dist && tsc --project tsconfig.build.json",
@@ -24,11 +33,13 @@
         "test:ci": "npm run lint && npm run test:coverage",
         "lint": "biome check . && tsc",
         "lint:fix": "biome check --write",
+        "prepublishOnly": "npm run build",
+        "postversion": "biome check --write package.json",
         "package-version": "echo $npm_package_version"
     },
     "repository": {
         "type": "git",
-        "url": "git://github.com/lokalise/projects-engine.git"
+        "url": "git+https://github.com/lokalise/projects-engine.git"
     },
     "dependencies": {
         "@lokalise/api-contracts": "^6.7.0",