@ovencord/util 1.1.1

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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
+
+   Copyright 2022 Noel Buechler
+
+   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.

package/README.md

@@ -0,0 +1,67 @@
+<div align="center">
+	<br />
+	<p>
+		<a href="https://discord.js.org"><img src="https://discord.js.org/static/logo.svg" width="546" alt="discord.js" /></a>
+	</p>
+	<br />
+	<p>
+		<a href="https://discord.gg/djs"><img src="https://img.shields.io/badge/join_us-on_discord-5865F2?logo=discord&logoColor=white" alt="Discord server" /></a>
+		<a href="https://github.com/ovencord/ovencord/actions"><img src="https://github.com/ovencord/ovencord/actions/workflows/tests.yml/badge.svg" alt="Build status" /></a>
+		<a href="https://github.com/ovencord/ovencord/commits/main/packages/util"><img alt="Last commit." src="https://img.shields.io/github/last-commit/ovencord/ovencord?logo=github&logoColor=ffffff&path=packages%2Futil" /></a>
+		<a href="https://opencollective.com/discordjs"><img src="https://img.shields.io/opencollective/backers/discordjs?maxAge=3600&logo=opencollective" alt="backers" /></a>
+	</p>
+	<p>
+		<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/ovencord/ovencord/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
+		<a href="https://www.cloudflare.com"><img src="https://raw.githubusercontent.com/ovencord/ovencord/main/.github/powered-by-workers.png" alt="Cloudflare Workers" height="44" /></a>
+	</p>
+</div>
+
+## About
+
+`@ovencord/util` is a collection of utility functions for use with discord.js.
+
+## Installation
+
+**Node.js 22.12.0 or newer is required.**
+
+```sh
+npm install @ovencord/util
+yarn add @ovencord/util
+pnpm add @ovencord/util
+bun add @ovencord/util
+```
+
+## Links
+
+- [Website][website] ([source][website-source])
+- [Documentation][documentation]
+- [Guide][guide] ([source][guide-source])
+  Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
+- [discord.js Discord server][discord]
+- [Discord Developers Discord server][discord-developers]
+- [GitHub][source]
+- [npm][npm]
+- [Related libraries][related-libs]
+
+## Contributing
+
+Before creating an issue, please ensure that it hasn't already been reported/suggested, and double-check the
+[documentation][documentation].  
+See [the contribution guide][contributing] if you'd like to submit a PR.
+
+## Help
+
+If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js Server][discord].
+
+[website]: https://discord.js.org
+[website-source]: https://github.com/ovencord/ovencord/tree/main/apps/website
+[documentation]: https://discord.js.org/docs/packages/util/stable
+[guide]: https://discordjs.guide
+[guide-source]: https://github.com/ovencord/ovencord/tree/main/apps/guide
+[guide-update]: https://discordjs.guide/legacy/additional-info/changes-in-v14
+[discord]: https://discord.gg/djs
+[discord-developers]: https://discord.gg/discord-developers
+[source]: https://github.com/ovencord/ovencord/tree/main/packages/util
+[npm]: https://www.npmjs.com/package/@ovencord/util
+[related-libs]: https://discord.com/developers/docs/topics/community-resources#libraries
+[contributing]: https://github.com/ovencord/ovencord/blob/main/.github/CONTRIBUTING.md

package/package.json

@@ -0,0 +1,55 @@
+{
+	"$schema": "https://json.schemastore.org/package.json",
+	"name": "@ovencord/util",
+	"version": "1.1.1",
+	"description": "Utilities shared across Discord.js packages",
+	"scripts": {
+		"test": "bun test",
+		"typecheck": "tsc --noEmit",
+		"lint": "eslint src"
+	},
+	"type": "module",
+	"exports": "./src/index.ts",
+	"main": "./src/index.ts",
+	"types": "./src/index.ts",
+	"contributors": [
+		"Ovencord Contributors"
+	],
+	"license": "Apache-2.0",
+	"keywords": [
+		"api",
+		"bot",
+		"client",
+		"node",
+		"discordjs"
+	],
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/ovencord/ovencord.git",
+		"directory": "packages/util"
+	},
+	"bugs": {
+		"url": "https://github.com/ovencord/ovencord/issues"
+	},
+	"homepage": "https://ovencord.dev",
+	"funding": "https://github.com/ovencord/ovencord?sponsor",
+	"dependencies": {
+		"discord-api-types": "^0.38.36"
+	},
+	"devDependencies": {
+		"@types/bun": "^1.3.8",
+		"eslint": "^9.39.2",
+		"typescript": "^5.9.3",
+		"typescript-eslint": "^8.54.0"
+	},
+	"engines": {
+		"bun": ">=1.0.0"
+	},
+	"publishConfig": {
+		"access": "public"
+	},
+	"module": "./src/index.ts",
+	"files": [
+		"src"
+	]
+}

