docs: export all visible symbols (#10760)

* docs: export all visible symbols

* fix: discord.js except raw

* refactor: remove raw data types

* docs: add back discord.js tsdoc file

* refactor: remove underscores

* fix: merge

* docs(RPCRedis): make `promises` as internal

---------

Co-authored-by: Qjuh <[email protected]>
Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>

Author: 3 people

packages/brokers/src/brokers/redis/RPCRedis.ts

@@ -63,6 +63,9 @@ export class RPCRedisBroker<TEvents extends Record<string, any[]>, TResponses ex
 	 */
 	protected override readonly options: Required<RPCRedisBrokerOptions>;
 
+	/**
+	 * @internal
+	 */
 	protected readonly promises = new Map<string, InternalPromise>();
 
 	public constructor(redisClient: Redis, options: RPCRedisBrokerOptions) {

packages/builders/src/index.ts

@@ -86,7 +86,7 @@ export * from './messages/MessageReference.js';
 export * from './util/componentUtil.js';
 export * from './util/normalizeArray.js';
 export * from './util/resolveBuilder.js';
-export * from './util/validation.js';
+export { disableValidators, enableValidators, isValidationEnabled } from './util/validation.js';
 
 export * from './Assertions.js';
 

packages/collection/src/collection.ts

@@ -1106,12 +1106,6 @@ export class Collection<Key, Value> extends Map<Key, Value> {
 	declare public static readonly [Symbol.species]: typeof Collection;
 }
 
-/**
- * @internal
- */
 export type Keep<Value> = { keep: false } | { keep: true; value: Value };
 
-/**
- * @internal
- */
 export type Comparator<Key, Value> = (firstValue: Value, secondValue: Value, firstKey: Key, secondKey: Key) => number;

packages/discord.js/.gitignore

@@ -28,4 +28,3 @@ docs/**/*
 
 # Generated files
 typings/index.d.mts
-typings/rawDataTypes.d.mts

packages/discord.js/scripts/esmDts.mjs

@@ -1,38 +1,6 @@
-import { readFile, writeFile } from 'node:fs/promises';
+import { cp } from 'node:fs/promises';
 
-const rawTypesDTS = new URL('../typings/rawDataTypes.d.ts', import.meta.url);
 const rawIndexDTS = new URL('../typings/index.d.ts', import.meta.url);
-
-const rawTypesMDTS = new URL('../typings/rawDataTypes.d.mts', import.meta.url);
 const rawIndexMTS = new URL('../typings/index.d.mts', import.meta.url);
 
-const [rawTypesString, rawIndexString] = await Promise.all([
-  readFile(rawTypesDTS, 'utf8'),
-  readFile(rawIndexDTS, 'utf8'),
-]);
-
-/**
- *
- * @param {string} source
- * @param {[from: string, to: string][]} imports
- */
-function updateImports(source, imports) {
-  return imports.reduce((code, [from, to]) => {
-    return code.replaceAll(from, to);
-  }, source);
-}
-
-/** @type {[string, string][]} */
-const rawTypesImports = [
-  ['./index.js', './index.mjs'], //
-];
-
-/** @type {[string, string][]} */
-const rawIndexImports = [
-  ['./rawDataTypes.js', './rawDataTypes.mjs'], //
-];
-
-const rawTypesMDTSString = updateImports(rawTypesString, rawTypesImports);
-const rawIndexMTSString = updateImports(rawIndexString, rawIndexImports);
-
-await Promise.all([writeFile(rawTypesMDTS, rawTypesMDTSString), writeFile(rawIndexMTS, rawIndexMTSString)]);
+await cp(rawIndexDTS, rawIndexMTS);

packages/discord.js/src/index.js

@@ -45,7 +45,17 @@ exports.ThreadMemberFlagsBitField = require('./util/ThreadMemberFlagsBitField.js
 exports.UserFlagsBitField = require('./util/UserFlagsBitField.js').UserFlagsBitField;
 
 __exportStar(require('./util/DataResolver.js'), exports);
-__exportStar(require('./util/Util.js'), exports);
+
+exports.cleanCodeBlockContent = require('./util/Util.js').cleanCodeBlockContent;
+exports.cleanContent = require('./util/Util.js').cleanContent;
+exports.discordSort = require('./util/Util.js').discordSort;
+exports.fetchRecommendedShardCount = require('./util/Util.js').fetchRecommendedShardCount;
+exports.flatten = require('./util/Util.js').flatten;
+exports.parseEmoji = require('./util/Util.js').parseEmoji;
+exports.parseWebhookURL = require('./util/Util.js').parseWebhookURL;
+exports.resolveColor = require('./util/Util.js').resolveColor;
+exports.resolveSKUId = require('./util/Util.js').resolveSKUId;
+exports.verifyString = require('./util/Util.js').verifyString;
 
 exports.version = require('../package.json').version;
 

packages/discord.js/src/util/Util.js

@@ -521,25 +521,28 @@ function resolveSKUId(resolvable) {
   return null;
 }
 
-exports.flatten = flatten;
+// Public
+exports.cleanCodeBlockContent = cleanCodeBlockContent;
+exports.cleanContent = cleanContent;
+exports.discordSort = discordSort;
 exports.fetchRecommendedShardCount = fetchRecommendedShardCount;
+exports.flatten = flatten;
 exports.parseEmoji = parseEmoji;
+exports.parseWebhookURL = parseWebhookURL;
+exports.resolveColor = resolveColor;
+exports.resolveSKUId = resolveSKUId;
+exports.verifyString = verifyString;
+
+// Private
 exports.resolvePartialEmoji = resolvePartialEmoji;
 exports.resolveGuildEmoji = resolveGuildEmoji;
 exports.makeError = makeError;
 exports.makePlainError = makePlainError;
 exports.getSortableGroupTypes = getSortableGroupTypes;
 exports.moveElementInArray = moveElementInArray;
-exports.verifyString = verifyString;
-exports.resolveColor = resolveColor;
-exports.discordSort = discordSort;
 exports.setPosition = setPosition;
 exports.basename = basename;
-exports.cleanContent = cleanContent;
-exports.cleanCodeBlockContent = cleanCodeBlockContent;
-exports.parseWebhookURL = parseWebhookURL;
 exports.transformResolved = transformResolved;
-exports.resolveSKUId = resolveSKUId;
 
 // Fixes Circular
 const { Attachment } = require('../structures/Attachment.js');

packages/discord.js/tsdoc.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["@discordjs/api-extractor/extends/tsdoc-base.json"],
+  "tagDefinitions": [
+    {
+      "tagName": "@unstable",
+      "syntaxKind": "modifier"
+    }
+  ],
+  "supportForTags": {
+    "@unstable": true
+  }
+}