@confighub/api 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) ConfigHub, Inc.
+
+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,43 @@
+# @confighub/api
+
+A typed, framework-agnostic client for the [ConfigHub](https://confighub.com) API,
+generated from the ConfigHub OpenAPI spec. Built on
+[openapi-fetch](https://openapi-ts.dev/openapi-fetch/) — a few KB, no Redux, no
+React, no required provider. Every path, parameter, and response is typed against a
+pinned server version.
+
+```ts
+import { createConfigHubClient } from '@confighub/api';
+
+const api = createConfigHubClient({
+  baseUrl: 'https://hub.confighub.com',
+  getToken: () => session.accessToken, // optional; sets Authorization: Bearer
+});
+
+const me = await api.GET('/me');
+const { data, error } = await api.GET('/space/{space_id}/unit', {
+  params: { path: { space_id } },
+});
+```
+
+## Options
+
+- `baseUrl` — absolute base URL of the ConfigHub instance.
+- `getToken?` — returns the current bearer token (may be async). Wired as a
+  per-request middleware. The client never stores or refreshes tokens; pair it with
+  [`@confighub/react-auth`](https://www.npmjs.com/package/@confighub/react-auth) or
+  supply your own token source.
+- `onUnauthorized?` — called on a 401 so the caller can refresh or re-login. The
+  request is not retried automatically.
+- `fetch?` — override the fetch implementation.
+
+## Types
+
+The full generated surface is exported for reuse:
+
+```ts
+import type { paths, components } from '@confighub/api';
+type Unit = components['schemas']['Unit'];
+```
+
+Types track the ConfigHub server version pinned in the SDK repo's `.spec-version`.

package/dist/index.cjs

@@ -0,0 +1,45 @@
+'use strict';
+
+var createClient = require('openapi-fetch');
+
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var createClient__default = /*#__PURE__*/_interopDefault(createClient);
+
+// src/client.ts
+var trimTrailingSlash = (s) => s.replace(/\/+$/, "");
+var apiBaseUrl = (baseUrl) => {
+  const trimmed = trimTrailingSlash(baseUrl);
+  return trimmed.endsWith("/api") ? trimmed : trimmed + "/api";
+};
+function createConfigHubClient(options) {
+  const { baseUrl, getToken, onUnauthorized, fetch: fetchImpl } = options;
+  const client = createClient__default.default({
+    baseUrl: apiBaseUrl(baseUrl),
+    fetch: fetchImpl
+  });
+  const middleware = {
+    async onRequest({ request }) {
+      if (getToken) {
+        const token = await getToken();
+        if (token) request.headers.set("Authorization", `Bearer ${token}`);
+      }
+      if (request.method === "PATCH" && request.body != null) {
+        request.headers.set("Content-Type", "application/merge-patch+json");
+      }
+      return request;
+    },
+    async onResponse({ response }) {
+      if (response.status === 401 && onUnauthorized) {
+        await onUnauthorized();
+      }
+      return response;
+    }
+  };
+  client.use(middleware);
+  return client;
+}
+
+exports.createConfigHubClient = createConfigHubClient;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/client.ts"],"names":["createClient"],"mappings":";;;;;;;;;AAqCA,IAAM,oBAAoB,CAAC,CAAA,KAAsB,CAAA,CAAE,OAAA,CAAQ,QAAQ,EAAE,CAAA;AAIrE,IAAM,UAAA,GAAa,CAAC,OAAA,KAA4B;AAC9C,EAAA,MAAM,OAAA,GAAU,kBAAkB,OAAO,CAAA;AACzC,EAAA,OAAO,OAAA,CAAQ,QAAA,CAAS,MAAM,CAAA,GAAI,UAAU,OAAA,GAAU,MAAA;AACxD,CAAA;AAaO,SAAS,sBAAsB,OAAA,EAAkD;AACtF,EAAA,MAAM,EAAE,OAAA,EAAS,QAAA,EAAU,cAAA,EAAgB,KAAA,EAAO,WAAU,GAAI,OAAA;AAEhE,EAAA,MAAM,SAASA,6BAAA,CAAoB;AAAA,IACjC,OAAA,EAAS,WAAW,OAAO,CAAA;AAAA,IAC3B,KAAA,EAAO;AAAA,GACR,CAAA;AAED,EAAA,MAAM,UAAA,GAAyB;AAAA,IAC7B,MAAM,SAAA,CAAU,EAAE,OAAA,EAAQ,EAAG;AAC3B,MAAA,IAAI,QAAA,EAAU;AACZ,QAAA,MAAM,KAAA,GAAQ,MAAM,QAAA,EAAS;AAC7B,QAAA,IAAI,OAAO,OAAA,CAAQ,OAAA,CAAQ,IAAI,eAAA,EAAiB,CAAA,OAAA,EAAU,KAAK,CAAA,CAAE,CAAA;AAAA,MACnE;AAIA,MAAA,IAAI,OAAA,CAAQ,MAAA,KAAW,OAAA,IAAW,OAAA,CAAQ,QAAQ,IAAA,EAAM;AACtD,QAAA,OAAA,CAAQ,OAAA,CAAQ,GAAA,CAAI,cAAA,EAAgB,8BAA8B,CAAA;AAAA,MACpE;AACA,MAAA,OAAO,OAAA;AAAA,IACT,CAAA;AAAA,IACA,MAAM,UAAA,CAAW,EAAE,QAAA,EAAS,EAAG;AAC7B,MAAA,IAAI,QAAA,CAAS,MAAA,KAAW,GAAA,IAAO,cAAA,EAAgB;AAC7C,QAAA,MAAM,cAAA,EAAe;AAAA,MACvB;AACA,MAAA,OAAO,QAAA;AAAA,IACT;AAAA,GACF;AAEA,EAAA,MAAA,CAAO,IAAI,UAAU,CAAA;AACrB,EAAA,OAAO,MAAA;AACT","file":"index.cjs","sourcesContent":["// Copyright (C) ConfigHub, Inc.\n// SPDX-License-Identifier: MIT\n\nimport createClient, { type Client, type Middleware } from 'openapi-fetch';\nimport type { paths } from './schema';\n\nexport interface ConfigHubClientOptions {\n  /**\n   * Base URL of the ConfigHub instance, e.g. `https://hub.confighub.com` — the same\n   * value passed to the auth provider. The ConfigHub API is mounted under `/api`\n   * (the spec's paths are relative to it), so the client targets `{baseUrl}/api`.\n   * Passing a URL that already ends in `/api` is accepted as-is.\n   */\n  baseUrl: string;\n\n  /**\n   * Returns the current bearer token, or undefined when unauthenticated. May be\n   * async so the caller can await a refresh. Wired as an openapi-fetch middleware\n   * that sets `Authorization: Bearer <token>` per request. The client never stores\n   * or refreshes tokens itself — that is the auth layer's job (see\n   * `@confighub/react-auth`).\n   */\n  getToken?: () => string | undefined | Promise<string | undefined>;\n\n  /**\n   * Called when a request returns 401. A library must not redirect on its own, so\n   * this hands control back to the caller — typically to trigger a token refresh\n   * or re-login. The originating request is not retried automatically.\n   */\n  onUnauthorized?: () => void | Promise<void>;\n\n  /** Override the fetch implementation (tests, non-browser runtimes). */\n  fetch?: typeof globalThis.fetch;\n}\n\nexport type ConfigHubClient = Client<paths>;\n\nconst trimTrailingSlash = (s: string): string => s.replace(/\\/+$/, '');\n\n// The ConfigHub API lives under /api and the OpenAPI paths are relative to it. Accept\n// either the instance origin or a URL that already includes /api.\nconst apiBaseUrl = (baseUrl: string): string => {\n  const trimmed = trimTrailingSlash(baseUrl);\n  return trimmed.endsWith('/api') ? trimmed : trimmed + '/api';\n};\n\n/**\n * Create a typed ConfigHub API client. Every path, param, and response is derived\n * from the pinned OpenAPI spec (`src/schema.d.ts`), so it stays in lockstep with\n * the server.\n *\n * ```ts\n * const api = createConfigHubClient({ baseUrl, getToken: () => session.accessToken });\n * const { data, error } = await api.GET('/me');\n * const units = await api.GET('/space/{space_id}/unit', { params: { path: { space_id } } });\n * ```\n */\nexport function createConfigHubClient(options: ConfigHubClientOptions): ConfigHubClient {\n  const { baseUrl, getToken, onUnauthorized, fetch: fetchImpl } = options;\n\n  const client = createClient<paths>({\n    baseUrl: apiBaseUrl(baseUrl),\n    fetch: fetchImpl,\n  });\n\n  const middleware: Middleware = {\n    async onRequest({ request }) {\n      if (getToken) {\n        const token = await getToken();\n        if (token) request.headers.set('Authorization', `Bearer ${token}`);\n      }\n      // ConfigHub's PATCH endpoints expect RFC 7386 merge-patch semantics. This\n      // mirrors the first-party UI, which sets the same content type for its\n      // patch/bulk-patch operations.\n      if (request.method === 'PATCH' && request.body != null) {\n        request.headers.set('Content-Type', 'application/merge-patch+json');\n      }\n      return request;\n    },\n    async onResponse({ response }) {\n      if (response.status === 401 && onUnauthorized) {\n        await onUnauthorized();\n      }\n      return response;\n    },\n  };\n\n  client.use(middleware);\n  return client;\n}\n"]}