@oxy.so/contracts 4.15.0 → 4.17.0

package/dist/esm/signIn.js

@@ -18,6 +18,11 @@
  *    one-use second-factor challenge instead of a session, and
  *    `POST /auth/signin/second-factor` takes the TOTP (or a backup code).
  *
+ * An email may hold several accounts (up to `EMAIL_ACCOUNTS_MAX`). Signing in
+ * with the email, once the code or the link proves it, answers the accounts to
+ * choose from when there are several, and `POST /auth/signin/email/choose`
+ * names one. A username always names one account.
+ *
  * `POST /auth/signup` creates an account from a username and an email confirmed
  * with `POST /auth/email/verify/{start,confirm}` (purpose `signup`).
  *
@@ -27,40 +32,10 @@
 import { z } from 'zod';
 import { EMAIL_CODE_LENGTH, emailAddressSchema, emailTicketSchema } from './accountEmail.js';
 import { deviceProofSchema } from './deviceSession.js';
-/** How long the link in a sign-in email can be opened. */
-export const EMAIL_SIGNIN_LINK_TTL_MS = 15 * 60 * 1000;
-/** How long a second-factor challenge can be answered. */
-export const SIGNIN_SECOND_FACTOR_TTL_MS = 5 * 60 * 1000;
-/** Wrong second-factor codes one challenge accepts. */
-export const SIGNIN_SECOND_FACTOR_MAX_ATTEMPTS = 5;
-/** Shortest password Oxy accepts when one is set. */
-export const PASSWORD_MIN_LENGTH = 10;
-/** Longest password Oxy accepts (characters). */
-export const PASSWORD_MAX_LENGTH = 256;
-/** Digits in an authenticator code. */
-export const TOTP_DIGITS = 6;
-/** Seconds each authenticator code lasts. */
-export const TOTP_PERIOD_SECONDS = 30;
-/** Backup codes issued when an authenticator is enabled or they are regenerated. */
-export const TOTP_BACKUP_CODE_COUNT = 10;
-/**
- * The long sign-in code: ten characters of Crockford base32 without the
- * look-alikes (no 0, O, 1, I, L, U), shown as `XXXXX-XXXXX`. An account whose
- * sign-in codes were guessed at too often today (the per-account ceiling) is
- * sent this instead of 6 digits for the rest of the day, so its owner can still
- * type a code while guessing one is infeasible.
- */
-export const EMAIL_SIGNIN_LONG_CODE_ALPHABET = '23456789ABCDEFGHJKMNPQRSTVWXYZ';
-export const EMAIL_SIGNIN_LONG_CODE_LENGTH = 10;
-/**
- * Normalise a typed sign-in code: 6 digits stay as they are; a long code is
- * upper-cased with its dash and spaces removed. Anything else is returned
- * trimmed (and will simply be wrong).
- */
-export function normalizeEmailSignInCode(code) {
-    const compact = code.trim().replace(/[\s-]/g, '').toUpperCase();
-    return compact;
-}
+// The Zod-free half of this contract lives in `./client/` (`@oxy.so/contracts/client`);
+// it is re-exported here so the root entry is unchanged.
+import { PASSWORD_MIN_LENGTH, PASSWORD_MAX_LENGTH, TOTP_DIGITS, TOTP_BACKUP_CODE_COUNT, EMAIL_SIGNIN_LONG_CODE_ALPHABET, EMAIL_SIGNIN_LONG_CODE_LENGTH, normalizeEmailSignInCode, EMAIL_ACCOUNTS_MAX, REAUTH_ACTIONS, } from './client/signIn.js';
+export { EMAIL_SIGNIN_LINK_TTL_MS, SIGNIN_SECOND_FACTOR_TTL_MS, SIGNIN_SECOND_FACTOR_MAX_ATTEMPTS, PASSWORD_MIN_LENGTH, PASSWORD_MAX_LENGTH, TOTP_DIGITS, TOTP_PERIOD_SECONDS, TOTP_BACKUP_CODE_COUNT, EMAIL_SIGNIN_LONG_CODE_ALPHABET, EMAIL_SIGNIN_LONG_CODE_LENGTH, normalizeEmailSignInCode, EMAIL_SIGNIN_CHOICE_TTL_MS, EMAIL_ACCOUNTS_MAX, isSecondFactorRequired, isEmailSignInChooseAccount, REAUTH_ACTIONS, SIGN_IN_ERROR_CODES, } from './client/signIn.js';
 const sixDigits = z
     .string()
     .trim()
@@ -188,21 +163,26 @@ export const emailSignInPendingSchema = z.object({
     status: z.literal('pending'),
     expiresAt: z.number().int().positive(),
 });