package/src/AsyncEventEmitter.ts

@@ -0,0 +1,28 @@
+import { EventEmitter } from 'node:events';
+
+/**
+ * A typed EventEmitter shim to replace @vladfrangu/async_event_emitter
+ * This version uses the native node:events EventEmitter.
+ * Note: strict async emission (awaiting listeners) is not implemented as it was not used by the library internally.
+ */
+export class AsyncEventEmitter<TEvents extends { [K in keyof TEvents]: any[] }> extends EventEmitter {
+	public override on<K extends keyof TEvents & string>(event: K, listener: (...args: TEvents[K]) => void): this {
+		return super.on(event, listener as any);
+	}
+
+	public override once<K extends keyof TEvents & string>(event: K, listener: (...args: TEvents[K]) => void): this {
+		return super.once(event, listener as any);
+	}
+
+	public override emit<K extends keyof TEvents & string>(event: K, ...args: TEvents[K]): boolean {
+		return super.emit(event, ...args);
+	}
+
+	public override off<K extends keyof TEvents & string>(event: K, listener: (...args: TEvents[K]) => void): this {
+		return super.off(event, listener as any);
+	}
+
+    public override removeListener<K extends keyof TEvents & string>(event: K, listener: (...args: TEvents[K]) => void): this {
+        return super.removeListener(event, listener as any);
+    }
+}

package/src/AsyncQueue.ts

@@ -0,0 +1,64 @@
+/**
+ * A simple asynchronous queue implementation
+ */
+export class AsyncQueue {
+	#promises: Array<{ promise: Promise<void>; resolve: () => void }> = [];
+
+	/**
+	 * The remaining number of requests in the queue
+	 */
+	public get remaining(): number {
+		return this.#promises.length;
+	}
+
+	/**
+	 * Waits for the queue to be free
+	 * @param options - Options for the wait
+	 * @param options.signal - An optional abort signal
+	 */
+	public wait(options?: { signal?: AbortSignal }): Promise<void> {
+		const next = this.#promises.length ? this.#promises.at(-1)!.promise : Promise.resolve();
+
+		let resolve!: () => void;
+		const promise = new Promise<void>((res) => {
+			resolve = res;
+		});
+
+		this.#promises.push({ promise, resolve });
+
+        // If no signal, just return the promise we wait on
+        if (!options?.signal) {
+            return next;
+        }
+
+        return new Promise((res, rej) => {
+            if (options.signal!.aborted) {
+                // Bridge immediately: when next resolves, we resolve our token
+                next.then(() => resolve());
+                rej(new Error('AbortError')); // TODO: Use DOMException or standard AbortError if available
+                return;
+            }
+
+            const abortHandler = () => {
+                // Bridge: when next resolves, we resolve our token
+                next.then(() => resolve());
+                rej(new Error('AbortError'));
+            };
+
+            options.signal!.addEventListener('abort', abortHandler, { once: true });
+
+            next.then(() => {
+                options.signal!.removeEventListener('abort', abortHandler);
+                res();
+            });
+        });
+	}
+
+	/**
+	 * Shifts the queue, allowing the next task to run
+	 */
+	public shift(): void {
+		const item = this.#promises.shift();
+		item?.resolve();
+	}
+}

package/src/Equatable.ts

@@ -0,0 +1,21 @@
+/**
+ * Represents a structure that can be checked against another
+ * given structure for equality
+ *
+ * @typeParam Value - The type of object to compare the current object to
+ */
+export interface Equatable<Value> {
+	/**
+	 * Whether or not this is equal to another structure
+	 */
+	equals(other: Value): boolean;
+}
+
+/**
+ * Indicates if an object is equatable or not.
+ *
+ * @param maybeEquatable - The object to check against
+ */
+export function isEquatable(maybeEquatable: unknown): maybeEquatable is Equatable<unknown> {
+	return maybeEquatable !== null && typeof maybeEquatable === 'object' && 'equals' in maybeEquatable;
+}

