@olc-sales/api-client 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,33 @@
-# Temporary Holding Version
+# @olc-sales/api-client
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Shared service-to-service HTTP client pieces, extracted from the near-identical
+copies in `olc-events`, `olc-search`, `olc-notifications`, `olc-data` and
+`olc-entitlements`.
+
+- `createJsonApiClient(opts)` – `getResource` / `getResources` / `getRelated`
+  against an OLC JSON API. 404 on single/related fetches resolves to `null`.
+  `version: 'auto'` uses v2 for capitalised resource types, else v1.
+  `maxConcurrent` optionally throttles via Bottleneck. Memoisation and logging
+  are left to the consumer.
+- `createServiceToken(tokenUri, clientId, clientSecret)` – OAuth
+  client-credentials token provider (cached until 1 min before expiry,
+  concurrent callers share one fetch). Pass it as `getToken`.
+
+```js
+const { createJsonApiClient, createServiceToken } = require('@olc-sales/api-client')
+
+const identity = createJsonApiClient({
+  baseUrl: config.api.identity,
+  applicationId: 'olc-events',
+  apiKey: config.api.key,
+  getToken: createServiceToken(`${config.api.identity}/oauth/token`, id, secret)
+})
+```
+
+`axios`, `qs` and `bottleneck` are peer dependencies.
+
+## Build
+
+```bash
+yarn build   # tsc -> dist/
+```

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { createJsonApiClient } from './jsonApiClient';
+export type { JsonApiClient, JsonApiClientOptions, Query } from './jsonApiClient';
+export { createServiceToken } from './serviceToken';
+export type { TokenProvider } from './serviceToken';
+//# 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":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AACrD,YAAY,EAAE,aAAa,EAAE,oBAAoB,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAA;AACjF,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AACnD,YAAY,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA"}

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createServiceToken = exports.createJsonApiClient = void 0;
+var jsonApiClient_1 = require("./jsonApiClient");
+Object.defineProperty(exports, "createJsonApiClient", { enumerable: true, get: function () { return jsonApiClient_1.createJsonApiClient; } });
+var serviceToken_1 = require("./serviceToken");
+Object.defineProperty(exports, "createServiceToken", { enumerable: true, get: function () { return serviceToken_1.createServiceToken; } });
+//# 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,iDAAqD;AAA5C,oHAAA,mBAAmB,OAAA;AAE5B,+CAAmD;AAA1C,kHAAA,kBAAkB,OAAA"}

package/dist/jsonApiClient.d.ts

@@ -0,0 +1,26 @@
+import type { TokenProvider } from './serviceToken';
+export interface JsonApiClientOptions {
+    baseUrl: string;
+    /** Sent as `X-Application-ID`. */
+    applicationId: string;
+    /** Needed when developing locally and connecting through the API gateway. */
+    apiKey?: string;
+    bearerToken?: string;
+    /** Resolved per request and sent as the bearer token; overrides `bearerToken`. */
+    getToken?: TokenProvider;
+    /** `'auto'` picks v2 for capitalised resource types, otherwise v1. */
+    version?: 'v1' | 'v2' | 'auto';
+    headers?: Record<string, string>;
+    /** Caps in-flight requests when set. */
+    maxConcurrent?: number;
+}
+export type Query = Record<string, unknown>;
+type Headers = Record<string, string>;
+export interface JsonApiClient {
+    getResource: (type: string, id: string, query?: Query, headers?: Headers) => Promise<any>;
+    getResources: (type: string, query?: Query, headers?: Headers) => Promise<any>;
+    getRelated: (type: string, id: string, relationship: string, query?: Query, headers?: Headers) => Promise<any>;
+}
+export declare const createJsonApiClient: ({ baseUrl, applicationId, apiKey, bearerToken, getToken, version, headers: extraHeaders, maxConcurrent }: JsonApiClientOptions) => JsonApiClient;
+export {};
+//# sourceMappingURL=jsonApiClient.d.ts.map

