inklok-sdk-node 0.1.3 → 0.1.5

package/README.md

@@ -2,23 +2,11 @@
 
 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
+## Install
 
-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.
+```bash
+npm install inklok-sdk-node
+```
 
 ## Usage
 
@@ -33,12 +21,28 @@ const metadata = await client.listOrkMetadataV1({
   orgId: "org-123",
   accessToken: "jwt-token",
 });
+
+const members = await client.listOrgMembersV1({
+  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).
+Request/response shapes come from the OpenAPI spec (see `api-spec` dependency). Types are generated with `openapi-typescript`; see `src/types.d.ts` (generated).
+
+## Development
+
+To build from source: copy `.npmrc.example` to `.npmrc` and configure GitHub Packages auth (see that file), then:
+
+```bash
+npm install
+npm run build
+```
+
+Types are regenerated from the spec on build; run `npm run codegen` to regenerate only `src/types.d.ts`.
 
 ## 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.
+On merge to `main`, GitHub Actions publishes to npm. Add an **NPM_TOKEN** secret (classic token, "Automation" type, from [npmjs.com/settings](https://www.npmjs.com/settings)). If the api-spec dependency is private, add **GH_PACKAGES_TOKEN** (PAT with `read:packages`) and wire the workflow to use it for GitHub Packages.

package/dist/client.d.ts

@@ -1,29 +1,29 @@
 /**
- * Inklok SDK client - thin wrapper over the public API.
- * No business logic; fetch and return only.
+ * Inklok SDK client - thin facade over endpoint modules.
+ * Each method delegates to one endpoint module for scalability and testability.
  */
-import type { components, operations } from "./types";
+import type { components } from "./types";
+import * as orkMetadata from "./endpoints/ork-metadata";
+import * as orgMembers from "./endpoints/org-members";
 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 type OrgMember = components["schemas"]["OrgMember"];
+export type ListOrkMetadataV1Params = orkMetadata.ListOrkMetadataV1Params;
+export type ListOrkMetadataV1Response = orkMetadata.ListOrkMetadataV1Response;
+export type ListOrgMembersV1Params = orgMembers.ListOrgMembersV1Params;
+export type ListOrgMembersV1Response = orgMembers.ListOrgMembersV1Response;
 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>;
+    /**
+     * GET /v1/orgs/{orgId}/members - list members of an organization.
+     */
+    listOrgMembersV1(params: ListOrgMembersV1Params): Promise<ListOrgMembersV1Response>;
 }

package/dist/client.js

@@ -1,13 +1,45 @@
 "use strict";
 /**
- * Inklok SDK client - thin wrapper over the public API.
- * No business logic; fetch and return only.
+ * Inklok SDK client - thin facade over endpoint modules.
+ * Each method delegates to one endpoint module for scalability and testability.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InklokClient = void 0;
-/**
- * Thin client for Inklok public API. Fetches and returns; no business logic.
- */
+const orkMetadata = __importStar(require("./endpoints/ork-metadata"));
+const orgMembers = __importStar(require("./endpoints/org-members"));
 class InklokClient {
     baseUrl;
     constructor(options) {
@@ -15,27 +47,15 @@ class InklokClient {
     }
     /**
      * 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;
+        return orkMetadata.listOrkMetadataV1(this.baseUrl, params);
+    }
+    /**
+     * GET /v1/orgs/{orgId}/members - list members of an organization.
+     */
+    async listOrgMembersV1(params) {
+        return orgMembers.listOrgMembersV1(this.baseUrl, params);
     }
 }
 exports.InklokClient = InklokClient;

package/dist/endpoints/org-members.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Org members endpoint: GET /v1/orgs/{orgId}/members
+ */
+import type { operations } from "../types";
+export type ListOrgMembersV1Response = operations["listOrgMembersV1"]["responses"]["200"]["content"]["application/json"];
+export interface ListOrgMembersV1Params {
+    orgId: string;
+    accessToken: string;
+}
+/**
+ * GET /v1/orgs/{orgId}/members - list members of an organization.
+ * Matches the public API contract used by the OpaqueInk /org page.
+ */
+export declare function listOrgMembersV1(baseUrl: string, params: ListOrgMembersV1Params): Promise<ListOrgMembersV1Response>;

package/dist/endpoints/org-members.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * Org members endpoint: GET /v1/orgs/{orgId}/members
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listOrgMembersV1 = listOrgMembersV1;
+const http_1 = require("../http");
+/**
+ * GET /v1/orgs/{orgId}/members - list members of an organization.
+ * Matches the public API contract used by the OpaqueInk /org page.
+ */
+async function listOrgMembersV1(baseUrl, params) {
+    const base = baseUrl.replace(/\/$/, "");
+    const url = `${base}/v1/orgs/${encodeURIComponent(params.orgId)}/members`;
+    return (0, http_1.getAuthenticated)(url, {
+        accessToken: params.accessToken,
+        orgId: params.orgId,
+    });
+}

package/dist/endpoints/ork-metadata.d.ts

@@ -0,0 +1,13 @@
+/**
+ * ORK metadata endpoint: GET /v1/ork/metadata
+ */
+import type { operations } from "../types";
+export type ListOrkMetadataV1Response = operations["listOrkMetadataV1"]["responses"]["200"]["content"]["application/json"];
+export interface ListOrkMetadataV1Params {
+    orgId: string;
+    accessToken: string;
+}
+/**
+ * GET /v1/ork/metadata - list ORK metadata for an org.
+ */
+export declare function listOrkMetadataV1(baseUrl: string, params: ListOrkMetadataV1Params): Promise<ListOrkMetadataV1Response>;

package/dist/endpoints/ork-metadata.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * ORK metadata endpoint: GET /v1/ork/metadata
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listOrkMetadataV1 = listOrkMetadataV1;
+const http_1 = require("../http");
+/**
+ * GET /v1/ork/metadata - list ORK metadata for an org.
+ */
+async function listOrkMetadataV1(baseUrl, params) {
+    const url = `${baseUrl.replace(/\/$/, "")}/v1/ork/metadata`;
+    return (0, http_1.getAuthenticated)(url, {
+        accessToken: params.accessToken,
+        orgId: params.orgId,
+    });
+}

package/dist/http.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Shared HTTP helper for authenticated GET requests.
+ * Used by endpoint modules to avoid duplicating fetch/error logic.
+ */
+export interface AuthenticatedGetOptions {
+    /** Bearer token (JWT). */
+    accessToken: string;
+    /** If set, adds X-Inklok-Org-Id header. */
+    orgId?: string;
+}
+/**
+ * Performs an authenticated GET and returns parsed JSON.
+ * Throws on non-OK response with status and body attached.
+ */
+export declare function getAuthenticated<T>(url: string, options: AuthenticatedGetOptions): Promise<T>;

package/dist/http.js

@@ -0,0 +1,29 @@
+"use strict";
+/**
+ * Shared HTTP helper for authenticated GET requests.
+ * Used by endpoint modules to avoid duplicating fetch/error logic.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAuthenticated = getAuthenticated;
+/**
+ * Performs an authenticated GET and returns parsed JSON.
+ * Throws on non-OK response with status and body attached.
+ */
+async function getAuthenticated(url, options) {
+    const headers = {
+        Authorization: `Bearer ${options.accessToken}`,
+        Accept: "application/json",
+    };
+    if (options.orgId != null) {
+        headers["X-Inklok-Org-Id"] = options.orgId;
+    }
+    const res = await fetch(url, { method: "GET", headers });
+    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;
+    }
+    return (await res.json());
+}

package/dist/index.d.ts

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

package/package.json

@@ -1,11 +1,7 @@
 {
   "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"
-  },
+  "version": "0.1.5",
+  "description": "Node.js SDK for Inklok public API",
   "publishConfig": {
     "access": "public"
   },