@lokalise/ragnarok-api-contracts 0.0.3 → 0.1.0

package/dist/evaluation-contracts.d.ts

@@ -1,5 +1,19 @@
 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>>;
@@ -9,3 +23,4 @@ export declare const postScheduleEvaluation: import("@lokalise/api-contracts").P
 }, z.core.$strip>, undefined, undefined, z.ZodObject<{
     authorization: z.ZodString;
 }, z.core.$strip>, undefined, false, false, undefined>;
+export {};

package/dist/evaluation-contracts.js

@@ -1,16 +1,35 @@
-import { buildPayloadRoute } from '@lokalise/api-contracts';
+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: () => '/evaluation/schedule',
+    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(),
+        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

@@ -1 +1 @@
-{"version":3,"file":"evaluation-contracts.js","sourceRoot":"","sources":["../src/evaluation-contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAC3D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AACvB,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAE1D,MAAM,CAAC,MAAM,sBAAsB,GAAG,iBAAiB,CAAC;IACtD,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,GAAG,EAAE,CAAC,sBAAsB;IAC1C,WAAW,EAAE,qBAAqB;IAClC,mBAAmB,EAAE,YAAY;IACjC,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC1B,OAAO,EAAE,cAAc;KACxB,CAAC;IACF,yBAAyB,EAAE,CAAC,CAAC,MAAM,CAAC;QAClC,YAAY,EAAE,CAAC,CAAC,IAAI,EAAE;KACvB,CAAC;CACH,CAAC,CAAA"}
+{"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

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

package/dist/index.js

@@ -1,2 +1,3 @@
-export { postScheduleEvaluation } from "./evaluation-contracts.js";
+export * from "./evaluation-contracts.js";
+export * from "./objects.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAA"}
+{"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,6 +1,6 @@
 {
     "name": "@lokalise/ragnarok-api-contracts",
-    "version": "0.0.3",
+    "version": "0.1.0",
     "author": {
         "name": "Lokalise",
         "url": "https://lokalise.com"