@liaisongroup/assist-api-js-client 1.5.39

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Liaison Group
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,51 @@
+<img src="./hero.svg" alt="Hero" />
+
+<p align="center">
+  🏌️‍♂️ Liaison Assist API JS Client
+  <br />
+  Generated using <a href="https://github.com/openapistack/openapi-client-axios">openapi-client-axios</a> from the OpenAPI v3 definition
+</p>
+
+# Installation
+
+Using your node runtime of choice install the package.
+
+bun add @liaisongroup/assist-api-js-client -D
+
+# Usage
+
+Create a file such as `client.ts` to store an instance of our JS Client.
+
+```ts
+import { init } from "@liaisongroup/assist-api-js-client"
+
+export const client = init("https://assist-dev-api.liaison.link")
+// ^ returns a full typed client, with autocomplete for all methods, parameters etc.
+```
+
+Then when needed, just import this `client` in project files as needed.
+
+`init` takes the API base URL as an optional argument, otherwise it will default to the value defined in the OpenAPI definition.
+
+```ts
+import { client } from "some/path/to/client"
+
+async function make_api_call() {
+  const sso_configs = await client.get_sso_configs()
+}
+```
+
+# Working with a local OpenAPI definition
+
+If you want to work with a local OpenAPI definition (ie. you have the `infinity-api` repo setup), then you can:
+
+1. Clone this repo and install its dependencies
+2. Setup an `.env.local` file, with the absolute path to the OpenAPI file (ie. `OPENAPI_URL="/path/to/infinity-api/openapi.yaml"`)
+3. Run `bun dev` to start the development server. This will watch for changes to the OpenAPI file and regenerate the client as needed.
+4. From the front-end repo, reference this local repo instead of installing from remote. For example:
+
+```json
+{
+  "@liaisongroup/assist-api-js-client": "../assist-api-js-client"
+}
+```

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import type { Client } from "./openapi.d.ts";
+export type { Components, Paths, PathsDictionary, OperationMethods, Client } from "./openapi.d.ts";
+export declare function init(base_url?: string): Client;

package/dist/index.js

@@ -0,0 +1,9 @@
+import { OpenAPIClientAxios } from "openapi-client-axios";
+import definition from "./openapi.json" assert { type: "json" };
+export function init(base_url) {
+    const client = new OpenAPIClientAxios({
+        definition: definition,
+        axiosConfigDefaults: { withCredentials: true, baseURL: base_url },
+    }).initSync();
+    return client;
+}