feat: First step at the rewrite

.eslintrc.json

@@ -1,3 +1,7 @@
 {
-	"extends": "klasa/eslint-ts"
+	"extends": "klasa/eslint-ts",
+	"rules": {
+		"no-dupe-class-members": 0,
+		"no-invalid-this": 0
+	}
 }

.gitignore

@@ -7,3 +7,4 @@ coverage/
 dist/
 docs/
 test-results.xml
+yarn-error.log

package.json

@@ -17,13 +17,19 @@
   "engines": {
     "node": ">=10.1.0"
   },
+  "peerDependencies": {
+    "klasa": "dirigeants/klasa"
+  },
   "devDependencies": {
     "@types/node": "^12.7.3",
+    "@types/ws": "^6.0.3",
     "@typescript-eslint/eslint-plugin": "^2.0.0",
     "@typescript-eslint/parser": "^2.0.0",
     "ava": "^2.3.0",
+    "discord.js": "discordjs/discord.js",
     "eslint": "^6.3.0",
     "eslint-config-klasa": "dirigeants/klasa-lint",
+    "klasa": "dirigeants/klasa#875/head",
     "source-map-support": "^0.5.13",
     "ts-node": "^8.3.0",
     "typescript": "^3.6.2"
@@ -45,5 +51,11 @@
       "ts-node/register",
       "source-map-support/register"
     ]
+  },
+  "dependencies": {
+    "@discordjs/collection": "^0.1.3",
+    "@klasa/querybuilder": "^0.0.1",
+    "@klasa/request-handler": "^0.0.3",
+    "@klasa/utils": "^0.0.2"
   }
 }

src/index.ts

@@ -1,3 +1,14 @@
-export default function foo(): string {
-	return 'bar';
-}
+export * from './lib/gateway/Gateway';
+export * from './lib/gateway/GatewayDriver';
+export * from './lib/gateway/GatewayStorage';
+export * from './lib/schema/Schema';
+export * from './lib/schema/SchemaEntry';
+export * from './lib/schema/SchemaFolder';
+export * from './lib/settings/Settings';
+export * from './lib/settings/SettingsFolder';
+export * from './lib/structures/Provider';
+export * from './lib/structures/SQLProvider';
+export * from './lib/structures/ProviderStore';
+export * from './lib/structures/Serializer';
+export * from './lib/structures/SerializerStore';
+export * from './lib/types';

src/lib/gateway/Gateway.ts

