@domino-sdk/relay 1.0.0-next.8 → 1.0.0-next.9

package/dist/authoring.d.ts

@@ -1,10 +1,11 @@
 import { z } from 'zod';
-import { C as ContentPolicy, g as ContentMetric, E as EngagementDefinition, l as leaderboardAuthoringSchema, r as referralAuthoringSchema, h as AdmittedContent, D as DiscordMember, T as TextEvidence, U as UrlEvidence, e as TextOptions, f as UrlOptions } from './submission-input-C9qm9ixd.js';
+export { z } from 'zod';
+import { C as ContentPolicy, g as ContentMetric, E as EngagementDefinition, l as leaderboardAuthoringSchema, r as referralAuthoringSchema, h as AdmittedContent, D as DiscordMember, T as TextEvidence, U as UrlEvidence, e as TextOptions, f as UrlOptions } from './submission-input-0OOGaq8c.js';
 import { Q as QuizContent, a as StreakPolicy } from './streaks-CwGReWGt.js';
-import { T as TrackerDefinition, I as IdentityKind, t as trackerDefinitionSchema, R as ResourceSource, O as Observation, a as TrackerTriggerContext, b as TrackerReader, X as XReader, D as DiscordMessage, c as TrackerTriggerMode, d as TrackerWhere, o as observationTriggerSchema, e as TrackerTriggerPolicy, B as Budget, f as IntegrationProvider } from './integrations-C3Sp558f.js';
-export { g as trackerTriggerContextSchema } from './integrations-C3Sp558f.js';
-import { I as ImageReader } from './images--vZ9U0kr.js';
-import { d as TextReviewInput, e as TextResult, P as PhotoResult, r as rewardSchema, t as triggerSchema, Q as QuestPresentation, a as QuestProfile, b as QuizEvidence, D as Decision, f as TieredRewardDefinition } from './schema-pnuWqvGn.js';
+import { R as ResourceSource, S as Setting, O as Observation, X as XReader, D as DiscordMessage, o as observationTriggerSchema, B as Budget, I as IntegerSettings, a as IntegrationProvider } from './integrations-Ba5TtqTv.js';
+import { T as TrackerDefinition, I as IdentityKind, c as customSourceSchema, W as WithRecordData, a as TrackerSource, t as trackerDefinitionSchema, b as Tracker, d as TrackerData, x as xSearchSourceSchema, X as XTweet, e as TrackerTriggerContext, f as TrackerTriggerPolicy, g as TrackerReader, h as ImageReader, i as Where, j as TrackerTriggerMode, k as WhereSetting } from './images-BTgk6OmC.js';
+export { l as TrackerDataSchema, m as TrackerPage, n as trackerDataSchema, o as trackerTriggerContextSchema } from './images-BTgk6OmC.js';
+import { d as TextReviewInput, e as TextResult, P as PhotoResult, r as rewardSchema, t as triggerSchema, Q as QuestPresentation, a as QuestProfile, b as QuizEvidence, D as Decision, f as TieredRewardDefinition } from './schema-Di3aLSiK.js';
 import { h as WalletConnection, S as SolanaBalance, L as LinkedWallet, i as WalletBalanceQuery, j as WalletBalance } from './wallet-BGOfFkG9.js';
 export { E as EvmChainId, k as isEvmChainId } from './wallet-BGOfFkG9.js';
 export { f as formatUnits, p as parseUnits } from './units-CwgsPB_r.js';
@@ -27,9 +28,9 @@ declare function content(tracker: TrackerDefinition, policy?: Partial<Pick<Conte
             start: number;
             end?: number | undefined;
         };
-        enrollment: "none" | "required";
+        enrollment: "required" | "none";
         posts: "after-enrollment" | "since-start";
