@zinn-digital/sdk 0.0.0-stage → 0.1.1308

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+/**
+ * @zinn/sdk-ts — the typed client for the Zinn Digital Platform API.
+ *
+ * `src/generated/schema.d.ts` is produced from `openapi/openapi.yaml` by
+ * openapi-typescript and is NEVER hand-edited (the spec is the single source of
+ * truth — CLAUDE.md §2.5). This file is the small, stable hand-written surface:
+ * a typed `openapi-fetch` client factory plus ergonomic type aliases.
+ *
+ * The client is intentionally un-configured here. @zinn/app-kit builds on it,
+ * attaching middleware for `Authorization: Bearer`, `Idempotency-Key`, the
+ * active-org header, `Accept-Language`, and error-envelope → typed `ApiError`
+ * normalisation (docs/32 §1.3). Anonymous callers (the public site) use it as-is.
+ */
+import { type Client, type ClientOptions, type Middleware } from "openapi-fetch";
+import type { components, operations, paths } from "./generated/schema";
+export type { components, operations, paths };
+/** Fully-typed client bound to the API's path map. */
+export type ZinnApiClient = Client<paths>;
+/**
+ * Create a typed API client. Pass `{ baseUrl }` (e.g. the dev/prod API origin).
+ * Attach cross-cutting behaviour with `client.use(middleware)` — see @zinn/app-kit.
+ */
+export declare function createApiClient(options?: ClientOptions): ZinnApiClient;
+export type { Client, ClientOptions, Middleware };
+type Schemas = components["schemas"];
+export type Health = Schemas["Health"];
+export type Principal = Schemas["Principal"];
+export type User = Schemas["User"];
+export type Membership = Schemas["Membership"];
+export type Organization = Schemas["Organization"];
+export type OrganizationCreate = Schemas["OrganizationCreate"];
+export type OrganizationPage = Schemas["OrganizationPage"];
+export type OrgType = Schemas["OrgType"];
+export type PageMeta = Schemas["PageMeta"];
+export type CurrencyCode = Schemas["CurrencyCode"];
+export type LocaleCode = Schemas["LocaleCode"];
+export type Uuid = Schemas["Uuid"];
+/** The standard error envelope every non-2xx response carries (docs/09 §2). */
+export type ApiErrorEnvelope = Schemas["Error"];
+export type ApiErrorDetail = Schemas["ErrorDetail"];
+/** `CLAUDE.md` §57 — the classified AI/vendor failure an error envelope may carry. */
+export type VendorFailure = Schemas["VendorFailure"];
+/**
+ * `CLAUDE.md` §2.19 — a refusal's message KEY and its parameters, so a console renders the
+ * sentence in the reader's own language instead of the English the engine composed (W43-138).
+ *
+ * ⛔ Not a replacement for `error.message`: the SDK, the CLI and a direct caller have no
+ * catalogue and go on reading the English. This is the half a console with 58 catalogues uses.
+ */
+export type Refusal = Schemas["Refusal"];
+/**
+ * Q225 — the order a one-click purchase was PLACED as, waiting for the customer to pay it
+ * on-session. Carried by a `PAYMENT_METHOD_REQUIRED` envelope as `error.payment`.
+ */
+export type PaymentStep = Schemas["PaymentStep"];

package/dist/index.js

@@ -0,0 +1,21 @@
+/**
+ * @zinn/sdk-ts — the typed client for the Zinn Digital Platform API.
+ *
+ * `src/generated/schema.d.ts` is produced from `openapi/openapi.yaml` by
+ * openapi-typescript and is NEVER hand-edited (the spec is the single source of
+ * truth — CLAUDE.md §2.5). This file is the small, stable hand-written surface:
+ * a typed `openapi-fetch` client factory plus ergonomic type aliases.
+ *
+ * The client is intentionally un-configured here. @zinn/app-kit builds on it,
+ * attaching middleware for `Authorization: Bearer`, `Idempotency-Key`, the
+ * active-org header, `Accept-Language`, and error-envelope → typed `ApiError`
+ * normalisation (docs/32 §1.3). Anonymous callers (the public site) use it as-is.
+ */
+import createClient, {} from "openapi-fetch";
+/**
+ * Create a typed API client. Pass `{ baseUrl }` (e.g. the dev/prod API origin).
+ * Attach cross-cutting behaviour with `client.use(middleware)` — see @zinn/app-kit.
+ */
+export function createApiClient(options) {
+    return createClient(options);
+}

package/package.json

@@ -1,6 +1,44 @@
 {
   "name": "@zinn-digital/sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1308",
+  "description": "Typed TypeScript client for the Zinn Digital Platform API, generated from its OpenAPI spec.",
+  "license": "MIT",
+  "author": "Neil Lock \u2014 CEO, Zinn Digital\u00ae Ltd <office@zinndigital.com>",
+  "homepage": "https://zinndigital.com/developers",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Zinn-Digital/platform.git",
+    "directory": "sdks"
+  },
+  "keywords": [
+    "zinn",
+    "hosting",
+    "api",
+    "sdk",
+    "openapi"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./schema": {
+      "types": "./dist/generated/schema.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=20"
+  },
+  "dependencies": {
+    "openapi-fetch": "^0.17.0"
+  }
+}