npm - @osdk/oauth - Versions diffs - 0.0.0 - Mend

@osdk/oauth 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

package/build/js/index.cjs +198 -0
package/build/js/index.cjs.map +1 -0
package/build/js/index.mjs +191 -0
package/build/js/index.mjs.map +1 -0
package/build/types/PublicOauthClient.d.ts +15 -0
package/build/types/PublicOauthClient.d.ts.map +1 -0
package/build/types/Token.d.ts +7 -0
package/build/types/Token.d.ts.map +1 -0
package/build/types/createPublicOauthClient.d.ts +15 -0
package/build/types/createPublicOauthClient.d.ts.map +1 -0
package/build/types/index.d.ts +3 -0
package/build/types/index.d.ts.map +1 -0
package/build/types/throwIfError.d.ts +6 -0
package/build/types/throwIfError.d.ts.map +1 -0
package/changelog/@unreleased/pr-156.v2.yml +5 -0
package/package.json +56 -0

package/build/js/index.cjs ADDED Viewed

@@ -0,0 +1,198 @@
+'use strict';
+var delay = require('delay');
+var oauth4webapi = require('oauth4webapi');
+var invariant = require('tiny-invariant');
+var typescriptEventTarget = require('typescript-event-target');
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+var delay__default = /*#__PURE__*/_interopDefault(delay);
+var invariant__default = /*#__PURE__*/_interopDefault(invariant);
+// src/createPublicOauthClient.ts
+function throwIfError(result) {
+  if (oauth4webapi.isOAuth2Error(result)) {
+    throw new Error(`Failed to get token: ${result.error}`);
+  }
+  return result;
+}
+// src/createPublicOauthClient.ts
+var storageKey = "asdfasdfdhjlkajhgj";
+function saveLocal(x) {
+  localStorage.setItem(storageKey, JSON.stringify(x));
+}
+function removeLocal() {
+  localStorage.removeItem(storageKey);
+}
+function readLocal() {
+  return JSON.parse(localStorage.getItem(storageKey) ?? "{}");
+}
+function createPublicOauthClient(client_id, url, redirectUrl, useHistory, loginPage, postLoginPage = window.location.toString(), scopes = ["api:read-data", "api:write-data"], fetchFn = globalThis.fetch, ctxPath = "/multipass") {
+  const oauthHttpOptions = {
+    [oauth4webapi.customFetch]: fetchFn
+  };
+  const eventTarget = new typescriptEventTarget.TypedEventTarget();
+  const issuer = `${new URL(ctxPath, url)}`;
+  const as = {
+    token_endpoint: `${issuer}/api/oauth2/token`,
+    authorization_endpoint: `${issuer}/api/oauth2/authorize`,
+    revocation_endpoint: `${issuer}/api/oauth2/revoke_token`,
+    issuer
+  };
+  const client = {
+    client_id,
+    token_endpoint_auth_method: "none"
+  };
+  async function go(x) {
+    if (useHistory)
+      return window.history.replaceState({}, "", x);
+    else
+      window.location.assign(x);
+    await delay__default.default(1e3);
+    throw new Error("Unable to redirect");
+  }
+  function makeTokenAndSaveRefresh(resp, type) {
+    const {
+      refresh_token,
+      expires_in,
+      access_token
+    } = resp;
+    !(expires_in != null) ? process.env.NODE_ENV !== "production" ? invariant__default.default(false) : invariant__default.default(false) : void 0;
+    saveLocal({
+      refresh_token
+    });
+    token = {
+      refresh_token,
+      expires_in,
+      access_token,
+      expires_at: Date.now() + expires_in * 1e3
+    };
+    eventTarget.dispatchTypedEvent(type, new CustomEvent(type, {
+      detail: token
+    }));
+    return token;
+  }
+  async function maybeRefresh(expectRefreshToken) {
+    const {
+      refresh_token
+    } = readLocal();
+    if (!refresh_token) {
+      if (expectRefreshToken)
+        throw new Error("No refresh token found");
+      return;
+    }
+    try {
+      return makeTokenAndSaveRefresh(throwIfError(await oauth4webapi.processAuthorizationCodeOAuth2Response(as, client, await oauth4webapi.refreshTokenGrantRequest(as, client, refresh_token, oauthHttpOptions))), "refresh");
+    } catch (e) {
+      if (!__DEV__) {
+        console.warn("Failed to get OAuth2 refresh token. Removing refresh token", e);
+      }
+      removeLocal();
+      if (expectRefreshToken) {
+        throw new Error("Could not refresh token");
+      }
+    }
+  }
+  async function maybeHandleAuthReturn() {
+    const {
+      codeVerifier,
+      state,
+      oldUrl
+    } = readLocal();
+    if (!codeVerifier)
+      return;
+    try {
+      const ret2 = makeTokenAndSaveRefresh(throwIfError(await oauth4webapi.processAuthorizationCodeOAuth2Response(as, client, await oauth4webapi.authorizationCodeGrantRequest(as, client, throwIfError(oauth4webapi.validateAuthResponse(as, client, new URL(window.location.href), state)), redirectUrl, codeVerifier, oauthHttpOptions))), "signIn");
+      go(oldUrl);
+      return ret2;
+    } catch (e) {
+      if (__DEV__) {
+        console.warn("Failed to get OAuth2 token using PCKE, removing PCKE and starting a new auth flow", e);
+      }
+      removeLocal();
+    }
+  }
+  async function initiateLoginRedirect() {
+    if (loginPage && window.location.href !== loginPage) {
+      saveLocal({
+        oldUrl: postLoginPage
+      });
+      return await go(loginPage);
+    }
+    const state = oauth4webapi.generateRandomState();
+    const codeVerifier = oauth4webapi.generateRandomCodeVerifier();
+    const oldUrl = readLocal().oldUrl ?? window.location.toString();
+    saveLocal({
+      codeVerifier,
+      state,
+      oldUrl
+    });
+    window.location.assign(`${as.authorization_endpoint}?${new URLSearchParams({
+      client_id,
+      response_type: "code",
+      state,
+      redirect_uri: redirectUrl,
+      code_challenge: await oauth4webapi.calculatePKCECodeChallenge(codeVerifier),
+      code_challenge_method: "S256",
+      scope: ["offline_access", ...scopes].join(" ")
+    })}`);
+    await delay__default.default(1e3);
+    throw new Error("Unable to redirect");
+  }
+  let refreshTimeout;
+  function rmTimeout() {
+    if (refreshTimeout)
+      clearTimeout(refreshTimeout);
+  }
+  function restartRefreshTimer(evt) {
+    rmTimeout();
+    refreshTimeout = setTimeout(refresh, evt.detail.expires_in * 1e3 - 60 * 1e3);
+  }
+  const refresh = maybeRefresh.bind(globalThis, true);
+  async function signOut() {
+    !token ? process.env.NODE_ENV !== "production" ? invariant__default.default(false, "not signed in") : invariant__default.default(false) : void 0;
+    const result = await oauth4webapi.processRevocationResponse(await oauth4webapi.revocationRequest(as, client, token.access_token, oauthHttpOptions));
+    rmTimeout();
+    removeLocal();
+    token = void 0;
+    throwIfError(result);
+    eventTarget.dispatchTypedEvent("signOut", new Event("signOut"));
+  }
+  let pendingSignIn;
+  async function signIn() {
+    if (pendingSignIn) {
+      return pendingSignIn;
+    }
+    try {
+      pendingSignIn = _signIn();
+      return await pendingSignIn;
+    } finally {
+      pendingSignIn = void 0;
+    }
+  }
+  async function _signIn() {
+    return token = await maybeRefresh() ?? await maybeHandleAuthReturn() ?? await initiateLoginRedirect();
+  }
+  eventTarget.addEventListener("signIn", restartRefreshTimer);
+  eventTarget.addEventListener("refresh", restartRefreshTimer);
+  let token;
+  const ret = Object.assign(async function ret2() {
+    if (!token || Date.now() >= token.expires_at) {
+      token = await signIn();
+    }
+    return token.access_token;
+  }, {
+    signIn,
+    refresh,
+    signOut,
+    addEventListener: eventTarget.addEventListener.bind(eventTarget),
+    removeEventListener: eventTarget.removeEventListener.bind(eventTarget)
+  });
+  return ret;
+}
+exports.createPublicOauthClient = createPublicOauthClient;
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.cjs.map