-        historical: "automatic" | "claim" | "staff";
+        historical: "staff" | "automatic" | "claim";
     };
 };
 declare function perContent(): {
@@ -179,8 +180,8 @@ declare function defineReferral(input: Omit<z.input<typeof referralAuthoringSche
 };
 declare function defineLeaderboard(input: Omit<z.input<typeof leaderboardAuthoringSchema>, "key" | "id"> & AuthoringIdentity): {
     id: string;
-    title: string;
     balance: string;
+    title: string;
     group?: string | undefined;
     score: {
         kind: "balance";
@@ -222,30 +223,28 @@ declare function defineLeaderboard(input: Omit<z.input<typeof leaderboardAuthori
     key: string;
 };
 declare const x: {
+    /** Posts matching an X search. Each record's `data` is the provider's post payload. */
     search: (input: {
         query: string;
-    }) => {
-        kind: "x-search";
-        query: string;
-    };
+    }) => z.output<typeof xSearchSourceSchema> & WithRecordData<XTweet>;
 };
 /**
- * Records your own code sends with `trackers.ingest`. With `identities`, each record's author, and
- * each named account in `accounts`, is a verified identity of one of those kinds, which Relay
- * attributes to the member who verified it, so quests can trigger from the tracker. A record states
- * each account's `kind` unless the source names exactly one.
+ * Records your own code sends with `trackers.ingest`. `data` is a zod object schema that every
+ * record's `data` must match: Relay stores its JSON Schema form with the tracker and rejects
+ * records that do not match it, and quests read each record's data with its type. With
+ * `identities`, each record's author, and each named account in `accounts`, is a verified identity
+ * of one of those kinds, which Relay attributes to the member who verified it, so quests can
+ * trigger from the tracker. A record states each account's `kind` unless the source names exactly
+ * one.
  */
-declare const customSource: (namespace: string, options?: {
+declare function customSource<S extends z.ZodObject>(namespace: string, options: {
     identities?: IdentityKind[];
     accounts?: string[];
-}) => {
-    kind: "custom";
-    namespace: string;
-    identities?: ("x" | "discord" | "member" | "wallet")[] | undefined;
-    accounts?: string[] | undefined;
-    authors?: "wallet" | undefined;
-};
-declare function defineTracker(input: z.input<typeof trackerDefinitionSchema>): TrackerDefinition;
+    data: S;
+}): z.output<typeof customSourceSchema> & WithRecordData<z.input<S>>;
+declare function defineTracker<S extends TrackerSource>(input: Omit<z.input<typeof trackerDefinitionSchema>, "source"> & {
+    source: S;
+}): Tracker<TrackerData<S>>;
 type ChannelTypes = Extract<ResourceSource, {
     resource: "channel";
 }>["types"];
@@ -265,17 +264,17 @@ type Label = {
 declare const settings: {
     pointLedger(options: Label & {
         default: string;
-    }): z.ZodDefault<z.ZodString>;
+    }): Setting<"point-ledger", z.ZodDefault<z.ZodString>>;
     datetime(options: Label & {
         default: string;
-    }): z.ZodDefault<z.ZodPipe<z.ZodISODateTime, z.ZodTransform<string, string>>>;
+    }): Setting<"datetime", z.ZodDefault<z.ZodPipe<z.ZodISODateTime, z.ZodTransform<string, string>>>>;
     resource(options: Label & {
         source: ResourceSource;
         default?: string;
-    }): z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodString]>>;
+    }): Setting<"resource", z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"">, z.ZodString]>>>;
     quiz(options: Label & {
         default: QuizContent;
-    }): z.ZodDefault<z.ZodArray<z.ZodObject<{
+    }): Setting<"quiz", z.ZodDefault<z.ZodArray<z.ZodObject<{
         id: z.ZodString;
         prompt: z.ZodString;
         choices: z.ZodArray<z.ZodObject<{
@@ -283,26 +282,27 @@ declare const settings: {
             label: z.ZodString;
         }, z.core.$strict>>;
         correct: z.ZodString;
-    }, z.core.$strict>>>;
+    }, z.core.$strict>>>>;
     text(options: Label & {
         default: string;
         minLength?: number;
         maxLength?: number;
         multiline?: boolean;
-    }): z.ZodDefault<z.ZodString>;
+    }): Setting<"text", z.ZodDefault<z.ZodString>>;
     integer(options: Label & {
         default: number;
         min: number;
         max: number;
-    }): z.ZodDefault<z.ZodNumber>;
+    }): Setting<"integer", z.ZodDefault<z.ZodNumber>>;
     boolean(options: Label & {
         default: boolean;
-    }): z.ZodDefault<z.ZodBoolean>;
+    }): Setting<"boolean", z.ZodDefault<z.ZodBoolean>>;
     choice<const T extends readonly [string, ...string[]]>(options: Label & {
         options: T;
         default: T[number];
-    }): z.ZodDefault<z.ZodEnum<{ [k_1 in T[number]]: k_1; } extends infer T_1 ? { [k in keyof T_1]: T_1[k]; } : never>>;
-    object<T extends Record<string, z.ZodType>>(shape: T): z.ZodObject<{ -readonly [P in keyof T]: T[P]; }, z.core.$strict>;
+    }): Setting<"choice", z.ZodDefault<z.ZodEnum<{ [k_1 in T[number]]: k_1; } extends infer T_1 ? { [k in keyof T_1]: T_1[k]; } : never>>>;
+    /** A quest's settings: every field is built with one of the builders above. */
+    object<T extends Record<string, Setting>>(shape: T): z.ZodObject<{ -readonly [P in keyof T]: T[P]; }, z.core.$strict>;
 };
 
 type Reward = z.infer<typeof rewardSchema>;
