@sapphire/pieces 4.2.3-next.463a170.0 → 4.2.3-next.6370cbf.0

package/dist/cjs/index.d.cts

@@ -793,7 +793,7 @@ interface Container {
  *
  * // In any piece, core, plugin, or custom:
  * export class UserCommand extends Command {
- *   public run(message, args) {
+ *   public messageRun(message, args) {
  *     // The injected version is available here:
  *     const { version } = this.container;
  *

package/dist/cjs/lib/shared/Container.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/lib/shared/Container.ts"],"names":[],"mappings":";AAAA,SAAS,qBAAqB;AA6EvB,IAAM,YAAuB;AAAA,EACnC,QAAQ,IAAI,cAAc;AAC3B","sourcesContent":["import { StoreRegistry } from '../structures/StoreRegistry';\n\n/**\n * Represents the type of the properties injected into the container, which is available at {@link container}.\n *\n * Because Sapphire works as a standalone framework (independent of external libraries), there is a need to pass data\n * from one place to another, which would vary depending on the user and their use-cases.\n *\n * Furthermore, plugins may use this structure to add properties referencing to the plugin's objects so they can be\n * accessed by both the user and the plugin at any moment and at any place.\n *\n * Finally, both library developers and bot developers should augment the Container interface from this module using\n * [module augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation).\n */\nexport interface Container {\n\tstores: StoreRegistry;\n}\n\n/**\n * The injected variables that will be accessible to any place. To add an extra property, simply add a property with a\n * regular assignment, and it will be available in all places simultaneously.\n *\n * @example\n * ```typescript\n * // Add a reference for the version:\n * import { container } from '@sapphire/pieces';\n *\n * container.version = '1.0.0';\n *\n * // Can be placed anywhere in a TypeScript file, for JavaScript projects,\n * // you can create an `augments.d.ts` and place the code there.\n * declare module '@sapphire/pieces' {\n *   interface Container {\n *     version: string;\n *   }\n * }\n *\n * // In any piece, core, plugin, or custom:\n * export class UserCommand extends Command {\n *   public run(message, args) {\n *     // The injected version is available here:\n *     const { version } = this.container;\n *\n *     // ...\n *   }\n * }\n * ```\n *\n * @example\n * ```typescript\n * // In a plugin's context, e.g. API:\n * class Api extends Plugin {\n *   static [postInitialization]() {\n *     const server = new Server(this);\n *     container.server = server;\n *\n *     // ...\n *   }\n * }\n *\n * declare module '@sapphire/pieces' {\n *   interface Container {\n *     server: Server;\n *   }\n * }\n *\n * // In any piece, even those that aren't routes nor middlewares:\n * export class UserRoute extends Route {\n *   public [methods.POST](message, args) {\n *     // The injected server is available here:\n *     const { server } = this.container;\n *\n *     // ...\n *   }\n * }\n * ```\n */\nexport const container: Container = {\n\tstores: new StoreRegistry()\n};\n"]}
+{"version":3,"sources":["../../../../src/lib/shared/Container.ts"],"names":[],"mappings":";AAAA,SAAS,qBAAqB;AA6EvB,IAAM,YAAuB;AAAA,EACnC,QAAQ,IAAI,cAAc;AAC3B","sourcesContent":["import { StoreRegistry } from '../structures/StoreRegistry';\n\n/**\n * Represents the type of the properties injected into the container, which is available at {@link container}.\n *\n * Because Sapphire works as a standalone framework (independent of external libraries), there is a need to pass data\n * from one place to another, which would vary depending on the user and their use-cases.\n *\n * Furthermore, plugins may use this structure to add properties referencing to the plugin's objects so they can be\n * accessed by both the user and the plugin at any moment and at any place.\n *\n * Finally, both library developers and bot developers should augment the Container interface from this module using\n * [module augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation).\n */\nexport interface Container {\n\tstores: StoreRegistry;\n}\n\n/**\n * The injected variables that will be accessible to any place. To add an extra property, simply add a property with a\n * regular assignment, and it will be available in all places simultaneously.\n *\n * @example\n * ```typescript\n * // Add a reference for the version:\n * import { container } from '@sapphire/pieces';\n *\n * container.version = '1.0.0';\n *\n * // Can be placed anywhere in a TypeScript file, for JavaScript projects,\n * // you can create an `augments.d.ts` and place the code there.\n * declare module '@sapphire/pieces' {\n *   interface Container {\n *     version: string;\n *   }\n * }\n *\n * // In any piece, core, plugin, or custom:\n * export class UserCommand extends Command {\n *   public messageRun(message, args) {\n *     // The injected version is available here:\n *     const { version } = this.container;\n *\n *     // ...\n *   }\n * }\n * ```\n *\n * @example\n * ```typescript\n * // In a plugin's context, e.g. API:\n * class Api extends Plugin {\n *   static [postInitialization]() {\n *     const server = new Server(this);\n *     container.server = server;\n *\n *     // ...\n *   }\n * }\n *\n * declare module '@sapphire/pieces' {\n *   interface Container {\n *     server: Server;\n *   }\n * }\n *\n * // In any piece, even those that aren't routes nor middlewares:\n * export class UserRoute extends Route {\n *   public [methods.POST](message, args) {\n *     // The injected server is available here:\n *     const { server } = this.container;\n *\n *     // ...\n *   }\n * }\n * ```\n */\nexport const container: Container = {\n\tstores: new StoreRegistry()\n};\n"]}

package/dist/esm/index.d.mts

@@ -793,7 +793,7 @@ interface Container {
  *
  * // In any piece, core, plugin, or custom:
  * export class UserCommand extends Command {
- *   public run(message, args) {
+ *   public messageRun(message, args) {
  *     // The injected version is available here:
  *     const { version } = this.container;
  *

package/dist/esm/lib/shared/Container.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/lib/shared/Container.ts"],"names":[],"mappings":";;;AAAA,SAAS,qBAAqB;AA6EvB,IAAM,YAAuB;AAAA,EACnC,QAAQ,IAAI,cAAc;AAC3B","sourcesContent":["import { StoreRegistry } from '../structures/StoreRegistry';\n\n/**\n * Represents the type of the properties injected into the container, which is available at {@link container}.\n *\n * Because Sapphire works as a standalone framework (independent of external libraries), there is a need to pass data\n * from one place to another, which would vary depending on the user and their use-cases.\n *\n * Furthermore, plugins may use this structure to add properties referencing to the plugin's objects so they can be\n * accessed by both the user and the plugin at any moment and at any place.\n *\n * Finally, both library developers and bot developers should augment the Container interface from this module using\n * [module augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation).\n */\nexport interface Container {\n\tstores: StoreRegistry;\n}\n\n/**\n * The injected variables that will be accessible to any place. To add an extra property, simply add a property with a\n * regular assignment, and it will be available in all places simultaneously.\n *\n * @example\n * ```typescript\n * // Add a reference for the version:\n * import { container } from '@sapphire/pieces';\n *\n * container.version = '1.0.0';\n *\n * // Can be placed anywhere in a TypeScript file, for JavaScript projects,\n * // you can create an `augments.d.ts` and place the code there.\n * declare module '@sapphire/pieces' {\n *   interface Container {\n *     version: string;\n *   }\n * }\n *\n * // In any piece, core, plugin, or custom:\n * export class UserCommand extends Command {\n *   public run(message, args) {\n *     // The injected version is available here:\n *     const { version } = this.container;\n *\n *     // ...\n *   }\n * }\n * ```\n *\n * @example\n * ```typescript\n * // In a plugin's context, e.g. API:\n * class Api extends Plugin {\n *   static [postInitialization]() {\n *     const server = new Server(this);\n *     container.server = server;\n *\n *     // ...\n *   }\n * }\n *\n * declare module '@sapphire/pieces' {\n *   interface Container {\n *     server: Server;\n *   }\n * }\n *\n * // In any piece, even those that aren't routes nor middlewares:\n * export class UserRoute extends Route {\n *   public [methods.POST](message, args) {\n *     // The injected server is available here:\n *     const { server } = this.container;\n *\n *     // ...\n *   }\n * }\n * ```\n */\nexport const container: Container = {\n\tstores: new StoreRegistry()\n};\n"]}
+{"version":3,"sources":["../../../../src/lib/shared/Container.ts"],"names":[],"mappings":";;;AAAA,SAAS,qBAAqB;AA6EvB,IAAM,YAAuB;AAAA,EACnC,QAAQ,IAAI,cAAc;AAC3B","sourcesContent":["import { StoreRegistry } from '../structures/StoreRegistry';\n\n/**\n * Represents the type of the properties injected into the container, which is available at {@link container}.\n *\n * Because Sapphire works as a standalone framework (independent of external libraries), there is a need to pass data\n * from one place to another, which would vary depending on the user and their use-cases.\n *\n * Furthermore, plugins may use this structure to add properties referencing to the plugin's objects so they can be\n * accessed by both the user and the plugin at any moment and at any place.\n *\n * Finally, both library developers and bot developers should augment the Container interface from this module using\n * [module augmentation](https://www.typescriptlang.org/docs/handbook/declaration-merging.html#module-augmentation).\n */\nexport interface Container {\n\tstores: StoreRegistry;\n}\n\n/**\n * The injected variables that will be accessible to any place. To add an extra property, simply add a property with a\n * regular assignment, and it will be available in all places simultaneously.\n *\n * @example\n * ```typescript\n * // Add a reference for the version:\n * import { container } from '@sapphire/pieces';\n *\n * container.version = '1.0.0';\n *\n * // Can be placed anywhere in a TypeScript file, for JavaScript projects,\n * // you can create an `augments.d.ts` and place the code there.\n * declare module '@sapphire/pieces' {\n *   interface Container {\n *     version: string;\n *   }\n * }\n *\n * // In any piece, core, plugin, or custom:\n * export class UserCommand extends Command {\n *   public messageRun(message, args) {\n *     // The injected version is available here:\n *     const { version } = this.container;\n *\n *     // ...\n *   }\n * }\n * ```\n *\n * @example\n * ```typescript\n * // In a plugin's context, e.g. API:\n * class Api extends Plugin {\n *   static [postInitialization]() {\n *     const server = new Server(this);\n *     container.server = server;\n *\n *     // ...\n *   }\n * }\n *\n * declare module '@sapphire/pieces' {\n *   interface Container {\n *     server: Server;\n *   }\n * }\n *\n * // In any piece, even those that aren't routes nor middlewares:\n * export class UserRoute extends Route {\n *   public [methods.POST](message, args) {\n *     // The injected server is available here:\n *     const { server } = this.container;\n *\n *     // ...\n *   }\n * }\n * ```\n */\nexport const container: Container = {\n\tstores: new StoreRegistry()\n};\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapphire/pieces",
-  "version": "4.2.3-next.463a170.0",
+  "version": "4.2.3-next.6370cbf.0",
   "description": "Sapphire's piece loader.",
   "main": "dist/cjs/index.cjs",
   "module": "dist/esm/index.mjs",
@@ -39,17 +39,17 @@
     "tslib": "^2.6.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "^18.6.1",
-    "@commitlint/config-conventional": "^18.6.2",
-    "@favware/cliff-jumper": "^2.2.3",
+    "@commitlint/cli": "^19.2.1",
+    "@commitlint/config-conventional": "^19.1.0",
+    "@favware/cliff-jumper": "^3.0.2",
     "@favware/npm-deprecate": "^1.0.7",
     "@favware/rollup-type-bundler": "^3.3.0",
-    "@sapphire/eslint-config": "^5.0.3",
+    "@sapphire/eslint-config": "^5.0.4",
     "@sapphire/prettier-config": "^2.0.0",
-    "@sapphire/ts-config": "^5.0.0",
-    "@types/node": "^20.11.24",
-    "@typescript-eslint/eslint-plugin": "^7.1.0",
-    "@typescript-eslint/parser": "^7.1.0",
+    "@sapphire/ts-config": "^5.0.1",
+    "@types/node": "^20.12.7",
+    "@typescript-eslint/eslint-plugin": "^7.6.0",
+    "@typescript-eslint/parser": "^7.6.0",
     "concurrently": "^8.2.2",
     "cz-conventional-changelog": "^3.3.0",
     "esbuild-plugin-file-path-extensions": "^2.0.0",
@@ -60,10 +60,10 @@
     "prettier": "^3.2.5",
     "rimraf": "^5.0.5",
     "tsup": "^8.0.2",
-    "typedoc": "^0.25.9",
+    "typedoc": "^0.25.13",
     "typedoc-json-parser": "^9.0.1",
-    "typescript": "^5.3.3",
-    "vitest": "^1.3.1"
+    "typescript": "^5.4.5",
+    "vitest": "^1.5.0"
   },
   "repository": {
     "type": "git",
@@ -112,5 +112,5 @@
     "minimist": "^1.2.8"
   },
   "prettier": "@sapphire/prettier-config",
-  "packageManager": "yarn@4.1.0"
+  "packageManager": "yarn@4.1.1"
 }