cauthy-auth 0.1.0 → 0.3.0

package/dist/cauthy-DsUNqjg6.d.mts

@@ -1,56 +0,0 @@
-import { S as Session, c as SessionStatus, b as SessionOrganization, P as PublicSession, a as CauthyOptions } from './types-BwCjBn-K.mjs';
-
-/** What `resolve` answers: who is there, and the cookies that must go back. */
-interface Resolved {
-    session: Session | null;
-    status: SessionStatus;
-    /** `Set-Cookie` values to send with the response. Empty when nothing changed. */
-    cookies: string[];
-}
-interface Cauthy {
-    /** Serves the routes under `basePath`: login, callback, session, refresh, logout, account. */
-    handler(request: Request): Promise<Response>;
-    /**
-     * Who is signed in, or null.
-     *
-     * Give it the response's headers and a session that needs renewing is
-     * renewed on the spot, its new cookie added to them. Without them an
-     * expired session reads as null (see `status`): renewing changes the
-     * cookie, and a cookie nobody sends back is a session lost.
-     */
-    getSession(request: Request, responseHeaders?: Headers): Promise<Session | null>;
-    /** Whether somebody is signed in, nobody is, or the session must be renewed first. */
-    status(request: Request): Promise<SessionStatus>;
-    /**
-     * The session, renewed when it has to be, and the cookies to send back.
-     * The caller MUST send `cookies` with its response.
-     */
-    resolve(request: Request): Promise<Resolved>;
-    /**
-     * For a route only a signed-in person may see: the session, or the response
-     * to give instead — a redirect to sign in (or to renew) for a page, a 401
-     * for anything else.
-     */
-    protect(request: Request): Promise<{
-        session: Session;
-        response?: undefined;
-    } | {
-        session?: undefined;
-        response: Response;
-    }>;
-    /** The organizations the person belongs to (of `system`, when set), with their role in each. */
-    organizations(session: Session): Promise<SessionOrganization[]>;
-    /** What the browser may be told of a session. */
-    toPublic(session: Session): Promise<PublicSession>;
-    /** Paths of this application that start a sign-in, a sign-out, or open the account page. */
-    urls: {
-        signIn(returnTo?: string): string;
-        signOut(): string;
-        account(returnTo?: string): string;
-        session: string;
-    };
-    options: Readonly<Required<Pick<CauthyOptions, 'issuer' | 'clientId' | 'basePath' | 'afterSignIn' | 'afterSignOut' | 'cookieName'>>>;
-}
-declare function createCauthy(given?: CauthyOptions): Cauthy;
-
-export { type Cauthy as C, type Resolved as R, createCauthy as c };

package/dist/types-BwCjBn-K.d.mts

@@ -1,97 +0,0 @@
-/** How an application is set up to sign its people in with Cauthy. */
-interface CauthyOptions {
-    /** Cauthy's public address, e.g. `https://id.example.com`. Default: `CAUTHY_ISSUER`. */
-    issuer?: string;
-    /** The application's OAuth client id. Default: `CAUTHY_CLIENT_ID`. */
-    clientId?: string;
-    /** Its secret, when the client is confidential. Default: `CAUTHY_CLIENT_SECRET`. */
-    clientSecret?: string;
-    /**
-     * The key the session cookie is encrypted with: any string of 32 characters
-     * or more, kept on the server. Default: `CAUTHY_SECRET`.
-     */
-    secret?: string;
-    /**
-     * The system this application is, as its organizations are filed under in
-     * Cauthy (`"pondari"`). When set, a session's organizations are that
-     * system's. Default: `CAUTHY_SYSTEM`.
-     */
-    system?: string;
-    /** Where the routes are mounted. Default: `/api/auth`. */
-    basePath?: string;
-    /**
-     * The application's own public origin (`https://app.example.com`), for the
-     * redirect URI. Default: the origin of each request, which is right unless
-     * a proxy hides it.
-     */
-    baseURL?: string;
-    /** Where a person lands after signing in, when no `return_to` was asked. Default: `/`. */
-    afterSignIn?: string;
-    /** Where a person lands after signing out. Default: `/`. */
-    afterSignOut?: string;
-    /** Name of the session cookie. Default: `cauthy_session`. */
-    cookieName?: string;
-    /** `fetch` to reach Cauthy with. Default: the global one. */
-    fetch?: typeof fetch;
-}
-/** The person signed in. Every moment is UTC. */
-interface SessionUser {
-    id: string;
-    email: string;
-    name: string;
-    emailVerified: boolean;
-    /**
-     * True when the account ran out of time to confirm its address: let it read
-     * and refuse its writes.
-     */
-    restricted: boolean;
-    /** When an unconfirmed address stops being enough (ISO 8601, UTC), if there is a deadline. */
-    emailVerifyBy?: string;
-    /** The language the person reads in ("es", "en-US"), when Cauthy knows it. */
-    locale?: string;
-}
-/** A value JSON can carry. What crosses from server to browser is typed as this, never `unknown`. */
-type JsonValue = string | number | boolean | null | JsonValue[] | {
-    [key: string]: JsonValue;
-};
-/** An organization the person belongs to, with their role in it. */
-interface SessionOrganization {
-    id: string;
-    system: string;
-    name: string;
-    kind: string;
-    externalId?: string;
-    role: string;
-    /** What the system keeps about the organization, as it filed it in Cauthy. */
-    metadata: Record<string, JsonValue>;
-}
-/** A signed-in person, as the server sees them. */
-interface Session {
-    user: SessionUser;
-    /** The Cauthy tenant the account is of. */
-    tenantId: string;
-    /** The roles the account holds in that tenant. */
-    roles: string[];
-    /**
-     * Cauthy's access token for this person: send it as `Authorization: Bearer`
-     * to another service that verifies Cauthy's tokens. Never give it to the browser.
-     */
-    accessToken: string;
-    /** When the access token expires and the session is checked with Cauthy again (ISO 8601, UTC). */
-    expiresAt: string;
-}
-/** What the browser is told of a session: who, and their organizations — never a token. */
-interface PublicSession {
-    user: SessionUser;
-    tenantId: string;
-    roles: string[];
-    organizations: SessionOrganization[];
-    expiresAt: string;
-}
-/** Why there is no session. */
-type SessionStatus = 'authenticated' | 'unauthenticated' | 'expired';
-declare class CauthyConfigError extends Error {
-    constructor(message: string);
-}
-
-export { CauthyConfigError as C, type JsonValue as J, type PublicSession as P, type Session as S, type CauthyOptions as a, type SessionOrganization as b, type SessionStatus as c, type SessionUser as d };

