@clinia/context-engine-js 0.6.0-rc.1 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @clinia/context-engine-js
 
+## 0.6.0
+
+### Minor Changes
+
+- b704c4a: Expose each area of the API as a resource property on `ContextEngineClient` — `client.patients`, `client.ingest`, `client.graph`, `client.sessions`, `client.vfs`, `client.info` — alongside the existing low-level `http` client. The resource classes are exported too, for constructing one on its own.
+
+  Add `ingest.ingestCdaR2Multipart()`, which submits several CDA documents in one request as `multipart/form-data`. `ingest.ingestCdaR2()` continues to submit a single document as `application/cda+xml`. A route offering more than one request media type now gets one method per media type rather than only its first.
+
+## 0.6.0-rc.2
+
+### Minor Changes
+
+- b704c4a: Expose each area of the API as a resource property on `ContextEngineClient` — `client.patients`, `client.ingest`, `client.graph`, `client.sessions`, `client.vfs`, `client.info` — alongside the existing low-level `http` client. The resource classes are exported too, for constructing one on its own.
+
+  Add `ingest.ingestCdaR2Multipart()`, which submits several CDA documents in one request as `multipart/form-data`. `ingest.ingestCdaR2()` continues to submit a single document as `application/cda+xml`. A route offering more than one request media type now gets one method per media type rather than only its first.
+
 ## 0.6.0-rc.1
 
 ## 0.6.0-rc.0

package/README.md

@@ -27,14 +27,16 @@ npm install @clinia/context-engine-js@rc
 
 ## Exports
 
-| Export                                     | Description                                                                 |
-| ------------------------------------------ | --------------------------------------------------------------------------- |
-| `ContextEngineClient`                      | Entry point. Holds a low-level `http` client.                               |
-| `HttpClient`                               | Typed `openapi-fetch` wrapper (`GET`/`POST`/`PUT`/`PATCH`/`DELETE`, `use`). |
-| `ContextEngineClientOptions`               | Constructor options (alias of `HttpClientOptions`).                         |
-| `createClientCredentialsTokenProvider`     | Builds a caching OAuth2 client-credentials token provider.                  |
-| `TokenProvider`, `ClientCredentialsConfig` | Auth types.                                                                 |
-| `paths`, generated request/response types  | Emitted from the OpenAPI spec.                                              |
+| Export                                     | Description                                                                                                                                                  |
+| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `ContextEngineClient`                      | Entry point. One resource property per API area, plus a low-level `http` client.                                                                             |
+| Resource classes                           | `InfoResource`, `PatientsResource`, `IngestResource`, `SessionsResource`, `VFSResource`, `GraphResource` — to construct one on its own over an `HttpClient`. |
+| `Resources`, `createResources`             | The resource set as an interface, and a builder for one of each over a shared `HttpClient`.                                                                  |
+| `HttpClient`                               | Typed `openapi-fetch` wrapper (`GET`/`POST`/`PUT`/`PATCH`/`DELETE`, `use`).                                                                                  |
+| `ContextEngineClientOptions`               | Constructor options (alias of `HttpClientOptions`).                                                                                                          |
+| `createClientCredentialsTokenProvider`     | Builds a caching OAuth2 client-credentials token provider.                                                                                                   |
+| `TokenProvider`, `ClientCredentialsConfig` | Auth types.                                                                                                                                                  |
+| `paths`, generated request/response types  | Emitted from the OpenAPI spec.                                                                                                                               |
 
 ## Usage
 
@@ -54,7 +56,7 @@ const client = new ContextEngineClient({
   },
 });
 
-const { data, error } = await client.http.GET("/v1/patients");
+const { data, error } = await client.patients.listPatients();
 ```
 
 That is the whole configuration. The client resolves Clinia's authorization
@@ -62,8 +64,24 @@ server, acquires a bearer token, caches it, refreshes it before expiry, and
 attaches `Authorization: Bearer <token>` to every request. Tokens last an hour;
 you do not manage them.
 
-The `http` client exposes the typed verbs directly, and the path, path params,
-query, and body are all checked against the OpenAPI contract:
+### Resources
+
+Each area of the API is a property on the client, with one method per operation:
+
+```ts
+await client.patients.getPatient("abc");
+await client.graph.listNodes("abc", "fact", { query: { perPage: 50 } });
+await client.ingest.ingestCdaR2("abc", cdaXml);
+await client.ingest.ingestCdaR2Multipart("abc", { documents: [firstCda, secondCda] });
+```
+
+Responses are `{ data, error }` — nothing throws on a non-2xx.
+
+### The `http` client
+
+`client.http` covers anything the resource methods do not. It exposes the typed
+verbs directly, with the path, path params, query, and body all checked against
+the OpenAPI contract:
 
 ```ts
 await client.http.GET("/v1/patients/{patientId}/read", {
@@ -71,8 +89,6 @@ await client.http.GET("/v1/patients/{patientId}/read", {
 });
 ```
 
-Responses are `{ data, error }` — nothing throws on a non-2xx.
-
 ### Without authentication
 
 Omit `auth` entirely and the client sends no `Authorization` header. Useful

package/dist/context-engine-client.d.ts

@@ -1,14 +1,26 @@
 import { HttpClient, type HttpClientOptions } from "./http-client";
+import { GraphResource, InfoResource, IngestResource, PatientsResource, SessionsResource, VFSResource, type Resources } from "./resources";
 export type ContextEngineClientOptions = HttpClientOptions;
 /**
  * Client for the Clinia Context Engine API.
  *
- * For now this client only exposes a low-level `http` client for making requests to the API. Higher-level resource methods can be added as the API surface stabilizes.
+ * Each area of the API is a resource property — `client.patients`, `client.ingest`,
+ * `client.graph` — and `http` stays available underneath for anything a resource method does
+ * not cover. Every resource shares that one http client, so authentication is configured once.
+ *
+ * `implements Resources` is what keeps this list honest: the resources are generated from the
+ * API spec, and a new one is a compile error here until it is named.
  */
-export declare class ContextEngineClient {
+export declare class ContextEngineClient implements Resources {
     /**
      * Low-level http client. Use when a resource method does not cover your use case.
      */
     readonly http: HttpClient;
+    readonly info: InfoResource;
+    readonly patients: PatientsResource;
+    readonly ingest: IngestResource;
+    readonly sessions: SessionsResource;
+    readonly vfs: VFSResource;
+    readonly graph: GraphResource;
     constructor(options: ContextEngineClientOptions);
 }

package/dist/form-data.d.ts

@@ -0,0 +1,14 @@
+/**
+ * A `multipart/form-data` request body, built from the object form of the schema.
+ *
+ * An array-valued field becomes one part per item under the same field name — how a schema
+ * declaring an array of items is sent — and every other field becomes a single part. A field
+ * left `undefined` or `null` is omitted rather than sent as the string `"undefined"` or `"null"`.
+ *
+ * Values are appended as given, so a string is sent as text and a `Blob` or `File` keeps the
+ * filename and content type it was created with.
+ *
+ * No `Content-Type` is set anywhere: the header carries the multipart boundary, which only
+ * the runtime sending the request can know.
+ */
+export declare function toFormData(body: unknown): FormData;