cabalspy-id 0.0.0-stage → 0.5.2

package/dist/react.d.cts

@@ -0,0 +1,315 @@
+import * as react from 'react';
+import { CSSProperties } from 'react';
+
+/**
+ * Response shapes of the CabalSpy ID Data API, derived from the server source.
+ *
+ * Every object type keeps an index signature-free shape for editor help, but
+ * the server may add fields later; nothing is stripped at runtime.
+ *
+ * Timestamps are ISO 8601 UTC strings ("2026-10-12T08:00:00Z"), except
+ * `PnlCalendarDay.date`, which is "DD-MM-YY" like the CabalSpy API.
+ */
+declare const CHAINS: readonly ["solana", "bnb", "base", "eth", "rh"];
+/** solana, bnb (BNB Chain), base, eth (Ethereum), rh (Robinhood Chain). */
+type Chain = (typeof CHAINS)[number];
+/**
+ * `thesis` lets your app post theses and replies, react and report in the
+ * user's name (Data API writes with `csid_id`, or the public thesis API and
+ * the thesis widget with the user's access token).
+ */
+type OidcScope = 'openid' | 'profile' | 'wallets' | 'onchain' | 'thesis' | 'offline_access';
+interface XProfileClaim {
+    id: string;
+    username: string;
+    followers: number | null;
+    following: number | null;
+    posts: number | null;
+    listed: number | null;
+    verified: boolean | null;
+    verified_type: string | null;
+    created_at: string | null;
+    fetched_at: string;
+}
+interface WalletClaim {
+    address: string;
+    family: string;
+    chains: Chain[];
+    verified_at: string | null;
+}
+/**
+ * Claims of an ID token or a userinfo response.
+ *
+ * When the platform is over its plan's user limit, `sub` is an anonymous
+ * `anon_…` id, `limited` is true and no profile or wallet data is included.
+ */
+interface CabalSpyIDClaims {
+    sub: string;
+    iss?: string;
+    aud?: string;
+    azp?: string;
+    exp?: number;
+    iat?: number;
+    auth_time?: number;
+    nonce?: string;
+    name?: string | null;
+    /** X handle; for people without X `tg.<telegram name>` (signed in with Telegram) or `id.<hex>` (signed in with Google). X handles never contain a dot. */
+    preferred_username?: string;
+    picture?: string | null;
+    /** https://id.cabalspy.xyz/u/<username> */
+    profile?: string;
+    kol_badge?: boolean;
+    /**
+     * Full X profile, userinfo only (scope `profile`). `null` for people who signed
+     * in with Telegram or Google and have not connected X. See hasX().
+     */
+    x?: XProfileClaim | null;
+    /** Verified wallets, userinfo only (scope `wallets`). */
+    wallets?: WalletClaim[];
+    /** Latest 7-day on-chain volume, userinfo only (scope `onchain`). */
+    onchain?: {
+        volume_7d_usd: number;
+        checked_at: string;
+    } | null;
+    /** A made-up sandbox identity; never trust it in production. */
+    sandbox?: boolean;
+    /** True when the platform is over its plan's user limit. */
+    limited?: boolean;
+    reason?: 'plan_user_limit' | string;
+    message?: string;
+    [claim: string]: unknown;
+}
+
+/**
+ * CabalSpy ID widgets for any web page (browser only, no framework):
+ * the "Sign in with CabalSpy ID" button and the token theses widget.
+ *
+ *   import { mountLoginButton, mountTheses } from 'cabalspy-id/widget';
+ *
+ *   mountLoginButton('#login', { clientId: 'csid_…', onLogin: ({ idToken }) => sendToBackend(idToken) });
+ *   mountTheses('#theses', { chain: 'solana', mint, clientId: 'csid_…', theme: 'dark' });
+ *
+ * Loads https://id.cabalspy.xyz/widget.js once and maps options to its data-*
+ * attributes. React components: `cabalspy-id/react` (also `cabalspy-id/widget/react`).
+ */
+
+declare const WIDGET_SRC = "https://id.cabalspy.xyz/widget.js";
+/** Detail of the widget's `csid:login` event. */
+interface CabalSpyIDLogin {
+    /** userinfo claims; `limited: true` (anonymous sub) when the platform is over its plan's user limit. */
+    user: CabalSpyIDClaims;
+    /** Send this to your backend and verify it there. */
+    idToken: string;
+    accessToken: string;
+    /** Seconds. */
+    expiresIn: number;
+}
+interface CabalSpyIDLogoutEvent {
+    clientId: string;
+}
+interface CabalSpyIDErrorEvent {
+    error: string;
+    description?: string;
+}
+/** The signed-in person as the widget remembers them on this device. */
+interface CabalSpyIDUserSummary {
+    sub: string;
+    username?: string;
+    name?: string | null;
+    picture?: string | null;
+    kol_badge?: boolean;
+    limited?: boolean;
+}
+/** The global the widget defines (window.CSID). */
+interface CSIDGlobal {
+    __loaded: true;
+    user: CabalSpyIDLogin | null;
+    mount(): void;
+    login(opts: {
+        clientId: string;
+        redirectUri?: string;
+        scope?: string;
+    }): Promise<void>;
+    setUser(clientId: string, user: CabalSpyIDUserSummary | CabalSpyIDClaims): void;
+    signOut(clientId: string): void;
+    onLogin(cb: (r: CabalSpyIDLogin) => void): void;
+    /** Thesis widgets on the page (data-csid-thesis). */
+    thesis?: {
+        /** Lets thesis widgets write as this user (access token with the scope "thesis"). */
+        setAccessToken(token: string | null): void;
+        /**
+         * Your own sign-in for the widget's "Sign in to write" (null removes it).
+         * See {@link setThesisSignInHandler}.
+         */
+        setSignInHandler?(handler: ThesisSignInHandler | null): void;
+        clear(): void;
+    };
+}
+/**
+ * Your page's sign-in for thesis widgets: obtain a thesis-capable access token
+ * for the person (e.g. your platform's own CabalSpy ID access token with the
+ * scope "thesis", from your backend), call `setThesisAccessToken(token)` (or
+ * `CSID.thesis.setAccessToken(token)`) and resolve `true`; resolve `false` when
+ * the person is not signed in.
+ */
+type ThesisSignInHandler = () => Promise<boolean> | boolean;
+declare global {
+    interface Window {
+        CSID?: CSIDGlobal;
+    }
+}
+/** Loads widget.js once per page. Resolves with window.CSID. */
+declare function loadCabalSpyIDWidget(src?: string): Promise<CSIDGlobal>;
+/** Design and behaviour of the login button. */
+interface LoginButtonOptions {
+    /** Your instance's client_id (`csid_…`). */
+    clientId: string;
+    /** Button design overrides; defaults come from the dashboard's button builder. */
+    theme?: 'dark' | 'light' | (string & {});
+    color?: string;
+    textColor?: string;
+    shape?: 'square' | 'rounded' | 'pill';
+    size?: 'sm' | 'md' | 'lg';
+    label?: string;
+    fullWidth?: boolean;
+    showLogo?: boolean;
+    /**
+     * Server-side apps: your own login route that starts the OIDC flow with your
+     * client secret. Without it, a public client runs PKCE in the browser.
+     */
+    href?: string;
+    /** Browser apps: redirect URI (default: the current page). */
+    redirectUri?: string;
+    /**
+     * Browser apps: requested scopes (default: openid profile). Add `thesis` so
+     * the person can write in thesis widgets on your page right after sign-in.
+     */
+    scope?: string | OidcScope[];
+    /** Server-side apps: the signed-in person's `sub`, to show the avatar menu. */
+    user?: string;
+    /** Server-side apps: where "Sign out" goes. */
+    logoutHref?: string;
+}
+/** Design and data of the token theses widget. */
+interface ThesisWidgetOptions {
+    /** solana | bnb | base | eth | rh */
+    chain: Chain;
+    /** Token mint / contract address. */
+    mint: string;
+    /**
+     * Required. Your instance's PUBLIC client_id (`csid_...`, shown in the
+     * dashboard next to the API key; not the API key). The widget sends it on
+     * every thesis API call; it also loads the design saved in the dashboard (the
+     * options below override it), credits posts to your app and enables `scope: 'instance'`.
+     */
+    clientId: string;
+    /** Default: dark */
+    theme?: 'dark' | 'light';
+    /** `global` (default): theses from every platform. `instance`: only the ones written on your instance. */
+    scope?: 'global' | 'instance';
+    /** Initial order. Default: new */
+    sort?: 'new' | 'top';
+    /** Font family, e.g. "Inter". */
+    font?: string;
+    /** Corner radius in px. Default: 12 */
+    radius?: number;
+    /** Colors (CSS colors, e.g. "#0d0f12"). */
+    bg?: string;
+    card?: string;
+    text?: string;
+    muted?: string;
+    border?: string;
+    accent?: string;
+    accentText?: string;
+    bull?: string;
+    bear?: string;
+    /** Show the token header. Default: true */
+    showHeader?: boolean;
+    /** Show the bull/bear sentiment bar. */
+    showSentiment?: boolean;
+    /** Denser layout. Default: false */
+    compact?: boolean;
+    /** Initial height in px; the widget then sizes itself to its content. Default: 520 */
+    height?: number;
+}
+
+interface CabalSpyLoginProps extends LoginButtonOptions {
+    /** Fired after a browser-app login (window event `csid:login`). */
+    onLogin?: (result: CabalSpyIDLogin) => void;
+    /** Fired when the person signs out from the menu (window event `csid:logout`). */
+    onLogout?: (event: CabalSpyIDLogoutEvent) => void;
+    /** Fired when the browser flow fails (window event `csid:error`). */
+    onError?: (event: CabalSpyIDErrorEvent) => void;
+    /** Override the widget URL (e.g. for a self-hosted copy). */
+    scriptSrc?: string;
+    className?: string;
+    style?: CSSProperties;
+    id?: string;
+}
+/** "Sign in with CabalSpy ID" button (the official widget). */
+declare function CabalSpyLogin(props: CabalSpyLoginProps): react.DetailedReactHTMLElement<{
+    id: string | undefined;
+    className: string | undefined;
+    style: CSSProperties | undefined;
+}, HTMLElement>;
+interface CabalSpyThesesProps extends ThesisWidgetOptions {
+    /**
+     * The signed-in user's CabalSpy ID access token (scope `thesis`), so they
+     * write without signing in again inside the widget. After a browser login
+     * through the widget this is set automatically. `null` signs the widget out.
+     */
+    accessToken?: string | null;
+    /**
+     * Your own sign-in for the widget's "Sign in to write" (instead of the page's
+     * login button / popup): get a thesis-capable access token for the person,
+     * pass it on (the `accessToken` prop or `setThesisAccessToken`) and resolve
+     * `true`; resolve `false` when they are not signed in. While set, the page is
+     * the source of truth for sign-in. Removed on unmount.
+     */
+    onSignIn?: ThesisSignInHandler;
+    scriptSrc?: string;
+    className?: string;
+    style?: CSSProperties;
+    id?: string;
+}
+/**
+ * Token theses widget: holders' theses on a token with their real position,
+ * replies, reactions, live updates.
+ *
+ *   <CabalSpyTheses chain="solana" mint={mint} clientId="csid_..." theme="dark" accessToken={accessToken} />
+ */
+declare function CabalSpyTheses(props: CabalSpyThesesProps): react.DetailedReactHTMLElement<{
+    id: string | undefined;
+    className: string | undefined;
+    style: CSSProperties | undefined;
+    key: string;
+}, HTMLElement>;
+interface UseCabalSpyIDOptions {
+    /** Your client_id; needed for login(), signOut() and the remembered user. */
+    clientId?: string;
+    /** Load widget.js on mount (so a returning OAuth redirect completes). Default: true */
+    load?: boolean;
+    scriptSrc?: string;
+}
+interface UseCabalSpyIDResult {
+    /** userinfo claims from this page's login, else the person remembered on this device. */
+    user: CabalSpyIDClaims | CabalSpyIDUserSummary | null;
+    /** Only right after a browser login on this page. Verify it on your backend. */
+    idToken: string | null;
+    accessToken: string | null;
+    /** True when the platform is over its plan's user limit for this person. */
+    limited: boolean;
+    /** widget.js is loaded. */
+    ready: boolean;
+    /** Starts the browser (public client) login flow. */
+    login: (opts?: {
+        redirectUri?: string;
+        scope?: string | OidcScope[];
+    }) => Promise<void>;
+    /** Forgets the person on this device and fires `csid:logout`. */
+    signOut: () => void;
+}
+/** Login state from the CabalSpy ID widget. */
+declare function useCabalSpyID(options?: UseCabalSpyIDOptions): UseCabalSpyIDResult;
+
+export { type CSIDGlobal, type CabalSpyIDErrorEvent, type CabalSpyIDLogin, type CabalSpyIDLogoutEvent, type CabalSpyIDUserSummary, CabalSpyLogin, type CabalSpyLoginProps, CabalSpyTheses, type CabalSpyThesesProps, type LoginButtonOptions, type ThesisSignInHandler, type ThesisWidgetOptions, type UseCabalSpyIDOptions, type UseCabalSpyIDResult, WIDGET_SRC, loadCabalSpyIDWidget, useCabalSpyID };