-/** Narrow a {@link SignInStepResult}. */
-export function isSecondFactorRequired(result) {
-    return result.secondFactorRequired === true;
-}
-/**
- * What a re-verification email code confirms. The code is bound to it: a code
- * asked for one change never authorises another, and the email names it.
- */
-export const REAUTH_ACTIONS = [
-    'change_password',
-    'totp',
-    'link_commons',
-    'delete_account',
-    'credentials_manage',
-];
+export const emailSignInAccountOptionSchema = z.object({
+    id: z.string().min(1).max(64),
+    username: z.string().min(1).optional(),
+    displayName: z.string().min(1).optional(),
+    avatar: z.string().min(1).optional(),
+});
+export const emailSignInChooseAccountSchema = z.object({
+    chooseAccount: z.literal(true),
+    accounts: z.array(emailSignInAccountOptionSchema).min(2).max(EMAIL_ACCOUNTS_MAX),
+    expiresAt: z.number().int().positive(),
+});
+/** `POST /auth/signin/email/choose` — the account, from those {@link EmailSignInChooseAccount} listed. */
+export const emailSignInChooseRequestSchema = z
+    .object({
+    requestId: z.string().trim().min(1).max(64),
+    requestSecret: opaqueTokenSchema,
+    userId: z.string().trim().min(1).max(64),
+    ...sessionEnvelope,
+})
+    .strict();
 /** `POST /users/me/reauth/email` */
 export const reauthEmailStartRequestSchema = z.object({ action: z.enum(REAUTH_ACTIONS) }).strict();
 /**
@@ -276,37 +256,3 @@ export const totpBackupCodesResponseSchema = z.object({
         .array(z.string().regex(/^[a-z2-9]{5}-[a-z2-9]{5}$/))
         .length(TOTP_BACKUP_CODE_COUNT),
 });
-/**
- * Stable error codes (`error.code` in the API error body). Clients map these
- * through their localization, never the English message.
- */
-export const SIGN_IN_ERROR_CODES = {
-    /** Wrong identifier or password — never says which. */
-    invalidCredentials: 'SIGNIN_INVALID_CREDENTIALS',
-    /** The request is unknown, expired, spent, or its secret is wrong. */
-    requestInvalid: 'SIGNIN_REQUEST_INVALID',
-    /** The link is unknown, expired or already used. */
-    linkInvalid: 'SIGNIN_LINK_INVALID',
-    /** The link was opened in another browser: type the code in the app instead. */
-    linkOtherDevice: 'SIGNIN_LINK_OTHER_DEVICE',
-    /** The second-factor challenge or its code is wrong, expired or spent. */
-    secondFactorInvalid: 'SECOND_FACTOR_INVALID',
-    /** Too many failures for this account: wait and try again. */
-    locked: 'SIGNIN_LOCKED',
-    /** The step needs a fresh proof (`reauth`). */
-    reauthRequired: 'REAUTH_REQUIRED',
-    /** The fresh proof was wrong. */
-    reauthInvalid: 'REAUTH_INVALID',
-    /** The account has an authenticator: the proof must carry its code. */
-    totpRequired: 'TOTP_REQUIRED',
-    /** Enrolling or confirming an authenticator that is already on. */
-    totpAlreadyEnabled: 'TOTP_ALREADY_ENABLED',
-    /** Disabling, confirming or regenerating codes with no authenticator (or no pending one). */
-    totpNotEnabled: 'TOTP_NOT_ENABLED',
-    /** The code the authenticator showed at enrolment is wrong. */
-    totpCodeInvalid: 'TOTP_CODE_INVALID',
-    /** Only official Oxy apps and auth.oxy.so may sign people in here. */
-    originNotAllowed: 'SIGNIN_ORIGIN_NOT_ALLOWED',
-    /** The username is taken. */
-    usernameTaken: 'USERNAME_TAKEN',
-};

package/dist/esm/userResponse.js

@@ -241,10 +241,6 @@ export const userResponseSchema = z
      * so it is present on the current-user DTO (`GET /users/me`,
      * `GET /session/user/:sessionId`) and absent until the user sets it.
      */