package/dist/jsonApiClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonApiClient.d.ts","sourceRoot":"","sources":["../src/jsonApiClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAEnD,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,kCAAkC;IAClC,aAAa,EAAE,MAAM,CAAA;IACrB,6EAA6E;IAC7E,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,kFAAkF;IAClF,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,sEAAsE;IACtE,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,MAAM,CAAA;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,wCAAwC;IACxC,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;AAC3C,KAAK,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAErC,MAAM,WAAW,aAAa;IAC5B,WAAW,EAAE,CACX,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,KAAK,CAAC,EAAE,KAAK,EACb,OAAO,CAAC,EAAE,OAAO,KACd,OAAO,CAAC,GAAG,CAAC,CAAA;IACjB,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAC9E,UAAU,EAAE,CACV,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,EACV,YAAY,EAAE,MAAM,EACpB,KAAK,CAAC,EAAE,KAAK,EACb,OAAO,CAAC,EAAE,OAAO,KACd,OAAO,CAAC,GAAG,CAAC,CAAA;CAClB;AAUD,eAAO,MAAM,mBAAmB,GAAI,0GASjC,oBAAoB,KAAG,aAmDzB,CAAA"}

package/dist/jsonApiClient.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createJsonApiClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+const bottleneck_1 = __importDefault(require("bottleneck"));
+const qs_1 = __importDefault(require("qs"));
+// A missing resource is a null result rather than an error.
+const handleGetFailure = (err) => {
+    if (err.response && err.response.status === 404) {
+        return null;
+    }
+    throw err;
+};
+const createJsonApiClient = ({ baseUrl, applicationId, apiKey, bearerToken, getToken, version = 'v1', headers: extraHeaders = {}, maxConcurrent }) => {
+    const defaultHeaders = {
+        'X-Application-ID': applicationId,
+        ...extraHeaders
+    };
+    if (apiKey) {
+        defaultHeaders['x-api-key'] = apiKey;
+    }
+    if (bearerToken) {
+        defaultHeaders.Authorization = `Bearer ${bearerToken}`;
+    }
+    const axiosInstance = axios_1.default.create({ headers: defaultHeaders });
+    if (getToken) {
+        axiosInstance.interceptors.request.use(async (request) => {
+            request.headers.Authorization = `Bearer ${await getToken()}`;
+            return request;
+        });
+    }
+    const limiter = maxConcurrent ? new bottleneck_1.default({ maxConcurrent }) : null;
+    const schedule = (fn) => limiter ? limiter.schedule(fn) : fn();
+    const apiVersion = (type) => version === 'auto' ? (/^[A-Z]/.test(type) ? 'v2' : 'v1') : version;
+    const get = (uri, headers) => schedule(() => axiosInstance
+        .get(uri, { headers })
+        .then(res => res.data));
+    return {
+        getResource: (type, id, query = {}, headers = {}) => get(`${baseUrl}/${apiVersion(type)}/${type}/${id}?${qs_1.default.stringify(query)}`, headers).catch(handleGetFailure),
+        getResources: (type, query = {}, headers = {}) => get(`${baseUrl}/${apiVersion(type)}/${type}?${qs_1.default.stringify(query)}`, headers),
+        getRelated: (type, id, relationship, query = {}, headers = {}) => get(`${baseUrl}/${apiVersion(type)}/${type}/${id}/${relationship}?${qs_1.default.stringify(query)}`, headers).catch(handleGetFailure)
+    };
+};
+exports.createJsonApiClient = createJsonApiClient;
+//# sourceMappingURL=jsonApiClient.js.map

