@bunizao/contracts 0.9.0 → 0.10.0

package/dist/comments.d.ts

@@ -514,17 +514,36 @@ 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`. */
+/** How many faces an `offer` holds. */
+export declare const AVATAR_OFFER_SIZE = 5;
+/** POST body for `READER_AVATAR_SEED_PATH`.
+
+    - `issue` (the default): one seed, handed out and counted. The first face
+      a browser gets.
+    - `offer`: AVATAR_OFFER_SIZE candidates to choose from, nothing counted
+      or kept -- a reader browsing faces has not taken one yet.
+    - `choose`: `seed` becomes the caller's face, counted and, for a verified
+      reader, kept. */
 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. */
+    /** The seed on screen now. `issue` and `offer` always answer in other
+        colour classes, so every new face visibly changes. */
     current?: number | null;
+    mode?: 'issue' | 'offer' | 'choose';
+    /** Required for `choose`. */
+    seed?: number;
 }
+/** The answer to `issue` and `choose`. */
 export interface AvatarSeedResult {
-    /** In the least-used colour class across the site, never `current`'s. */
+    /** For `issue`, in the least-used colour class across the site, never
+        `current`'s. For `choose`, the seed that was sent. */
     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;
 }
+/** The answer to `offer`: one seed in each of the AVATAR_OFFER_SIZE
+    least-used colour classes, none of them `current`'s. */
+export interface AvatarSeedOfferResult {
+    seeds: number[];
+}

package/dist/comments.js

@@ -74,8 +74,10 @@ 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;
 }
+var AVATAR_OFFER_SIZE = 5;
 export {
   AVATAR_CLASSES,
+  AVATAR_OFFER_SIZE,
   COMMENTS_MODES,
   COMMENT_ANCHOR_PATTERN,
   COMMENT_ANCHOR_TOKEN_LENGTH,

package/dist/index.js

@@ -86,6 +86,7 @@ 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;
 }
+var AVATAR_OFFER_SIZE = 5;
 // src/content.ts
 var CONTENT_DOCUMENT_SOURCES = ["mood", "post"];
 var POST_LOCALE_RE = /^[a-z]{2,8}(?:-[a-z0-9]{1,8})*$/;
@@ -220,6 +221,7 @@ export {
   ADMIN_BASE_PATH,
   API_PREFIX,
   AVATAR_CLASSES,
+  AVATAR_OFFER_SIZE,
   BLOG_ANALYTICS_ARTICLE_ENDPOINT,
   BLOG_ANALYTICS_COMPLETION_SCROLL_DEPTH,
   BLOG_ANALYTICS_EVENTS_DEFAULT_LIMIT,

package/package.json

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