@pelicanplatform/components 1.0.0

package/dist/PublicClient/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from "./PublicClient";
+export * from "./PublicClient";
+//# sourceMappingURL=index.d.ts.map

package/dist/PublicClient/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/PublicClient/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,cAAc,gBAAgB,CAAC"}

package/dist/PublicClient/index.js

@@ -0,0 +1,3 @@
+export { default } from "./PublicClient";
+export * from "./PublicClient";
+//# sourceMappingURL=index.js.map

package/dist/PublicClient/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/PublicClient/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,cAAc,gBAAgB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from "./Client";
+export * from "./Client";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,cAAc,UAAU,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export { default } from "./Client";
+export * from "./Client";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,cAAc,UAAU,CAAC"}

package/dist/usePelicanClient/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./useAuthExchange";
+export * from "./useCodeVerifier";
+//# sourceMappingURL=index.d.ts.map

package/dist/usePelicanClient/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/usePelicanClient/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC"}

package/dist/usePelicanClient/index.js

@@ -0,0 +1,3 @@
+export * from "./useAuthExchange";
+export * from "./useCodeVerifier";
+//# sourceMappingURL=index.js.map

package/dist/usePelicanClient/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/usePelicanClient/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC"}

package/dist/usePelicanClient/useAuthExchange.d.ts

@@ -0,0 +1,41 @@
+import { Namespace, Token } from "@pelicanplatform/web-client";
+export interface AuthExchangeResult {
+    federationHostname: string;
+    namespacePrefix: string;
+    token: Token;
+}
+export interface UseAuthExchangeOptions {
+    /** Whether authentication is enabled */
+    enabled: boolean;
+    /** The PKCE code verifier for the OAuth flow */
+    codeVerifier: string | null;
+    /** Callback invoked when a token is successfully obtained */
+    onTokenReceived?: (result: AuthExchangeResult) => void;
+    /** Function to get namespace metadata by federation hostname and prefix */
+    getNamespace: (federationHostname: string, namespacePrefix: string) => Namespace | undefined;
+}
+export interface UseAuthExchangeReturn {
+    /** Whether the auth code exchange is ongoing */
+    loading: boolean;
+    /** Error message if exchange failed */
+    error: string | null;
+}
+/**
+ * Hook to manage OAuth authorization code exchange flow.
+ *
+ * On mount, checks URL params for an authorization code and exchanges it
+ * for an access token using the PKCE code verifier. The token is returned
+ * via the onTokenReceived callback for storage in the parent component.
+ *
+ * This hook is designed to run once per page load and handles:
+ * - Parsing authorization code from URL params
+ * - Validating required OAuth credentials exist
+ * - Exchanging code for token
+ * - Cleaning up URL params
+ *
+ * @param options Configuration options for the auth exchange
+ * @returns Status of the exchange process
+ */
+export declare function useAuthExchange({ enabled, codeVerifier, onTokenReceived, getNamespace }: UseAuthExchangeOptions): UseAuthExchangeReturn;
+export default useAuthExchange;
+//# sourceMappingURL=useAuthExchange.d.ts.map

package/dist/usePelicanClient/useAuthExchange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAuthExchange.d.ts","sourceRoot":"","sources":["../../src/usePelicanClient/useAuthExchange.tsx"],"names":[],"mappings":"AACA,OAAO,EAGH,SAAS,EACT,KAAK,EACR,MAAM,6BAA6B,CAAC;AAErC,MAAM,WAAW,kBAAkB;IAC/B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,KAAK,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACnC,wCAAwC;IACxC,OAAO,EAAE,OAAO,CAAC;IACjB,gDAAgD;IAChD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,6DAA6D;IAC7D,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC;IACvD,2EAA2E;IAC3E,YAAY,EAAE,CAAC,kBAAkB,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,KAAK,SAAS,GAAG,SAAS,CAAC;CAChG;AAED,MAAM,WAAW,qBAAqB;IAClC,gDAAgD;IAChD,OAAO,EAAE,OAAO,CAAC;IACjB,uCAAuC;IACvC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,eAAe,CAAC,EAC5B,OAAO,EACP,YAAY,EACZ,eAAe,EACf,YAAY,EACf,EAAE,sBAAsB,GAAG,qBAAqB,CAsFhD;AAED,eAAe,eAAe,CAAC"}

