@opengovsg/refx-ts-sdk 0.0.0-develop-1759151439 → 0.0.0-develop-alpha-1762412839

package/dist/wrapper/ReferralExchangeJwtClient.js

@@ -0,0 +1,81 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferralExchangeJwtClient = void 0;
+const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+const Client_1 = require("../Client");
+const Fetcher_1 = require("../core/fetcher/Fetcher");
+const JWT_TTL_SECONDS = 15;
+class ReferralExchangeJwtClient extends Client_1.ReferralExchangeClient {
+    constructor(options) {
+        const { privateKey, apiKeyName } = options, baseOptions = __rest(options, ["privateKey", "apiKeyName"]);
+        const signer = new JwtSigner({ privateKey, issuer: apiKeyName });
+        const fetcher = createJwtFetcher(signer);
+        super(Object.assign(Object.assign({}, baseOptions), { fetcher }));
+    }
+}
+exports.ReferralExchangeJwtClient = ReferralExchangeJwtClient;
+class JwtSigner {
+    constructor({ privateKey, issuer }) {
+        this.privateKey = privateKey;
+        this.issuer = issuer;
+    }
+    getToken() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const nowSeconds = Math.floor(Date.now() / 1000);
+            if (this.cachedToken != null && nowSeconds < this.cachedToken.expiresAtEpochSeconds - 1) {
+                return this.cachedToken.token;
+            }
+            const { token, expiresAtEpochSeconds } = createSignedJwt({
+                privateKey: this.privateKey,
+                issuer: this.issuer,
+            });
+            this.cachedToken = { token, expiresAtEpochSeconds };
+            return token;
+        });
+    }
+}
+function createJwtFetcher(signer) {
+    return (args) => __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const token = yield signer.getToken();
+        const headers = Object.assign({}, ((_a = args.headers) !== null && _a !== void 0 ? _a : {}));
+        headers.Authorization = `Bearer ${token}`;
+        return (0, Fetcher_1.fetcherImpl)(Object.assign(Object.assign({}, args), { headers }));
+    });
+}
+function createSignedJwt({ privateKey, issuer }) {
+    const issuedAt = Math.floor(Date.now() / 1000);
+    const expiresAtEpochSeconds = issuedAt + JWT_TTL_SECONDS;
+    const token = jsonwebtoken_1.default.sign({}, privateKey, {
+        algorithm: "ES256",
+        issuer,
+        expiresIn: JWT_TTL_SECONDS,
+    });
+    return {
+        token,
+        expiresAtEpochSeconds,
+    };
+}

package/index.d.ts

@@ -1,4 +1,5 @@
 export * as ReferralExchange from "./api";
 export { ReferralExchangeClient } from "./Client";
+export { ReferralExchangeJwtClient } from "./wrapper/ReferralExchangeJwtClient";
 export { ReferralExchangeEnvironment } from "./environments";
 export { ReferralExchangeError, ReferralExchangeTimeoutError } from "./errors";

package/index.js

@@ -33,10 +33,12 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReferralExchangeTimeoutError = exports.ReferralExchangeError = exports.ReferralExchangeEnvironment = exports.ReferralExchangeClient = exports.ReferralExchange = void 0;
+exports.ReferralExchangeTimeoutError = exports.ReferralExchangeError = exports.ReferralExchangeEnvironment = exports.ReferralExchangeJwtClient = exports.ReferralExchangeClient = exports.ReferralExchange = void 0;
 exports.ReferralExchange = __importStar(require("./api"));
 var Client_1 = require("./Client");
 Object.defineProperty(exports, "ReferralExchangeClient", { enumerable: true, get: function () { return Client_1.ReferralExchangeClient; } });
+var ReferralExchangeJwtClient_1 = require("./wrapper/ReferralExchangeJwtClient");
+Object.defineProperty(exports, "ReferralExchangeJwtClient", { enumerable: true, get: function () { return ReferralExchangeJwtClient_1.ReferralExchangeJwtClient; } });
 var environments_1 = require("./environments");
 Object.defineProperty(exports, "ReferralExchangeEnvironment", { enumerable: true, get: function () { return environments_1.ReferralExchangeEnvironment; } });
 var errors_1 = require("./errors");

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@opengovsg/refx-ts-sdk",
-    "version": "0.0.0-develop-1759151439",
+    "version": "0.0.0-develop-alpha-1762412839",
     "private": false,
     "repository": "https://github.com/opengovsg/refer-ts-sdk",
     "main": "./index.js",
@@ -9,12 +9,14 @@
         "format": "prettier . --write --ignore-unknown",
         "build": "tsc",
         "prepack": "cp -rv dist/. .",