@@ -361,8 +361,9 @@ declare function manual(options: {
     actor: "staff";
 };
 /** A tracker trigger: which observations of which tracker run the quest, and for whom. */
-type TrackerTriggerInput = {
-    tracker: TrackerDefinition;
+type TrackerTriggerInput<T extends Tracker = Tracker, W extends Where<TrackerData<T>> | undefined = Where<TrackerData<T>> | undefined> = {
+    /** The tracker handle `defineTracker` returns. */
+    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
@@ -372,9 +373,11 @@ type TrackerTriggerInput = {
     on?: TrackerTriggerMode;
     /**
      * Admit only observations whose `data` matches, such as `{ path: "amount", gte: 1000 }` or
-     * `{ path: "amount", gte: { setting: "threshold" } }`. Others record no outcome.
+     * `{ path: "amount", gte: { setting: "threshold" } }`, or a list of at most 10 such conditions
+     * that must all hold. Paths and values are checked against the tracker's data type, and a
+     * `setting` must name one of the quest's integer settings. Others record no outcome.
      */
-    where?: TrackerWhere;
+    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
@@ -382,6 +385,24 @@ type TrackerTriggerInput = {
      */
     beneficiary?: string;
 };
+/** Type-only markers a tracker trigger carries into `defineQuest`. They never exist at runtime. */
+declare const triggerData: unique symbol;
+declare const triggerSettings: unique symbol;
+/**
+ * A tracker trigger whose records carry `data` of type `D` and whose filter compares with the
+ * settings `S`. `defineQuest` types `ctx.tracker` from `D` and checks `S` against its integer
+ * settings.
+ */
+type TrackerTrigger<D = unknown, S extends string = never> = {
+    kind: "automatic";
+    tracker: TrackerTriggerPolicy;
+    readonly [triggerData]?: D;
+    readonly [triggerSettings]?: S;
+};
+type TriggerData<G> = G extends TrackerTrigger<infer D, string> ? unknown extends D ? unknown : D : unknown;
+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
@@ -394,44 +415,46 @@ declare function automatic(observation: z.infer<typeof observationTriggerSchema>
     kind: "automatic";
     observation: z.infer<typeof observationTriggerSchema>;
 };
-declare function automatic(input: TrackerTriggerInput): {
-    kind: "automatic";
-    tracker: TrackerTriggerPolicy;
+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,
+ * and `Present | null` when `G` is not known.
+ */
+type Supplied<G, K extends string, Present, Base> = unknown extends G ? Base | null : G extends unknown ? K extends keyof G ? [G[K]] extends [object] ? Present : Base | null : null : never;
+/** `ctx.tracker` for a trigger: non-null and typed for a tracker trigger, null for others. */
+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.
+ */
+type KeyedContext = {
+    member: {
+        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;
+    /** The attempt's evaluation time; see {@link EvaluationContext.now}. */
+    now: number;
 };
 declare const budget: (definition: Budget) => {
     id: string;
     scope: "member" | "project";
-    period: "day" | "lifetime" | "week";
+    period: "lifetime" | "day" | "week";
     limit: number;
     cost: number | {
         balance: string;
     };
 };
-declare const keyed: (key: (ctx: {
-    member: {
-        id: string;
-    };
-    content?: AdmittedContent | null;
-    observation: Observation | null;
-    /** The pinned tracker observation of a tracker-triggered quest. */
-    tracker?: TrackerTriggerContext | null;
-    eligibleAt: number;
-    /** The attempt's evaluation time; see {@link EvaluationContext.now}. */
-    now: number;
-}) => string) => {
+declare const keyed: (key: (ctx: KeyedContext) => string) => {
     kind: "keyed";
-    key: (ctx: {
-        member: {
-            id: string;
-        };
-        content?: AdmittedContent | null;
-        observation: Observation | null;
-        /** The pinned tracker observation of a tracker-triggered quest. */
-        tracker?: TrackerTriggerContext | null;
-        eligibleAt: number;
-        /** The attempt's evaluation time; see {@link EvaluationContext.now}. */
-        now: number;
-    }) => string;
+    key: (ctx: KeyedContext) => string;
 };
 declare const completed: (quest: AuthoringIdentity | string) => {
     quest: string;
@@ -521,21 +544,28 @@ 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
+ * leaves them nullable and lets a shared evaluator, such as `evaluators.photo()`, fit every quest.
+ */
 type EvaluationContext<T, I = {
     photo: string;
-}> = {
+}, G = any> = {
     settings: T;
     member: {
         id: string;
     };
     input: I;
-    content: AdmittedContent | null;
-    observation: Observation | null;
+    /** 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. Null unless the quest has a tracker trigger.
+     * was attributed to. Present for a tracker trigger, with `record.data` of the tracker's type.
      */
-    tracker: TrackerTriggerContext | null;
+    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.
@@ -582,7 +612,7 @@ type EvaluationContext<T, I = {
 };
 type Evaluator<T, I = {
     photo: string;
-}> = (ctx: EvaluationContext<T, I>) => Promise<Outcome>;
+}, G = any> = (ctx: EvaluationContext<T, I, G>) => Promise<Outcome>;
 declare const evaluators: {
     quiz(answerKey: QuizEvidence["answers"], options?: {
         minimumCorrect?: number;
@@ -606,7 +636,16 @@ type QuestInput<T extends Trigger> = T extends {
 } ? TextEvidence : T extends {
     input: "url";
 } ? UrlEvidence : Record<string, never>;
-declare function defineQuest<T extends Record<string, z.ZodType>, const G extends Trigger, const M extends readonly [ContentMetric, ...ContentMetric[]] = readonly [
+/**
+ * Rejects a trigger whose filter compares with settings that are not integer settings of the
+ * quest, naming them.
+ */
+type IntegerSettingBounds<G, T> = [
+    Exclude<TriggerSettings<G>, IntegerSettings<T>>
+] extends [never] ? unknown : {
+    readonly "The tracker filter compares with settings that are not integer settings of this quest": Exclude<TriggerSettings<G>, IntegerSettings<T>>;
+};
+declare function defineQuest<T extends Record<string, Setting>, const G extends Trigger, const M extends readonly [ContentMetric, ...ContentMetric[]] = readonly [
     ContentMetric,
     ...ContentMetric[]
 ]>(definition: AuthoringIdentity & {
@@ -617,7 +656,7 @@ declare function defineQuest<T extends Record<string, z.ZodType>, const G extend
     presentation?: (ctx: {
         settings: z.output<z.ZodObject<T>>;
     }) => QuestPresentation;
-    trigger: G;
+    trigger: G & NoInfer<IntegerSettingBounds<G, T>>;
     integrations?: IntegrationProvider[];
     requires?: ReturnType<typeof completed>[];
     completion: ReturnType<typeof once> | ReturnType<typeof keyed> | StreakPolicy;
@@ -642,7 +681,7 @@ declare function defineQuest<T extends Record<string, z.ZodType>, const G extend
     rewards: Reward[] | ((ctx: {
         settings: z.output<z.ZodObject<T>>;
     }) => Reward[]);
-    evaluate?: Evaluator<z.output<z.ZodObject<T>>, QuestInput<G>>;
+    evaluate?: Evaluator<z.output<z.ZodObject<T>>, QuestInput<G>, NoInfer<G>>;
     performance?: G extends {
         content: unknown;
     } ? {
@@ -701,12 +740,12 @@ declare function defineQuest<T extends Record<string, z.ZodType>, const G extend
             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";
@@ -803,9 +842,9 @@ declare function defineQuest<T extends Record<string, z.ZodType>, const G extend
                     start: number;
                     end?: number | undefined;
                 };
-                enrollment: "none" | "required";
+                enrollment: "required" | "none";
                 posts: "after-enrollment" | "since-start";
-                historical: "automatic" | "claim" | "staff";
+                historical: "staff" | "automatic" | "claim";
             } | undefined;
             tracker?: {
                 tracker: string;
@@ -829,7 +868,24 @@ declare function defineQuest<T extends Record<string, z.ZodType>, const G extend
                 } | {
                     path: string;
                     equals: string | number | boolean;
-                } | undefined;
+                } | ({
+                    path: string;
+                    gt?: number | {
+                        setting: string;
+                    } | undefined;
+                    gte?: number | {
+                        setting: string;
+                    } | undefined;
+                    lt?: number | {
+                        setting: string;
+                    } | undefined;
+                    lte?: number | {
+                        setting: string;
+                    } | undefined;
+                } | {
+                    path: string;
+                    equals: string | number | boolean;
+                })[] | undefined;
             } | undefined;
         } | {
             kind: "manual";
@@ -839,7 +895,7 @@ declare function defineQuest<T extends Record<string, z.ZodType>, const G extend
                 minLength: number;
                 maxLength: number;
             };
-            actor?: "member" | "staff" | undefined;
+            actor?: "staff" | "member" | undefined;
         } | {
             kind: "manual";
             input: "url";
@@ -847,11 +903,11 @@ declare function defineQuest<T extends Record<string, z.ZodType>, const G extend
                 required: boolean;
                 allowedHosts?: string[] | undefined;
             };
-            actor?: "member" | "staff" | undefined;
+            actor?: "staff" | "member" | undefined;
         } | {
             kind: "manual";
-            input: "none" | "quiz" | "photo";
-            actor?: "member" | "staff" | undefined;
+            input: "photo" | "quiz" | "none";
+            actor?: "staff" | "member" | undefined;
         };
         requires: {
             quest: string;
@@ -869,7 +925,7 @@ declare function defineQuest<T extends Record<string, z.ZodType>, const G extend
         budgets: {
             id: string;
             scope: "member" | "project";
-            period: "day" | "lifetime" | "week";
+            period: "lifetime" | "day" | "week";
             limit: number;
             cost: number | {
                 balance: string;
@@ -893,4 +949,4 @@ declare function defineQuest<T extends Record<string, z.ZodType>, const G extend
  * Console instances receive independent quest identities and pinned versions. */
 declare const defineQuestType: typeof defineQuest;
 
-export { type EvaluationContext, ImageReader, type PerformanceOutcome, TrackerReader, TrackerTriggerContext, type TrackerTriggerInput, WalletBalance, WalletBalanceQuery, 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 { 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 };