@oxy.so/contracts 4.16.0 → 4.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/.tsbuildinfo +1 -1
- package/dist/cjs/accountEmail.js +12 -34
- package/dist/cjs/accountGraph.js +22 -320
- package/dist/cjs/agentKeys.js +11 -13
- package/dist/cjs/client/accountEmail.js +48 -0
- package/dist/cjs/client/accountGraph.js +323 -0
- package/dist/cjs/client/agentKeys.js +77 -0
- package/dist/cjs/client/check.js +466 -0
- package/dist/cjs/client/deviceBoot.js +22 -0
- package/dist/cjs/client/deviceDirectory.js +51 -0
- package/dist/cjs/client/deviceSession.js +63 -0
- package/dist/cjs/client/externalIdentity.js +19 -0
- package/dist/cjs/client/identity.js +45 -0
- package/dist/cjs/client/identityLink.js +55 -0
- package/dist/cjs/client/identityProof.js +109 -0
- package/dist/cjs/client/index.js +190 -0
- package/dist/cjs/client/organizations.js +114 -0
- package/dist/cjs/client/products.js +153 -0
- package/dist/cjs/client/recommendations.js +33 -0
- package/dist/cjs/client/reputation.js +41 -0
- package/dist/cjs/client/safety.js +15 -0
- package/dist/cjs/client/sessionStatus.js +23 -0
- package/dist/cjs/client/signIn.js +157 -0
- package/dist/cjs/client/userResponse.js +15 -0
- package/dist/cjs/client/username.js +173 -0
- package/dist/cjs/deviceSession.js +3 -16
- package/dist/cjs/identityLink.js +13 -34
- package/dist/cjs/identityProof.js +18 -106
- package/dist/cjs/organizations.js +21 -41
- package/dist/cjs/reputation.js +3 -34
- package/dist/cjs/signIn.js +33 -111
- package/dist/cjs/username.js +23 -158
- package/dist/esm/.tsbuildinfo +1 -1
- package/dist/esm/accountEmail.js +4 -32
- package/dist/esm/accountGraph.js +4 -309
- package/dist/esm/agentKeys.js +4 -10
- package/dist/esm/client/accountEmail.js +45 -0
- package/dist/esm/client/accountGraph.js +314 -0
- package/dist/esm/client/agentKeys.js +74 -0
- package/dist/esm/client/check.js +428 -0
- package/dist/esm/client/deviceBoot.js +19 -0
- package/dist/esm/client/deviceDirectory.js +48 -0
- package/dist/esm/client/deviceSession.js +60 -0
- package/dist/esm/client/externalIdentity.js +16 -0
- package/dist/esm/client/identity.js +42 -0
- package/dist/esm/client/identityLink.js +50 -0
- package/dist/esm/client/identityProof.js +104 -0
- package/dist/esm/client/index.js +37 -0
- package/dist/esm/client/organizations.js +111 -0
- package/dist/esm/client/products.js +150 -0
- package/dist/esm/client/recommendations.js +30 -0
- package/dist/esm/client/reputation.js +37 -0
- package/dist/esm/client/safety.js +12 -0
- package/dist/esm/client/sessionStatus.js +20 -0
- package/dist/esm/client/signIn.js +151 -0
- package/dist/esm/client/userResponse.js +12 -0
- package/dist/esm/client/username.js +167 -0
- package/dist/esm/deviceSession.js +1 -15
- package/dist/esm/identityLink.js +4 -27
- package/dist/esm/identityProof.js +4 -99
- package/dist/esm/organizations.js +4 -31
- package/dist/esm/reputation.js +1 -32
- package/dist/esm/signIn.js +4 -96
- package/dist/esm/username.js +4 -148
- package/dist/types/.tsbuildinfo +1 -1
- package/dist/types/accountEmail.d.ts +2 -34
- package/dist/types/accountGraph.d.ts +12 -208
- package/dist/types/agency.d.ts +24 -24
- package/dist/types/agentKeys.d.ts +8 -6
- package/dist/types/client/accountEmail.d.ts +44 -0
- package/dist/types/client/accountGraph.d.ts +203 -0
- package/dist/types/client/agentKeys.d.ts +113 -0
- package/dist/types/client/check.d.ts +184 -0
- package/dist/types/client/deviceBoot.d.ts +6 -0
- package/dist/types/client/deviceDirectory.d.ts +134 -0
- package/dist/types/client/deviceSession.d.ts +91 -0
- package/dist/types/client/externalIdentity.d.ts +14 -0
- package/dist/types/client/identity.d.ts +8 -0
- package/dist/types/client/identityLink.d.ts +21 -0
- package/dist/types/client/identityProof.d.ts +73 -0
- package/dist/types/client/index.d.ts +37 -0
- package/dist/types/client/organizations.d.ts +167 -0
- package/dist/types/client/products.d.ts +145 -0
- package/dist/types/client/recommendations.d.ts +27 -0
- package/dist/types/client/reputation.d.ts +28 -0
- package/dist/types/client/safety.d.ts +13 -0
- package/dist/types/client/sessionStatus.d.ts +19 -0
- package/dist/types/client/signIn.d.ts +107 -0
- package/dist/types/client/userResponse.d.ts +7 -0
- package/dist/types/client/username.d.ts +126 -0
- package/dist/types/deviceDirectory.d.ts +28 -28
- package/dist/types/deviceSession.d.ts +1 -12
- package/dist/types/externalIdentity.d.ts +11 -11
- package/dist/types/identityLink.d.ts +3 -11
- package/dist/types/identityProof.d.ts +2 -65
- package/dist/types/inference/decisions.d.ts +10 -10
- package/dist/types/inference/embeddings.d.ts +16 -16
- package/dist/types/inference/errors.d.ts +8 -8
- package/dist/types/inference/inbox.d.ts +8 -8
- package/dist/types/inference/privateAutoExecution.d.ts +6 -6
- package/dist/types/inference/realtime.d.ts +30 -30
- package/dist/types/inference/request.d.ts +28 -28
- package/dist/types/inference/streamEvents.d.ts +16 -16
- package/dist/types/inference/usage.d.ts +4 -4
- package/dist/types/oauth.d.ts +2 -2
- package/dist/types/organizations.d.ts +8 -10
- package/dist/types/products/billing.d.ts +3 -0
- package/dist/types/reputation.d.ts +1 -11
- package/dist/types/sessionStatus.d.ts +2 -2
- package/dist/types/signIn.d.ts +6 -89
- package/dist/types/userResponse.d.ts +20 -20
- package/dist/types/username.d.ts +1 -96
- package/package.json +20 -1
package/dist/esm/username.js
CHANGED
|
@@ -99,100 +99,10 @@
|
|
|
99
99
|
* knows what is taken, and it must not pretend to.
|
|
100
100
|
*/
|
|
101
101
|
import { z } from 'zod';
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
export
|
|
106
|
-
/** The 400 / inline-validation copy for every path that rejects a handle. */
|
|
107
|
-
export const USERNAME_INVALID_MESSAGE = 'Username must be 3-30 characters, use only letters, numbers, hyphens and underscores, ' +
|
|
108
|
-
'start and end with a letter or number, and never repeat a separator';
|
|
109
|
-
/**
|
|
110
|
-
* Exact-match handles nobody may newly claim, regardless of account kind.
|
|
111
|
-
*
|
|
112
|
-
* This is NOT a namespace tightening like the bot suffix — it is a list of
|
|
113
|
-
* names withheld from `users_lower_username_key` before anybody asks for
|
|
114
|
-
* them. Compared against the same normalization the unique index applies
|
|
115
|
-
* (`lower(btrim(username))`), so `Admin`, ` ADMIN ` and `admin` are the one
|
|
116
|
-
* name this list means.
|
|
117
|
-
*
|
|
118
|
-
* `oxy`, `mention`, `homiio`, `clarity`, `faircoin`, `astro` and `mercaria`
|
|
119
|
-
* are deliberately NOT here: each already has an `organization`/`project`
|
|
120
|
-
* row, so the unique index already refuses a second one, and `oxy` is the
|
|
121
|
-
* name `USERNAME_MIN_LENGTH` is pinned against in
|
|
122
|
-
* `__tests__/username.test.ts` — listing it would make
|
|
123
|
-
* `usernameSchema.safeParse('oxy')` fail and falsify that comment. A brand
|
|
124
|
-
* with no account of its own yet (measured 2026-09-18: Alia, Allo, TNP,
|
|
125
|
-
* Kaana, Bloom) has no row to protect it, so it is listed until one exists.
|
|
126
|
-
*/
|
|
127
|
-
export const RESERVED_USERNAMES = new Set([
|
|
128
|
-
// Oxy product lines with no account row of their own yet.
|
|
129
|
-
'alia',
|
|
130
|
-
'allo',
|
|
131
|
-
'tnp',
|
|
132
|
-
'kaana',
|
|
133
|
-
'bloom',
|
|
134
|
-
// System / role words a signup impersonating staff or Oxy itself would reach for.
|
|
135
|
-
'admin',
|
|
136
|
-
'administrator',
|
|
137
|
-
'root',
|
|
138
|
-
'superadmin',
|
|
139
|
-
'super',
|
|
140
|
-
'superuser',
|
|
141
|
-
'support',
|
|
142
|
-
'staff',
|
|
143
|
-
'moderator',
|
|
144
|
-
'mod',
|
|
145
|
-
'security',
|
|
146
|
-
'system',
|
|
147
|
-
'official',
|
|
148
|
-
'help',
|
|
149
|
-
'noreply',
|
|
150
|
-
'anonymous',
|
|
151
|
-
'everyone',
|
|
152
|
-
'owner',
|
|
153
|
-
]);
|
|
154
|
-
/** The 400 / inline-validation copy for a handle on {@link RESERVED_USERNAMES}. */
|
|
155
|
-
export const RESERVED_USERNAME_MESSAGE = 'This username is reserved and cannot be registered';
|
|
156
|
-
/**
|
|
157
|
-
* {@link RESERVED_USERNAMES}, minus `alia`, checked against each `-`/`_`
|
|
158
|
-
* separated SEGMENT of a candidate rather than the whole string — so
|
|
159
|
-
* `official-oxy`, `super-admin` and `team-kaana` are refused the same as the
|
|
160
|
-
* bare words, without banning every word that merely CONTAINS one as a
|
|
161
|
-
* substring (`superman`, `modern`, `grassroot`, `homeowner` all stay legal:
|
|
162
|
-
* none of them separates the reserved word from the rest with `-` or `_`).
|
|
163
|
-
*
|
|
164
|
-
* `alia` is excluded because `alia-` is the live internal-cost-centre
|
|
165
|
-
* namespace: `alia-production-chat` is a minted account and
|
|
166
|
-
* `alia-research` / `alia-voice` / `alia-evaluations` are pinned as legal
|
|
167
|
-
* slugs in `__tests__/username.test.ts` and `internalCostCenterSpecs.test.ts`.
|
|
168
|
-
* Segment-matching `alia` would refuse all four. The bare word `alia` is
|
|
169
|
-
* still refused — {@link RESERVED_USERNAMES} above catches it exactly.
|
|
170
|
-
*/
|
|
171
|
-
const RESERVED_USERNAME_SEGMENTS = new Set([...RESERVED_USERNAMES].filter((word) => word !== 'alia'));
|
|
172
|
-
/** The 400 / inline-validation copy for a handle that is only digits. */
|
|
173
|
-
export const NUMERIC_USERNAME_MESSAGE = 'Username cannot be only numbers';
|
|
174
|
-
/**
|
|
175
|
-
* Alphanumeric runs joined by single separators, as a SOURCE string.
|
|
176
|
-
*
|
|
177
|
-
* A string rather than a literal because the OpenAPI docblocks that publish this
|
|
178
|
-
* rule (`POST /auth/register`, `PUT /users/:userId`) must quote it verbatim, and
|
|
179
|
-
* `usernamePolicySingleSource.test.ts` compares them against THIS constant. A
|
|
180
|
-
* published `pattern:` that drifts from the enforced rule is a lie told to every
|
|
181
|
-
* client that generates from the spec, and it is exactly the kind of copy nobody
|
|
182
|
-
* notices going stale.
|
|
183
|
-
*
|
|
184
|
-
* Deliberately NOT re-exported from the package barrel: it exists for the
|
|
185
|
-
* schema below and for that one gate. Anything validating a username uses
|
|
186
|
-
* {@link usernameSchema}, so there is no second way to ask the question.
|
|
187
|
-
*
|
|
188
|
-
* Written as an unambiguous alternation rather than a lookahead: every character
|
|
189
|
-
* belongs to exactly one branch, so matching is linear and there is no
|
|
190
|
-
* backtracking to bound. It also carries no `\p{…}` property escape, which
|
|
191
|
-
* mobile Hermes throws on at runtime — this module is reachable from every React
|
|
192
|
-
* Native consumer.
|
|
193
|
-
*/
|
|
194
|
-
export const USERNAME_PATTERN_SOURCE = '^[A-Za-z0-9]+(?:[-_][A-Za-z0-9]+)*$';
|
|
195
|
-
const USERNAME_PATTERN = new RegExp(USERNAME_PATTERN_SOURCE);
|
|
102
|
+
// The Zod-free half of this contract lives in `./client/` (`@oxy.so/contracts/client`);
|
|
103
|
+
// it is re-exported here so the root entry is unchanged.
|
|
104
|
+
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';
|
|
105
|
+
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';
|
|
196
106
|
/**
|
|
197
107
|
* The one username policy, as a schema.
|
|
198
108
|
*
|
|
@@ -223,36 +133,6 @@ export const usernameSchema = z
|
|
|
223
133
|
export function isValidUsername(candidate) {
|
|
224
134
|
return usernameSchema.safeParse(candidate).success;
|
|
225
135
|
}
|
|
226
|
-
/**
|
|
227
|
-
* Drop the characters the policy forbids, for an input field that filters
|
|
228
|
-
* keystrokes.
|
|
229
|
-
*
|
|
230
|
-
* This is a TYPING aid and nothing else — the result still has to pass
|
|
231
|
-
* {@link usernameSchema}, which is what decides. It does not lower-case (case is
|
|
232
|
-
* preserved, see the header) and it cannot repair a name: a value that is too
|
|
233
|
-
* short, edge-separated or doubly-separated comes back unchanged and fails
|
|
234
|
-
* validation with a message, which is the outcome the coercing rules this
|
|
235
|
-
* replaces used to hide.
|
|
236
|
-
*/
|
|
237
|
-
export function stripDisallowedUsernameCharacters(input) {
|
|
238
|
-
return input.replace(/[^A-Za-z0-9_-]/g, '');
|
|
239
|
-
}
|
|
240
|
-
/**
|
|
241
|
-
* The label a bot's handle ends in — the ONE exception the policy carries.
|
|
242
|
-
*
|
|
243
|
-
* Lower-case here because it is what a generator appends; the comparison that
|
|
244
|
-
* enforces it folds case, so `MyBot` satisfies it just as `mybot` does.
|
|
245
|
-
*
|
|
246
|
-
* Deliberately NOT re-exported from the package barrel, for the same reason
|
|
247
|
-
* {@link USERNAME_PATTERN_SOURCE} is not: it exists for the schema and the
|
|
248
|
-
* generator aid below. A consumer that wants to SAY the rule uses
|
|
249
|
-
* {@link BOT_USERNAME_INVALID_MESSAGE}, which already quotes it, and one that
|
|
250
|
-
* wants to APPLY it uses {@link applyBotUsernameSuffix} — so there is no second
|
|
251
|
-
* way to spell the check.
|
|
252
|
-
*/
|
|
253
|
-
export const BOT_USERNAME_SUFFIX = 'bot';
|
|
254
|
-
/** The 400 / inline-validation copy for a bot handle that carries no label. */
|
|
255
|
-
export const BOT_USERNAME_INVALID_MESSAGE = `A bot account's username must end in "${BOT_USERNAME_SUFFIX}"`;
|
|
256
136
|
/**
|
|
257
137
|
* The username policy for an account of kind `bot`: everything above, plus a
|
|
258
138
|
* handle that ends in {@link BOT_USERNAME_SUFFIX}.
|
|
@@ -327,27 +207,3 @@ export const botUsernameSchema = usernameSchema.refine((username) => username.to
|
|
|
327
207
|
export function usernameSchemaForAccountKind(kind) {
|
|
328
208
|
return kind === 'bot' ? botUsernameSchema : usernameSchema;
|
|
329
209
|
}
|
|
330
|
-
/**
|
|
331
|
-
* Label a proposed bot handle, so a generator PROPOSES something the server will
|
|
332
|
-
* accept.
|
|
333
|
-
*
|
|
334
|
-
* Alia builds an agent's handle from its display name; without this it would
|
|
335
|
-
* propose `garden-helper` for a bot and be 400ed on submit, which is the same
|
|
336
|
-
* "suggest, then refuse" defect the minimum length already caused once.
|
|
337
|
-
*
|
|
338
|
-
* It appends and never inserts: a separator is the caller's choice, so
|
|
339
|
-
* `garden-helper` becomes `garden-helperbot` while a caller who typed
|
|
340
|
-
* `garden-helper-` gets `garden-helper-bot`. It truncates to leave room rather
|
|
341
|
-
* than overflowing {@link USERNAME_MAX_LENGTH}.
|
|
342
|
-
*
|
|
343
|
-
* Like {@link stripDisallowedUsernameCharacters} it is an aid, not a decision: it
|
|
344
|
-
* cannot repair a handle the base policy refuses, and the result still has to
|
|
345
|
-
* pass {@link botUsernameSchema}.
|
|
346
|
-
*/
|
|
347
|
-
export function applyBotUsernameSuffix(candidate) {
|
|
348
|
-
const trimmed = candidate.trim();
|
|
349
|
-
if (trimmed.toLowerCase().endsWith(BOT_USERNAME_SUFFIX)) {
|
|
350
|
-
return trimmed;
|
|
351
|
-
}
|
|
352
|
-
return trimmed.slice(0, USERNAME_MAX_LENGTH - BOT_USERNAME_SUFFIX.length) + BOT_USERNAME_SUFFIX;
|
|
353
|
-
}
|