@koolbase/core 12.0.0 → 12.2.0

package/dist/cjs/fiscal.d.ts

@@ -0,0 +1,114 @@
+import { KoolbaseConfig } from './types.js';
+import { KoolbaseError } from './errors.js';
+/**
+ * The lifecycle status of a fiscal intent.
+ *
+ * A sale is durably recorded the moment `submit` returns; fiscal numbers and
+ * the authority's certification follow this state machine:
+ *
+ * - `queued` / `submitting` / `retrying` — sealed with allocated numbers;
+ *   delivery to the authority is in progress.
+ * - `fiscalized` — the authority answered; for certifying document kinds the
+ *   `certification` is present.
+ * - `blocked` — a precondition failed BEFORE any fiscal number was consumed
+ *   (see `blockedReason`). Resubmitting the same `clientRef` after fixing the
+ *   cause resumes it.
+ * - `attention` — the authority rejected the document, or its credential died
+ *   after sealing. An operator resolves it; the register's chain waits behind
+ *   it.
+ * - `voided` — terminally closed by an operator without fiscalization.
+ *
+ * `unknown` is the forward-compatible fallback: a status this SDK version has
+ * not heard of parses as unknown rather than throwing, so a server that grows
+ * a state does not break older clients.
+ */
+export type FiscalStatus = 'created' | 'blocked' | 'queued' | 'submitting' | 'retrying' | 'fiscalized' | 'attention' | 'voided' | 'unknown';
+/**
+ * The state of one fiscal intent.
+ *
+ * Jurisdiction-neutral by design: this SDK never learns a jurisdiction's
+ * vocabulary. Payloads travel as objects shaped by the device's adapter, and
+ * `certification` comes back as the authority granted it — for Ghana that
+ * means `ysdcregsig`, `ysdcrecnum`, `qr_code` and so on, which the SDK
+ * passes through without naming.
+ */
+export interface FiscalIntentResult {
+    intentId: string;
+    status: FiscalStatus;
+    /** Why a `blocked` intent stopped, when the server said. */
+    blockedReason?: string;
+    /** Fiscal numbers allocated at sealing. */
+    numbers?: Record<string, number>;
+    /** When the intent was sealed and its numbers allocated. */
+    sealedAt?: string;
+    /**
+     * What the authority granted, once `status` is `fiscalized`. This is the
+     * receipt-rendering payload: for Ghana, the signature, receipt number and
+     * QR verification URL.
+     */
+    certification?: Record<string, unknown>;
+}
+/** True once the authority has certified the document. */
+export declare function isFiscalized(r: FiscalIntentResult): boolean;
+/** True while delivery to the authority is still in progress. */
+export declare function isPending(r: FiscalIntentResult): boolean;
+/** A fiscal request that failed. Carries the HTTP status where there was one. */
+export declare class KoolbaseFiscalError extends KoolbaseError {
+    readonly statusCode?: number;
+    constructor(message: string, statusCode?: number);
+}
+/**
+ * Classify a response. Status and body in, result or error out.
+ *
+ * Exported for testability, and because auth handling belongs with the
+ * session hook rather than here — the same split the Flutter SDK makes.
+ */
+export declare function decodeFiscalResponse(status: number, body: string): Promise<FiscalIntentResult>;
+/**
+ * Koolbase Fiscal — submitting sales to a tax authority.
+ *
+ * Jurisdiction-neutral: the SDK moves payloads and reads back whatever the
+ * authority certified. Ghana's GRA E-VAT is the first jurisdiction; nothing
+ * here names it.
+ */
+export declare class KoolbaseFiscal {
+    private config;
+    private getToken;
+    private onSessionExpired?;
+    constructor(config: KoolbaseConfig, getToken: () => Promise<string | null>, onSessionExpired?: () => Promise<void>);
+    private buildHeaders;
+    private decode;
+    /**
+     * Submit a sale for fiscalization.
+     *
+     * The sale is durably recorded the moment this returns; fiscal numbers and
+     * the authority's certification follow asynchronously — poll `status()`
+     * with the same `clientRef` to watch it.
+     *
+     * **On timeout, do not resubmit blindly.** The sale may have fiscalized
+     * anyway: the request reached the server and the response was lost. Poll
+     * `status()` with the same `clientRef` instead, which is idempotent and
+     * tells you what actually happened.
+     *
+     * @param clientRef your own reference for this sale; the idempotency key
+     *   and the handle you poll and render receipts by.
+     */
+    submit(params: {
+        deviceId: string;
+        clientRef: string;
+        payload: Record<string, unknown>;
+        timeoutMs?: number;
+    }): Promise<FiscalIntentResult>;
+    /**
+     * Read an intent's current state by the reference it was submitted under.
+     *
+     * This is the receipt-rendering read: once the status is `fiscalized`, the
+     * `certification` carries what the receipt must show — for Ghana, the
+     * signature, receipt number and QR verification URL.
+     */
+    status(params: {
+        deviceId: string;
+        clientRef: string;
+        timeoutMs?: number;
+    }): Promise<FiscalIntentResult>;
+}

