onehook-api-client 1.0.20 → 1.0.22

package/dist-cjs/membership/index.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.maxConnectionsForTier = exports.isPaidSubscriptionTier = exports.subscriptionTierRank = exports.resolveSubscriptionTier = exports.onUnknownSubscriptionTier = exports.parseSubscriptionTier = exports.subscriptionTierDisplayName = exports.subscriptionTierInfo = exports.PAID_SUBSCRIPTION_TIERS = exports.DEFAULT_SUBSCRIPTION_TIER = exports.SUBSCRIPTION_TIER_ORDER = exports.SUBSCRIPTION_TIERS = exports.SubscriptionTier = void 0;
+const models_0_1 = require("../models/models_0");
+Object.defineProperty(exports, "SubscriptionTier", { enumerable: true, get: function () { return models_0_1.SubscriptionTier; } });
+exports.SUBSCRIPTION_TIERS = Object.freeze([
+    { wire: 'MUST', displayName: 'Must', maxConnections: 1 },
+    { wire: 'SUPER', displayName: 'Super', maxConnections: 1 },
+    { wire: 'INFINITY', displayName: 'Infinity', maxConnections: 3 },
+]);
+exports.SUBSCRIPTION_TIER_ORDER = Object.freeze(exports.SUBSCRIPTION_TIERS.map((t) => t.wire));
+exports.DEFAULT_SUBSCRIPTION_TIER = exports.SUBSCRIPTION_TIER_ORDER[0];
+exports.PAID_SUBSCRIPTION_TIERS = Object.freeze(exports.SUBSCRIPTION_TIERS.slice(1));
+const BY_WIRE = Object.freeze(Object.fromEntries(exports.SUBSCRIPTION_TIERS.map((t) => [t.wire, t])));
+function subscriptionTierInfo(tier) {
+    return BY_WIRE[tier];
+}
+exports.subscriptionTierInfo = subscriptionTierInfo;
+function subscriptionTierDisplayName(tier) {
+    return BY_WIRE[tier].displayName;
+}
+exports.subscriptionTierDisplayName = subscriptionTierDisplayName;
+function parseSubscriptionTier(raw) {
+    if (typeof raw !== 'string')
+        return undefined;
+    const key = raw.trim().toUpperCase();
+    return exports.SUBSCRIPTION_TIERS.find((t) => t.wire === key)?.wire;
+}
+exports.parseSubscriptionTier = parseSubscriptionTier;
+let unknownTierHandler = () => { };
+function onUnknownSubscriptionTier(handler) {
+    unknownTierHandler = handler;
+}
+exports.onUnknownSubscriptionTier = onUnknownSubscriptionTier;
+function resolveSubscriptionTier(raw) {
+    const tier = parseSubscriptionTier(raw);
+    if (tier)
+        return tier;
+    if (typeof raw === 'string' ? raw.trim() !== '' : raw != null) {
+        try {
+            unknownTierHandler(String(raw));
+        }
+        catch {
+        }
+    }
+    return exports.DEFAULT_SUBSCRIPTION_TIER;
+}
+exports.resolveSubscriptionTier = resolveSubscriptionTier;
+function subscriptionTierRank(tier) {
+    return exports.SUBSCRIPTION_TIER_ORDER.indexOf(tier);
+}
+exports.subscriptionTierRank = subscriptionTierRank;
+function isPaidSubscriptionTier(tier) {
+    const parsed = parseSubscriptionTier(tier);
+    return parsed !== undefined && parsed !== exports.DEFAULT_SUBSCRIPTION_TIER;
+}
+exports.isPaidSubscriptionTier = isPaidSubscriptionTier;
+function maxConnectionsForTier(raw) {
+    return BY_WIRE[resolveSubscriptionTier(raw)].maxConnections;
+}
+exports.maxConnectionsForTier = maxConnectionsForTier;

