@lokalise/ragnarok-api-contracts 0.0.2 → 0.1.0

package/LICENSE

@@ -1,13 +1,13 @@
-Copyright 2026 Lokalise, Inc.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
+Copyright 2026 Lokalise, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
 limitations under the License.

package/README.md

@@ -1,22 +1,22 @@
-# @lokalise/ragnarok-api-contracts
-
-API contracts for the Lokalise Ragnarok Service.  
-This package provides type-safe, validated API route definitions using Zod schemas.
-
-## Installation
-
-```bash
-npm install @lokalise/ragnarok-api-contracts
-```
-
-### Peer Dependencies
-
-This package requires `zod` as a peer dependency:
-
-```bash
-npm install zod@^4.0.0
-```
-
-## License
-
-Apache-2.0
+# @lokalise/ragnarok-api-contracts
+
+API contracts for the Lokalise Ragnarok Service.  
+This package provides type-safe, validated API route definitions using Zod schemas.
+
+## Installation
+
+```bash
+npm install @lokalise/ragnarok-api-contracts
+```
+
+### Peer Dependencies
+
+This package requires `zod` as a peer dependency:
+
+```bash
+npm install zod@^4.0.0
+```
+
+## License
+
+Apache-2.0

package/dist/common.d.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export declare const AUTH_HEADERS: z.ZodObject<{
+    authorization: z.ZodString;
+}, z.core.$strip>;
+export declare const WEBHOOK_SCHEMA: z.ZodObject<{
+    url: z.ZodURL;
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$strip>;

package/dist/common.js

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+export const AUTH_HEADERS = z.object({
+    authorization: z.string(),
+});
+export const WEBHOOK_SCHEMA = z
+    .object({
+    url: z
+        .url()
+        .max(2048)
+        .describe('The URL to which the webhook will be sent as HTTP POST request once the job has finished.'),
+    headers: z
+        .record(z
+        .string()
+        .regex(/^[A-Za-z0-9-]+$/, {
+        message: 'Header names must contain only letters, numbers, and dashes',
+    })
+        .max(128)
+        .describe('The HTTP header name (e.g., Authorization, X-Custom-Id)'), z.string().min(1).max(2048).describe('The HTTP header value; must be a non-empty string'))
+        .optional()
+        .describe('Additional headers to include in the webhook request.'),
+})
+    .describe('Configuration for sending a webhook callback when the job completes.');
+//# sourceMappingURL=common.js.map

package/dist/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../src/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;CAC1B,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC;KAC5B,MAAM,CAAC;IACN,GAAG,EAAE,CAAC;SACH,GAAG,EAAE;SACL,GAAG,CAAC,IAAI,CAAC;SACT,QAAQ,CACP,2FAA2F,CAC5F;IACH,OAAO,EAAE,CAAC;SACP,MAAM,CACL,CAAC;SACE,MAAM,EAAE;SACR,KAAK,CAAC,iBAAiB,EAAE;QACxB,OAAO,EAAE,6DAA6D;KACvE,CAAC;SACD,GAAG,CAAC,GAAG,CAAC;SACR,QAAQ,CAAC,yDAAyD,CAAC,EACtE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,mDAAmD,CAAC,CAC1F;SACA,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;CACrE,CAAC;KACD,QAAQ,CAAC,sEAAsE,CAAC,CAAA"}

package/dist/evaluation-contracts.d.ts

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+declare const GET_EVALUATION_SCHEMA: z.ZodObject<{
+    evaluationId: z.ZodUUID;
+}, z.core.$strip>;
+export type GetEvaluationParams = z.infer<typeof GET_EVALUATION_SCHEMA>;
+export declare const getEvaluation: import("@lokalise/api-contracts").GetRouteDefinition<z.ZodObject<{
+    id: z.ZodUUID;
+    ownerId: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    evaluationId: z.ZodUUID;
+}, z.core.$strip>, undefined, z.ZodObject<{
+    authorization: z.ZodString;
+}, z.core.$strip>, undefined, false, false, undefined>;
+export declare const postScheduleEvaluation: import("@lokalise/api-contracts").PayloadRouteDefinition<z.ZodObject<{
+    correlationId: z.ZodString;
+    datasets: z.ZodRecord<z.ZodString, z.ZodURL>;
+    webhook: z.ZodObject<{
+        url: z.ZodURL;
+        headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    evaluationId: z.ZodUUID;
+}, z.core.$strip>, undefined, undefined, z.ZodObject<{
+    authorization: z.ZodString;
+}, z.core.$strip>, undefined, false, false, undefined>;
+export {};

package/dist/evaluation-contracts.js

@@ -0,0 +1,35 @@
+import { buildGetRoute, buildPayloadRoute } from '@lokalise/api-contracts';
+import { z } from 'zod';
+import { AUTH_HEADERS, WEBHOOK_SCHEMA } from "./common.js";
+import { EVALUATION_SCHEMA } from "./objects.js";
+const GET_EVALUATION_SCHEMA = z.object({
+    evaluationId: z.uuid().describe('The unique identifier of the evaluation to retrieve.'),
+});
+export const getEvaluation = buildGetRoute({
+    pathResolver: (params) => `/v1/evaluations/${params.evaluationId}`,
+    description: 'Retrieve evaluation by id',
+    requestPathParamsSchema: GET_EVALUATION_SCHEMA,
+    requestHeaderSchema: AUTH_HEADERS,
+    successResponseBodySchema: EVALUATION_SCHEMA,
+});
+export const postScheduleEvaluation = buildPayloadRoute({
+    method: 'post',
+    pathResolver: () => '/v1/evaluations',
+    description: 'Schedule evaluation',
+    requestHeaderSchema: AUTH_HEADERS,
+    requestBodySchema: z.object({
+        correlationId: z
+            .string()
+            .describe('A unique identifier to correlate this evaluation with external systems and enforce idempotency.'),
+        datasets: z
+            .record(z.string(), z.url())
+            .describe('List of the dataset file URLs to be evaluated, keyed by a unique id. Must be in a special format within a JSONL container file.'),
+        webhook: WEBHOOK_SCHEMA,
+    }),
+    successResponseBodySchema: z.object({
+        evaluationId: z
+            .uuid()
+            .describe('The unique identifier of the scheduled evaluation. Use it to retrieve the evaluation results later.'),
+    }),
+});
+//# sourceMappingURL=evaluation-contracts.js.map

package/dist/evaluation-contracts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"evaluation-contracts.js","sourceRoot":"","sources":["../src/evaluation-contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC1E,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAEhD,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IACrC,YAAY,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,sDAAsD,CAAC;CACxF,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,aAAa,GAAG,aAAa,CAAC;IACzC,YAAY,EAAE,CAAC,MAA2B,EAAE,EAAE,CAAC,mBAAmB,MAAM,CAAC,YAAY,EAAE;IACvF,WAAW,EAAE,2BAA2B;IACxC,uBAAuB,EAAE,qBAAqB;IAC9C,mBAAmB,EAAE,YAAY;IACjC,yBAAyB,EAAE,iBAAiB;CAC7C,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;IACtD,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,GAAG,EAAE,CAAC,iBAAiB;IACrC,WAAW,EAAE,qBAAqB;IAClC,mBAAmB,EAAE,YAAY;IACjC,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC1B,aAAa,EAAE,CAAC;aACb,MAAM,EAAE;aACR,QAAQ,CACP,iGAAiG,CAClG;QACH,QAAQ,EAAE,CAAC;aACR,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC;aAC3B,QAAQ,CACP,iIAAiI,CAClI;QACH,OAAO,EAAE,cAAc;KACxB,CAAC;IACF,yBAAyB,EAAE,CAAC,CAAC,MAAM,CAAC;QAClC,YAAY,EAAE,CAAC;aACZ,IAAI,EAAE;aACN,QAAQ,CACP,qGAAqG,CACtG;KACJ,CAAC;CACH,CAAC,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './evaluation-contracts.ts';
+export * from './objects.ts';

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from "./evaluation-contracts.js";
+export * from "./objects.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,2BAA2B,CAAA;AACzC,cAAc,cAAc,CAAA"}

package/dist/objects.d.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+export declare const EVALUATION_SCHEMA: z.ZodObject<{
+    id: z.ZodUUID;
+    ownerId: z.ZodString;
+}, z.core.$strip>;
+export type Evaluation = z.infer<typeof EVALUATION_SCHEMA>;

package/dist/objects.js

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+export const EVALUATION_SCHEMA = z.object({
+    id: z.uuid(),
+    ownerId: z.string(),
+});
+//# sourceMappingURL=objects.js.map

package/dist/objects.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"objects.js","sourceRoot":"","sources":["../src/objects.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE;IACZ,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAA"}

package/package.json

@@ -1,50 +1,50 @@
-{
-    "name": "@lokalise/ragnarok-api-contracts",
-    "version": "0.0.2",
-    "author": {
-        "name": "Lokalise",
-        "url": "https://lokalise.com"
-    },
-    "description": "Ragnarok API contracts",
-    "license": "Apache-2.0",
-    "repository": {
-        "type": "git",
-        "url": "git://github.com/lokalise/ragnarok.git",
-        "directory": "packages/ragnarok-api-contracts"
-    },
-    "engines": {
-        "node": ">=20"
-    },
-    "files": [
-        "dist"
-    ],
-    "type": "module",
-    "main": "dist/index.js",
-    "exports": {
-        ".": "./dist/index.js",
-        "./package.json": "./package.json"
-    },
-    "publishConfig": {
-        "access": "public"
-    },
-    "scripts": {
-        "build": "rimraf dist && tsc -p tsconfig.build.json",
-        "lint": "biome check . && tsc",
-        "lint:fix": "biome check --write",
-        "package-version": "echo $npm_package_version",
-        "postversion": "biome check --write package.json"
-    },
-    "devDependencies": {
-        "@biomejs/biome": "^2.3.8",
-        "@lokalise/biome-config": "^3.1.0",
-        "@lokalise/tsconfig": "^3.0.0",
-        "rimraf": "^6.0.1",
-        "typescript": "5.9.3"
-    },
-    "peerDependencies": {
-        "zod": "^4.0.0"
-    },
-    "dependencies": {
-        "@lokalise/api-contracts": "^6.1.0"
-    }
-}
+{
+    "name": "@lokalise/ragnarok-api-contracts",
+    "version": "0.1.0",
+    "author": {
+        "name": "Lokalise",
+        "url": "https://lokalise.com"
+    },
+    "description": "Ragnarok API contracts",
+    "license": "Apache-2.0",
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/lokalise/ragnarok.git",
+        "directory": "packages/ragnarok-api-contracts"
+    },
+    "engines": {
+        "node": ">=20"
+    },
+    "files": [
+        "dist"
+    ],
+    "type": "module",
+    "main": "dist/index.js",
+    "exports": {
+        ".": "./dist/index.js",
+        "./package.json": "./package.json"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "build": "rimraf dist && tsc -p tsconfig.build.json",
+        "lint": "biome check . && tsc",
+        "lint:fix": "biome check --write",
+        "package-version": "echo $npm_package_version",
+        "postversion": "biome check --write package.json"
+    },
+    "devDependencies": {
+        "@biomejs/biome": "^2.3.8",
+        "@lokalise/biome-config": "^3.1.0",
+        "@lokalise/tsconfig": "^3.0.0",
+        "rimraf": "^6.0.1",
+        "typescript": "5.9.3"
+    },
+    "peerDependencies": {
+        "zod": "^4.0.0"
+    },
+    "dependencies": {
+        "@lokalise/api-contracts": "^6.1.0"
+    }
+}