package/dist/types-BwCjBn-K.d.ts

@@ -1,97 +0,0 @@
-/** How an application is set up to sign its people in with Cauthy. */
-interface CauthyOptions {
-    /** Cauthy's public address, e.g. `https://id.example.com`. Default: `CAUTHY_ISSUER`. */
-    issuer?: string;
-    /** The application's OAuth client id. Default: `CAUTHY_CLIENT_ID`. */
-    clientId?: string;
-    /** Its secret, when the client is confidential. Default: `CAUTHY_CLIENT_SECRET`. */
-    clientSecret?: string;
-    /**
-     * The key the session cookie is encrypted with: any string of 32 characters
-     * or more, kept on the server. Default: `CAUTHY_SECRET`.
-     */
-    secret?: string;
-    /**
-     * The system this application is, as its organizations are filed under in
-     * Cauthy (`"pondari"`). When set, a session's organizations are that
-     * system's. Default: `CAUTHY_SYSTEM`.
-     */
-    system?: string;
-    /** Where the routes are mounted. Default: `/api/auth`. */
-    basePath?: string;
-    /**
-     * The application's own public origin (`https://app.example.com`), for the
-     * redirect URI. Default: the origin of each request, which is right unless
-     * a proxy hides it.
-     */
-    baseURL?: string;
-    /** Where a person lands after signing in, when no `return_to` was asked. Default: `/`. */
-    afterSignIn?: string;
-    /** Where a person lands after signing out. Default: `/`. */
-    afterSignOut?: string;
-    /** Name of the session cookie. Default: `cauthy_session`. */
-    cookieName?: string;
-    /** `fetch` to reach Cauthy with. Default: the global one. */
-    fetch?: typeof fetch;
-}
-/** The person signed in. Every moment is UTC. */
-interface SessionUser {
-    id: string;
-    email: string;
-    name: string;
-    emailVerified: boolean;
-    /**
-     * True when the account ran out of time to confirm its address: let it read
-     * and refuse its writes.
-     */
-    restricted: boolean;
-    /** When an unconfirmed address stops being enough (ISO 8601, UTC), if there is a deadline. */
-    emailVerifyBy?: string;
-    /** The language the person reads in ("es", "en-US"), when Cauthy knows it. */
-    locale?: string;
-}
-/** A value JSON can carry. What crosses from server to browser is typed as this, never `unknown`. */
-type JsonValue = string | number | boolean | null | JsonValue[] | {
-    [key: string]: JsonValue;
-};
-/** An organization the person belongs to, with their role in it. */
-interface SessionOrganization {
-    id: string;
-    system: string;
-    name: string;
-    kind: string;
-    externalId?: string;
-    role: string;
-    /** What the system keeps about the organization, as it filed it in Cauthy. */
-    metadata: Record<string, JsonValue>;
-}
-/** A signed-in person, as the server sees them. */
-interface Session {
-    user: SessionUser;
-    /** The Cauthy tenant the account is of. */
-    tenantId: string;
-    /** The roles the account holds in that tenant. */
-    roles: string[];
-    /**
-     * Cauthy's access token for this person: send it as `Authorization: Bearer`
-     * to another service that verifies Cauthy's tokens. Never give it to the browser.
-     */
-    accessToken: string;
-    /** When the access token expires and the session is checked with Cauthy again (ISO 8601, UTC). */
-    expiresAt: string;
-}
-/** What the browser is told of a session: who, and their organizations — never a token. */
-interface PublicSession {
-    user: SessionUser;
-    tenantId: string;
-    roles: string[];
-    organizations: SessionOrganization[];
-    expiresAt: string;
-}
-/** Why there is no session. */
-type SessionStatus = 'authenticated' | 'unauthenticated' | 'expired';
-declare class CauthyConfigError extends Error {
-    constructor(message: string);
-}
-
-export { CauthyConfigError as C, type JsonValue as J, type PublicSession as P, type Session as S, type CauthyOptions as a, type SessionOrganization as b, type SessionStatus as c, type SessionUser as d };