@domino-sdk/relay 1.0.0-next.13 → 1.0.0-next.15

package/README.md

@@ -13,7 +13,7 @@ pnpm add @domino-sdk/relay
 | `@domino-sdk/relay/react`        | React hooks over the browser client                                                        |
 | `@domino-sdk/relay/avatar`       | Generated default avatars (`avatarSrc`, `defaultAvatar`)                                   |
 | `@domino-sdk/relay/authoring`    | Quest, tracker, leaderboard, referral and engagement definitions, and evaluator types     |
-| `@domino-sdk/relay/schema`       | Zod schemas of Relay's API bodies, deployments, tracker records and observations           |
+| `@domino-sdk/relay/schema`       | Zod schemas of Relay's API bodies, deployments and tracker records                         |
 | `@domino-sdk/relay/build`        | Bundling authored modules; needs `esbuild` installed                                       |
 | `@domino-sdk/relay/portal-proxy` | Server proxies and hosted app Workers                                                      |
 | `@domino-sdk/relay/vite`         | The Vite plugin that keeps server code out of the browser build                            |

package/dist/authoring.d.ts

@@ -1,14 +1,13 @@
 import { z } from 'zod';
 export { z } from 'zod';
 import { e as ContentPolicy, C as ContentMetric, E as EngagementBudget, T as leaderboardDefinitionSchema, a9 as referralAuthoringSchema, A as AdmittedContent } from './referrals-KQfP4pBf.js';
+import { r as discordMessagesSourceSchema, a as DiscordMessageData, b as DiscordMessageTextData, t as discordReactionsSourceSchema, c as DiscordReactionData, e as ResourceSource, S as Setting, j as XReader, D as DiscordMessage, B as Budget, I as IntegerSettings, d as IntegrationProvider } from './integrations-C1vB6Ry6.js';
 import { Q as QuizContent, a as StreakPolicy } from './streaks-CWyq8Px5.js';
-import { b as ResourceSource, S as Setting, g as XReader, I as IntegerSettings, a as IntegrationProvider } from './integrations-EjQzIApL.js';
-import { j as TrackerDefinition, I as IdentityKind, J as customSourceSchema, F as WithRecordData, t as TrackerSource, a1 as trackerDefinitionSchema, T as Tracker, g as TrackerData, au as xSearchSourceSchema, X as XTweet, v as TrackerTriggerContext, x as TrackerTriggerPolicy, q as TrackerReader, W as Where, w as TrackerTriggerMode, E as WhereSetting } from './trackers-W7nRdRr7.js';
-export { i as TrackerDataSchema, m as TrackerPage, aw as trackerDataSchema, ak as trackerTriggerContextSchema } from './trackers-W7nRdRr7.js';
-import { e as ImageReader } from './images-BG4pdO4y.js';
-import { O as Observation, D as DiscordMessage, h as observationTriggerSchema, B as Budget } from './observations-CQ6IcNuQ.js';
+import { j as TrackerDefinition, I as IdentityKind, K as customSourceSchema, G as WithRecordData, t as TrackerSource, a2 as trackerDefinitionSchema, T as Tracker, g as TrackerData, aw as xSearchSourceSchema, X as XTweet, w as TrackerTriggerContext, y as TrackerTriggerPolicy, q as TrackerReader, W as Where, x as TrackerTriggerMode, F as WhereSetting } from './trackers-7lxSWp2g.js';
+export { i as TrackerDataSchema, m as TrackerPage, ay as trackerDataSchema, am as trackerTriggerContextSchema } from './trackers-7lxSWp2g.js';
+import { e as ImageReader } from './images-CRxHUuG5.js';
 import { D as DiscordMember, T as TextEvidence, U as UrlEvidence, b as TextOptions, c as UrlOptions } from './submission-input-CccwAl5Z.js';
