@vxil/sdk 0.4.0 → 0.4.1

package/README.md

@@ -88,6 +88,10 @@ try {
 
 ## Changelog
 
+### 0.4.1 — 2026-09-13
+
+- Documentation only: JSDoc no longer cites internal repository paths; points at the public guide instead. No runtime change.
+
 ### 0.4.0 — 2026-09-11
 
 - React-Native-clean: every query string is built without `URLSearchParams` (React Native's polyfill throws on `.set` before 0.81); wire bytes unchanged.

package/dist/index.d.ts

@@ -84,11 +84,11 @@ export interface VxilOptions {
      *  a mobile/SPA holds a public/thin-client key + the signed-in user's session
      *  token and calls the edge directly, safely scoped to that user. Absent ⇒
      *  **no header** ⇒ server-caller mode, exactly as today (backward compatible).
-     *  See docs/end-user-principals-design.md §4.1, §10. For a per-call override on
+     *  See https://vxil.com/docs/guide/09-security-and-multitenancy. For a per-call override on
      *  an otherwise server-mode client, use `vx.asEndUser(token)`. */
     endUserToken?: string;
     /** Global API major every request pins (default `'v1'`). Path-major, per
-     *  docs/feature-versioning.md — a breaking change ships as a new major on a
+     *  the versioning section of https://vxil.com/docs/guide/12-going-to-production — a breaking change ships as a new major on a
      *  new path, never in place. */
     apiVersion?: ApiVersion;
     /** Per-feature API-major overrides (`{ cms: 'v2' }`); each takes precedence
@@ -1345,7 +1345,7 @@ export declare class Vxil<S extends VxilSchemaShape = VxilSchemaShape> {
      *  client, mirroring how the edge threads the verified principal. The base
      *  URL, api key, fetch impl, version pins and the retry/timeout/hooks options
      *  are inherited unchanged; only the end-user token is (re)set. Pass a falsy token to get back a server-mode
-     *  client (drops the header). See docs/end-user-principals-design.md §4.1. */
+     *  client (drops the header). See https://vxil.com/docs/guide/09-security-and-multitenancy. */
     asEndUser(endUserToken: string | undefined): Vxil<S>;
     /** Build the versioned request path — the ONE place a wire path is finalized.
      *  Every request (call(), audit.export, the fn proxy) routes through here, so
@@ -1620,7 +1620,7 @@ export declare class Vxil<S extends VxilSchemaShape = VxilSchemaShape> {
      *  ADVISORY vxil plan — which features to enable, a materialized `config_draft`,
      *  and which truly-unique logic needs a tenant function. Deterministic + pure;
      *  it PROPOSES a plan, it never applies anything (review it, then push the
-     *  config). Needs `features:read`. (POST /v1/plan; docs/planner-feature-design.md) */
+     *  config). Needs `features:read`. (POST /v1/plan; https://vxil.com/docs/guide/10-agents-and-mcp) */
     readonly planner: {
         create: (description: string, name?: string) => Promise<VxilPlan>;
     };
@@ -1832,7 +1832,7 @@ export declare class Vxil<S extends VxilSchemaShape = VxilSchemaShape> {
             delete: (ruleId: string) => Promise<void>;
         };
     };
-    /** vxil-auth. SCOPES (docs/features/auth.md §7.6): every flow here that
+    /** vxil-auth. SCOPES (vxil.com/docs/guide/09-security-and-multitenancy): every flow here that
      *  obtains, renews, verifies or ends the caller's OWN session (signUp/signIn,
      *  magicLink, otp, anonymous, stepUp, oauth, sessions.refresh/revoke/verify,
      *  password reset) accepts the narrow `auth:signin` — the ONLY auth scope a
@@ -2174,7 +2174,7 @@ export declare class Vxil<S extends VxilSchemaShape = VxilSchemaShape> {
             create: (input: {
                 collection: string;
                 singular?: string;
-                /** End-user owner-scoping (docs/end-user-principals-design.md §5.1):
+                /** End-user owner-scoping (https://vxil.com/docs/guide/09-security-and-multitenancy):
                  *  names an existing `string` field that holds the owner id. When set,
                  *  the cms worker auto-scopes owned reads/writes to the VERIFIED
                  *  end-user principal (default-deny) in end-user mode; a no-op in
@@ -2474,7 +2474,7 @@ export declare class Vxil<S extends VxilSchemaShape = VxilSchemaShape> {
      * only the envelope: membership, read-cursors, mute, and a directed block
      * list; the messages themselves are `comments` rows on the
      * `dm:<conversation_id>` topic. Gated by its own `dm` config, independent of
-     * comments. See docs/features/dm.md.
+     * comments. See vxil.com/docs/guide/06-feature-catalog.
      */
     readonly dm: {
         /** Read the resolved DM config (defaults merged with the stored partial). */

package/dist/index.js

@@ -150,7 +150,7 @@ export class Vxil {
      *  client, mirroring how the edge threads the verified principal. The base
      *  URL, api key, fetch impl, version pins and the retry/timeout/hooks options
      *  are inherited unchanged; only the end-user token is (re)set. Pass a falsy token to get back a server-mode
-     *  client (drops the header). See docs/end-user-principals-design.md §4.1. */
+     *  client (drops the header). See https://vxil.com/docs/guide/09-security-and-multitenancy. */
     asEndUser(endUserToken) {
         return new Vxil({
             apiKey: this.key,
@@ -402,7 +402,7 @@ export class Vxil {
      *  ADVISORY vxil plan — which features to enable, a materialized `config_draft`,
      *  and which truly-unique logic needs a tenant function. Deterministic + pure;
      *  it PROPOSES a plan, it never applies anything (review it, then push the
-     *  config). Needs `features:read`. (POST /v1/plan; docs/planner-feature-design.md) */
+     *  config). Needs `features:read`. (POST /v1/plan; https://vxil.com/docs/guide/10-agents-and-mcp) */
     planner = {
         create: async (description, name) => (await this.call('POST', '/v1/plan', {
             description,
@@ -544,7 +544,7 @@ export class Vxil {
             },
         },
     };
-    /** vxil-auth. SCOPES (docs/features/auth.md §7.6): every flow here that
+    /** vxil-auth. SCOPES (vxil.com/docs/guide/09-security-and-multitenancy): every flow here that
      *  obtains, renews, verifies or ends the caller's OWN session (signUp/signIn,
      *  magicLink, otp, anonymous, stepUp, oauth, sessions.refresh/revoke/verify,
      *  password reset) accepts the narrow `auth:signin` — the ONLY auth scope a
@@ -880,7 +880,7 @@ export class Vxil {
      * only the envelope: membership, read-cursors, mute, and a directed block
      * list; the messages themselves are `comments` rows on the
      * `dm:<conversation_id>` topic. Gated by its own `dm` config, independent of
-     * comments. See docs/features/dm.md.
+     * comments. See vxil.com/docs/guide/06-feature-catalog.
      */
     dm = {
         /** Read the resolved DM config (defaults merged with the stored partial). */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vxil/sdk",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "private": false,
   "type": "module",
   "description": "Typed client for the Vxil REST API (notifications, auth, jobs, files, cms, comments, webhooks, realtime, orgs, rate-limits).",
@@ -10,8 +10,7 @@
     "backend",
     "baas",
     "sdk",
-    "typed-client",
-    "cloudflare-workers"
+    "typed-client"
   ],
   "engines": {
     "node": ">=18"