package/build/js/index.cjs.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../../src/createPublicOauthClient.ts","../../src/throwIfError.ts"],"names":["ret"],"mappings":";AAgBA,OAAO,WAAW;AAClB,SAAS,+BAA+B,4BAA4B,aAAa,4BAA4B,qBAAqB,wCAAwC,2BAA2B,0BAA0B,mBAAmB,4BAA4B;AAC9Q,OAAO,eAAe;AACtB,SAAS,wBAAwB;;;ACHjC,SAAS,qBAAqB;AACvB,SAAS,aAAa,QAAQ;AACnC,MAAI,cAAc,MAAM,GAAG;AACzB,UAAM,IAAI,MAAM,wBAAwB,OAAO,KAAK,EAAE;AAAA,EACxD;AACA,SAAO;AACT;;;ADDA,IAAM,aAAa;AACnB,SAAS,UAAU,GAAG;AACpB,eAAa,QAAQ,YAAY,KAAK,UAAU,CAAC,CAAC;AACpD;AACA,SAAS,cAAc;AACrB,eAAa,WAAW,UAAU;AACpC;AACA,SAAS,YAAY;AACnB,SAAO,KAAK,MAAM,aAAa,QAAQ,UAAU,KAAK,IAAI;AAC5D;AAcO,SAAS,wBAAwB,WAAW,KAAK,aAAa,YAAY,WAAW,gBAAgB,OAAO,SAAS,SAAS,GAAG,SAAS,CAAC,iBAAiB,gBAAgB,GAAG,UAAU,WAAW,OAAO,UAAU,cAAc;AACxO,QAAM,mBAAmB;AAAA,IACvB,CAAC,WAAW,GAAG;AAAA,EACjB;AACA,QAAM,cAAc,IAAI,iBAAiB;AACzC,QAAM,SAAS,GAAG,IAAI,IAAI,SAAS,GAAG,CAAC;AACvC,QAAM,KAAK;AAAA,IACT,gBAAgB,GAAG,MAAM;AAAA,IACzB,wBAAwB,GAAG,MAAM;AAAA,IACjC,qBAAqB,GAAG,MAAM;AAAA,IAC9B;AAAA,EACF;AACA,QAAM,SAAS;AAAA,IACb;AAAA,IACA,4BAA4B;AAAA,EAC9B;AACA,iBAAe,GAAG,GAAG;AACnB,QAAI;AAAY,aAAO,OAAO,QAAQ,aAAa,CAAC,GAAG,IAAI,CAAC;AAAA;AAAO,aAAO,SAAS,OAAO,CAAC;AAC3F,UAAM,MAAM,GAAI;AAChB,UAAM,IAAI,MAAM,oBAAoB;AAAA,EACtC;AACA,WAAS,wBAAwB,MAAM,MAAM;AAC3C,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,IACF,IAAI;AACJ,MAAE,cAAc,QAAQ,QAAQ,IAAI,aAAa,eAAe,UAAU,KAAK,IAAI,UAAU,KAAK,IAAI;AACtG,cAAU;AAAA,MACR;AAAA,IACF,CAAC;AACD,YAAQ;AAAA,MACN;AAAA,MACA;AAAA,MACA;AAAA,MACA,YAAY,KAAK,IAAI,IAAI,aAAa;AAAA,IACxC;AACA,gBAAY,mBAAmB,MAAM,IAAI,YAAY,MAAM;AAAA,MACzD,QAAQ;AAAA,IACV,CAAC,CAAC;AACF,WAAO;AAAA,EACT;AACA,iBAAe,aAAa,oBAAoB;AAC9C,UAAM;AAAA,MACJ;AAAA,IACF,IAAI,UAAU;AACd,QAAI,CAAC,eAAe;AAClB,UAAI;AAAoB,cAAM,IAAI,MAAM,wBAAwB;AAChE;AAAA,IACF;AACA,QAAI;AAGF,aAAO,wBAAwB,aAAa,MAAM,uCAAuC,IAAI,QAAQ,MAAM,yBAAyB,IAAI,QAAQ,eAAe,gBAAgB,CAAC,CAAC,GAAG,SAAS;AAAA,IAC/L,SAAS,GAAG;AACV,UAAI,CAAC,SAAS;AAEZ,gBAAQ,KAAK,8DAA8D,CAAC;AAAA,MAC9E;AACA,kBAAY;AACZ,UAAI,oBAAoB;AACtB,cAAM,IAAI,MAAM,yBAAyB;AAAA,MAC3C;AAAA,IACF;AAAA,EACF;AACA,iBAAe,wBAAwB;AACrC,UAAM;AAAA,MACJ;AAAA,MACA;AAAA,MACA;AAAA,IACF,IAAI,UAAU;AACd,QAAI,CAAC;AAAc;AACnB,QAAI;AACF,YAAMA,OAAM,wBAAwB,aAAa,MAAM,uCAAuC,IAAI,QAAQ,MAAM,8BAA8B,IAAI,QAAQ,aAAa,qBAAqB,IAAI,QAAQ,IAAI,IAAI,OAAO,SAAS,IAAI,GAAG,KAAK,CAAC,GAAG,aAAa,cAAc,gBAAgB,CAAC,CAAC,GAAG,QAAQ;AACxS,SAAG,MAAM;AACT,aAAOA;AAAA,IACT,SAAS,GAAG;AACV,UAAI,SAAS;AAEX,gBAAQ,KAAK,qFAAqF,CAAC;AAAA,MACrG;AACA,kBAAY;AAAA,IACd;AAAA,EACF;AACA,iBAAe,wBAAwB;AACrC,QAAI,aAAa,OAAO,SAAS,SAAS,WAAW;AACnD,gBAAU;AAAA,QACR,QAAQ;AAAA,MACV,CAAC;AACD,aAAO,MAAM,GAAG,SAAS;AAAA,IAC3B;AACA,UAAM,QAAQ,oBAAoB;AAClC,UAAM,eAAe,2BAA2B;AAChD,UAAM,SAAS,UAAU,EAAE,UAAU,OAAO,SAAS,SAAS;AAC9D,cAAU;AAAA,MACR;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AACD,WAAO,SAAS,OAAO,GAAG,GAAG,sBAAsB,IAAI,IAAI,gBAAgB;AAAA,MACzE;AAAA,MACA,eAAe;AAAA,MACf;AAAA,MACA,cAAc;AAAA,MACd,gBAAgB,MAAM,2BAA2B,YAAY;AAAA,MAC7D,uBAAuB;AAAA,MACvB,OAAO,CAAC,kBAAkB,GAAG,MAAM,EAAE,KAAK,GAAG;AAAA,IAC/C,CAAC,CAAC,EAAE;AAGJ,UAAM,MAAM,GAAI;AAChB,UAAM,IAAI,MAAM,oBAAoB;AAAA,EACtC;AACA,MAAI;AACJ,WAAS,YAAY;AACnB,QAAI;AAAgB,mBAAa,cAAc;AAAA,EACjD;AACA,WAAS,oBAAoB,KAAK;AAChC,cAAU;AACV,qBAAiB,WAAW,SAAS,IAAI,OAAO,aAAa,MAAO,KAAK,GAAI;AAAA,EAC/E;AACA,QAAM,UAAU,aAAa,KAAK,YAAY,IAAI;AAClD,iBAAe,UAAU;AACvB,KAAC,QAAQ,QAAQ,IAAI,aAAa,eAAe,UAAU,OAAO,eAAe,IAAI,UAAU,KAAK,IAAI;AACxG,UAAM,SAAS,MAAM,0BAA0B,MAAM,kBAAkB,IAAI,QAAQ,MAAM,cAAc,gBAAgB,CAAC;AACxH,cAAU;AAGV,gBAAY;AACZ,YAAQ;AACR,iBAAa,MAAM;AACnB,gBAAY,mBAAmB,WAAW,IAAI,MAAM,SAAS,CAAC;AAAA,EAChE;AACA,MAAI;AACJ,iBAAe,SAAS;AACtB,QAAI,eAAe;AACjB,aAAO;AAAA,IACT;AACA,QAAI;AACF,sBAAgB,QAAQ;AACxB,aAAO,MAAM;AAAA,IACf,UAAE;AACA,sBAAgB;AAAA,IAClB;AAAA,EACF;AAEA,iBAAe,UAAU;AAEvB,WAAO,QAAS,MAAM,aAAa,KAE7B,MAAM,sBAAsB,KAE9B,MAAM,sBAAsB;AAAA,EAClC;AACA,cAAY,iBAAiB,UAAU,mBAAmB;AAC1D,cAAY,iBAAiB,WAAW,mBAAmB;AAC3D,MAAI;AACJ,QAAM,MAAM,OAAO,OAAO,eAAeA,OAAM;AAC7C,QAAI,CAAC,SAAS,KAAK,IAAI,KAAK,MAAM,YAAY;AAC5C,cAAQ,MAAM,OAAO;AAAA,IACvB;AACA,WAAO,MAAM;AAAA,EACf,GAAG;AAAA,IACD;AAAA,IACA;AAAA,IACA;AAAA,IACA,kBAAkB,YAAY,iBAAiB,KAAK,WAAW;AAAA,IAC/D,qBAAqB,YAAY,oBAAoB,KAAK,WAAW;AAAA,EACvE,CAAC;AACD,SAAO;AACT","sourcesContent":["/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport delay from \"delay\";\nimport { authorizationCodeGrantRequest, calculatePKCECodeChallenge, customFetch, generateRandomCodeVerifier, generateRandomState, processAuthorizationCodeOAuth2Response, processRevocationResponse, refreshTokenGrantRequest, revocationRequest, validateAuthResponse } from \"oauth4webapi\";\nimport invariant from \"tiny-invariant\";\nimport { TypedEventTarget } from \"typescript-event-target\";\nimport { throwIfError } from \"./throwIfError.js\";\nconst storageKey = \"asdfasdfdhjlkajhgj\";\nfunction saveLocal(x) {\n localStorage.setItem(storageKey, JSON.stringify(x));\n}\nfunction removeLocal() {\n localStorage.removeItem(storageKey);\n}\nfunction readLocal() {\n return JSON.parse(localStorage.getItem(storageKey) ?? \"{}\");\n}\n\n/**\n * @param client_id\n * @param url the base url of your foundry server\n * @param redirectUrl the url configured for redirect in the oauth configuration on the server\n * @param useHistory if true, when possible uses `history.replaceState()`, otherwise uses `window.location.assign()`\n * @param loginPage if you want a custom landing page prior to logging in, set this to that url\n * @param postLoginPage if you want to customize where you return to after a completed authentication cycle. defaults to the url when the page loaded\n * @param scopes\n * @param fetchFn\n * @param ctxPath\n * @returns {PublicOauthClient} which can be used as a token provider\n */\nexport function createPublicOauthClient(client_id, url, redirectUrl, useHistory, loginPage, postLoginPage = window.location.toString(), scopes = [\"api:read-data\", \"api:write-data\"], fetchFn = globalThis.fetch, ctxPath = \"/multipass\") {\n const oauthHttpOptions = {\n [customFetch]: fetchFn\n };\n const eventTarget = new TypedEventTarget();\n const issuer = `${new URL(ctxPath, url)}`;\n const as = {\n token_endpoint: `${issuer}/api/oauth2/token`,\n authorization_endpoint: `${issuer}/api/oauth2/authorize`,\n revocation_endpoint: `${issuer}/api/oauth2/revoke_token`,\n issuer\n };\n const client = {\n client_id,\n token_endpoint_auth_method: \"none\"\n };\n async function go(x) {\n if (useHistory) return window.history.replaceState({}, \"\", x);else window.location.assign(x);\n await delay(1000);\n throw new Error(\"Unable to redirect\");\n }\n function makeTokenAndSaveRefresh(resp, type) {\n const {\n refresh_token,\n expires_in,\n access_token\n } = resp;\n !(expires_in != null) ? process.env.NODE_ENV !== \"production\" ? invariant(false) : invariant(false) : void 0;\n saveLocal({\n refresh_token\n });\n token = {\n refresh_token,\n expires_in,\n access_token,\n expires_at: Date.now() + expires_in * 1000\n };\n eventTarget.dispatchTypedEvent(type, new CustomEvent(type, {\n detail: token\n }));\n return token;\n }\n async function maybeRefresh(expectRefreshToken) {\n const {\n refresh_token\n } = readLocal();\n if (!refresh_token) {\n if (expectRefreshToken) throw new Error(\"No refresh token found\");\n return;\n }\n try {\n // note, we dont use processRefreshTokenResponse because the mp oauth implementation\n // doesn't do refresh tokens quite right and this lets us skip the id check\n return makeTokenAndSaveRefresh(throwIfError(await processAuthorizationCodeOAuth2Response(as, client, await refreshTokenGrantRequest(as, client, refresh_token, oauthHttpOptions))), \"refresh\");\n } catch (e) {\n if (!__DEV__) {\n // eslint-disable-next-line no-console\n console.warn(\"Failed to get OAuth2 refresh token. Removing refresh token\", e);\n }\n removeLocal();\n if (expectRefreshToken) {\n throw new Error(\"Could not refresh token\");\n }\n }\n }\n async function maybeHandleAuthReturn() {\n const {\n codeVerifier,\n state,\n oldUrl\n } = readLocal();\n if (!codeVerifier) return;\n try {\n const ret = makeTokenAndSaveRefresh(throwIfError(await processAuthorizationCodeOAuth2Response(as, client, await authorizationCodeGrantRequest(as, client, throwIfError(validateAuthResponse(as, client, new URL(window.location.href), state)), redirectUrl, codeVerifier, oauthHttpOptions))), \"signIn\");\n go(oldUrl);\n return ret;\n } catch (e) {\n if (__DEV__) {\n // eslint-disable-next-line no-console\n console.warn(\"Failed to get OAuth2 token using PCKE, removing PCKE and starting a new auth flow\", e);\n }\n removeLocal();\n }\n }\n async function initiateLoginRedirect() {\n if (loginPage && window.location.href !== loginPage) {\n saveLocal({\n oldUrl: postLoginPage\n });\n return await go(loginPage);\n }\n const state = generateRandomState();\n const codeVerifier = generateRandomCodeVerifier();\n const oldUrl = readLocal().oldUrl ?? window.location.toString();\n saveLocal({\n codeVerifier,\n state,\n oldUrl\n });\n window.location.assign(`${as.authorization_endpoint}?${new URLSearchParams({\n client_id,\n response_type: \"code\",\n state,\n redirect_uri: redirectUrl,\n code_challenge: await calculatePKCECodeChallenge(codeVerifier),\n code_challenge_method: \"S256\",\n scope: [\"offline_access\", ...scopes].join(\" \")\n })}`);\n\n // Give time for redirect to happen\n await delay(1000);\n throw new Error(\"Unable to redirect\");\n }\n let refreshTimeout;\n function rmTimeout() {\n if (refreshTimeout) clearTimeout(refreshTimeout);\n }\n function restartRefreshTimer(evt) {\n rmTimeout();\n refreshTimeout = setTimeout(refresh, evt.detail.expires_in * 1000 - 60 * 1000);\n }\n const refresh = maybeRefresh.bind(globalThis, true);\n async function signOut() {\n !token ? process.env.NODE_ENV !== \"production\" ? invariant(false, \"not signed in\") : invariant(false) : void 0;\n const result = await processRevocationResponse(await revocationRequest(as, client, token.access_token, oauthHttpOptions));\n rmTimeout();\n\n // Clean up\n removeLocal();\n token = undefined;\n throwIfError(result);\n eventTarget.dispatchTypedEvent(\"signOut\", new Event(\"signOut\"));\n }\n let pendingSignIn;\n async function signIn() {\n if (pendingSignIn) {\n return pendingSignIn;\n }\n try {\n pendingSignIn = _signIn();\n return await pendingSignIn;\n } finally {\n pendingSignIn = undefined;\n }\n }\n /** Will throw if there is no token! */\n async function _signIn() {\n // 1. Check if we have a refresh token in local storage\n return token = (await maybeRefresh()\n // 2. If there is no refresh token we are likely trying to perform the callback\n ) ?? (await maybeHandleAuthReturn())\n // 3. If we haven't been able to load the token from one of the two above ways, we need to make the initial auth request\n ?? (await initiateLoginRedirect());\n }\n eventTarget.addEventListener(\"signIn\", restartRefreshTimer);\n eventTarget.addEventListener(\"refresh\", restartRefreshTimer);\n let token;\n const ret = Object.assign(async function ret() {\n if (!token || Date.now() >= token.expires_at) {\n token = await signIn();\n }\n return token.access_token;\n }, {\n signIn,\n refresh,\n signOut,\n addEventListener: eventTarget.addEventListener.bind(eventTarget),\n removeEventListener: eventTarget.removeEventListener.bind(eventTarget)\n });\n return ret;\n}","/*\n * Copyright 2024 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { isOAuth2Error } from \"oauth4webapi\";\nexport function throwIfError(result) {\n if (isOAuth2Error(result)) {\n throw new Error(`Failed to get token: ${result.error}`);\n }\n return result;\n}"]}

