log-client: update to new log-api

Author: QuentinRoy

packages/log-client/__mocks__/mock-server.ts

@@ -1,5 +1,4 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import { type paths } from '@lightmill/log-api';
 import {
   http,
   HttpResponse,
@@ -10,6 +9,7 @@ import {
 import { setupServer, SetupServerApi } from 'msw/node';
 import type { IsNever, RequiredKeysOf } from 'type-fest';
 import { test, vi, type Mock } from 'vitest';
+import { type paths } from '../src/generated/openapi.js';
 import { apiMediaType } from '../src/utils.js';
 
 export type ApiMediaType = typeof apiMediaType;
@@ -32,14 +32,18 @@ type PathMethod<Path extends keyof paths> = Extract<
 type ApiRequestBody<
   Path extends keyof paths,
   Method extends PathMethod<Path>,
-> = paths extends {
-  [P in Path]: {
-    [M in Method]: {
-      requestBody: { content: { [K in ApiMediaType]: infer R } };
-    };
-  };
-}
-  ? R
+> = paths extends { [P in Path]: { [M in Method]: infer Route } }
+  ? Route extends {
+      requestBody: { content: { [K in ApiMediaType]: infer Content } };
+    }
+    ? Content
+    : Route extends { requestBody?: never }
+      ? undefined
+      : Route extends {
+            requestBody?: { content: { [K in ApiMediaType]: infer Content } };
+          }
+        ? Content | undefined
+        : never
   : never;
 
 type ApiRequestPathParams<

packages/log-client/package.json

@@ -25,6 +25,7 @@
     "cross-env": "^7.0.3",
     "msw": "^2.7.3",
     "onchange": "^7.1.0",
+    "openapi-typescript": "^7.8.0",
     "type-fest": "^4.39.1",
     "typescript": "catalog:",
     "vitest": "catalog:"
@@ -34,7 +35,9 @@
   },
   "scripts": {
     "test": "cross-env NODE_ENV=test vitest",
-    "build": "tsc -b tsconfig.build.json",
+    "generate-openapi-types": "openapi-typescript node_modules/@lightmill/log-api/dist/openapi.yaml --output src/generated/openapi.ts",
+    "build-ts": "tsc -b tsconfig.build.json",
+    "build": "pnpm run generate-openapi-types && pnpm run build-ts",
     "prepublish": "pnpm run build"
   },
   "keywords": [

packages/log-client/src/client.ts

@@ -1,5 +1,5 @@
-import type { components, paths } from '@lightmill/log-api';
 import createClient from 'openapi-fetch';
+import type { components, paths } from './generated/openapi.js';
 import { anyLogSerializer } from './log-serializer.js';
 import { LightmillLogger } from './logger.js';
 import type {
@@ -207,13 +207,12 @@ export class LightmillClient<ClientLog extends LogBase = AnyLog> {
     let response = await this.#fetchClient.GET('/experiments', {
       params: { query: { 'filter[name]': experimentName } },
     });
-    if (response.data != null) return response.data.data[0];
-    if (response.response.status === 404) return null;
-    let error = response.error.errors[0];
-    throw new Error(
-      error.detail ??
-        `Could not fetch experiment: server returned ${error.code}`,
-    );
+    // Checking the length isn't strictly necessary, but it makes the
+    // intention clearer, and let typescript know that it may return null.
+    if (response.data != null) {
+      return response.data.data.length > 0 ? response.data.data[0] : null;
+    }
+    throw new RequestError(response);
   }
 
   async #getRunFromName(
@@ -231,12 +230,12 @@ export class LightmillClient<ClientLog extends LogBase = AnyLog> {
         },
       },
     });
-    if (response.data != null) return response.data.data[0];
-    if (response.response.status === 404) return null;
-    let error = response.error.errors[0];
-    throw new Error(
-      error.detail ?? `Could not fetch run: server returned ${error.code}`,
-    );
+    // Checking the length isn't strictly necessary, but it makes the
+    // intention clearer, and let typescript know that it may return null.
+    if (response.data != null) {
+      return response.data.data.length > 0 ? response.data.data[0] : null;
+    }
+    throw new RequestError(response);
   }
 
   async #getRunIdFromName(
@@ -355,5 +354,5 @@ export class LightmillClient<ClientLog extends LogBase = AnyLog> {
   }
 }
 
-type ExperimentResource = components['schemas']['Experiment.Resource'];
-type LogResource = components['schemas']['Log.Resource'];
+type ExperimentResource = components['schemas']['ExperimentResource'];
+type LogResource = components['schemas']['LogResource'];

packages/log-client/src/logger.ts

@@ -1,6 +1,6 @@
-import type { paths } from '@lightmill/log-api';
 import type { Client as FetchClient } from 'openapi-fetch';
 import type { JsonValue } from 'type-fest';
+import type { paths } from './generated/openapi.js';
 import { Subject } from './subject.ts';
 import type { LogValuesSerializer, RunStatus } from './types.js';
 import { apiMediaType, RequestError } from './utils.js';