@workos-inc/widgets 1.1.0 → 1.1.1

package/dist/esm/api/api-provider.d.ts

@@ -0,0 +1,26 @@
+import * as React from "react";
+export type AuthToken = string | (() => Promise<string>);
+interface ElevatedAccess {
+    token: string;
+    expiresAt: string;
+}
+interface ApiConfig {
+    authToken: Promise<string> | string;
+    authTokenQueryKey: string;
+    baseUrl: string;
+    elevatedAccess?: ElevatedAccess;
+    setElevatedAccess: (elevatedAccess?: ElevatedAccess) => void;
+}
+interface ApiProviderProps {
+    authToken: AuthToken;
+    baseUrl: string;
+    children: React.ReactNode;
+}
+export declare const ApiProvider: ({ authToken, baseUrl, children, }: ApiProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useApi: () => ApiConfig;
+export declare const useElevatedAccessToken: () => {
+    elevatedAccess: ElevatedAccess | undefined;
+    setElevatedAccess: (elevatedAccess?: ElevatedAccess) => void;
+};
+export {};
+//# sourceMappingURL=api-provider.d.ts.map

package/dist/esm/api/api-provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-provider.d.ts","sourceRoot":"","sources":["../../../src/api/api-provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAE/B,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;AAEzD,UAAU,cAAc;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,UAAU,SAAS;IACjB,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IACpC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,iBAAiB,EAAE,CAAC,cAAc,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;CAC9D;AAID,UAAU,gBAAgB;IACxB,SAAS,EAAE,SAAS,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAED,eAAO,MAAM,WAAW,sCAIrB,gBAAgB,4CA6ClB,CAAC;AAEF,eAAO,MAAM,MAAM,iBAQlB,CAAC;AAEF,eAAO,MAAM,sBAAsB;;yCAxEI,cAAc,KAAK,IAAI;CA4E7D,CAAC"}

package/dist/esm/api/api-provider.js

@@ -0,0 +1,94 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import * as React from "react";
+const ApiContext = React.createContext(undefined);
+export const ApiProvider = ({ authToken, baseUrl, children, }) => {
+    const authTokenPromiseOrString = typeof authToken === "string" ? authToken : authToken();
+    const [elevatedAccess, setElevatedAccess] = React.useState();
+    const elevatedAccessTimeout = React.useRef();
+    // This effect manages the expiration of elevated access tokens
+    // When an elevated access token is present, it checks every 30 seconds if the token has expired
+    // If the token has expired (current time > expiration time), it clears the elevated access
+    React.useEffect(() => {
+        if (elevatedAccessTimeout.current) {
+            clearInterval(elevatedAccessTimeout.current);
+        }
+        if (elevatedAccess) {
+            elevatedAccessTimeout.current = setInterval(() => {
+                const now = new Date();
+                const expiresAtDate = new Date(elevatedAccess.expiresAt);
+                //  Reset the elevated access if it has expired
+                if (now > expiresAtDate) {
+                    setElevatedAccess(undefined);
+                }
+            }, 30_000); // every 30 seconds
+        }
+        return () => {
+            if (elevatedAccessTimeout.current) {
+                clearInterval(elevatedAccessTimeout.current);
+            }
+        };
+    }, [elevatedAccess]);
+    const value = React.useMemo(() => ({
+        authToken: authTokenPromiseOrString,
+        authTokenQueryKey: getAuthTokenQueryKey(authTokenPromiseOrString),
+        baseUrl,
+        elevatedAccess,
+        setElevatedAccess,
+    }), [authTokenPromiseOrString, baseUrl, elevatedAccess, setElevatedAccess]);
+    return _jsx(ApiContext.Provider, { value: value, children: children });
+};
+export const useApi = () => {
+    const context = React.useContext(ApiContext);
+    if (context === undefined) {
+        throw new Error("useApi must be used within an ApiProvider");
+    }
+    return context;
+};
+export const useElevatedAccessToken = () => {
+    const { elevatedAccess, setElevatedAccess } = useApi();
+    return { elevatedAccess, setElevatedAccess };
+};
+// Map promises to a UUID that they can be identified by
+const PromiseKey = new WeakMap();
+/*
+ *
+ * @param getAccessToken - Async function that returns a promise that resolves to a string
+ * @returns a resolved string or null from the access token promise
+ */
+function getAuthTokenQueryKey(authTokenPromiseOrString) {
+    // Need to go by equality of the promise to avoid scenarios where
+    // 1. The promise is the same, but the function changes
+    // 2. The function is the same, but the promise is different ⚠️
+    //
+    // This does have the unfortunate side effect where if the function result
+    // isn't memoized somehow, then it will invalidate the query on every render.
+    // This doesn't occur with the current use case of getAccessToken from
+    // useAuth, but could in a custom implementation.
+    //
+    // Other things I explored:
+    // 1. Removing promise api, and force user to resolve the promise
+    //    themselves. The user can already do this with the string API, so
+    //    it's not necessary, and they could run into issues 1, or 2 if
+    //    implemented wrong.
+    // 2. Memoizing the function - this results in issue 2, where the function
+    //    is static, but the promise changes. I believe this actually is the
+    //    case with useAuth since it only sets the client once on initialization,
+    //    and binds the function to the client after that promise resolves.
+    if (typeof authTokenPromiseOrString === "string") {
+        return authTokenPromiseOrString;
+    }
+    const authTokenPromise = authTokenPromiseOrString;
+    // Cannot memoize on the function because it could remain the same while
+    // returning a different promise (and useAuth behaves this way).
+    const promiseKey = PromiseKey.get(authTokenPromise);
+    // Side effect, but we we're using a weak map, so it should be pretty safe
+    if (!promiseKey) {
+        const newPromiseKey = `${Math.random()}`;
+        PromiseKey.set(authTokenPromise, newPromiseKey);
+        return newPromiseKey;
+    }
+    else {
+        return promiseKey;
+    }
+}
+//# sourceMappingURL=api-provider.js.map

package/dist/esm/api/api-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-provider.js","sourceRoot":"","sources":["../../../src/api/api-provider.tsx"],"names":[],"mappings":";AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAiB/B,MAAM,UAAU,GAAG,KAAK,CAAC,aAAa,CAAwB,SAAS,CAAC,CAAC;AAQzE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,EAC1B,SAAS,EACT,OAAO,EACP,QAAQ,GACS,EAAE,EAAE;IACrB,MAAM,wBAAwB,GAC5B,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;IAC1D,MAAM,CAAC,cAAc,EAAE,iBAAiB,CAAC,GAAG,KAAK,CAAC,QAAQ,EAAkB,CAAC;IAC7E,MAAM,qBAAqB,GAAG,KAAK,CAAC,MAAM,EAAkB,CAAC;IAE7D,+DAA+D;IAC/D,gGAAgG;IAChG,2FAA2F;IAC3F,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,IAAI,qBAAqB,CAAC,OAAO,EAAE,CAAC;YAClC,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,cAAc,EAAE,CAAC;YACnB,qBAAqB,CAAC,OAAO,GAAG,WAAW,CAAC,GAAG,EAAE;gBAC/C,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,MAAM,aAAa,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;gBAEzD,+CAA+C;gBAC/C,IAAI,GAAG,GAAG,aAAa,EAAE,CAAC;oBACxB,iBAAiB,CAAC,SAAS,CAAC,CAAC;gBAC/B,CAAC;YACH,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,mBAAmB;QACjC,CAAC;QAED,OAAO,GAAG,EAAE;YACV,IAAI,qBAAqB,CAAC,OAAO,EAAE,CAAC;gBAClC,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC,CAAC;IACJ,CAAC,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC;IAErB,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CACzB,GAAG,EAAE,CAAC,CAAC;QACL,SAAS,EAAE,wBAAwB;QACnC,iBAAiB,EAAE,oBAAoB,CAAC,wBAAwB,CAAC;QACjE,OAAO;QACP,cAAc;QACd,iBAAiB;KAClB,CAAC,EACF,CAAC,wBAAwB,EAAE,OAAO,EAAE,cAAc,EAAE,iBAAiB,CAAC,CACvE,CAAC;IAEF,OAAO,KAAC,UAAU,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YAAG,QAAQ,GAAuB,CAAC;AAC7E,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,GAAG,EAAE;IACzB,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IAE7C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAAG,EAAE;IACzC,MAAM,EAAE,cAAc,EAAE,iBAAiB,EAAE,GAAG,MAAM,EAAE,CAAC;IAEvD,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,CAAC;AAC/C,CAAC,CAAC;AAEF,wDAAwD;AACxD,MAAM,UAAU,GAAG,IAAI,OAAO,EAA2B,CAAC;AAC1D;;;;GAIG;AACH,SAAS,oBAAoB,CAC3B,wBAAkD;IAElD,iEAAiE;IACjE,uDAAuD;IACvD,+DAA+D;IAC/D,EAAE;IACF,0EAA0E;IAC1E,6EAA6E;IAC7E,sEAAsE;IACtE,iDAAiD;IACjD,EAAE;IACF,2BAA2B;IAC3B,iEAAiE;IACjE,sEAAsE;IACtE,mEAAmE;IACnE,wBAAwB;IACxB,0EAA0E;IAC1E,wEAAwE;IACxE,6EAA6E;IAC7E,uEAAuE;IAEvE,IAAI,OAAO,wBAAwB,KAAK,QAAQ,EAAE,CAAC;QACjD,OAAO,wBAAwB,CAAC;IAClC,CAAC;IAED,MAAM,gBAAgB,GAAG,wBAAwB,CAAC;IAElD,wEAAwE;IACxE,gEAAgE;IAEhE,MAAM,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;IAEpD,0EAA0E;IAC1E,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,aAAa,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;QACzC,UAAU,CAAC,GAAG,CAAC,gBAAgB,EAAE,aAAa,CAAC,CAAC;QAChD,OAAO,aAAa,CAAC;IACvB,CAAC;SAAM,CAAC;QACN,OAAO,UAAU,CAAC;IACpB,CAAC;AACH,CAAC"}

package/dist/esm/api/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const WIDGETS_API_VERSION = "1";
+//# sourceMappingURL=constants.d.ts.map

package/dist/esm/api/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/api/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB,MAAM,CAAC"}

package/dist/esm/api/constants.js

@@ -0,0 +1,2 @@
+export const WIDGETS_API_VERSION = "1";
+//# sourceMappingURL=constants.js.map

package/dist/esm/api/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/api/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,CAAC"}