+        "pretest": "yarn build",
         "test": "jest"
     },
     "dependencies": {
         "url-join": "4.0.1",
         "form-data": "^4.0.0",
         "formdata-node": "^6.0.3",
+        "jsonwebtoken": "^9.0.2",
         "node-fetch": "^2.7.0",
         "qs": "^6.13.1",
         "readable-stream": "^4.5.2"
@@ -23,6 +25,7 @@
         "@types/url-join": "4.0.1",
         "@types/qs": "^6.9.17",
         "@types/node-fetch": "^2.6.12",
+        "@types/jsonwebtoken": "^9.0.7",
         "@types/readable-stream": "^4.0.18",
         "webpack": "^5.97.1",
         "ts-loader": "^9.5.1",
@@ -37,6 +40,7 @@
     "browser": {
         "fs": false,
         "os": false,
-        "path": false
+        "path": false,
+        "jsonwebtoken": "./dist/browser/jsonwebtoken-stub.js"
     }
 }

package/reference.md

@@ -16,6 +16,9 @@
 
 ```typescript
 await client.eligibility.get({
+    referrerId: "referrerId",
+    referrerIdType: "mcr",
+    referrerInstitutionId: "referrerInstitutionId",
     uin: "uin",
     offeringId: "offeringId",
 });
@@ -631,7 +634,11 @@ await client.notes.create("referralId", {
 <dd>
 
 ```typescript
-await client.offerings.list();
+await client.offerings.list({
+    referrerId: "referrerId",
+    referrerIdType: "mcr",
+    referrerInstitutionId: "referrerInstitutionId",
+});
 ```
 
 </dd>

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.0.0-develop-1759151439";
+export declare const SDK_VERSION = "0.0.54";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "0.0.0-develop-1759151439";
+exports.SDK_VERSION = "0.0.54";

package/wrapper/ReferralExchangeJwtClient.d.ts

@@ -0,0 +1,10 @@
+import { ReferralExchangeClient } from "../Client";
+export declare namespace ReferralExchangeJwtClient {
+    interface Options extends Omit<ReferralExchangeClient.Options, "fetcher" | "apiKey"> {
+        privateKey: string;
+        apiKeyName: string;
+    }
+}
+export declare class ReferralExchangeJwtClient extends ReferralExchangeClient {
+    constructor(options: ReferralExchangeJwtClient.Options);
+}

package/wrapper/ReferralExchangeJwtClient.js

@@ -0,0 +1,81 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReferralExchangeJwtClient = void 0;
+const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
+const Client_1 = require("../Client");
+const Fetcher_1 = require("../core/fetcher/Fetcher");
+const JWT_TTL_SECONDS = 15;
+class ReferralExchangeJwtClient extends Client_1.ReferralExchangeClient {
+    constructor(options) {
+        const { privateKey, apiKeyName } = options, baseOptions = __rest(options, ["privateKey", "apiKeyName"]);
+        const signer = new JwtSigner({ privateKey, issuer: apiKeyName });
+        const fetcher = createJwtFetcher(signer);
+        super(Object.assign(Object.assign({}, baseOptions), { fetcher }));
+    }
+}
+exports.ReferralExchangeJwtClient = ReferralExchangeJwtClient;
+class JwtSigner {
+    constructor({ privateKey, issuer }) {
+        this.privateKey = privateKey;
+        this.issuer = issuer;
+    }
+    getToken() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const nowSeconds = Math.floor(Date.now() / 1000);
+            if (this.cachedToken != null && nowSeconds < this.cachedToken.expiresAtEpochSeconds - 1) {
+                return this.cachedToken.token;
+            }
+            const { token, expiresAtEpochSeconds } = createSignedJwt({
+                privateKey: this.privateKey,
+                issuer: this.issuer,
+            });
+            this.cachedToken = { token, expiresAtEpochSeconds };
+            return token;
+        });
+    }
+}
+function createJwtFetcher(signer) {
+    return (args) => __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const token = yield signer.getToken();
+        const headers = Object.assign({}, ((_a = args.headers) !== null && _a !== void 0 ? _a : {}));
+        headers.Authorization = `Bearer ${token}`;
+        return (0, Fetcher_1.fetcherImpl)(Object.assign(Object.assign({}, args), { headers }));
+    });
+}
+function createSignedJwt({ privateKey, issuer }) {
+    const issuedAt = Math.floor(Date.now() / 1000);
+    const expiresAtEpochSeconds = issuedAt + JWT_TTL_SECONDS;
+    const token = jsonwebtoken_1.default.sign({}, privateKey, {
+        algorithm: "ES256",
+        issuer,
+        expiresIn: JWT_TTL_SECONDS,
+    });
+    return {
+        token,
+        expiresAtEpochSeconds,
+    };
+}