@palbase/backend 10.0.0 → 10.2.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;
 }
@@ -791,6 +808,7 @@ declare function defineTestUsers(input: TestUsersInput): TestUsersConfig;
  *     new_dashboard: flag({ type: "boolean", default: false, description: "Roll out the new dashboard" }),
  *     max_uploads:   flag({ type: "number",  default: 10 }),
  *     theme:         flag({ type: "string",  default: "light", variants: ["light", "dark", "system"] }),
+ *     limits:        flag({ type: "json",    default: { daily: 10, burst: 50 } }),
  *   },
  * });
  *
@@ -799,47 +817,80 @@ declare function defineTestUsers(input: TestUsersInput): TestUsersConfig;
  *   { __config: "flags", flags: { <key>: { type, default, variants, description }, ... } }
  * `variants` is the allowed-values list for a string flag, or `null` (any
  * string). `description` is the doc string, or `null`. The apply step maps the
- * author-facing `type` ("boolean") to PalFlags' `value_type` ("bool").
+ * author-facing `type` to PalFlags' `value_type`: "boolean" → "bool" and
+ * "json" → "object"; "number"/"string" pass through.
  */
 /** The `__config` discriminant the eval/apply reads to confirm a config/*.ts is
  * a flags config. Flags is `"flags"`. */
 declare const FLAGS_CONFIG_KIND: "flags";
 /**
  * A flag's type. The author-facing vocabulary is `"boolean" | "number" |
- * "string"`. (The br-pod maps `"boolean"` to PalFlags' `value_type: "bool"` on
- * apply — the SDK keeps the JS-natural `"boolean"` so the DSL reads cleanly.)
+ * "string" | "json"`; the apply step maps it to PalFlags' `value_type` enum —
+ * `"boolean"` → `"bool"`, `"json"` → `"object"`, the other two pass through. The
+ * SDK keeps the JS-natural names so the DSL reads cleanly.
  *
- * PalFlags also supports an `object` value type, but config-as-code flags are
- * deliberately scoped to the three SCALAR types — an object default is awkward
- * to author on the CLI and rare for a feature flag, so it is intentionally
- * omitted here (set an object flag via the Studio / API directly if needed).
+ * `"json"` is a structured (object) flag. It is named for what an author types —
+ * a JSON object literal — and matches the `--type json` the CLI's per-user
+ * override commands already use for this same server type.
  */
-type FlagType = "boolean" | "number" | "string";
+type FlagType = "boolean" | "number" | "string" | "json";
+/** Any value expressible in JSON — what may appear INSIDE a `"json"` flag's default. */
+type FlagJsonValue = boolean | number | string | null | FlagJsonValue[] | {
+    [key: string]: FlagJsonValue;
+};
+/**
+ * The default of a `"json"` flag: a JSON OBJECT. Not an array and not a scalar —
+ * PalFlags' `object` value type accepts a JSON object at the top level only
+ * (`validate.ValidateValueTypeMatch`), and it caps nesting depth at 3.
+ */
+type FlagJsonObject = {
+    [key: string]: FlagJsonValue;
+};
 /** The runtime JSON value a flag's `default` may hold (matches {@link FlagType}). */
-type FlagValue = boolean | number | string;
+type FlagValue = boolean | number | string | FlagJsonObject;
 /**
- * The author-facing options for a single flag.
+ * The author-facing options for a single flag — a UNION keyed on `type`, so
+ * `default` is checked against the declared type at compile time and `variants`
+ * is only accepted where it means something.
  *
- * - `type`: the flag's type — `"boolean" | "number" | "string"`.
+ * - `type`: the flag's type — `"boolean" | "number" | "string" | "json"`.
  * - `default`: the project-wide default value. MUST match `type` (a `number`
- *   default with `type: "boolean"` throws).
+ *   default with `type: "boolean"` is a type error, and throws at runtime).
  * - `variants`: ONLY valid for `type: "string"` — the allowed values the string
  *   flag may take (a DEFINITION, not a per-user assignment). When given, the
- *   `default` MUST be one of the variants. Supplying `variants` on a non-string
- *   type throws.
+ *   `default` MUST be one of the variants. Supplying `variants` on any other
+ *   type is a type error, and throws at runtime. (PalFlags rejects variants for
+ *   every non-string `value_type`, so accepting them here would only produce a
+ *   config the server refuses.)
  * - `description`: an optional human description of what the flag controls.
  */