package/dist/usePelicanClient/useAuthExchange.js

@@ -0,0 +1,89 @@
+import { useEffect, useState } from "react";
+import { getAuthorizationCode, getToken } from "@pelicanplatform/web-client";
+/**
+ * Hook to manage OAuth authorization code exchange flow.
+ *
+ * On mount, checks URL params for an authorization code and exchanges it
+ * for an access token using the PKCE code verifier. The token is returned
+ * via the onTokenReceived callback for storage in the parent component.
+ *
+ * This hook is designed to run once per page load and handles:
+ * - Parsing authorization code from URL params
+ * - Validating required OAuth credentials exist
+ * - Exchanging code for token
+ * - Cleaning up URL params
+ *
+ * @param options Configuration options for the auth exchange
+ * @returns Status of the exchange process
+ */
+export function useAuthExchange({ enabled, codeVerifier, onTokenReceived, getNamespace }) {
+    const [error, setError] = useState(null);
+    const [loading, setLoading] = useState(false);
+    useEffect(() => {
+        if (!enabled) {
+            return;
+        }
+        async function exchange() {
+            const { federationHostname, namespacePrefix, code } = getAuthorizationCode();
+            try {
+                // Check if we have an authorization code to exchange
+                if (!code || !federationHostname || !namespacePrefix || !codeVerifier) {
+                    // No code to exchange - this is normal for non-redirect page loads
+                    setLoading(false);
+                    return;
+                }
+                setLoading(true);
+                // Get namespace metadata (includes OAuth client credentials)
+                const namespace = getNamespace(federationHostname, namespacePrefix);
+                if (!namespace) {
+                    const errorMsg = `Cannot exchange code: namespace metadata not found for ${namespacePrefix}`;
+                    console.error(errorMsg);
+                    setError(errorMsg);
+                    setLoading(false);
+                    return;
+                }
+                if (!namespace.clientId || !namespace.clientSecret) {
+                    const errorMsg = `Cannot exchange code: missing client credentials for namespace ${namespacePrefix}`;
+                    console.error(errorMsg);
+                    setError(errorMsg);
+                    setLoading(false);
+                    return;
+                }
+                if (!namespace.oidcConfiguration) {
+                    const errorMsg = `Cannot exchange code: missing OIDC configuration for namespace ${namespacePrefix}`;
+                    console.error(errorMsg);
+                    setError(errorMsg);
+                    setLoading(false);
+                    return;
+                }
+                // Exchange authorization code for access token
+                const tokenData = await getToken(namespace.oidcConfiguration, codeVerifier, namespace.clientId, namespace.clientSecret, code);
+                console.log("Obtained token via authorization code exchange:", tokenData);
+                // Notify parent component of successful token acquisition
+                if (onTokenReceived) {
+                    onTokenReceived({
+                        federationHostname,
+                        namespacePrefix,
+                        token: tokenData.accessToken,
+                    });
+                }
+            }
+            catch (e) {
+                const errorMsg = `Error during authorization code exchange: ${e}`;
+                console.error(errorMsg);
+                setError(errorMsg);
+            }
+            finally {
+                // Mark exchange as complete (whether successful or not)
+                setLoading(false);
+            }
+        }
+        exchange();
+    }, [enabled, codeVerifier, getNamespace, onTokenReceived]);
+    return {
+        loading,
+        error,
+    };
+}
+export default useAuthExchange;
+//# sourceMappingURL=useAuthExchange.js.map

