@domino-sdk/relay 1.11.1 → 1.14.0

package/README.md

@@ -17,6 +17,7 @@ pnpm add @domino-sdk/relay
 | `@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                            |
+| `@domino-sdk/relay/testing`      | Unit-testing quests locally (`runQuest`); for test files only                             |
 
 `@domino-sdk/relay/internal` is shared by Relay's own services and Console. It is not a supported API and can change in any release.
 

package/build.mjs

@@ -17,6 +17,20 @@ async function esbuild() {
   }
 }
 
+/** The quest testing kit stays in tests: a quest bundle that imports it fails to build. */
+const testsOnly = {
+  name: "domino:tests-only",
+  setup(build) {
+    build.onResolve({ filter: /^@domino-sdk\/relay\/testing$/ }, (args) => ({
+      errors: [
+        {
+          text: `Quest code cannot import @domino-sdk/relay/testing (imported by ${args.importer}). The testing kit runs quests in tests; import it from a test file instead.`,
+        },
+      ],
+    }))
+  },
+}
+
 /** Bundle an authored quest without evaluating developer code in the build process. */
 export async function buildQuest(entry, options = {}) {
   if (
@@ -45,6 +59,7 @@ export async function buildQuest(entry, options = {}) {
     platform: "neutral",
     target: "es2022",
     minify: true,
+    plugins: [testsOnly],
   })
   const file = result.outputFiles[0]
 

package/dist/accounts-5ciAkCMP.d.ts

@@ -0,0 +1,147 @@
+import { z } from 'zod';
+
+/** A Discord message as `ctx.discord.message()` reads it, from the project's Discord server. */
+declare const discordMessageSchema: z.ZodObject<{
+    guildId: z.ZodString;
+    channelId: z.ZodString;
+    messageId: z.ZodString;
+    userId: z.ZodString;
+    content: z.ZodNullable<z.ZodString>;
+    replyTo: z.ZodNullable<z.ZodString>;
+    publishedAt: z.ZodNumber;
+}, z.core.$strict>;
+type DiscordMessage = z.infer<typeof discordMessageSchema>;
+/**
+ * Messages posted in the project's Discord server, written by the Discord gateway. The record's
+ * `author` is the message author's Discord account. Message text is stored only with `text: true`.
+ * Edits update stored text. Deleting a message, or turning text off, removes retained text.
+ */
+declare const discordMessagesSourceSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"discord-messages">;
+    /** Store each message's text in `data.text`. Off unless set. */
+    text: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/**
+ * Reactions added in the project's Discord server, written by the Discord gateway. The record's
+ * `author` is the reactor's Discord account and its `messageAuthor` account is the message's
+ * author, when Discord could name it.
+ */
+declare const discordReactionsSourceSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"discord-reactions">;
+}, z.core.$strict>;
+/** The `data` of a `discord.messages()` record. IDs are Discord snowflakes. */
+declare const discordMessageDataSchema: z.ZodObject<{
+    guildId: z.ZodString;
+    channelId: z.ZodString;
+    messageId: z.ZodString;
+    replyTo: z.ZodNullable<z.ZodString>;
+    publishedAt: z.ZodNumber;
+}, z.core.$strip>;
+type DiscordMessageData = z.infer<typeof discordMessageDataSchema>;
+/**
+ * The `data` of a `discord.messages({ text: true })` record. `text` is null when the platform's
+ * bot does not receive message content.
+ */
+declare const discordMessageTextDataSchema: z.ZodObject<{
+    guildId: z.ZodString;
+    channelId: z.ZodString;
+    messageId: z.ZodString;
+    replyTo: z.ZodNullable<z.ZodString>;
+    publishedAt: z.ZodNumber;
+    text: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+type DiscordMessageTextData = z.infer<typeof discordMessageTextDataSchema>;
+/** The `data` of a `discord.reactions()` record. IDs are Discord snowflakes. */
+declare const discordReactionDataSchema: z.ZodObject<{
+    guildId: z.ZodString;
+    channelId: z.ZodString;
+    messageId: z.ZodString;
+    emoji: z.ZodObject<{
+        id: z.ZodNullable<z.ZodString>;
+        name: z.ZodString;
+    }, z.core.$strip>;
+    reactorRoles: z.ZodArray<z.ZodString>;
+    messagePublishedAt: z.ZodNumber;
+}, z.core.$strip>;
+type DiscordReactionData = z.infer<typeof discordReactionDataSchema>;
+/** Rewards and resource selectors supported by the Discord integration. */
+declare const discordRewardSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"integration">;
+    provider: z.ZodLiteral<"discord">;
+    action: z.ZodLiteral<"grant-role">;
+    roleId: z.ZodString;
+}, z.core.$strict>;
+declare const discordResourceSourceSchema: z.ZodUnion<readonly [z.ZodObject<{
+    provider: z.ZodLiteral<"discord">;
+    resource: z.ZodLiteral<"channel">;
+    types: z.ZodArray<z.ZodEnum<{
+        text: "text";
+        announcement: "announcement";
+    }>>;
+}, z.core.$strict>, z.ZodObject<{
+    provider: z.ZodLiteral<"discord">;
+    resource: z.ZodLiteral<"role">;
+    assignable: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strict>]>;
+
+declare const authProviderSchema: z.ZodEnum<{
+    discord: "discord";
+    google: "google";
+    apple: "apple";
+    x: "x";
+}>;
+type AuthProvider = z.infer<typeof authProviderSchema>;
+declare const accountConnectionSchema: z.ZodObject<{
+    provider: z.ZodEnum<{
+        discord: "discord";
+        google: "google";
+        apple: "apple";
+        x: "x";
+    }>;
+    configured: z.ZodBoolean;
+    status: z.ZodEnum<{
+        disconnected: "disconnected";
+        connected: "connected";
+        reconnect: "reconnect";
+    }>;
+    subject: z.ZodNullable<z.ZodString>;
+    revision: z.ZodNumber;
+}, z.core.$strip>;
+type AccountConnection = z.infer<typeof accountConnectionSchema>;
+declare const discordMemberInputSchema: z.ZodObject<{}, z.core.$strict>;
+declare const discordMessageInputSchema: z.ZodObject<{
+    channelId: z.ZodString;
+    messageId: z.ZodString;
+}, z.core.$strict>;
+declare const discordMemberSchema: z.ZodObject<{
+    userId: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    nickname: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    displayName: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    boostingSince: z.ZodDefault<z.ZodNullable<z.ZodString>>;
+    roles: z.ZodArray<z.ZodString>;
+    joinedAt: z.ZodNullable<z.ZodString>;
+    pending: z.ZodBoolean;
+}, z.core.$strip>;
+type DiscordMember = z.infer<typeof discordMemberSchema>;
+/**
+ * Reads the project's connected Discord server for the member's linked Discord account. The
+ * account and the integration are pinned at the attempt's first Discord read: later links and
+ * unlinks do not change the attempt. Provider failures, and an integration that is not ready,
+ * throw `CapabilityError` with code `"provider-unavailable"`.
+ */
+interface DiscordReader {
+    /** The member's server membership; null when they are not in the server or have not linked Discord. */
+    member(): Promise<DiscordMember | null>;
+    /**
+     * A message in the connected server; null when it does not exist. The bot reads it, so the
+     * member needs no linked Discord account. A channel outside the connected server, or one the
+     * bot cannot see, throws
+     * `CapabilityError` with code `"author-error"`.
+     */
+    message(input: {
+        channelId: string;
+        messageId: string;
+    }): Promise<DiscordMessage | null>;
+}
+
+export { type AccountConnection as A, type DiscordMessageData as D, type AuthProvider as a, type DiscordMessageTextData as b, discordReactionsSourceSchema as c, discordMessagesSourceSchema as d, type DiscordReactionData as e, type DiscordReader as f, type DiscordMember as g, type DiscordMessage as h, accountConnectionSchema as i, authProviderSchema as j, discordMemberInputSchema as k, discordMemberSchema as l, discordMessageDataSchema as m, discordMessageInputSchema as n, discordMessageSchema as o, discordMessageTextDataSchema as p, discordReactionDataSchema as q, discordResourceSourceSchema as r, discordRewardSchema as s };