@prdb/sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,50 @@
+import { type PrdbClient } from "./generated/prdbClient.js";
+/** Header the API expects the key in. */
+export declare const API_KEY_HEADER = "X-Api-Key";
+/** Production base URL, also the default baked into the generated client. */
+export declare const DEFAULT_BASE_URL = "https://api.prdb.net";
+/** A fetch implementation, as Kiota's middleware pipeline expects it. */
+export type FetchLike = (url: string, init: RequestInit) => Promise<Response>;
+/**
+ * Thrown when the API redirects to a different origin.
+ *
+ * Following such a redirect would hand the API key to whoever answers at the
+ * new location, so the SDK refuses it. Redirects that stay on the same origin
+ * are followed normally.
+ */
+export declare class CrossOriginRedirectError extends Error {
+    constructor(originalUrl: string, newUrl: string);
+}
+export interface ClientOptions {
+    /** The API key, sent in the `X-Api-Key` header on every request. */
+    apiKey: string;
+    /**
+     * Override the API root. Useful for a staging deployment. Must use `https`,
+     * so the key is never sent in cleartext.
+     */
+    baseUrl?: string;
+    /**
+     * Supply your own fetch implementation to control timeouts, proxies or
+     * agents. It is wrapped in the SDK's middleware either way, so the redirect
+     * rule below always applies.
+     */
+    customFetch?: FetchLike;
+}
+export type AnonymousClientOptions = Omit<ClientOptions, "apiKey">;
+/**
+ * Create a client authenticated with an API key.
+ *
+ * @throws If `apiKey` is empty, or `baseUrl` is not an absolute `https` URL.
+ */
+export declare function createClient(options: ClientOptions): PrdbClient;
+/**
+ * Create a client without credentials.
+ *
+ * Only `GET /health` is reachable this way; every other endpoint answers 401.
+ * Provided so health probes do not need an API key.
+ *
+ * With no credential to protect, `baseUrl` may use plain `http`.
+ */
+export declare function createAnonymousClient(options?: AnonymousClientOptions): PrdbClient;
+export type { PrdbClient };
+//# 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":"AA+BA,OAAO,EAAoB,KAAK,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAE9E,yCAAyC;AACzC,eAAO,MAAM,cAAc,cAAc,CAAC;AAE1C,6EAA6E;AAC7E,eAAO,MAAM,gBAAgB,yBAAyB,CAAC;AAEvD,yEAAyE;AACzE,MAAM,MAAM,SAAS,GAAG,CACvB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,WAAW,KACb,OAAO,CAAC,QAAQ,CAAC,CAAC;AAEvB;;;;;;GAMG;AACH,qBAAa,wBAAyB,SAAQ,KAAK;gBACtC,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;CAO/C;AAED,MAAM,WAAW,aAAa;IAC7B,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,SAAS,CAAC;CACxB;AAED,MAAM,MAAM,sBAAsB,GAAG,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AAEnE;;;;GAIG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,UAAU,CAiB/D;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACpC,OAAO,GAAE,sBAA2B,GAClC,UAAU,CASZ;AA8GD,YAAY,EAAE,UAAU,EAAE,CAAC"}

package/dist/index.js

