vrc-packages-api-preview 0.0.0-stage → 2026.10.0-pre

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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

@@ -1,3 +1,63 @@
-# Temporary Holding Version
+# vrc-packages-api
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This package supplies the consumer SDK and schemas for operator, user and application APIs. It does not supply a crawler node or job runner.
+
+The root exports VRCPackageClient, VRCPackageClientOptions and VRCPApiError. VRC Packages is the canonical project brand. VRCP abbreviates that name, and P already stands for Packages. Use the exact client spelling VRCPackageClient, not VRCPPackageClient or VRCPPackagesClient. Crawler, Worker and Client describe project components, not the overall brand.
+
+One SDK source supplies two npm identities: release `vrc-packages-api` and preview `vrc-packages-api-preview`.
+Version configs select their versions. Preview uses CalVer with a `pre` suffix.
+Version zero retains no aliases for the old client/options/error names. Package aliases do not add retired API exports.
+
+The taxonomy subpath exposes the three umbrella values: tools, assets and avatars. It does not supply an indexed tag vocabulary or coordinator-internal evidence schemas. VPM version validation belongs to the crawler. Coordinator-owned tags and classification profiles remain under development.
+
+The distribution contains ESM JavaScript and TypeScript declarations. It does not require TypeScript source execution, Bun or another monorepo folder at runtime. Supported imports:
+
+- `vrc-packages-api`
+- `vrc-packages-api/protocol`
+- `vrc-packages-api/types`
+- `vrc-packages-api/taxonomy`
+- `vrc-packages-api/auth`
+
+The preview package has the same subpaths under `vrc-packages-api-preview`.
+Consumers can keep the release import spelling with an exact npm dependency alias:
+
+```json
+{
+  "dependencies": {
+    "vrc-packages-api": "npm:vrc-packages-api-preview@2026.10.0-pre"
+  }
+}
+```
+
+This is an example alias. Read the preview config for the current milestone version.
+
+Run `bun run build` to create the distribution. Each build removes the generated `dist` directory before compilation. This prevents deleted source files from leaving stale package exports. Source files remain unchanged.
+
+Run `bun run test` to build and test it. `npm pack` runs the build before it creates a tarball. Runtime dependencies remain declared npm dependencies, not bundled copies.
+
+Run `npm run test:distribution` before release. This test packs the SDK, installs the tarball in a separate directory and checks all exports with ordinary Node. It also checks strict declarations, an isolated Wrangler build and native Worker execution. Use `npm run test:distribution -- --offline` when npm has cached the runtime dependencies.
+
+The SDK owns its pinned Worker test tools as development dependencies. The distribution test does not use another project directory. It prints and retains the temporary consumer directory for inspection. The packed SDK contains no Worker test tools or crawler source.
+
+The owner authorizes release v0.0.0 and CalVer preview publication after package verification.
+The manifest permits publication and declares the existing Apache-2.0 license asset. CI checks the artifact before publication.
+The complete owner API route review still gates release v0.1.0, including its prereleases. That milestone declares a stable `/v1/` contract.
+Separate preview versions do not waive artifact checks or declare that stable contract.
+See [delivery](../docs/source/DELIVERY.md) for config routing and remaining checks.
+Packaging this SDK does not relocate crawler-internal Worker dependencies.
+The source typecheck excludes installed-consumer fixtures. The distribution gate compiles those fixtures strictly against packed declarations for each identity.
+
+Operator lead rows use the exact Worker snake-case wire fields. The SDK adds no aliases or missing provenance. Approval and rejection require an explicit reason. Unknown fields fail validation. The grouped source and packed-consumer checks passed. Remaining authorization and report-lifecycle gaps still require review.
+
+## Public catalog pages
+
+`client.index.query` calls GET `/v1/app/index` without authentication. It accepts only `limit` and `cursor`. The default limit is 50. Integer limits from 1 through 100 are valid.
+
+```typescript
+const first = await client.index.query({ limit: 100 });
+if (first.nextCursor !== null) {
+  const next = await client.index.query({ limit: 100, cursor: first.nextCursor });
+}
+```
+
+The response contains `schemaVersion`, `packages` and `nextCursor`. A null cursor ends the page sequence. It has no total count. Unsupported options, invalid cursors and malformed responses fail validation. Use the authenticated `index.search` method for search filters.