package/dist/cjs/fiscal.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KoolbaseFiscal = exports.KoolbaseFiscalError = void 0;
+exports.isFiscalized = isFiscalized;
+exports.isPending = isPending;
+exports.decodeFiscalResponse = decodeFiscalResponse;
+const errors_js_1 = require("./errors.js");
+const KNOWN_STATUSES = [
+    'created', 'blocked', 'queued', 'submitting',
+    'retrying', 'fiscalized', 'attention', 'voided',
+];
+function parseStatus(raw) {
+    return typeof raw === 'string' && KNOWN_STATUSES.includes(raw)
+        ? raw
+        : 'unknown';
+}
+/** True once the authority has certified the document. */
+function isFiscalized(r) {
+    return r.status === 'fiscalized';
+}
+/** True while delivery to the authority is still in progress. */
+function isPending(r) {
+    return r.status === 'queued'
+        || r.status === 'submitting'
+        || r.status === 'retrying';
+}
+/** A fiscal request that failed. Carries the HTTP status where there was one. */
+class KoolbaseFiscalError extends errors_js_1.KoolbaseError {
+    constructor(message, statusCode) {
+        super(message, 'fiscal_failed');
+        this.statusCode = statusCode;
+        this.name = 'KoolbaseFiscalError';
+        Object.setPrototypeOf(this, KoolbaseFiscalError.prototype);
+    }
+}
+exports.KoolbaseFiscalError = KoolbaseFiscalError;
+function resultFromJson(json) {
+    const numbers = json.numbers;
+    return {
+        intentId: String(json.intent_id ?? ''),
+        status: parseStatus(json.status),
+        blockedReason: json.blocked_reason,
+        numbers: numbers ?? undefined,
+        sealedAt: json.sealed_at,
+        certification: json.certification,
+    };
+}
+/**
+ * Classify a response. Status and body in, result or error out.
+ *
+ * Exported for testability, and because auth handling belongs with the
+ * session hook rather than here — the same split the Flutter SDK makes.
+ */
+async function decodeFiscalResponse(status, body) {
+    let parsed;
+    try {
+        parsed = JSON.parse(body);
+    }
+    catch {
+        throw new KoolbaseFiscalError(`fiscal: unreadable response (${status})`, status);
+    }
+    if ((status >= 200 && status < 300) || status === 202) {
+        return resultFromJson(parsed);
+    }
+    throw new KoolbaseFiscalError(parsed.error ?? 'fiscal: request failed', status);
+}
+// ─── KoolbaseFiscal ──────────────────────────────────────────────────────────
+/**
+ * Koolbase Fiscal — submitting sales to a tax authority.
+ *
+ * Jurisdiction-neutral: the SDK moves payloads and reads back whatever the
+ * authority certified. Ghana's GRA E-VAT is the first jurisdiction; nothing
+ * here names it.
+ */
+class KoolbaseFiscal {
+    constructor(config, getToken, onSessionExpired) {
+        this.config = config;
+        this.getToken = getToken;
+        this.onSessionExpired = onSessionExpired;
+    }
+    async buildHeaders() {
+        const token = await this.getToken();
+        return {
+            'Content-Type': 'application/json',
+            'x-api-key': this.config.publicKey,
+            ...(token ? { Authorization: `Bearer ${token}` } : {}),
+        };
+    }
+    async decode(res) {
+        if (res.status === 401 || res.status === 403) {
+            await this.onSessionExpired?.();
+            throw new errors_js_1.KoolbaseUnauthenticatedError(`fiscal: unauthenticated (${res.status})`);
+        }
+        return decodeFiscalResponse(res.status, await res.text());
+    }
+    /**
+     * Submit a sale for fiscalization.
+     *
+     * The sale is durably recorded the moment this returns; fiscal numbers and
+     * the authority's certification follow asynchronously — poll `status()`
+     * with the same `clientRef` to watch it.
+     *
+     * **On timeout, do not resubmit blindly.** The sale may have fiscalized
+     * anyway: the request reached the server and the response was lost. Poll
+     * `status()` with the same `clientRef` instead, which is idempotent and
+     * tells you what actually happened.
+     *
+     * @param clientRef your own reference for this sale; the idempotency key
+     *   and the handle you poll and render receipts by.
+     */
+    async submit(params) {
+        const controller = new AbortController();
+        const timer = setTimeout(() => controller.abort(), params.timeoutMs ?? 30000);
+        try {
+            const res = await fetch(`${this.config.baseUrl}/v1/sdk/fiscal/submit`, {
+                method: 'POST',
+                headers: await this.buildHeaders(),
+                signal: controller.signal,
+                body: JSON.stringify({
+                    device_id: params.deviceId,
+                    client_ref: params.clientRef,
+                    payload: params.payload,
+                }),
+            });
+            return await this.decode(res);
+        }
+        catch (e) {
+            if (e instanceof Error && e.name === 'AbortError') {
+                throw new KoolbaseFiscalError('fiscal submit timed out — the sale may still fiscalize; '
+                    + 'poll status with the same clientRef');
+            }
+            throw e;
+        }
+        finally {
+            clearTimeout(timer);
+        }
+    }
+    /**
+     * Read an intent's current state by the reference it was submitted under.
+     *
+     * This is the receipt-rendering read: once the status is `fiscalized`, the
+     * `certification` carries what the receipt must show — for Ghana, the
+     * signature, receipt number and QR verification URL.
+     */
+    async status(params) {
+        const controller = new AbortController();
+        const timer = setTimeout(() => controller.abort(), params.timeoutMs ?? 15000);
+        try {
+            const q = new URLSearchParams({
+                device_id: params.deviceId,
+                client_ref: params.clientRef,
+            });
+            const res = await fetch(`${this.config.baseUrl}/v1/sdk/fiscal/status?${q.toString()}`, { method: 'GET', headers: await this.buildHeaders(), signal: controller.signal });
+            return await this.decode(res);
+        }
+        catch (e) {
+            if (e instanceof Error && e.name === 'AbortError') {
+                throw new KoolbaseFiscalError('fiscal status timed out');
+            }
+            throw e;
+        }
+        finally {
+            clearTimeout(timer);
+        }
+    }
+}
+exports.KoolbaseFiscal = KoolbaseFiscal;

