@osdk/oauth 1.1.0-beta.1 → 1.1.0-beta.11

package/build/esm/__tests__/createPublicOauthClient.test.js

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2024 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { createPublicOauthClient } from "@osdk/oauth";
+import * as oauthModule from "@osdk/oauth";
+import { describe, expect, it, vi } from "vitest";
+import * as utilsModule from "../utils.js";
+const originalCreatePublicOauthClient = oauthModule.createPublicOauthClient;
+const FOUNDRY_CLIENT_ID = "example-foundry-client-id";
+const FOUNDRY_URL = "http://example-foundry-url.com";
+const REDIRECT_URI = "http://localhost:8080/auth/callback";
+vi.stubGlobal("window", {
+  location: {
+    toString: vi.fn().mockReturnValue("http://example.com")
+  }
+});
+describe("createPublicOauthClient", () => {
+  it("should return the same processed options for both client creation methods", async () => {
+    const mockProcessOptionsAndAssignDefaults = vi.fn();
+
+    // Mock processOptionsAndAssignDefaults to call the mock function
+    vi.spyOn(utilsModule, "processOptionsAndAssignDefaults").mockImplementation((...args) => {
+      mockProcessOptionsAndAssignDefaults(...args);
+      return utilsModule.processOptionsAndAssignDefaults(...args);
+    });
+
+    // Mock createPublicOauthClient to call both the mock and the original function
+    vi.spyOn(oauthModule, "createPublicOauthClient").mockImplementation((...args) => {
+      const [_client_id, ...rest] = args;
+      mockProcessOptionsAndAssignDefaults(...rest);
+      return originalCreatePublicOauthClient(...args);
+    });
+    const authClient = createPublicOauthClient(FOUNDRY_CLIENT_ID, FOUNDRY_URL, REDIRECT_URI, true, undefined, undefined, undefined, fetch, undefined);
+    expect(authClient).toBeDefined();
+    expect(mockProcessOptionsAndAssignDefaults).toHaveBeenCalledTimes(1);
+    const authClientWithOptions = createPublicOauthClient(FOUNDRY_CLIENT_ID, FOUNDRY_URL, REDIRECT_URI, {
+      useHistory: true,
+      fetchFn: fetch
+    });
+    expect(authClientWithOptions).toBeDefined();
+    expect(mockProcessOptionsAndAssignDefaults).toHaveBeenCalledTimes(2);
+    const [result1, result2] = mockProcessOptionsAndAssignDefaults.mock.results;
+    expect(result1.value).toEqual(result2.value);
+  });
+});
+//# sourceMappingURL=createPublicOauthClient.test.js.map

package/build/esm/__tests__/createPublicOauthClient.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPublicOauthClient.test.js","names":["createPublicOauthClient","oauthModule","describe","expect","it","vi","utilsModule","originalCreatePublicOauthClient","FOUNDRY_CLIENT_ID","FOUNDRY_URL","REDIRECT_URI","stubGlobal","location","toString","fn","mockReturnValue","mockProcessOptionsAndAssignDefaults","spyOn","mockImplementation","args","processOptionsAndAssignDefaults","_client_id","rest","authClient","undefined","fetch","toBeDefined","toHaveBeenCalledTimes","authClientWithOptions","useHistory","fetchFn","result1","result2","mock","results","value","toEqual"],"sources":["createPublicOauthClient.test.ts"],"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 { createPublicOauthClient } from \"@osdk/oauth\";\nimport * as oauthModule from \"@osdk/oauth\";\nimport { describe, expect, it, vi } from \"vitest\";\nimport * as utilsModule from \"../utils.js\";\n\nconst originalCreatePublicOauthClient = oauthModule.createPublicOauthClient;\n\nconst FOUNDRY_CLIENT_ID = \"example-foundry-client-id\";\nconst FOUNDRY_URL = \"http://example-foundry-url.com\";\nconst REDIRECT_URI = \"http://localhost:8080/auth/callback\";\n\nvi.stubGlobal(\"window\", {\n  location: {\n    toString: vi.fn().mockReturnValue(\"http://example.com\"),\n  },\n});\n\ntype CreatePublicOauthClientParams = Parameters<typeof createPublicOauthClient>;\n\ntype ProcessedPublicOauthClientOptionsParams = Parameters<\n  typeof utilsModule.processOptionsAndAssignDefaults\n>;\n\ntype ProcessedPublicOauthClientOptionsReturn = ReturnType<\n  typeof utilsModule.processOptionsAndAssignDefaults\n>;\n\ndescribe(\"createPublicOauthClient\", () => {\n  it(\"should return the same processed options for both client creation methods\", async () => {\n    const mockProcessOptionsAndAssignDefaults = vi.fn<\n      (\n        ...args: ProcessedPublicOauthClientOptionsParams\n      ) => ProcessedPublicOauthClientOptionsReturn\n    >();\n\n    // Mock processOptionsAndAssignDefaults to call the mock function\n    vi.spyOn(utilsModule, \"processOptionsAndAssignDefaults\").mockImplementation(\n      (\n        ...args: ProcessedPublicOauthClientOptionsParams\n      ) => {\n        mockProcessOptionsAndAssignDefaults(...args);\n        return utilsModule.processOptionsAndAssignDefaults(...args);\n      },\n    );\n\n    // Mock createPublicOauthClient to call both the mock and the original function\n    vi.spyOn(oauthModule, \"createPublicOauthClient\").mockImplementation(\n      (\n        ...args: CreatePublicOauthClientParams\n      ) => {\n        const [_client_id, ...rest] = args;\n        mockProcessOptionsAndAssignDefaults(...rest);\n        return originalCreatePublicOauthClient(...args);\n      },\n    );\n\n    const authClient = createPublicOauthClient(\n      FOUNDRY_CLIENT_ID,\n      FOUNDRY_URL,\n      REDIRECT_URI,\n      true,\n      undefined,\n      undefined,\n      undefined,\n      fetch,\n      undefined,\n    );\n\n    expect(authClient).toBeDefined();\n    expect(mockProcessOptionsAndAssignDefaults).toHaveBeenCalledTimes(1);\n\n    const authClientWithOptions = createPublicOauthClient(\n      FOUNDRY_CLIENT_ID,\n      FOUNDRY_URL,\n      REDIRECT_URI,\n      {\n        useHistory: true,\n        fetchFn: fetch,\n      },\n    );\n\n    expect(authClientWithOptions).toBeDefined();\n    expect(mockProcessOptionsAndAssignDefaults).toHaveBeenCalledTimes(2);\n\n    const [result1, result2] = mockProcessOptionsAndAssignDefaults.mock.results;\n    expect(result1.value).toEqual(result2.value);\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,uBAAuB,QAAQ,aAAa;AACrD,OAAO,KAAKC,WAAW,MAAM,aAAa;AAC1C,SAASC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,QAAQ;AACjD,OAAO,KAAKC,WAAW,MAAM,aAAa;AAE1C,MAAMC,+BAA+B,GAAGN,WAAW,CAACD,uBAAuB;AAE3E,MAAMQ,iBAAiB,GAAG,2BAA2B;AACrD,MAAMC,WAAW,GAAG,gCAAgC;AACpD,MAAMC,YAAY,GAAG,qCAAqC;AAE1DL,EAAE,CAACM,UAAU,CAAC,QAAQ,EAAE;EACtBC,QAAQ,EAAE;IACRC,QAAQ,EAAER,EAAE,CAACS,EAAE,CAAC,CAAC,CAACC,eAAe,CAAC,oBAAoB;EACxD;AACF,CAAC,CAAC;AAYFb,QAAQ,CAAC,yBAAyB,EAAE,MAAM;EACxCE,EAAE,CAAC,2EAA2E,EAAE,YAAY;IAC1F,MAAMY,mCAAmC,GAAGX,EAAE,CAACS,EAAE,CAI/C,CAAC;;IAEH;IACAT,EAAE,CAACY,KAAK,CAACX,WAAW,EAAE,iCAAiC,CAAC,CAACY,kBAAkB,CACzE,CACE,GAAGC,IAA6C,KAC7C;MACHH,mCAAmC,CAAC,GAAGG,IAAI,CAAC;MAC5C,OAAOb,WAAW,CAACc,+BAA+B,CAAC,GAAGD,IAAI,CAAC;IAC7D,CACF,CAAC;;IAED;IACAd,EAAE,CAACY,KAAK,CAAChB,WAAW,EAAE,yBAAyB,CAAC,CAACiB,kBAAkB,CACjE,CACE,GAAGC,IAAmC,KACnC;MACH,MAAM,CAACE,UAAU,EAAE,GAAGC,IAAI,CAAC,GAAGH,IAAI;MAClCH,mCAAmC,CAAC,GAAGM,IAAI,CAAC;MAC5C,OAAOf,+BAA+B,CAAC,GAAGY,IAAI,CAAC;IACjD,CACF,CAAC;IAED,MAAMI,UAAU,GAAGvB,uBAAuB,CACxCQ,iBAAiB,EACjBC,WAAW,EACXC,YAAY,EACZ,IAAI,EACJc,SAAS,EACTA,SAAS,EACTA,SAAS,EACTC,KAAK,EACLD,SACF,CAAC;IAEDrB,MAAM,CAACoB,UAAU,CAAC,CAACG,WAAW,CAAC,CAAC;IAChCvB,MAAM,CAACa,mCAAmC,CAAC,CAACW,qBAAqB,CAAC,CAAC,CAAC;IAEpE,MAAMC,qBAAqB,GAAG5B,uBAAuB,CACnDQ,iBAAiB,EACjBC,WAAW,EACXC,YAAY,EACZ;MACEmB,UAAU,EAAE,IAAI;MAChBC,OAAO,EAAEL;IACX,CACF,CAAC;IAEDtB,MAAM,CAACyB,qBAAqB,CAAC,CAACF,WAAW,CAAC,CAAC;IAC3CvB,MAAM,CAACa,mCAAmC,CAAC,CAACW,qBAAqB,CAAC,CAAC,CAAC;IAEpE,MAAM,CAACI,OAAO,EAAEC,OAAO,CAAC,GAAGhB,mCAAmC,CAACiB,IAAI,CAACC,OAAO;IAC3E/B,MAAM,CAAC4B,OAAO,CAACI,KAAK,CAAC,CAACC,OAAO,CAACJ,OAAO,CAACG,KAAK,CAAC;EAC9C,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/build/esm/common.js

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import { processRevocationResponse, revocationRequest } from "oauth4webapi";
 import invariant from "tiny-invariant";
 import { TypedEventTarget } from "typescript-event-target";
@@ -29,21 +30,36 @@ const CustomEvent = globalThis.CustomEvent ?? class extends Event {
     return this.#detail;
   }
 };
-const localStorage = globalThis.localStorage;
+function localStorageKey(client) {
+  return `@osdk/oauth : refresh : ${client.client_id}`;
+}
 export function saveLocal(client, x) {
   // MUST `localStorage?` as nodejs does not have localStorage
-  localStorage?.setItem(`@osdk/oauth : refresh : ${client.client_id}`, JSON.stringify(x));
+  globalThis.localStorage?.setItem(localStorageKey(client), JSON.stringify(x));
 }
 export function removeLocal(client) {
   // MUST `localStorage?` as nodejs does not have localStorage
-  localStorage?.removeItem(`@osdk/oauth : refresh : ${client.client_id}`);
+  globalThis.localStorage?.removeItem(localStorageKey(client));
 }
 export function readLocal(client) {
   return JSON.parse(
   // MUST `localStorage?` as nodejs does not have localStorage
-  localStorage?.getItem(`@osdk/oauth : refresh : ${client.client_id}`) ?? "{}");
+  globalThis.localStorage?.getItem(localStorageKey(client)) ?? "{}");
+}
+export function saveSession(client, x) {
+  // MUST `sessionStorage?` as nodejs does not have sessionStorage
+  globalThis.sessionStorage?.setItem(localStorageKey(client), JSON.stringify(x));
+}
+export function removeSession(client) {
+  // MUST `sessionStorage?` as nodejs does not have sessionStorage
+  globalThis.sessionStorage?.removeItem(localStorageKey(client));
 }