package/dist/usePelicanClient/useAuthExchange.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useAuthExchange.js","sourceRoot":"","sources":["../../src/usePelicanClient/useAuthExchange.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EACH,oBAAoB,EACpB,QAAQ,EAGX,MAAM,6BAA6B,CAAC;AA0BrC;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,eAAe,CAAC,EAC5B,OAAO,EACP,YAAY,EACZ,eAAe,EACf,YAAY,EACS;IACrB,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAgB,IAAI,CAAC,CAAC;IACxD,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAE9C,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,CAAC,OAAO,EAAE,CAAC;YACX,OAAO;QACX,CAAC;QAED,KAAK,UAAU,QAAQ;YACnB,MAAM,EAAE,kBAAkB,EAAE,eAAe,EAAE,IAAI,EAAE,GAAG,oBAAoB,EAAE,CAAC;YAE7E,IAAI,CAAC;gBACD,qDAAqD;gBACrD,IAAI,CAAC,IAAI,IAAI,CAAC,kBAAkB,IAAI,CAAC,eAAe,IAAI,CAAC,YAAY,EAAE,CAAC;oBACpE,mEAAmE;oBACnE,UAAU,CAAC,KAAK,CAAC,CAAC;oBAClB,OAAO;gBACX,CAAC;gBAED,UAAU,CAAC,IAAI,CAAC,CAAC;gBAEjB,6DAA6D;gBAC7D,MAAM,SAAS,GAAG,YAAY,CAAC,kBAAkB,EAAE,eAAe,CAAC,CAAC;gBAEpE,IAAI,CAAC,SAAS,EAAE,CAAC;oBACb,MAAM,QAAQ,GAAG,0DAA0D,eAAe,EAAE,CAAC;oBAC7F,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBACxB,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBACnB,UAAU,CAAC,KAAK,CAAC,CAAC;oBAClB,OAAO;gBACX,CAAC;gBAED,IAAI,CAAC,SAAS,CAAC,QAAQ,IAAI,CAAC,SAAS,CAAC,YAAY,EAAE,CAAC;oBACjD,MAAM,QAAQ,GAAG,kEAAkE,eAAe,EAAE,CAAC;oBACrG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBACxB,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBACnB,UAAU,CAAC,KAAK,CAAC,CAAC;oBAClB,OAAO;gBACX,CAAC;gBAED,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,CAAC;oBAC/B,MAAM,QAAQ,GAAG,kEAAkE,eAAe,EAAE,CAAC;oBACrG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;oBACxB,QAAQ,CAAC,QAAQ,CAAC,CAAC;oBACnB,UAAU,CAAC,KAAK,CAAC,CAAC;oBAClB,OAAO;gBACX,CAAC;gBAED,+CAA+C;gBAC/C,MAAM,SAAS,GAAG,MAAM,QAAQ,CAC5B,SAAS,CAAC,iBAAiB,EAC3B,YAAY,EACZ,SAAS,CAAC,QAAQ,EAClB,SAAS,CAAC,YAAY,EACtB,IAAI,CACP,CAAC;gBAEF,OAAO,CAAC,GAAG,CAAC,iDAAiD,EAAE,SAAS,CAAC,CAAC;gBAE1E,0DAA0D;gBAC1D,IAAI,eAAe,EAAE,CAAC;oBAClB,eAAe,CAAC;wBACZ,kBAAkB;wBAClB,eAAe;wBACf,KAAK,EAAE,SAAS,CAAC,WAAW;qBAC/B,CAAC,CAAC;gBACP,CAAC;YAEL,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,MAAM,QAAQ,GAAG,6CAA6C,CAAC,EAAE,CAAC;gBAClE,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBACxB,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACvB,CAAC;oBAAS,CAAC;gBACP,wDAAwD;gBACxD,UAAU,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;QACL,CAAC;QAED,QAAQ,EAAE,CAAC;IACf,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;IAE3D,OAAO;QACH,OAAO;QACP,KAAK;KACR,CAAC;AACN,CAAC;AAED,eAAe,eAAe,CAAC"}

package/dist/usePelicanClient/useCodeVerifier.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Hook to manage OAuth PKCE code verifier generation and persistence.
+ *
+ * The code verifier is automatically generated on first use and persisted
+ * in session storage for the duration of the OAuth flow.
+ *
+ * @returns {[string | null, () => string]} A tuple containing the current code verifier
+ * and a function to ensure a code verifier exists (generating one if needed)
+ */
+export declare function useCodeVerifier(): [string | null, () => string];
+export default useCodeVerifier;
+//# sourceMappingURL=useCodeVerifier.d.ts.map

package/dist/usePelicanClient/useCodeVerifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCodeVerifier.d.ts","sourceRoot":"","sources":["../../src/usePelicanClient/useCodeVerifier.tsx"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,wBAAgB,eAAe,IAAI,CAAC,MAAM,GAAG,IAAI,EAAE,MAAM,MAAM,CAAC,CA6B/D;AAED,eAAe,eAAe,CAAC"}

package/dist/usePelicanClient/useCodeVerifier.js