package/dist/cjs/index.d.ts

@@ -14,6 +14,8 @@ export { KoolbaseFunctions } from './functions.js';
 export { KoolbaseRealtime } from './realtime.js';
 export { KoolbaseStorage } from './storage.js';
 export { KoolbaseAnalytics } from './analytics.js';
+export { KoolbaseFiscal, KoolbaseFiscalError, decodeFiscalResponse, isFiscalized, isPending } from './fiscal.js';
+export type { FiscalIntentResult, FiscalStatus } from './fiscal.js';
 export { KoolbaseMessaging } from './messaging.js';
 export type { RegisterTokenOptions } from './messaging.js';
 export { getOrCreateDeviceId } from './device-id.js';

package/dist/cjs/index.js

@@ -19,7 +19,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.memoryPlatform = exports.getPlatform = exports.setPlatform = exports.RestoreResult = exports.koolbaseSdkVersion = exports.getOrCreateDeviceId = exports.KoolbaseMessaging = exports.KoolbaseAnalytics = exports.KoolbaseStorage = exports.KoolbaseRealtime = exports.KoolbaseFunctions = exports.KoolbaseFlags = exports.KoolbaseDatabase = exports.KoolbaseAuth = void 0;
+exports.memoryPlatform = exports.getPlatform = exports.setPlatform = exports.RestoreResult = exports.koolbaseSdkVersion = exports.getOrCreateDeviceId = exports.KoolbaseMessaging = exports.isPending = exports.isFiscalized = exports.decodeFiscalResponse = exports.KoolbaseFiscalError = exports.KoolbaseFiscal = exports.KoolbaseAnalytics = exports.KoolbaseStorage = exports.KoolbaseRealtime = exports.KoolbaseFunctions = exports.KoolbaseFlags = exports.KoolbaseDatabase = exports.KoolbaseAuth = void 0;
 __exportStar(require("./types.js"), exports);
 __exportStar(require("./errors.js"), exports);
 __exportStar(require("./aggregate.js"), exports);
