inklok-sdk-node 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ryan Erickson
+
+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,44 @@
+# inklok-sdk-node
+
+Node.js SDK for Inklok/OpaqueInk public API. Thin wrapper around the public endpoints; no business logic. Used as a middle-man by opaqueink Next.js instead of calling the API directly.
+
+## Setup
+
+1. Copy `.npmrc.example` to `.npmrc` and configure GitHub Packages auth (for `@ryan-m-erickson/api-spec`):
+
+   ```
+   @ryan-m-erickson:registry=https://npm.pkg.github.com
+   //npm.pkg.github.com/:_authToken=YOUR_TOKEN
+   ```
+
+2. Install and build:
+
+   ```bash
+   npm install
+   npm run build
+   ```
+
+3. Codegen: Types are generated from the OpenAPI spec (`@ryan-m-erickson/api-spec`). Run `npm run codegen` to regenerate `src/types.d.ts` after updating the spec dependency.
+
+## Usage
+
+```ts
+import { InklokClient } from "inklok-sdk-node";
+
+const client = new InklokClient({
+  baseUrl: "https://xxx.execute-api.us-east-2.amazonaws.com/prod",
+});
+
+const metadata = await client.listOrkMetadataV1({
+  orgId: "org-123",
+  accessToken: "jwt-token",
+});
+```
+
+## Contract
+
+Request/response shapes are defined by the OpenAPI spec (`@ryan-m-erickson/api-spec`). The SDK uses codegen (`openapi-typescript`) to derive types—no custom type definitions. See `src/types.d.ts` (generated).
+
+## CI/CD
+
+On merge to `main`, GitHub Actions publishes to npm. Add an **NPM_TOKEN** secret (classic token with "Automation" type from [npmjs.com/settings](https://www.npmjs.com/settings)) to the repo. If `@ryan-m-erickson/api-spec` is private, also add a **GH_PACKAGES_TOKEN** (PAT with `read:packages`) and update the workflow to use it for GitHub Packages auth.

package/dist/client.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Inklok SDK client - thin wrapper over the public API.
+ * No business logic; fetch and return only.
+ */
+import type { components, operations } from "./types";
+export type OrkMetadata = components["schemas"]["OrkMetadata"];
+/** Request shape for listOrkMetadataV1 (from OpenAPI). */
+export interface ListOrkMetadataV1Params {
+    orgId: string;
+    accessToken: string;
+}
+/** Response shape for listOrkMetadataV1 (from OpenAPI). */
+export type ListOrkMetadataV1Response = operations["listOrkMetadataV1"]["responses"]["200"]["content"]["application/json"];
+export interface InklokClientOptions {
+    /** Base URL of the API (e.g. https://xxx.execute-api.us-east-2.amazonaws.com/prod). */
+    baseUrl: string;
+}
+/**
+ * Thin client for Inklok public API. Fetches and returns; no business logic.
+ */
+export declare class InklokClient {
+    private readonly baseUrl;
+    constructor(options: InklokClientOptions);
+    /**
+     * GET /v1/ork/metadata - list ORK metadata for an org.
+     * Contract from OpenAPI; propagates API errors.
+     */
+    listOrkMetadataV1(params: ListOrkMetadataV1Params): Promise<ListOrkMetadataV1Response>;
+}

package/dist/client.js

@@ -0,0 +1,41 @@
+"use strict";
+/**
+ * Inklok SDK client - thin wrapper over the public API.
+ * No business logic; fetch and return only.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InklokClient = void 0;
+/**
+ * Thin client for Inklok public API. Fetches and returns; no business logic.
+ */
+class InklokClient {
+    baseUrl;
+    constructor(options) {
+        this.baseUrl = options.baseUrl.replace(/\/$/, "");
+    }
+    /**
+     * GET /v1/ork/metadata - list ORK metadata for an org.
+     * Contract from OpenAPI; propagates API errors.
+     */
+    async listOrkMetadataV1(params) {
+        const url = `${this.baseUrl}/v1/ork/metadata`;
+        const res = await fetch(url, {
+            method: "GET",
+            headers: {
+                "X-Inklok-Org-Id": params.orgId,
+                Authorization: `Bearer ${params.accessToken}`,
+                Accept: "application/json",
+            },
+        });
+        if (!res.ok) {
+            const body = await res.text();
+            const err = new Error(`API error ${res.status}: ${body}`);
+            err.status = res.status;
+            err.body = body;
+            throw err;
+        }
+        const json = (await res.json());
+        return json;
+    }
+}
+exports.InklokClient = InklokClient;

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * inklok-sdk-node - Node.js SDK for Inklok/OpaqueInk public API
+ */
+export { InklokClient, ListOrkMetadataV1Params, ListOrkMetadataV1Response, OrkMetadata } from "./client";

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+/**
+ * inklok-sdk-node - Node.js SDK for Inklok/OpaqueInk public API
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InklokClient = void 0;
+var client_1 = require("./client");
+Object.defineProperty(exports, "InklokClient", { enumerable: true, get: function () { return client_1.InklokClient; } });

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "inklok-sdk-node",
+  "version": "0.1.3",
+  "description": "Node.js SDK for OpaqueInk/Inklok public API - thin wrapper, no business logic",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ryan-m-erickson/inklok-sdk-node"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "codegen": "openapi-typescript node_modules/@ryan-m-erickson/api-spec/openapi.yaml -o src/types.d.ts",
+    "prebuild": "npm run codegen",
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@ryan-m-erickson/api-spec": "^1.0.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "openapi-typescript": "^7.0.0",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}