package/src/RawFile.ts

@@ -0,0 +1,33 @@
+
+/**
+ * Represents a file to be added to a request with multipart/form-data encoding
+ */
+export interface RawFile {
+	/**
+	 * Content-Type of the file.
+	 * If not provided, it will be inferred from the file data when possible
+	 *
+	 * @example 'image/png'
+	 * @example 'application/pdf'
+	 */
+	contentType?: string;
+	/**
+	 * The actual data for the file
+	 */
+	data: Uint8Array | boolean | number | string;
+	/**
+	 * An explicit key to use for the formdata field for this file.
+	 * When not provided, the index of the file in the files array is used in the form `files[${index}]`.
+	 * If you wish to alter the placeholder snowflake, you must provide this property in the same form (`files[${placeholder}]`)
+	 */
+	key?: string;
+	/**
+	 * The name of the file. This is the actual filename that will be used when uploading to Discord.
+	 * This is also the name you'll use to reference the file with attachment:// URLs.
+	 *
+	 * @example 'image.png'
+	 * @example 'document.pdf'
+	 * @example 'SPOILER_secret.jpeg'
+	 */
+	name: string;
+}

package/src/encodables.ts

@@ -0,0 +1,61 @@
+import type { RawFile } from './RawFile.js';
+
+/**
+ * Represents an object capable of representing itself as a JSON object
+ *
+ * @typeParam Value - The JSON type corresponding to {@link JSONEncodable.toJSON} outputs.
+ */
+export interface JSONEncodable<Value> {
+	/**
+	 * Transforms this object to its JSON format
+	 */
+	toJSON(): Value;
+}
+
+/**
+ * Indicates if an object is encodable or not.
+ *
+ * @param maybeEncodable - The object to check against
+ */
+export function isJSONEncodable(maybeEncodable: unknown): maybeEncodable is JSONEncodable<unknown> {
+	return maybeEncodable !== null && typeof maybeEncodable === 'object' && 'toJSON' in maybeEncodable;
+}
+
+/**
+ * Result of encoding an object that includes file attachments
+ *
+ * @typeParam BodyValue - The JSON body type
+ */
+export interface FileBodyEncodableResult<BodyValue> {
+	/**
+	 * The JSON body to send with the request
+	 */
+	body: BodyValue;
+	/**
+	 * The files to attach to the request
+	 */
+	files: RawFile[];
+}
+
+/**
+ * Represents an object capable of representing itself as a request body with file attachments.
+ * Objects implementing this interface can separate JSON body data from binary file data,
+ * which is necessary for multipart/form-data requests.
+ *
+ * @typeParam BodyValue - The JSON body type
+ */
+export interface FileBodyEncodable<BodyValue> {
+	/**
+	 * Transforms this object to its file body format, separating the JSON body from file attachments.
+	 */
+	toFileBody(): FileBodyEncodableResult<BodyValue>;
+}
+
+/**
+ * Indicates if an object is file body encodable or not.
+ *
+ * @param maybeEncodable - The object to check against
+ */
+export function isFileBodyEncodable(maybeEncodable: unknown): maybeEncodable is FileBodyEncodable<unknown> {
+	return maybeEncodable !== null && typeof maybeEncodable === 'object' && 'toFileBody' in maybeEncodable;
+}

package/src/functions/calculateShardId.ts

@@ -0,0 +1,9 @@
+/**
+ * Calculates the shard id for a given guild id.
+ *
+ * @param guildId - The guild id to calculate the shard id for
+ * @param shardCount - The total number of shards
+ */
+export function calculateShardId(guildId: string, shardCount: number) {
+	return Number(BigInt(guildId) >> 22n) % shardCount;
+}

package/src/functions/embedLength.ts

@@ -0,0 +1,16 @@
+import type { APIEmbed } from 'discord-api-types/v10';
+
+/**
+ * Calculates the length of an embed.
+ *
+ * @param data - The embed data to check
+ */
+export function embedLength(data: APIEmbed) {
+	return (
+		(data.title?.length ?? 0) +
+		(data.description?.length ?? 0) +
+		(data.fields?.reduce((prev, curr) => prev + curr.name.length + curr.value.length, 0) ?? 0) +
+		(data.footer?.text.length ?? 0) +
+		(data.author?.name.length ?? 0)
+	);
+}