-interface FlagOptions {
-    type: FlagType;
-    default: FlagValue;
+type FlagOptions = {
+    type: "boolean";
+    default: boolean;
+    variants?: never;
+    description?: string;
+} | {
+    type: "number";
+    default: number;
+    variants?: never;
+    description?: string;
+} | {
+    type: "string";
+    default: string;
     variants?: string[];
     description?: string;
-}
+} | {
+    type: "json";
+    default: FlagJsonObject;
+    variants?: never;
+    description?: string;
+};
 /**
  * The compiled, serializable flag definition — the EXACT shape emitted to JSON
  * and consumed by the Go apply step.
  *
- * - `type`: the author-facing type verbatim (`"boolean" | "number" | "string"`).
+ * - `type`: the author-facing type verbatim (`"boolean" | "number" | "string" |
+ *   "json"`) — the apply step maps it to PalFlags' `value_type`.
  * - `default`: the default value (matches `type`).
  * - `variants`: the allowed-values list for a string flag, or `null` (any).
  * - `description`: the doc string, or `null`.
@@ -868,12 +919,12 @@ interface FlagsInput {
  * options.
  *
  * Validates eagerly (at config-author time):
- *  - `type` is one of `"boolean" | "number" | "string"`.
+ *  - `type` is one of `"boolean" | "number" | "string" | "json"`.
  *  - `default` matches `type` (e.g. a `number` default with `type: "boolean"`
- *    throws).
- *  - `variants` is ONLY allowed for a string flag (variants on a non-string
- *    type throws); each entry is a non-empty string; the `default` must be one
- *    of the variants.
+ *    throws; a `"json"` default must be a plain object, not an array or scalar).
+ *  - `variants` is ONLY allowed for a string flag (variants on any other type
+ *    throws); each entry is a non-empty string; the `default` must be one of the
+ *    variants.
  *
  * Returns a normalized {@link FlagDef}: `variants` deduped-or-null,
  * `description` trimmed-or-null.
@@ -1603,4 +1654,4 @@ declare const documents: {
     onDocumentDeleted(handler: HookHandler<DocumentDeletedEvent>): ResolvedHook<DocumentDeletedEvent>;
 };
 
-export { type AcsOptions, type ApnsOptions, type BackoffStrategy, Body, type BucketDef, type BucketOptions, Cache, CacheClient, Client, Controller, type ControllerOptions, type CustomWebhookConfig, DBClient, Database, type DefinedError, type DefinedErrorWithData, Delete, type DocumentCreatedEvent, type DocumentDeletedEvent, type DocumentUpdatedEvent, Documents, EGRESS_CONFIG_KIND, type EgressConfig, type EgressInput, type EnvSecretRef, EnvTypedDatabase, FLAGS_CONFIG_KIND, type FcmOptions, type FileDeletedEvent, type FileUploadedEvent, type FlagDef, type FlagOptions, type FlagType, type FlagValue, Flags, type FlagsConfig, type FlagsInput, Get, Headers, type HookHandler, type HookMeta, HttpError, type HttpMethodUpper, type JobConfig, type JobMeta, Log, Logger, NOTIFICATIONS_CONFIG_KIND, Notifications, type NotificationsConfig, type NotificationsInput, OptionalUser, type OwnedTablesOf, PROVIDER_CATALOG, PalbaseDocsClient, PalbaseFlagsClient, PalbaseNotificationsClient, PalbaseRealtimeClient, PalbaseStorageClient, Param, type ParamKind, type ParamMeta, type PasswordResetEvent, Patch, Post, type ProviderCatalogEntry, type ProviderDef, type ProviderEventMap, type ProviderName, type ProviderOptions, type ProviderWebhookConfig, Put, Query, QueryParams, Queue, QueueClient, RESERVED_SECRET_PREFIX, RateLimitConfig, Realtime, type RegisteredError, Req, RequestId, type ResolvedCustomWebhook, type ResolvedHook, type ResolvedJobConfig, type ResolvedProviderWebhook, type ResolvedWebhookConfig, type ResolvedWorkerConfig, Resource, type ResourceEnv, type RouteMeta, type RouteOptions, type RuntimeServices, STORAGE_CONFIG_KIND, SchemaDef, type Seed, type SeedFor, type SeedJson, type SeedRowFor, type SendgridOptions, type SesOptions, type SignInEvent, type SignOutEvent, type SmtpOptions, Storage, type StorageConfig, type StorageInput, TEST_USERS_CONFIG_KIND, type TableGraph, TableTypes, Tables, type TestUserDef, type TestUserOptions, type TestUsersConfig, type TestUsersInput, type ThrowDescriptor, TraceId, type TwilioOptions, Upload, type UploadConfig, UploadedObject, User, type UserCreatedEvent, User$1 as UserT, type WebhookEventHandler, type WebhookMeta, type WebhookProvider, type WebhookRequest, type WorkerConfig, type WorkerMeta, __getRuntime, __registerResource, __requestALS, __runResourceBoot, __runWithRuntime, __setRuntime, __shutdownResources, auth, bucket, buildProvider, defineEgress, defineError, defineFlags, defineJob, defineNotifications, defineStorage, defineTestUsers, defineWebhook, defineWorker, documents, flag, getErrorRegistry, getRoutes, makeEnvDts, parseFileSizeLimit, recordThrows, reservedSecretKey, storage, testUser, validateUploadAgainstStorage };
+export { type AcsOptions, type ApnsOptions, type BackoffStrategy, Body, type BucketDef, type BucketOptions, Cache, CacheClient, Client, Controller, type ControllerOptions, type CustomWebhookConfig, DBClient, Database, type DefinedError, type DefinedErrorWithData, Delete, type DocumentCreatedEvent, type DocumentDeletedEvent, type DocumentUpdatedEvent, Documents, EGRESS_CONFIG_KIND, type EgressConfig, type EgressInput, type EnvSecretRef, EnvTypedDatabase, FLAGS_CONFIG_KIND, type FcmOptions, type FileDeletedEvent, type FileUploadedEvent, type FlagDef, type FlagJsonObject, type FlagJsonValue, type FlagOptions, type FlagType, type FlagValue, Flags, type FlagsConfig, type FlagsInput, Get, Headers, type HookHandler, type HookMeta, HttpError, type HttpMethodUpper, type JobConfig, type JobMeta, Log, Logger, NOTIFICATIONS_CONFIG_KIND, Notifications, type NotificationsConfig, type NotificationsInput, OptionalUser, type OwnedTablesOf, PROVIDER_CATALOG, PalbaseDocsClient, PalbaseFlagsClient, PalbaseNotificationsClient, PalbaseRealtimeClient, PalbaseStorageClient, Param, type ParamKind, type ParamMeta, type PasswordResetEvent, Patch, Post, type ProviderCatalogEntry, type ProviderDef, type ProviderEventMap, type ProviderName, type ProviderOptions, type ProviderWebhookConfig, Put, Query, QueryParams, Queue, QueueClient, RESERVED_SECRET_PREFIX, RateLimitConfig, Realtime, type RegisteredError, Req, RequestId, type ResolvedCustomWebhook, type ResolvedHook, type ResolvedJobConfig, type ResolvedProviderWebhook, type ResolvedWebhookConfig, type ResolvedWorkerConfig, Resource, type ResourceEnv, type RouteMeta, type RouteOptions, type RuntimeServices, STORAGE_CONFIG_KIND, SchemaDef, type Seed, type SeedFor, type SeedJson, type SeedRowFor, type SendgridOptions, type SesOptions, type SignInEvent, type SignOutEvent, type SmtpOptions, Storage, type StorageConfig, type StorageInput, TEST_USERS_CONFIG_KIND, type TableGraph, TableTypes, Tables, type TestUserDef, type TestUserOptions, type TestUsersConfig, type TestUsersInput, type ThrowDescriptor, TraceId, type TwilioOptions, Upload, type UploadConfig, UploadedObject, User, type UserCreatedEvent, User$1 as UserT, type WebhookEventHandler, type WebhookMeta, type WebhookProvider, type WebhookRequest, type WorkerConfig, type WorkerMeta, __getRuntime, __registerResource, __requestALS, __runResourceBoot, __runWithRuntime, __setRuntime, __shutdownResources, auth, bucket, buildProvider, defineEgress, defineError, defineFlags, defineJob, defineNotifications, defineStorage, defineTestUsers, defineWebhook, defineWorker, documents, flag, getErrorRegistry, getRoutes, makeEnvDts, parseFileSizeLimit, recordThrows, reservedSecretKey, storage, testUser, validateUploadAgainstStorage };

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;
 }
@@ -791,6 +808,7 @@ declare function defineTestUsers(input: TestUsersInput): TestUsersConfig;
  *     new_dashboard: flag({ type: "boolean", default: false, description: "Roll out the new dashboard" }),
  *     max_uploads:   flag({ type: "number",  default: 10 }),
  *     theme:         flag({ type: "string",  default: "light", variants: ["light", "dark", "system"] }),
+ *     limits:        flag({ type: "json",    default: { daily: 10, burst: 50 } }),
  *   },
  * });
  *
@@ -799,47 +817,80 @@ declare function defineTestUsers(input: TestUsersInput): TestUsersConfig;
  *   { __config: "flags", flags: { <key>: { type, default, variants, description }, ... } }
  * `variants` is the allowed-values list for a string flag, or `null` (any
  * string). `description` is the doc string, or `null`. The apply step maps the
- * author-facing `type` ("boolean") to PalFlags' `value_type` ("bool").
+ * author-facing `type` to PalFlags' `value_type`: "boolean" → "bool" and
+ * "json" → "object"; "number"/"string" pass through.
  */
 /** The `__config` discriminant the eval/apply reads to confirm a config/*.ts is
  * a flags config. Flags is `"flags"`. */
 declare const FLAGS_CONFIG_KIND: "flags";
 /**
  * A flag's type. The author-facing vocabulary is `"boolean" | "number" |
- * "string"`. (The br-pod maps `"boolean"` to PalFlags' `value_type: "bool"` on
- * apply — the SDK keeps the JS-natural `"boolean"` so the DSL reads cleanly.)
+ * "string" | "json"`; the apply step maps it to PalFlags' `value_type` enum —
+ * `"boolean"` → `"bool"`, `"json"` → `"object"`, the other two pass through. The
+ * SDK keeps the JS-natural names so the DSL reads cleanly.
  *
- * PalFlags also supports an `object` value type, but config-as-code flags are
- * deliberately scoped to the three SCALAR types — an object default is awkward
- * to author on the CLI and rare for a feature flag, so it is intentionally
- * omitted here (set an object flag via the Studio / API directly if needed).
+ * `"json"` is a structured (object) flag. It is named for what an author types —
+ * a JSON object literal — and matches the `--type json` the CLI's per-user
+ * override commands already use for this same server type.
  */