package/dist/auth/index.d.ts

@@ -0,0 +1 @@
+export * from "./tokens.ts";

package/dist/auth/index.js

@@ -0,0 +1 @@
+export * from "./tokens.js";

package/dist/auth/tokens.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Authoritative Identity and Token Prefix Configuration for Downstream Consumers.
+ * Enforces unified `vrcp_` prepend identity across consumer credentials.
+ */
+export declare const IDENTITY_PREFIX: "vrcp_";
+/** Downstream application credentials prepend `vrcp_app_` followed by 64-hex entropy. */
+export declare const APP_TOKEN_PREFIX: "vrcp_app_";
+export declare const APP_TOKEN_REGEX: RegExp;
+export declare function formatAppToken(entropyHex: string): string;
+export declare function isAppToken(token: string): boolean;
+/**
+ * User credentials prepend `vrcp_usr_` followed by 64-hex entropy.
+ * Users can register downstream apps and submit delisting requests on their own behalf.
+ */
+export declare const USER_TOKEN_PREFIX: "vrcp_usr_";
+export declare const USER_TOKEN_REGEX: RegExp;
+export declare function formatUserToken(entropyHex: string): string;
+export declare function isUserToken(token: string): boolean;
+/**
+ * Admin operator credentials are 64-character hex secrets in version 0 wire protocols.
+ * In future web operator panel gates (src-web / Gate G10), Firebase and/or GitHub
+ * will be used for Auth / OAuth identity providers.
+ */
+export declare const OPERATOR_TOKEN_REGEX: RegExp;
+export declare function isOperatorToken(token: string): boolean;

package/dist/auth/tokens.js

@@ -0,0 +1,35 @@
+/**
+ * Authoritative Identity and Token Prefix Configuration for Downstream Consumers.
+ * Enforces unified `vrcp_` prepend identity across consumer credentials.
+ */
+export const IDENTITY_PREFIX = "vrcp_";
+/** Downstream application credentials prepend `vrcp_app_` followed by 64-hex entropy. */
+export const APP_TOKEN_PREFIX = "vrcp_app_";
+export const APP_TOKEN_REGEX = /^vrcp_app_[a-f0-9]{64}$/;
+export function formatAppToken(entropyHex) {
+    return `${APP_TOKEN_PREFIX}${entropyHex.toLowerCase()}`;
+}
+export function isAppToken(token) {
+    return APP_TOKEN_REGEX.test(token);
+}
+/**
+ * User credentials prepend `vrcp_usr_` followed by 64-hex entropy.
+ * Users can register downstream apps and submit delisting requests on their own behalf.
+ */
+export const USER_TOKEN_PREFIX = "vrcp_usr_";
+export const USER_TOKEN_REGEX = /^vrcp_usr_[a-f0-9]{64}$/;
+export function formatUserToken(entropyHex) {
+    return `${USER_TOKEN_PREFIX}${entropyHex.toLowerCase()}`;
+}
+export function isUserToken(token) {
+    return USER_TOKEN_REGEX.test(token);
+}
+/**
+ * Admin operator credentials are 64-character hex secrets in version 0 wire protocols.
+ * In future web operator panel gates (src-web / Gate G10), Firebase and/or GitHub
+ * will be used for Auth / OAuth identity providers.
+ */
+export const OPERATOR_TOKEN_REGEX = /^[0-9a-fA-F]{64}$/;
+export function isOperatorToken(token) {
+    return OPERATOR_TOKEN_REGEX.test(token);
+}

package/dist/client.d.ts