package/src/functions/index.ts

@@ -0,0 +1,6 @@
+export * from './calculateShardId.js';
+export * from './embedLength.js';
+export * from './lazy.js';
+export * from './range.js';
+export * from './runtime.js';
+export * from './userAgentAppendix.js';

package/src/functions/lazy.ts

@@ -0,0 +1,18 @@
+/**
+ * Lazy is a wrapper around a value that is computed lazily. It is useful for
+ * cases where the value is expensive to compute and the computation may not
+ * be needed at all.
+ *
+ * @param cb - The callback to lazily evaluate
+ * @typeParam Value - The type of the value
+ * @example
+ * ```ts
+ * const value = lazy(() => computeExpensiveValue());
+ * ```
+ */
+// eslint-disable-next-line
+export function lazy<Value>(cb: () => Value): () => Value {
+	let defaultValue: Value;
+	// eslint-disable-next-line
+	return () => (defaultValue ??= cb());
+}

package/src/functions/range.ts

@@ -0,0 +1,61 @@
+/**
+ * Options for creating a range
+ */
+export interface RangeOptions {
+	/**
+	 * The end of the range (exclusive)
+	 */
+	end: number;
+	/**
+	 * The start of the range (inclusive)
+	 */
+	start: number;
+	/**
+	 * The amount to increment by
+	 *
+	 * @defaultValue `1`
+	 */
+	step?: number;
+}
+
+/**
+ * A generator to yield numbers in a given range
+ *
+ * @remarks
+ * This method is end-exclusive, for example the last number yielded by `range(5)` is 4. If you
+ * prefer for the end to be included add 1 to the range or `end` option.
+ * @param range - A number representing the range to yield (exclusive) or an object with start, end and step
+ * @example
+ * Basic range
+ * ```ts
+ * for (const number of range(5)) {
+ *  console.log(number);
+ * }
+ * // Prints 0, 1, 2, 3, 4
+ * ```
+ * @example
+ * Range with a step
+ * ```ts
+ * for (const number of range({ start: 3, end: 10, step: 2 })) {
+ * 	console.log(number);
+ * }
+ * // Prints 3, 5, 7, 9
+ * ```
+ */
+export function* range(range: RangeOptions | number) {
+	let rangeEnd: number;
+	let start = 0;
+	let step = 1;
+
+	if (typeof range === 'number') {
+		rangeEnd = range;
+	} else {
+		start = range.start;
+		rangeEnd = range.end;
+		step = range.step ?? 1;
+	}
+
+	for (let index = start; index < rangeEnd; index += step) {
+		yield index;
+	}
+}

package/src/functions/runtime.ts

@@ -0,0 +1,14 @@
+
+
+export function shouldUseGlobalFetchAndWebSocket() {
+	// Browser env and deno when ran directly
+	if (typeof globalThis.process === 'undefined') {
+		return 'fetch' in globalThis && 'WebSocket' in globalThis;
+	}
+
+	if ('versions' in globalThis.process) {
+		return 'deno' in globalThis.process.versions || 'bun' in globalThis.process.versions;
+	}
+
+	return false;
+}

package/src/functions/userAgentAppendix.ts

@@ -0,0 +1,50 @@
+
+
+/**
+ * Resolves the user agent appendix string for the current environment.
+ */
+export function getUserAgentAppendix(): string {
+	// https://vercel.com/docs/concepts/functions/edge-functions/edge-runtime#check-if-you're-running-on-the-edge-runtime
+	// @ts-expect-error Vercel Edge functions
+	if (typeof globalThis.EdgeRuntime !== 'undefined') {
+		return 'Vercel-Edge-Functions';
+	}
+
+	// @ts-expect-error Cloudflare Workers
+	if (typeof globalThis.R2 !== 'undefined' && typeof globalThis.WebSocketPair !== 'undefined') {
+		// https://developers.cloudflare.com/workers/runtime-apis/web-standards/#navigatoruseragent
+		return 'Cloudflare-Workers';
+	}
+
+	// https://docs.netlify.com/edge-functions/api/#netlify-global-object
+	// @ts-expect-error Netlify Edge functions
+	if (typeof globalThis.Netlify !== 'undefined') {
+		return 'Netlify-Edge-Functions';
+	}
+
+	// Most (if not all) edge environments will have `process` defined. Within a web browser we'll extract it using `navigator.userAgent`.
+	if (typeof globalThis.process !== 'object') {
+		if (typeof globalThis.navigator === 'object') {
+			return globalThis.navigator.userAgent;
+		}
+
+		return 'UnknownEnvironment';
+	}
+
+	const versions = (globalThis.process as any).versions;
+	if (versions) {
+		if ('deno' in versions) {
+			return `Deno/${versions.deno}`;
+		}
+
+		if ('bun' in versions) {
+			return `Bun/${versions.bun}`;
+		}
+
+		if ('node' in versions) {
+			return `Node.js/${versions.node}`;
+		}
+	}
+
+	return 'UnknownEnvironment';
+}