@@ -0,0 +1,75 @@
+import { RequestHandler, IdKeyed } from '@klasa/request-handler';
+import Collection from '@discordjs/collection';
+import { GatewayStorage } from './GatewayStorage';
+import { Settings } from '../settings/Settings';
+import { Client } from '../types';
+
+export class Gateway extends GatewayStorage {
+
+	/**
+	 * The cached entries for this Gateway or the external datastore to get the settings from.
+	 */
+	public cache: ProxyMap = (this.name in this.client) && (this.client[this.name as keyof Client] instanceof Map) ?
+		this.client[this.name as keyof Client] as ProxyMap :
+		new Collection<string, ProxyMapEntry>();
+
+	/**
+	 * The request handler that manages the synchronization queue.
+	 */
+	public requestHandler = new RequestHandler(
+		(id: string): Promise<IdKeyed<string>> => {
+			const { provider } = this;
+			if (provider === null) throw new Error('Cannot run requests without a provider available.');
+			return provider.get(this.name, id) as Promise<IdKeyed<string>>;
+		}, (ids: string[]): Promise<IdKeyed<string>[]> => {
+			const { provider } = this;
+			if (provider === null) throw new Error('Cannot run requests without a provider available.');
+			return provider.getAll(this.name, ids) as Promise<IdKeyed<string>[]>;
+		}
+	);
+
+	/**
+	 * Gets an entry from the cache or creates one if it does not exist
+	 * @param target The target that holds a Settings instance of the holder for the new one
+	 * @param id The settings' identificator
+	 */
+	public acquire(target: IdKeyed<string>, id = target.id): Settings {
+		return this.get(id) || this.create(target, id);
+	}
+
+	/**
+	 * Get an entry from the cache.
+	 * @param id The key to get from the cache
+	 */
+	public get(id: string): Settings | null {
+		const entry = this.cache.get(id);
+		return (entry && entry.settings) || null;
+	}
+
+	/**
+	 * Create a new Settings instance for this gateway.
+	 * @param target The target that will hold this instance alive
+	 * @param id The settings' identificator
+	 */
+	public create(target: IdKeyed<string>, id = target.id): Settings {
+		const settings = new Settings(this, target, id);
+		if (this.schema.size !== 0) settings.sync(true).catch(err => this.client.emit('error', err));
+		return settings;
+	}
+
+	/**
+	 * Runs a synchronization task for the gateway.
+	 */
+	public async sync(): Promise<this> {
+		await this.requestHandler.wait();
+		return this;
+	}
+
+}
+
+export interface ProxyMapEntry {
+	settings: Settings;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface ProxyMap extends Map<string, ProxyMapEntry> { }

src/lib/gateway/GatewayDriver.ts

@@ -0,0 +1,49 @@
+import Collection from '@discordjs/collection';
+import { GatewayStorage, GatewayStorageJson } from './GatewayStorage';
+import { Client } from '../types';
+
+export class GatewayDriver extends Collection<string, GatewayStorage> {
+
+	/**
+	 * The client this GatewayDriver was created with.
+	 */
+	public readonly client: Client;
+
+	/**
+	 * Constructs a new instance of GatewayDriver.
+	 * @param client The client that manages this instance
+	 */
+	public constructor(client: Client) {
+		super();
+		this.client = client;
+	}
+
+	/**
+	 * Registers a new gateway.
+	 * @param gateway The gateway to register
+	 */
+	public register(gateway: GatewayStorage): this {
+		if (typeof this.client.options.settings.gateways === 'undefined') this.client.options.settings.gateways = {};
+		if (!(gateway.name in this.client.options.settings.gateways)) this.client.options.settings.gateways[gateway.name] = {};
+		this.set(gateway.name, gateway);
+		return this;
+	}
+
+	/**
+	 * Initializes all gateways.
+	 */
+	public async init(): Promise<void> {
+		await Promise.all([...this.values()].map(gateway => gateway.init()));
+	}
+
+	/**
+	 * The gateway driver with all serialized gateways.
+	 */
+	public toJSON(): GatewayDriverJson {
+		return Object.fromEntries([...this.entries()].map(([key, value]) => [key, value.toJSON()]));
+	}
+
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface GatewayDriverJson extends Record<string, GatewayStorageJson> { }

src/lib/gateway/GatewayStorage.ts

@@ -0,0 +1,120 @@
+import { Client } from '../types';
+import { Schema, SchemaJson } from '../schema/Schema';
+import { Provider } from '../structures/Provider';
+
+export class GatewayStorage {
+
+	/**
+	 * The client this gateway was created with.
+	 */
+	public readonly client: Client;
+
+	/**
+	 * The name of this gateway.
+	 */
+	public readonly name: string;
+
+	/**
+	 * The schema for this gateway.
+	 */
+	public readonly schema: Schema;
+
+	/**
+	 * Whether or not this gateway has been initialized.
+	 */
+	public ready = false;
+
+	/**
+	 * The provider's name that manages this gateway.
+	 */
+	private readonly _provider: string;
+
+	public constructor(client: Client, name: string, options: GatewayStorageOptions) {
+		this.client = client;
+		this.name = name;
+		this.schema = options.schema || new Schema();
+		this._provider = options.provider || client.options.providers.default || '';
+	}
+
+	/**
+	 * The provider that manages this gateway's persistent data.
+	 */
+	public get provider(): Provider | null {
+		return this.client.providers.get(this._provider) || null;
+	}
+
+	/**
+	 * Initializes the gateway.
+	 */
+	public async init(): Promise<void> {
+		// Gateways must not initialize twice.
+		if (this.ready) throw new Error(`The gateway ${this.name} has already been initialized.`);
+
+		// Check the provider's existence.
+		const { provider } = this;
+		if (provider === null) throw new Error(`The gateway ${this.name} could not find the provider ${this._provider}.`);
+		this.ready = true;
+
+		const errors = [];
+		for (const entry of this.schema.values(true)) {
+			// Assign Client to all Pieces for Serializers && Type Checking
+			entry.client = this.client;
+
+			Object.freeze(entry);
+
+			// Check if the entry is valid
+			try {
+				entry.check();
+			} catch (error) {
+				errors.push(error.message);
+			}
+		}
+
+		if (errors.length) throw new Error(`[SCHEMA] There is an error with your schema.\n${errors.join('\n')}`);
+
+		// TODO(kyranet): Finish this.
+		// this.schema.defaults._init(this.schema.defaults, this.schema);
+
+		// // Init the table
+		// const hasTable = await provider.hasTable(this.name);
+		// if (!hasTable) await provider.createTable(this.name);
+
+		// // Add any missing columns (NoSQL providers return empty array)
+		// const columns = await provider.getColumns(this.name);
+		// if (columns.length) {
+		// 	const promises = [];
+		// 	for (const [key, entry] of this.schema.paths) if (!columns.includes(key)) promises.push(provider.addColumn(this.name, entry));
+		// 	await Promise.all(promises);
+		// }
+	}
+
+	/**
+	 * Runs a synchronization task for the gateway.
+	 */
+	public async sync(): Promise<this> {
+		return this;
+	}
+
+	/**
+	 * Get A JSON object containing the schema and the options.
+	 */
+	public toJSON(): GatewayStorageJson {
+		return {
+			name: this.name,
+			provider: this._provider,
+			schema: this.schema.toJSON()
+		};
+	}
+
+}
+
+export interface GatewayStorageOptions {
+	schema?: Schema;
+	provider?: string;
+}
+
+export interface GatewayStorageJson {
+	name: string;
+	provider: string;
+	schema: SchemaJson;
+}