@onplo/sdk 0.0.0-stage → 0.0.1

package/generated/storage.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,27 @@
 {
   "name": "@onplo/sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.1",
+  "description": "The Onplo SDK: a typed client for Onplo's public API, generated from its OpenAPI contracts.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    }
+  },
+  "files": [
+    "src",
+    "generated",
+    "LICENSE",
+    "README.md"
+  ],
+  "dependencies": {
+    "openapi-fetch": "0.17.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * THE ONPLO SDK — what an outside developer installs, and what our own frontend calls the public API
+ * through (decision 1024).
+ *
+ *     import { onplo } from '@onplo/sdk';
+ *
+ *     const account = onplo('account', { token });
+ *     const { data, error } = await account.GET('/me');
+ *
+ * The types come from `../generated/`, which `generate.mjs` writes from the outsiders' documents in
+ * `api-contracts/` and which is never committed. Nothing here describes an endpoint, a field or an
+ * address. `error` is not an exception: every failure is an RFC 9457 problem document with a stable
+ * `code` to branch on and a `request_id` to quote (decision 0547).
+ */
+import { type Client } from 'openapi-fetch';
+import { type ContractPaths } from '../generated/index.js';
+/** An outsiders' contract, by its domain's name (`account`, `storage`). Generated from `api-contracts/`. */
+export type Contract = keyof ContractPaths;
+export interface OnploOptions {
+    /** A scoped key, a grant or a federated identity (decision 0508). It never carries more than whoever minted it. */
+    token: string;
+    /** Another origin alone, for a preview environment or a laptop (`http://localhost:3000`). The path stays the contract's. */
+    origin?: string;
+    /** Passed to `fetch`; use it for a timeout signal or a custom agent. */
+    fetch?: typeof globalThis.fetch;
+}
+/** The address one contract is called at: its own `servers`, or the same path at another origin. */
+export declare function addressOf(contract: Contract, origin?: string): string;
+/** A typed client for one outsiders' contract. */
+export declare function onplo<C extends Contract>(contract: C, { token, origin, fetch }: OnploOptions): Client<ContractPaths[C]>;
+export * from '../generated/index.js';

package/src/index.js

@@ -0,0 +1,36 @@
+/**
+ * THE ONPLO SDK — what an outside developer installs, and what our own frontend calls the public API
+ * through (decision 1024).
+ *
+ *     import { onplo } from '@onplo/sdk';
+ *
+ *     const account = onplo('account', { token });
+ *     const { data, error } = await account.GET('/me');
+ *
+ * The types come from `../generated/`, which `generate.mjs` writes from the outsiders' documents in
+ * `api-contracts/` and which is never committed. Nothing here describes an endpoint, a field or an
+ * address. `error` is not an exception: every failure is an RFC 9457 problem document with a stable
+ * `code` to branch on and a `request_id` to quote (decision 0547).
+ */
+import createClient from 'openapi-fetch';
+import { SERVERS } from '../generated/index.js';
+/** The address one contract is called at: its own `servers`, or the same path at another origin. */
+export function addressOf(contract, origin) {
+    const server = SERVERS[contract];
+    if (origin === undefined)
+        return server;
+    const at = new URL(origin);
+    if (at.pathname !== '/' || at.search || at.hash) {
+        throw new Error(`@onplo/sdk: ${JSON.stringify(origin)} is not an origin alone — the path is the contract's (${new URL(server).pathname})`);
+    }
+    return `${at.origin}${new URL(server).pathname}`;
+}
+/** A typed client for one outsiders' contract. */
+export function onplo(contract, { token, origin, fetch }) {
+    return createClient({
+        baseUrl: addressOf(contract, origin),
+        fetch,
+        headers: { Authorization: `Bearer ${token}` },
+    });
+}
+export * from '../generated/index.js';