@oxy.so/contracts 4.12.0 → 4.14.0

package/dist/types/accountGraph.d.ts

@@ -207,7 +207,7 @@ export declare const MAX_ACCOUNT_CATEGORIES = 4;
  * property the list exists to carry. A duplicate only ever comes from a client
  * bug, and a 400 naming the index is how that bug gets found.
  */
-export declare const accountCategoriesSchema: z.ZodEffects<z.ZodArray<z.ZodEnum<["news", "politics", "business", "startup", "finance", "crypto", "marketplace", "retail", "real_estate", "agency", "landlord", "cooperative", "architecture", "technology", "software", "ai", "security", "automation", "science", "education", "books", "health", "fitness", "sports", "gaming", "music", "film", "podcast", "art", "photography", "comedy", "food", "travel", "fashion", "home_garden", "diy", "automotive", "animals", "family", "nonprofit", "government", "community", "activism", "environment", "religion", "other"]>, "many">, ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[], ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[]>;
+export declare const accountCategoriesSchema: z.ZodEffects<z.ZodArray<z.ZodEnum<["news", "politics", "business", "startup", "finance", "crypto", "marketplace", "retail", "real_estate", "agency", "landlord", "cooperative", "architecture", "technology", "software", "ai", "security", "automation", "science", "education", "books", "health", "fitness", "sports", "gaming", "music", "film", "podcast", "art", "photography", "comedy", "food", "travel", "fashion", "home_garden", "diy", "automotive", "animals", "family", "nonprofit", "government", "community", "activism", "environment", "religion", "other"]>, "many">, ("news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "security" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[], ("news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "security" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[]>;
 /**
  * Kinds that may carry categories: every kind EXCEPT `personal`.
  *
@@ -227,6 +227,33 @@ export type AccountCategoryKind = (typeof ACCOUNT_CATEGORY_KINDS)[number];
  * {@link ACCOUNT_CATEGORY_KINDS}, so they cannot disagree.
  */
 export declare function kindAcceptsAccountCategories(kind: AccountKind | null | undefined): boolean;
+/**
+ * An account's name on the create/update wire.
+ *
+ * `displayName` is EXPLICIT and stored, not derived. `first`/`last` model a
+ * human name, and composing a display string from them is right for a person —
+ * but a non-personal account has a TITLE, not a given and family name. Without
+ * this field the only way to name a channel "Notas de Nate" was to put the whole
+ * title in `first`, which renders correctly by accident while recording it as
+ * somebody's given name.
+ *
+ * When present it wins over the composed `first`/`last` (see the API's
+ * `composeDisplayName`, which already preferred an explicit value — only the
+ * storage for one was missing).
+ */
+export declare const accountNameSchema: z.ZodOptional<z.ZodObject<{
+    first: z.ZodOptional<z.ZodString>;
+    last: z.ZodOptional<z.ZodString>;
+    displayName: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    first?: string | undefined;
+    last?: string | undefined;
+    displayName?: string | undefined;
+}, {
+    first?: string | undefined;
+    last?: string | undefined;
+    displayName?: string | undefined;
+}>>;
 /**
  * POST /accounts — create a non-personal account under the caller's tree.
  *
@@ -287,7 +314,8 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
      */
     color: z.ZodOptional<z.ZodString>;
     /** Ordered, PRIMARY FIRST — see rule 2 above {@link ACCOUNT_CATEGORY_IDS}. */
-    accountCategories: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodEnum<["news", "politics", "business", "startup", "finance", "crypto", "marketplace", "retail", "real_estate", "agency", "landlord", "cooperative", "architecture", "technology", "software", "ai", "security", "automation", "science", "education", "books", "health", "fitness", "sports", "gaming", "music", "film", "podcast", "art", "photography", "comedy", "food", "travel", "fashion", "home_garden", "diy", "automotive", "animals", "family", "nonprofit", "government", "community", "activism", "environment", "religion", "other"]>, "many">, ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[], ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[]>>;
+    accountCategories: z.ZodOptional<z.ZodEffects<z.ZodArray<z.ZodEnum<["news", "politics", "business", "startup", "finance", "crypto", "marketplace", "retail", "real_estate", "agency", "landlord", "cooperative", "architecture", "technology", "software", "ai", "security", "automation", "science", "education", "books", "health", "fitness", "sports", "gaming", "music", "film", "podcast", "art", "photography", "comedy", "food", "travel", "fashion", "home_garden", "diy", "automotive", "animals", "family", "nonprofit", "government", "community", "activism", "environment", "religion", "other"]>, "many">, ("news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "security" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[], ("news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "security" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[]>>;
+    organizationType: z.ZodOptional<z.ZodEnum<["business", "nonprofit", "public_body", "community", "other"]>>;
     /**
      * Create the account already opted OUT of discovery.
      *
@@ -329,9 +357,17 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
      * remedy must not either.
      */
     isPrivateAccount: z.ZodOptional<z.ZodBoolean>;
+    /**
+     * The 3D avatar character of a `bot` — and ONLY of a bot (the refinement
+     * below). Optional on the wire: a bot created without one is given a look
+     * seeded from its handle (`avatarCharacterFor`), so every bot account has a
+     * character from birth and the owner customizes it afterwards.
+     */
+    character: z.ZodOptional<z.ZodType<import("./avatarCharacter").AvatarCharacter, z.ZodTypeDef, unknown>>;
 }, "strip", z.ZodTypeAny, {
-    kind: "bot" | "organization" | "project" | "channel";
+    kind: "organization" | "project" | "bot" | "channel";
     username: string;
+    color?: string | undefined;
     parentAccountId?: string | undefined;
     name?: {
         first?: string | undefined;
@@ -341,12 +377,14 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
     bio?: string | undefined;
     avatar?: string | undefined;
     description?: string | undefined;
-    color?: string | undefined;
-    accountCategories?: ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
+    accountCategories?: ("news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "security" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
+    organizationType?: "business" | "nonprofit" | "community" | "other" | "public_body" | undefined;
     isPrivateAccount?: boolean | undefined;
+    character?: import("./avatarCharacter").AvatarCharacter | undefined;
 }, {
-    kind: "bot" | "organization" | "project" | "channel";
+    kind: "organization" | "project" | "bot" | "channel";
     username: string;
+    color?: string | undefined;
     parentAccountId?: string | undefined;
     name?: {
         first?: string | undefined;
@@ -356,12 +394,14 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
     bio?: string | undefined;
     avatar?: string | undefined;
     description?: string | undefined;
-    color?: string | undefined;
-    accountCategories?: ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
+    accountCategories?: ("news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "security" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
+    organizationType?: "business" | "nonprofit" | "community" | "other" | "public_body" | undefined;
     isPrivateAccount?: boolean | undefined;
+    character?: unknown;
 }>, {
-    kind: "bot" | "organization" | "project" | "channel";
+    kind: "organization" | "project" | "bot" | "channel";
     username: string;
+    color?: string | undefined;
     parentAccountId?: string | undefined;
     name?: {
         first?: string | undefined;
@@ -371,12 +411,14 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
     bio?: string | undefined;
     avatar?: string | undefined;
     description?: string | undefined;
-    color?: string | undefined;
-    accountCategories?: ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
+    accountCategories?: ("news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "security" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
+    organizationType?: "business" | "nonprofit" | "community" | "other" | "public_body" | undefined;
     isPrivateAccount?: boolean | undefined;
+    character?: import("./avatarCharacter").AvatarCharacter | undefined;
 }, {
-    kind: "bot" | "organization" | "project" | "channel";
+    kind: "organization" | "project" | "bot" | "channel";
     username: string;
+    color?: string | undefined;
     parentAccountId?: string | undefined;
     name?: {
         first?: string | undefined;
@@ -386,8 +428,9 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
     bio?: string | undefined;
     avatar?: string | undefined;
     description?: string | undefined;
-    color?: string | undefined;
-    accountCategories?: ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
+    accountCategories?: ("news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "security" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
+    organizationType?: "business" | "nonprofit" | "community" | "other" | "public_body" | undefined;
     isPrivateAccount?: boolean | undefined;
+    character?: unknown;
 }>;
 export type CreateAccountRequest = z.infer<typeof createAccountRequestSchema>;

package/dist/types/accountSubject.d.ts

@@ -166,7 +166,7 @@ export declare const financialEffectAttributionSchema: z.ZodEffects<z.ZodObject<
     }>;
 }, "strict", z.ZodTypeAny, {
     schemaVersion: 1;
-    direction: "credit" | "debit";
+    direction: "debit" | "credit";
     subjectAccountId: string & z.BRAND<"OxyAccountId">;
     actor: {
         schemaVersion: 1;
@@ -176,7 +176,7 @@ export declare const financialEffectAttributionSchema: z.ZodEffects<z.ZodObject<
     };
 }, {
     schemaVersion: 1;
-    direction: "credit" | "debit";
+    direction: "debit" | "credit";
     subjectAccountId: string;
     actor: {
         schemaVersion: 1;
@@ -186,7 +186,7 @@ export declare const financialEffectAttributionSchema: z.ZodEffects<z.ZodObject<
     };
 }>, {
     schemaVersion: 1;
-    direction: "credit" | "debit";
+    direction: "debit" | "credit";
     subjectAccountId: string & z.BRAND<"OxyAccountId">;
     actor: {
         schemaVersion: 1;
@@ -196,7 +196,7 @@ export declare const financialEffectAttributionSchema: z.ZodEffects<z.ZodObject<
     };
 }, {
     schemaVersion: 1;
-    direction: "credit" | "debit";
+    direction: "debit" | "credit";
     subjectAccountId: string;
     actor: {
         schemaVersion: 1;

package/dist/types/avatarCharacter.d.ts

@@ -0,0 +1,57 @@
+/**
+ * The 3D avatar character a `bot` account carries.
+ *
+ * ONE definition for the wire shape, its validator and the generator that picks
+ * a look for a new bot, shared by the Oxy API (which stores and serves it) and
+ * every client. It mirrors Bloom's flat `AvatarCharacter`
+ * (`@oxy.so/bloom/agent-avatar`).
+ *
+ * ## The vocabulary is Bloom's and is NOT enforced here
+ *
+ * Bloom is a React Native package this one cannot depend on, so the ids a
+ * character is made of are restated below as a curated SUBSET, only to PICK a
+ * look for a new bot ({@link avatarCharacterFor}). A STORED character is never
+ * checked against them: validating against a stale copy of somebody else's
+ * catalogue is how a working look starts being refused. What the schema checks
+ * is the SHAPE of what a client writes: only the keys a character has, each an
+ * id-like string, a `#rrggbb` paint, a spacing in range. The client resolves
+ * the ids and falls back on a default look for one it cannot draw.
+ */
+import { z } from 'zod';
+/** The flat shape of Bloom's `AvatarCharacter`; every field is optional (a preset supplies the rest). */
+export interface AvatarCharacter {
+    preset?: string;
+    shape?: string;
+    eyes?: string;
+    eyewear?: string;
+    accessory?: string;
+    /** Named paint. */
+    color?: string;
+    /** Exact paint, `#rrggbb`; it wins over `color`. */
+    bodyColor?: string;
+    /** A multiplier (0.5 to 1.5) on the shape's eye separation. */
+    eyeSpacing?: number;
+}
+/** Bounds of {@link AvatarCharacter.eyeSpacing}. */
+export declare const AVATAR_EYE_SPACING: {
+    readonly min: 0.5;
+    readonly max: 1.5;
+};
+/**
+ * A character a client sends. `.strict()` so a misspelled field is a refusal
+ * now rather than a look that never takes effect. A character with nothing in
+ * it draws nothing: it needs a preset, or a shape and a paint.
+ */
+export declare const avatarCharacterSchema: z.ZodType<AvatarCharacter, z.ZodTypeDef, unknown>;
+/** The validated character, or `null` for anything that is not one. */
+export declare function parseAvatarCharacter(value: unknown): AvatarCharacter | null;
+/** The parts a new bot's look is picked from: the plain, friendly shapes, in the editor's order. */
+export declare const AVATAR_PICKABLE_SHAPES: readonly ["rounded_triangle", "capsule", "rounded_head_two_ears", "six_lobed_flower", "heart", "four_lobed_butterfly", "circle_two_ears", "twelve_scalloped_rosette", "rounded_cube", "rounded_diamond", "slender", "pocket", "petal", "star", "cloud", "shield", "pebble", "squircle"];
+/** Bloom's named paints. */
+export declare const AVATAR_PICKABLE_COLORS: readonly ["pink", "orchid", "violet", "blue", "cyan", "teal", "lime", "yellow", "coral"];
+/**
+ * A look for a new bot, picked from its seed (its handle): a shape and a paint,
+ * plain oval eyes, nothing on its head. Stable — the same seed is the same look
+ * — and the owner changes it afterwards.
+ */
+export declare function avatarCharacterFor(seed: string): AvatarCharacter;