@@ -0,0 +1,37 @@
+import { useEffect } from "react";
+import { generateCodeVerifier } from "@pelicanplatform/web-client";
+import { useSessionStorage } from "./useSessionStorage";
+/**
+ * Hook to manage OAuth PKCE code verifier generation and persistence.
+ *
+ * The code verifier is automatically generated on first use and persisted
+ * in session storage for the duration of the OAuth flow.
+ *
+ * @returns {[string | null, () => string]} A tuple containing the current code verifier
+ * and a function to ensure a code verifier exists (generating one if needed)
+ */
+export function useCodeVerifier() {
+    const [codeVerifier, setCodeVerifier] = useSessionStorage("pelican-wc-cv", null);
+    // Auto-generate on mount if missing
+    useEffect(() => {
+        if (!codeVerifier) {
+            const cv = generateCodeVerifier();
+            setCodeVerifier(cv);
+        }
+    }, [codeVerifier, setCodeVerifier]);
+    /**
+     * Ensures a code verifier exists, generating one if needed.
+     * Returns the current or newly generated code verifier.
+     */
+    const ensureCodeVerifier = () => {
+        if (codeVerifier) {
+            return codeVerifier;
+        }
+        const cv = generateCodeVerifier();
+        setCodeVerifier(cv);
+        return cv;
+    };
+    return [codeVerifier, ensureCodeVerifier];
+}
+export default useCodeVerifier;
+//# sourceMappingURL=useCodeVerifier.js.map

package/dist/usePelicanClient/useCodeVerifier.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useCodeVerifier.js","sourceRoot":"","sources":["../../src/usePelicanClient/useCodeVerifier.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe;IAC3B,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,iBAAiB,CACvD,eAAe,EACf,IAAI,CACL,CAAC;IAEF,oCAAoC;IACpC,SAAS,CAAC,GAAG,EAAE;QACX,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,MAAM,EAAE,GAAG,oBAAoB,EAAE,CAAC;YAClC,eAAe,CAAC,EAAE,CAAC,CAAC;QACxB,CAAC;IACL,CAAC,EAAE,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC,CAAC;IAEpC;;;OAGG;IACH,MAAM,kBAAkB,GAAG,GAAW,EAAE;QACpC,IAAI,YAAY,EAAE,CAAC;YACf,OAAO,YAAY,CAAC;QACxB,CAAC;QAED,MAAM,EAAE,GAAG,oBAAoB,EAAE,CAAC;QAClC,eAAe,CAAC,EAAE,CAAC,CAAC;QACpB,OAAO,EAAE,CAAC;IACd,CAAC,CAAC;IAEF,OAAO,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;AAC9C,CAAC;AAED,eAAe,eAAe,CAAC"}

package/dist/usePelicanClient/useEventCallback.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Custom hook that creates a memoized event callback.
+ * @template Args - An array of argument types for the event callback.
+ * @template R - The return type of the event callback.
+ * @param {(...args: Args) => R} fn - The callback function.
+ * @returns {(...args: Args) => R} A memoized event callback function.
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-event-callback)
+ * @example
+ * ```tsx
+ * const handleClick = useEventCallback((event) => {
+ *   // Handle the event here
+ * });
+ * ```
+ */
+export declare function useEventCallback<Args extends unknown[], R>(fn: (...args: Args) => R): (...args: Args) => R;
+export declare function useEventCallback<Args extends unknown[], R>(fn: ((...args: Args) => R) | undefined): ((...args: Args) => R) | undefined;
+//# sourceMappingURL=useEventCallback.d.ts.map

package/dist/usePelicanClient/useEventCallback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useEventCallback.d.ts","sourceRoot":"","sources":["../../src/usePelicanClient/useEventCallback.tsx"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,gBAAgB,CAAC,IAAI,SAAS,OAAO,EAAE,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,CAAC,CAAC;AAC5G,wBAAgB,gBAAgB,CAAC,IAAI,SAAS,OAAO,EAAE,EAAE,CAAC,EACtD,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,CAAC,CAAC,GAAG,SAAS,GACvC,CAAC,CAAC,GAAG,IAAI,EAAE,IAAI,KAAK,CAAC,CAAC,GAAG,SAAS,CAAC"}

package/dist/usePelicanClient/useEventCallback.js

