vrchat 1.20.0-next.1752332210 → 1.20.1

package/.github/workflows/ci.yaml

@@ -0,0 +1,44 @@
+on:
+  repository_dispatch:
+    types: [spec_release]
+#on: push
+
+name: Generate VRChat API SDK
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    name: Generate VRChat API SDK
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+      - uses: actions/checkout@v2
+      - name: 'Cache node_modules'
+        uses: actions/cache@v4
+        with:
+          path: node_modules
+          key: ${{ runner.os }}-node-v16-${{ hashFiles('**/generate.sh') }}
+          restore-keys: |
+            ${{ runner.os }}-node-v16
+      - name: Install OpenAPI Generator CLI
+        run: npm install @openapitools/openapi-generator-cli
+      - name: Set OpenAPI Generator version
+        run: ./node_modules/\@openapitools/openapi-generator-cli/main.js version-manager set 6.3.1
+      - name: Generate SDK Client
+        run: bash ./generate.sh
+      - name: Check version number
+        run: |
+          echo "spec_version=$(grep "version" ./package.json | cut -d "\"" -f 4)" >> $GITHUB_ENV
+      - name: Print version number
+        run: echo ${{ env.spec_version }}
+      - name: Deploy SDK back into main branch
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: main
+          folder: .
+          commit-message: "Upgrade Node SDK to spec ${{ env.spec_version }}"
+      - name: Upload to NPM
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          token: ${{ secrets.NPM_TOKEN }}

package/.openapi-generator/FILES

@@ -0,0 +1,8 @@
+.npmignore
+api.ts
+base.ts
+common.ts
+configuration.ts
+index.ts
+package.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+6.2.1

package/.openapi-generator-ignore

@@ -0,0 +1,29 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md
+
+
+# VRChatAPI: Do not modify .gitignore to avoid comitting "dist"
+.gitignore
+README.md
+git_push.sh

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2025 Owners of GitHub organization "vrchatapi" and individual contributors.
+Copyright (c) 2021 Owners of GitHub organisation "vrchatapi" and individual contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -0,0 +1,69 @@
+![](https://github.com/vrchatapi/vrchatapi.github.io/blob/main/static/assets/img/lang/lang_javascript_banner_1500x300.png?raw=true)
+
+# VRChat API Library for JavaScript/TypeScript
+
+A JavaScript/TypeScript/NodeJS client to interact with the unofficial VRChat API. Supports all REST calls specified in the [API specification](https://github.com/vrchatapi/specification).
+
+## Disclaimer
+
+This is the official response of the VRChat Team (from Tupper more specifically) on the usage of the VRChat API.
+
+> Use of the API using applications other than the approved methods (website, VRChat application) are not officially supported. You may use the API for your own application, but keep these guidelines in mind:
+> * We do not provide documentation or support for the API.
+> * Do not make queries to the API more than once per 60 seconds.
+> * Abuse of the API may result in account termination.
+> * Access to API endpoints may break at any given time, with no warning.
+
+As stated, this documentation was not created with the help of the official VRChat team. Therefore this documentation is not an official documentation of the VRChat API and may not be always up to date with the latest versions. If you find that a page or endpoint is not longer valid please create an issue and tell us so we can fix it.
+
+## Getting Started
+
+First add the package to to your project:
+```bash
+npm install vrchat
+```
+
+Below is an example on how to login to the API and fetch your own user information.
+
+```javascript
+// Step 1. We begin with creating a Configuration, which contains the username and password for authentication, as well as an options dictionary, which contains the user agent header.
+const vrchat = require("vrchat");
+
+const configuration = new vrchat.Configuration({
+    username: "username",
+    password: "password"
+});
+
+const options = { headers: { "User-Agent": "ExampleProgram/0.0.1 my@email.com"}};
+
+// Step 2. VRChat consists of several API's (WorldsApi, UsersApi, FilesApi, NotificationsApi, FriendsApi, etc...)
+// Here we instantiate the Authentication API which is required for logging in.
+const AuthenticationApi = new vrchat.AuthenticationApi(configuration);
+
+// Step 3. Calling getCurrentUser on Authentication API logs you in if the user isn't already logged in.
+AuthenticationApi.getCurrentUser(options).then(async resp => {
+    var currentUser = resp.data;
+
+    // Step 3.5. Calling email verify2fa if the account has 2FA disabled
+    if (currentUser["requiresTwoFactorAuth"] && currentUser["requiresTwoFactorAuth"][0] === "emailOtp") {
+        await AuthenticationApi.verify2FAEmailCode({ code: "123456" }, options)
+        currentUser = (await AuthenticationApi.getCurrentUser(options)).data;
+    }
+
+    // Step 3.5. Calling verify2fa if the account has 2FA enabled
+    if (currentUser["requiresTwoFactorAuth"] && currentUser["requiresTwoFactorAuth"][0] === "totp") {
+        await AuthenticationApi.verify2FA({ code: "123456" }, options)
+        currentUser = (await AuthenticationApi.getCurrentUser(options)).data;
+    }
+    
+    console.log(`Logged in as: ${currentUser.displayName}`);
+});
+```
+
+See [example.js](https://github.com/vrchatapi/vrchatapi-javascript/blob/master/example.js) for more example usage on getting started.
+
+## Contributing
+
+Contributions are welcome, but do not add features that should be handled by the OpenAPI specification.
+
+Join the [Discord server](https://discord.gg/Ge2APMhPfD) to get in touch with us.