feat: ship duel esm & cjs

Author: ariesclark

example/index.ts

@@ -18,6 +18,7 @@
     "vrchat": "^1.19.4"
   },
   "devDependencies": {
-    "@types/prompts": "^2.4.9"
+    "@types/prompts": "^2.4.9",
+    "typescript": "^5.8.3"
   }
 }

example/package.json

@@ -0,0 +1,40 @@
+import KeyvFile from "keyv-file";
+import prompts from "prompts";
+import { VRChat } from "vrchat";
+
+const vrchat = new VRChat({
+	application: {
+		name: "Example",
+		version: "1.5.1",
+		contact: "timmy@examaple.com"
+	},
+	authentication: {
+		optimistic: false,
+		credentials: () => prompts([
+			{
+				name: "username",
+				type: "text",
+				message: "VRChat username",
+			},
+			{
+				name: "password",
+				type: "password",
+				message: "VRChat password",
+			},
+			{
+				name: "twoFactorCode",
+				type: "text",
+				message: "Two-factor authentication code",
+			}
+		]),
+	},
+	keyv: new KeyvFile({ filename: "./data.json" }),
+});
+
+(async () => {
+	await vrchat.getCurrentSubscriptions({ throwOnError: true });
+	const { data: { displayName } } = await vrchat.getCurrentUser({ throwOnError: true });
+	// eslint-disable-next-line no-console
+	console.log(`Logged in as ${displayName}`);
+	// await Promise.all(Array.from({ length: 10 }).map(() => vrchat.getCurrentOnlineUsers({ throwOnError: true })));
+})();

example/pnpm-lock.yaml

@@ -0,0 +1,115 @@
+/* eslint-disable no-console */
+import KeyvFile from "keyv-file";
+import prompts from "prompts";
+import { VRChat, VRChatError } from "vrchat";
+
+const vrchat = new VRChat({
+	/**
+	 * When using the VRChat API, you must provide an application name, version, and contact information.
+	 * This is used to identify your application to VRChat, and to provide support if needed.
+	 */
+	application: {
+		name: "Example",
+		version: "1.5.1",
+		/**
+		 * An email, or a URL to a support page.
+		 */
+		contact: "timmy@examaple.com"
+	},
+	/**
+	 * Save cookies to a file, so you can use them later.
+	 *
+	 * This is optional, but recommended for persistent sessions.
+	 * If you don't provide a `keyv` instance, it will use an in-memory store.
+	 *
+	 * You can use any Keyv-compatible adapter for this, such as `keyv-file`, `@keyv/redis`, or `@keyv/postgres`.
+	 * See https://keyv.org/docs/keyv/#official-storage-adapters for more information.
+	 */
+	keyv: new KeyvFile({ filename: "./data.json" }),
+});
+
+(async () => {
+	const { data: user } = await vrchat
+		.getCurrentUser({ throwOnError: true })
+		// Since we've passed `throwOnError: true`, this will throw an error if the user is not logged in.
+		// We can catch that error and prompt the user for their credentials.
+		.catch(async (reason) => {
+			// Rethrow the error if it's not a 401 Unauthorized error.
+			if (!(reason instanceof VRChatError) || reason.statusCode !== 401)
+				throw reason;
+
+			/**
+			 * Ask the user for their VRChat username and password.
+			 * You can also use environment variables, or any other method to get the credentials.
+			 */
+			const { username, password } = await prompts([
+				{
+					name: "username",
+					type: "text",
+					message: "VRChat username",
+				},
+				{
+					name: "password",
+					type: "password",
+					message: "VRChat password",
+				},
+			]);
+
+			return vrchat.login({
+				username,
+				password,
+				/**
+				 * This function will be called when two-factor authentication is required.
+				 * Accepts any code, such as from an authenticator app or a recovery code.
+				 */
+				twoFactorCode: async () => {
+					const { code } = await prompts({
+						name: "code",
+						type: "text",
+						message: "Two-factor authentication code",
+					});
+
+					return code;
+				},
+				/**
+				 * Or, automatically generate a code from a secret.
+				 * Useful for service accounts & automated workflows.
+				 *
+				 * If this is a user-initiated login, don't use this.
+				 */
+				// totpSecret: "",
+				throwOnError: true,
+			});
+		});
+
+	console.log(`Logged in as ${user.displayName} (id: ${user.id}).`);
+
+	/**
+	 * Get 10 online friends, you can change the `n` parameter to get more or less friends.
+	 * Exercise: You can also use the `offline` query parameter to include offline friends.
+	 */
+	const { data: friends } = await vrchat.getFriends({ query: { n: 10 }, throwOnError: true });
+
+	console.log(
+		friends.length > 0
+			? "Your friends:"
+			: "Aw, you don't have any online friends."
+	);
+	for (const friend of friends) {
+		console.log(`- ${friend.displayName} (id: ${friend.id})`);
+	}
+
+	const tupperId = "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469";
+
+	await vrchat
+		// Add Tupper as a friend, he's a nice guy.
+		.friend({ path: { userId: tupperId }, throwOnError: true })
+		// If we've already sent one, we'll catch the error and ignore it.
+		.catch(() => { });
+
+	const { data: { outgoingRequest } } = await vrchat
+		.getFriendStatus({ path: { userId: tupperId }, throwOnError: true });
+
+	// Tupper ghosted our friend request, so let's delete it.
+	if (outgoingRequest) await vrchat.deleteFriendRequest({ path: { userId: tupperId }, throwOnError: true });
+})();

example/src/automatic-sessions.ts

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Node 16",
+  "compilerOptions": {
+    "target": "ES2021",
+    "lib": [
+      "ES2021"
+    ],
+    "module": "commonjs",
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "outDir": "./dist"
+  }
+}

example/src/default.ts

@@ -59,7 +59,7 @@ export default defineConfig({
 			asClass: true,
 			instance: true,
 			transformer: true,
-			classNameBuilder: () => "_VRChat",
+			classNameBuilder: () => "VRChatInternal",
 		},
 		customPlugin as any
 	],

example/tsconfig.json

@@ -1,9 +1,8 @@
 {
   "name": "vrchat",
-  "version": "2.0.0",
-  "type": "module",
+  "version": "0.0.0-next.0",
   "description": "",
-  "main": "dist/index.js",
+  "type": "commonjs",
   "types": "dist/index.d.ts",
   "homepage": "https://vrchat.community/javascript",
   "repository": "vrchatapi/vrchatapi-javascript",
@@ -13,6 +12,13 @@
   "files": [
     "dist"
   ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "scripts": {
     "prebuild": "rm src/generated -rf && openapi-ts",
     "build": "tsup"

openapi-ts.config.ts

@@ -11,7 +11,7 @@
 		/* Language and Environment */
 		"target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
 		"lib": [
-			"es2022",
+			"esnext",
 			"dom"
 		],
 		// "jsx": "preserve",                                /* Specify what JSX code is generated. */

package.json

@@ -1,17 +1,19 @@
 import { defineConfig } from "tsup";
 
-import * as package_ from "./package.json";
+import { version } from "./package.json";
 
 export default defineConfig({
 	entry: ["src/index.ts"],
-	format: "esm",
+	format: [
+		"esm",
+		"cjs"
+	],
 	dts: true,
 	sourcemap: true,
 	// treeshake: true,
 	minify: true,
 	clean: true,
 	env: {
-		VERSION: package_.version,
-		ISSUE_URL: package_.bugs.url,
+		VERSION: version
 	}
 });