@@ -0,0 +1,12 @@
+import { useCallback, useRef } from "react";
+import { useIsomorphicLayoutEffect } from "./useIsomorphicLayoutEffect";
+export function useEventCallback(fn) {
+    const ref = useRef(() => {
+        throw new Error("Cannot call an event handler while rendering.");
+    });
+    useIsomorphicLayoutEffect(() => {
+        ref.current = fn;
+    }, [fn]);
+    return useCallback((...args) => { var _a; return (_a = ref.current) === null || _a === void 0 ? void 0 : _a.call(ref, ...args); }, [ref]);
+}
+//# sourceMappingURL=useEventCallback.js.map

package/dist/usePelicanClient/useEventCallback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useEventCallback.js","sourceRoot":"","sources":["../../src/usePelicanClient/useEventCallback.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE5C,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAqBxE,MAAM,UAAU,gBAAgB,CAC5B,EAAsC;IAEtC,MAAM,GAAG,GAAG,MAAM,CAAY,GAAG,EAAE;QAC/B,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,yBAAyB,CAAC,GAAG,EAAE;QAC3B,GAAG,CAAC,OAAO,GAAG,EAAE,CAAC;IACrB,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAET,OAAO,WAAW,CAAC,CAAC,GAAG,IAAU,EAAE,EAAE,WAAC,OAAA,MAAA,GAAG,CAAC,OAAO,oDAAG,GAAG,IAAI,CAAC,CAAA,EAAA,EAAE,CAAC,GAAG,CAAC,CAAyB,CAAC;AACjG,CAAC"}

package/dist/usePelicanClient/useEventListener.d.ts

@@ -0,0 +1,7 @@
+import type { RefObject } from "react";
+declare function useEventListener<K extends keyof MediaQueryListEventMap>(eventName: K, handler: (event: MediaQueryListEventMap[K]) => void, element: RefObject<MediaQueryList>, options?: boolean | AddEventListenerOptions): void;
+declare function useEventListener<K extends keyof WindowEventMap>(eventName: K, handler: (event: WindowEventMap[K]) => void, element?: undefined, options?: boolean | AddEventListenerOptions): void;
+declare function useEventListener<K extends keyof HTMLElementEventMap & keyof SVGElementEventMap, T extends Element = K extends keyof HTMLElementEventMap ? HTMLDivElement : SVGElement>(eventName: K, handler: ((event: HTMLElementEventMap[K]) => void) | ((event: SVGElementEventMap[K]) => void), element: RefObject<T>, options?: boolean | AddEventListenerOptions): void;
+declare function useEventListener<K extends keyof DocumentEventMap>(eventName: K, handler: (event: DocumentEventMap[K]) => void, element: RefObject<Document>, options?: boolean | AddEventListenerOptions): void;
+export { useEventListener };
+//# sourceMappingURL=useEventListener.d.ts.map

package/dist/usePelicanClient/useEventListener.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useEventListener.d.ts","sourceRoot":"","sources":["../../src/usePelicanClient/useEventListener.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAKvC,iBAAS,gBAAgB,CAAC,CAAC,SAAS,MAAM,sBAAsB,EAC5D,SAAS,EAAE,CAAC,EACZ,OAAO,EAAE,CAAC,KAAK,EAAE,sBAAsB,CAAC,CAAC,CAAC,KAAK,IAAI,EACnD,OAAO,EAAE,SAAS,CAAC,cAAc,CAAC,EAClC,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAC5C,IAAI,CAAC;AAGR,iBAAS,gBAAgB,CAAC,CAAC,SAAS,MAAM,cAAc,EACpD,SAAS,EAAE,CAAC,EACZ,OAAO,EAAE,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,EAC3C,OAAO,CAAC,EAAE,SAAS,EACnB,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAC5C,IAAI,CAAC;AAGR,iBAAS,gBAAgB,CACrB,CAAC,SAAS,MAAM,mBAAmB,GAAG,MAAM,kBAAkB,EAC9D,CAAC,SAAS,OAAO,GAAG,CAAC,SAAS,MAAM,mBAAmB,GAAG,cAAc,GAAG,UAAU,EAErF,SAAS,EAAE,CAAC,EACZ,OAAO,EAAE,CAAC,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,EAC7F,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC,EACrB,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAC5C,IAAI,CAAC;AAGR,iBAAS,gBAAgB,CAAC,CAAC,SAAS,MAAM,gBAAgB,EACtD,SAAS,EAAE,CAAC,EACZ,OAAO,EAAE,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,KAAK,IAAI,EAC7C,OAAO,EAAE,SAAS,CAAC,QAAQ,CAAC,EAC5B,OAAO,CAAC,EAAE,OAAO,GAAG,uBAAuB,GAC5C,IAAI,CAAC;AA6ER,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/usePelicanClient/useEventListener.js