@@ -0,0 +1,182 @@
+import { type Platform } from "./types/index.ts";
+import { type CatalogDeltaResponse, type PublicCatalogListQuery, type PublicCatalogListResponse } from "./protocol/catalog.ts";
+import { type CatalogSearchResponse, type RegisterAppRequest, type RegisterAppResponse, type ReportSubmissionRequest, type ReportSubmissionResponse, type QueryOrigin } from "./protocol/downstream.ts";
+import { type UserAppListQuery, type UserAppListResponse, type UserAppResponse } from "./protocol/user.ts";
+import { type LeadStatus, type RevokeNodeResponse, type EnqueueJobRequest, type EnqueueJobResponse, type InitializeCoordinatorResponse, type LeadListResponse, type LeadActionResponse, type SourceAccessProfileListResponse, type CreateSourceAccessProfile, type SourceAccessProfileResponse, type AutoQueueRuleListResponse, type CreateAutoQueueRule, type AutoQueueRuleResponse, type IssueNodeCredential, type NodeCredentialResponse, type CatalogListResponse, type TakedownListResponse, type VerifyTakedownResponse } from "./protocol/operator.ts";
+export declare class VRCPApiError extends Error {
+    readonly status: number;
+    readonly code?: string;
+    readonly details?: unknown;
+    constructor(status: number, message: string, code?: string, details?: unknown);
+}
+export interface VRCPackageClientOptions {
+    /** Coordinator baseUrl, e.g. "https://api.vrc-packages.example" or "http://127.0.0.1:8787" */
+    baseUrl: string;
+    /** Downstream application token starting with `vrcp_app_` */
+    appToken?: string;
+    /** User token starting with `vrcp_usr_` */
+    userToken?: string;
+    /** Operator token for administrative endpoints */
+    operatorToken?: string;
+    /** Custom fetch implementation (defaults to global fetch) */
+    fetch?: typeof fetch;
+}
+export interface CatalogSearchParams {
+    query?: string;
+    queryOrigin: QueryOrigin;
+    umbrella?: "tools" | "assets" | "avatars";
+    category?: string;
+    platform?: Platform;
+    tags?: string[];
+    limit?: number;
+    cursor?: string | null;
+}
+export interface SyncDeltasParams {
+    cursor?: string;
+    limit?: number;
+}
+export declare class VRCPackageClient {
+    private readonly baseUrl;
+    private readonly appToken?;
+    private readonly userToken?;
+    private readonly operatorToken?;
+    private readonly fetchFn;
+    constructor(options: VRCPackageClientOptions);
+    private request;
+    readonly index: {
+        /**
+         * Queries the public canonical package index projection (GET /v1/app/index).
+         */
+        query: (params?: PublicCatalogListQuery) => Promise<PublicCatalogListResponse>;
+        /**
+         * Executes bounded search with mandatory query attribution (user_authored vs app_automated).
+         * Requires downstream application token (POST /v1/app/index/search).
+         */
+        search: (params: CatalogSearchParams) => Promise<CatalogSearchResponse>;
+        /**
+         * Pages current catalog changes (GET /v1/app/index/delta), not an immutable event log.
+         */
+        syncDeltas: (params?: SyncDeltasParams) => Promise<CatalogDeltaResponse>;
+    };
+    readonly app: {
+        /**
+         * Registers a downstream application (POST /v1/app/register).
+         * Gated by user authentication (userToken) or operator token.
+         */
+        register: (request: RegisterAppRequest) => Promise<RegisterAppResponse>;
+    };
+    readonly reports: {
+        /**
+         * Submits demand, issue or pending removal reports (POST /v1/app/report).
+         * Requires downstream application token.
+         */
+        submit: (report: ReportSubmissionRequest) => Promise<ReportSubmissionResponse>;
+    };
+    readonly user: {
+        apps: {
+            list: (params?: Partial<UserAppListQuery>) => Promise<UserAppListResponse>;
+            get: (appId: string) => Promise<UserAppResponse>;
+        };
+    };
+    readonly operator: {
+        jobs: {
+            /** Record a crawl candidate. Existing jobs keep their state and lease. */
+            enqueue: (request: EnqueueJobRequest) => Promise<EnqueueJobResponse>;
+        };
+        /** Initialize storage and optionally queue candidates, without granting source access. */
+        init: (params?: {
+            autoSeed?: boolean;
+        }) => Promise<InitializeCoordinatorResponse>;
+        leads: {
+            /**
+             * Lists pending, approved, or rejected discovery leads (GET /v1/operator/leads).
+             */
+            list: (params?: {
+                status?: LeadStatus;
+                limit?: number;
+                cursor?: string;
+            }) => Promise<LeadListResponse>;
+            /**
+             * Approves a discovery lead into the crawl queue (POST /v1/operator/leads/{leadKey}/approve).
+             */
+            approve: (leadKey: string, params: {
+                minDelayMs?: number;
+                reason: string;
+            }) => Promise<LeadActionResponse>;
+            /**
+             * Rejects a discovery lead (POST /v1/operator/leads/{leadKey}/reject).
+             */
+            reject: (leadKey: string, params: {
+                reason: string;
+            }) => Promise<LeadActionResponse>;
+        };
+        sourceProfiles: {
+            /**
+             * Lists source-access profiles (GET /v1/operator/source-profiles).
+             */
+            list: (params?: {
+                limit?: number;
+                cursor?: string;
+            }) => Promise<SourceAccessProfileListResponse>;
+            /**
+             * Creates a source-access profile (POST /v1/operator/source-profiles).
+             */
+            create: (request: CreateSourceAccessProfile) => Promise<SourceAccessProfileResponse>;
+            /**
+             * Disables a source-access profile (POST /v1/operator/source-profiles/{id}/disable).
+             */
+            disable: (profileId: string, reason: string) => Promise<SourceAccessProfileResponse>;
+        };
+        autoQueueRules: {
+            /**
+             * Lists auto-queue rules (GET /v1/operator/autoqueue-rules).
+             */
+            list: (params?: {
+                limit?: number;
+                cursor?: string;
+            }) => Promise<AutoQueueRuleListResponse>;
+            /**
+             * Creates an auto-queue rule (POST /v1/operator/autoqueue-rules).
+             */
+            create: (request: CreateAutoQueueRule) => Promise<AutoQueueRuleResponse>;
+            /**
+             * Disables an auto-queue rule (POST /v1/operator/autoqueue-rules/{id}/disable).
+             */
+            disable: (ruleId: string, reason: string) => Promise<AutoQueueRuleResponse>;
+        };
+        nodes: {
+            /** Revoke credentials without releasing a possibly in-flight origin reservation. */
+            revoke: (nodeId: string, reason: string) => Promise<RevokeNodeResponse>;
+            /**
+             * Issues an audited node credential with assigned capabilities (POST /v1/operator/nodes).
+             */
+            issue: (request: IssueNodeCredential) => Promise<NodeCredentialResponse>;
+        };
+        catalog: {
+            /**
+             * Lists canonical packages with operator oversight (GET /v1/operator/catalog).
+             */
+            list: (params?: {
+                limit?: number;
+                cursor?: string;
+            }) => Promise<CatalogListResponse>;
+        };
+        takedowns: {
+            /**
+             * Audits recorded creator opt-outs and delistings (GET /v1/operator/takedowns).
+             */
+            list: (params?: {
+                requesterType?: "unauthenticated_creator" | "user" | "admin_operator";
+                limit?: number;
+                cursor?: string;
+            }) => Promise<TakedownListResponse>;
+            /**
+             * Records an operator verdict on a stored creator opt-out (POST /v1/operator/takedowns/{id}/verify).
+             */
+            verify: (takedownId: string, request: {
+                verdict: "accepted" | "rejected";
+                notes?: string;
+            }) => Promise<VerifyTakedownResponse>;
+        };
+    };
+}