@synqauth/plugin-siws

@synqauth/plugin-siwsCopy Anchor Link

MountRequestCopy Anchor Link

Type. Calls the app's route mount, from its own page: what

type MountRequest = (path: string, init?: RequestInit) => Promise<Response>;

SIWS_PLUGIN_IDCopy Anchor Link

Constant. The plugin's id: its server half's routes are under it, and its actions under it in usePlugin.

const SIWS_PLUGIN_ID: "siws"

SiwsActionsCopy Anchor Link

Interface. The browser half's actions.

interface SiwsActions {
    signIn: (wallet: Wallet, options?: SiwsSignInOptions) => Promise<SiwsResult<null>>;
}

siwsPluginCopy Anchor Link

Function. The SIWS plugin's browser half: a wallet's sign-in from the app's own page, through the route mount.

function siwsPlugin(options?: SiwsPluginOptions): SiwsPlugin

SiwsPluginCopy Anchor Link

Interface. The SIWS plugin's browser half, in SynqClientPlugin's shape: for <SynqProvider plugins> or @synqauth/nextjs/client.

interface SiwsPlugin {
    readonly id: typeof SIWS_PLUGIN_ID;
    actions: (request: MountRequest) => SiwsActions;
}

SiwsPluginOptionsCopy Anchor Link

Interface. What siwsPlugin() takes.

interface SiwsPluginOptions {
    navigate?: (url: string) => void;
    fetch?: typeof fetch;
}

SiwsResultCopy Anchor Link

Type. A call's outcome: its data, or the SynqError it failed with.

type SiwsResult<T> = {
    readonly data: T;
    readonly error: null;
} | {
    readonly data: null;
    readonly error: SynqError;
};

SiwsSignInOptionsCopy Anchor Link

Interface. What signIn takes besides the wallet.

interface SiwsSignInOptions {
    returnTo?: string;
    account?: WalletAccount;
}

@synqauth/plugin-siws/serverCopy Anchor Link

SiwsRouteContextCopy Anchor Link

Interface. What a server plugin's route is handed: the part of

interface SiwsRouteContext {
    readonly issuer: string;
    readonly clientId: string;
}

siwsServerPluginCopy Anchor Link

Function. The SIWS plugin's server half, for synqAuth({ plugins }): it tells the page which issuer and app to ask for a sign-in request.

function siwsServerPlugin(): SiwsServerPlugin

SiwsServerPluginCopy Anchor Link

Interface. The server half, in

interface SiwsServerPlugin {
    readonly id: 'siws';
    readonly routes: {
        readonly 'GET /config': (context: SiwsRouteContext, request: Request) => Response;
    };
}

See every package.