-export function common(client, as, _signIn, oauthHttpOptions, refresh) {
+export function readSession(client) {
+  return JSON.parse(
+  // MUST `sessionStorage?` as nodejs does not have sessionStorage
+  globalThis.sessionStorage?.getItem(localStorageKey(client)) ?? "{}");
+}
+export function common(client, as, _signIn, oauthHttpOptions, refresh, refreshTokenMarker) {
   let token;
   const eventTarget = new TypedEventTarget();
   function makeTokenAndSaveRefresh(resp, type) {
@@ -54,7 +70,8 @@ export function common(client, as, _signIn, oauthHttpOptions, refresh) {
     } = resp;
     !(expires_in != null) ? process.env.NODE_ENV !== "production" ? invariant(false) : invariant(false) : void 0;
     saveLocal(client, {
-      refresh_token
+      refresh_token,
+      refreshTokenMarker
     });
     token = {
       refresh_token,
@@ -109,6 +126,7 @@ export function common(client, as, _signIn, oauthHttpOptions, refresh) {
       !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();
+
       // Clean up
       removeLocal(client);
       token = undefined;
@@ -126,7 +144,7 @@ export function common(client, as, _signIn, oauthHttpOptions, refresh) {
   };
 }
 export function createAuthorizationServer(ctxPath, url) {
-  const issuer = `${new URL(ctxPath, url)}`;
+  const issuer = `${new URL(ctxPath, url.endsWith("/") ? url : url + "/")}`;
   return {
     token_endpoint: `${issuer}/api/oauth2/token`,
     authorization_endpoint: `${issuer}/api/oauth2/authorize`,

package/build/esm/common.js.map

@@ -1 +1 @@
-{"version":3,"file":"common.js","names":["processRevocationResponse","revocationRequest","invariant","TypedEventTarget","throwIfError","CustomEvent","globalThis","Event","detail","constructor","type","options","localStorage","saveLocal","client","x","setItem","client_id","JSON","stringify","removeLocal","removeItem","readLocal","parse","getItem","common","as","_signIn","oauthHttpOptions","refresh","token","eventTarget","makeTokenAndSaveRefresh","resp","refresh_token","expires_in","access_token","process","env","NODE_ENV","expires_at","Date","now","dispatchTypedEvent","refreshTimeout","rmTimeout","clearTimeout","restartRefreshTimer","evt","setTimeout","pendingSignIn","signIn","undefined","addEventListener","getTokenOrUndefined","getToken","Object","assign","signOut","result","bind","removeEventListener","createAuthorizationServer","ctxPath","url","issuer","URL","token_endpoint","authorization_endpoint","revocation_endpoint"],"sources":["common.js"],"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 */\nimport { processRevocationResponse, revocationRequest } from \"oauth4webapi\";\nimport invariant from \"tiny-invariant\";\nimport { TypedEventTarget } from \"typescript-event-target\";\nimport { throwIfError } from \"./throwIfError.js\";\n// Node 18 is supposed to have a `CustomEvent` but it is not exposed on `globalThis`\n// which creates a problem for making a single codebase for node and browser. This polyfill works around it\nconst CustomEvent = process.env.TARGET === \"browser\"\n    ? globalThis.CustomEvent\n    : globalThis.CustomEvent\n        ?? class CustomEvent extends Event {\n            #detail;\n            constructor(type, options) {\n                super(type, options);\n                this.#detail = options?.detail ?? null;\n            }\n            get detail() {\n                return this.#detail;\n            }\n        };\nconst localStorage = globalThis.localStorage;\nexport function saveLocal(client, x) {\n    // MUST `localStorage?` as nodejs does not have localStorage\n    localStorage?.setItem(`@osdk/oauth : refresh : ${client.client_id}`, JSON.stringify(x));\n}\nexport function removeLocal(client) {\n    // MUST `localStorage?` as nodejs does not have localStorage\n    localStorage?.removeItem(`@osdk/oauth : refresh : ${client.client_id}`);\n}\nexport function readLocal(client) {\n    return JSON.parse(\n    // MUST `localStorage?` as nodejs does not have localStorage\n    localStorage?.getItem(`@osdk/oauth : refresh : ${client.client_id}`)\n        ?? \"{}\");\n}\nexport function common(client, as, _signIn, oauthHttpOptions, refresh) {\n    let token;\n    const eventTarget = new TypedEventTarget();\n    function makeTokenAndSaveRefresh(resp, type) {\n        const { refresh_token, expires_in, access_token } = resp;\n        invariant(expires_in != null);\n        saveLocal(client, { refresh_token });\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, { detail: token }));\n        return token;\n    }\n    let refreshTimeout;\n    function rmTimeout() {\n        if (refreshTimeout)\n            clearTimeout(refreshTimeout);\n    }\n    function restartRefreshTimer(evt) {\n        if (refresh) {\n            rmTimeout();\n            refreshTimeout = setTimeout(refresh, evt.detail.expires_in * 1000 - 60 * 1000);\n        }\n    }\n    async function signOut() {\n        invariant(token, \"not signed in\");\n        const result = await processRevocationResponse(await revocationRequest(as, client, token.access_token, oauthHttpOptions));\n        rmTimeout();\n        // Clean up\n        removeLocal(client);\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        }\n        finally {\n            pendingSignIn = undefined;\n        }\n    }\n    eventTarget.addEventListener(\"signIn\", restartRefreshTimer);\n    eventTarget.addEventListener(\"refresh\", restartRefreshTimer);\n    function getTokenOrUndefined() {\n        if (!token || Date.now() >= token.expires_at) {\n            return undefined;\n        }\n        return token?.access_token;\n    }\n    const getToken = Object.assign(async function getToken() {\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        rmTimeout,\n        getTokenOrUndefined,\n        addEventListener: eventTarget.addEventListener.bind(eventTarget),\n        removeEventListener: eventTarget.removeEventListener.bind(eventTarget),\n    });\n    return { getToken, makeTokenAndSaveRefresh };\n}\nexport function createAuthorizationServer(ctxPath, url) {\n    const issuer = `${new URL(ctxPath, url)}`;\n    return {\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}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,yBAAyB,EAAEC,iBAAiB,QAAQ,cAAc;AAC3E,OAAOC,SAAS,MAAM,gBAAgB;AACtC,SAASC,gBAAgB,QAAQ,yBAAyB;AAC1D,SAASC,YAAY,QAAQ,mBAAmB;AAChD;AACA;AACA,MAAMC,WAAW,GAEXC,UAAU,CAACD,WAAW,IACjB,cAA0BE,KAAK,CAAC;EAC/B,CAACC,MAAM;EACPC,WAAWA,CAACC,IAAI,EAAEC,OAAO,EAAE;IACvB,KAAK,CAACD,IAAI,EAAEC,OAAO,CAAC;IACpB,IAAI,CAAC,CAACH,MAAM,GAAGG,OAAO,EAAEH,MAAM,IAAI,IAAI;EAC1C;EACA,IAAIA,MAAMA,CAAA,EAAG;IACT,OAAO,IAAI,CAAC,CAACA,MAAM;EACvB;AACJ,CAAC;AACT,MAAMI,YAAY,GAAGN,UAAU,CAACM,YAAY;AAC5C,OAAO,SAASC,SAASA,CAACC,MAAM,EAAEC,CAAC,EAAE;EACjC;EACAH,YAAY,EAAEI,OAAO,CAAC,2BAA2BF,MAAM,CAACG,SAAS,EAAE,EAAEC,IAAI,CAACC,SAAS,CAACJ,CAAC,CAAC,CAAC;AAC3F;AACA,OAAO,SAASK,WAAWA,CAACN,MAAM,EAAE;EAChC;EACAF,YAAY,EAAES,UAAU,CAAC,2BAA2BP,MAAM,CAACG,SAAS,EAAE,CAAC;AAC3E;AACA,OAAO,SAASK,SAASA,CAACR,MAAM,EAAE;EAC9B,OAAOI,IAAI,CAACK,KAAK;EACjB;EACAX,YAAY,EAAEY,OAAO,CAAC,2BAA2BV,MAAM,CAACG,SAAS,EAAE,CAAC,IAC7D,IAAI,CAAC;AAChB;AACA,OAAO,SAASQ,MAAMA,CAACX,MAAM,EAAEY,EAAE,EAAEC,OAAO,EAAEC,gBAAgB,EAAEC,OAAO,EAAE;EACnE,IAAIC,KAAK;EACT,MAAMC,WAAW,GAAG,IAAI5B,gBAAgB,CAAC,CAAC;EAC1C,SAAS6B,uBAAuBA,CAACC,IAAI,EAAEvB,IAAI,EAAE;IACzC,MAAM;MAAEwB,aAAa;MAAEC,UAAU;MAAEC;IAAa,CAAC,GAAGH,IAAI;IACxD,EAAUE,UAAU,IAAI,IAAI,IAAAE,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAA5BrC,SAAS,UAATA,SAAS;IACTW,SAAS,CAACC,MAAM,EAAE;MAAEoB;IAAc,CAAC,CAAC;IACpCJ,KAAK,GAAG;MACJI,aAAa;MACbC,UAAU;MACVC,YAAY;MACZI,UAAU,EAAEC,IAAI,CAACC,GAAG,CAAC,CAAC,GAAGP,UAAU,GAAG;IAC1C,CAAC;IACDJ,WAAW,CAACY,kBAAkB,CAACjC,IAAI,EAAE,IAAIL,WAAW,CAACK,IAAI,EAAE;MAAEF,MAAM,EAAEsB;IAAM,CAAC,CAAC,CAAC;IAC9E,OAAOA,KAAK;EAChB;EACA,IAAIc,cAAc;EAClB,SAASC,SAASA,CAAA,EAAG;IACjB,IAAID,cAAc,EACdE,YAAY,CAACF,cAAc,CAAC;EACpC;EACA,SAASG,mBAAmBA,CAACC,GAAG,EAAE;IAC9B,IAAInB,OAAO,EAAE;MACTgB,SAAS,CAAC,CAAC;MACXD,cAAc,GAAGK,UAAU,CAACpB,OAAO,EAAEmB,GAAG,CAACxC,MAAM,CAAC2B,UAAU,GAAG,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC;IAClF;EACJ;EAWA,IAAIe,aAAa;EACjB,eAAeC,MAAMA,CAAA,EAAG;IACpB,IAAID,aAAa,EAAE;MACf,OAAOA,aAAa;IACxB;IACA,IAAI;MACAA,aAAa,GAAGvB,OAAO,CAAC,CAAC;MACzB,OAAO,MAAMuB,aAAa;IAC9B,CAAC,SACO;MACJA,aAAa,GAAGE,SAAS;IAC7B;EACJ;EACArB,WAAW,CAACsB,gBAAgB,CAAC,QAAQ,EAAEN,mBAAmB,CAAC;EAC3DhB,WAAW,CAACsB,gBAAgB,CAAC,SAAS,EAAEN,mBAAmB,CAAC;EAC5D,SAASO,mBAAmBA,CAAA,EAAG;IAC3B,IAAI,CAACxB,KAAK,IAAIW,IAAI,CAACC,GAAG,CAAC,CAAC,IAAIZ,KAAK,CAACU,UAAU,EAAE;MAC1C,OAAOY,SAAS;IACpB;IACA,OAAOtB,KAAK,EAAEM,YAAY;EAC9B;EACA,MAAMmB,QAAQ,GAAGC,MAAM,CAACC,MAAM,CAAC,eAAeF,QAAQA,CAAA,EAAG;IACrD,IAAI,CAACzB,KAAK,IAAIW,IAAI,CAACC,GAAG,CAAC,CAAC,IAAIZ,KAAK,CAACU,UAAU,EAAE;MAC1CV,KAAK,GAAG,MAAMqB,MAAM,CAAC,CAAC;IAC1B;IACA,OAAOrB,KAAK,EAAEM,YAAY;EAC9B,CAAC,EAAE;IACCe,MAAM;IACNtB,OAAO;IACP6B,OAAO,EAvCX,eAAeA,OAAOA,CAAA,EAAG;MACrB,CAAU5B,KAAK,GAAAO,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAfrC,SAAS,QAAQ,eAAe,IAAhCA,SAAS;MACT,MAAMyD,MAAM,GAAG,MAAM3D,yBAAyB,CAAC,MAAMC,iBAAiB,CAACyB,EAAE,EAAEZ,MAAM,EAAEgB,KAAK,CAACM,YAAY,EAAER,gBAAgB,CAAC,CAAC;MACzHiB,SAAS,CAAC,CAAC;MACX;MACAzB,WAAW,CAACN,MAAM,CAAC;MACnBgB,KAAK,GAAGsB,SAAS;MACjBhD,YAAY,CAACuD,MAAM,CAAC;MACpB5B,WAAW,CAACY,kBAAkB,CAAC,SAAS,EAAE,IAAIpC,KAAK,CAAC,SAAS,CAAC,CAAC;IACnE,CA8BW;IACPsC,SAAS;IACTS,mBAAmB;IACnBD,gBAAgB,EAAEtB,WAAW,CAACsB,gBAAgB,CAACO,IAAI,CAAC7B,WAAW,CAAC;IAChE8B,mBAAmB,EAAE9B,WAAW,CAAC8B,mBAAmB,CAACD,IAAI,CAAC7B,WAAW;EACzE,CAAC,CAAC;EACF,OAAO;IAAEwB,QAAQ;IAAEvB;EAAwB,CAAC;AAChD;AACA,OAAO,SAAS8B,yBAAyBA,CAACC,OAAO,EAAEC,GAAG,EAAE;EACpD,MAAMC,MAAM,GAAG,GAAG,IAAIC,GAAG,CAACH,OAAO,EAAEC,GAAG,CAAC,EAAE;EACzC,OAAO;IACHG,cAAc,EAAE,GAAGF,MAAM,mBAAmB;IAC5CG,sBAAsB,EAAE,GAAGH,MAAM,uBAAuB;IACxDI,mBAAmB,EAAE,GAAGJ,MAAM,0BAA0B;IACxDA;EACJ,CAAC;AACL","ignoreList":[]}
+{"version":3,"file":"common.js","names":["processRevocationResponse","revocationRequest","invariant","TypedEventTarget","throwIfError","CustomEvent","globalThis","Event","detail","constructor","type","options","localStorageKey","client","client_id","saveLocal","x","localStorage","setItem","JSON","stringify","removeLocal","removeItem","readLocal","parse","getItem","saveSession","sessionStorage","removeSession","readSession","common","as","_signIn","oauthHttpOptions","refresh","refreshTokenMarker","token","eventTarget","makeTokenAndSaveRefresh","resp","refresh_token","expires_in","access_token","process","env","NODE_ENV","expires_at","Date","now","dispatchTypedEvent","refreshTimeout","rmTimeout","clearTimeout","restartRefreshTimer","evt","setTimeout","pendingSignIn","signIn","undefined","addEventListener","getTokenOrUndefined","getToken","Object","assign","signOut","result","bind","removeEventListener","createAuthorizationServer","ctxPath","url","issuer","URL","endsWith","token_endpoint","authorization_endpoint","revocation_endpoint"],"sources":["common.ts"],"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 type {\n  AuthorizationServer,\n  Client,\n  HttpRequestOptions,\n  OAuth2TokenEndpointResponse,\n} from \"oauth4webapi\";\nimport { processRevocationResponse, revocationRequest } from \"oauth4webapi\";\nimport invariant from \"tiny-invariant\";\nimport { TypedEventTarget } from \"typescript-event-target\";\nimport type { BaseOauthClient, Events } from \"./BaseOauthClient.js\";\nimport { throwIfError } from \"./throwIfError.js\";\nimport type { Token } from \"./Token.js\";\n\n// Node 18 is supposed to have a `CustomEvent` but it is not exposed on `globalThis`\n// which creates a problem for making a single codebase for node and browser. This polyfill works around it\nconst CustomEvent = process.env.TARGET === \"browser\"\n  ? globalThis.CustomEvent\n  : globalThis.CustomEvent\n    ?? class CustomEvent<T> extends Event {\n      #detail: T | null;\n\n      constructor(type: string, options: EventInit & { detail: T }) {\n        super(type, options);\n        this.#detail = options?.detail ?? null;\n      }\n\n      get detail() {\n        return this.#detail;\n      }\n    };\n\ndeclare const process: {\n  env: Record<string, string | undefined>;\n};\n\nexport interface LocalStorageState {\n  refresh_token?: string;\n  refreshTokenMarker?: string;\n}\n\nexport type SessionStorageState =\n  // when we are going to the login page\n  | {\n    codeVerifier?: never;\n    state?: never;\n    oldUrl: string;\n  }\n  // when we are redirecting to oauth login\n  | {\n    codeVerifier: string;\n    state: string;\n    oldUrl: string;\n  }\n  // when we have the refresh token\n  | {\n    codeVerifier?: never;\n    state?: never;\n    oldUrl?: never;\n  };\n\nfunction localStorageKey(client: Client) {\n  return `@osdk/oauth : refresh : ${client.client_id}`;\n}\n\nexport function saveLocal(client: Client, x: LocalStorageState): void {\n  // MUST `localStorage?` as nodejs does not have localStorage\n  globalThis.localStorage?.setItem(\n    localStorageKey(client),\n    JSON.stringify(x),\n  );\n}\n\nexport function removeLocal(client: Client): void {\n  // MUST `localStorage?` as nodejs does not have localStorage\n  globalThis.localStorage?.removeItem(\n    localStorageKey(client),\n  );\n}\n\nexport function readLocal(client: Client): LocalStorageState {\n  return JSON.parse(\n    // MUST `localStorage?` as nodejs does not have localStorage\n    globalThis.localStorage?.getItem(\n      localStorageKey(client),\n    )\n      ?? \"{}\",\n  );\n}\n\nexport function saveSession(client: Client, x: SessionStorageState): void {\n  // MUST `sessionStorage?` as nodejs does not have sessionStorage\n  globalThis.sessionStorage?.setItem(\n    localStorageKey(client),\n    JSON.stringify(x),\n  );\n}\n\nexport function removeSession(client: Client): void {\n  // MUST `sessionStorage?` as nodejs does not have sessionStorage\n  globalThis.sessionStorage?.removeItem(\n    localStorageKey(client),\n  );\n}\n\nexport function readSession(client: Client): SessionStorageState {\n  return JSON.parse(\n    // MUST `sessionStorage?` as nodejs does not have sessionStorage\n    globalThis.sessionStorage?.getItem(\n      localStorageKey(client),\n    )\n      ?? \"{}\",\n  );\n}\n\nexport function common<\n  R extends undefined | (() => Promise<Token | undefined>),\n>(\n  client: Client,\n  as: AuthorizationServer,\n  _signIn: () => Promise<Token>,\n  oauthHttpOptions: HttpRequestOptions,\n  refresh: R,\n  refreshTokenMarker: string | undefined,\n): {\n  getToken: BaseOauthClient<keyof Events & string> & { refresh: R };\n  makeTokenAndSaveRefresh: (\n    resp: OAuth2TokenEndpointResponse,\n    type: \"signIn\" | \"refresh\",\n  ) => Token;\n} {\n  let token: Token | undefined;\n  const eventTarget = new TypedEventTarget<Events>();\n\n  function makeTokenAndSaveRefresh(\n    resp: OAuth2TokenEndpointResponse,\n    type: \"signIn\" | \"refresh\",\n  ): Token {\n    const { refresh_token, expires_in, access_token } = resp;\n    invariant(expires_in != null);\n    saveLocal(client, {\n      refresh_token,\n      refreshTokenMarker,\n    });\n    token = {\n      refresh_token,\n      expires_in,\n      access_token,\n      expires_at: Date.now() + expires_in * 1000,\n    };\n\n    eventTarget.dispatchTypedEvent(\n      type,\n      new CustomEvent(\n        type,\n        { detail: token },\n      ),\n    );\n    return token;\n  }\n\n  let refreshTimeout: ReturnType<typeof setTimeout>;\n  function rmTimeout() {\n    if (refreshTimeout) clearTimeout(refreshTimeout);\n  }\n  function restartRefreshTimer(evt: CustomEvent<Token>) {\n    if (refresh) {\n      rmTimeout();\n      refreshTimeout = setTimeout(\n        refresh,\n        evt.detail.expires_in * 1000 - 60 * 1000,\n      );\n    }\n  }\n\n  async function signOut() {\n    invariant(token, \"not signed in\");\n\n    const result = await processRevocationResponse(\n      await revocationRequest(\n        as,\n        client,\n        token.access_token,\n        oauthHttpOptions,\n      ),\n    );\n\n    rmTimeout();\n\n    // Clean up\n    removeLocal(client);\n    token = undefined;\n    throwIfError(result);\n    eventTarget.dispatchTypedEvent(\"signOut\", new Event(\"signOut\"));\n  }\n\n  let pendingSignIn: Promise<Token> | undefined;\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\n  eventTarget.addEventListener(\"signIn\", restartRefreshTimer);\n  eventTarget.addEventListener(\"refresh\", restartRefreshTimer);\n\n  function getTokenOrUndefined() {\n    if (!token || Date.now() >= token.expires_at) {\n      return undefined;\n    }\n    return token?.access_token;\n  }\n\n  const getToken = Object.assign(async function getToken() {\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    rmTimeout,\n    getTokenOrUndefined,\n    addEventListener: eventTarget.addEventListener.bind(\n      eventTarget,\n    ) as typeof eventTarget.addEventListener,\n    removeEventListener: eventTarget.removeEventListener.bind(\n      eventTarget,\n    ) as typeof eventTarget.removeEventListener,\n  });\n\n  return { getToken, makeTokenAndSaveRefresh };\n}\n\nexport function createAuthorizationServer(\n  ctxPath: string,\n  url: string,\n): Required<\n  Pick<\n    AuthorizationServer,\n    | \"issuer\"\n    | \"token_endpoint\"\n    | \"authorization_endpoint\"\n    | \"revocation_endpoint\"\n  >\n> {\n  const issuer = `${new URL(ctxPath, url.endsWith(\"/\") ? url : url + \"/\")}`;\n  return {\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}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA,SAASA,yBAAyB,EAAEC,iBAAiB,QAAQ,cAAc;AAC3E,OAAOC,SAAS,MAAM,gBAAgB;AACtC,SAASC,gBAAgB,QAAQ,yBAAyB;AAE1D,SAASC,YAAY,QAAQ,mBAAmB;AAGhD;AACA;AACA,MAAMC,WAAW,GAEbC,UAAU,CAACD,WAAW,IACnB,cAA6BE,KAAK,CAAC;EACpC,CAACC,MAAM;EAEPC,WAAWA,CAACC,IAAY,EAAEC,OAAkC,EAAE;IAC5D,KAAK,CAACD,IAAI,EAAEC,OAAO,CAAC;IACpB,IAAI,CAAC,CAACH,MAAM,GAAGG,OAAO,EAAEH,MAAM,IAAI,IAAI;EACxC;EAEA,IAAIA,MAAMA,CAAA,EAAG;IACX,OAAO,IAAI,CAAC,CAACA,MAAM;EACrB;AACF,CAAC;AA+BL,SAASI,eAAeA,CAACC,MAAc,EAAE;EACvC,OAAO,2BAA2BA,MAAM,CAACC,SAAS,EAAE;AACtD;AAEA,OAAO,SAASC,SAASA,CAACF,MAAc,EAAEG,CAAoB,EAAQ;EACpE;EACAV,UAAU,CAACW,YAAY,EAAEC,OAAO,CAC9BN,eAAe,CAACC,MAAM,CAAC,EACvBM,IAAI,CAACC,SAAS,CAACJ,CAAC,CAClB,CAAC;AACH;AAEA,OAAO,SAASK,WAAWA,CAACR,MAAc,EAAQ;EAChD;EACAP,UAAU,CAACW,YAAY,EAAEK,UAAU,CACjCV,eAAe,CAACC,MAAM,CACxB,CAAC;AACH;AAEA,OAAO,SAASU,SAASA,CAACV,MAAc,EAAqB;EAC3D,OAAOM,IAAI,CAACK,KAAK;EACf;EACAlB,UAAU,CAACW,YAAY,EAAEQ,OAAO,CAC9Bb,eAAe,CAACC,MAAM,CACxB,CAAC,IACI,IACP,CAAC;AACH;AAEA,OAAO,SAASa,WAAWA,CAACb,MAAc,EAAEG,CAAsB,EAAQ;EACxE;EACAV,UAAU,CAACqB,cAAc,EAAET,OAAO,CAChCN,eAAe,CAACC,MAAM,CAAC,EACvBM,IAAI,CAACC,SAAS,CAACJ,CAAC,CAClB,CAAC;AACH;AAEA,OAAO,SAASY,aAAaA,CAACf,MAAc,EAAQ;EAClD;EACAP,UAAU,CAACqB,cAAc,EAAEL,UAAU,CACnCV,eAAe,CAACC,MAAM,CACxB,CAAC;AACH;AAEA,OAAO,SAASgB,WAAWA,CAAChB,MAAc,EAAuB;EAC/D,OAAOM,IAAI,CAACK,KAAK;EACf;EACAlB,UAAU,CAACqB,cAAc,EAAEF,OAAO,CAChCb,eAAe,CAACC,MAAM,CACxB,CAAC,IACI,IACP,CAAC;AACH;AAEA,OAAO,SAASiB,MAAMA,CAGpBjB,MAAc,EACdkB,EAAuB,EACvBC,OAA6B,EAC7BC,gBAAoC,EACpCC,OAAU,EACVC,kBAAsC,EAOtC;EACA,IAAIC,KAAwB;EAC5B,MAAMC,WAAW,GAAG,IAAIlC,gBAAgB,CAAS,CAAC;EAElD,SAASmC,uBAAuBA,CAC9BC,IAAiC,EACjC7B,IAA0B,EACnB;IACP,MAAM;MAAE8B,aAAa;MAAEC,UAAU;MAAEC;IAAa,CAAC,GAAGH,IAAI;IACxD,EAAUE,UAAU,IAAI,IAAI,IAAAE,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAA5B3C,SAAS,UAATA,SAAS;IACTa,SAAS,CAACF,MAAM,EAAE;MAChB2B,aAAa;MACbL;IACF,CAAC,CAAC;IACFC,KAAK,GAAG;MACNI,aAAa;MACbC,UAAU;MACVC,YAAY;MACZI,UAAU,EAAEC,IAAI,CAACC,GAAG,CAAC,CAAC,GAAGP,UAAU,GAAG;IACxC,CAAC;IAEDJ,WAAW,CAACY,kBAAkB,CAC5BvC,IAAI,EACJ,IAAIL,WAAW,CACbK,IAAI,EACJ;MAAEF,MAAM,EAAE4B;IAAM,CAClB,CACF,CAAC;IACD,OAAOA,KAAK;EACd;EAEA,IAAIc,cAA6C;EACjD,SAASC,SAASA,CAAA,EAAG;IACnB,IAAID,cAAc,EAAEE,YAAY,CAACF,cAAc,CAAC;EAClD;EACA,SAASG,mBAAmBA,CAACC,GAAuB,EAAE;IACpD,IAAIpB,OAAO,EAAE;MACXiB,SAAS,CAAC,CAAC;MACXD,cAAc,GAAGK,UAAU,CACzBrB,OAAO,EACPoB,GAAG,CAAC9C,MAAM,CAACiC,UAAU,GAAG,IAAI,GAAG,EAAE,GAAG,IACtC,CAAC;IACH;EACF;EAuBA,IAAIe,aAAyC;EAC7C,eAAeC,MAAMA,CAAA,EAAG;IACtB,IAAID,aAAa,EAAE;MACjB,OAAOA,aAAa;IACtB;IACA,IAAI;MACFA,aAAa,GAAGxB,OAAO,CAAC,CAAC;MACzB,OAAO,MAAMwB,aAAa;IAC5B,CAAC,SAAS;MACRA,aAAa,GAAGE,SAAS;IAC3B;EACF;EAEArB,WAAW,CAACsB,gBAAgB,CAAC,QAAQ,EAAEN,mBAAmB,CAAC;EAC3DhB,WAAW,CAACsB,gBAAgB,CAAC,SAAS,EAAEN,mBAAmB,CAAC;EAE5D,SAASO,mBAAmBA,CAAA,EAAG;IAC7B,IAAI,CAACxB,KAAK,IAAIW,IAAI,CAACC,GAAG,CAAC,CAAC,IAAIZ,KAAK,CAACU,UAAU,EAAE;MAC5C,OAAOY,SAAS;IAClB;IACA,OAAOtB,KAAK,EAAEM,YAAY;EAC5B;EAEA,MAAMmB,QAAQ,GAAGC,MAAM,CAACC,MAAM,CAAC,eAAeF,QAAQA,CAAA,EAAG;IACvD,IAAI,CAACzB,KAAK,IAAIW,IAAI,CAACC,GAAG,CAAC,CAAC,IAAIZ,KAAK,CAACU,UAAU,EAAE;MAC5CV,KAAK,GAAG,MAAMqB,MAAM,CAAC,CAAC;IACxB;IACA,OAAOrB,KAAK,EAAEM,YAAY;EAC5B,CAAC,EAAE;IACDe,MAAM;IACNvB,OAAO;IACP8B,OAAO,EApDT,eAAeA,OAAOA,CAAA,EAAG;MACvB,CAAU5B,KAAK,GAAAO,OAAA,CAAAC,GAAA,CAAAC,QAAA,oBAAf3C,SAAS,QAAQ,eAAe,IAAhCA,SAAS;MAET,MAAM+D,MAAM,GAAG,MAAMjE,yBAAyB,CAC5C,MAAMC,iBAAiB,CACrB8B,EAAE,EACFlB,MAAM,EACNuB,KAAK,CAACM,YAAY,EAClBT,gBACF,CACF,CAAC;MAEDkB,SAAS,CAAC,CAAC;;MAEX;MACA9B,WAAW,CAACR,MAAM,CAAC;MACnBuB,KAAK,GAAGsB,SAAS;MACjBtD,YAAY,CAAC6D,MAAM,CAAC;MACpB5B,WAAW,CAACY,kBAAkB,CAAC,SAAS,EAAE,IAAI1C,KAAK,CAAC,SAAS,CAAC,CAAC;IACjE,CAiCS;IACP4C,SAAS;IACTS,mBAAmB;IACnBD,gBAAgB,EAAEtB,WAAW,CAACsB,gBAAgB,CAACO,IAAI,CACjD7B,WACF,CAAwC;IACxC8B,mBAAmB,EAAE9B,WAAW,CAAC8B,mBAAmB,CAACD,IAAI,CACvD7B,WACF;EACF,CAAC,CAAC;EAEF,OAAO;IAAEwB,QAAQ;IAAEvB;EAAwB,CAAC;AAC9C;AAEA,OAAO,SAAS8B,yBAAyBA,CACvCC,OAAe,EACfC,GAAW,EASX;EACA,MAAMC,MAAM,GAAG,GAAG,IAAIC,GAAG,CAACH,OAAO,EAAEC,GAAG,CAACG,QAAQ,CAAC,GAAG,CAAC,GAAGH,GAAG,GAAGA,GAAG,GAAG,GAAG,CAAC,EAAE;EACzE,OAAO;IACLI,cAAc,EAAE,GAAGH,MAAM,mBAAmB;IAC5CI,sBAAsB,EAAE,GAAGJ,MAAM,uBAAuB;IACxDK,mBAAmB,EAAE,GAAGL,MAAM,0BAA0B;IACxDA;EACF,CAAC;AACH","ignoreList":[]}

package/build/esm/common.test.js

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2025 Palantir Technologies, Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { common, createAuthorizationServer, readLocal, removeLocal, saveLocal } from "./common.js";
+describe("local functions", () => {
+  beforeEach(() => {
+    vi.stubGlobal("localStorage", {
+      setItem: vi.fn(),
+      removeItem: vi.fn(),
+      getItem: vi.fn()
+    });
+  });
+  afterEach(() => {
+    vi.unstubAllGlobals();
+  });
+  it("should use the old style keys when there is no refresh token marker", () => {
+    const client = {
+      client_id: "hi_mom",
+      $refreshTokenMarker: undefined
+    };
+    const oldLocalStorageKey = `@osdk/oauth : refresh : ${client.client_id}`;
+    readLocal(client);
+    removeLocal(client);
+    saveLocal(client, {});
+    expect(vi.mocked(globalThis.localStorage.getItem)).toBeCalledWith(oldLocalStorageKey);
+    expect(vi.mocked(globalThis.localStorage.setItem)).toBeCalledWith(oldLocalStorageKey, expect.anything());
+    expect(vi.mocked(globalThis.localStorage.removeItem)).toBeCalledWith(oldLocalStorageKey);
+  });
+  it("should save the refreshTokenMaker if it exists", () => {
+    const client = {
+      client_id: "hi_mom"
+    };
+    const signIn = vi.fn();
+    const refresh = vi.fn();
+    const authServer = createAuthorizationServer("multipass", "https://stack.palantir.com");
+    const {
+      makeTokenAndSaveRefresh
+    } = common(client, authServer, signIn, {}, refresh, "marker marker");
+    makeTokenAndSaveRefresh({
+      refresh_token: "refresh",
+      access_token: "access",
+      token_type: "idk",
+      expires_in: 10_000
+    }, "signIn");
+    expect(globalThis.localStorage.setItem).toBeCalledWith(`@osdk/oauth : refresh : ${client.client_id}`, JSON.stringify({
+      refresh_token: "refresh",
+      refreshTokenMarker: "marker marker"
+    }));
+  });
+});
+//# sourceMappingURL=common.test.js.map

package/build/esm/common.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.test.js","names":["afterEach","beforeEach","describe","expect","it","vi","common","createAuthorizationServer","readLocal","removeLocal","saveLocal","stubGlobal","setItem","fn","removeItem","getItem","unstubAllGlobals","client","client_id","$refreshTokenMarker","undefined","oldLocalStorageKey","mocked","globalThis","localStorage","toBeCalledWith","anything","signIn","refresh","authServer","makeTokenAndSaveRefresh","refresh_token","access_token","token_type","expires_in","JSON","stringify","refreshTokenMarker"],"sources":["common.test.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { afterEach, beforeEach, describe, expect, it, vi } from \"vitest\";\nimport {\n  common,\n  createAuthorizationServer,\n  readLocal,\n  removeLocal,\n  saveLocal,\n} from \"./common.js\";\n\ndescribe(\"local functions\", () => {\n  beforeEach(() => {\n    vi.stubGlobal(\"localStorage\", {\n      setItem: vi.fn(),\n      removeItem: vi.fn(),\n      getItem: vi.fn(),\n    });\n  });\n\n  afterEach(() => {\n    vi.unstubAllGlobals();\n  });\n\n  it(\"should use the old style keys when there is no refresh token marker\", () => {\n    const client = {\n      client_id: \"hi_mom\",\n      $refreshTokenMarker: undefined,\n    };\n\n    const oldLocalStorageKey = `@osdk/oauth : refresh : ${client.client_id}`;\n\n    readLocal(client);\n    removeLocal(client);\n    saveLocal(client, {});\n\n    expect(vi.mocked(globalThis.localStorage.getItem)).toBeCalledWith(\n      oldLocalStorageKey,\n    );\n\n    expect(vi.mocked(globalThis.localStorage.setItem)).toBeCalledWith(\n      oldLocalStorageKey,\n      expect.anything(),\n    );\n\n    expect(vi.mocked(globalThis.localStorage.removeItem)).toBeCalledWith(\n      oldLocalStorageKey,\n    );\n  });\n\n  it(\"should save the refreshTokenMaker if it exists\", () => {\n    const client = {\n      client_id: \"hi_mom\",\n    };\n\n    const signIn = vi.fn();\n    const refresh = vi.fn();\n\n    const authServer = createAuthorizationServer(\n      \"multipass\",\n      \"https://stack.palantir.com\",\n    );\n\n    const { makeTokenAndSaveRefresh } = common(\n      client,\n      authServer,\n      signIn,\n      {},\n      refresh,\n      \"marker marker\",\n    );\n\n    makeTokenAndSaveRefresh({\n      refresh_token: \"refresh\",\n      access_token: \"access\",\n      token_type: \"idk\",\n      expires_in: 10_000,\n    }, \"signIn\");\n\n    expect(globalThis.localStorage.setItem).toBeCalledWith(\n      `@osdk/oauth : refresh : ${client.client_id}`,\n      JSON.stringify({\n        refresh_token: \"refresh\",\n        refreshTokenMarker: \"marker marker\",\n      }),\n    );\n  });\n});\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,SAAS,EAAEC,UAAU,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,EAAE,EAAEC,EAAE,QAAQ,QAAQ;AACxE,SACEC,MAAM,EACNC,yBAAyB,EACzBC,SAAS,EACTC,WAAW,EACXC,SAAS,QACJ,aAAa;AAEpBR,QAAQ,CAAC,iBAAiB,EAAE,MAAM;EAChCD,UAAU,CAAC,MAAM;IACfI,EAAE,CAACM,UAAU,CAAC,cAAc,EAAE;MAC5BC,OAAO,EAAEP,EAAE,CAACQ,EAAE,CAAC,CAAC;MAChBC,UAAU,EAAET,EAAE,CAACQ,EAAE,CAAC,CAAC;MACnBE,OAAO,EAAEV,EAAE,CAACQ,EAAE,CAAC;IACjB,CAAC,CAAC;EACJ,CAAC,CAAC;EAEFb,SAAS,CAAC,MAAM;IACdK,EAAE,CAACW,gBAAgB,CAAC,CAAC;EACvB,CAAC,CAAC;EAEFZ,EAAE,CAAC,qEAAqE,EAAE,MAAM;IAC9E,MAAMa,MAAM,GAAG;MACbC,SAAS,EAAE,QAAQ;MACnBC,mBAAmB,EAAEC;IACvB,CAAC;IAED,MAAMC,kBAAkB,GAAG,2BAA2BJ,MAAM,CAACC,SAAS,EAAE;IAExEV,SAAS,CAACS,MAAM,CAAC;IACjBR,WAAW,CAACQ,MAAM,CAAC;IACnBP,SAAS,CAACO,MAAM,EAAE,CAAC,CAAC,CAAC;IAErBd,MAAM,CAACE,EAAE,CAACiB,MAAM,CAACC,UAAU,CAACC,YAAY,CAACT,OAAO,CAAC,CAAC,CAACU,cAAc,CAC/DJ,kBACF,CAAC;IAEDlB,MAAM,CAACE,EAAE,CAACiB,MAAM,CAACC,UAAU,CAACC,YAAY,CAACZ,OAAO,CAAC,CAAC,CAACa,cAAc,CAC/DJ,kBAAkB,EAClBlB,MAAM,CAACuB,QAAQ,CAAC,CAClB,CAAC;IAEDvB,MAAM,CAACE,EAAE,CAACiB,MAAM,CAACC,UAAU,CAACC,YAAY,CAACV,UAAU,CAAC,CAAC,CAACW,cAAc,CAClEJ,kBACF,CAAC;EACH,CAAC,CAAC;EAEFjB,EAAE,CAAC,gDAAgD,EAAE,MAAM;IACzD,MAAMa,MAAM,GAAG;MACbC,SAAS,EAAE;IACb,CAAC;IAED,MAAMS,MAAM,GAAGtB,EAAE,CAACQ,EAAE,CAAC,CAAC;IACtB,MAAMe,OAAO,GAAGvB,EAAE,CAACQ,EAAE,CAAC,CAAC;IAEvB,MAAMgB,UAAU,GAAGtB,yBAAyB,CAC1C,WAAW,EACX,4BACF,CAAC;IAED,MAAM;MAAEuB;IAAwB,CAAC,GAAGxB,MAAM,CACxCW,MAAM,EACNY,UAAU,EACVF,MAAM,EACN,CAAC,CAAC,EACFC,OAAO,EACP,eACF,CAAC;IAEDE,uBAAuB,CAAC;MACtBC,aAAa,EAAE,SAAS;MACxBC,YAAY,EAAE,QAAQ;MACtBC,UAAU,EAAE,KAAK;MACjBC,UAAU,EAAE;IACd,CAAC,EAAE,QAAQ,CAAC;IAEZ/B,MAAM,CAACoB,UAAU,CAACC,YAAY,CAACZ,OAAO,CAAC,CAACa,cAAc,CACpD,2BAA2BR,MAAM,CAACC,SAAS,EAAE,EAC7CiB,IAAI,CAACC,SAAS,CAAC;MACbL,aAAa,EAAE,SAAS;MACxBM,kBAAkB,EAAE;IACtB,CAAC,CACH,CAAC;EACH,CAAC,CAAC;AACJ,CAAC,CAAC","ignoreList":[]}

package/build/esm/createConfidentialOauthClient.js

@@ -13,9 +13,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import { clientCredentialsGrantRequest, customFetch, processClientCredentialsResponse } from "oauth4webapi";
 import { common, createAuthorizationServer } from "./common.js";
 import { throwIfError } from "./throwIfError.js";
+
 /**
  * @param client_id
  * @param client_secret
@@ -25,7 +27,7 @@ import { throwIfError } from "./throwIfError.js";
  * @param ctxPath
  * @returns which can be used as a token provider
  */
-export function createConfidentialOauthClient(client_id, client_secret, url, scopes = ["api:read-data", "api:write-data"], fetchFn = globalThis.fetch, ctxPath = "/multipass") {
+export function createConfidentialOauthClient(client_id, client_secret, url, scopes = ["api:read-data", "api:write-data"], fetchFn = globalThis.fetch, ctxPath = "multipass") {
   const client = {
     client_id,
     client_secret
@@ -41,7 +43,7 @@ export function createConfidentialOauthClient(client_id, client_secret, url, sco
     return makeTokenAndSaveRefresh(throwIfError(await processClientCredentialsResponse(authServer, client, await clientCredentialsGrantRequest(authServer, client, new URLSearchParams({
       scope: scopes.join(" ")
     }), oauthHttpOptions))), "signIn");
-  }, oauthHttpOptions, undefined);
+  }, oauthHttpOptions, undefined, undefined);
   return getToken;
 }
 //# sourceMappingURL=createConfidentialOauthClient.js.map

package/build/esm/createConfidentialOauthClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"createConfidentialOauthClient.js","names":["clientCredentialsGrantRequest","customFetch","processClientCredentialsResponse","common","createAuthorizationServer","throwIfError","createConfidentialOauthClient","client_id","client_secret","url","scopes","fetchFn","globalThis","fetch","ctxPath","client","authServer","oauthHttpOptions","getToken","makeTokenAndSaveRefresh","URLSearchParams","scope","join","undefined"],"sources":["createConfidentialOauthClient.js"],"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 */\nimport { clientCredentialsGrantRequest, customFetch, processClientCredentialsResponse, } from \"oauth4webapi\";\nimport { common, createAuthorizationServer } from \"./common.js\";\nimport { throwIfError } from \"./throwIfError.js\";\n/**\n * @param client_id\n * @param client_secret\n * @param url the base url of your foundry server\n * @param scopes\n * @param fetchFn\n * @param ctxPath\n * @returns which can be used as a token provider\n */\nexport function createConfidentialOauthClient(client_id, client_secret, url, scopes = [\"api:read-data\", \"api:write-data\"], fetchFn = globalThis.fetch, ctxPath = \"/multipass\") {\n    const client = { client_id, client_secret };\n    const authServer = createAuthorizationServer(ctxPath, url);\n    const oauthHttpOptions = { [customFetch]: fetchFn };\n    const { getToken, makeTokenAndSaveRefresh } = common(client, authServer, _signIn, oauthHttpOptions, undefined);\n    async function _signIn() {\n        return makeTokenAndSaveRefresh(throwIfError(await processClientCredentialsResponse(authServer, client, await clientCredentialsGrantRequest(authServer, client, new URLSearchParams({ scope: scopes.join(\" \") }), oauthHttpOptions))), \"signIn\");\n    }\n    return getToken;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,6BAA6B,EAAEC,WAAW,EAAEC,gCAAgC,QAAS,cAAc;AAC5G,SAASC,MAAM,EAAEC,yBAAyB,QAAQ,aAAa;AAC/D,SAASC,YAAY,QAAQ,mBAAmB;AAChD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,6BAA6BA,CAACC,SAAS,EAAEC,aAAa,EAAEC,GAAG,EAAEC,MAAM,GAAG,CAAC,eAAe,EAAE,gBAAgB,CAAC,EAAEC,OAAO,GAAGC,UAAU,CAACC,KAAK,EAAEC,OAAO,GAAG,YAAY,EAAE;EAC3K,MAAMC,MAAM,GAAG;IAAER,SAAS;IAAEC;EAAc,CAAC;EAC3C,MAAMQ,UAAU,GAAGZ,yBAAyB,CAACU,OAAO,EAAEL,GAAG,CAAC;EAC1D,MAAMQ,gBAAgB,GAAG;IAAE,CAAChB,WAAW,GAAGU;EAAQ,CAAC;EACnD,MAAM;IAAEO,QAAQ;IAAEC;EAAwB,CAAC,GAAGhB,MAAM,CAACY,MAAM,EAAEC,UAAU,EACvE,kBAAyB;IACrB,OAAOG,uBAAuB,CAACd,YAAY,CAAC,MAAMH,gCAAgC,CAACc,UAAU,EAAED,MAAM,EAAE,MAAMf,6BAA6B,CAACgB,UAAU,EAAED,MAAM,EAAE,IAAIK,eAAe,CAAC;MAAEC,KAAK,EAAEX,MAAM,CAACY,IAAI,CAAC,GAAG;IAAE,CAAC,CAAC,EAAEL,gBAAgB,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC;EACnP,CAAC,EAHiFA,gBAAgB,EAAEM,SAAS,CAAC;EAI9G,OAAOL,QAAQ;AACnB","ignoreList":[]}
+{"version":3,"file":"createConfidentialOauthClient.js","names":["clientCredentialsGrantRequest","customFetch","processClientCredentialsResponse","common","createAuthorizationServer","throwIfError","createConfidentialOauthClient","client_id","client_secret","url","scopes","fetchFn","globalThis","fetch","ctxPath","client","authServer","oauthHttpOptions","getToken","makeTokenAndSaveRefresh","URLSearchParams","scope","join","undefined"],"sources":["createConfidentialOauthClient.ts"],"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 type { Client, HttpRequestOptions } from \"oauth4webapi\";\nimport {\n  clientCredentialsGrantRequest,\n  customFetch,\n  processClientCredentialsResponse,\n} from \"oauth4webapi\";\nimport { common, createAuthorizationServer } from \"./common.js\";\nimport type { ConfidentialOauthClient } from \"./ConfidentialOauthClient.js\";\nimport { throwIfError } from \"./throwIfError.js\";\n\n/**\n * @param client_id\n * @param client_secret\n * @param url the base url of your foundry server\n * @param scopes\n * @param fetchFn\n * @param ctxPath\n * @returns which can be used as a token provider\n */\nexport function createConfidentialOauthClient(\n  client_id: string,\n  client_secret: string,\n  url: string,\n  scopes: string[] = [\"api:read-data\", \"api:write-data\"],\n  fetchFn: typeof globalThis.fetch = globalThis.fetch,\n  ctxPath: string = \"multipass\",\n): ConfidentialOauthClient {\n  const client: Client = { client_id, client_secret };\n  const authServer = createAuthorizationServer(ctxPath, url);\n  const oauthHttpOptions: HttpRequestOptions = { [customFetch]: fetchFn };\n\n  const { getToken, makeTokenAndSaveRefresh } = common(\n    client,\n    authServer,\n    _signIn,\n    oauthHttpOptions,\n    undefined,\n    undefined,\n  );\n\n  async function _signIn() {\n    return makeTokenAndSaveRefresh(\n      throwIfError(\n        await processClientCredentialsResponse(\n          authServer,\n          client,\n          await clientCredentialsGrantRequest(\n            authServer,\n            client,\n            new URLSearchParams({ scope: scopes.join(\" \") }),\n            oauthHttpOptions,\n          ),\n        ),\n      ),\n      \"signIn\",\n    );\n  }\n\n  return getToken;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SACEA,6BAA6B,EAC7BC,WAAW,EACXC,gCAAgC,QAC3B,cAAc;AACrB,SAASC,MAAM,EAAEC,yBAAyB,QAAQ,aAAa;AAE/D,SAASC,YAAY,QAAQ,mBAAmB;;AAEhD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,6BAA6BA,CAC3CC,SAAiB,EACjBC,aAAqB,EACrBC,GAAW,EACXC,MAAgB,GAAG,CAAC,eAAe,EAAE,gBAAgB,CAAC,EACtDC,OAAgC,GAAGC,UAAU,CAACC,KAAK,EACnDC,OAAe,GAAG,WAAW,EACJ;EACzB,MAAMC,MAAc,GAAG;IAAER,SAAS;IAAEC;EAAc,CAAC;EACnD,MAAMQ,UAAU,GAAGZ,yBAAyB,CAACU,OAAO,EAAEL,GAAG,CAAC;EAC1D,MAAMQ,gBAAoC,GAAG;IAAE,CAAChB,WAAW,GAAGU;EAAQ,CAAC;EAEvE,MAAM;IAAEO,QAAQ;IAAEC;EAAwB,CAAC,GAAGhB,MAAM,CAClDY,MAAM,EACNC,UAAU,EAOZ,kBAAyB;IACvB,OAAOG,uBAAuB,CAC5Bd,YAAY,CACV,MAAMH,gCAAgC,CACpCc,UAAU,EACVD,MAAM,EACN,MAAMf,6BAA6B,CACjCgB,UAAU,EACVD,MAAM,EACN,IAAIK,eAAe,CAAC;MAAEC,KAAK,EAAEX,MAAM,CAACY,IAAI,CAAC,GAAG;IAAE,CAAC,CAAC,EAChDL,gBACF,CACF,CACF,CAAC,EACD,QACF,CAAC;EACH,CAAC,EArBCA,gBAAgB,EAChBM,SAAS,EACTA,SACF,CAAC;EAoBD,OAAOL,QAAQ;AACjB","ignoreList":[]}

package/build/esm/createPublicOauthClient.js

@@ -13,23 +13,49 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 import delay from "delay";
 import { authorizationCodeGrantRequest, calculatePKCECodeChallenge, customFetch, generateRandomCodeVerifier, generateRandomState, processAuthorizationCodeOAuth2Response, refreshTokenGrantRequest, validateAuthResponse } from "oauth4webapi";
-import { common, createAuthorizationServer, readLocal, removeLocal, saveLocal } from "./common.js";
+import { common, createAuthorizationServer, readLocal, readSession, removeLocal, removeSession, saveLocal, saveSession } from "./common.js";
 import { throwIfError } from "./throwIfError.js";
+import { processOptionsAndAssignDefaults } from "./utils.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
+ * Creates a PublicOauthClient for authentication.
+ *
+ * @param {string} clientId - The client_id from the OAuth configuration on the server
+ * @param {string} url - The base URL of your Foundry server
+ * @param {string} redirectUrl - The URL configured for redirect in the OAuth configuration on the server
+ * @param {PublicOauthClientOptions} options - Additional options for the client
+ * @returns {PublicOauthClient} A client that can be used as a token provider
+ */
+
+/**
+ * Creates a PublicOauthClient for authentication.
+ *
+ * @param {string} clientId - The client_id from the OAuth configuration on the server
+ * @param {string} url - The base URL of your Foundry server
+ * @param {string} redirectUrl - The URL configured for redirect in the OAuth configuration on the server
+ * @param {boolean} useHistory - If true, uses `history.replaceState()`, otherwise uses `window.location.assign()` (defaults to true)
+ * @param {string} loginPage - Custom landing page URL prior to logging in
+ * @param {string} postLoginPage - URL to return to after completed authentication cycle (defaults to `window.location.toString()`)
+ * @param {string[]} scopes - OAuth scopes to request. If not provided, defaults to `["api:read-data", "api:write-data"]`
+ * @param {typeof globalThis.fetch} fetchFn - Custom fetch function to use for requests (defaults to `globalThis.fetch`)
+ * @param {string} ctxPath - Context path for the authorization server (defaults to "multipass")
+ * @returns {PublicOauthClient} A client that can be used as a token provider
  */
-export function createPublicOauthClient(client_id, url, redirectUrl, useHistory = true, loginPage, postLoginPage = window.location.toString(), scopes = [], fetchFn = globalThis.fetch, ctxPath = "/multipass") {
+
+export function createPublicOauthClient(client_id, url, redirect_uri, useHistory, loginPage, postLoginPage, scopes, fetchFn, ctxPath) {
+  let refreshTokenMarker;
+  ({
+    useHistory,
+    loginPage,
+    postLoginPage,
+    scopes,
+    fetchFn,
+    ctxPath,
+    refreshTokenMarker
+  } = processOptionsAndAssignDefaults(url, redirect_uri, useHistory, loginPage, postLoginPage, scopes, fetchFn, ctxPath));
   const client = {
     client_id,
     token_endpoint_auth_method: "none"
@@ -38,9 +64,6 @@ export function createPublicOauthClient(client_id, url, redirectUrl, useHistory
   const oauthHttpOptions = {
     [customFetch]: fetchFn
   };
-  if (scopes.length === 0) {
-    scopes = ["api:read-data", "api:write-data"];
-  }
   const {
     makeTokenAndSaveRefresh,
     getToken
@@ -52,17 +75,23 @@ export function createPublicOauthClient(client_id, url, redirectUrl, useHistory
     ) ?? (await maybeHandleAuthReturn())
     // 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
     ?? (await initiateLoginRedirect());
-  }, oauthHttpOptions, maybeRefresh.bind(globalThis, true));
-  async function go(x) {
-    if (useHistory) return window.history.replaceState({}, "", x);else window.location.assign(x);
+  }, oauthHttpOptions, maybeRefresh.bind(globalThis, true), refreshTokenMarker);
+
+  // as an arrow function, `useHistory` is known to be a boolean
+  const go = async x => {
+    if (useHistory) {
+      window.history.replaceState({}, "", x);
+      return;
+    } else window.location.assign(x);
     await delay(1000);
     throw new Error("Unable to redirect");
-  }
+  };
   async function maybeRefresh(expectRefreshToken) {
     const {
-      refresh_token
+      refresh_token,
+      refreshTokenMarker: lastRefreshTokenMarker
     } = readLocal(client);
-    if (!refresh_token) {
+    if (!refresh_token || lastRefreshTokenMarker !== refreshTokenMarker) {
       if (expectRefreshToken) throw new Error("No refresh token found");
       return;
     }
@@ -70,11 +99,12 @@ export function createPublicOauthClient(client_id, url, redirectUrl, useHistory
       // note, we don't use processRefreshTokenResponse because the mp oauth implementation
       // doesn't do refresh tokens quite right and this lets us skip the id check
       const result = makeTokenAndSaveRefresh(throwIfError(await processAuthorizationCodeOAuth2Response(authServer, client, await refreshTokenGrantRequest(authServer, client, refresh_token, oauthHttpOptions))), "refresh");
-      if (result && window.location.pathname === new URL(redirectUrl).pathname) {
+      if (result && window.location.pathname === new URL(redirect_uri).pathname) {
         const {
           oldUrl
-        } = readLocal(client);
-        go(oldUrl ?? "/");
+        } = readSession(client);
+        // don't block on the redirect
+        void go(oldUrl ?? "/");
       }
       return result;
     } catch (e) {
@@ -90,14 +120,14 @@ export function createPublicOauthClient(client_id, url, redirectUrl, useHistory
   }
   async function maybeHandleAuthReturn() {
     const {
-      codeVerifier,
       state,
-      oldUrl
-    } = readLocal(client);
+      oldUrl,
+      codeVerifier
+    } = readSession(client);
     if (!codeVerifier) return;
     try {
-      const ret = makeTokenAndSaveRefresh(throwIfError(await processAuthorizationCodeOAuth2Response(authServer, client, await authorizationCodeGrantRequest(authServer, client, throwIfError(validateAuthResponse(authServer, client, new URL(window.location.href), state)), redirectUrl, codeVerifier, oauthHttpOptions))), "signIn");
-      go(oldUrl);
+      const ret = makeTokenAndSaveRefresh(throwIfError(await processAuthorizationCodeOAuth2Response(authServer, client, await authorizationCodeGrantRequest(authServer, client, throwIfError(validateAuthResponse(authServer, client, new URL(window.location.href), state)), redirect_uri, codeVerifier, oauthHttpOptions))), "signIn");
+      void go(oldUrl);
       return ret;
     } catch (e) {
       if (process.env.NODE_ENV !== "production") {
@@ -105,19 +135,26 @@ export function createPublicOauthClient(client_id, url, redirectUrl, useHistory
         console.warn("Failed to get OAuth2 token using PKCE, removing PKCE and starting a new auth flow", e);
       }
       removeLocal(client);
+      removeSession(client);
+      throw e;
     }
   }
-  async function initiateLoginRedirect() {
+
+  // As an arrow function, `scopes` and `postLoginPage` are known at compile time
+  const initiateLoginRedirect = async () => {
     if (loginPage && window.location.href !== loginPage && window.location.pathname !== loginPage) {
-      saveLocal(client, {
+      saveLocal(client, {});
+      saveSession(client, {
         oldUrl: postLoginPage
       });
-      return await go(loginPage);
+      await go(loginPage);
+      return;
     }
     const state = generateRandomState();
     const codeVerifier = generateRandomCodeVerifier();
-    const oldUrl = readLocal(client).oldUrl ?? window.location.toString();
-    saveLocal(client, {
+    const oldUrl = readSession(client).oldUrl ?? window.location.toString();
+    saveLocal(client, {});
+    saveSession(client, {
       codeVerifier,
       state,
       oldUrl
@@ -126,15 +163,16 @@ export function createPublicOauthClient(client_id, url, redirectUrl, useHistory
       client_id,
       response_type: "code",
       state,
-      redirect_uri: redirectUrl,
+      redirect_uri,
       code_challenge: await calculatePKCECodeChallenge(codeVerifier),
       code_challenge_method: "S256",
       scope: ["offline_access", ...scopes].join(" ")
     })}`);
+
     // Give time for redirect to happen
     await delay(1000);
     throw new Error("Unable to redirect");
-  }
+  };
   return getToken;
 }
 //# sourceMappingURL=createPublicOauthClient.js.map

package/build/esm/createPublicOauthClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"createPublicOauthClient.js","names":["delay","authorizationCodeGrantRequest","calculatePKCECodeChallenge","customFetch","generateRandomCodeVerifier","generateRandomState","processAuthorizationCodeOAuth2Response","refreshTokenGrantRequest","validateAuthResponse","common","createAuthorizationServer","readLocal","removeLocal","saveLocal","throwIfError","createPublicOauthClient","client_id","url","redirectUrl","useHistory","loginPage","postLoginPage","window","location","toString","scopes","fetchFn","globalThis","fetch","ctxPath","client","token_endpoint_auth_method","authServer","oauthHttpOptions","length","makeTokenAndSaveRefresh","getToken","_signIn","maybeRefresh","maybeHandleAuthReturn","initiateLoginRedirect","bind","go","x","history","replaceState","assign","Error","expectRefreshToken","refresh_token","result","pathname","URL","oldUrl","e","process","env","NODE_ENV","console","warn","codeVerifier","state","ret","href","authorization_endpoint","URLSearchParams","response_type","redirect_uri","code_challenge","code_challenge_method","scope","join"],"sources":["createPublicOauthClient.js"],"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 */\nimport delay from \"delay\";\nimport { authorizationCodeGrantRequest, calculatePKCECodeChallenge, customFetch, generateRandomCodeVerifier, generateRandomState, processAuthorizationCodeOAuth2Response, refreshTokenGrantRequest, validateAuthResponse, } from \"oauth4webapi\";\nimport { common, createAuthorizationServer, readLocal, removeLocal, saveLocal, } from \"./common.js\";\nimport { throwIfError } from \"./throwIfError.js\";\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 = true, loginPage, postLoginPage = window.location.toString(), scopes = [], fetchFn = globalThis.fetch, ctxPath = \"/multipass\") {\n    const client = { client_id, token_endpoint_auth_method: \"none\" };\n    const authServer = createAuthorizationServer(ctxPath, url);\n    const oauthHttpOptions = { [customFetch]: fetchFn };\n    if (scopes.length === 0) {\n        scopes = [\"api:read-data\", \"api:write-data\"];\n    }\n    const { makeTokenAndSaveRefresh, getToken } = common(client, authServer, _signIn, oauthHttpOptions, maybeRefresh.bind(globalThis, true));\n    async function go(x) {\n        if (useHistory)\n            return window.history.replaceState({}, \"\", x);\n        else\n            window.location.assign(x);\n        await delay(1000);\n        throw new Error(\"Unable to redirect\");\n    }\n    async function maybeRefresh(expectRefreshToken) {\n        const { refresh_token } = readLocal(client);\n        if (!refresh_token) {\n            if (expectRefreshToken)\n                throw new Error(\"No refresh token found\");\n            return;\n        }\n        try {\n            // note, we don't use processRefreshTokenResponse because the mp oauth implementation\n            // doesn't do refresh tokens quite right and this lets us skip the id check\n            const result = makeTokenAndSaveRefresh(throwIfError(await processAuthorizationCodeOAuth2Response(authServer, client, await refreshTokenGrantRequest(authServer, client, refresh_token, oauthHttpOptions))), \"refresh\");\n            if (result && window.location.pathname === new URL(redirectUrl).pathname) {\n                const { oldUrl } = readLocal(client);\n                go(oldUrl ?? \"/\");\n            }\n            return result;\n        }\n        catch (e) {\n            if (process.env.NODE_ENV !== \"production\") {\n                // eslint-disable-next-line no-console\n                console.warn(\"Failed to get OAuth2 refresh token. Removing refresh token\", e);\n            }\n            removeLocal(client);\n            if (expectRefreshToken) {\n                throw new Error(\"Could not refresh token\");\n            }\n        }\n    }\n    async function maybeHandleAuthReturn() {\n        const { codeVerifier, state, oldUrl } = readLocal(client);\n        if (!codeVerifier)\n            return;\n        try {\n            const ret = makeTokenAndSaveRefresh(throwIfError(await processAuthorizationCodeOAuth2Response(authServer, client, await authorizationCodeGrantRequest(authServer, client, throwIfError(validateAuthResponse(authServer, client, new URL(window.location.href), state)), redirectUrl, codeVerifier, oauthHttpOptions))), \"signIn\");\n            go(oldUrl);\n            return ret;\n        }\n        catch (e) {\n            if (process.env.NODE_ENV !== \"production\") {\n                // eslint-disable-next-line no-console\n                console.warn(\"Failed to get OAuth2 token using PKCE, removing PKCE and starting a new auth flow\", e);\n            }\n            removeLocal(client);\n        }\n    }\n    async function initiateLoginRedirect() {\n        if (loginPage\n            && window.location.href !== loginPage\n            && window.location.pathname !== loginPage) {\n            saveLocal(client, { oldUrl: postLoginPage });\n            return await go(loginPage);\n        }\n        const state = generateRandomState();\n        const codeVerifier = generateRandomCodeVerifier();\n        const oldUrl = readLocal(client).oldUrl ?? window.location.toString();\n        saveLocal(client, { codeVerifier, state, oldUrl });\n        window.location.assign(`${authServer\n            .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        // Give time for redirect to happen\n        await delay(1000);\n        throw new Error(\"Unable to redirect\");\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 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    return getToken;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAOA,KAAK,MAAM,OAAO;AACzB,SAASC,6BAA6B,EAAEC,0BAA0B,EAAEC,WAAW,EAAEC,0BAA0B,EAAEC,mBAAmB,EAAEC,sCAAsC,EAAEC,wBAAwB,EAAEC,oBAAoB,QAAS,cAAc;AAC/O,SAASC,MAAM,EAAEC,yBAAyB,EAAEC,SAAS,EAAEC,WAAW,EAAEC,SAAS,QAAS,aAAa;AACnG,SAASC,YAAY,QAAQ,mBAAmB;AAChD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,uBAAuBA,CAACC,SAAS,EAAEC,GAAG,EAAEC,WAAW,EAAEC,UAAU,GAAG,IAAI,EAAEC,SAAS,EAAEC,aAAa,GAAGC,MAAM,CAACC,QAAQ,CAACC,QAAQ,CAAC,CAAC,EAAEC,MAAM,GAAG,EAAE,EAAEC,OAAO,GAAGC,UAAU,CAACC,KAAK,EAAEC,OAAO,GAAG,YAAY,EAAE;EAC5M,MAAMC,MAAM,GAAG;IAAEd,SAAS;IAAEe,0BAA0B,EAAE;EAAO,CAAC;EAChE,MAAMC,UAAU,GAAGtB,yBAAyB,CAACmB,OAAO,EAAEZ,GAAG,CAAC;EAC1D,MAAMgB,gBAAgB,GAAG;IAAE,CAAC9B,WAAW,GAAGuB;EAAQ,CAAC;EACnD,IAAID,MAAM,CAACS,MAAM,KAAK,CAAC,EAAE;IACrBT,MAAM,GAAG,CAAC,eAAe,EAAE,gBAAgB,CAAC;EAChD;EACA,MAAM;IAAEU,uBAAuB;IAAEC;EAAS,CAAC,GAAG3B,MAAM,CAACqB,MAAM,EAAEE,UAAU,EA+EvE;EACA,eAAeK,OAAOA,CAAA,EAAG;IACrB;IACA,OAAO,OAAMC,YAAY,CAAC;IACtB;IAAA,MACG,MAAMC,qBAAqB,CAAC,CAAC;IAChC;IAAA,IACG,MAAMC,qBAAqB,CAAC,CAAC;EACxC,CAAC,EAvFiFP,gBAAgB,EAAEK,YAAY,CAACG,IAAI,CAACd,UAAU,EAAE,IAAI,CAAC,CAAC;EACxI,eAAee,EAAEA,CAACC,CAAC,EAAE;IACjB,IAAIxB,UAAU,EACV,OAAOG,MAAM,CAACsB,OAAO,CAACC,YAAY,CAAC,CAAC,CAAC,EAAE,EAAE,EAAEF,CAAC,CAAC,CAAC,KAE9CrB,MAAM,CAACC,QAAQ,CAACuB,MAAM,CAACH,CAAC,CAAC;IAC7B,MAAM3C,KAAK,CAAC,IAAI,CAAC;IACjB,MAAM,IAAI+C,KAAK,CAAC,oBAAoB,CAAC;EACzC;EACA,eAAeT,YAAYA,CAACU,kBAAkB,EAAE;IAC5C,MAAM;MAAEC;IAAc,CAAC,GAAGtC,SAAS,CAACmB,MAAM,CAAC;IAC3C,IAAI,CAACmB,aAAa,EAAE;MAChB,IAAID,kBAAkB,EAClB,MAAM,IAAID,KAAK,CAAC,wBAAwB,CAAC;MAC7C;IACJ;IACA,IAAI;MACA;MACA;MACA,MAAMG,MAAM,GAAGf,uBAAuB,CAACrB,YAAY,CAAC,MAAMR,sCAAsC,CAAC0B,UAAU,EAAEF,MAAM,EAAE,MAAMvB,wBAAwB,CAACyB,UAAU,EAAEF,MAAM,EAAEmB,aAAa,EAAEhB,gBAAgB,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC;MACtN,IAAIiB,MAAM,IAAI5B,MAAM,CAACC,QAAQ,CAAC4B,QAAQ,KAAK,IAAIC,GAAG,CAAClC,WAAW,CAAC,CAACiC,QAAQ,EAAE;QACtE,MAAM;UAAEE;QAAO,CAAC,GAAG1C,SAAS,CAACmB,MAAM,CAAC;QACpCY,EAAE,CAACW,MAAM,IAAI,GAAG,CAAC;MACrB;MACA,OAAOH,MAAM;IACjB,CAAC,CACD,OAAOI,CAAC,EAAE;MACN,IAAIC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;QACvC;QACAC,OAAO,CAACC,IAAI,CAAC,4DAA4D,EAAEL,CAAC,CAAC;MACjF;MACA1C,WAAW,CAACkB,MAAM,CAAC;MACnB,IAAIkB,kBAAkB,EAAE;QACpB,MAAM,IAAID,KAAK,CAAC,yBAAyB,CAAC;MAC9C;IACJ;EACJ;EACA,eAAeR,qBAAqBA,CAAA,EAAG;IACnC,MAAM;MAAEqB,YAAY;MAAEC,KAAK;MAAER;IAAO,CAAC,GAAG1C,SAAS,CAACmB,MAAM,CAAC;IACzD,IAAI,CAAC8B,YAAY,EACb;IACJ,IAAI;MACA,MAAME,GAAG,GAAG3B,uBAAuB,CAACrB,YAAY,CAAC,MAAMR,sCAAsC,CAAC0B,UAAU,EAAEF,MAAM,EAAE,MAAM7B,6BAA6B,CAAC+B,UAAU,EAAEF,MAAM,EAAEhB,YAAY,CAACN,oBAAoB,CAACwB,UAAU,EAAEF,MAAM,EAAE,IAAIsB,GAAG,CAAC9B,MAAM,CAACC,QAAQ,CAACwC,IAAI,CAAC,EAAEF,KAAK,CAAC,CAAC,EAAE3C,WAAW,EAAE0C,YAAY,EAAE3B,gBAAgB,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC;MACjUS,EAAE,CAACW,MAAM,CAAC;MACV,OAAOS,GAAG;IACd,CAAC,CACD,OAAOR,CAAC,EAAE;MACN,IAAIC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;QACvC;QACAC,OAAO,CAACC,IAAI,CAAC,mFAAmF,EAAEL,CAAC,CAAC;MACxG;MACA1C,WAAW,CAACkB,MAAM,CAAC;IACvB;EACJ;EACA,eAAeU,qBAAqBA,CAAA,EAAG;IACnC,IAAIpB,SAAS,IACNE,MAAM,CAACC,QAAQ,CAACwC,IAAI,KAAK3C,SAAS,IAClCE,MAAM,CAACC,QAAQ,CAAC4B,QAAQ,KAAK/B,SAAS,EAAE;MAC3CP,SAAS,CAACiB,MAAM,EAAE;QAAEuB,MAAM,EAAEhC;MAAc,CAAC,CAAC;MAC5C,OAAO,MAAMqB,EAAE,CAACtB,SAAS,CAAC;IAC9B;IACA,MAAMyC,KAAK,GAAGxD,mBAAmB,CAAC,CAAC;IACnC,MAAMuD,YAAY,GAAGxD,0BAA0B,CAAC,CAAC;IACjD,MAAMiD,MAAM,GAAG1C,SAAS,CAACmB,MAAM,CAAC,CAACuB,MAAM,IAAI/B,MAAM,CAACC,QAAQ,CAACC,QAAQ,CAAC,CAAC;IACrEX,SAAS,CAACiB,MAAM,EAAE;MAAE8B,YAAY;MAAEC,KAAK;MAAER;IAAO,CAAC,CAAC;IAClD/B,MAAM,CAACC,QAAQ,CAACuB,MAAM,CAAC,GAAGd,UAAU,CAC/BgC,sBAAsB,IAAI,IAAIC,eAAe,CAAC;MAC/CjD,SAAS;MACTkD,aAAa,EAAE,MAAM;MACrBL,KAAK;MACLM,YAAY,EAAEjD,WAAW;MACzBkD,cAAc,EAAE,MAAMlE,0BAA0B,CAAC0D,YAAY,CAAC;MAC9DS,qBAAqB,EAAE,MAAM;MAC7BC,KAAK,EAAE,CAAC,gBAAgB,EAAE,GAAG7C,MAAM,CAAC,CAAC8C,IAAI,CAAC,GAAG;IACjD,CAAC,CAAC,EAAE,CAAC;IACL;IACA,MAAMvE,KAAK,CAAC,IAAI,CAAC;IACjB,MAAM,IAAI+C,KAAK,CAAC,oBAAoB,CAAC;EACzC;EAUA,OAAOX,QAAQ;AACnB","ignoreList":[]}
+{"version":3,"file":"createPublicOauthClient.js","names":["delay","authorizationCodeGrantRequest","calculatePKCECodeChallenge","customFetch","generateRandomCodeVerifier","generateRandomState","processAuthorizationCodeOAuth2Response","refreshTokenGrantRequest","validateAuthResponse","common","createAuthorizationServer","readLocal","readSession","removeLocal","removeSession","saveLocal","saveSession","throwIfError","processOptionsAndAssignDefaults","createPublicOauthClient","client_id","url","redirect_uri","useHistory","loginPage","postLoginPage","scopes","fetchFn","ctxPath","refreshTokenMarker","client","token_endpoint_auth_method","authServer","oauthHttpOptions","makeTokenAndSaveRefresh","getToken","_signIn","maybeRefresh","maybeHandleAuthReturn","initiateLoginRedirect","bind","globalThis","go","x","window","history","replaceState","location","assign","Error","expectRefreshToken","refresh_token","lastRefreshTokenMarker","result","pathname","URL","oldUrl","e","process","env","NODE_ENV","console","warn","state","codeVerifier","ret","href","toString","authorization_endpoint","URLSearchParams","response_type","code_challenge","code_challenge_method","scope","join"],"sources":["createPublicOauthClient.ts"],"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 type { Client, HttpRequestOptions } from \"oauth4webapi\";\nimport {\n  authorizationCodeGrantRequest,\n  calculatePKCECodeChallenge,\n  customFetch,\n  generateRandomCodeVerifier,\n  generateRandomState,\n  processAuthorizationCodeOAuth2Response,\n  refreshTokenGrantRequest,\n  validateAuthResponse,\n} from \"oauth4webapi\";\nimport {\n  common,\n  createAuthorizationServer,\n  readLocal,\n  readSession,\n  removeLocal,\n  removeSession,\n  saveLocal,\n  saveSession,\n} from \"./common.js\";\nimport type { PublicOauthClient } from \"./PublicOauthClient.js\";\nimport { throwIfError } from \"./throwIfError.js\";\nimport type { Token } from \"./Token.js\";\nimport { processOptionsAndAssignDefaults } from \"./utils.js\";\n\ndeclare const process: {\n  env: {\n    NODE_ENV: \"production\" | \"development\";\n    TARGET: \"browser\" | \"node\";\n  };\n};\n\nexport interface PublicOauthClientOptions {\n  /**\n   * If true, uses `history.replaceState()`, otherwise uses `window.location.assign()` (defaults to true)\n   */\n  useHistory?: boolean;\n\n  /**\n   * Custom landing page URL prior to logging in\n   */\n  loginPage?: string;\n\n  /**\n   * URL to return to after completed authentication cycle (defaults to `window.location.toString()`)\n   */\n  postLoginPage?: string;\n\n  /**\n   * * @param {string[]} [scopes=[]] - OAuth scopes to request. If not provided, defaults to `[\"api:read-data\", \"api:write-data\"]`\n   */\n  scopes?: string[];\n\n  /**\n   * Custom fetch function to use for requests (defaults to `globalThis.fetch`)\n   */\n  fetchFn?: typeof globalThis.fetch;\n\n  /**\n   * Context path for the authorization server (defaults to \"multipass\")\n   */\n  ctxPath?: string;\n\n  /**\n   * Allows for an additional value to be appended to the local storage key for the refresh token.\n   */\n  refreshTokenMarker?: string;\n}\n\n/**\n * Creates a PublicOauthClient for authentication.\n *\n * @param {string} clientId - The client_id from the OAuth configuration on the server\n * @param {string} url - The base URL of your Foundry server\n * @param {string} redirectUrl - The URL configured for redirect in the OAuth configuration on the server\n * @param {PublicOauthClientOptions} options - Additional options for the client\n * @returns {PublicOauthClient} A client that can be used as a token provider\n */\nexport function createPublicOauthClient(\n  clientId: string,\n  url: string,\n  redirectUrl: string,\n  options?: PublicOauthClientOptions,\n): PublicOauthClient;\n\n/**\n * Creates a PublicOauthClient for authentication.\n *\n * @param {string} clientId - The client_id from the OAuth configuration on the server\n * @param {string} url - The base URL of your Foundry server\n * @param {string} redirectUrl - The URL configured for redirect in the OAuth configuration on the server\n * @param {boolean} useHistory - If true, uses `history.replaceState()`, otherwise uses `window.location.assign()` (defaults to true)\n * @param {string} loginPage - Custom landing page URL prior to logging in\n * @param {string} postLoginPage - URL to return to after completed authentication cycle (defaults to `window.location.toString()`)\n * @param {string[]} scopes - OAuth scopes to request. If not provided, defaults to `[\"api:read-data\", \"api:write-data\"]`\n * @param {typeof globalThis.fetch} fetchFn - Custom fetch function to use for requests (defaults to `globalThis.fetch`)\n * @param {string} ctxPath - Context path for the authorization server (defaults to \"multipass\")\n * @returns {PublicOauthClient} A client that can be used as a token provider\n */\nexport function createPublicOauthClient(\n  client_id: string,\n  url: string,\n  redirectUrl: string,\n  useHistory?: boolean,\n  loginPage?: string,\n  postLoginPage?: string,\n  scopes?: string[],\n  fetchFn?: typeof globalThis.fetch,\n  ctxPath?: string,\n): PublicOauthClient;\nexport function createPublicOauthClient(\n  client_id: string,\n  url: string,\n  redirect_uri: string,\n  useHistory?: boolean | PublicOauthClientOptions,\n  loginPage?: string,\n  postLoginPage?: string,\n  scopes?: string[],\n  fetchFn?: typeof globalThis.fetch,\n  ctxPath?: string,\n): PublicOauthClient {\n  let refreshTokenMarker: string | undefined;\n  ({\n    useHistory,\n    loginPage,\n    postLoginPage,\n    scopes,\n    fetchFn,\n    ctxPath,\n    refreshTokenMarker,\n  } = processOptionsAndAssignDefaults(\n    url,\n    redirect_uri,\n    useHistory,\n    loginPage,\n    postLoginPage,\n    scopes,\n    fetchFn,\n    ctxPath,\n  ));\n\n  const client: Client = {\n    client_id,\n    token_endpoint_auth_method: \"none\",\n  };\n  const authServer = createAuthorizationServer(ctxPath, url);\n  const oauthHttpOptions: HttpRequestOptions = { [customFetch]: fetchFn };\n\n  const { makeTokenAndSaveRefresh, getToken } = common(\n    client,\n    authServer,\n    _signIn,\n    oauthHttpOptions,\n    maybeRefresh.bind(globalThis, true),\n    refreshTokenMarker,\n  );\n\n  // as an arrow function, `useHistory` is known to be a boolean\n  const go = async (x: string) => {\n    if (useHistory) {\n      window.history.replaceState({}, \"\", x);\n      return;\n    } else window.location.assign(x);\n\n    await delay(1000);\n    throw new Error(\"Unable to redirect\");\n  };\n\n  async function maybeRefresh(\n    expectRefreshToken?: boolean,\n  ): Promise<Token | undefined> {\n    const { refresh_token, refreshTokenMarker: lastRefreshTokenMarker } =\n      readLocal(client);\n\n    if (!refresh_token || lastRefreshTokenMarker !== refreshTokenMarker) {\n      if (expectRefreshToken) throw new Error(\"No refresh token found\");\n      return;\n    }\n\n    try {\n      // note, we don't use processRefreshTokenResponse because the mp oauth implementation\n      // doesn't do refresh tokens quite right and this lets us skip the id check\n      const result = makeTokenAndSaveRefresh(\n        throwIfError(\n          await processAuthorizationCodeOAuth2Response(\n            authServer,\n            client,\n            await refreshTokenGrantRequest(\n              authServer,\n              client,\n              refresh_token,\n              oauthHttpOptions,\n            ),\n          ),\n        ),\n        \"refresh\",\n      );\n\n      if (\n        result && window.location.pathname === new URL(redirect_uri).pathname\n      ) {\n        const { oldUrl } = readSession(client);\n        // don't block on the redirect\n        void go(oldUrl ?? \"/\");\n      }\n      return result;\n    } catch (e) {\n      if (process.env.NODE_ENV !== \"production\") {\n        // eslint-disable-next-line no-console\n        console.warn(\n          \"Failed to get OAuth2 refresh token. Removing refresh token\",\n          e,\n        );\n      }\n      removeLocal(client);\n      if (expectRefreshToken) {\n        throw new Error(\"Could not refresh token\");\n      }\n    }\n  }\n\n  async function maybeHandleAuthReturn() {\n    const { state, oldUrl, codeVerifier } = readSession(client);\n    if (!codeVerifier) return;\n\n    try {\n      const ret = makeTokenAndSaveRefresh(\n        throwIfError(\n          await processAuthorizationCodeOAuth2Response(\n            authServer,\n            client,\n            await authorizationCodeGrantRequest(\n              authServer,\n              client,\n              throwIfError(\n                validateAuthResponse(\n                  authServer,\n                  client,\n                  new URL(window.location.href),\n                  state,\n                ),\n              ),\n              redirect_uri,\n              codeVerifier,\n              oauthHttpOptions,\n            ),\n          ),\n        ),\n        \"signIn\",\n      );\n\n      void go(oldUrl);\n      return ret;\n    } catch (e) {\n      if (process.env.NODE_ENV !== \"production\") {\n        // eslint-disable-next-line no-console\n        console.warn(\n          \"Failed to get OAuth2 token using PKCE, removing PKCE and starting a new auth flow\",\n          e,\n        );\n      }\n      removeLocal(client);\n      removeSession(client);\n      throw e;\n    }\n  }\n\n  // As an arrow function, `scopes` and `postLoginPage` are known at compile time\n  const initiateLoginRedirect = async (): Promise<void> => {\n    if (\n      loginPage\n      && window.location.href !== loginPage\n      && window.location.pathname !== loginPage\n    ) {\n      saveLocal(client, {});\n      saveSession(client, { oldUrl: postLoginPage });\n      await go(loginPage);\n      return;\n    }\n\n    const state = generateRandomState()!;\n    const codeVerifier = generateRandomCodeVerifier();\n    const oldUrl = readSession(client).oldUrl ?? window.location.toString();\n    saveLocal(client, {});\n    saveSession(client, { codeVerifier, state, oldUrl });\n\n    window.location.assign(`${authServer\n      .authorization_endpoint!}?${new URLSearchParams({\n      client_id,\n      response_type: \"code\",\n      state,\n      redirect_uri,\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\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 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() as unknown as Token;\n  }\n\n  return getToken;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,OAAOA,KAAK,MAAM,OAAO;AAEzB,SACEC,6BAA6B,EAC7BC,0BAA0B,EAC1BC,WAAW,EACXC,0BAA0B,EAC1BC,mBAAmB,EACnBC,sCAAsC,EACtCC,wBAAwB,EACxBC,oBAAoB,QACf,cAAc;AACrB,SACEC,MAAM,EACNC,yBAAyB,EACzBC,SAAS,EACTC,WAAW,EACXC,WAAW,EACXC,aAAa,EACbC,SAAS,EACTC,WAAW,QACN,aAAa;AAEpB,SAASC,YAAY,QAAQ,mBAAmB;AAEhD,SAASC,+BAA+B,QAAQ,YAAY;;AA8C5D;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAQA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAYA,OAAO,SAASC,uBAAuBA,CACrCC,SAAiB,EACjBC,GAAW,EACXC,YAAoB,EACpBC,UAA+C,EAC/CC,SAAkB,EAClBC,aAAsB,EACtBC,MAAiB,EACjBC,OAAiC,EACjCC,OAAgB,EACG;EACnB,IAAIC,kBAAsC;EAC1C,CAAC;IACCN,UAAU;IACVC,SAAS;IACTC,aAAa;IACbC,MAAM;IACNC,OAAO;IACPC,OAAO;IACPC;EACF,CAAC,GAAGX,+BAA+B,CACjCG,GAAG,EACHC,YAAY,EACZC,UAAU,EACVC,SAAS,EACTC,aAAa,EACbC,MAAM,EACNC,OAAO,EACPC,OACF,CAAC;EAED,MAAME,MAAc,GAAG;IACrBV,SAAS;IACTW,0BAA0B,EAAE;EAC9B,CAAC;EACD,MAAMC,UAAU,GAAGtB,yBAAyB,CAACkB,OAAO,EAAEP,GAAG,CAAC;EAC1D,MAAMY,gBAAoC,GAAG;IAAE,CAAC9B,WAAW,GAAGwB;EAAQ,CAAC;EAEvE,MAAM;IAAEO,uBAAuB;IAAEC;EAAS,CAAC,GAAG1B,MAAM,CAClDqB,MAAM,EACNE,UAAU,EAwJZ;EACA,eAAeI,OAAOA,CAAA,EAAG;IACvB;IACA,OAAO,OAAMC,YAAY,CAAC;IACxB;IAAA,MACG,MAAMC,qBAAqB,CAAC,CAAC;IAChC;IAAA,IACG,MAAMC,qBAAqB,CAAC,CAAC,CAAoB;EACxD,CAAC,EA9JCN,gBAAgB,EAChBI,YAAY,CAACG,IAAI,CAACC,UAAU,EAAE,IAAI,CAAC,EACnCZ,kBACF,CAAC;;EAED;EACA,MAAMa,EAAE,GAAG,MAAOC,CAAS,IAAK;IAC9B,IAAIpB,UAAU,EAAE;MACdqB,MAAM,CAACC,OAAO,CAACC,YAAY,CAAC,CAAC,CAAC,EAAE,EAAE,EAAEH,CAAC,CAAC;MACtC;IACF,CAAC,MAAMC,MAAM,CAACG,QAAQ,CAACC,MAAM,CAACL,CAAC,CAAC;IAEhC,MAAM3C,KAAK,CAAC,IAAI,CAAC;IACjB,MAAM,IAAIiD,KAAK,CAAC,oBAAoB,CAAC;EACvC,CAAC;EAED,eAAeZ,YAAYA,CACzBa,kBAA4B,EACA;IAC5B,MAAM;MAAEC,aAAa;MAAEtB,kBAAkB,EAAEuB;IAAuB,CAAC,GACjEzC,SAAS,CAACmB,MAAM,CAAC;IAEnB,IAAI,CAACqB,aAAa,IAAIC,sBAAsB,KAAKvB,kBAAkB,EAAE;MACnE,IAAIqB,kBAAkB,EAAE,MAAM,IAAID,KAAK,CAAC,wBAAwB,CAAC;MACjE;IACF;IAEA,IAAI;MACF;MACA;MACA,MAAMI,MAAM,GAAGnB,uBAAuB,CACpCjB,YAAY,CACV,MAAMX,sCAAsC,CAC1C0B,UAAU,EACVF,MAAM,EACN,MAAMvB,wBAAwB,CAC5ByB,UAAU,EACVF,MAAM,EACNqB,aAAa,EACblB,gBACF,CACF,CACF,CAAC,EACD,SACF,CAAC;MAED,IACEoB,MAAM,IAAIT,MAAM,CAACG,QAAQ,CAACO,QAAQ,KAAK,IAAIC,GAAG,CAACjC,YAAY,CAAC,CAACgC,QAAQ,EACrE;QACA,MAAM;UAAEE;QAAO,CAAC,GAAG5C,WAAW,CAACkB,MAAM,CAAC;QACtC;QACA,KAAKY,EAAE,CAACc,MAAM,IAAI,GAAG,CAAC;MACxB;MACA,OAAOH,MAAM;IACf,CAAC,CAAC,OAAOI,CAAC,EAAE;MACV,IAAIC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;QACzC;QACAC,OAAO,CAACC,IAAI,CACV,4DAA4D,EAC5DL,CACF,CAAC;MACH;MACA5C,WAAW,CAACiB,MAAM,CAAC;MACnB,IAAIoB,kBAAkB,EAAE;QACtB,MAAM,IAAID,KAAK,CAAC,yBAAyB,CAAC;MAC5C;IACF;EACF;EAEA,eAAeX,qBAAqBA,CAAA,EAAG;IACrC,MAAM;MAAEyB,KAAK;MAAEP,MAAM;MAAEQ;IAAa,CAAC,GAAGpD,WAAW,CAACkB,MAAM,CAAC;IAC3D,IAAI,CAACkC,YAAY,EAAE;IAEnB,IAAI;MACF,MAAMC,GAAG,GAAG/B,uBAAuB,CACjCjB,YAAY,CACV,MAAMX,sCAAsC,CAC1C0B,UAAU,EACVF,MAAM,EACN,MAAM7B,6BAA6B,CACjC+B,UAAU,EACVF,MAAM,EACNb,YAAY,CACVT,oBAAoB,CAClBwB,UAAU,EACVF,MAAM,EACN,IAAIyB,GAAG,CAACX,MAAM,CAACG,QAAQ,CAACmB,IAAI,CAAC,EAC7BH,KACF,CACF,CAAC,EACDzC,YAAY,EACZ0C,YAAY,EACZ/B,gBACF,CACF,CACF,CAAC,EACD,QACF,CAAC;MAED,KAAKS,EAAE,CAACc,MAAM,CAAC;MACf,OAAOS,GAAG;IACZ,CAAC,CAAC,OAAOR,CAAC,EAAE;MACV,IAAIC,OAAO,CAACC,GAAG,CAACC,QAAQ,KAAK,YAAY,EAAE;QACzC;QACAC,OAAO,CAACC,IAAI,CACV,mFAAmF,EACnFL,CACF,CAAC;MACH;MACA5C,WAAW,CAACiB,MAAM,CAAC;MACnBhB,aAAa,CAACgB,MAAM,CAAC;MACrB,MAAM2B,CAAC;IACT;EACF;;EAEA;EACA,MAAMlB,qBAAqB,GAAG,MAAAA,CAAA,KAA2B;IACvD,IACEf,SAAS,IACNoB,MAAM,CAACG,QAAQ,CAACmB,IAAI,KAAK1C,SAAS,IAClCoB,MAAM,CAACG,QAAQ,CAACO,QAAQ,KAAK9B,SAAS,EACzC;MACAT,SAAS,CAACe,MAAM,EAAE,CAAC,CAAC,CAAC;MACrBd,WAAW,CAACc,MAAM,EAAE;QAAE0B,MAAM,EAAE/B;MAAc,CAAC,CAAC;MAC9C,MAAMiB,EAAE,CAAClB,SAAS,CAAC;MACnB;IACF;IAEA,MAAMuC,KAAK,GAAG1D,mBAAmB,CAAC,CAAE;IACpC,MAAM2D,YAAY,GAAG5D,0BAA0B,CAAC,CAAC;IACjD,MAAMoD,MAAM,GAAG5C,WAAW,CAACkB,MAAM,CAAC,CAAC0B,MAAM,IAAIZ,MAAM,CAACG,QAAQ,CAACoB,QAAQ,CAAC,CAAC;IACvEpD,SAAS,CAACe,MAAM,EAAE,CAAC,CAAC,CAAC;IACrBd,WAAW,CAACc,MAAM,EAAE;MAAEkC,YAAY;MAAED,KAAK;MAAEP;IAAO,CAAC,CAAC;IAEpDZ,MAAM,CAACG,QAAQ,CAACC,MAAM,CAAC,GAAGhB,UAAU,CACjCoC,sBAAsB,IAAK,IAAIC,eAAe,CAAC;MAChDjD,SAAS;MACTkD,aAAa,EAAE,MAAM;MACrBP,KAAK;MACLzC,YAAY;MACZiD,cAAc,EAAE,MAAMrE,0BAA0B,CAAC8D,YAAY,CAAC;MAC9DQ,qBAAqB,EAAE,MAAM;MAC7BC,KAAK,EAAE,CAAC,gBAAgB,EAAE,GAAG/C,MAAM,CAAC,CAACgD,IAAI,CAAC,GAAG;IAC/C,CAAC,CAAC,EAAE,CAAC;;IAEL;IACA,MAAM1E,KAAK,CAAC,IAAI,CAAC;IACjB,MAAM,IAAIiD,KAAK,CAAC,oBAAoB,CAAC;EACvC,CAAC;EAYD,OAAOd,QAAQ;AACjB","ignoreList":[]}

package/build/esm/index.js

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 export { createConfidentialOauthClient } from "./createConfidentialOauthClient.js";
 export { createPublicOauthClient } from "./createPublicOauthClient.js";
 //# sourceMappingURL=index.js.map

package/build/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["createConfidentialOauthClient","createPublicOauthClient"],"sources":["index.js"],"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 */\nexport { createConfidentialOauthClient } from \"./createConfidentialOauthClient.js\";\nexport { createPublicOauthClient } from \"./createPublicOauthClient.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAASA,6BAA6B,QAAQ,oCAAoC;AAClF,SAASC,uBAAuB,QAAQ,8BAA8B","ignoreList":[]}
+{"version":3,"file":"index.js","names":["createConfidentialOauthClient","createPublicOauthClient"],"sources":["index.ts"],"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\nexport { createConfidentialOauthClient } from \"./createConfidentialOauthClient.js\";\nexport { createPublicOauthClient } from \"./createPublicOauthClient.js\";\nexport type { PublicOauthClient } from \"./PublicOauthClient.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,6BAA6B,QAAQ,oCAAoC;AAClF,SAASC,uBAAuB,QAAQ,8BAA8B","ignoreList":[]}