@went.tf/discord-bot-framework 2.0.0 → 2.2.0

package/build/commands/schema/index.js

@@ -7,6 +7,7 @@ import { applicationCommandTypeSchema } from './application-command-type.schema.
 import { applicationIntegrationTypeSchema } from './application-integration-type.schema.js';
 import { channelTypeSchema } from './channel-type.schema.js';
 import { chatInputCommandSchema } from './chat-input-command.schema.js';
+import { commandFileEntrySchema } from './command-file-entry.schema.js';
 import { commandsFileSchema } from './commands-file.schema.js';
 import { contextMenuCommandSchema } from './context-menu-command.schema.js';
 import { contextMenuNameSchema } from './context-menu-name.schema.js';
@@ -14,7 +15,8 @@ import { defaultMemberPermissionsSchema } from './default-member-permissions.sch
 import { interactionContextTypeSchema } from './interaction-context-type.schema.js';
 import { optionNameSchema } from './option-name.schema.js';
 export { parseCommandsFile } from './parse-commands-file.js';
-export { applicationCommandTypeSchema, interactionContextTypeSchema, applicationIntegrationTypeSchema, channelTypeSchema, optionNameSchema, contextMenuNameSchema, applicationCommandOptionChoiceSchema, defaultMemberPermissionsSchema, applicationCommandLeafOptionSchema, applicationCommandSubcommandSchema, applicationCommandSubcommandGroupSchema, applicationCommandOptionSchema, chatInputCommandSchema, contextMenuCommandSchema, commandsFileSchema, };
+export { APPLICATION_COMMAND_TYPE_MAP, APPLICATION_COMMAND_OPTION_TYPE_MAP, INTERACTION_CONTEXT_TYPE_MAP, APPLICATION_INTEGRATION_TYPE_MAP, CHANNEL_TYPE_MAP, resolveEnumValue, } from './enum-maps.js';
+export { applicationCommandTypeSchema, interactionContextTypeSchema, applicationIntegrationTypeSchema, channelTypeSchema, optionNameSchema, contextMenuNameSchema, applicationCommandOptionChoiceSchema, defaultMemberPermissionsSchema, applicationCommandLeafOptionSchema, applicationCommandSubcommandSchema, applicationCommandSubcommandGroupSchema, applicationCommandOptionSchema, chatInputCommandSchema, contextMenuCommandSchema, commandFileEntrySchema, commandsFileSchema, };
 /** Every fragment this package ships, in an order safe to `ajv.addSchema()` sequentially. */
 const frameworkSchemas = [
     applicationCommandTypeSchema,
@@ -31,12 +33,76 @@ const frameworkSchemas = [
     applicationCommandOptionSchema,
     chatInputCommandSchema,
     contextMenuCommandSchema,
+    commandFileEntrySchema,
     commandsFileSchema,
 ];
+const fragmentIdByFileName = new Map(frameworkSchemas.map((s) => [s.$id.split('/').pop(), s.$id]));
+/**
+ * Rewrites a bot's own composed commands.schema.json, replacing any `$ref`
+ * that points at one of this package's fragments by a relative filesystem
+ * path (e.g. `"../node_modules/@went.tf/discord-bot-framework/build/commands/schema/chat-input-command.json"` -
+ * the form an editor can resolve for autocomplete) with that fragment's
+ * canonical `$id` (the form `registerFrameworkSchemas` registers, which ajv
+ * can actually resolve). Matched by filename alone, so it works regardless
+ * of how deep your own commands.schema.json sits relative to `node_modules`
+ * - you never need to get the exact `../` count "right" for ajv's sake, only
+ * for the editor's. `$ref`s that don't match a known fragment filename (e.g.
+ * your own `#/$defs/...` refs) are left untouched.
+ *
+ * Call this on the raw parsed schema before `ajv.compile()`, after
+ * `registerFrameworkSchemas(ajv)`:
+ *
+ * ```ts
+ * import myCommandsSchemaRaw from './commands.schema.json' with { type: 'json' };
+ * const myCommandsSchema = resolveCommandsSchemaRefs(myCommandsSchemaRaw);
+ * registerFrameworkSchemas(ajv);
+ * const validate = ajv.compile(myCommandsSchema);
+ * ```
+ */
+export function resolveCommandsSchemaRefs(schema) {
+    return rewriteRefs(schema);
+}
+function rewriteRefs(node) {
+    if (Array.isArray(node)) {
+        return node.map(rewriteRefs);
+    }
+    if (node !== null && typeof node === 'object') {
+        const result = {};
+        for (const [key, value] of Object.entries(node)) {
+            if (key === '$ref' && typeof value === 'string') {
+                const fileName = value.split('/').pop();
+                result[key] = fragmentIdByFileName.get(fileName) ?? value;
+            }
+            else {
+                result[key] = rewriteRefs(value);
+            }
+        }
+        return result;
+    }
+    return node;
+}
 /**
  * Registers every generic fragment this package ships onto a bot's own ajv
- * instance, so the bot's own composed commands.schema.json can `$ref` them
- * by `$id`. Call this before `ajv.compile()`-ing the bot's own schema.
+ * instance under its canonical `$id`, so the framework's own fragments can
+ * `$ref` each other. Call this before `ajv.compile()`-ing the bot's own
+ * schema, after passing that schema through `resolveCommandsSchemaRefs()`.
+ *
+ * A fragment's `$id` (e.g. `https://schema.went.tf/discord-bot-framework/chat-input-command.json`)
+ * is an opaque, never-fetched identifier - not a real filesystem location -
+ * so it's not something an editor (VS Code, JetBrains, ...) can resolve for
+ * autocomplete while you hand-edit commands.schema.json, and not something
+ * this package tries to make ajv resolve via real filesystem/URI math either
+ * (an earlier version of this function tried registering fragments under
+ * their real `file://` location for that purpose; confirmed broken for every
+ * pnpm install, not just local dev, because pnpm always symlinks packages
+ * from its `.pnpm` virtual store into `node_modules`, and Node's ESM loader
+ * resolves `import.meta.url` through that symlink to the real store path -
+ * a path a bot's own relative `$ref` can never independently compute).
+ * `resolveCommandsSchemaRefs()` is the actual fix: it rewrites a bot's own
+ * relative-path `$ref`s to the matching fragment's canonical `$id` by
+ * filename, sidestepping filesystem resolution for ajv entirely while
+ * leaving the human-facing JSON file itself untouched (still relative paths,
+ * for the editor).
  */
 export function registerFrameworkSchemas(ajv) {
     for (const schema of frameworkSchemas) {
@@ -45,4 +111,11 @@ export function registerFrameworkSchemas(ajv) {
         }
     }
 }
+/** Normalizes either `CommandsFile` root shape down to the flat entries array. */
+export function getCommandsFileEntries(commandsFile) {
+    if (Array.isArray(commandsFile)) {
+        return commandsFile;
+    }
+    return commandsFile.commands;
+}
 //# sourceMappingURL=index.js.map

package/build/commands/schema/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/schema/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kCAAkC,EAAE,MAAM,6CAA6C,CAAC;AACjG,OAAO,EAAE,oCAAoC,EAAE,MAAM,+CAA+C,CAAC;AACrG,OAAO,EAAE,8BAA8B,EAAE,MAAM,wCAAwC,CAAC;AACxF,OAAO,EAAE,uCAAuC,EAAE,MAAM,kDAAkD,CAAC;AAC3G,OAAO,EAAE,kCAAkC,EAAE,MAAM,4CAA4C,CAAC;AAChG,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAC5F,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAE,8BAA8B,EAAE,MAAM,wCAAwC,CAAC;AACxF,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAG7D,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,gCAAgC,EAChC,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,oCAAoC,EACpC,8BAA8B,EAC9B,kCAAkC,EAClC,kCAAkC,EAClC,uCAAuC,EACvC,8BAA8B,EAC9B,sBAAsB,EACtB,wBAAwB,EACxB,kBAAkB,GACnB,CAAC;AAEF,6FAA6F;AAC7F,MAAM,gBAAgB,GAAG;IACvB,4BAA4B;IAC5B,4BAA4B;IAC5B,gCAAgC;IAChC,iBAAiB;IACjB,gBAAgB;IAChB,qBAAqB;IACrB,oCAAoC;IACpC,8BAA8B;IAC9B,kCAAkC;IAClC,kCAAkC;IAClC,uCAAuC;IACvC,8BAA8B;IAC9B,sBAAsB;IACtB,wBAAwB;IACxB,kBAAkB;CACV,CAAC;AAEX;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAAC,GAAQ;IAC/C,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;QACtC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;AACH,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/schema/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kCAAkC,EAAE,MAAM,6CAA6C,CAAC;AACjG,OAAO,EAAE,oCAAoC,EAAE,MAAM,+CAA+C,CAAC;AACrG,OAAO,EAAE,8BAA8B,EAAE,MAAM,wCAAwC,CAAC;AACxF,OAAO,EAAE,uCAAuC,EAAE,MAAM,kDAAkD,CAAC;AAC3G,OAAO,EAAE,kCAAkC,EAAE,MAAM,4CAA4C,CAAC;AAChG,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,EAAE,gCAAgC,EAAE,MAAM,0CAA0C,CAAC;AAC5F,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,qBAAqB,EAAE,MAAM,+BAA+B,CAAC;AACtE,OAAO,EAAE,8BAA8B,EAAE,MAAM,wCAAwC,CAAC;AACxF,OAAO,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAG7D,OAAO,EACL,4BAA4B,EAC5B,mCAAmC,EACnC,4BAA4B,EAC5B,gCAAgC,EAChC,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,gCAAgC,EAChC,iBAAiB,EACjB,gBAAgB,EAChB,qBAAqB,EACrB,oCAAoC,EACpC,8BAA8B,EAC9B,kCAAkC,EAClC,kCAAkC,EAClC,uCAAuC,EACvC,8BAA8B,EAC9B,sBAAsB,EACtB,wBAAwB,EACxB,sBAAsB,EACtB,kBAAkB,GACnB,CAAC;AAEF,6FAA6F;AAC7F,MAAM,gBAAgB,GAAG;IACvB,4BAA4B;IAC5B,4BAA4B;IAC5B,gCAAgC;IAChC,iBAAiB;IACjB,gBAAgB;IAChB,qBAAqB;IACrB,oCAAoC;IACpC,8BAA8B;IAC9B,kCAAkC;IAClC,kCAAkC;IAClC,uCAAuC;IACvC,8BAA8B;IAC9B,sBAAsB;IACtB,wBAAwB;IACxB,sBAAsB;IACtB,kBAAkB;CACV,CAAC;AAEX,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAY,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AAE7G;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,yBAAyB,CAAI,MAAS;IACpD,OAAO,WAAW,CAAC,MAAM,CAAM,CAAC;AAClC,CAAC;AAED,SAAS,WAAW,CAAC,IAAa;IAChC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAC/B,CAAC;IACD,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC9C,MAAM,MAAM,GAA4B,EAAE,CAAC;QAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,IAAI,GAAG,KAAK,MAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAChD,MAAM,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAY,CAAC;gBAClD,MAAM,CAAC,GAAG,CAAC,GAAG,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC;YAC5D,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,wBAAwB,CAAC,GAAQ;IAC/C,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;QACtC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC;YAC/B,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;AACH,CAAC;AA2ED,kFAAkF;AAClF,MAAM,UAAU,sBAAsB,CAAC,YAA0B;IAC/D,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;QAChC,OAAO,YAA2C,CAAC;IACrD,CAAC;IACD,OAAQ,YAA0D,CAAC,QAAQ,CAAC;AAC9E,CAAC"}

package/build/commands/schema/interaction-context-type.schema.d.ts

@@ -1,6 +1,6 @@
 export declare const interactionContextTypeSchema: {
     readonly $id: "https://schema.went.tf/discord-bot-framework/interaction-context-type.json";
-    readonly description: "InteractionContextType (discord-api-types): 0 Guild, 1 BotDM, 2 PrivateChannel.";
-    readonly enum: readonly [0, 1, 2];
+    readonly description: "InteractionContextType (discord-api-types): 0/GUILD, 1/BOT_DM, 2/PRIVATE_CHANNEL. Both the numeric value and its UPPER_SNAKE_CASE string alias (see enum-maps.ts) are always valid.";
+    readonly enum: readonly [0, 1, 2, "GUILD", "BOT_DM", "PRIVATE_CHANNEL"];
 };
 //# sourceMappingURL=interaction-context-type.schema.d.ts.map

package/build/commands/schema/interaction-context-type.schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interaction-context-type.schema.d.ts","sourceRoot":"","sources":["../../../src/commands/schema/interaction-context-type.schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,4BAA4B;;;;CAI/B,CAAC"}
+{"version":3,"file":"interaction-context-type.schema.d.ts","sourceRoot":"","sources":["../../../src/commands/schema/interaction-context-type.schema.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,4BAA4B;;;;CAK/B,CAAC"}

package/build/commands/schema/interaction-context-type.schema.js

@@ -1,6 +1,6 @@
 export const interactionContextTypeSchema = {
     $id: 'https://schema.went.tf/discord-bot-framework/interaction-context-type.json',
-    description: 'InteractionContextType (discord-api-types): 0 Guild, 1 BotDM, 2 PrivateChannel.',
-    enum: [0, 1, 2],
+    description: 'InteractionContextType (discord-api-types): 0/GUILD, 1/BOT_DM, 2/PRIVATE_CHANNEL. Both the numeric value and its UPPER_SNAKE_CASE string alias (see enum-maps.ts) are always valid.',
+    enum: [0, 1, 2, 'GUILD', 'BOT_DM', 'PRIVATE_CHANNEL'],
 };
 //# sourceMappingURL=interaction-context-type.schema.js.map

package/build/commands/schema/interaction-context-type.schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"interaction-context-type.schema.js","sourceRoot":"","sources":["../../../src/commands/schema/interaction-context-type.schema.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,GAAG,EAAE,4EAA4E;IACjF,WAAW,EAAE,iFAAiF;IAC9F,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;CACP,CAAC"}
+{"version":3,"file":"interaction-context-type.schema.js","sourceRoot":"","sources":["../../../src/commands/schema/interaction-context-type.schema.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,GAAG,EAAE,4EAA4E;IACjF,WAAW,EACT,qLAAqL;IACvL,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,iBAAiB,CAAC;CAC7C,CAAC"}

package/build/commands/schema/interaction-context-type.schema.json

@@ -1,9 +1,12 @@
 {
   "$id": "https://schema.went.tf/discord-bot-framework/interaction-context-type.json",
-  "description": "InteractionContextType (discord-api-types): 0 Guild, 1 BotDM, 2 PrivateChannel.",
+  "description": "InteractionContextType (discord-api-types): 0/GUILD, 1/BOT_DM, 2/PRIVATE_CHANNEL. Both the numeric value and its UPPER_SNAKE_CASE string alias (see enum-maps.ts) are always valid.",
   "enum": [
     0,
     1,
-    2
+    2,
+    "GUILD",
+    "BOT_DM",
+    "PRIVATE_CHANNEL"
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@went.tf/discord-bot-framework",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "description": "Shared framework for building Discord bots with discord.js: logging, env validation, interaction dispatch, API client, and optional Postgres/i18next helpers",
   "author": "WentTheFox <mail@went.tf> (https://github.com/WentTheFox)",
   "license": "MIT",