@@ -43,6 +43,12 @@ var storage_js_1 = require("./storage.js");
 Object.defineProperty(exports, "KoolbaseStorage", { enumerable: true, get: function () { return storage_js_1.KoolbaseStorage; } });
 var analytics_js_1 = require("./analytics.js");
 Object.defineProperty(exports, "KoolbaseAnalytics", { enumerable: true, get: function () { return analytics_js_1.KoolbaseAnalytics; } });
+var fiscal_js_1 = require("./fiscal.js");
+Object.defineProperty(exports, "KoolbaseFiscal", { enumerable: true, get: function () { return fiscal_js_1.KoolbaseFiscal; } });
+Object.defineProperty(exports, "KoolbaseFiscalError", { enumerable: true, get: function () { return fiscal_js_1.KoolbaseFiscalError; } });
+Object.defineProperty(exports, "decodeFiscalResponse", { enumerable: true, get: function () { return fiscal_js_1.decodeFiscalResponse; } });
+Object.defineProperty(exports, "isFiscalized", { enumerable: true, get: function () { return fiscal_js_1.isFiscalized; } });
+Object.defineProperty(exports, "isPending", { enumerable: true, get: function () { return fiscal_js_1.isPending; } });
 var messaging_js_1 = require("./messaging.js");
 Object.defineProperty(exports, "KoolbaseMessaging", { enumerable: true, get: function () { return messaging_js_1.KoolbaseMessaging; } });
 var device_id_js_1 = require("./device-id.js");

package/dist/esm/auth-errors.d.ts