@@ -0,0 +1,57 @@
+import { useEffect, useRef } from "react";
+import { useIsomorphicLayoutEffect } from "./useIsomorphicLayoutEffect";
+/**
+ * Custom hook that attaches event listeners to DOM elements, the window, or media query lists.
+ * @template KW - The type of event for window events.
+ * @template KH - The type of event for HTML or SVG element events.
+ * @template KM - The type of event for media query list events.
+ * @template T - The type of the DOM element (default is `HTMLElement`).
+ * @param {KW | KH | KM} eventName - The name of the event to listen for.
+ * @param {(event: WindowEventMap[KW] | HTMLElementEventMap[KH] | SVGElementEventMap[KH] | MediaQueryListEventMap[KM] | Event) => void} handler - The event handler function.
+ * @param {RefObject<T>} [element] - The DOM element or media query list to attach the event listener to (optional).
+ * @param {boolean | AddEventListenerOptions} [options] - An options object that specifies characteristics about the event listener (optional).
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-event-listener)
+ * @example
+ * ```tsx
+ * // Example 1: Attach a window event listener
+ * useEventListener('resize', handleResize);
+ * ```
+ * @example
+ * ```tsx
+ * // Example 2: Attach a document event listener with options
+ * const elementRef = useRef(document);
+ * useEventListener('click', handleClick, elementRef, { capture: true });
+ * ```
+ * @example
+ * ```tsx
+ * // Example 3: Attach an element event listener
+ * const buttonRef = useRef<HTMLButtonElement>(null);
+ * useEventListener('click', handleButtonClick, buttonRef);
+ * ```
+ */
+function useEventListener(eventName, handler, element, options) {
+    // Create a ref that stores handler
+    const savedHandler = useRef(handler);
+    useIsomorphicLayoutEffect(() => {
+        savedHandler.current = handler;
+    }, [handler]);
+    useEffect(() => {
+        var _a;
+        // Define the listening target
+        const targetElement = (_a = element === null || element === void 0 ? void 0 : element.current) !== null && _a !== void 0 ? _a : window;
+        if (!(targetElement && targetElement.addEventListener))
+            return;
+        // Create event listener that calls handler function stored in ref
+        const listener = (event) => {
+            savedHandler.current(event);
+        };
+        targetElement.addEventListener(eventName, listener, options);
+        // Remove event listener on cleanup
+        return () => {
+            targetElement.removeEventListener(eventName, listener, options);
+        };
+    }, [eventName, element, options]);
+}
+export { useEventListener };
+//# sourceMappingURL=useEventListener.js.map

package/dist/usePelicanClient/useEventListener.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useEventListener.js","sourceRoot":"","sources":["../../src/usePelicanClient/useEventListener.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAI1C,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAqCxE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,SAAS,gBAAgB,CAMrB,SAAuB,EACvB,OAOS,EACT,OAAsB,EACtB,OAA2C;IAE3C,mCAAmC;IACnC,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAErC,yBAAyB,CAAC,GAAG,EAAE;QAC3B,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IACnC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAEd,SAAS,CAAC,GAAG,EAAE;;QACX,8BAA8B;QAC9B,MAAM,aAAa,GAAe,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,mCAAI,MAAM,CAAC;QAE7D,IAAI,CAAC,CAAC,aAAa,IAAI,aAAa,CAAC,gBAAgB,CAAC;YAAE,OAAO;QAE/D,kEAAkE;QAClE,MAAM,QAAQ,GAAmB,CAAC,KAAK,EAAE,EAAE;YACvC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC,CAAC;QAEF,aAAa,CAAC,gBAAgB,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QAE7D,mCAAmC;QACnC,OAAO,GAAG,EAAE;YACR,aAAa,CAAC,mBAAmB,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACpE,CAAC,CAAC;IACN,CAAC,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AACtC,CAAC;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/usePelicanClient/useIsomorphicLayoutEffect.d.ts

