@guettonenrique/passwordless-auth 0.0.0-stage → 0.1.2

package/dist/types-BUi8ZPam.d.ts

@@ -0,0 +1,110 @@
+interface RequestOtpPayload {
+    email: string;
+}
+interface VerifyOtpPayload {
+    email: string;
+    code: string;
+}
+interface RequestOtpResponse {
+    status: 'success';
+    message: string;
+}
+interface VerifyOtpResponse {
+    status: 'success';
+    /** Firebase custom auth token — exchange with signInWithCustomToken. */
+    customToken: string;
+}
+/** A fully composed OTP email, ready to dispatch. */
+interface OtpEmail {
+    to: string;
+    subject: string;
+    text: string;
+    html: string;
+}
+/**
+ * Delivers the OTP email. The default implementation sends via SendGrid;
+ * projects can replace it entirely (custom provider, or a console-logging
+ * sender during development).
+ */
+type OtpEmailSender = (email: OtpEmail) => Promise<void>;
+/** Inputs for {@link buildOtpEmail}. */
+interface OtpEmailInput {
+    to: string;
+    appName: string;
+    /** The plaintext 6-digit code — only ever passed to the sender, never persisted. */
+    code: string;
+    /** Code lifetime in minutes, for the email copy. */
+    expiresMinutes: number;
+}
+interface SendgridSenderOptions {
+    /**
+     * The API key, resolved per call. Accepts a plain string, a getter
+     * function (`defineSecret('X').value`), or a Firebase params Secret
+     * object (`defineSecret('X')`) directly.
+     */
+    apiKey: string | (() => string) | {
+        value: () => string;
+    };
+    fromEmail: string;
+    fromName: string;
+}
+/** Base options shared by the request/verify factories. */
+interface BaseOtpOptions {
+    /** Firestore collection holding pending OTPs. Default: `auth_otps`. */
+    collection?: string;
+    /** Resend cooldown in ms. Default: 60_000. */
+    cooldownMs?: number;
+    /** Code lifetime in ms. Default: 600_000 (10 minutes). */
+    expiryMs?: number;
+    /** Failed verifications before the code is invalidated. Default: 5. */
+    maxAttempts?: number;
+    /** Enforce App Check on the callable. Default: false (flip true in production). */
+    enforceAppCheck?: boolean;
+}
+interface RequestOtpOptions extends BaseOtpOptions {
+    /** Brand name used in the email subject and body. Required. */
+    appName: string;
+    /** Replace the default SendGrid delivery entirely. */
+    sendEmail?: OtpEmailSender;
+    /** SendGrid sender config; required unless `sendEmail` is provided. */
+    sendgrid?: SendgridSenderOptions;
+}
+/**
+ * Resolves (and, if needed, creates) the auth user for an email, returning
+ * the uid the custom token will be minted for. This is the one required
+ * project-specific hook — it owns the app's user schema.
+ */
+type OtpProvisioner = (email: string) => Promise<string>;
+interface VerifyOtpOptions extends BaseOtpOptions {
+    /** Required. Creates or resolves the user and returns their uid. */
+    provision: OtpProvisioner;
+}
+interface CleanupOtpOptions {
+    /** Cloud Scheduler cron. Default: `every 15 minutes`. */
+    schedule?: string;
+    /** Collection to clean. Default: `auth_otps`. */
+    collection?: string;
+    /** Writes per batch. Default: 400 (Firestore limit is 500). */
+    batchSize?: number;
+}
+interface OtpDocumentData {
+    /** SHA-256 hex of `email:code`. The plaintext code is never stored. */
+    hash: string;
+    /** Failed guess counter. */
+    attempts: number;
+    /** Expiry as epoch milliseconds. */
+    expiresAt: number;
+    /** Last dispatch as epoch milliseconds (drives the resend cooldown). */
+    lastSentAt: number;
+    createdAt?: unknown;
+}
+declare const OTP_ERROR_CODES: {
+    readonly InvalidArgument: "invalid-argument";
+    readonly NotFound: "not-found";
+    readonly DeadlineExceeded: "deadline-exceeded";
+    readonly ResourceExhausted: "resource-exhausted";
+    readonly Internal: "internal";
+};
+type OtpErrorCode = (typeof OTP_ERROR_CODES)[keyof typeof OTP_ERROR_CODES];
+
+export { type BaseOtpOptions as B, type CleanupOtpOptions as C, type OtpEmailSender as O, type RequestOtpOptions as R, type SendgridSenderOptions as S, type VerifyOtpOptions as V, type RequestOtpPayload as a, type RequestOtpResponse as b, type VerifyOtpPayload as c, type VerifyOtpResponse as d, type OtpEmailInput as e, type OtpEmail as f, OTP_ERROR_CODES as g, type OtpDocumentData as h, type OtpErrorCode as i, type OtpProvisioner as j };

package/package.json

@@ -1,6 +1,93 @@
 {
   "name": "@guettonenrique/passwordless-auth",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.2",
+  "description": "Passwordless email-OTP authentication: Firebase Cloud Function factories + React Native API and UI. One package, two entries, zero shared runtime deps.",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    "./shared": {
+      "import": {
+        "types": "./dist/shared/index.d.ts",
+        "default": "./dist/shared/index.js"
+      },
+      "require": {
+        "types": "./dist/shared/index.d.cts",
+        "default": "./dist/shared/index.cjs"
+      }
+    },
+    "./functions": {
+      "import": {
+        "types": "./dist/functions/index.d.cts",
+        "default": "./dist/functions/index.cjs"
+      },
+      "require": {
+        "types": "./dist/functions/index.d.cts",
+        "default": "./dist/functions/index.cjs"
+      }
+    },
+    "./react-native": {
+      "import": {
+        "types": "./dist/react-native/index.d.ts",
+        "default": "./dist/react-native/index.js"
+      },
+      "default": {
+        "types": "./dist/react-native/index.d.ts",
+        "default": "./dist/react-native/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/guettonenrique/passwordless-auth.git"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup",
+    "prepublishOnly": "npm run build",
+    "typecheck": "tsc --noEmit -p tsconfig.shared.json && tsc --noEmit -p tsconfig.functions.json && tsc --noEmit -p tsconfig.react-native.json",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "clean": "rm -rf dist"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.30.0",
+    "@react-native-firebase/app": "^27.1.0",
+    "@react-native-firebase/auth": "^27.1.0",
+    "@react-native-firebase/functions": "^27.1.0",
+    "@sendgrid/mail": "^8.1.5",
+    "@types/node": "^24.0.0",
+    "@types/react": "^19.0.0",
+    "@types/react-test-renderer": "^19.3.1",
+    "eslint": "^9.30.0",
+    "expo-haptics": "~58.0.7",
+    "firebase-admin": "^14.2.0",
+    "firebase-functions": "^7.3.2",
+    "lucide-react-native": "^1.71.0",
+    "react": "19.3.0",
+    "react-native": "0.88.1",
+    "react-native-keyboard-controller": "1.22.7",
+    "react-test-renderer": "19.3.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.7.3",
+    "typescript-eslint": "^8.35.0",
+    "vitest": "^3.2.0"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "allowScripts": {
+    "esbuild@0.27.7": true,
+    "@firebase/util@1.15.3": true,
+    "fsevents@2.3.3": true,
+    "protobufjs@7.6.6": true
+  }
+}