-import { n as TextReviewInput, m as TextResult, P as PhotoResult, ag as rewardSchema, av as triggerSchema, Q as QuestPresentation, a as QuestProfile, b as QuizEvidence, D as Decision, o as TieredRewardDefinition } from './schema-BF_TQsmT.js';
+import { n as TextReviewInput, m as TextResult, P as PhotoResult, ag as rewardSchema, av as triggerSchema, Q as QuestPresentation, a as QuestProfile, b as QuizEvidence, D as Decision, o as TieredRewardDefinition } from './schema-C4F2K9cm.js';
 import { k as WalletConnection, S as SolanaBalance, L as LinkedWallet, j as WalletBalanceQuery, i as WalletBalance } from './wallet-BtiG0Xhr.js';
 export { E as EvmChainId, r as isEvmChainId } from './wallet-BtiG0Xhr.js';
 export { f as formatUnits, p as parseUnits } from './units-CwgsPB_r.js';
@@ -33,7 +32,7 @@ declare function content(tracker: TrackerDefinition, policy?: Partial<Pick<Conte
         };
         enrollment: "required" | "none";
         posts: "after-enrollment" | "since-start";
-        historical: "staff" | "automatic" | "claim";
+        historical: "automatic" | "claim" | "staff";
     };
 };
 declare function perContent(): {
@@ -80,8 +79,8 @@ declare function defineEngagementReward<const M extends readonly [ContentMetric,
 /**
  * One milestone per quest, after `days` consecutive project calendar days with an accepted
  * attempt. Multiple accepted attempts occupy one day. The day comes from the attempt's trusted
- * occurrence time: a tracker record's (or observation's) `occurredAt` for `automatic({ tracker })`,
- * and the submission's admission time for `manual()`, so a manual streak counts the days a member
+ * occurrence time: a tracker record's `occurredAt` for `automatic({ tracker })`, and the
+ * submission's admission time for `manual()`, so a manual streak counts the days a member
  * submitted. Days begin at midnight in the project timezone (`calendar.timeZone` in relay.json, or
  * Console settings). Not available on content quests or prerequisite-only `automatic()`.
  */
@@ -186,8 +185,8 @@ declare function defineReferral(input: Omit<z.input<typeof referralAuthoringSche
 };
 declare function defineLeaderboard(input: Omit<z.input<typeof leaderboardDefinitionSchema>, "key" | "id"> & AuthoringIdentity): {
     id: string;
-    balance: string;
     title: string;
+    balance: string;
     group?: string | undefined;
     score: {
         kind: "balance";
@@ -252,7 +251,33 @@ declare function defineTracker<S extends TrackerSource>(input: Omit<z.input<type
 type ChannelTypes = Extract<ResourceSource, {
     resource: "channel";
 }>["types"];
+type DiscordMessagesSource = z.output<typeof discordMessagesSourceSchema>;
+/**
+ * Messages members post in the project's Discord server. The Discord gateway writes one record per
+ * message, keyed by the message ID: its `author` is the poster's Discord account, `occurredAt` is
+ * when the message arrived, and `data` holds the channel, the replied-to message and the post time.
+ * A record is stored only when its author has linked that Discord account in the project, and its
+ * text only with `text: true`.
+ */
+declare function messages(options?: {
+    text?: false;
+}): DiscordMessagesSource & WithRecordData<DiscordMessageData>;
+declare function messages(options: {
+    text: true;
+}): DiscordMessagesSource & WithRecordData<DiscordMessageTextData>;
+/**
+ * Reactions members add in the project's Discord server. The Discord gateway writes one record per
+ * reaction, keyed by message, reactor and emoji: its `author` is the reactor's Discord account and
+ * its `messageAuthor` account the message's author, when Discord names it. `occurredAt` is when
+ * the reaction arrived. A record is stored only when the reactor or the message author has linked
+ * that Discord account in the project. Pay the message author with
+ * `automatic({ tracker, beneficiary: "messageAuthor" })`; reactions to one's own message are
+ * skipped.
+ */
+declare function reactions(): z.output<typeof discordReactionsSourceSchema> & WithRecordData<DiscordReactionData>;
 declare const discord: {
+    messages: typeof messages;
+    reactions: typeof reactions;
     roles(options?: {
         assignable?: boolean;
     }): ResourceSource;
@@ -370,8 +395,9 @@ type TrackerTriggerInput<T extends Tracker = Tracker, W extends Where<TrackerDat
     tracker: T;
     /**
      * Which observations fire. `"new-record"`: each record's first observation (the default for X
-     * trackers, where it means each newly collected post). `"new-observation"`: each observation
-     * that becomes its record's current one (the default for custom trackers). `"data-changed"`: a
+     * and Discord trackers, where it means each newly collected post, message or reaction).
+     * `"new-observation"`: each observation that becomes its record's current one (the default for
+     * custom trackers). `"data-changed"`: a
      * new record, or a current observation whose `data` differs from the previous one.
      */
     on?: TrackerTriggerMode;
@@ -384,8 +410,9 @@ type TrackerTriggerInput<T extends Tracker = Tracker, W extends Where<TrackerDat
     where?: W;
     /**
      * The record account whose member the quest pays: `"author"` (the default), `"inReplyTo"` on
-     * an X tracker, or a named account a custom source declares in `accounts`. Skipped when that
-     * account is the record's author account or belongs to the author's member.
+     * an X tracker, `"messageAuthor"` on a Discord reactions tracker, or a named account a custom
+     * source declares in `accounts`. Skipped when that account is the record's author account or
+     * belongs to the author's member, such as a reaction to one's own message.
      */
     beneficiary?: string;
 };
@@ -408,17 +435,13 @@ type TriggerSettings<G> = G extends {
     readonly [triggerSettings]?: infer S;
 } ? unknown extends S ? never : Exclude<S, undefined> : never;
 /**
- * An automatic quest. With no argument it runs once its prerequisites are complete; with an
- * observation it runs for each matching observation; with a tracker it runs for each observation
- * its firing mode and filter admit, for the member Relay attributes the beneficiary account to.
+ * An automatic quest. With no argument it runs once its prerequisites are complete; with a tracker
+ * it runs for each observation its firing mode and filter admit, for the member Relay attributes
+ * the beneficiary account to.
  */
 declare function automatic(): {
     kind: "automatic";
 };
-declare function automatic(observation: z.infer<typeof observationTriggerSchema>): {
-    kind: "automatic";
-    observation: z.infer<typeof observationTriggerSchema>;
-};
 declare function automatic<T extends Tracker, const W extends Where<TrackerData<T>> | undefined = undefined>(input: TrackerTriggerInput<T, W>): TrackerTrigger<TrackerData<T>, WhereSetting<W>>;
 /**
  * What a trigger `G` supplies under key `K`: `Present` when the trigger has it, null when it cannot,
@@ -429,8 +452,6 @@ type Supplied<G, K extends string, Present, Base> = unknown extends G ? Base | n
 type ContextTracker<G> = Supplied<G, "tracker", TrackerTriggerContext<TriggerData<G>>, TrackerTriggerContext>;
 /** `ctx.content` for a trigger: the admitted post for a content trigger, null for others. */
 type ContextContent<G> = Supplied<G, "content", AdmittedContent, AdmittedContent>;
-/** `ctx.observation` for a trigger: the observation for an observation trigger, null for others. */
-type ContextObservation<G> = Supplied<G, "observation", Observation, Observation>;
 /**
  * What a `keyed()` completion key reads. TypeScript cannot carry the trigger into a completion
  * built inline, so `tracker` stays nullable here; the evaluator's `ctx.tracker` is typed.
@@ -440,7 +461,6 @@ type KeyedContext = {
         id: string;
     };
     content?: AdmittedContent | null;
-    observation: Observation | null;
     /** The pinned tracker observation of a tracker-triggered quest; null for other triggers. */
     tracker: TrackerTriggerContext | null;
     eligibleAt: number;
@@ -549,8 +569,8 @@ declare const decision: {
     review: typeof review;
 };
 /**
- * What an evaluator reads. `G` is the quest's trigger: `tracker`, `content` and `observation` are
- * non-null for the trigger that supplies them and null otherwise. `G` defaults to `any`, which
+ * What an evaluator reads. `G` is the quest's trigger: `tracker` and `content` are non-null for
+ * the trigger that supplies them and null otherwise. `G` defaults to `any`, which
  * leaves them nullable and lets a shared evaluator, such as `evaluators.photo()`, fit every quest.
  */
 type EvaluationContext<T, I = {
@@ -563,16 +583,14 @@ type EvaluationContext<T, I = {
     input: I;
     /** The admitted post of a content quest. */
     content: ContextContent<G>;
-    /** The observation of an observation-triggered quest. */
-    observation: ContextObservation<G>;
     /**
      * The tracker observation that admitted this attempt, and the member and verified account it
      * was attributed to. Present for a tracker trigger, with `record.data` of the tracker's type.
      */
     tracker: ContextTracker<G>;
     /**
-     * When the activity happened, in epoch milliseconds: the observation's or tracker record's
-     * occurrence time, else when the attempt was admitted. Budgets and daily keys use it.
+     * When the activity happened, in epoch milliseconds: the tracker record's occurrence time, else
+     * when the attempt was admitted. Budgets and daily keys use it.
      */
     eligibleAt: number;
     /**
@@ -744,12 +762,12 @@ declare function defineQuest<T extends Record<string, Setting>, const G extends
             kind: "resource";
             default: string;
             source: {
-                provider: "domino";
-                resource: "point-ledger";
-            } | {
                 provider: "discord";
                 resource: "channel";
                 types: ("text" | "announcement")[];
+            } | {
+                provider: "domino";
+                resource: "point-ledger";
             } | {
                 provider: "discord";
                 resource: "role";
@@ -836,10 +854,6 @@ declare function defineQuest<T extends Record<string, Setting>, const G extends
         humanReview: boolean;
         trigger: {
             kind: "automatic";
-            observation?: {
-                source: string;
-                type: string;
-            } | undefined;
             content?: {
                 tracker: string;
                 window: {
@@ -848,11 +862,11 @@ declare function defineQuest<T extends Record<string, Setting>, const G extends
                 };
                 enrollment: "required" | "none";
                 posts: "after-enrollment" | "since-start";
-                historical: "staff" | "automatic" | "claim";
+                historical: "automatic" | "claim" | "staff";
             } | undefined;
             tracker?: {
                 tracker: string;
-                source: "custom" | "x-search";
+                source: string;
                 beneficiary: string;
                 on?: "new-record" | "new-observation" | "data-changed" | undefined;
                 where?: {
@@ -899,7 +913,7 @@ declare function defineQuest<T extends Record<string, Setting>, const G extends
                 minLength: number;
                 maxLength: number;
             };
-            actor?: "staff" | "member" | undefined;
+            actor?: "member" | "staff" | undefined;
         } | {
             kind: "manual";
             input: "url";
@@ -907,11 +921,11 @@ declare function defineQuest<T extends Record<string, Setting>, const G extends
                 required: boolean;
                 allowedHosts?: string[] | undefined;
             };
-            actor?: "staff" | "member" | undefined;
+            actor?: "member" | "staff" | undefined;
         } | {
             kind: "manual";
-            input: "photo" | "quiz" | "none";
-            actor?: "staff" | "member" | undefined;
+            input: "none" | "quiz" | "photo";
+            actor?: "member" | "staff" | undefined;
         };
         requires: {
             quest: string;
@@ -952,4 +966,4 @@ declare function defineQuest<T extends Record<string, Setting>, const G extends
  * Console instances receive independent quest identities and pinned versions. */
 declare const defineQuestType: typeof defineQuest;
 
-export { type EvaluationContext, ImageReader, type KeyedContext, type PerformanceOutcome, Setting, Tracker, TrackerData, TrackerReader, type TrackerTrigger, TrackerTriggerContext, type TrackerTriggerInput, WalletBalance, WalletBalanceQuery, Where, XReader, automatic, budget, completed, content, customSource, decision, defineEngagementReward, defineLeaderboard, defineQuest, defineQuestType, defineReferral, defineTieredReward, defineTracker, discord, discordRole, evaluators, evidence, keyed, manual, once, perContent, pointLedgers, points, settings, staffHandover, streak, untracked, x };
+export { DiscordMessageData, DiscordMessageTextData, DiscordReactionData, type EvaluationContext, ImageReader, type KeyedContext, type PerformanceOutcome, Setting, Tracker, TrackerData, TrackerReader, type TrackerTrigger, TrackerTriggerContext, type TrackerTriggerInput, WalletBalance, WalletBalanceQuery, Where, XReader, automatic, budget, completed, content, customSource, decision, defineEngagementReward, defineLeaderboard, defineQuest, defineQuestType, defineReferral, defineTieredReward, defineTracker, discord, discordRole, evaluators, evidence, keyed, manual, once, perContent, pointLedgers, points, settings, staffHandover, streak, untracked, x };

package/dist/authoring.js

@@ -2,6 +2,10 @@ import {
   formatUnits,
   parseUnits
 } from "./chunk-V7UKZLHA.js";
+import {
+  sourceDataSchema,
+  sourceRoles
+} from "./chunk-FJ6O44NE.js";
 import {
   authoringKey,
   engagementDefinitionSchema,
@@ -10,7 +14,7 @@ import {
   isEvmChainId,
   leaderboardAuthoringSchema,
   referralAuthoringSchema
-} from "./chunk-OA2KMQVZ.js";
+} from "./chunk-J52HD4AA.js";
 import {
   admittedContentSchema,
   budgetSchema,
@@ -20,6 +24,8 @@ import {
   customSourceSchema,
   decisionSchema,
   defaultTriggerMode,
+  discordMessagesSourceSchema,
+  discordReactionsSourceSchema,
   identifier,
   integrationRewardSchema,
   parseSettings,
@@ -46,9 +52,8 @@ import {
   urlOptionsSchema,
   whereSchemaIssue,
   whereSettings,
-  xAccountRoles,
   xSearchSourceSchema
-} from "./chunk-CRNQP7NV.js";
+} from "./chunk-J4OYDYJE.js";
 
 // src/builders.ts
 import { z } from "zod";
@@ -147,7 +152,18 @@ function isZodSchema(value) {
 function defineTracker(input) {
   return trackerDefinitionSchema.parse(input);
 }
+function messages(options = {}) {
+  return discordMessagesSourceSchema.parse({
+    kind: "discord-messages",
+    ...options.text ? { text: true } : {}
+  });
+}
+function reactions() {
+  return discordReactionsSourceSchema.parse({ kind: "discord-reactions" });
+}
 var discord = {
+  messages,
+  reactions,
   roles(options = {}) {
     return resourceSourceSchema.parse({
       provider: "discord",
@@ -291,44 +307,43 @@ function automatic(input) {
   if (!input) {
     return { kind: "automatic" };
   }
-  if ("tracker" in input) {
-    const { tracker, beneficiary = "author", on, where } = input;
-    const { source } = tracker;
-    if (source.kind === "x-search" && !xAccountRoles.includes(beneficiary)) {
-      throw new Error(
-        `X trackers pay "author" or "inReplyTo", not "${beneficiary}"`
-      );
-    }
-    if (!sourceIdentities(source)) {
-      throw new Error(
-        'Tracker triggers need attributable records: declare customSource(namespace, { identities: ["wallet"] }) or other identity kinds'
-      );
-    }
-    if (source.kind === "custom" && beneficiary !== "author" && !source.accounts?.includes(beneficiary)) {
-      throw new Error(
-        `Tracker "${tracker.key}" has no "${beneficiary}" account: declare it in customSource(namespace, { accounts: ["${beneficiary}"] })`
-      );
-    }
-    const policy = trackerTriggerPolicySchema.parse({
-      tracker: tracker.key,
-      source: source.kind,
-      // The source's default mode is left out, so default quests keep the policy shape
-      // earlier SDKs and servers read.
-      ...on && on !== defaultTriggerMode(source.kind) ? { on } : {},
-      ...where ? { where } : {},
-      beneficiary
-    });
-    const issue = source.kind === "custom" && source.data ? whereSchemaIssue(source.data, policy.where) : null;
-    if (issue) {
-      throw new Error(issue);
-    }
-    const trigger = { kind: "automatic", tracker: policy };
-    if (source.kind === "custom" && source.data) {
-      triggerDataSchemas.set(trigger, source.data);
-    }
-    return trigger;
+  const { tracker, beneficiary = "author", on, where } = input;
+  if (!tracker?.source) {
+    throw new Error(
+      "automatic() takes no argument, or { tracker } with a tracker handle from defineTracker"
+    );
+  }
+  const { source } = tracker;
+  if (!sourceIdentities(source)) {
+    throw new Error(
+      'Tracker triggers need attributable records: declare customSource(namespace, { identities: ["wallet"] }) or other identity kinds'
+    );
+  }
+  const roles = sourceRoles(source);
+  if (!roles.includes(beneficiary)) {
+    throw new Error(
+      source.kind === "custom" ? `Tracker "${tracker.key}" has no "${beneficiary}" account: declare it in customSource(namespace, { accounts: ["${beneficiary}"] })` : `Tracker "${tracker.key}" pays ${roles.map((role) => `"${role}"`).join(" or ")}, not "${beneficiary}"`
+    );
+  }
+  const policy = trackerTriggerPolicySchema.parse({
+    tracker: tracker.key,
+    source: source.kind,
+    // The source's default mode is left out, so default quests keep the policy shape
+    // earlier SDKs and servers read.
+    ...on && on !== defaultTriggerMode(source.kind) ? { on } : {},
+    ...where ? { where } : {},
+    beneficiary
+  });
+  const schema = sourceDataSchema(source);
+  const issue = schema ? whereSchemaIssue(schema, policy.where) : null;
+  if (issue) {
+    throw new Error(issue);
+  }
+  const trigger = { kind: "automatic", tracker: policy };
+  if (schema) {
+    triggerDataSchemas.set(trigger, schema);
   }
-  return { kind: "automatic", observation: input };
+  return trigger;
 }
 var budget = (definition) => budgetSchema.parse(definition);
 var keyed = (key) => ({
@@ -406,15 +421,15 @@ function defineQuest(definition) {
       "Content triggers require perContent completion, and perContent requires a content trigger"
     );
   }
-  const bareAutomatic = definition.trigger.kind === "automatic" && !definition.trigger.observation && !definition.trigger.content && !definition.trigger.tracker;
+  const bareAutomatic = definition.trigger.kind === "automatic" && !definition.trigger.content && !definition.trigger.tracker;
   if (bareAutomatic && !definition.requires?.length) {
     throw new Error(
-      "A bare automatic() quest needs at least one requires entry, such as requires: [completed(quest)]. Give it an observation, content or tracker trigger, or a prerequisite."
+      "A bare automatic() quest needs at least one requires entry, such as requires: [completed(quest)]. Give it a content or tracker trigger, or a prerequisite."
     );
   }
   if (bareAutomatic && definition.completion.kind !== "once") {
     throw new Error(
-      `A bare automatic() quest cannot use ${definition.completion.kind}() completion. Give it a tracker or observation trigger, or use once().`
+      `A bare automatic() quest cannot use ${definition.completion.kind}() completion. Give it a tracker trigger, or use once().`
     );
   }
   if (definition.trigger.kind === "manual" && definition.trigger.input !== "none" && !definition.evaluate) {
@@ -543,7 +558,6 @@ function defineQuest(definition) {
         member: ctx.member,
         input: ctx.input,
         content: contentTrigger ? admittedContentSchema.parse(ctx.content) : null,
-        observation: ctx.observation ?? null,
         tracker,
         eligibleAt: ctx.eligibleAt,
         now: ctx.now,
@@ -571,7 +585,6 @@ function defineQuest(definition) {
           ...definition.completion.kind === "keyed" ? {
             completionKey: definition.completion.key({
               ...ctx,
-              observation: ctx.observation ?? null,
               tracker: pinned
             })
           } : {}