@sapphire/plugin-utilities-store 1.1.0-next.7766f29.0

package/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.

package/README.md

@@ -0,0 +1,111 @@
+<div align="center">
+
+![Sapphire Logo](https://cdn.skyra.pw/gh-assets/sapphire-banner.png)
+
+# @sapphire/plugin-utilities-store
+
+**Plugin for <a href="https://github.com/sapphiredev/framework">@sapphire/framework</a> to have a Sapphire store which you can fill with utility functions available through the container.**
+
+[![GitHub](https://img.shields.io/github/license/sapphiredev/plugins)](https://github.com/sapphiredev/plugins/blob/main/LICENSE.md)
+[![codecov](https://codecov.io/gh/sapphiredev/plugins/branch/main/graph/badge.svg?token=QWL8FB16BR)](https://codecov.io/gh/sapphiredev/plugins)
+[![npm bundle size](https://img.shields.io/bundlephobia/min/@sapphire/plugin-api?logo=webpack&style=flat-square)](https://bundlephobia.com/result?p=@sapphire/plugin-api)
+[![npm](https://img.shields.io/npm/v/@sapphire/plugin-api?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/@sapphire/plugin-api)
+
+</div>
+
+## Description
+
+When writing a bot you often have many external utility functions and to have some centralized place to access them from it is useful to have an automatically imported utilities store. This plugin provides a store that you can fill with utility functions and access them from the container.
+
+**Please note that utility functions are available on the Sapphire `container` only after the bot has logged in, any functions required before logging in should be exported through normal module loading means.**
+
+## Installation
+
+`@sapphire/plugin-utilities-store` depends on the following packages. Be sure to install these along with this package!
+
+-   [`@sapphire/framework`](https://www.npmjs.com/package/@sapphire/framework)
+
+You can use the following command to install this package, or replace `npm install` with your package manager of choice.
+
+```sh
+npm install @sapphire/plugin-utilities-store
+```
+
+---
+
+## Usage
+
+Start by importing the registration file in your project to use the plugin:
+
+**JavaScript**
+
+```javascript
+require('@sapphire/plugin-utilities-store/register');
+```
+
+**TypeScript**
+
+```typescript
+import '@sapphire/plugin-utilities-store/register';
+```
+
+-   Create a new `utilities` directory under `/src`
+-   Make your first utility piece:
+
+```typescript
+import { Utility } from '@sapphire/plugin-utilities-store';
+
+export class SumUtility extends Utility {
+	public constructor(context: Utility.Context, options: Utility.Options) {
+		super(context, {
+			...options,
+			name: 'sum'
+		});
+	}
+
+	public add(numberOne: number, numberTwo: number) {
+		return numberOne + numberTwo;
+	}
+
+	public subtract(numberOne: number, numberTwo: number) {
+		return numberOne - numberTwo;
+	}
+}
+```
+
+In this example we simply add and subtract two numbers. You can pass any arguments you wish to the utility function, and it will execute as written.
+
+In order for TypeScript to know about your utility functions and their arguments you need to do leverage module augmentation. `SumUtility` here is the piece class as defined in the example above.
+
+```typescript
+declare module '@sapphire/plugin-utilities-store' {
+	export interface Utilities {
+		sum: SumUtility;
+	}
+}
+```
+
+## Buy us some doughnuts
+
+Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!
+
+We accept donations through Open Collective, Ko-fi, Paypal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.
+
+|   Donate With   |                       Address                       |
+| :-------------: | :-------------------------------------------------: |
+| Open Collective | [Click Here](https://sapphirejs.dev/opencollective) |
+|      Ko-fi      |      [Click Here](https://sapphirejs.dev/kofi)      |
+|     Patreon     |    [Click Here](https://sapphirejs.dev/patreon)     |
+|     PayPal      |     [Click Here](https://sapphirejs.dev/paypal)     |
+
+## Contributors
+
+Please make sure to read the [Contributing Guide][contributing] before making a pull request.
+
+Thank you to all the people who already contributed to Sapphire!
+
+<a href="https://github.com/sapphiredev/plugins/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=sapphiredev/plugins" />
+</a>
+
+[contributing]: https://github.com/sapphiredev/.github/blob/main/.github/CONTRIBUTING.md

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import type { Utilities } from './lib/Utilities';
+import type { UtilitiesStore } from './lib/UtilitiesStore';
+export * from './lib/Utilities';
+export * from './lib/UtilitiesStore';
+export * from './lib/Utility';
+declare module 'discord.js' {
+    interface Client {
+        utilities: Utilities;
+    }
+}
+declare module '@sapphire/pieces' {
+    interface StoreRegistryEntries {
+        utilities: UtilitiesStore;
+    }
+    interface Container {
+        utilities: Utilities;
+    }
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAE3D,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAE9B,OAAO,QAAQ,YAAY,CAAC;IAC3B,UAAiB,MAAM;QACtB,SAAS,EAAE,SAAS,CAAC;KACrB;CACD;AAED,OAAO,QAAQ,kBAAkB,CAAC;IACjC,UAAU,oBAAoB;QAC7B,SAAS,EAAE,cAAc,CAAC;KAC1B;IAED,UAAU,SAAS;QAClB,SAAS,EAAE,SAAS,CAAC;KACrB;CACD"}

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/Utilities"), exports);
+tslib_1.__exportStar(require("./lib/UtilitiesStore"), exports);
+tslib_1.__exportStar(require("./lib/Utility"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAGA,0DAAgC;AAChC,+DAAqC;AACrC,wDAA8B"}

package/dist/index.mjs

@@ -0,0 +1,6 @@
+import mod from "./index.js";
+
+export default mod;
+export const Utilities = mod.Utilities;
+export const UtilitiesStore = mod.UtilitiesStore;
+export const Utility = mod.Utility;

package/dist/lib/Utilities.d.ts

@@ -0,0 +1,24 @@
+import { UtilitiesStore } from './UtilitiesStore';
+import type { Utility } from './Utility';
+/**
+ * @since 1.0.0
+ */
+export declare class Utilities {
+    /**
+     * The utilities this store holds.
+     * @since 1.0.0
+     */
+    readonly store: UtilitiesStore;
+    /**
+     * @since 1.0.0
+     * @param options The options for this server
+     */
+    constructor();
+    /**
+     * Registers a piece on this class.
+     * @param name The name of the piece to register on this class
+     * @param piece The piece to register on this class
+     */
+    exposePiece(name: string, piece: Utility): void;
+}
+//# sourceMappingURL=Utilities.d.ts.map

package/dist/lib/Utilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utilities.d.ts","sourceRoot":"","sources":["../../src/lib/Utilities.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,qBAAa,SAAS;IACrB;;;OAGG;IACH,SAAgB,KAAK,EAAE,cAAc,CAAC;IAEtC;;;OAGG;;IAMH;;;;OAIG;IACI,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO;CAI/C"}

package/dist/lib/Utilities.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Utilities = void 0;
+const pieces_1 = require("@sapphire/pieces");
+const UtilitiesStore_1 = require("./UtilitiesStore");
+/**
+ * @since 1.0.0
+ */
+class Utilities {
+    /**
+     * @since 1.0.0
+     * @param options The options for this server
+     */
+    constructor() {
+        /**
+         * The utilities this store holds.
+         * @since 1.0.0
+         */
+        Object.defineProperty(this, "store", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        pieces_1.container.utilities = this;
+        this.store = new UtilitiesStore_1.UtilitiesStore();
+    }
+    /**
+     * Registers a piece on this class.
+     * @param name The name of the piece to register on this class
+     * @param piece The piece to register on this class
+     */
+    exposePiece(name, piece) {
+        // @ts-expect-error Bypass TypeScript check for dynamic property assignment
+        this[name] = piece;
+    }
+}
+exports.Utilities = Utilities;
+//# sourceMappingURL=Utilities.js.map

package/dist/lib/Utilities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utilities.js","sourceRoot":"","sources":["../../src/lib/Utilities.ts"],"names":[],"mappings":";;;AAAA,6CAA6C;AAC7C,qDAAkD;AAGlD;;GAEG;AACH,MAAa,SAAS;IAOrB;;;OAGG;IACH;QAVA;;;WAGG;QACH;;;;;WAAsC;QAOrC,kBAAS,CAAC,SAAS,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC,KAAK,GAAG,IAAI,+BAAc,EAAE,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,IAAY,EAAE,KAAc;QAC9C,2EAA2E;QAC3E,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IACpB,CAAC;CACD;AAzBD,8BAyBC"}

package/dist/lib/UtilitiesStore.d.ts

@@ -0,0 +1,9 @@
+import { Store } from '@sapphire/pieces';
+import { Utility } from './Utility';
+/**
+ * @since 1.0.0
+ */
+export declare class UtilitiesStore extends Store<Utility> {
+    constructor();
+}
+//# sourceMappingURL=UtilitiesStore.d.ts.map

package/dist/lib/UtilitiesStore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UtilitiesStore.d.ts","sourceRoot":"","sources":["../../src/lib/UtilitiesStore.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;GAEG;AACH,qBAAa,cAAe,SAAQ,KAAK,CAAC,OAAO,CAAC;;CAIjD"}

package/dist/lib/UtilitiesStore.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UtilitiesStore = void 0;
+const pieces_1 = require("@sapphire/pieces");
+const Utility_1 = require("./Utility");
+/**
+ * @since 1.0.0
+ */
+class UtilitiesStore extends pieces_1.Store {
+    constructor() {
+        super(Utility_1.Utility, { name: 'utilities' });
+    }
+}
+exports.UtilitiesStore = UtilitiesStore;
+//# sourceMappingURL=UtilitiesStore.js.map

package/dist/lib/UtilitiesStore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UtilitiesStore.js","sourceRoot":"","sources":["../../src/lib/UtilitiesStore.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AACzC,uCAAoC;AAEpC;;GAEG;AACH,MAAa,cAAe,SAAQ,cAAc;IACjD;QACC,KAAK,CAAC,iBAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;IACvC,CAAC;CACD;AAJD,wCAIC"}

package/dist/lib/Utility.d.ts

@@ -0,0 +1,11 @@
+import { Piece } from '@sapphire/pieces';
+/**
+ * @since 1.0.0
+ */
+export declare abstract class Utility extends Piece {
+}
+export declare namespace Utility {
+    type Context = Piece.Context;
+    type Options = Piece.Options;
+}
+//# sourceMappingURL=Utility.d.ts.map

package/dist/lib/Utility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utility.d.ts","sourceRoot":"","sources":["../../src/lib/Utility.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEzC;;GAEG;AACH,8BAAsB,OAAQ,SAAQ,KAAK;CAAG;AAE9C,yBAAiB,OAAO,CAAC;IACxB,KAAY,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;IACpC,KAAY,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;CACpC"}

package/dist/lib/Utility.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Utility = void 0;
+const pieces_1 = require("@sapphire/pieces");
+/**
+ * @since 1.0.0
+ */
+class Utility extends pieces_1.Piece {
+}
+exports.Utility = Utility;
+//# sourceMappingURL=Utility.js.map

package/dist/lib/Utility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utility.js","sourceRoot":"","sources":["../../src/lib/Utility.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAEzC;;GAEG;AACH,MAAsB,OAAQ,SAAQ,cAAK;CAAG;AAA9C,0BAA8C"}

package/dist/register.d.ts

@@ -0,0 +1,16 @@
+import './index';
+import { Plugin, postLogin, preInitialization, SapphireClient } from '@sapphire/framework';
+/**
+ * @since 1.0.0
+ */
+export declare class UtilitiesPlugin extends Plugin {
+    /**
+     * @since 1.0.0
+     */
+    static [preInitialization](this: SapphireClient): void;
+    /**
+     * @since 1.0.0
+     */
+    static [postLogin](this: SapphireClient): void;
+}
+//# sourceMappingURL=register.d.ts.map

package/dist/register.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,CAAC;AACjB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAK3F;;GAEG;AACH,qBAAa,eAAgB,SAAQ,MAAM;IAC1C;;OAEG;WACW,CAAC,iBAAiB,CAAC,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI;IAO7D;;OAEG;WACW,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI;CAOrD"}

package/dist/register.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UtilitiesPlugin = void 0;
+require("./index");
+const framework_1 = require("@sapphire/framework");
+const path_1 = require("path");
+const Utilities_1 = require("./lib/Utilities");
+const UtilitiesStore_1 = require("./lib/UtilitiesStore");
+/**
+ * @since 1.0.0
+ */
+class UtilitiesPlugin extends framework_1.Plugin {
+    /**
+     * @since 1.0.0
+     */
+    static [framework_1.preInitialization]() {
+        this.utilities = new Utilities_1.Utilities();
+        this.stores.register(this.utilities.store);
+        this.utilities.store.registerPath((0, path_1.join)(__dirname, UtilitiesStore_1.UtilitiesStore.name));
+    }
+    /**
+     * @since 1.0.0
+     */
+    static [framework_1.postLogin]() {
+        const pieces = this.utilities.store;
+        for (const [name, piece] of pieces.entries()) {
+            this.utilities.exposePiece(name, piece);
+        }
+    }
+}
+exports.UtilitiesPlugin = UtilitiesPlugin;
+framework_1.SapphireClient.plugins.registerPreInitializationHook(UtilitiesPlugin[framework_1.preInitialization], 'UtilitiesStore-PreInitialization');
+framework_1.SapphireClient.plugins.registerPostLoginHook(UtilitiesPlugin[framework_1.postLogin], 'UtilitiesStore-PostLogin');
+//# sourceMappingURL=register.js.map

package/dist/register.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"register.js","sourceRoot":"","sources":["../src/register.ts"],"names":[],"mappings":";;;AAAA,mBAAiB;AACjB,mDAA2F;AAC3F,+BAA4B;AAC5B,+CAA4C;AAC5C,yDAAsD;AAEtD;;GAEG;AACH,MAAa,eAAgB,SAAQ,kBAAM;IAC1C;;OAEG;IACI,MAAM,CAAC,CAAC,6BAAiB,CAAC;QAChC,IAAI,CAAC,SAAS,GAAG,IAAI,qBAAS,EAAE,CAAC;QACjC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAE3C,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,CAAC,IAAA,WAAI,EAAC,SAAS,EAAE,+BAAc,CAAC,IAAI,CAAC,CAAC,CAAC;IACzE,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,CAAC,qBAAS,CAAC;QACxB,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;QAEpC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,EAAE,EAAE;YAC7C,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;SACxC;IACF,CAAC;CACD;AArBD,0CAqBC;AAED,0BAAc,CAAC,OAAO,CAAC,6BAA6B,CAAC,eAAe,CAAC,6BAAiB,CAAC,EAAE,kCAAkC,CAAC,CAAC;AAC7H,0BAAc,CAAC,OAAO,CAAC,qBAAqB,CAAC,eAAe,CAAC,qBAAS,CAAC,EAAE,0BAA0B,CAAC,CAAC"}

package/dist/register.mjs

@@ -0,0 +1,4 @@
+import mod from "./register.js";
+
+export default mod;
+export const UtilitiesPlugin = mod.UtilitiesPlugin;

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@sapphire/plugin-utilities-store",
+  "version": "1.1.0-next.7766f29.0",
+  "description": "Plugin for @sapphire/framework to have a Sapphire store which you can fill with utility functions available through the container",
+  "author": "@sapphire",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./register": {
+      "import": "./register.mjs",
+      "require": "./register.js",
+      "types": "./register.d.ts"
+    }
+  },
+  "sideEffects": [
+    "./dist/register.js",
+    "./register.js",
+    "./register.mjs"
+  ],
+  "homepage": "https://github.com/sapphiredev/plugins/tree/main/packages/api",
+  "scripts": {
+    "lint": "eslint src --ext ts --fix",
+    "build": "tsc -b src && yarn esm:register && yarn esm:default",
+    "esm:register": "gen-esm-wrapper dist/register.js dist/register.mjs",
+    "esm:default": "gen-esm-wrapper dist/index.js dist/index.mjs",
+    "docs": "typedoc-json-parser",
+    "prepack": "yarn build",
+    "bump": "cliff-jumper",
+    "check-update": "cliff-jumper --dry-run"
+  },
+  "dependencies": {
+    "tslib": "^2.5.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sapphiredev/plugins.git",
+    "directory": "packages/utilities-store"
+  },
+  "files": [
+    "dist/**/*.js*",
+    "dist/**/*.mjs*",
+    "dist/**/*.d*",
+    "./register.*"
+  ],
+  "engines": {
+    "node": ">=v14.0.0",
+    "npm": ">=7.0.0"
+  },
+  "keywords": [
+    "sapphiredev",
+    "plugin",
+    "bot",
+    "typescript",
+    "ts",
+    "yarn",
+    "discord",
+    "sapphire"
+  ],
+  "bugs": {
+    "url": "https://github.com/sapphiredev/plugins/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@favware/cliff-jumper": "^1.10.0",
+    "gen-esm-wrapper": "^1.1.3",
+    "typedoc": "^0.23.24",
+    "typedoc-json-parser": "^7.1.0",
+    "typescript": "^4.9.4"
+  }
+}

package/register.d.ts

@@ -0,0 +1 @@
+export * from './dist/register';

package/register.js

@@ -0,0 +1,4 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const tslib = require('tslib');
+
+tslib.__exportStar(require('./dist/register.js'), exports);

package/register.mjs

@@ -0,0 +1 @@
+export * from './dist/register.mjs';