@palbase/backend 10.0.0 → 10.1.0

package/dist/index.d.cts

@@ -707,6 +707,19 @@ type Seed = [keyof Tables] extends [never] ? SeedJson : SeedFor<Tables>;
 interface TestUserOptions {
     email?: string;
     password?: string;
+    /**
+     * A verified phone for this fixture, E.164 (`+905551112233`). Requires
+     * {@link TestUserOptions.otp}: nothing can receive an SMS at a fabricated
+     * number, so a phone fixture without a knowable code is one no test could
+     * ever sign in as.
+     */
+    phone?: string;
+    /**
+     * The fixed code this fixture's phone accepts. Honoured ONLY for the
+     * `is_test` user it belongs to — the real rail is untouched, and no
+     * verification is ever sent (or billed) for a fixture.
+     */
+    otp?: string;
     seed?: Seed;
 }
 /** The compiled, serializable test-user definition — the EXACT shape emitted to
@@ -716,6 +729,10 @@ interface TestUserDef {
     email: string | null;
     /** Fixed password (fixture), or `null` when the server should generate one. */
     password: string | null;
+    /** Verified phone in E.164, or `null` for an e-mail-only fixture. */
+    phone: string | null;
+    /** The code that phone accepts, or `null` when there is no phone. */
+    otp: string | null;
     /** The user's data tree; `{}` when nothing is seeded. */
     seed: SeedJson;
 }

package/dist/index.d.ts

@@ -707,6 +707,19 @@ type Seed = [keyof Tables] extends [never] ? SeedJson : SeedFor<Tables>;
 interface TestUserOptions {
     email?: string;
     password?: string;
+    /**
+     * A verified phone for this fixture, E.164 (`+905551112233`). Requires
+     * {@link TestUserOptions.otp}: nothing can receive an SMS at a fabricated
+     * number, so a phone fixture without a knowable code is one no test could
+     * ever sign in as.
+     */
+    phone?: string;
+    /**
+     * The fixed code this fixture's phone accepts. Honoured ONLY for the
+     * `is_test` user it belongs to — the real rail is untouched, and no
+     * verification is ever sent (or billed) for a fixture.
+     */
+    otp?: string;
     seed?: Seed;
 }
 /** The compiled, serializable test-user definition — the EXACT shape emitted to
@@ -716,6 +729,10 @@ interface TestUserDef {
     email: string | null;
     /** Fixed password (fixture), or `null` when the server should generate one. */
     password: string | null;
+    /** Verified phone in E.164, or `null` for an e-mail-only fixture. */
+    phone: string | null;
+    /** The code that phone accepts, or `null` when there is no phone. */
+    otp: string | null;
     /** The user's data tree; `{}` when nothing is seeded. */
     seed: SeedJson;
 }

package/dist/index.js

@@ -363,6 +363,9 @@ function camelToUpperSnake(s) {
 var TEST_USERS_CONFIG_KIND = "test-users";
 var TEST_USER_NAME_RE = /^[a-zA-Z][a-zA-Z0-9_]*$/;
 var EMAIL_RE = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+var E164_RE = /^\+[1-9]\d{1,14}$/;
+var OTP_LENGTH = 6;
+var OTP_RE = /^\d{6}$/;
 var MIN_PASSWORD_LENGTH = 8;
 function isPlainObject(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
@@ -397,7 +400,7 @@ function normalizeSeed(seed, userName) {
 }
 function testUser(opts = {}) {
   if (!isPlainObject(opts)) {
-    throw new Error("testUser() expects { email?, password?, seed? }");
+    throw new Error("testUser() expects { email?, password?, phone?, otp?, seed? }");
   }
   const hasEmail = opts.email !== void 0;
   const hasPassword = opts.password !== void 0;
@@ -420,7 +423,30 @@ function testUser(opts = {}) {
     email = opts.email;
     password = opts.password;
   }
-  return { email, password, seed: normalizeSeed(opts.seed, email ?? "<template>") };
+  const hasPhone = opts.phone !== void 0;
+  const hasOTP = opts.otp !== void 0;
+  if (hasPhone !== hasOTP) {
+    throw new Error(
+      "testUser() needs phone AND otp together \u2014 nothing can receive an SMS at a fabricated number, so a phone fixture without its fixed code can never be signed in as"
+    );
+  }
+  let phone = null;
+  let otp = null;
+  if (hasPhone) {
+    if (typeof opts.phone !== "string" || !E164_RE.test(opts.phone)) {
+      throw new Error(
+        `testUser phone ${JSON.stringify(opts.phone)} must be E.164, e.g. "+905551112233"`
+      );
+    }
+    if (typeof opts.otp !== "string" || !OTP_RE.test(opts.otp)) {
+      throw new Error(
+        `testUser otp ${JSON.stringify(opts.otp)} must be ${OTP_LENGTH} digits`
+      );
+    }
+    phone = opts.phone;
+    otp = opts.otp;
+  }
+  return { email, password, phone, otp, seed: normalizeSeed(opts.seed, email ?? "<template>") };
 }
 function defineTestUsers(input) {
   if (!isPlainObject(input) || !isPlainObject(input.users)) {