package/build/js/index.mjs ADDED Viewed

@@ -0,0 +1,191 @@
+import delay from 'delay';
+import { processAuthorizationCodeOAuth2Response, refreshTokenGrantRequest, processRevocationResponse, revocationRequest, isOAuth2Error, customFetch, authorizationCodeGrantRequest, validateAuthResponse, generateRandomState, generateRandomCodeVerifier, calculatePKCECodeChallenge } from 'oauth4webapi';
+import invariant from 'tiny-invariant';
+import { TypedEventTarget } from 'typescript-event-target';
+// src/createPublicOauthClient.ts
+function throwIfError(result) {
+  if (isOAuth2Error(result)) {
+    throw new Error(`Failed to get token: ${result.error}`);
+  }
+  return result;
+}
+// src/createPublicOauthClient.ts
+var storageKey = "asdfasdfdhjlkajhgj";
+function saveLocal(x) {
+  localStorage.setItem(storageKey, JSON.stringify(x));
+}
+function removeLocal() {
+  localStorage.removeItem(storageKey);
+}
+function readLocal() {
+  return JSON.parse(localStorage.getItem(storageKey) ?? "{}");
+}
+function createPublicOauthClient(client_id, url, redirectUrl, useHistory, loginPage, postLoginPage = window.location.toString(), scopes = ["api:read-data", "api:write-data"], fetchFn = globalThis.fetch, ctxPath = "/multipass") {
+  const oauthHttpOptions = {
+    [customFetch]: fetchFn
+  };
+  const eventTarget = new TypedEventTarget();
+  const issuer = `${new URL(ctxPath, url)}`;
+  const as = {
+    token_endpoint: `${issuer}/api/oauth2/token`,
+    authorization_endpoint: `${issuer}/api/oauth2/authorize`,
+    revocation_endpoint: `${issuer}/api/oauth2/revoke_token`,
+    issuer
+  };
+  const client = {
+    client_id,
+    token_endpoint_auth_method: "none"
+  };
+  async function go(x) {
+    if (useHistory)
+      return window.history.replaceState({}, "", x);
+    else
+      window.location.assign(x);
+    await delay(1e3);
+    throw new Error("Unable to redirect");
+  }
+  function makeTokenAndSaveRefresh(resp, type) {
+    const {
+      refresh_token,
+      expires_in,
+      access_token
+    } = resp;
+    !(expires_in != null) ? process.env.NODE_ENV !== "production" ? invariant(false) : invariant(false) : void 0;
+    saveLocal({
+      refresh_token
+    });
+    token = {
+      refresh_token,
+      expires_in,
+      access_token,
+      expires_at: Date.now() + expires_in * 1e3
+    };
+    eventTarget.dispatchTypedEvent(type, new CustomEvent(type, {
+      detail: token
+    }));
+    return token;
+  }
+  async function maybeRefresh(expectRefreshToken) {
+    const {
+      refresh_token
+    } = readLocal();
+    if (!refresh_token) {
+      if (expectRefreshToken)
+        throw new Error("No refresh token found");
+      return;
+    }
+    try {
+      return makeTokenAndSaveRefresh(throwIfError(await processAuthorizationCodeOAuth2Response(as, client, await refreshTokenGrantRequest(as, client, refresh_token, oauthHttpOptions))), "refresh");
+    } catch (e) {
+      if (!__DEV__) {
+        console.warn("Failed to get OAuth2 refresh token. Removing refresh token", e);
+      }
+      removeLocal();
+      if (expectRefreshToken) {
+        throw new Error("Could not refresh token");
+      }
+    }
+  }
+  async function maybeHandleAuthReturn() {
+    const {
+      codeVerifier,
+      state,
+      oldUrl
+    } = readLocal();
+    if (!codeVerifier)
+      return;
+    try {
+      const ret2 = makeTokenAndSaveRefresh(throwIfError(await processAuthorizationCodeOAuth2Response(as, client, await authorizationCodeGrantRequest(as, client, throwIfError(validateAuthResponse(as, client, new URL(window.location.href), state)), redirectUrl, codeVerifier, oauthHttpOptions))), "signIn");
+      go(oldUrl);
+      return ret2;
+    } catch (e) {
+      if (__DEV__) {
+        console.warn("Failed to get OAuth2 token using PCKE, removing PCKE and starting a new auth flow", e);
+      }
+      removeLocal();
+    }
+  }
+  async function initiateLoginRedirect() {
+    if (loginPage && window.location.href !== loginPage) {
+      saveLocal({
+        oldUrl: postLoginPage
+      });
+      return await go(loginPage);
+    }
+    const state = generateRandomState();
+    const codeVerifier = generateRandomCodeVerifier();
+    const oldUrl = readLocal().oldUrl ?? window.location.toString();
+    saveLocal({
+      codeVerifier,
+      state,
+      oldUrl
+    });
+    window.location.assign(`${as.authorization_endpoint}?${new URLSearchParams({
+      client_id,
+      response_type: "code",
+      state,
+      redirect_uri: redirectUrl,
+      code_challenge: await calculatePKCECodeChallenge(codeVerifier),
+      code_challenge_method: "S256",
+      scope: ["offline_access", ...scopes].join(" ")
+    })}`);
+    await delay(1e3);
+    throw new Error("Unable to redirect");
+  }
+  let refreshTimeout;
+  function rmTimeout() {
+    if (refreshTimeout)
+      clearTimeout(refreshTimeout);
+  }
+  function restartRefreshTimer(evt) {
+    rmTimeout();
+    refreshTimeout = setTimeout(refresh, evt.detail.expires_in * 1e3 - 60 * 1e3);
+  }
+  const refresh = maybeRefresh.bind(globalThis, true);
+  async function signOut() {
+    !token ? process.env.NODE_ENV !== "production" ? invariant(false, "not signed in") : invariant(false) : void 0;
+    const result = await processRevocationResponse(await revocationRequest(as, client, token.access_token, oauthHttpOptions));
+    rmTimeout();
+    removeLocal();
+    token = void 0;
+    throwIfError(result);
+    eventTarget.dispatchTypedEvent("signOut", new Event("signOut"));
+  }
+  let pendingSignIn;
+  async function signIn() {
+    if (pendingSignIn) {
+      return pendingSignIn;
+    }
+    try {
+      pendingSignIn = _signIn();
+      return await pendingSignIn;
+    } finally {
+      pendingSignIn = void 0;
+    }
+  }
+  async function _signIn() {
+    return token = await maybeRefresh() ?? await maybeHandleAuthReturn() ?? await initiateLoginRedirect();
+  }
+  eventTarget.addEventListener("signIn", restartRefreshTimer);
+  eventTarget.addEventListener("refresh", restartRefreshTimer);
+  let token;
+  const ret = Object.assign(async function ret2() {
+    if (!token || Date.now() >= token.expires_at) {
+      token = await signIn();
+    }
+    return token.access_token;
+  }, {
+    signIn,
+    refresh,
+    signOut,
+    addEventListener: eventTarget.addEventListener.bind(eventTarget),
+    removeEventListener: eventTarget.removeEventListener.bind(eventTarget)
+  });
+  return ret;
+}
+export { createPublicOauthClient };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=index.mjs.map

