@insurance-broker/api-client 1.0.0

package/README.md

@@ -0,0 +1,46 @@
+# @insurance-broker/api-client
+
+TypeScript types for the Insurance Broker Platform API, generated from that platform's OpenAPI
+document. It is published for the platform's own web and mobile applications; it is not a
+general-purpose library, and it carries no runtime code beyond one constant.
+
+```bash
+pnpm add @insurance-broker/api-client openapi-fetch
+```
+
+```ts
+import createClient from 'openapi-fetch';
+import type { paths } from '@insurance-broker/api-client';
+
+const api = createClient<paths>({ baseUrl: process.env.API_BASE_URL });
+```
+
+`openapi-fetch` is a peer dependency: the transport is the consumer's choice of version, and this
+package only describes the shapes it carries.
+
+## What is in it
+
+- `paths`, `components`, `operations`, `webhooks` — the generated contract types.
+- `apiVersion` — the API version the package was generated from, for asserting against during a
+  compatibility window.
+
+Nothing here is written by hand except the entry point. The types come from the backend's committed
+`docs/api/openapi.json`, and the backend's own CI fails if the two drift apart.
+
+## Versioning
+
+Semantic versioning against the **contract**, not against this file:
+
+- **major** — a breaking contract change (a route or field removed, renamed, or narrowed).
+- **minor** — an additive contract change (a new route, an optional field).
+- **patch** — packaging only; the contract is unchanged.
+
+Pin with a caret. A breaking change gets a compatibility window, because older mobile builds stay
+installed on customers' phones after a backend release.
+
+## Licence and source
+
+Published publicly so that installing it needs no registry credentials. That is a distribution
+decision, not a licence grant: this package is `UNLICENSED` and its source repository is private.
+The API shape being readable is not a weakening of anything — backend validation and authorization
+are authoritative regardless of what a client believes.

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated TypeScript client for the Insurance Broker Platform API.
+ *
+ * The types in `schema.d.ts` are generated from `docs/api/openapi.json` and must not be edited
+ * by hand — run `scripts/update-api-contract` instead. This file is the stable public surface of
+ * the package and is hand-written, so regenerating the schema never rewrites the entry point.
+ *
+ * Consumers should not duplicate these request and response shapes (architecture doc section 9.4);
+ * the backend contract is the single source of truth, and backend validation and authorization
+ * remain authoritative regardless of what the client believes.
+ */
+export type { paths, components, operations, webhooks } from './schema.js';
+/**
+ * The API version this package was generated from. Consumers can assert against it when a
+ * compatibility window is in effect during a breaking change.
+ */
+export declare const apiVersion: "v1";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE3E;;;GAGG;AACH,eAAO,MAAM,UAAU,EAAG,IAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,17 @@
+/**
+ * Generated TypeScript client for the Insurance Broker Platform API.
+ *
+ * The types in `schema.d.ts` are generated from `docs/api/openapi.json` and must not be edited
+ * by hand — run `scripts/update-api-contract` instead. This file is the stable public surface of
+ * the package and is hand-written, so regenerating the schema never rewrites the entry point.
+ *
+ * Consumers should not duplicate these request and response shapes (architecture doc section 9.4);
+ * the backend contract is the single source of truth, and backend validation and authorization
+ * remain authoritative regardless of what the client believes.
+ */
+/**
+ * The API version this package was generated from. Consumers can assert against it when a
+ * compatibility window is in effect during a breaking change.
+ */
+export const apiVersion = 'v1';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH;;;GAGG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,IAAa,CAAC"}