@rydr/game-sdk 8.10.0 → 8.11.0

package/dist/protocol/identity.d.ts

@@ -6,6 +6,60 @@
  * name, and the physics metrics it explicitly requested. This is the privacy
  * boundary that makes third-party games safe.
  */
+/**
+ * What CONTENT this rider may see, as a ladder: `free` < `beta` < `all_access`, each rung
+ * containing the one below it.
+ *
+ * | Tier | The rider gets |
+ * |---|---|
+ * | `free` | the free experiences only |
+ * | `beta` | the free ones plus early access |
+ * | `all_access` | everything, including unpublished content |
+ *
+ * ## The platform states the fact, the game applies the policy
+ *
+ * Which of YOUR experiences are free is yours to decide, not the platform's: it knows nothing
+ * about your tracks, songs or levels, and a list of them kept platform-side would drift the first
+ * time someone shipped content without updating it. So the host says which tier the rider is on and
+ * your game decides what that unlocks. Same division as the FTP difficulty ladder: the platform
+ * hands over a calibrated fact, the game decides what to do with it.
+ *
+ * ## Fewer values than the platform has
+ *
+ * The platform also holds buckets meaning "cannot play at all" (waiting for a beta place, played at
+ * an event, access ended). None of them can appear here, because a game only ever runs for a rider
+ * who is already playing. Do not add branches for states that cannot arrive.
+ *
+ * ## Never compare it directly
+ *
+ * Use {@link tierAtLeast}. A bare `tier === "beta"` excludes `all_access` riders from content they
+ * are entitled to, silently, and the day a tier is inserted into the middle of the ladder every
+ * such comparison is wrong at once.
+ */
+export type AccessTier = "free" | "beta" | "all_access";
+/**
+ * What an ABSENT tier means, and why it is not the lowest one.
+ *
+ * The field is missing whenever an older host meets a newer game (the host simply does not send
+ * it). Reading that as `free` would strip content from fully entitled riders during any version
+ * skew, which is a worse failure than briefly showing someone one track too many. So absence means
+ * today's behaviour, which is `beta`.
+ *
+ * A compatibility default, not a policy: a host that HAS tiers always sends one.
+ */
+export declare const DEFAULT_ACCESS_TIER: AccessTier;
+/**
+ * Is this rider on `min` or better? The one way to read {@link AccessTier}.
+ *
+ * ```ts
+ * if (tierAtLeast(identity.accessTier, "beta")) showEarlyAccessTracks();
+ * ```
+ *
+ * An absent tier counts as {@link DEFAULT_ACCESS_TIER}, and an unrecognised one (a host newer than
+ * this SDK, sending a tier that did not exist when you built) counts the same way rather than
+ * throwing: a game mid-session should not crash because the ladder grew.
+ */
+export declare function tierAtLeast(tier: AccessTier | undefined, min: AccessTier): boolean;
 export interface ScopedIdentity {
     /** Stable, opaque per-player id. Safe to use as a key; reveals no PII. */
     playerId: string;
@@ -24,5 +78,14 @@ export interface ScopedIdentity {
      * enforces auth via RLS on the admin role.
      */
     isAdmin?: boolean;
+    /**
+     * What content this rider is entitled to (see {@link AccessTier}). Read it with
+     * {@link tierAtLeast}, never by comparing it.
+     *
+     * A UI hint, exactly like {@link isAdmin}: it tells your game what to OFFER. Nothing stops a
+     * modified guest from ignoring it, so the day real money hangs on a tier the enforcement has to
+     * be server-side as well. Absent means {@link DEFAULT_ACCESS_TIER}.
+     */
+    accessTier?: AccessTier;
 }
 //# sourceMappingURL=identity.d.ts.map

package/dist/protocol/identity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"identity.d.ts","sourceRoot":"","sources":["../../src/protocol/identity.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc;IAC7B,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,CAAC;IACjB,uEAAuE;IACvE,WAAW,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,6FAA6F;IAC7F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}
+{"version":3,"file":"identity.d.ts","sourceRoot":"","sources":["../../src/protocol/identity.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,YAAY,CAAC;AAExD;;;;;;;;;GASG;AACH,eAAO,MAAM,mBAAmB,EAAE,UAAmB,CAAC;AAStD;;;;;;;;;;GAUG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,EAAE,GAAG,EAAE,UAAU,GAAG,OAAO,CAGlF;AAED,MAAM,WAAW,cAAc;IAC7B,0EAA0E;IAC1E,QAAQ,EAAE,MAAM,CAAC;IACjB,uEAAuE;IACvE,WAAW,EAAE,MAAM,CAAC;IACpB,oCAAoC;IACpC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,6FAA6F;IAC7F,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB"}

package/dist/protocol/identity.js

@@ -1,2 +1,41 @@
-export {};
+/**
+ * The scoped identity a game receives — deliberately NOT the full player profile.
+ *
+ * The platform holds PII (real name, gender, year of birth, exact weight). A
+ * game only ever receives this redacted view: a stable opaque id, a display
+ * name, and the physics metrics it explicitly requested. This is the privacy
+ * boundary that makes third-party games safe.
+ */
+/**
+ * What an ABSENT tier means, and why it is not the lowest one.
+ *
+ * The field is missing whenever an older host meets a newer game (the host simply does not send
+ * it). Reading that as `free` would strip content from fully entitled riders during any version
+ * skew, which is a worse failure than briefly showing someone one track too many. So absence means
+ * today's behaviour, which is `beta`.
+ *
+ * A compatibility default, not a policy: a host that HAS tiers always sends one.
+ */
+export const DEFAULT_ACCESS_TIER = "beta";
+/** Position on the ladder. Private on purpose: ask {@link tierAtLeast}, never a number. */
+const TIER_RANK = {
+    free: 0,
+    beta: 1,
+    all_access: 2,
+};
+/**
+ * Is this rider on `min` or better? The one way to read {@link AccessTier}.
+ *
+ * ```ts
+ * if (tierAtLeast(identity.accessTier, "beta")) showEarlyAccessTracks();
+ * ```
+ *
+ * An absent tier counts as {@link DEFAULT_ACCESS_TIER}, and an unrecognised one (a host newer than
+ * this SDK, sending a tier that did not exist when you built) counts the same way rather than
+ * throwing: a game mid-session should not crash because the ladder grew.
+ */
+export function tierAtLeast(tier, min) {
+    const have = TIER_RANK[tier] ?? TIER_RANK[DEFAULT_ACCESS_TIER];
+    return have >= TIER_RANK[min];
+}
 //# sourceMappingURL=identity.js.map

package/dist/protocol/identity.js.map

@@ -1 +1 @@
-{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../src/protocol/identity.ts"],"names":[],"mappings":""}
+{"version":3,"file":"identity.js","sourceRoot":"","sources":["../../src/protocol/identity.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAkCH;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAe,MAAM,CAAC;AAEtD,2FAA2F;AAC3F,MAAM,SAAS,GAA+B;IAC5C,IAAI,EAAE,CAAC;IACP,IAAI,EAAE,CAAC;IACP,UAAU,EAAE,CAAC;CACd,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,UAAU,WAAW,CAAC,IAA4B,EAAE,GAAe;IACvE,MAAM,IAAI,GAAG,SAAS,CAAC,IAAkB,CAAC,IAAI,SAAS,CAAC,mBAAmB,CAAC,CAAC;IAC7E,OAAO,IAAI,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;AAChC,CAAC"}

package/dist/protocol/version.d.ts

@@ -9,5 +9,5 @@
 export declare const RYDR_PROTOCOL_VERSION: 31;
 /** Semver of this SDK build. Sent in the handshake for telemetry/debugging.
  *  (Bumped to 2.0.0 by `npm version major` on release — see CHANGELOG [Unreleased].) */
-export declare const RYDR_SDK_VERSION = "8.10.0";
+export declare const RYDR_SDK_VERSION = "8.11.0";
 //# sourceMappingURL=version.d.ts.map

package/dist/protocol/version.js

@@ -196,5 +196,5 @@
 export const RYDR_PROTOCOL_VERSION = 31;
 /** Semver of this SDK build. Sent in the handshake for telemetry/debugging.
  *  (Bumped to 2.0.0 by `npm version major` on release — see CHANGELOG [Unreleased].) */
-export const RYDR_SDK_VERSION = "8.10.0";
+export const RYDR_SDK_VERSION = "8.11.0";
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rydr/game-sdk",
-  "version": "8.10.0",
+  "version": "8.11.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/bdefrenne/rydr-game-sdk.git"