@@ -101,6 +101,14 @@ export declare class NetworkError extends KoolbaseAuthError {
 export declare class InvalidPhoneNumberError extends KoolbaseAuthError {
     constructor();
 }
+/**
+ * The project has switched off signing in with an emailed code — 403
+ * `email_code_disabled`. Applies to every address alike, so it reveals
+ * nothing about which accounts exist.
+ */
+export declare class EmailCodeDisabledError extends KoolbaseAuthError {
+    constructor();
+}
 export declare class OtpExpiredError extends KoolbaseAuthError {
     constructor();
 }
@@ -249,3 +257,29 @@ export declare class InvalidGoogleTokenError extends KoolbaseAuthError {
 export declare class GoogleEmailRequiredError extends KoolbaseAuthError {
     constructor();
 }
+/**
+ * The first factor passed and this account needs a second: sign-in is not
+ * finished. Pass `challengeToken` to `verifyMfa` with a code from the
+ * person's authenticator app, or to `verifyRecoveryCode`. Apps that never
+ * enable MFA never see this.
+ */
+export declare class MfaRequiredError extends KoolbaseAuthError {
+    readonly challengeToken: string;
+    readonly expiresAt?: string;
+    constructor(challengeToken: string, expiresAt?: string);
+}
+export declare class RecentAuthRequiredError extends KoolbaseAuthError {
+    constructor();
+}
+export declare class RecentMfaRequiredError extends KoolbaseAuthError {
+    constructor();
+}
+export declare class MfaAlreadyEnabledError extends KoolbaseAuthError {
+    constructor();
+}
+export declare class MfaEnrollmentNotFoundError extends KoolbaseAuthError {
+    constructor();
+}
+export declare class MfaNotEnabledError extends KoolbaseAuthError {
+    constructor();
+}

package/dist/esm/auth-errors.js

@@ -162,6 +162,18 @@ export class InvalidPhoneNumberError extends KoolbaseAuthError {
         Object.setPrototypeOf(this, InvalidPhoneNumberError.prototype);
     }
 }
+/**
+ * The project has switched off signing in with an emailed code — 403
+ * `email_code_disabled`. Applies to every address alike, so it reveals
+ * nothing about which accounts exist.
+ */
+export class EmailCodeDisabledError extends KoolbaseAuthError {
+    constructor() {
+        super('Signing in with an emailed code is switched off for this project', 'email_code_disabled');
+        this.name = 'EmailCodeDisabledError';
+        Object.setPrototypeOf(this, EmailCodeDisabledError.prototype);
+    }
+}
 export class OtpExpiredError extends KoolbaseAuthError {
     constructor() {
         super('OTP has expired, please request a new code', 'otp_expired');
@@ -426,3 +438,54 @@ export class GoogleEmailRequiredError extends KoolbaseAuthError {
         Object.setPrototypeOf(this, GoogleEmailRequiredError.prototype);
     }
 }
+// ─── Two-step sign-in (MFA) ─────────────────────────────────────────────────
+/**
+ * The first factor passed and this account needs a second: sign-in is not
+ * finished. Pass `challengeToken` to `verifyMfa` with a code from the
+ * person's authenticator app, or to `verifyRecoveryCode`. Apps that never
+ * enable MFA never see this.
+ */
+export class MfaRequiredError extends KoolbaseAuthError {
+    constructor(challengeToken, expiresAt) {
+        super('Two-step sign-in required', 'mfa_required');
+        this.name = 'MfaRequiredError';
+        this.challengeToken = challengeToken;
+        this.expiresAt = expiresAt;
+        Object.setPrototypeOf(this, MfaRequiredError.prototype);
+    }
+}
+export class RecentAuthRequiredError extends KoolbaseAuthError {
+    constructor() {
+        super('Sign in again to change two-step sign-in', 'recent_auth_required');
+        this.name = 'RecentAuthRequiredError';
+        Object.setPrototypeOf(this, RecentAuthRequiredError.prototype);
+    }
+}
+export class RecentMfaRequiredError extends KoolbaseAuthError {
+    constructor() {
+        super('Confirm with your authenticator first', 'recent_mfa_required');
+        this.name = 'RecentMfaRequiredError';
+        Object.setPrototypeOf(this, RecentMfaRequiredError.prototype);
+    }
+}
+export class MfaAlreadyEnabledError extends KoolbaseAuthError {
+    constructor() {
+        super('Two-step sign-in is already on for this account', 'mfa_already_enabled');
+        this.name = 'MfaAlreadyEnabledError';
+        Object.setPrototypeOf(this, MfaAlreadyEnabledError.prototype);
+    }
+}
+export class MfaEnrollmentNotFoundError extends KoolbaseAuthError {
+    constructor() {
+        super('No enrolment in progress; start again', 'mfa_enrollment_not_found');
+        this.name = 'MfaEnrollmentNotFoundError';
+        Object.setPrototypeOf(this, MfaEnrollmentNotFoundError.prototype);
+    }
+}
+export class MfaNotEnabledError extends KoolbaseAuthError {
+    constructor() {
+        super('Two-step sign-in is not on for this account', 'mfa_not_enabled');
+        this.name = 'MfaNotEnabledError';
+        Object.setPrototypeOf(this, MfaNotEnabledError.prototype);
+    }
+}

package/dist/esm/auth.d.ts

@@ -302,12 +302,10 @@ export declare class KoolbaseAuth {
     validAccessToken(): Promise<string | null>;
     setSession(session: KoolbaseSession | null): Promise<void>;
     /**
-     * @deprecated v1.9.0: Server endpoint /v1/sdk/auth/oauth not yet
-     * shipped. This method previously routed to /v1/auth/oauth (dashboard
-     * developer OAuth) which never created project-scoped end-user
-     * sessions. Properly implemented in v1.10.0 with provider-specific
-     * server endpoints under /v1/sdk/auth/oauth/{apple,google,github}.
-     * Use email/password sign-in for now.
+     * @deprecated Never implemented; kept only so existing code compiles.
+     * Google and Apple sign-in are supported — use signInWithGoogle() or
+     * signInWithApple(). This used to say OAuth was not yet shipped and to
+     * use email and password instead, which stopped being true long ago.
      *
      * @throws Always throws KoolbaseAuthError('not_implemented').
      */
@@ -318,6 +316,74 @@ export declare class KoolbaseAuth {
         name?: string;
         avatarUrl?: string;
     }): Promise<never>;
+    /**
+     * Emails a six-digit sign-in code.
+     *
+     * Resolves the same way whether or not the address has an account, so it
+     * cannot be used to check who is registered. A new address receives a code
+     * only while the project accepts sign-ups; a disabled account receives
+     * nothing.
+     *
+     * @throws EmailCodeDisabledError if the project has switched this off
+     * @throws RateLimitError after too many requests for one address
+     */
+    requestEmailCode(params: {
+        email: string;
+    }): Promise<void>;
+    /**
+     * Signs in with a code from requestEmailCode(), storing the session exactly
+     * as login() does. An unknown address becomes an account only if the
+     * project still accepts sign-ups at this moment. Each code works once and
+     * allows three attempts.
+     *
+     * @throws OtpInvalidError, OtpExpiredError, OtpMaxAttemptsError
+     * @throws EmailCodeDisabledError if the project has switched this off
+     */
+    signInWithEmailCode(params: {
+        email: string;
+        code: string;
+    }): Promise<KoolbaseSession>;
+    private mfaRequired;
+    /** Finishes sign-in with a code from the person's authenticator app. */
+    verifyMfa(params: {
+        challengeToken: string;
+        code: string;
+    }): Promise<KoolbaseSession>;
+    /**
+     * Finishes sign-in with a recovery code. Each works once; prompt the person
+     * to regenerate when recoveryCodesRemaining reaches zero.
+     */
+    verifyRecoveryCode(params: {
+        challengeToken: string;
+        code: string;
+    }): Promise<{
+        session: KoolbaseSession;
+        recoveryCodesRemaining: number;
+    }>;
+    /**
+     * Starts adding an authenticator; needs a sign-in within ten minutes. Show
+     * otpauthUri as a QR code, then call confirmMfaEnrollment with the first
+     * code the app shows.
+     */
+    enrollMfa(): Promise<{
+        otpauthUri: string;
+        secret: string;
+    }>;
+    /** Turns MFA on and returns ten recovery codes, shown this once only. Other devices are signed out. */
+    confirmMfaEnrollment(code: string): Promise<string[]>;
+    mfaStatus(): Promise<{
+        enabled: boolean;
+        recoveryCodesRemaining: number;
+    }>;
+    /** Re-confirms the second factor, opening ten minutes to change MFA. */
+    stepUpMfa(params: {
+        code?: string;
+        recoveryCode?: string;
+    }): Promise<void>;
+    /** Turns MFA off. Needs stepUpMfa() within the last ten minutes. */
+    disableMfa(): Promise<void>;
+    /** Replaces all recovery codes; the old ones stop working. Needs stepUpMfa() within ten minutes. */
+    regenerateRecoveryCodes(): Promise<string[]>;
     sendOtp(params: SendOtpParams): Promise<OtpSendResult>;
     verifyOtp(params: VerifyOtpParams): Promise<PhoneVerifyResult>;
     linkPhone(params: LinkPhoneParams): Promise<void>;