package/dist/jsonApiClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonApiClient.js","sourceRoot":"","sources":["../src/jsonApiClient.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAiD;AACjD,4DAAmC;AACnC,4CAAmB;AAuCnB,4DAA4D;AAC5D,MAAM,gBAAgB,GAAG,CAAC,GAAQ,EAAE,EAAE;IACpC,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;QAChD,OAAO,IAAI,CAAA;IACb,CAAC;IACD,MAAM,GAAG,CAAA;AACX,CAAC,CAAA;AAEM,MAAM,mBAAmB,GAAG,CAAC,EAClC,OAAO,EACP,aAAa,EACb,MAAM,EACN,WAAW,EACX,QAAQ,EACR,OAAO,GAAG,IAAI,EACd,OAAO,EAAE,YAAY,GAAG,EAAE,EAC1B,aAAa,EACQ,EAAiB,EAAE;IACxC,MAAM,cAAc,GAAY;QAC9B,kBAAkB,EAAE,aAAa;QACjC,GAAG,YAAY;KAChB,CAAA;IACD,IAAI,MAAM,EAAE,CAAC;QACX,cAAc,CAAC,WAAW,CAAC,GAAG,MAAM,CAAA;IACtC,CAAC;IACD,IAAI,WAAW,EAAE,CAAC;QAChB,cAAc,CAAC,aAAa,GAAG,UAAU,WAAW,EAAE,CAAA;IACxD,CAAC;IAED,MAAM,aAAa,GAAG,eAAK,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;IAC/D,IAAI,QAAQ,EAAE,CAAC;QACb,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;YACrD,OAAO,CAAC,OAAO,CAAC,aAAa,GAAG,UAAU,MAAM,QAAQ,EAAE,EAAE,CAAA;YAC5D,OAAO,OAAO,CAAA;QAChB,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,OAAO,GAAG,aAAa,CAAC,CAAC,CAAC,IAAI,oBAAU,CAAC,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IACxE,MAAM,QAAQ,GAAG,CAAI,EAAoB,EAAc,EAAE,CACvD,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAA;IAEvC,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,EAAE,CAClC,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;IAEpE,MAAM,GAAG,GAAG,CAAC,GAAW,EAAE,OAAgB,EAAE,EAAE,CAC5C,QAAQ,CAAC,GAAG,EAAE,CACZ,aAAa;SACV,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAwB,CAAC;SAC3C,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CACzB,CAAA;IAEH,OAAO;QACL,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,GAAG,EAAE,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE,CAClD,GAAG,CACD,GAAG,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE,IAAI,YAAE,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EACrE,OAAO,CACR,CAAC,KAAK,CAAC,gBAAgB,CAAC;QAC3B,YAAY,EAAE,CAAC,IAAI,EAAE,KAAK,GAAG,EAAE,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE,CAC/C,GAAG,CACD,GAAG,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,YAAE,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EAC/D,OAAO,CACR;QACH,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,YAAY,EAAE,KAAK,GAAG,EAAE,EAAE,OAAO,GAAG,EAAE,EAAE,EAAE,CAC/D,GAAG,CACD,GAAG,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,EAAE,IAAI,YAAY,IAAI,YAAE,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,EACrF,OAAO,CACR,CAAC,KAAK,CAAC,gBAAgB,CAAC;KAC5B,CAAA;AACH,CAAC,CAAA;AA5DY,QAAA,mBAAmB,uBA4D/B"}

package/dist/serviceToken.d.ts

@@ -0,0 +1,7 @@
+export type TokenProvider = () => Promise<string>;
+/**
+ * Client-credentials token for an OAuth server (olc-identity), cached until a
+ * minute before expiry. Concurrent callers share one in-flight fetch.
+ */
+export declare const createServiceToken: (tokenUri: string, clientId: string, clientSecret: string) => TokenProvider;
+//# sourceMappingURL=serviceToken.d.ts.map

package/dist/serviceToken.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serviceToken.d.ts","sourceRoot":"","sources":["../src/serviceToken.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;AAEjD;;;GAGG;AACH,eAAO,MAAM,kBAAkB,GAC7B,UAAU,MAAM,EAChB,UAAU,MAAM,EAChB,cAAc,MAAM,KACnB,aAiCF,CAAA"}