-type FlagType = "boolean" | "number" | "string";
+type FlagType = "boolean" | "number" | "string" | "json";
+/** Any value expressible in JSON — what may appear INSIDE a `"json"` flag's default. */
+type FlagJsonValue = boolean | number | string | null | FlagJsonValue[] | {
+    [key: string]: FlagJsonValue;
+};
+/**
+ * The default of a `"json"` flag: a JSON OBJECT. Not an array and not a scalar —
+ * PalFlags' `object` value type accepts a JSON object at the top level only
+ * (`validate.ValidateValueTypeMatch`), and it caps nesting depth at 3.
+ */
+type FlagJsonObject = {
+    [key: string]: FlagJsonValue;
+};
 /** The runtime JSON value a flag's `default` may hold (matches {@link FlagType}). */
-type FlagValue = boolean | number | string;
+type FlagValue = boolean | number | string | FlagJsonObject;
 /**
- * The author-facing options for a single flag.
+ * The author-facing options for a single flag — a UNION keyed on `type`, so
+ * `default` is checked against the declared type at compile time and `variants`
+ * is only accepted where it means something.
  *
- * - `type`: the flag's type — `"boolean" | "number" | "string"`.
+ * - `type`: the flag's type — `"boolean" | "number" | "string" | "json"`.
  * - `default`: the project-wide default value. MUST match `type` (a `number`
- *   default with `type: "boolean"` throws).
+ *   default with `type: "boolean"` is a type error, and throws at runtime).
  * - `variants`: ONLY valid for `type: "string"` — the allowed values the string
  *   flag may take (a DEFINITION, not a per-user assignment). When given, the
- *   `default` MUST be one of the variants. Supplying `variants` on a non-string
- *   type throws.
+ *   `default` MUST be one of the variants. Supplying `variants` on any other
+ *   type is a type error, and throws at runtime. (PalFlags rejects variants for
+ *   every non-string `value_type`, so accepting them here would only produce a
+ *   config the server refuses.)
  * - `description`: an optional human description of what the flag controls.
  */