-    userPreferences: z
-        .object({ displayCurrency: z.enum(['USD', 'EUR', 'FAIR']).optional() })
-        .catchall(z.unknown())
-        .optional(),
     themePreference: themePreferenceSchema.optional(),
     personalization: z
         .object({
@@ -305,10 +301,7 @@ export const userProfileUpdateSchema = z
     languages: z.array(z.string()).optional(),
     accountExpiresAfterInactivityDays: z.number().nullable().optional(),
     notificationPreferences: z.record(z.unknown()).optional(),
-    userPreferences: z
-        .object({ displayCurrency: z.enum(['USD', 'EUR', 'FAIR']).optional() })
-        .catchall(z.unknown())
-        .optional(),
+    userPreferences: z.record(z.unknown()).optional(),
     privacySettings: z.record(z.unknown()).optional(),
     /**
      * Portable theme preference. Written through the same `PUT /users/me`

package/dist/esm/username.js

@@ -99,100 +99,10 @@
  * knows what is taken, and it must not pretend to.
  */
 import { z } from 'zod';
-/** Shortest storable handle. `oxy` sets the floor. */
-export const USERNAME_MIN_LENGTH = 3;
-/** Longest storable handle, and the `maxLength` an input field should carry. */
-export const USERNAME_MAX_LENGTH = 30;
-/** The 400 / inline-validation copy for every path that rejects a handle. */
-export const USERNAME_INVALID_MESSAGE = 'Username must be 3-30 characters, use only letters, numbers, hyphens and underscores, ' +
-    'start and end with a letter or number, and never repeat a separator';
-/**
- * Exact-match handles nobody may newly claim, regardless of account kind.
- *
- * This is NOT a namespace tightening like the bot suffix — it is a list of
- * names withheld from `users_lower_username_key` before anybody asks for
- * them. Compared against the same normalization the unique index applies
- * (`lower(btrim(username))`), so `Admin`, ` ADMIN ` and `admin` are the one
- * name this list means.
- *
- * `oxy`, `mention`, `homiio`, `clarity`, `faircoin`, `astro` and `mercaria`
- * are deliberately NOT here: each already has an `organization`/`project`
- * row, so the unique index already refuses a second one, and `oxy` is the
- * name `USERNAME_MIN_LENGTH` is pinned against in
- * `__tests__/username.test.ts` — listing it would make
- * `usernameSchema.safeParse('oxy')` fail and falsify that comment. A brand
- * with no account of its own yet (measured 2026-09-18: Alia, Allo, TNP,
- * Kaana, Bloom) has no row to protect it, so it is listed until one exists.
- */
-export const RESERVED_USERNAMES = new Set([
-    // Oxy product lines with no account row of their own yet.
-    'alia',
-    'allo',
-    'tnp',
-    'kaana',
-    'bloom',
-    // System / role words a signup impersonating staff or Oxy itself would reach for.
-    'admin',
-    'administrator',
-    'root',
-    'superadmin',
-    'super',
-    'superuser',
-    'support',
-    'staff',
-    'moderator',
-    'mod',
-    'security',
-    'system',
-    'official',
-    'help',
-    'noreply',
-    'anonymous',
-    'everyone',
-    'owner',
-]);
-/** The 400 / inline-validation copy for a handle on {@link RESERVED_USERNAMES}. */
-export const RESERVED_USERNAME_MESSAGE = 'This username is reserved and cannot be registered';
-/**
- * {@link RESERVED_USERNAMES}, minus `alia`, checked against each `-`/`_`
- * separated SEGMENT of a candidate rather than the whole string — so
- * `official-oxy`, `super-admin` and `team-kaana` are refused the same as the
- * bare words, without banning every word that merely CONTAINS one as a
- * substring (`superman`, `modern`, `grassroot`, `homeowner` all stay legal:
- * none of them separates the reserved word from the rest with `-` or `_`).
- *
- * `alia` is excluded because `alia-` is the live internal-cost-centre
- * namespace: `alia-production-chat` is a minted account and
- * `alia-research` / `alia-voice` / `alia-evaluations` are pinned as legal
- * slugs in `__tests__/username.test.ts` and `internalCostCenterSpecs.test.ts`.
- * Segment-matching `alia` would refuse all four. The bare word `alia` is
- * still refused — {@link RESERVED_USERNAMES} above catches it exactly.
- */
-const RESERVED_USERNAME_SEGMENTS = new Set([...RESERVED_USERNAMES].filter((word) => word !== 'alia'));
-/** The 400 / inline-validation copy for a handle that is only digits. */
-export const NUMERIC_USERNAME_MESSAGE = 'Username cannot be only numbers';
-/**
- * Alphanumeric runs joined by single separators, as a SOURCE string.
- *
- * A string rather than a literal because the OpenAPI docblocks that publish this
- * rule (`POST /auth/register`, `PUT /users/:userId`) must quote it verbatim, and
- * `usernamePolicySingleSource.test.ts` compares them against THIS constant. A
- * published `pattern:` that drifts from the enforced rule is a lie told to every
- * client that generates from the spec, and it is exactly the kind of copy nobody
- * notices going stale.
- *
- * Deliberately NOT re-exported from the package barrel: it exists for the
- * schema below and for that one gate. Anything validating a username uses
- * {@link usernameSchema}, so there is no second way to ask the question.
- *
- * Written as an unambiguous alternation rather than a lookahead: every character
- * belongs to exactly one branch, so matching is linear and there is no
- * backtracking to bound. It also carries no `\p{…}` property escape, which
- * mobile Hermes throws on at runtime — this module is reachable from every React
- * Native consumer.
- */
-export const USERNAME_PATTERN_SOURCE = '^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$';
-const USERNAME_PATTERN = new RegExp(USERNAME_PATTERN_SOURCE);
+// The Zod-free half of this contract lives in `./client/` (`@oxy.so/contracts/client`);
+// it is re-exported here so the root entry is unchanged.
+import { USERNAME_MIN_LENGTH, USERNAME_MAX_LENGTH, USERNAME_INVALID_MESSAGE, RESERVED_USERNAMES, RESERVED_USERNAME_MESSAGE, NUMERIC_USERNAME_MESSAGE, BOT_USERNAME_SUFFIX, BOT_USERNAME_INVALID_MESSAGE, RESERVED_USERNAME_SEGMENTS, USERNAME_PATTERN, } from './client/username.js';
+export { USERNAME_MIN_LENGTH, USERNAME_MAX_LENGTH, USERNAME_INVALID_MESSAGE, RESERVED_USERNAMES, RESERVED_USERNAME_MESSAGE, NUMERIC_USERNAME_MESSAGE, USERNAME_PATTERN_SOURCE, stripDisallowedUsernameCharacters, BOT_USERNAME_SUFFIX, BOT_USERNAME_INVALID_MESSAGE, applyBotUsernameSuffix, } from './client/username.js';
 /**
  * The one username policy, as a schema.
  *
@@ -223,36 +133,6 @@ export const usernameSchema = z
 export function isValidUsername(candidate) {
     return usernameSchema.safeParse(candidate).success;
 }
-/**
- * Drop the characters the policy forbids, for an input field that filters
- * keystrokes.
- *
- * This is a TYPING aid and nothing else — the result still has to pass
- * {@link usernameSchema}, which is what decides. It does not lower-case (case is
- * preserved, see the header) and it cannot repair a name: a value that is too
- * short, edge-separated or doubly-separated comes back unchanged and fails
- * validation with a message, which is the outcome the coercing rules this
- * replaces used to hide.
- */
-export function stripDisallowedUsernameCharacters(input) {
-    return input.replace(/[^A-Za-z0-9_-]/g, '');
-}
-/**
- * The label a bot's handle ends in — the ONE exception the policy carries.
- *
- * Lower-case here because it is what a generator appends; the comparison that
- * enforces it folds case, so `MyBot` satisfies it just as `mybot` does.
- *
- * Deliberately NOT re-exported from the package barrel, for the same reason
- * {@link USERNAME_PATTERN_SOURCE} is not: it exists for the schema and the
- * generator aid below. A consumer that wants to SAY the rule uses
- * {@link BOT_USERNAME_INVALID_MESSAGE}, which already quotes it, and one that
- * wants to APPLY it uses {@link applyBotUsernameSuffix} — so there is no second
- * way to spell the check.
- */
-export const BOT_USERNAME_SUFFIX = 'bot';
-/** The 400 / inline-validation copy for a bot handle that carries no label. */
-export const BOT_USERNAME_INVALID_MESSAGE = `A bot account's username must end in "${BOT_USERNAME_SUFFIX}"`;
 /**
  * The username policy for an account of kind `bot`: everything above, plus a
  * handle that ends in {@link BOT_USERNAME_SUFFIX}.
@@ -327,27 +207,3 @@ export const botUsernameSchema = usernameSchema.refine((username) => username.to
 export function usernameSchemaForAccountKind(kind) {
     return kind === 'bot' ? botUsernameSchema : usernameSchema;
 }
-/**
- * Label a proposed bot handle, so a generator PROPOSES something the server will
- * accept.
- *
- * Alia builds an agent's handle from its display name; without this it would
- * propose `garden-helper` for a bot and be 400ed on submit, which is the same
- * "suggest, then refuse" defect the minimum length already caused once.
- *
- * It appends and never inserts: a separator is the caller's choice, so
- * `garden-helper` becomes `garden-helperbot` while a caller who typed
- * `garden-helper-` gets `garden-helper-bot`. It truncates to leave room rather
- * than overflowing {@link USERNAME_MAX_LENGTH}.
- *
- * Like {@link stripDisallowedUsernameCharacters} it is an aid, not a decision: it
- * cannot repair a handle the base policy refuses, and the result still has to
- * pass {@link botUsernameSchema}.
- */
-export function applyBotUsernameSuffix(candidate) {
-    const trimmed = candidate.trim();
-    if (trimmed.toLowerCase().endsWith(BOT_USERNAME_SUFFIX)) {
-        return trimmed;
-    }
-    return trimmed.slice(0, USERNAME_MAX_LENGTH - BOT_USERNAME_SUFFIX.length) + BOT_USERNAME_SUFFIX;
-}