package/build/js/index.mjs.map ADDED Viewed

@@ -0,0 +1 @@

package/build/types/PublicOauthClient.d.ts ADDED Viewed

@@ -0,0 +1,15 @@
+import type { Token } from "./Token.js";
+export type Events = {
+    signIn: CustomEvent<Token>;
+    signOut: Event;
+    refresh: CustomEvent<Token>;
+};
+export interface PublicOauthClient {
+    (): Promise<string>;
+    signIn: () => Promise<Token>;
+    refresh: () => Promise<Token | undefined>;
+    signOut: () => Promise<void>;
+    addEventListener: <T extends keyof Events & string>(type: T, listener: ((evt: Events[T]) => void) | null, options?: boolean | AddEventListenerOptions) => void;
+    removeEventListener: <T extends keyof Events & string>(type: T, callback: ((evt: Events[T]) => void) | null, options?: EventListenerOptions | boolean) => void;
+}
+//# sourceMappingURL=PublicOauthClient.d.ts.map

package/build/types/PublicOauthClient.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"PublicOauthClient.d.ts","sourceRoot":"","sources":["../../src/PublicOauthClient.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAExC,MAAM,MAAM,MAAM,GAAG;IACnB,MAAM,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;IAC3B,OAAO,EAAE,KAAK,CAAC;IACf,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,WAAW,iBAAiB;IAChC,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAEpB,MAAM,EAAE,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7B,OAAO,EAAE,MAAM,OAAO,CAAC,KAAK,GAAG,SAAS,CAAC,CAAC;IAC1C,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B,gBAAgB,EAAE,CAAC,CAAC,SAAS,MAAM,MAAM,GAAG,MAAM,EAChD,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,GAAG,IAAI,EAC3C,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,KACxC,IAAI,CAAC;IAEV,mBAAmB,EAAE,CAAC,CAAC,SAAS,MAAM,MAAM,GAAG,MAAM,EACnD,IAAI,EAAE,CAAC,EACP,QAAQ,EAAE,CAAC,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,GAAG,IAAI,EAC3C,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,KACrC,IAAI,CAAC;CACX"}