@@ -0,0 +1,16 @@
+import { useLayoutEffect } from "react";
+/**
+ * Custom hook that uses either `useLayoutEffect` or `useEffect` based on the environment (client-side or server-side).
+ * @param {Function} effect - The effect function to be executed.
+ * @param {Array<any>} [dependencies] - An array of dependencies for the effect (optional).
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-isomorphic-layout-effect)
+ * @example
+ * ```tsx
+ * useIsomorphicLayoutEffect(() => {
+ *   // Code to be executed during the layout phase on the client side
+ * }, [dependency1, dependency2]);
+ * ```
+ */
+export declare const useIsomorphicLayoutEffect: typeof useLayoutEffect;
+//# sourceMappingURL=useIsomorphicLayoutEffect.d.ts.map

package/dist/usePelicanClient/useIsomorphicLayoutEffect.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useIsomorphicLayoutEffect.d.ts","sourceRoot":"","sources":["../../src/usePelicanClient/useIsomorphicLayoutEffect.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAa,eAAe,EAAE,MAAM,OAAO,CAAC;AAEnD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,yBAAyB,wBAA8D,CAAC"}

package/dist/usePelicanClient/useIsomorphicLayoutEffect.js

@@ -0,0 +1,16 @@
+import { useEffect, useLayoutEffect } from "react";
+/**
+ * Custom hook that uses either `useLayoutEffect` or `useEffect` based on the environment (client-side or server-side).
+ * @param {Function} effect - The effect function to be executed.
+ * @param {Array<any>} [dependencies] - An array of dependencies for the effect (optional).
+ * @public
+ * @see [Documentation](https://usehooks-ts.com/react-hook/use-isomorphic-layout-effect)
+ * @example
+ * ```tsx
+ * useIsomorphicLayoutEffect(() => {
+ *   // Code to be executed during the layout phase on the client side
+ * }, [dependency1, dependency2]);
+ * ```
+ */
+export const useIsomorphicLayoutEffect = typeof window !== "undefined" ? useLayoutEffect : useEffect;
+//# sourceMappingURL=useIsomorphicLayoutEffect.js.map

package/dist/usePelicanClient/useIsomorphicLayoutEffect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useIsomorphicLayoutEffect.js","sourceRoot":"","sources":["../../src/usePelicanClient/useIsomorphicLayoutEffect.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,OAAO,CAAC;AAEnD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,OAAO,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC"}

package/dist/usePelicanClient/usePelicanClient.d.ts

@@ -0,0 +1,27 @@
+import { ObjectList, Collection } from "@pelicanplatform/web-client";
+export interface UsePelicanClientOptions {
+    /** The initial object URL to load */
+    objectUrl: string;
+    /** Whether to enable authentication features */
+    enableAuth?: boolean;
+}
+/**
+ * A React hook to manage Pelican client state and actions.
+ *
+ * The main pieces of state are `objectUrl`, `federationHostname`, and `objectPrefix`.
+ * These each represent:
+ * - `objectUrl`: The full Pelican URL, as inputed by the user
+ * - `federationHostname`: The hostname of the federation being accessed
+ * - `objectPrefix`: The prefix (namespace) of the object being accessed
+ */
+declare function usePelicanClient({ objectUrl, enableAuth }: UsePelicanClientOptions): {
+    loading: boolean;
+    collections: Collection[];
+    loginRequired: boolean;
+    getObjectList: () => Promise<ObjectList[] | undefined>;
+    handleLogin: () => Promise<void>;
+    handleDownload: (downloadObjectUrl: string) => Promise<void>;
+    handleUpload: (file: File, uploadObjectUrl?: string) => Promise<void>;
+};
+export default usePelicanClient;
+//# sourceMappingURL=usePelicanClient.d.ts.map

package/dist/usePelicanClient/usePelicanClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usePelicanClient.d.ts","sourceRoot":"","sources":["../../src/usePelicanClient/usePelicanClient.tsx"],"names":[],"mappings":"AAEA,OAAO,EAEL,UAAU,EAaV,UAAU,EAEX,MAAM,6BAA6B,CAAC;AAMrC,MAAM,WAAW,uBAAuB;IACtC,qCAAqC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;;;GAQG;AACH,iBAAS,gBAAgB,CAAC,EAAE,SAAS,EAAE,UAAiB,EAAE,EAAE,uBAAuB;;;;;;wCA2MhC,MAAM;yBA0BrB,IAAI,oBAAoB,MAAM;EA2BjE;AAED,eAAe,gBAAgB,CAAC"}