aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/api/DataStore/LICENSE202
-rw-r--r--src/api/DataStore/index.ts282
-rw-r--r--src/api/index.ts1
3 files changed, 485 insertions, 0 deletions
diff --git a/src/api/DataStore/LICENSE b/src/api/DataStore/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/src/api/DataStore/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/src/api/DataStore/index.ts b/src/api/DataStore/index.ts
new file mode 100644
index 0000000..f0764b3
--- /dev/null
+++ b/src/api/DataStore/index.ts
@@ -0,0 +1,282 @@
+// This is https://github.com/jakearchibald/idb-keyval v6.2.0
+// The only change is changing the default DB & Store name
+// and formatting it to pass our configs
+// I would usually not add my own Copyright for such a small modification
+// but the Apache License requires this.
+
+/*
+ * Copyright 2016, Jake Archibald
+ * Copyright 2022, Vendicated
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export function promisifyRequest<T = undefined>(
+ request: IDBRequest<T> | IDBTransaction,
+): Promise<T> {
+ return new Promise<T>((resolve, reject) => {
+ // @ts-ignore - file size hacks
+ request.oncomplete = request.onsuccess = () => resolve(request.result);
+ // @ts-ignore - file size hacks
+ request.onabort = request.onerror = () => reject(request.error);
+ });
+}
+
+export function createStore(dbName: string, storeName: string): UseStore {
+ const request = indexedDB.open(dbName);
+ request.onupgradeneeded = () => request.result.createObjectStore(storeName);
+ const dbp = promisifyRequest(request);
+
+ return (txMode, callback) =>
+ dbp.then(db =>
+ callback(db.transaction(storeName, txMode).objectStore(storeName)),
+ );
+}
+
+export type UseStore = <T>(
+ txMode: IDBTransactionMode,
+ callback: (store: IDBObjectStore) => T | PromiseLike<T>,
+) => Promise<T>;
+
+let defaultGetStoreFunc: UseStore | undefined;
+
+function defaultGetStore() {
+ if (!defaultGetStoreFunc) {
+ defaultGetStoreFunc = createStore("VencordData", "VencordStore");
+ }
+ return defaultGetStoreFunc;
+}
+
+/**
+ * Get a value by its key.
+ *
+ * @param key
+ * @param customStore Method to get a custom store. Use with caution (see the docs).
+ */
+export function get<T = any>(
+ key: IDBValidKey,
+ customStore = defaultGetStore(),
+): Promise<T | undefined> {
+ return customStore("readonly", store => promisifyRequest(store.get(key)));
+}
+
+/**
+ * Set a value with a key.
+ *
+ * @param key
+ * @param value
+ * @param customStore Method to get a custom store. Use with caution (see the docs).
+ */
+export function set(
+ key: IDBValidKey,
+ value: any,
+ customStore = defaultGetStore(),
+): Promise<void> {
+ return customStore("readwrite", store => {
+ store.put(value, key);
+ return promisifyRequest(store.transaction);
+ });
+}
+
+/**
+ * Set multiple values at once. This is faster than calling set() multiple times.
+ * It's also atomic – if one of the pairs can't be added, none will be added.
+ *
+ * @param entries Array of entries, where each entry is an array of `[key, value]`.
+ * @param customStore Method to get a custom store. Use with caution (see the docs).
+ */
+export function setMany(
+ entries: [IDBValidKey, any][],
+ customStore = defaultGetStore(),
+): Promise<void> {
+ return customStore("readwrite", store => {
+ entries.forEach(entry => store.put(entry[1], entry[0]));
+ return promisifyRequest(store.transaction);
+ });
+}
+
+/**
+ * Get multiple values by their keys
+ *
+ * @param keys
+ * @param customStore Method to get a custom store. Use with caution (see the docs).
+ */
+export function getMany<T = any>(
+ keys: IDBValidKey[],
+ customStore = defaultGetStore(),
+): Promise<T[]> {
+ return customStore("readonly", store =>
+ Promise.all(keys.map(key => promisifyRequest(store.get(key)))),
+ );
+}
+
+/**
+ * Update a value. This lets you see the old value and update it as an atomic operation.
+ *
+ * @param key
+ * @param updater A callback that takes the old value and returns a new value.
+ * @param customStore Method to get a custom store. Use with caution (see the docs).
+ */
+export function update<T = any>(
+ key: IDBValidKey,
+ updater: (oldValue: T | undefined) => T,
+ customStore = defaultGetStore(),
+): Promise<void> {
+ return customStore(
+ "readwrite",
+ store =>
+ // Need to create the promise manually.
+ // If I try to chain promises, the transaction closes in browsers
+ // that use a promise polyfill (IE10/11).
+ new Promise((resolve, reject) => {
+ store.get(key).onsuccess = function () {
+ try {
+ store.put(updater(this.result), key);
+ resolve(promisifyRequest(store.transaction));
+ } catch (err) {
+ reject(err);
+ }
+ };
+ }),
+ );
+}
+
+/**
+ * Delete a particular key from the store.
+ *
+ * @param key
+ * @param customStore Method to get a custom store. Use with caution (see the docs).
+ */
+export function del(
+ key: IDBValidKey,
+ customStore = defaultGetStore(),
+): Promise<void> {
+ return customStore("readwrite", store => {
+ store.delete(key);
+ return promisifyRequest(store.transaction);
+ });
+}
+
+/**
+ * Delete multiple keys at once.
+ *
+ * @param keys List of keys to delete.
+ * @param customStore Method to get a custom store. Use with caution (see the docs).
+ */
+export function delMany(
+ keys: IDBValidKey[],
+ customStore = defaultGetStore(),
+): Promise<void> {
+ return customStore("readwrite", (store: IDBObjectStore) => {
+ keys.forEach((key: IDBValidKey) => store.delete(key));
+ return promisifyRequest(store.transaction);
+ });
+}
+
+/**
+ * Clear all values in the store.
+ *
+ * @param customStore Method to get a custom store. Use with caution (see the docs).
+ */
+export function clear(customStore = defaultGetStore()): Promise<void> {
+ return customStore("readwrite", store => {
+ store.clear();
+ return promisifyRequest(store.transaction);
+ });
+}
+
+function eachCursor(
+ store: IDBObjectStore,
+ callback: (cursor: IDBCursorWithValue) => void,
+): Promise<void> {
+ store.openCursor().onsuccess = function () {
+ if (!this.result) return;
+ callback(this.result);
+ this.result.continue();
+ };
+ return promisifyRequest(store.transaction);
+}
+
+/**
+ * Get all keys in the store.
+ *
+ * @param customStore Method to get a custom store. Use with caution (see the docs).
+ */
+export function keys<KeyType extends IDBValidKey>(
+ customStore = defaultGetStore(),
+): Promise<KeyType[]> {
+ return customStore("readonly", store => {
+ // Fast path for modern browsers
+ if (store.getAllKeys) {
+ return promisifyRequest(
+ store.getAllKeys() as unknown as IDBRequest<KeyType[]>,
+ );
+ }
+
+ const items: KeyType[] = [];
+
+ return eachCursor(store, cursor =>
+ items.push(cursor.key as KeyType),
+ ).then(() => items);
+ });
+}
+
+/**
+ * Get all values in the store.
+ *
+ * @param customStore Method to get a custom store. Use with caution (see the docs).
+ */
+export function values<T = any>(customStore = defaultGetStore()): Promise<T[]> {
+ return customStore("readonly", store => {
+ // Fast path for modern browsers
+ if (store.getAll) {
+ return promisifyRequest(store.getAll() as IDBRequest<T[]>);
+ }
+
+ const items: T[] = [];
+
+ return eachCursor(store, cursor => items.push(cursor.value as T)).then(
+ () => items,
+ );
+ });
+}
+
+/**
+ * Get all entries in the store. Each entry is an array of `[key, value]`.
+ *
+ * @param customStore Method to get a custom store. Use with caution (see the docs).
+ */
+export function entries<KeyType extends IDBValidKey, ValueType = any>(
+ customStore = defaultGetStore(),
+): Promise<[KeyType, ValueType][]> {
+ return customStore("readonly", store => {
+ // Fast path for modern browsers
+ // (although, hopefully we'll get a simpler path some day)
+ if (store.getAll && store.getAllKeys) {
+ return Promise.all([
+ promisifyRequest(
+ store.getAllKeys() as unknown as IDBRequest<KeyType[]>,
+ ),
+ promisifyRequest(store.getAll() as IDBRequest<ValueType[]>),
+ ]).then(([keys, values]) => keys.map((key, i) => [key, values[i]]));
+ }
+
+ const items: [KeyType, ValueType][] = [];
+
+ return customStore("readonly", store =>
+ eachCursor(store, cursor =>
+ items.push([cursor.key as KeyType, cursor.value]),
+ ).then(() => items),
+ );
+ });
+}
diff --git a/src/api/index.ts b/src/api/index.ts
index 7c379f9..036fed6 100644
--- a/src/api/index.ts
+++ b/src/api/index.ts
@@ -1,3 +1,4 @@
export * as MessageEvents from "./MessageEvents";
export * as Notices from "./Notices";
export * as Commands from "./Commands";
+export * as DataStore from "./DataStore";