@wolfstar/plugin-gateway 0.15.0 → 0.16.0

package/README.md

@@ -1318,7 +1318,7 @@ export default defineConfig({
 });
 ```
 
-The module registers no plugin and takes no options: you still construct the `GatewayClient` yourself.
+The module registers no plugin and takes no options: you still construct the `GatewayClient` yourself. It owns the `gateway` key of `stars.config` (reserved for future options), so no other module can claim it.
 
 ## Credits
 

package/dist/esm/module.d.ts

@@ -1,9 +1,21 @@
 //#region src/module.d.ts
+/**
+ * The options of the module: none yet. The `gateway` key of `stars.config` is reserved for them.
+ */
+export type GatewayModuleOptions = Record<string, never>;
 /**
  * The Stars module: listing `@wolfstar/plugin-gateway/module` in `modules` in `stars.config` adds the package to the
  * auto imports. The `GatewayClient` is still constructed by you.
+ *
+ * @remarks
+ * The module owns the `gateway` key of `stars.config`, which takes no options for now.
  */
-declare const _default: import("@wolfstar/kit").StarsModule<import("@wolfstar/kit").ModuleOptions>;
+declare const _default: import("@wolfstar/kit").StarsModule<GatewayModuleOptions>;
+declare module "@wolfstar/schema" {
+  interface StarsConfig {
+    gateway?: GatewayModuleOptions;
+  }
+}
 //#endregion
 export { _default as default };
 //# sourceMappingURL=module.d.ts.map

package/dist/esm/module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"module.d.ts","names":[],"sources":["../../src/module.ts"],"mappings":";;;;;cAEA"}
+{"version":3,"file":"module.d.ts","names":[],"sources":["../../src/module.ts"],"mappings":";;;;YAKY,uBAAuB;;;;;;;;;;YAqBvB;IACR,UAAU"}

package/dist/esm/module.js

@@ -4,10 +4,14 @@ import { defineModule } from "@wolfstar/kit";
 /**
 * The Stars module: listing `@wolfstar/plugin-gateway/module` in `modules` in `stars.config` adds the package to the
 * auto imports. The `GatewayClient` is still constructed by you.
+*
+* @remarks
+* The module owns the `gateway` key of `stars.config`, which takes no options for now.
 */
 var module_default = defineModule({
 	meta: {
 		name: "@wolfstar/plugin-gateway",
+		configKey: "gateway",
 		compatibility: { framework: ">=6.1.0" }
 	},
 	setup(_options, ctx) {

package/dist/esm/module.js.map

@@ -1 +1 @@
-{"version":3,"file":"module.js","names":[],"sources":["../../src/module.ts"],"sourcesContent":["import { defineModule } from \"@wolfstar/kit\";\n\n/**\n * The Stars module: listing `@wolfstar/plugin-gateway/module` in `modules` in `stars.config` adds the package to the\n * auto imports. The `GatewayClient` is still constructed by you.\n */\nexport default defineModule({\n  meta: { name: \"@wolfstar/plugin-gateway\", compatibility: { framework: \">=6.1.0\" } },\n  setup(_options, ctx) {\n    ctx.addImports(\"@wolfstar/plugin-gateway\");\n  },\n});\n"],"mappings":";;;;;;;AAMA,qBAAe,aAAa;CAC1B,MAAM;EAAE,MAAM;EAA4B,eAAe,EAAE,WAAW,UAAU;CAAE;CAClF,MAAM,UAAU,KAAK;EACnB,IAAI,WAAW,0BAA0B;CAC3C;AACF,CAAC"}
+{"version":3,"file":"module.js","names":[],"sources":["../../src/module.ts"],"sourcesContent":["import { defineModule } from \"@wolfstar/kit\";\n\n/**\n * The options of the module: none yet. The `gateway` key of `stars.config` is reserved for them.\n */\nexport type GatewayModuleOptions = Record<string, never>;\n\n/**\n * The Stars module: listing `@wolfstar/plugin-gateway/module` in `modules` in `stars.config` adds the package to the\n * auto imports. The `GatewayClient` is still constructed by you.\n *\n * @remarks\n * The module owns the `gateway` key of `stars.config`, which takes no options for now.\n */\nexport default defineModule<GatewayModuleOptions>({\n  meta: {\n    name: \"@wolfstar/plugin-gateway\",\n    configKey: \"gateway\",\n    compatibility: { framework: \">=6.1.0\" },\n  },\n  setup(_options, ctx) {\n    ctx.addImports(\"@wolfstar/plugin-gateway\");\n  },\n});\n\ndeclare module \"@wolfstar/schema\" {\n  interface StarsConfig {\n    gateway?: GatewayModuleOptions;\n  }\n}\n"],"mappings":";;;;;;;;;;AAcA,qBAAe,aAAmC;CAChD,MAAM;EACJ,MAAM;EACN,WAAW;EACX,eAAe,EAAE,WAAW,UAAU;CACxC;CACA,MAAM,UAAU,KAAK;EACnB,IAAI,WAAW,0BAA0B;CAC3C;AACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wolfstar/plugin-gateway",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Gateway (WebSocket) support for @wolfstar/http-framework: a GatewayClient emitting Structures, backed by a pluggable cache",
   "keywords": [
     "discord",
@@ -59,20 +59,25 @@
     "@discordjs/structures": "1.0.0-pr-11602.1789066132-275cd4b42",
     "@discordjs/ws": "^2.0.4",
     "@sapphire/pieces": "^4.4.1",
-    "@wolfstar/plugin-cache": "^0.7.0",
+    "@wolfstar/plugin-cache": "^0.8.0",
     "discord-api-types": "^0.38.33"
   },
   "devDependencies": {
     "@wolfstar/http-framework": "^6.1.0",
-    "@wolfstar/kit": "^0.1.0"
+    "@wolfstar/kit": "^0.2.0",
+    "@wolfstar/schema": "^0.9.0"
   },
   "peerDependencies": {
     "@wolfstar/http-framework": "^3.4.0 || ^5.0.0 || ^6.0.0",
-    "@wolfstar/kit": "^0.1.0"
+    "@wolfstar/kit": "^0.2.0",
+    "@wolfstar/schema": "^0.9.0"
   },
   "peerDependenciesMeta": {
     "@wolfstar/kit": {
       "optional": true
+    },
+    "@wolfstar/schema": {
+      "optional": true
     }
   },
   "engines": {