package/dist-cjs/models/models_0.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CredentialGap = exports.DeviceLimitError = exports.Platform = exports.LastSeenVisibility = exports.MediaKind = exports.ForbiddenError = exports.NotFoundError = exports.InternalServerError = exports.BadRequestError = void 0;
+exports.SubscriptionTier = exports.CredentialGap = exports.DeviceLimitError = exports.Platform = exports.LastSeenVisibility = exports.MediaKind = exports.ForbiddenError = exports.NotFoundError = exports.InternalServerError = exports.BadRequestError = void 0;
 const OneHookServiceException_1 = require("./OneHookServiceException");
 class BadRequestError extends OneHookServiceException_1.OneHookServiceException {
     name = "BadRequestError";
@@ -99,3 +99,8 @@ exports.CredentialGap = {
     USERNAME_MISMATCHED_IN_COGNITO: "USERNAME_MISMATCHED_IN_COGNITO",
     USERNAME_NOT_SYNCED_TO_COGNITO: "USERNAME_NOT_SYNCED_TO_COGNITO",
 };
+exports.SubscriptionTier = {
+    INFINITY: "INFINITY",
+    MUST: "MUST",
+    SUPER: "SUPER",
+};

package/dist-es/membership/index.js

@@ -0,0 +1,50 @@
+import { SubscriptionTier } from '../models/models_0';
+export { SubscriptionTier };
+export const SUBSCRIPTION_TIERS = Object.freeze([
+    { wire: 'MUST', displayName: 'Must', maxConnections: 1 },
+    { wire: 'SUPER', displayName: 'Super', maxConnections: 1 },
+    { wire: 'INFINITY', displayName: 'Infinity', maxConnections: 3 },
+]);
+export const SUBSCRIPTION_TIER_ORDER = Object.freeze(SUBSCRIPTION_TIERS.map((t) => t.wire));
+export const DEFAULT_SUBSCRIPTION_TIER = SUBSCRIPTION_TIER_ORDER[0];
+export const PAID_SUBSCRIPTION_TIERS = Object.freeze(SUBSCRIPTION_TIERS.slice(1));
+const BY_WIRE = Object.freeze(Object.fromEntries(SUBSCRIPTION_TIERS.map((t) => [t.wire, t])));
+export function subscriptionTierInfo(tier) {
+    return BY_WIRE[tier];
+}
+export function subscriptionTierDisplayName(tier) {
+    return BY_WIRE[tier].displayName;
+}
+export function parseSubscriptionTier(raw) {
+    if (typeof raw !== 'string')
+        return undefined;
+    const key = raw.trim().toUpperCase();
+    return SUBSCRIPTION_TIERS.find((t) => t.wire === key)?.wire;
+}
+let unknownTierHandler = () => { };
+export function onUnknownSubscriptionTier(handler) {
+    unknownTierHandler = handler;
+}
+export function resolveSubscriptionTier(raw) {
+    const tier = parseSubscriptionTier(raw);
+    if (tier)
+        return tier;
+    if (typeof raw === 'string' ? raw.trim() !== '' : raw != null) {
+        try {
+            unknownTierHandler(String(raw));
+        }
+        catch {
+        }
+    }
+    return DEFAULT_SUBSCRIPTION_TIER;
+}
+export function subscriptionTierRank(tier) {
+    return SUBSCRIPTION_TIER_ORDER.indexOf(tier);
+}
+export function isPaidSubscriptionTier(tier) {
+    const parsed = parseSubscriptionTier(tier);
+    return parsed !== undefined && parsed !== DEFAULT_SUBSCRIPTION_TIER;
+}
+export function maxConnectionsForTier(raw) {
+    return BY_WIRE[resolveSubscriptionTier(raw)].maxConnections;
+}

package/dist-es/models/models_0.js

@@ -91,3 +91,8 @@ export const CredentialGap = {
     USERNAME_MISMATCHED_IN_COGNITO: "USERNAME_MISMATCHED_IN_COGNITO",
     USERNAME_NOT_SYNCED_TO_COGNITO: "USERNAME_NOT_SYNCED_TO_COGNITO",
 };
+export const SubscriptionTier = {
+    INFINITY: "INFINITY",
+    MUST: "MUST",
+    SUPER: "SUPER",
+};

package/dist-types/commands/GetMyProfileCommand.d.ts

@@ -61,7 +61,7 @@ declare const GetMyProfileCommand_base: {
  * //   ],
  * //   starSign: "STRING_VALUE",
  * //   verified: true || false,
- * //   subscriptionTier: "STRING_VALUE",
+ * //   subscriptionTier: "MUST" || "SUPER" || "INFINITY",
  * //   pictures: [
  * //     "STRING_VALUE",
  * //   ],

package/dist-types/commands/GetProfileCommand.d.ts

@@ -62,7 +62,7 @@ declare const GetProfileCommand_base: {
  * //   ],
  * //   starSign: "STRING_VALUE",
  * //   verified: true || false,
- * //   subscriptionTier: "STRING_VALUE",
+ * //   subscriptionTier: "MUST" || "SUPER" || "INFINITY",
  * //   pictures: [
  * //     "STRING_VALUE",
  * //   ],

package/dist-types/commands/GetStateCommand.d.ts

@@ -47,7 +47,7 @@ declare const GetStateCommand_base: {
  * //   matchIds: [ // StringList // required
  * //     "STRING_VALUE",
  * //   ],
- * //   subscriptionTier: "STRING_VALUE", // required
+ * //   subscriptionTier: "MUST" || "SUPER" || "INFINITY", // required
  * // };
  *
  * ```

package/dist-types/commands/UpdateEntitlementsCommand.d.ts

@@ -41,7 +41,7 @@ declare const UpdateEntitlementsCommand_base: {
  * const client = new OneHookClient(config);
  * const input = { // UpdateEntitlementsRequest
  *   userId: "STRING_VALUE", // required
- *   subscriptionTier: "STRING_VALUE", // required
+ *   subscriptionTier: "MUST" || "SUPER" || "INFINITY", // required
  *   source: "STRING_VALUE",
  *   purchaseRef: "STRING_VALUE",
  *   effectiveAt: Number("long"),
@@ -50,7 +50,7 @@ declare const UpdateEntitlementsCommand_base: {
  * const response = await client.send(command);
  * // { // UpdateEntitlementsResponse
  * //   status: "STRING_VALUE", // required
- * //   subscriptionTier: "STRING_VALUE", // required
+ * //   subscriptionTier: "MUST" || "SUPER" || "INFINITY", // required
  * // };
  *
  * ```

package/dist-types/commands/UpgradeUserCommand.d.ts

@@ -45,7 +45,7 @@ declare const UpgradeUserCommand_base: {
  * //   matchIds: [ // StringList // required
  * //     "STRING_VALUE",
  * //   ],
- * //   subscriptionTier: "STRING_VALUE", // required
+ * //   subscriptionTier: "MUST" || "SUPER" || "INFINITY", // required
  * // };
  *
  * ```

package/dist-types/membership/index.d.ts

@@ -0,0 +1,47 @@
+import { SubscriptionTier } from '../models/models_0';
+export { SubscriptionTier };
+/** Customer-facing brand name of a tier. */
+export type SubscriptionTierDisplayName = 'Must' | 'Super' | 'Infinity';
+export interface SubscriptionTierInfo {
+    /** Wire value — the ONLY form that is persisted or sent to the backend. */
+    readonly wire: SubscriptionTier;
+    /** Presentation-only brand name. */
+    readonly displayName: SubscriptionTierDisplayName;
+    /** Default concurrent-connection (hook) ceiling. */
+    readonly maxConnections: number;
+}
+/** Every tier, lowest first. */
+export declare const SUBSCRIPTION_TIERS: readonly SubscriptionTierInfo[];
+/** Tier wire values, lowest first. */
+export declare const SUBSCRIPTION_TIER_ORDER: readonly SubscriptionTier[];
+/** The lowest tier — what an unknown / missing tier fails closed to. */
+export declare const DEFAULT_SUBSCRIPTION_TIER: SubscriptionTier;
+/** Paid tiers (every tier above the lowest), lowest first. */
+export declare const PAID_SUBSCRIPTION_TIERS: readonly SubscriptionTierInfo[];
+/** Metadata for a wire value. */
+export declare function subscriptionTierInfo(tier: SubscriptionTier): SubscriptionTierInfo;
+/** Customer-facing name for a wire value. */
+export declare function subscriptionTierDisplayName(tier: SubscriptionTier): SubscriptionTierDisplayName;
+/**
+ * Strict parser for an UNTRUSTED tier string (token claim, stored row, config key). Accepts a tier
+ * name (wire value or display name), case-insensitively and trimmed. Returns undefined otherwise.
+ */
+export declare function parseSubscriptionTier(raw: unknown): SubscriptionTier | undefined;
+/** Called with the raw value whenever {@link resolveSubscriptionTier} meets a non-empty unknown tier. */
+export type UnknownSubscriptionTierHandler = (raw: string) => void;
+/**
+ * Registers the process-wide handler for unknown tiers (e.g. log an error / page a developer).
+ * The tier still resolves to {@link DEFAULT_SUBSCRIPTION_TIER}; the handler is for investigation.
+ */
+export declare function onUnknownSubscriptionTier(handler: UnknownSubscriptionTierHandler): void;
+/**
+ * Like {@link parseSubscriptionTier} but fails closed to {@link DEFAULT_SUBSCRIPTION_TIER}. A missing
+ * value is normal (new account); a non-empty unknown value is reported to the registered handler.
+ */
+export declare function resolveSubscriptionTier(raw: unknown): SubscriptionTier;
+/** Zero-based rank of a tier (lowest = 0). */
+export declare function subscriptionTierRank(tier: SubscriptionTier): number;
+/** True for any tier above the lowest tier. */
+export declare function isPaidSubscriptionTier(tier: unknown): boolean;
+/** Default connection ceiling for a (possibly unknown) tier; unknown fails closed to the lowest tier. */
+export declare function maxConnectionsForTier(raw: unknown): number;

package/dist-types/models/models_0.d.ts

@@ -784,12 +784,32 @@ export interface UnlinkSocialRequest {
 export interface UnlinkSocialResponse {
     status: string | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const SubscriptionTier: {
+    readonly INFINITY: "INFINITY";
+    readonly MUST: "MUST";
+    readonly SUPER: "SUPER";
+};
+/**
+ * @public
+ */
+export type SubscriptionTier = typeof SubscriptionTier[keyof typeof SubscriptionTier];
 /**
  * @public
  */
 export interface UpdateEntitlementsRequest {
     userId: string | undefined;
-    subscriptionTier: string | undefined;
+    /**
+     * A OneHook membership tier. The member values are the wire values persisted in Cognito
+     * (`custom:subscriptionTier`), DynamoDB and Postgres. Members are declared in ascending order
+     * (lowest tier first); consumers rely on that order. A stored value that is not one of these is
+     * treated as the lowest tier (Must) and raises the UnknownSubscriptionTier alarm.
+     * @public
+     */
+    subscriptionTier: SubscriptionTier | undefined;
     /**
      * Provenance of the entitlement decision (e.g. stripe / apple / google / sync). Advisory/audit.
      * @public
@@ -811,7 +831,14 @@ export interface UpdateEntitlementsRequest {
  */
 export interface UpdateEntitlementsResponse {
     status: string | undefined;
-    subscriptionTier: string | undefined;
+    /**
+     * A OneHook membership tier. The member values are the wire values persisted in Cognito
+     * (`custom:subscriptionTier`), DynamoDB and Postgres. Members are declared in ascending order
+     * (lowest tier first); consumers rely on that order. A stored value that is not one of these is
+     * treated as the lowest tier (Must) and raises the UnknownSubscriptionTier alarm.
+     * @public
+     */
+    subscriptionTier: SubscriptionTier | undefined;
 }
 /**
  * @public
@@ -1421,7 +1448,14 @@ export interface ProfileResponse {
      * @public
      */
     verified?: boolean | undefined;
-    subscriptionTier?: string | undefined;
+    /**
+     * A OneHook membership tier. The member values are the wire values persisted in Cognito
+     * (`custom:subscriptionTier`), DynamoDB and Postgres. Members are declared in ascending order
+     * (lowest tier first); consumers rely on that order. A stored value that is not one of these is
+     * treated as the lowest tier (Must) and raises the UnknownSubscriptionTier alarm.
+     * @public
+     */
+    subscriptionTier?: SubscriptionTier | undefined;
     pictures?: (string)[] | undefined;
     /**
      * Display-only preview transforms keyed by picture object key. Values use `v1:x,y,zoom`.
@@ -1547,7 +1581,14 @@ export interface UserStateResponse {
     state: string | undefined;
     activeConnections: number | undefined;
     matchIds: (string)[] | undefined;
-    subscriptionTier: string | undefined;
+    /**
+     * A OneHook membership tier. The member values are the wire values persisted in Cognito
+     * (`custom:subscriptionTier`), DynamoDB and Postgres. Members are declared in ascending order
+     * (lowest tier first); consumers rely on that order. A stored value that is not one of these is
+     * treated as the lowest tier (Must) and raises the UnknownSubscriptionTier alarm.
+     * @public
+     */
+    subscriptionTier: SubscriptionTier | undefined;
 }
 /**
  * @public

package/membership/SubscriptionTierCatalog.kt

@@ -0,0 +1,30 @@
+// GENERATED from OneHookBackend packages/api-models/model/smithy/common.smithy (SubscriptionTier).
+// DO NOT EDIT. Regenerate: (OneHookBackend) npm run generate && npm run membership:sync
+
+package club.onehook.membership
+
+/** Backend-owned membership catalogue (wire value, display name, connection ceiling), lowest first. */
+object SubscriptionTierCatalog {
+    data class Entry(val wire: String, val displayName: String, val maxConnections: Int)
+
+    val tiers: List<Entry> = listOf(
+        Entry(wire = "MUST", displayName = "Must", maxConnections = 1),
+        Entry(wire = "SUPER", displayName = "Super", maxConnections = 1),
+        Entry(wire = "INFINITY", displayName = "Infinity", maxConnections = 3),
+    )
+
+    /** The lowest tier wire value — what an unknown tier fails closed to. */
+    val defaultWire: String = tiers.first().wire
+
+    /** Parser: tier name (wire value or display name), case-insensitive + trimmed; null if unknown. */
+    fun parse(raw: String?): Entry? {
+        val key = raw?.trim()?.uppercase().orEmpty()
+        return tiers.firstOrNull { it.wire == key }
+    }
+
+    /** Parses [raw], failing closed to the lowest tier (Must). The server alarms on unknown stored tiers. */
+    fun resolve(raw: String?): Entry = parse(raw) ?: tiers.first()
+
+    /** True for any known tier above the lowest tier. */
+    fun isPaid(raw: String?): Boolean = parse(raw)?.let { it.wire != defaultWire } ?: false
+}

package/membership/SubscriptionTierCatalog.swift

@@ -0,0 +1,31 @@
+// GENERATED from OneHookBackend packages/api-models/model/smithy/common.smithy (SubscriptionTier).
+// DO NOT EDIT. Regenerate: (OneHookBackend) npm run generate && npm run membership:sync
+
+import Foundation
+
+/// Backend-owned membership catalogue (wire value, display name, connection ceiling), lowest first.
+enum SubscriptionTierCatalog {
+    struct Entry: Equatable, Sendable {
+        let wire: String
+        let displayName: String
+        let maxConnections: Int
+    }
+
+    static let tiers: [Entry] = [
+        .init(wire: "MUST", displayName: "Must", maxConnections: 1),
+        .init(wire: "SUPER", displayName: "Super", maxConnections: 1),
+        .init(wire: "INFINITY", displayName: "Infinity", maxConnections: 3),
+    ]
+
+    /// The lowest tier wire value — what an unknown tier fails closed to.
+    static let defaultWire: String = tiers[0].wire
+
+    static func entry(wire: String) -> Entry? { tiers.first { $0.wire == wire } }
+
+    /// Parser: tier name (wire value or display name), case-insensitive + trimmed; nil if unknown.
+    /// Callers treat nil as the lowest tier (Must) — the server alarms on unknown stored tiers.
+    static func parse(_ raw: String?) -> Entry? {
+        guard let key = raw?.trimmingCharacters(in: .whitespacesAndNewlines).uppercased() else { return nil }
+        return entry(wire: key)
+    }
+}

package/membership/membership-catalog.json

@@ -0,0 +1,20 @@
+{
+  "source": "club.onehook.common#SubscriptionTier",
+  "tiers": [
+    {
+      "wire": "MUST",
+      "displayName": "Must",
+      "maxConnections": 1
+    },
+    {
+      "wire": "SUPER",
+      "displayName": "Super",
+      "maxConnections": 1
+    },
+    {
+      "wire": "INFINITY",
+      "displayName": "Infinity",
+      "maxConnections": 3
+    }
+  ]
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "onehook-api-client",
   "description": "OneHook API Client",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -73,7 +73,8 @@
   },
   "files": [
     "dist-*/**",
-    "telemetry/**"
+    "telemetry/**",
+    "membership/**"
   ],
   "browser": {
     "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.browser"
@@ -98,6 +99,14 @@
       "import": "./dist-es/telemetry/index.js",
       "require": "./dist-cjs/telemetry/index.js"
     },
+    "./membership": {
+      "types": "./dist-types/membership/index.d.ts",
+      "import": "./dist-es/membership/index.js",
+      "require": "./dist-cjs/membership/index.js"
+    },
+    "./membership/SubscriptionTierCatalog.swift": "./membership/SubscriptionTierCatalog.swift",
+    "./membership/SubscriptionTierCatalog.kt": "./membership/SubscriptionTierCatalog.kt",
+    "./membership/membership-catalog.json": "./membership/membership-catalog.json",
     "./telemetry/TelemetryCatalog.swift": "./telemetry/TelemetryCatalog.swift",
     "./telemetry/TelemetryCatalog.kt": "./telemetry/TelemetryCatalog.kt",
     "./telemetry/telemetry-catalog.json": "./telemetry/telemetry-catalog.json",