@usethrottle/auth 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,245 @@
+interface Customer {
+    id: string;
+    email: string;
+    emailVerified: boolean;
+    firstName?: string | null;
+    lastName?: string | null;
+    phone?: string | null;
+    company?: string | null;
+    acceptsMarketing?: boolean;
+}
+interface Session {
+    accessToken: string;
+    expiresAt: string;
+    refreshToken: string;
+    customer: Customer;
+}
+/**
+ * Defined here rather than in `storage.ts` so `ThrottleAuthConfig` can name it
+ * without importing a module that does not exist until Task 2. `storage.ts`
+ * imports and re-exports it.
+ */
+interface AuthStorage {
+    get(key: string): string | null | Promise<string | null>;
+    set(key: string, value: string): void | Promise<void>;
+    remove(key: string): void | Promise<void>;
+}
+interface ThrottleAuthConfig {
+    publishableKey: string;
+    baseUrl?: string;
+    storage?: AuthStorage;
+    /** Called when a route needs a step-up proof. Return the buyer's password, or null to cancel. */
+    onStepUpRequired?: () => Promise<string | null>;
+}
+interface ProfilePatch {
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    company?: string | null;
+    acceptsMarketing?: boolean;
+}
+interface AddressInput {
+    label?: string;
+    firstName?: string;
+    lastName?: string;
+    company?: string;
+    addressLine1: string;
+    addressLine2?: string;
+    city: string;
+    stateProvince?: string;
+    postalCode?: string;
+    countryCode: string;
+    phone?: string;
+    isDefault?: boolean;
+}
+interface Address {
+    id: string;
+    label: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    company: string | null;
+    addressLine1: string;
+    addressLine2: string | null;
+    city: string;
+    stateProvince: string | null;
+    postalCode: string | null;
+    countryCode: string;
+    phone: string | null;
+    isDefault: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface PaymentMethod {
+    id: string;
+    methodType: string;
+    cardBrand: string | null;
+    cardLastFour: string | null;
+    cardExpMonth: number | null;
+    cardExpYear: number | null;
+    isDefault: boolean;
+    createdAt: string;
+}
+interface Order {
+    id: string;
+    orderNumber: string;
+    status: string;
+    type: string;
+    paymentStatus: string;
+    currency: string;
+    subtotal: number;
+    taxTotal: number;
+    discountTotal: number;
+    shippingTotal: number;
+    total: number;
+    buyerVatNumber: string | null;
+    taxReverseCharge: boolean;
+    billingAddress: unknown | null;
+    shippingAddress: unknown | null;
+    discountCode: string | null;
+    subscriptionId: string | null;
+    cancelledAt: string | null;
+    completedAt: string | null;
+    closedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface Invoice {
+    id: string;
+    number: string;
+    status: string;
+    currency: string;
+    subtotal: number;
+    taxTotal: number;
+    shippingTotal: number;
+    discountTotal: number;
+    total: number;
+    amountRefunded: number;
+    issuedAt: string;
+    dueAt: string | null;
+    periodStart: string | null;
+    periodEnd: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface Subscription {
+    id: string;
+    status: string;
+    planReference: string;
+    planName: string | null;
+    interval: string;
+    amount: number;
+    quantity: number;
+    currency: string;
+    currentPeriodStart: string;
+    currentPeriodEnd: string;
+    trialEnd: string | null;
+    cancelledAt: string | null;
+    cancelAtPeriodEnd: boolean;
+    pendingPlanReference: string | null;
+    pendingPlanName: string | null;
+    pendingInterval: string | null;
+    pendingQuantity: number | null;
+    pausedAt: string | null;
+    lastPaymentAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+
+type AuthStatus = 'loading' | 'authenticated' | 'unauthenticated';
+interface AuthSnapshot {
+    status: AuthStatus;
+    customer: Customer | null;
+    /**
+     * False here does NOT only mean "we emailed them and they have not clicked".
+     * While it is false the API may also be withholding pre-existing account
+     * data behind the claim cutoff — empty order lists and a 403 on `PATCH /me`
+     * are expected, not broken. See the plan header.
+     */
+    emailVerified: boolean;
+}
+
+interface DeviceSession {
+    id: string;
+    userAgent: string | null;
+    ipPrefix: string | null;
+    createdAt: string;
+    lastUsedAt: string;
+    current: boolean;
+}
+interface ThrottleAuth {
+    register(email: string, password: string): Promise<{
+        status: 'active' | 'pending';
+    }>;
+    signIn(email: string, password: string): Promise<void>;
+    signOut(): Promise<void>;
+    signOutEverywhere(): Promise<void>;
+    restore(): Promise<void>;
+    getSnapshot(): AuthSnapshot;
+    subscribe(fn: (s: AuthSnapshot) => void): () => void;
+    stepUp(password: string): Promise<void>;
+    call<T = any>(method: string, path: string, body?: unknown): Promise<T>;
+    verifyEmail(token: string): Promise<void>;
+    resendVerification(): Promise<void>;
+    forgotPassword(email: string): Promise<void>;
+    resetPassword(token: string, password: string): Promise<void>;
+    changePassword(password: string): Promise<void>;
+    listSessions(): Promise<DeviceSession[]>;
+    revokeSession(id: string): Promise<void>;
+}
+declare function createThrottleAuth(config: ThrottleAuthConfig): ThrottleAuth;
+
+declare class ThrottleAuthError extends Error {
+    readonly code: string;
+    readonly statusCode: number;
+    readonly retryAfter?: number;
+    readonly details?: unknown;
+    constructor(args: {
+        code: string;
+        message: string;
+        statusCode: number;
+        retryAfter?: number;
+        details?: unknown;
+    });
+}
+
+declare function memoryStorage(): AuthStorage;
+/**
+ * localStorage when it works, memory when it does not. Safari private mode,
+ * hardened browser settings and server-side rendering all make localStorage
+ * either absent or throwing; none of them may take the storefront down.
+ */
+declare function localStorageAdapter(): AuthStorage;
+
+interface Page {
+    cursor?: string;
+    limit?: number;
+}
+interface ThrottleAccount {
+    getProfile(): Promise<Customer>;
+    updateProfile(patch: ProfilePatch): Promise<Customer>;
+    listAddresses(): Promise<Address[]>;
+    createAddress(input: AddressInput): Promise<Address>;
+    updateAddress(id: string, patch: Partial<AddressInput>): Promise<Address>;
+    deleteAddress(id: string): Promise<void>;
+    listPaymentMethods(): Promise<PaymentMethod[]>;
+    setDefaultPaymentMethod(id: string): Promise<PaymentMethod>;
+    deletePaymentMethod(id: string): Promise<void>;
+    listOrders(page?: Page): Promise<Order[]>;
+    getOrder(id: string): Promise<Order>;
+    listInvoices(page?: Page): Promise<Invoice[]>;
+    getInvoice(id: string): Promise<Invoice>;
+    listSubscriptions(page?: Page): Promise<Subscription[]>;
+    getSubscription(id: string): Promise<Subscription>;
+    cancelSubscription(id: string, opts?: {
+        atPeriodEnd?: boolean;
+    }): Promise<Subscription>;
+    pauseSubscription(id: string): Promise<Subscription>;
+    resumeSubscription(id: string): Promise<Subscription>;
+    claimCart(cartId: string): Promise<{
+        cartId: string;
+        customerId: string;
+    }>;
+}
+declare function createAccount(auth: ThrottleAuth): ThrottleAccount;
+
+export { type Address, type AddressInput, type AuthSnapshot, type AuthStatus, type AuthStorage, type Customer, type DeviceSession, type Invoice, type Order, type Page, type PaymentMethod, type ProfilePatch, type Session, type Subscription, type ThrottleAccount, type ThrottleAuth, type ThrottleAuthConfig, ThrottleAuthError, createAccount, createThrottleAuth, localStorageAdapter, memoryStorage };

package/dist/index.d.ts

@@ -0,0 +1,245 @@
+interface Customer {
+    id: string;
+    email: string;
+    emailVerified: boolean;
+    firstName?: string | null;
+    lastName?: string | null;
+    phone?: string | null;
+    company?: string | null;
+    acceptsMarketing?: boolean;
+}
+interface Session {
+    accessToken: string;
+    expiresAt: string;
+    refreshToken: string;
+    customer: Customer;
+}
+/**
+ * Defined here rather than in `storage.ts` so `ThrottleAuthConfig` can name it
+ * without importing a module that does not exist until Task 2. `storage.ts`
+ * imports and re-exports it.
+ */
+interface AuthStorage {
+    get(key: string): string | null | Promise<string | null>;
+    set(key: string, value: string): void | Promise<void>;
+    remove(key: string): void | Promise<void>;
+}
+interface ThrottleAuthConfig {
+    publishableKey: string;
+    baseUrl?: string;
+    storage?: AuthStorage;
+    /** Called when a route needs a step-up proof. Return the buyer's password, or null to cancel. */
+    onStepUpRequired?: () => Promise<string | null>;
+}
+interface ProfilePatch {
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    company?: string | null;
+    acceptsMarketing?: boolean;
+}
+interface AddressInput {
+    label?: string;
+    firstName?: string;
+    lastName?: string;
+    company?: string;
+    addressLine1: string;
+    addressLine2?: string;
+    city: string;
+    stateProvince?: string;
+    postalCode?: string;
+    countryCode: string;
+    phone?: string;
+    isDefault?: boolean;
+}
+interface Address {
+    id: string;
+    label: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    company: string | null;
+    addressLine1: string;
+    addressLine2: string | null;
+    city: string;
+    stateProvince: string | null;
+    postalCode: string | null;
+    countryCode: string;
+    phone: string | null;
+    isDefault: boolean;
+    createdAt: string;
+    updatedAt: string;
+}
+interface PaymentMethod {
+    id: string;
+    methodType: string;
+    cardBrand: string | null;
+    cardLastFour: string | null;
+    cardExpMonth: number | null;
+    cardExpYear: number | null;
+    isDefault: boolean;
+    createdAt: string;
+}
+interface Order {
+    id: string;
+    orderNumber: string;
+    status: string;
+    type: string;
+    paymentStatus: string;
+    currency: string;
+    subtotal: number;
+    taxTotal: number;
+    discountTotal: number;
+    shippingTotal: number;
+    total: number;
+    buyerVatNumber: string | null;
+    taxReverseCharge: boolean;
+    billingAddress: unknown | null;
+    shippingAddress: unknown | null;
+    discountCode: string | null;
+    subscriptionId: string | null;
+    cancelledAt: string | null;
+    completedAt: string | null;
+    closedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface Invoice {
+    id: string;
+    number: string;
+    status: string;
+    currency: string;
+    subtotal: number;
+    taxTotal: number;
+    shippingTotal: number;
+    discountTotal: number;
+    total: number;
+    amountRefunded: number;
+    issuedAt: string;
+    dueAt: string | null;
+    periodStart: string | null;
+    periodEnd: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface Subscription {
+    id: string;
+    status: string;
+    planReference: string;
+    planName: string | null;
+    interval: string;
+    amount: number;
+    quantity: number;
+    currency: string;
+    currentPeriodStart: string;
+    currentPeriodEnd: string;
+    trialEnd: string | null;
+    cancelledAt: string | null;
+    cancelAtPeriodEnd: boolean;
+    pendingPlanReference: string | null;
+    pendingPlanName: string | null;
+    pendingInterval: string | null;
+    pendingQuantity: number | null;
+    pausedAt: string | null;
+    lastPaymentAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+
+type AuthStatus = 'loading' | 'authenticated' | 'unauthenticated';
+interface AuthSnapshot {
+    status: AuthStatus;
+    customer: Customer | null;
+    /**
+     * False here does NOT only mean "we emailed them and they have not clicked".
+     * While it is false the API may also be withholding pre-existing account
+     * data behind the claim cutoff — empty order lists and a 403 on `PATCH /me`
+     * are expected, not broken. See the plan header.
+     */
+    emailVerified: boolean;
+}
+
+interface DeviceSession {
+    id: string;
+    userAgent: string | null;
+    ipPrefix: string | null;
+    createdAt: string;
+    lastUsedAt: string;
+    current: boolean;
+}
+interface ThrottleAuth {
+    register(email: string, password: string): Promise<{
+        status: 'active' | 'pending';
+    }>;
+    signIn(email: string, password: string): Promise<void>;
+    signOut(): Promise<void>;
+    signOutEverywhere(): Promise<void>;
+    restore(): Promise<void>;
+    getSnapshot(): AuthSnapshot;
+    subscribe(fn: (s: AuthSnapshot) => void): () => void;
+    stepUp(password: string): Promise<void>;
+    call<T = any>(method: string, path: string, body?: unknown): Promise<T>;
+    verifyEmail(token: string): Promise<void>;
+    resendVerification(): Promise<void>;
+    forgotPassword(email: string): Promise<void>;
+    resetPassword(token: string, password: string): Promise<void>;
+    changePassword(password: string): Promise<void>;
+    listSessions(): Promise<DeviceSession[]>;
+    revokeSession(id: string): Promise<void>;
+}
+declare function createThrottleAuth(config: ThrottleAuthConfig): ThrottleAuth;
+
+declare class ThrottleAuthError extends Error {
+    readonly code: string;
+    readonly statusCode: number;
+    readonly retryAfter?: number;
+    readonly details?: unknown;
+    constructor(args: {
+        code: string;
+        message: string;
+        statusCode: number;
+        retryAfter?: number;
+        details?: unknown;
+    });
+}
+
+declare function memoryStorage(): AuthStorage;
+/**
+ * localStorage when it works, memory when it does not. Safari private mode,
+ * hardened browser settings and server-side rendering all make localStorage
+ * either absent or throwing; none of them may take the storefront down.
+ */
+declare function localStorageAdapter(): AuthStorage;
+
+interface Page {
+    cursor?: string;
+    limit?: number;
+}
+interface ThrottleAccount {
+    getProfile(): Promise<Customer>;
+    updateProfile(patch: ProfilePatch): Promise<Customer>;
+    listAddresses(): Promise<Address[]>;
+    createAddress(input: AddressInput): Promise<Address>;
+    updateAddress(id: string, patch: Partial<AddressInput>): Promise<Address>;
+    deleteAddress(id: string): Promise<void>;
+    listPaymentMethods(): Promise<PaymentMethod[]>;
+    setDefaultPaymentMethod(id: string): Promise<PaymentMethod>;
+    deletePaymentMethod(id: string): Promise<void>;
+    listOrders(page?: Page): Promise<Order[]>;
+    getOrder(id: string): Promise<Order>;
+    listInvoices(page?: Page): Promise<Invoice[]>;
+    getInvoice(id: string): Promise<Invoice>;
+    listSubscriptions(page?: Page): Promise<Subscription[]>;
+    getSubscription(id: string): Promise<Subscription>;
+    cancelSubscription(id: string, opts?: {
+        atPeriodEnd?: boolean;
+    }): Promise<Subscription>;
+    pauseSubscription(id: string): Promise<Subscription>;
+    resumeSubscription(id: string): Promise<Subscription>;
+    claimCart(cartId: string): Promise<{
+        cartId: string;
+        customerId: string;
+    }>;
+}
+declare function createAccount(auth: ThrottleAuth): ThrottleAccount;
+
+export { type Address, type AddressInput, type AuthSnapshot, type AuthStatus, type AuthStorage, type Customer, type DeviceSession, type Invoice, type Order, type Page, type PaymentMethod, type ProfilePatch, type Session, type Subscription, type ThrottleAccount, type ThrottleAuth, type ThrottleAuthConfig, ThrottleAuthError, createAccount, createThrottleAuth, localStorageAdapter, memoryStorage };

package/dist/index.js

@@ -0,0 +1,16 @@
+import "./chunk-ZMNCURDE.js";
+import {
+  ThrottleAuthError,
+  createAccount,
+  createThrottleAuth,
+  localStorageAdapter,
+  memoryStorage
+} from "./chunk-NQU7HM23.js";
+export {
+  ThrottleAuthError,
+  createAccount,
+  createThrottleAuth,
+  localStorageAdapter,
+  memoryStorage
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}