@@ -0,0 +1,138 @@
+/**
+ * TypeScript SDK for the prdb Public API.
+ *
+ * The request builders mirror the API's URL structure:
+ *
+ * ```ts
+ * import { createClient } from "@prdb/sdk";
+ *
+ * const client = createClient({ apiKey: "..." });
+ * const page = await client.videos.get();
+ * const video = await client.videos.byId(videoId).get();
+ * ```
+ *
+ * Everything under `./generated` is produced by Kiota from `spec/openapi.json`
+ * and is overwritten on every regeneration. Do not edit it.
+ */
+import { AnonymousAuthenticationProvider, ApiKeyAuthenticationProvider, ApiKeyLocation, } from "@microsoft/kiota-abstractions";
+import { DefaultRequestAdapter } from "@microsoft/kiota-bundle";
+import { KiotaClientFactory, MiddlewareFactory, RedirectHandler, RedirectHandlerOptions, } from "@microsoft/kiota-http-fetchlibrary";
+import { createPrdbClient } from "./generated/prdbClient.js";
+/** Header the API expects the key in. */
+export const API_KEY_HEADER = "X-Api-Key";
+/** Production base URL, also the default baked into the generated client. */
+export const DEFAULT_BASE_URL = "https://api.prdb.net";
+/**
+ * Thrown when the API redirects to a different origin.
+ *
+ * Following such a redirect would hand the API key to whoever answers at the
+ * new location, so the SDK refuses it. Redirects that stay on the same origin
+ * are followed normally.
+ */
+export class CrossOriginRedirectError extends Error {
+    constructor(originalUrl, newUrl) {
+        super(`refusing to follow a redirect from ${new URL(originalUrl).host} to ` +
+            `${new URL(newUrl).host}; the api key is bound to the first host`);
+        this.name = "CrossOriginRedirectError";
+    }
+}
+/**
+ * Create a client authenticated with an API key.
+ *
+ * @throws If `apiKey` is empty, or `baseUrl` is not an absolute `https` URL.
+ */
+export function createClient(options) {
+    const { apiKey, baseUrl = DEFAULT_BASE_URL, customFetch } = options;
+    if (!apiKey) {
+        throw new Error("apiKey must not be empty");
+    }
+    const host = hostOf(baseUrl, { requireHttps: true });
+    const authProvider = new ApiKeyAuthenticationProvider(apiKey, API_KEY_HEADER, ApiKeyLocation.Header, new Set([host]));
+    return buildClient(authProvider, baseUrl, customFetch);
+}
+/**
+ * Create a client without credentials.
+ *
+ * Only `GET /health` is reachable this way; every other endpoint answers 401.
+ * Provided so health probes do not need an API key.
+ *
+ * With no credential to protect, `baseUrl` may use plain `http`.
+ */
+export function createAnonymousClient(options = {}) {
+    const { baseUrl = DEFAULT_BASE_URL, customFetch } = options;
+    hostOf(baseUrl, { requireHttps: false });
+    return buildClient(new AnonymousAuthenticationProvider(), baseUrl, customFetch);
+}
+function buildClient(authProvider, baseUrl, customFetch) {
+    const adapter = new DefaultRequestAdapter(authProvider, undefined, undefined, buildHttpClient(customFetch));
+    adapter.baseUrl = baseUrl;
+    return createPrdbClient(adapter);
+}
+/**
+ * Build Kiota's default middleware pipeline with one change: a redirect to a
+ * different origin is refused instead of followed.
+ *
+ * The API key travels in a custom header, and nothing below this point strips
+ * it. Kiota's default scrubbing removes only `authorization`, `cookie` and
+ * `proxy-authorization`, and `fetch` itself keeps custom headers across a
+ * redirect, so a redirect off the API host would hand the credential to
+ * whoever answered.
+ */
+function buildHttpClient(customFetch) {
+    const middlewares = MiddlewareFactory.getDefaultMiddlewares(customFetch);
+    const ours = new RedirectHandler(new RedirectHandlerOptions({
+        scrubSensitiveHeaders: refuseCrossOriginRedirect,
+    }));
+    const index = middlewares.findIndex((middleware) => middleware instanceof RedirectHandler);
+    if (index === -1) {
+        // Kiota's defaults no longer include one; ours still has to run.
+        middlewares.unshift(ours);
+    }
+    else {
+        middlewares[index] = ours;
+    }
+    return KiotaClientFactory.create(customFetch, middlewares);
+}
+/**
+ * Refuse a redirect that leaves the origin the request started on.
+ *
+ * The key is deleted before throwing as well, so it is gone from the headers
+ * even if a caller catches the error and reuses them.
+ */
+function refuseCrossOriginRedirect(headers, originalUrl, newUrl) {
+    const original = new URL(originalUrl);
+    const next = new URL(newUrl);
+    if (original.protocol.toLowerCase() === next.protocol.toLowerCase() &&
+        original.host.toLowerCase() === next.host.toLowerCase()) {
+        return;
+    }
+    // The request adapter lower-cases every header key before the middleware
+    // sees it, so a PascalCase delete would be a no-op.
+    for (const key of Object.keys(headers)) {
+        const lower = key.toLowerCase();
+        if (lower === API_KEY_HEADER.toLowerCase() ||
+            lower === "authorization" ||
+            lower === "cookie" ||
+            lower === "proxy-authorization") {
+            delete headers[key];
+        }
+    }
+    throw new CrossOriginRedirectError(originalUrl, newUrl);
+}
+function hostOf(baseUrl, { requireHttps }) {
+    let url;
+    try {
+        url = new URL(baseUrl);
+    }
+    catch {
+        throw new Error(`baseUrl must be an absolute URL, got ${baseUrl}`);
+    }
+    if (!url.host || (url.protocol !== "http:" && url.protocol !== "https:")) {
+        throw new Error(`baseUrl must be an absolute URL, got ${baseUrl}`);
+    }
+    if (requireHttps && url.protocol !== "https:") {
+        throw new Error(`baseUrl must use https so the api key is not sent in cleartext, got ${baseUrl}`);
+    }
+    return url.host;
+}
+//# 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;;;;;;;;;;;;;;;GAeG;AACH,OAAO,EACN,+BAA+B,EAC/B,4BAA4B,EAC5B,cAAc,GACd,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAEN,kBAAkB,EAElB,iBAAiB,EACjB,eAAe,EACf,sBAAsB,GACtB,MAAM,oCAAoC,CAAC;AAE5C,OAAO,EAAE,gBAAgB,EAAmB,MAAM,2BAA2B,CAAC;AAE9E,yCAAyC;AACzC,MAAM,CAAC,MAAM,cAAc,GAAG,WAAW,CAAC;AAE1C,6EAA6E;AAC7E,MAAM,CAAC,MAAM,gBAAgB,GAAG,sBAAsB,CAAC;AAQvD;;;;;;GAMG;AACH,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IAClD,YAAY,WAAmB,EAAE,MAAc;QAC9C,KAAK,CACJ,sCAAsC,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,IAAI,MAAM;YACpE,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC,IAAI,0CAA0C,CAClE,CAAC;QACF,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;IACxC,CAAC;CACD;AAoBD;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,OAAsB;IAClD,MAAM,EAAE,MAAM,EAAE,OAAO,GAAG,gBAAgB,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAEpE,IAAI,CAAC,MAAM,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC;IAErD,MAAM,YAAY,GAAG,IAAI,4BAA4B,CACpD,MAAM,EACN,cAAc,EACd,cAAc,CAAC,MAAM,EACrB,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CACf,CAAC;IAEF,OAAO,WAAW,CAAC,YAAY,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;AACxD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CACpC,UAAkC,EAAE;IAEpC,MAAM,EAAE,OAAO,GAAG,gBAAgB,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAC5D,MAAM,CAAC,OAAO,EAAE,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC,CAAC;IAEzC,OAAO,WAAW,CACjB,IAAI,+BAA+B,EAAE,EACrC,OAAO,EACP,WAAW,CACX,CAAC;AACH,CAAC;AAED,SAAS,WAAW,CACnB,YAAoE,EACpE,OAAe,EACf,WAAuB;IAEvB,MAAM,OAAO,GAAG,IAAI,qBAAqB,CACxC,YAAY,EACZ,SAAS,EACT,SAAS,EACT,eAAe,CAAC,WAAW,CAAC,CAC5B,CAAC;IACF,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;IAE1B,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC;AAClC,CAAC;AAED;;;;;;;;;GASG;AACH,SAAS,eAAe,CAAC,WAAuB;IAC/C,MAAM,WAAW,GAChB,iBAAiB,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAEtD,MAAM,IAAI,GAAG,IAAI,eAAe,CAC/B,IAAI,sBAAsB,CAAC;QAC1B,qBAAqB,EAAE,yBAAyB;KAChD,CAAC,CACF,CAAC;IAEF,MAAM,KAAK,GAAG,WAAW,CAAC,SAAS,CAClC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,YAAY,eAAe,CACrD,CAAC;IACF,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;QAClB,iEAAiE;QACjE,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;SAAM,CAAC;QACP,WAAW,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;IAC3B,CAAC;IAED,OAAO,kBAAkB,CAAC,MAAM,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;AAC5D,CAAC;AAED;;;;;GAKG;AACH,SAAS,yBAAyB,CACjC,OAA+B,EAC/B,WAAmB,EACnB,MAAc;IAEd,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC;IACtC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;IAE7B,IACC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE;QAC/D,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,EACtD,CAAC;QACF,OAAO;IACR,CAAC;IAED,yEAAyE;IACzE,oDAAoD;IACpD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QAChC,IACC,KAAK,KAAK,cAAc,CAAC,WAAW,EAAE;YACtC,KAAK,KAAK,eAAe;YACzB,KAAK,KAAK,QAAQ;YAClB,KAAK,KAAK,qBAAqB,EAC9B,CAAC;YACF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACF,CAAC;IAED,MAAM,IAAI,wBAAwB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,MAAM,CACd,OAAe,EACf,EAAE,YAAY,EAA6B;IAE3C,IAAI,GAAQ,CAAC;IACb,IAAI,CAAC;QACJ,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IACxB,CAAC;IAAC,MAAM,CAAC;QACR,MAAM,IAAI,KAAK,CAAC,wCAAwC,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,CAAC,EAAE,CAAC;QAC1E,MAAM,IAAI,KAAK,CAAC,wCAAwC,OAAO,EAAE,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,YAAY,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC/C,MAAM,IAAI,KAAK,CACd,uEAAuE,OAAO,EAAE,CAChF,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC;AACjB,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@prdb/sdk",
+  "version": "0.1.0",
+  "description": "TypeScript SDK for the prdb Public API",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/prdb-net/prdb-sdk.git",
+    "directory": "typescript"
+  },
+  "homepage": "https://github.com/prdb-net/prdb-sdk#readme",
+  "bugs": "https://github.com/prdb-net/prdb-sdk/issues",
+  "keywords": ["prdb", "sdk", "api", "client"],
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": ["dist"],
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "typecheck": "tsc --noEmit",
+    "test": "tsc -p tsconfig.test.json && node --test .test-dist/test/*.test.js",
+    "clean": "rm -rf dist .test-dist"
+  },
+  "dependencies": {
+    "@microsoft/kiota-bundle": "1.0.0-preview.103"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.0",
+    "@types/node": "^20.0.0"
+  }
+}