vrc-packages-api-preview 2026.10.6-pre → 2026.10.8-pre
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +58 -43
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,63 +1,78 @@
|
|
|
1
|
-
|
|
1
|
+
<!-- LOCKED DOCUMENTATION - DO NOT CHANGE -->
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
# VRC Packages API
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
This package supplies the consumer SDK and schemas for operator, user and application APIs. VRC Packages (VRCP) is an open-source discovery and indexing network engine for public VRChat creator packages (Tools, Assets, & Avatars).
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
Version configs select their versions. Preview uses CalVer with a `pre` suffix.
|
|
9
|
-
Version zero retains no aliases for the old client/options/error names. Package aliases do not add retired API exports.
|
|
7
|
+
---
|
|
10
8
|
|
|
11
|
-
|
|
9
|
+
## Using this service
|
|
12
10
|
|
|
13
|
-
|
|
11
|
+
### 1. Integration via (`vrc-packages-api`)
|
|
14
12
|
|
|
15
|
-
|
|
16
|
-
- `vrc-packages-api/protocol`
|
|
17
|
-
- `vrc-packages-api/types`
|
|
18
|
-
- `vrc-packages-api/taxonomy`
|
|
19
|
-
- `vrc-packages-api/auth`
|
|
13
|
+
Downstream applications can use the SDK's public contracts. For full documentation, read [docs/source](../docs/source). For agents: See [DELEGATES.md](../DELEGATES.md) for full SDK documentation overview, registration procedures, and keyset pagination guides.
|
|
20
14
|
|
|
21
|
-
|
|
22
|
-
|
|
15
|
+
```typescript
|
|
16
|
+
import { VRCPackageClient } from "vrc-packages-api";
|
|
17
|
+
|
|
18
|
+
// Backend example: supply the issued credential through protected runtime configuration.
|
|
19
|
+
const applicationCredential = process.env.VRCP_APP_TOKEN;
|
|
20
|
+
if (!applicationCredential) throw new Error("Missing application credential");
|
|
21
|
+
|
|
22
|
+
const client = new VRCPackageClient({
|
|
23
|
+
baseUrl: "https://coordinator.example.com",
|
|
24
|
+
appToken: applicationCredential,
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
// Bounded authenticated search. Indexed dynamic tag filtering remains open.
|
|
28
|
+
const results = await client.index.search({
|
|
29
|
+
query: "PhysBones",
|
|
30
|
+
queryOrigin: "user_authored",
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
// Resumable delta synchronization for local caches
|
|
34
|
+
const deltas = await client.index.syncDeltas({
|
|
35
|
+
limit: 100,
|
|
36
|
+
});
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**Install API package with npm or with your favorite package manager**
|
|
40
|
+
|
|
41
|
+
```shell
|
|
42
|
+
# Stable Release
|
|
43
|
+
npm i vrc-packages-api
|
|
23
44
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
"dependencies": {
|
|
27
|
-
"vrc-packages-api": "npm:vrc-packages-api-preview@2026.10.0-pre"
|
|
28
|
-
}
|
|
29
|
-
}
|
|
45
|
+
# Unstable Nightly Builds
|
|
46
|
+
npm i vrc-packages-api-preview
|
|
30
47
|
```
|
|
31
48
|
|
|
32
|
-
|
|
49
|
+
---
|
|
33
50
|
|
|
34
|
-
|
|
51
|
+
To read further, see repository documentation at [docs/applications](../docs/applications/VRCP%20API/).
|
|
35
52
|
|
|
36
|
-
|
|
53
|
+
---
|
|
37
54
|
|
|
38
|
-
|
|
55
|
+
## Changelogs
|
|
39
56
|
|
|
40
|
-
|
|
57
|
+
Current changelog lies [here](https://github.com/SlamTheDragon/vrc-packages/blob/main/CHANGELOG.md) <br/>
|
|
58
|
+
Read the full changelog history [here](https://github.com/SlamTheDragon/vrc-packages/tree/main/docs/changelogs/vrcp-packages-api)
|
|
41
59
|
|
|
42
|
-
|
|
43
|
-
The manifest permits publication and declares the existing Apache-2.0 license asset. CI checks the artifact before publication.
|
|
44
|
-
The complete owner API route review still gates release v0.1.0, including its prereleases. That milestone declares a stable `/v1/` contract.
|
|
45
|
-
Separate preview versions do not waive artifact checks or declare that stable contract.
|
|
46
|
-
See [delivery](../docs/source/DELIVERY.md) for config routing and remaining checks.
|
|
47
|
-
Packaging this SDK does not relocate crawler-internal Worker dependencies.
|
|
48
|
-
The source typecheck excludes installed-consumer fixtures. The distribution gate compiles those fixtures strictly against packed declarations for each identity.
|
|
60
|
+
---
|
|
49
61
|
|
|
50
|
-
|
|
62
|
+
## Legal & Compliance
|
|
51
63
|
|
|
52
|
-
|
|
64
|
+
The Project operates under strict technical and legal covenants to safeguard creator rights and target infrastructure:
|
|
53
65
|
|
|
54
|
-
|
|
66
|
+
- **Zero-Binaries**: The crawler never fetches, stores, or mirrors binary archives (e.g. `.unitypackage`, `.zip`, `.rar`, executables, or 3D model files).
|
|
67
|
+
- **Mandatory Outbound Routing**: Downstream APIs and applications must provide direct outbound links to the original creator storefront or repository.
|
|
68
|
+
- **RFC 9309 Robots Compliance**: Honors `robots.txt` directives with conservative origin-wide AIMD rate pacing.
|
|
69
|
+
- **Removal Review**: App-authenticated removal reports are recorded without automatic delisting. DNS/bio ownership verification remains unimplemented.
|
|
70
|
+
- **Anti-AI Model Training Restrictions**: Catalog compilations are restricted from use in training generative AI models.
|
|
55
71
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
```
|
|
72
|
+
Review [LEGAL.md](../LEGAL.md) for full operational covenants, governing law, and public terms of service.
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## License
|
|
62
77
|
|
|
63
|
-
|
|
78
|
+
This package is licensed under the **Apache License v2.0**
|