package/build/types/Token.d.ts ADDED Viewed

@@ -0,0 +1,7 @@
+export interface Token {
+    readonly access_token: string;
+    readonly expires_in: number;
+    readonly refresh_token?: string;
+    readonly expires_at: number;
+}
+//# sourceMappingURL=Token.d.ts.map

package/build/types/Token.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"Token.d.ts","sourceRoot":"","sources":["../../src/Token.ts"],"names":[],"mappings":"AAgBA,MAAM,WAAW,KAAK;IACpB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B"}

package/build/types/createPublicOauthClient.d.ts ADDED Viewed

@@ -0,0 +1,15 @@
+import type { PublicOauthClient } from "./PublicOauthClient.js";
+/**
+ * @param client_id
+ * @param url the base url of your foundry server
+ * @param redirectUrl the url configured for redirect in the oauth configuration on the server
+ * @param useHistory if true, when possible uses `history.replaceState()`, otherwise uses `window.location.assign()`
+ * @param loginPage if you want a custom landing page prior to logging in, set this to that url
+ * @param postLoginPage if you want to customize where you return to after a completed authentication cycle. defaults to the url when the page loaded
+ * @param scopes
+ * @param fetchFn
+ * @param ctxPath
+ * @returns {PublicOauthClient} which can be used as a token provider
+ */
+export declare function createPublicOauthClient(client_id: string, url: string, redirectUrl: string, useHistory?: boolean, loginPage?: string, postLoginPage?: string, scopes?: string[], fetchFn?: typeof globalThis.fetch, ctxPath?: string): PublicOauthClient;
+//# sourceMappingURL=createPublicOauthClient.d.ts.map

