@lokalise/projects-engine-contracts 2.0.3

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 (2) hide show
  1. package/README.md +33 -0
  2. package/package.json +53 -0
package/README.md ADDED
@@ -0,0 +1,33 @@
1
+ # @lokalise/projects-engine-contracts
2
+
3
+ Shared API contracts and domain schemas for the Projects Engine service.
4
+
5
+ ## Contents
6
+
7
+ ### `src/apiContracts/`
8
+
9
+ - **`schemas.ts`** — Zod schemas for request/response validation: `AUTH_HEADERS`, `GET_PROJECTS_LIST_PATH_PARAMS_SCHEMA`, `GET_PROJECTS_LIST_SUCCESS_RESPONSE_BODY`
10
+ - **`projectsContracts.ts`** — typed route contracts built with `@lokalise/api-contracts`: `getProjectsListContract`
11
+
12
+ ### `src/project/`
13
+
14
+ - **`schemas.ts`** — core project domain schemas: `PROJECT_SCHEMA`, `LANGUAGE_SCHEMA`, `ContentSourceEnum`, `WorkflowTypeEnum`
15
+
16
+ ## Publishing
17
+
18
+ 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:
19
+
20
+ | Label | Effect |
21
+ |---|---|
22
+ | `major` | Bumps major version and publishes |
23
+ | `minor` | Bumps minor version and publishes |
24
+ | `patch` | Bumps patch version and publishes |
25
+ | `skip-release` | Skips publishing entirely |
26
+
27
+ Every PR touching this package **must** carry exactly one of these labels (enforced by CI).
28
+
29
+ ## Installation
30
+
31
+ ```bash
32
+ npm install @lokalise/projects-engine-contracts
33
+ ```
package/package.json ADDED
@@ -0,0 +1,53 @@
1
+ {
2
+ "name": "@lokalise/projects-engine-contracts",
3
+ "version": "2.0.3",
4
+ "description": "API contracts and shared schemas for the Projects Engine service",
5
+ "type": "module",
6
+ "main": "./dist/index.js",
7
+ "files": [
8
+ "dist"
9
+ ],
10
+ "exports": {
11
+ ".": "./dist/index.js",
12
+ "./package.json": "./package.json"
13
+ },
14
+ "private": false,
15
+ "publishConfig": {
16
+ "access": "public"
17
+ },
18
+ "sideEffects": false,
19
+ "scripts": {
20
+ "build": "rimraf dist && tsc --project tsconfig.build.json",
21
+ "clean": "rimraf dist",
22
+ "test": "vitest",
23
+ "test:coverage": "vitest --coverage",
24
+ "test:ci": "npm run lint && npm run test:coverage",
25
+ "lint": "biome check . && tsc",
26
+ "lint:fix": "biome check --write",
27
+ "package-version": "echo $npm_package_version"
28
+ },
29
+ "repository": {
30
+ "type": "git",
31
+ "url": "git://github.com/lokalise/projects-engine.git"
32
+ },
33
+ "dependencies": {
34
+ "@lokalise/api-contracts": "^6.7.0",
35
+ "@lokalise/content-type-app-engine-contracts": "^4.6.0",
36
+ "@lokalise/translation-storage-api-schemas": "^9.1.0"
37
+ },
38
+ "peerDependencies": {
39
+ "zod": "^4.0.0"
40
+ },
41
+ "devDependencies": {
42
+ "@biomejs/biome": "2.4.10",
43
+ "@lokalise/biome-config": "^3.1.1",
44
+ "@lokalise/id-utils": "^3.0.1",
45
+ "@lokalise/tsconfig": "^3.1.0",
46
+ "@types/node": "^25.5.0",
47
+ "@vitest/coverage-v8": "^4.1.2",
48
+ "rimraf": "^6.1.3",
49
+ "typescript": "^6.0.2",
50
+ "vitest": "^4.1.2",
51
+ "zod": "^4.3.6"
52
+ }
53
+ }