-interface FlagOptions {
-    type: FlagType;
-    default: FlagValue;
+type FlagOptions = {
+    type: "boolean";
+    default: boolean;
+    variants?: never;
+    description?: string;
+} | {
+    type: "number";
+    default: number;
+    variants?: never;
+    description?: string;
+} | {
+    type: "string";
+    default: string;
     variants?: string[];
     description?: string;
-}
+} | {
+    type: "json";
+    default: FlagJsonObject;
+    variants?: never;
+    description?: string;
+};
 /**
  * The compiled, serializable flag definition — the EXACT shape emitted to JSON
  * and consumed by the Go apply step.
  *
- * - `type`: the author-facing type verbatim (`"boolean" | "number" | "string"`).
+ * - `type`: the author-facing type verbatim (`"boolean" | "number" | "string" |
+ *   "json"`) — the apply step maps it to PalFlags' `value_type`.
  * - `default`: the default value (matches `type`).
  * - `variants`: the allowed-values list for a string flag, or `null` (any).
  * - `description`: the doc string, or `null`.
@@ -868,12 +919,12 @@ interface FlagsInput {
  * options.
  *
  * Validates eagerly (at config-author time):
- *  - `type` is one of `"boolean" | "number" | "string"`.
+ *  - `type` is one of `"boolean" | "number" | "string" | "json"`.
  *  - `default` matches `type` (e.g. a `number` default with `type: "boolean"`
- *    throws).
- *  - `variants` is ONLY allowed for a string flag (variants on a non-string
- *    type throws); each entry is a non-empty string; the `default` must be one
- *    of the variants.
+ *    throws; a `"json"` default must be a plain object, not an array or scalar).
+ *  - `variants` is ONLY allowed for a string flag (variants on any other type
+ *    throws); each entry is a non-empty string; the `default` must be one of the
+ *    variants.
  *
  * Returns a normalized {@link FlagDef}: `variants` deduped-or-null,
  * `description` trimmed-or-null.
@@ -1603,4 +1654,4 @@ declare const documents: {
     onDocumentDeleted(handler: HookHandler<DocumentDeletedEvent>): ResolvedHook<DocumentDeletedEvent>;
 };
 
-export { type AcsOptions, type ApnsOptions, type BackoffStrategy, Body, type BucketDef, type BucketOptions, Cache, CacheClient, Client, Controller, type ControllerOptions, type CustomWebhookConfig, DBClient, Database, type DefinedError, type DefinedErrorWithData, Delete, type DocumentCreatedEvent, type DocumentDeletedEvent, type DocumentUpdatedEvent, Documents, EGRESS_CONFIG_KIND, type EgressConfig, type EgressInput, type EnvSecretRef, EnvTypedDatabase, FLAGS_CONFIG_KIND, type FcmOptions, type FileDeletedEvent, type FileUploadedEvent, type FlagDef, type FlagOptions, type FlagType, type FlagValue, Flags, type FlagsConfig, type FlagsInput, Get, Headers, type HookHandler, type HookMeta, HttpError, type HttpMethodUpper, type JobConfig, type JobMeta, Log, Logger, NOTIFICATIONS_CONFIG_KIND, Notifications, type NotificationsConfig, type NotificationsInput, OptionalUser, type OwnedTablesOf, PROVIDER_CATALOG, PalbaseDocsClient, PalbaseFlagsClient, PalbaseNotificationsClient, PalbaseRealtimeClient, PalbaseStorageClient, Param, type ParamKind, type ParamMeta, type PasswordResetEvent, Patch, Post, type ProviderCatalogEntry, type ProviderDef, type ProviderEventMap, type ProviderName, type ProviderOptions, type ProviderWebhookConfig, Put, Query, QueryParams, Queue, QueueClient, RESERVED_SECRET_PREFIX, RateLimitConfig, Realtime, type RegisteredError, Req, RequestId, type ResolvedCustomWebhook, type ResolvedHook, type ResolvedJobConfig, type ResolvedProviderWebhook, type ResolvedWebhookConfig, type ResolvedWorkerConfig, Resource, type ResourceEnv, type RouteMeta, type RouteOptions, type RuntimeServices, STORAGE_CONFIG_KIND, SchemaDef, type Seed, type SeedFor, type SeedJson, type SeedRowFor, type SendgridOptions, type SesOptions, type SignInEvent, type SignOutEvent, type SmtpOptions, Storage, type StorageConfig, type StorageInput, TEST_USERS_CONFIG_KIND, type TableGraph, TableTypes, Tables, type TestUserDef, type TestUserOptions, type TestUsersConfig, type TestUsersInput, type ThrowDescriptor, TraceId, type TwilioOptions, Upload, type UploadConfig, UploadedObject, User, type UserCreatedEvent, User$1 as UserT, type WebhookEventHandler, type WebhookMeta, type WebhookProvider, type WebhookRequest, type WorkerConfig, type WorkerMeta, __getRuntime, __registerResource, __requestALS, __runResourceBoot, __runWithRuntime, __setRuntime, __shutdownResources, auth, bucket, buildProvider, defineEgress, defineError, defineFlags, defineJob, defineNotifications, defineStorage, defineTestUsers, defineWebhook, defineWorker, documents, flag, getErrorRegistry, getRoutes, makeEnvDts, parseFileSizeLimit, recordThrows, reservedSecretKey, storage, testUser, validateUploadAgainstStorage };
+export { type AcsOptions, type ApnsOptions, type BackoffStrategy, Body, type BucketDef, type BucketOptions, Cache, CacheClient, Client, Controller, type ControllerOptions, type CustomWebhookConfig, DBClient, Database, type DefinedError, type DefinedErrorWithData, Delete, type DocumentCreatedEvent, type DocumentDeletedEvent, type DocumentUpdatedEvent, Documents, EGRESS_CONFIG_KIND, type EgressConfig, type EgressInput, type EnvSecretRef, EnvTypedDatabase, FLAGS_CONFIG_KIND, type FcmOptions, type FileDeletedEvent, type FileUploadedEvent, type FlagDef, type FlagJsonObject, type FlagJsonValue, type FlagOptions, type FlagType, type FlagValue, Flags, type FlagsConfig, type FlagsInput, Get, Headers, type HookHandler, type HookMeta, HttpError, type HttpMethodUpper, type JobConfig, type JobMeta, Log, Logger, NOTIFICATIONS_CONFIG_KIND, Notifications, type NotificationsConfig, type NotificationsInput, OptionalUser, type OwnedTablesOf, PROVIDER_CATALOG, PalbaseDocsClient, PalbaseFlagsClient, PalbaseNotificationsClient, PalbaseRealtimeClient, PalbaseStorageClient, Param, type ParamKind, type ParamMeta, type PasswordResetEvent, Patch, Post, type ProviderCatalogEntry, type ProviderDef, type ProviderEventMap, type ProviderName, type ProviderOptions, type ProviderWebhookConfig, Put, Query, QueryParams, Queue, QueueClient, RESERVED_SECRET_PREFIX, RateLimitConfig, Realtime, type RegisteredError, Req, RequestId, type ResolvedCustomWebhook, type ResolvedHook, type ResolvedJobConfig, type ResolvedProviderWebhook, type ResolvedWebhookConfig, type ResolvedWorkerConfig, Resource, type ResourceEnv, type RouteMeta, type RouteOptions, type RuntimeServices, STORAGE_CONFIG_KIND, SchemaDef, type Seed, type SeedFor, type SeedJson, type SeedRowFor, type SendgridOptions, type SesOptions, type SignInEvent, type SignOutEvent, type SmtpOptions, Storage, type StorageConfig, type StorageInput, TEST_USERS_CONFIG_KIND, type TableGraph, TableTypes, Tables, type TestUserDef, type TestUserOptions, type TestUsersConfig, type TestUsersInput, type ThrowDescriptor, TraceId, type TwilioOptions, Upload, type UploadConfig, UploadedObject, User, type UserCreatedEvent, User$1 as UserT, type WebhookEventHandler, type WebhookMeta, type WebhookProvider, type WebhookRequest, type WorkerConfig, type WorkerMeta, __getRuntime, __registerResource, __requestALS, __runResourceBoot, __runWithRuntime, __setRuntime, __shutdownResources, auth, bucket, buildProvider, defineEgress, defineError, defineFlags, defineJob, defineNotifications, defineStorage, defineTestUsers, defineWebhook, defineWorker, documents, flag, getErrorRegistry, getRoutes, makeEnvDts, parseFileSizeLimit, recordThrows, reservedSecretKey, storage, testUser, validateUploadAgainstStorage };

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)) {
@@ -462,6 +488,8 @@ function valueMatchesType(type, value) {
       return typeof value === "number" && Number.isFinite(value);
     case "string":
       return typeof value === "string";
+    case "json":
+      return typeof value === "object" && value !== null && !Array.isArray(value);
   }
 }
 function flag(opts) {
@@ -469,8 +497,8 @@ function flag(opts) {
     throw new Error("flag() expects { type, default, variants?, description? }");
   }
   const { type } = opts;
-  if (type !== "boolean" && type !== "number" && type !== "string") {
-    throw new Error(`flag type must be "boolean", "number", or "string", got ${JSON.stringify(type)}`);
+  if (type !== "boolean" && type !== "number" && type !== "string" && type !== "json") {
+    throw new Error(`flag type must be "boolean", "number", "string", or "json", got ${JSON.stringify(type)}`);
   }
   if (!valueMatchesType(type, opts.default)) {
     throw new Error(
@@ -479,7 +507,7 @@ function flag(opts) {
   }
   let variants = null;
   if (opts.variants !== void 0) {
-    if (type !== "string") {
+    if (opts.type !== "string") {
       throw new Error(`flag variants are only valid for type "string" (got type "${type}")`);
     }
     if (!Array.isArray(opts.variants)) {