package/build/types/createPublicOauthClient.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"createPublicOauthClient.d.ts","sourceRoot":"","sources":["../../src/createPublicOauthClient.ts"],"names":[],"mappings":"AAqCA,OAAO,KAAK,EAAU,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AA+CxE;;;;;;;;;;;GAWG;AACH,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,MAAM,EACjB,GAAG,EAAE,MAAM,EACX,WAAW,EAAE,MAAM,EACnB,UAAU,CAAC,EAAE,OAAO,EACpB,SAAS,CAAC,EAAE,MAAM,EAClB,aAAa,GAAE,MAAmC,EAClD,MAAM,GAAE,MAAM,EAAwC,EACtD,OAAO,GAAE,OAAO,UAAU,CAAC,KAAwB,EACnD,OAAO,GAAE,MAAqB,GAC7B,iBAAiB,CA0OnB"}

package/build/types/index.d.ts ADDED Viewed

@@ -0,0 +1,3 @@
+export { createPublicOauthClient } from "./createPublicOauthClient.js";
+export type { PublicOauthClient } from "./PublicOauthClient.js";
+//# sourceMappingURL=index.d.ts.map

package/build/types/index.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,YAAY,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC"}

package/build/types/throwIfError.d.ts ADDED Viewed

@@ -0,0 +1,6 @@
+import type { OAuth2Error } from "oauth4webapi";
+import { isOAuth2Error } from "oauth4webapi";
+type IsErrorInputs = Parameters<typeof isOAuth2Error>[0];
+export declare function throwIfError<T extends IsErrorInputs>(result: T | OAuth2Error): Exclude<T, OAuth2Error>;
+export {};
+//# sourceMappingURL=throwIfError.d.ts.map

