@coinlist-co/react 0.0.1 → 0.1.0

package/dist/coinlist-client-BH_Cn_7u.d.cts

@@ -1,71 +0,0 @@
-import { A as AuthorizationCode, c as CodeVerifier, f as Config, O as OAuthAccessToken } from './oauth-session-g0OPJNKn.cjs';
-
-type AuthState = 'unknown' | 'logged-in' | 'logged-out';
-/** Discriminated error reasons from {@link CoinListClient.completeOauth}. */
-type OauthClientErrorReason = 'missing_state' | 'invalid_state' | 'missing_code' | 'missing_code_verifier';
-type OauthClientResult = {
-    type: 'ok';
-    code: AuthorizationCode;
-    codeVerifier: CodeVerifier;
-} | {
-    type: 'error';
-    reason: OauthClientErrorReason;
-};
-
-interface ClientConfig extends Config {
-    /**
-     * The SDK user must provide this function. It is responsible for fetching a
-     * valid {@link OAuthAccessToken}, or **null** for logged-out users. If your
-     * backend is in TypeScript, it is recommended to use
-     * {@link CoinListServer#accessToken} from `@/server/coinlist.server`.
-     */
-    getAccessToken: () => Promise<OAuthAccessToken | null>;
-}
-interface CoinListClient {
-    /**
-     * Calls the provided {@link ClientConfig.getAccessToken} lambda to determine
-     * the user's {@link AuthState}. This is called automatically by {@link CoinListProvider};
-     * you typically do not need to call it yourself unless you are using the client
-     * outside of the provider.
-     */
-    init(): Promise<AuthState>;
-    /**
-     * Returns the current auth state: `'logged-in'`, `'logged-out'`, or `'unknown'`.
-     * Returns **unknown** until {@link CoinListClient.init} has completed. It is
-     * recommended to use the `const { isReady, coinlist } = useCoinList()` hook to know when
-     * the SDK has initialized, or to manually await {@link CoinListClient.init}
-     * before relying on this value.
-     */
-    getAuthState(): AuthState;
-    /**
-     * Starts the OAuth flow with PKCE. Generates a random `state` and `code_verifier`,
-     * stores them in sessionStorage (for validation in {@link CoinListClient.completeOAuth}
-     * on redirect), then redirects the user to the CoinList authorization page. After
-     * the user authorizes, they are sent back to your application's redirect URI; call
-     * {@link CoinListClient.completeOAuth} on that page to finish the flow.
-     */
-    startOAuth(): Promise<void>;
-    /**
-     * Completes the OAuth flow on the FE with PKCE and state validation. Parses the
-     * redirect URL (state, code) and validates them against sessionStorage
-     * (state, code_verifier). The state check protects against CSRF (cross-site
-     * request forgery). Call this on the frontend page the user is redirected
-     * to after authorizing.
-     *
-     * On `ok`: Call your backend to exchange the short-lived `authorizationCode`
-     * (and the returned `codeVerifier`) for a long-lived session. If your backend
-     * is in TypeScript, you can use {@link CoinListServer#completeOAuth} from
-     * `@/server/coinlist.server` (CoinListServer) to perform that exchange.
-     *
-     * On `error`: `reason` is an {@link OauthClientErrorReason} (e.g. `'missing_state'`, `'invalid_state'`) so you can switch on it and surface a message to the user.
-     */
-    completeOAuth(): OauthClientResult;
-    /**
-     * Clears the in-memory access token. Note: you need to manually
-     * also logout on the backend via CoinListServer#logout to clear the session cookie.
-     */
-    logout(): void;
-}
-declare function createCoinListClient(config: ClientConfig): CoinListClient;
-
-export { type AuthState as A, type ClientConfig as C, type OauthClientErrorReason as O, type CoinListClient as a, type OauthClientResult as b, createCoinListClient as c };

package/dist/coinlist-client-fkB3J-2a.d.ts

@@ -1,71 +0,0 @@
-import { A as AuthorizationCode, c as CodeVerifier, f as Config, O as OAuthAccessToken } from './oauth-session-g0OPJNKn.js';
-
-type AuthState = 'unknown' | 'logged-in' | 'logged-out';
-/** Discriminated error reasons from {@link CoinListClient.completeOauth}. */
-type OauthClientErrorReason = 'missing_state' | 'invalid_state' | 'missing_code' | 'missing_code_verifier';
-type OauthClientResult = {
-    type: 'ok';
-    code: AuthorizationCode;
-    codeVerifier: CodeVerifier;
-} | {
-    type: 'error';
-    reason: OauthClientErrorReason;
-};
-
-interface ClientConfig extends Config {
-    /**
-     * The SDK user must provide this function. It is responsible for fetching a
-     * valid {@link OAuthAccessToken}, or **null** for logged-out users. If your
-     * backend is in TypeScript, it is recommended to use
-     * {@link CoinListServer#accessToken} from `@/server/coinlist.server`.
-     */
-    getAccessToken: () => Promise<OAuthAccessToken | null>;
-}
-interface CoinListClient {
-    /**
-     * Calls the provided {@link ClientConfig.getAccessToken} lambda to determine
-     * the user's {@link AuthState}. This is called automatically by {@link CoinListProvider};
-     * you typically do not need to call it yourself unless you are using the client
-     * outside of the provider.
-     */
-    init(): Promise<AuthState>;
-    /**
-     * Returns the current auth state: `'logged-in'`, `'logged-out'`, or `'unknown'`.
-     * Returns **unknown** until {@link CoinListClient.init} has completed. It is
-     * recommended to use the `const { isReady, coinlist } = useCoinList()` hook to know when
-     * the SDK has initialized, or to manually await {@link CoinListClient.init}
-     * before relying on this value.
-     */
-    getAuthState(): AuthState;
-    /**
-     * Starts the OAuth flow with PKCE. Generates a random `state` and `code_verifier`,
-     * stores them in sessionStorage (for validation in {@link CoinListClient.completeOAuth}
-     * on redirect), then redirects the user to the CoinList authorization page. After
-     * the user authorizes, they are sent back to your application's redirect URI; call
-     * {@link CoinListClient.completeOAuth} on that page to finish the flow.
-     */
-    startOAuth(): Promise<void>;
-    /**
-     * Completes the OAuth flow on the FE with PKCE and state validation. Parses the
-     * redirect URL (state, code) and validates them against sessionStorage
-     * (state, code_verifier). The state check protects against CSRF (cross-site
-     * request forgery). Call this on the frontend page the user is redirected
-     * to after authorizing.
-     *
-     * On `ok`: Call your backend to exchange the short-lived `authorizationCode`
-     * (and the returned `codeVerifier`) for a long-lived session. If your backend
-     * is in TypeScript, you can use {@link CoinListServer#completeOAuth} from
-     * `@/server/coinlist.server` (CoinListServer) to perform that exchange.
-     *
-     * On `error`: `reason` is an {@link OauthClientErrorReason} (e.g. `'missing_state'`, `'invalid_state'`) so you can switch on it and surface a message to the user.
-     */
-    completeOAuth(): OauthClientResult;
-    /**
-     * Clears the in-memory access token. Note: you need to manually
-     * also logout on the backend via CoinListServer#logout to clear the session cookie.
-     */
-    logout(): void;
-}
-declare function createCoinListClient(config: ClientConfig): CoinListClient;
-
-export { type AuthState as A, type ClientConfig as C, type OauthClientErrorReason as O, type CoinListClient as a, type OauthClientResult as b, createCoinListClient as c };