package/dist/serviceToken.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createServiceToken = void 0;
+const axios_1 = __importDefault(require("axios"));
+/**
+ * Client-credentials token for an OAuth server (olc-identity), cached until a
+ * minute before expiry. Concurrent callers share one in-flight fetch.
+ */
+const createServiceToken = (tokenUri, clientId, clientSecret) => {
+    let token;
+    let expiresAt = 0;
+    let pending = null;
+    const fetchToken = () => axios_1.default
+        .post(tokenUri, {
+        grant_type: 'client_credentials',
+        client_id: clientId,
+        client_secret: clientSecret
+    }, { timeout: 10000 })
+        .then(({ data: { access_token: accessToken, expires_in: expiresIn } }) => {
+        token = accessToken;
+        expiresAt = Date.now() + (expiresIn - 60) * 1000;
+        return token;
+    });
+    return () => {
+        if (token && Date.now() < expiresAt) {
+            return Promise.resolve(token);
+        }
+        pending =
+            pending ||
+                fetchToken().finally(() => {
+                    pending = null;
+                });
+        return pending;
+    };
+};
+exports.createServiceToken = createServiceToken;
+//# sourceMappingURL=serviceToken.js.map

package/dist/serviceToken.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serviceToken.js","sourceRoot":"","sources":["../src/serviceToken.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyB;AAIzB;;;GAGG;AACI,MAAM,kBAAkB,GAAG,CAChC,QAAgB,EAChB,QAAgB,EAChB,YAAoB,EACL,EAAE;IACjB,IAAI,KAAyB,CAAA;IAC7B,IAAI,SAAS,GAAG,CAAC,CAAA;IACjB,IAAI,OAAO,GAA2B,IAAI,CAAA;IAE1C,MAAM,UAAU,GAAG,GAAG,EAAE,CACtB,eAAK;SACF,IAAI,CACH,QAAQ,EACR;QACE,UAAU,EAAE,oBAAoB;QAChC,SAAS,EAAE,QAAQ;QACnB,aAAa,EAAE,YAAY;KAC5B,EACD,EAAE,OAAO,EAAE,KAAK,EAAE,CACnB;SACA,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE;QACvE,KAAK,GAAG,WAAqB,CAAA;QAC7B,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,SAAS,GAAG,EAAE,CAAC,GAAG,IAAI,CAAA;QAChD,OAAO,KAAK,CAAA;IACd,CAAC,CAAC,CAAA;IAEN,OAAO,GAAG,EAAE;QACV,IAAI,KAAK,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,EAAE,CAAC;YACpC,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QAC/B,CAAC;QACD,OAAO;YACL,OAAO;gBACP,UAAU,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE;oBACxB,OAAO,GAAG,IAAI,CAAA;gBAChB,CAAC,CAAC,CAAA;QACJ,OAAO,OAAO,CAAA;IAChB,CAAC,CAAA;AACH,CAAC,CAAA;AArCY,QAAA,kBAAkB,sBAqC9B"}

package/package.json

@@ -1,6 +1,38 @@
 {
   "name": "@olc-sales/api-client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Shared OLC service-to-service HTTP clients - JSON API read client and OAuth client-credentials token provider",
+  "keywords": [
+    "api",
+    "client",
+    "oauth",
+    "olc"
+  ],
+  "author": "Joel Woods <joel@miaem.com>",
+  "license": "ISC",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepublishOnly": "yarn build"
+  },
+  "peerDependencies": {
+    "axios": ">=0.18.0",
+    "bottleneck": "^2.0.0",
+    "qs": "^6.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.14.0",
+    "@types/qs": "^6.9.15",
+    "axios": "^1.7.0",
+    "bottleneck": "^2.19.5",
+    "qs": "^6.12.0",
+    "typescript": "^5.5.4"
+  }
+}