package/build/types/throwIfError.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"throwIfError.d.ts","sourceRoot":"","sources":["../../src/throwIfError.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAChD,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE7C,KAAK,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;AACzD,wBAAgB,YAAY,CAAC,CAAC,SAAS,aAAa,EAClD,MAAM,EAAE,CAAC,GAAG,WAAW,GACtB,OAAO,CAAC,CAAC,EAAE,WAAW,CAAC,CAKzB"}

package/changelog/@unreleased/pr-156.v2.yml ADDED Viewed

@@ -0,0 +1,5 @@
+type: improvement
+improvement:
+  description: Public Oauth Client for v2
+  links:
+  - https://github.com/palantir/osdk-ts/pull/156

package/package.json ADDED Viewed

@@ -0,0 +1,56 @@
+{
+  "name": "@osdk/oauth",
+  "version": "0.0.0",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/palantir/osdk-ts.git"
+  },
+  "exports": {
+    ".": {
+      "types": "./build/types/index.d.ts",
+      "import": "./build/js/index.mjs",
+      "require": "./build/js/index.cjs"
+    },
+    "./*": {
+      "types": "./build/types/public/*.d.ts",
+      "import": "./build/js/public/*.mjs",
+      "require": "./build/js/public/*.cjs"
+    }
+  },
+  "dependencies": {
+    "delay": "^6.0.0",
+    "oauth4webapi": "^2.10.3",
+    "tiny-invariant": "^1.3.1",
+    "typescript-event-target": "^1.1.0"
+  },
+  "devDependencies": {
+    "jest-extended": "^4.0.2",
+    "ts-expect": "^1.3.0",
+    "type-fest": "^4.14.0",
+    "typescript": "^5.4.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "build/types",
+    "build/js",
+    "changelog",
+    "CHANGELOG_OLD.md",
+    "package.json",
+    "templates",
+    "*.d.ts"
+  ],
+  "main": "./build/js/index.cjs",
+  "module": "./build/js/index.mjs",
+  "types": "./build/types/index.d.ts",
+  "type": "module",
+  "scripts": {
+    "clean": "rm -rf lib dist types build tsconfig.tsbuildinfo",
+    "fix-lint": "eslint . --fix && dprint fmt --config $(find-up dprint.json)",
+    "lint": "eslint . && dprint check  --config $(find-up dprint.json)",
+    "transpile": "tsup",
+    "typecheck": "tsc-absolute"
+  }
+}