@bunizao/contracts 0.7.2 → 0.8.0

package/dist/comments.d.ts

@@ -60,6 +60,9 @@ export interface ReaderMe {
     provider: ReaderProvider;
     displayName: string;
     avatarUrl: string;
+    /** Seed of the drawn face shown when `avatarUrl` is empty. Null until one
+        has been handed out -- the client then draws from the name. */
+    avatarSeed: number | null;
     notifyReplies: boolean;
     /** Whether this address holds an active newsletter subscription. */
     subscribed: boolean;
@@ -131,6 +134,8 @@ export declare const DEFAULT_REACTION_EMOJI = "\u2764\uFE0F";
 export interface ReactorChip {
     name: string;
     avatarUrl: string | null;
+    /** Drawn-face seed; absent from servers older than 0.8.0. */
+    avatarSeed?: number | null;
 }
 export interface ReactionSummary {
     emoji: string;
@@ -304,6 +309,10 @@ export interface CommentAuthor {
         any key it does not know, so a path emitted for every address would make
         every face an identicon. */
     avatarUrl: string;
+    /** Seed of the drawn face for an empty `avatarUrl`: the writer's reader
+        seed when they have one, else the seed the comment was posted with.
+        Null or absent (servers older than 0.8.0) means draw from the name. */
+    avatarSeed?: number | null;
     /** True when this row's writer is the blog owner. */
     byAuthor: boolean;
 }
@@ -361,6 +370,9 @@ export interface CommentCreateInput {
         Omitted or empty: the comment is owned by its anon session only and
         the client renders an identicon. */
     email?: string;
+    /** The drawn face the writer picked in the compose box, from
+        `READER_AVATAR_SEED_PATH`. Ignored when it is not an `isAvatarSeed`. */
+    avatarSeed?: number;
     turnstileToken: string;
     /** Visually-hidden honeypot field. Must arrive empty. */
     website?: string;
@@ -523,3 +535,29 @@ export interface CommentTelemetryInput {
     outcome: 'accepted' | 'http_error' | 'network_error' | 'challenge_failed';
     challenges: number;
 }
+/** A drawn face's colour pair is `seed % AVATAR_CLASSES`: five palette
+    colours as background, times the four others as head. The pair is what
+    tells two faces apart at stack size, so it is the unit the server balances
+    when it hands out a seed and the unit a re-roll must change. The palette
+    itself is a rendering concern and lives with the client. */
+export declare const AVATAR_CLASSES = 20;
+export declare const MAX_AVATAR_SEED = 4294967295;
+export declare function isAvatarSeed(value: unknown): value is number;
+export declare function avatarClass(seed: number): number;
+/** A seed in colour class `cls`; `variety` fills the digits that pick the
+    expression, pose and head shape. */
+export declare function seedInClass(cls: number, variety: number): number;
+/** POST body for `READER_AVATAR_SEED_PATH`. */
+export interface AvatarSeedInput {
+    /** The seed on screen now. The answer is always in a different colour
+        class, so every re-roll visibly changes the face. */
+    current?: number | null;
+}
+export interface AvatarSeedResult {
+    /** In the least-used colour class across the site, never `current`'s. */
+    seed: number;
+    /** True when the caller is a verified reader and the seed is now theirs
+        everywhere. False for anyone else: the client keeps it and sends it as
+        `CommentCreateInput.avatarSeed`. */
+    persisted: boolean;
+}

package/dist/comments.js

@@ -61,7 +61,20 @@ function commentPolicyFromTags(tags, base = DEFAULT_COMMENT_POLICY) {
   return policy;
 }
 var acceptsComments = (policy) => policy.mode === "open";
+var AVATAR_CLASSES = 20;
+var MAX_AVATAR_SEED = 4294967295;
+function isAvatarSeed(value) {
+  return Number.isInteger(value) && value >= 0 && value <= MAX_AVATAR_SEED;
+}
+function avatarClass(seed) {
+  return seed % AVATAR_CLASSES;
+}
+function seedInClass(cls, variety) {
+  const span = Math.floor(MAX_AVATAR_SEED / AVATAR_CLASSES);
+  return Math.abs(Math.trunc(variety)) % span * AVATAR_CLASSES + Math.abs(Math.trunc(cls)) % AVATAR_CLASSES;
+}
 export {
+  AVATAR_CLASSES,
   COMMENTS_MODES,
   COMMENT_ANCHOR_PATTERN,
   COMMENT_ANCHOR_TOKEN_LENGTH,
@@ -72,6 +85,7 @@ export {
   COMMENT_SURFACES,
   DEFAULT_COMMENT_POLICY,
   DEFAULT_REACTION_EMOJI,
+  MAX_AVATAR_SEED,
   MODERATION_ACTIONS,
   MODERATION_REASONS,
   REACTION_TARGET_TYPES,
@@ -80,6 +94,9 @@ export {
   READER_PROVIDERS,
   READER_VERIFY_OUTCOMES,
   acceptsComments,
+  avatarClass,
   commentAnchorToken,
-  commentPolicyFromTags
+  commentPolicyFromTags,
+  isAvatarSeed,
+  seedInClass
 };

package/dist/index.js

@@ -73,6 +73,18 @@ function commentPolicyFromTags(tags, base = DEFAULT_COMMENT_POLICY) {
   return policy;
 }
 var acceptsComments = (policy) => policy.mode === "open";
+var AVATAR_CLASSES = 20;
+var MAX_AVATAR_SEED = 4294967295;
+function isAvatarSeed(value) {
+  return Number.isInteger(value) && value >= 0 && value <= MAX_AVATAR_SEED;
+}
+function avatarClass(seed) {
+  return seed % AVATAR_CLASSES;
+}
+function seedInClass(cls, variety) {
+  const span = Math.floor(MAX_AVATAR_SEED / AVATAR_CLASSES);
+  return Math.abs(Math.trunc(variety)) % span * AVATAR_CLASSES + Math.abs(Math.trunc(cls)) % AVATAR_CLASSES;
+}
 // src/content.ts
 var CONTENT_DOCUMENT_SOURCES = ["mood", "post"];
 var POST_LOCALE_RE = /^[a-z]{2,8}(?:-[a-z0-9]{1,8})*$/;
@@ -130,6 +142,7 @@ var READER_RESEND_PATH = "/v2/reader/resend";
 var READER_PREFERENCES_PATH = "/v2/reader/preferences";
 var READER_MUTE_PATH = "/v2/reader/mute";
 var READER_AVATAR_PATH_PREFIX = "/v2/reader/avatar/";
+var READER_AVATAR_SEED_PATH = "/v2/reader/avatar-seed";
 var READER_OAUTH_PATH_PREFIX = "/oauth/reader/";
 var READER_CONFIRM_PATH = "/reader/confirm";
 var READER_MUTE_PAGE_PATH = "/reader/mute";
@@ -203,6 +216,7 @@ var TELEGRAM_OPS_BROADCAST_STATUSES = [
 export {
   ADMIN_BASE_PATH,
   API_PREFIX,
+  AVATAR_CLASSES,
   BLOG_ANALYTICS_ARTICLE_ENDPOINT,
   BLOG_ANALYTICS_COMPLETION_SCROLL_DEPTH,
   BLOG_ANALYTICS_EVENTS_DEFAULT_LIMIT,
@@ -234,6 +248,7 @@ export {
   LEGACY_NOTIFY_BASE_PATH,
   LISTENING_ANALYTICS_EVENT_ENDPOINT,
   LISTENING_PATH,
+  MAX_AVATAR_SEED,
   MESSAGE_LOCALES,
   MESSAGE_MAX_BODY_LENGTH,
   MESSAGE_MAX_NAME_LENGTH,
@@ -269,6 +284,7 @@ export {
   REACTIONS_TOGGLE_PATH,
   REACTION_TARGET_TYPES,
   READER_AVATAR_PATH_PREFIX,
+  READER_AVATAR_SEED_PATH,
   READER_CONFIRM_PATH,
   READER_GRADES,
   READER_ME_PATH,
@@ -298,9 +314,12 @@ export {
   TELEGRAM_OPS_WEBHOOK_PATH,
   TELEGRAM_WEBHOOK_PATH,
   acceptsComments,
+  avatarClass,
   commentAnchorToken,
   commentPolicyFromTags,
+  isAvatarSeed,
   parsePostLocaleTag,
+  seedInClass,
   telegramOpsEventActionPath,
   telegramOpsEventPath,
   telegramOpsReminderDeliveredPath,

package/dist/routes.d.ts

@@ -23,6 +23,7 @@ export declare const READER_RESEND_PATH: '/v2/reader/resend';
 export declare const READER_PREFERENCES_PATH: '/v2/reader/preferences';
 export declare const READER_MUTE_PATH: '/v2/reader/mute';
 export declare const READER_AVATAR_PATH_PREFIX: '/v2/reader/avatar/';
+export declare const READER_AVATAR_SEED_PATH: '/v2/reader/avatar-seed';
 export declare const READER_OAUTH_PATH_PREFIX: '/oauth/reader/';
 export declare const READER_CONFIRM_PATH: '/reader/confirm';
 export declare const READER_MUTE_PAGE_PATH: '/reader/mute';

package/dist/routes.js

@@ -24,6 +24,7 @@ var READER_RESEND_PATH = "/v2/reader/resend";
 var READER_PREFERENCES_PATH = "/v2/reader/preferences";
 var READER_MUTE_PATH = "/v2/reader/mute";
 var READER_AVATAR_PATH_PREFIX = "/v2/reader/avatar/";
+var READER_AVATAR_SEED_PATH = "/v2/reader/avatar-seed";
 var READER_OAUTH_PATH_PREFIX = "/oauth/reader/";
 var READER_CONFIRM_PATH = "/reader/confirm";
 var READER_MUTE_PAGE_PATH = "/reader/mute";
@@ -67,6 +68,7 @@ export {
   REACTIONS_PATH,
   REACTIONS_TOGGLE_PATH,
   READER_AVATAR_PATH_PREFIX,
+  READER_AVATAR_SEED_PATH,
   READER_CONFIRM_PATH,
   READER_ME_PATH,
   READER_MUTE_PAGE_PATH,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bunizao/contracts",
-  "version": "0.7.2",
+  "version": "0.8.0",
   "description": "Shared TypeScript contracts for buxx.me services and clients.",
   "type": "module",
   "sideEffects": false,