package/src/gatewayRateLimitError.ts

@@ -0,0 +1,25 @@
+import type { GatewayOpcodeRateLimitMetadataMap, GatewayRateLimitedDispatchData } from 'discord-api-types/v10';
+
+/**
+ * Represents the error thrown when the gateway emits a `RATE_LIMITED` event after a certain request.
+ */
+export class GatewayRateLimitError extends Error {
+	public override readonly name = GatewayRateLimitError.name;
+
+	public constructor(
+		/**
+		 * The data associated with the rate limit event
+		 */
+		public readonly data: GatewayRateLimitedDispatchData<keyof GatewayOpcodeRateLimitMetadataMap>,
+		/**
+		 * The payload data that lead to this rate limit
+		 *
+		 * @privateRemarks
+		 * Too complicated to type properly here (i.e. extract the ['data']
+		 * of event payloads that have t = keyof GatewayOpcodeRateLimitMetadataMap)
+		 */
+		public readonly payload: unknown,
+	) {
+		super(`Request with opcode ${data.opcode} was rate limited. Retry after ${data.retry_after} seconds.`);
+	}
+}

package/src/index.ts

@@ -0,0 +1,16 @@
+export type * from './types.js';
+export * from './functions/index.js';
+export * from './encodables.js';
+export type * from './RawFile.js';
+export * from './Equatable.js';
+export * from './gatewayRateLimitError.js';
+export * from './AsyncEventEmitter.js';
+export * from './AsyncQueue.js';
+
+/**
+ * The {@link https://github.com/ovencord/ovencord/blob/main/packages/util#readme | @ovencord/util} version
+ * that you are currently using.
+ *
+ * @privateRemarks This needs to explicitly be `string` so it is not typed as a "const string" that gets injected by esbuild.
+ */
+export const version = '[VI]{{inject}}[/VI]' as string;

package/src/shims.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Type Shims for Bun Native Environment
+ * 
+ * This file provides type declarations to eliminate conflicts between
+ * @types/node and @types/bun, allowing clean TypeScript compilation
+ * in a pure Bun environment.
+ */
+
+declare global {
+	/**
+	 * Minimal NodeJS namespace declarations for compatibility with libraries
+	 * that reference Node.js types but run in Bun runtime.
+	 */
+	namespace NodeJS {
+		/**
+		 * TypedArray union type - maps to Web Standard TypedArrays
+		 */
+		type TypedArray =
+			| Uint8Array
+			| Uint8ClampedArray
+			| Uint16Array
+			| Uint32Array
+			| Int8Array
+			| Int16Array
+			| Int32Array
+			| Float32Array
+			| Float64Array
+			| BigUint64Array
+			| BigInt64Array;
+
+		/**
+		 * Error with errno code - compatible with Bun's error handling
+		 */
+		interface ErrnoException extends Error {
+			errno?: number | undefined;
+			code?: string | undefined;
+			path?: string | undefined;
+			syscall?: string | undefined;
+		}
+
+		/**
+		 * Process CWD function - maps to Bun.cwd()
+		 */
+		interface Process {
+			cwd(): string;
+			env: Record<string, string | undefined>;
+			platform: string;
+		}
+
+		interface Timeout extends Number {}
+	}
+	
+	// Global declarations
+	var process: NodeJS.Process;
+	var __dirname: string;
+	var __filename: string;
+}
+
+export {};

package/src/types.ts

@@ -0,0 +1,4 @@
+/**
+ * Represents a type that may or may not be a promise
+ */
+export type Awaitable<Value> = PromiseLike<Value> | Value;