package/dist/react.d.ts

@@ -0,0 +1,315 @@
+import * as react from 'react';
+import { CSSProperties } from 'react';
+
+/**
+ * Response shapes of the CabalSpy ID Data API, derived from the server source.
+ *
+ * Every object type keeps an index signature-free shape for editor help, but
+ * the server may add fields later; nothing is stripped at runtime.
+ *
+ * Timestamps are ISO 8601 UTC strings ("2026-10-12T08:00:00Z"), except
+ * `PnlCalendarDay.date`, which is "DD-MM-YY" like the CabalSpy API.
+ */
+declare const CHAINS: readonly ["solana", "bnb", "base", "eth", "rh"];
+/** solana, bnb (BNB Chain), base, eth (Ethereum), rh (Robinhood Chain). */
+type Chain = (typeof CHAINS)[number];
+/**
+ * `thesis` lets your app post theses and replies, react and report in the
+ * user's name (Data API writes with `csid_id`, or the public thesis API and
+ * the thesis widget with the user's access token).
+ */
+type OidcScope = 'openid' | 'profile' | 'wallets' | 'onchain' | 'thesis' | 'offline_access';
+interface XProfileClaim {
+    id: string;
+    username: string;
+    followers: number | null;
+    following: number | null;
+    posts: number | null;
+    listed: number | null;
+    verified: boolean | null;
+    verified_type: string | null;
+    created_at: string | null;
+    fetched_at: string;
+}
+interface WalletClaim {
+    address: string;
+    family: string;
+    chains: Chain[];
+    verified_at: string | null;
+}
+/**
+ * Claims of an ID token or a userinfo response.
+ *
+ * When the platform is over its plan's user limit, `sub` is an anonymous
+ * `anon_…` id, `limited` is true and no profile or wallet data is included.
+ */
+interface CabalSpyIDClaims {
+    sub: string;
+    iss?: string;
+    aud?: string;
+    azp?: string;
+    exp?: number;
+    iat?: number;
+    auth_time?: number;
+    nonce?: string;
+    name?: string | null;
+    /** X handle; for people without X `tg.<telegram name>` (signed in with Telegram) or `id.<hex>` (signed in with Google). X handles never contain a dot. */
+    preferred_username?: string;
+    picture?: string | null;
+    /** https://id.cabalspy.xyz/u/<username> */
+    profile?: string;
+    kol_badge?: boolean;
+    /**
+     * Full X profile, userinfo only (scope `profile`). `null` for people who signed
+     * in with Telegram or Google and have not connected X. See hasX().
+     */
+    x?: XProfileClaim | null;
+    /** Verified wallets, userinfo only (scope `wallets`). */
+    wallets?: WalletClaim[];
+    /** Latest 7-day on-chain volume, userinfo only (scope `onchain`). */
+    onchain?: {
+        volume_7d_usd: number;
+        checked_at: string;
+    } | null;
+    /** A made-up sandbox identity; never trust it in production. */
+    sandbox?: boolean;
+    /** True when the platform is over its plan's user limit. */
+    limited?: boolean;
+    reason?: 'plan_user_limit' | string;
+    message?: string;
+    [claim: string]: unknown;
+}
+
+/**
+ * CabalSpy ID widgets for any web page (browser only, no framework):
+ * the "Sign in with CabalSpy ID" button and the token theses widget.
+ *
+ *   import { mountLoginButton, mountTheses } from 'cabalspy-id/widget';
+ *
+ *   mountLoginButton('#login', { clientId: 'csid_…', onLogin: ({ idToken }) => sendToBackend(idToken) });
+ *   mountTheses('#theses', { chain: 'solana', mint, clientId: 'csid_…', theme: 'dark' });
+ *
+ * Loads https://id.cabalspy.xyz/widget.js once and maps options to its data-*
+ * attributes. React components: `cabalspy-id/react` (also `cabalspy-id/widget/react`).
+ */
+
+declare const WIDGET_SRC = "https://id.cabalspy.xyz/widget.js";
+/** Detail of the widget's `csid:login` event. */
+interface CabalSpyIDLogin {
+    /** userinfo claims; `limited: true` (anonymous sub) when the platform is over its plan's user limit. */
+    user: CabalSpyIDClaims;
+    /** Send this to your backend and verify it there. */
+    idToken: string;
+    accessToken: string;
+    /** Seconds. */
+    expiresIn: number;
+}
+interface CabalSpyIDLogoutEvent {
+    clientId: string;
+}
+interface CabalSpyIDErrorEvent {
+    error: string;
+    description?: string;
+}
+/** The signed-in person as the widget remembers them on this device. */
+interface CabalSpyIDUserSummary {
+    sub: string;
+    username?: string;
+    name?: string | null;
+    picture?: string | null;
+    kol_badge?: boolean;
+    limited?: boolean;
+}
+/** The global the widget defines (window.CSID). */
+interface CSIDGlobal {
+    __loaded: true;
+    user: CabalSpyIDLogin | null;
+    mount(): void;
+    login(opts: {
+        clientId: string;
+        redirectUri?: string;
+        scope?: string;
+    }): Promise<void>;
+    setUser(clientId: string, user: CabalSpyIDUserSummary | CabalSpyIDClaims): void;
+    signOut(clientId: string): void;
+    onLogin(cb: (r: CabalSpyIDLogin) => void): void;
+    /** Thesis widgets on the page (data-csid-thesis). */
+    thesis?: {
+        /** Lets thesis widgets write as this user (access token with the scope "thesis"). */
+        setAccessToken(token: string | null): void;
+        /**
+         * Your own sign-in for the widget's "Sign in to write" (null removes it).
+         * See {@link setThesisSignInHandler}.
+         */
+        setSignInHandler?(handler: ThesisSignInHandler | null): void;
+        clear(): void;
+    };
+}
+/**
+ * Your page's sign-in for thesis widgets: obtain a thesis-capable access token
+ * for the person (e.g. your platform's own CabalSpy ID access token with the
+ * scope "thesis", from your backend), call `setThesisAccessToken(token)` (or
+ * `CSID.thesis.setAccessToken(token)`) and resolve `true`; resolve `false` when
+ * the person is not signed in.
+ */
+type ThesisSignInHandler = () => Promise<boolean> | boolean;
+declare global {
+    interface Window {
+        CSID?: CSIDGlobal;
+    }
+}
+/** Loads widget.js once per page. Resolves with window.CSID. */
+declare function loadCabalSpyIDWidget(src?: string): Promise<CSIDGlobal>;
+/** Design and behaviour of the login button. */
+interface LoginButtonOptions {
+    /** Your instance's client_id (`csid_…`). */
+    clientId: string;
+    /** Button design overrides; defaults come from the dashboard's button builder. */
+    theme?: 'dark' | 'light' | (string & {});
+    color?: string;
+    textColor?: string;
+    shape?: 'square' | 'rounded' | 'pill';
+    size?: 'sm' | 'md' | 'lg';
+    label?: string;
+    fullWidth?: boolean;
+    showLogo?: boolean;
+    /**
+     * Server-side apps: your own login route that starts the OIDC flow with your
+     * client secret. Without it, a public client runs PKCE in the browser.
+     */
+    href?: string;
+    /** Browser apps: redirect URI (default: the current page). */
+    redirectUri?: string;
+    /**
+     * Browser apps: requested scopes (default: openid profile). Add `thesis` so
+     * the person can write in thesis widgets on your page right after sign-in.
+     */
+    scope?: string | OidcScope[];
+    /** Server-side apps: the signed-in person's `sub`, to show the avatar menu. */
+    user?: string;
+    /** Server-side apps: where "Sign out" goes. */
+    logoutHref?: string;
+}
+/** Design and data of the token theses widget. */
+interface ThesisWidgetOptions {
+    /** solana | bnb | base | eth | rh */
+    chain: Chain;
+    /** Token mint / contract address. */
+    mint: string;
+    /**
+     * Required. Your instance's PUBLIC client_id (`csid_...`, shown in the
+     * dashboard next to the API key; not the API key). The widget sends it on
+     * every thesis API call; it also loads the design saved in the dashboard (the
+     * options below override it), credits posts to your app and enables `scope: 'instance'`.
+     */
+    clientId: string;
+    /** Default: dark */
+    theme?: 'dark' | 'light';
+    /** `global` (default): theses from every platform. `instance`: only the ones written on your instance. */
+    scope?: 'global' | 'instance';
+    /** Initial order. Default: new */
+    sort?: 'new' | 'top';
+    /** Font family, e.g. "Inter". */
+    font?: string;
+    /** Corner radius in px. Default: 12 */
+    radius?: number;
+    /** Colors (CSS colors, e.g. "#0d0f12"). */
+    bg?: string;
+    card?: string;
+    text?: string;
+    muted?: string;
+    border?: string;
+    accent?: string;
+    accentText?: string;
+    bull?: string;
+    bear?: string;
+    /** Show the token header. Default: true */
+    showHeader?: boolean;
+    /** Show the bull/bear sentiment bar. */
+    showSentiment?: boolean;
+    /** Denser layout. Default: false */
+    compact?: boolean;
+    /** Initial height in px; the widget then sizes itself to its content. Default: 520 */
+    height?: number;
+}
+
+interface CabalSpyLoginProps extends LoginButtonOptions {
+    /** Fired after a browser-app login (window event `csid:login`). */
+    onLogin?: (result: CabalSpyIDLogin) => void;
+    /** Fired when the person signs out from the menu (window event `csid:logout`). */
+    onLogout?: (event: CabalSpyIDLogoutEvent) => void;
+    /** Fired when the browser flow fails (window event `csid:error`). */
+    onError?: (event: CabalSpyIDErrorEvent) => void;
+    /** Override the widget URL (e.g. for a self-hosted copy). */
+    scriptSrc?: string;
+    className?: string;
+    style?: CSSProperties;
+    id?: string;
+}
+/** "Sign in with CabalSpy ID" button (the official widget). */
+declare function CabalSpyLogin(props: CabalSpyLoginProps): react.DetailedReactHTMLElement<{
+    id: string | undefined;
+    className: string | undefined;
+    style: CSSProperties | undefined;
+}, HTMLElement>;
+interface CabalSpyThesesProps extends ThesisWidgetOptions {
+    /**
+     * The signed-in user's CabalSpy ID access token (scope `thesis`), so they
+     * write without signing in again inside the widget. After a browser login
+     * through the widget this is set automatically. `null` signs the widget out.
+     */
+    accessToken?: string | null;
+    /**
+     * Your own sign-in for the widget's "Sign in to write" (instead of the page's
+     * login button / popup): get a thesis-capable access token for the person,
+     * pass it on (the `accessToken` prop or `setThesisAccessToken`) and resolve
+     * `true`; resolve `false` when they are not signed in. While set, the page is
+     * the source of truth for sign-in. Removed on unmount.
+     */
+    onSignIn?: ThesisSignInHandler;
+    scriptSrc?: string;
+    className?: string;
+    style?: CSSProperties;
+    id?: string;
+}
+/**
+ * Token theses widget: holders' theses on a token with their real position,
+ * replies, reactions, live updates.
+ *
+ *   <CabalSpyTheses chain="solana" mint={mint} clientId="csid_..." theme="dark" accessToken={accessToken} />
+ */
+declare function CabalSpyTheses(props: CabalSpyThesesProps): react.DetailedReactHTMLElement<{
+    id: string | undefined;
+    className: string | undefined;
+    style: CSSProperties | undefined;
+    key: string;
+}, HTMLElement>;
+interface UseCabalSpyIDOptions {
+    /** Your client_id; needed for login(), signOut() and the remembered user. */
+    clientId?: string;
+    /** Load widget.js on mount (so a returning OAuth redirect completes). Default: true */
+    load?: boolean;
+    scriptSrc?: string;
+}
+interface UseCabalSpyIDResult {
+    /** userinfo claims from this page's login, else the person remembered on this device. */
+    user: CabalSpyIDClaims | CabalSpyIDUserSummary | null;
+    /** Only right after a browser login on this page. Verify it on your backend. */
+    idToken: string | null;
+    accessToken: string | null;
+    /** True when the platform is over its plan's user limit for this person. */
+    limited: boolean;
+    /** widget.js is loaded. */
+    ready: boolean;
+    /** Starts the browser (public client) login flow. */
+    login: (opts?: {
+        redirectUri?: string;
+        scope?: string | OidcScope[];
+    }) => Promise<void>;
+    /** Forgets the person on this device and fires `csid:logout`. */
+    signOut: () => void;
+}
+/** Login state from the CabalSpy ID widget. */
+declare function useCabalSpyID(options?: UseCabalSpyIDOptions): UseCabalSpyIDResult;
+
+export { type CSIDGlobal, type CabalSpyIDErrorEvent, type CabalSpyIDLogin, type CabalSpyIDLogoutEvent, type CabalSpyIDUserSummary, CabalSpyLogin, type CabalSpyLoginProps, CabalSpyTheses, type CabalSpyThesesProps, type LoginButtonOptions, type ThesisSignInHandler, type ThesisWidgetOptions, type UseCabalSpyIDOptions, type UseCabalSpyIDResult, WIDGET_SRC, loadCabalSpyIDWidget, useCabalSpyID };