@crowdedkingdoms/crowdyjs 13.9.0 → 14.1.0

package/dist/domains/sharedEnvironment.d.ts

@@ -5,7 +5,7 @@ import { type SharedEnvPlansQuery, type OrgFreeAppQuotaQuery, type AppSharedSubs
  * auto-billing — exposed as `client.sharedEnvironment` (and grouped under
  * `client.admin`).
  *
- * Targets the **management-api**. {@link plans} is public; the read operations
+ * Part of the management surface. {@link plans} is public; the read operations
  * require org membership; spend-cap / auto-billing / subscription mutations
  * require the `manage_billing` org permission; {@link publishApp} currently
  * requires super-admin (preview). Monetary values are `*Cents` (minor units).
@@ -15,8 +15,8 @@ import { type SharedEnvPlansQuery, type OrgFreeAppQuotaQuery, type AppSharedSubs
  *   different args.
  */
 export declare class SharedEnvironmentAPI {
-    private readonly management;
-    constructor(management: GraphQLClient);
+    private readonly api;
+    constructor(api: GraphQLClient);
     /**
      * Public catalog of paid shared-environment app-slot plans.
      *

package/dist/domains/sharedEnvironment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sharedEnvironment.d.ts","sourceRoot":"","sources":["../../src/domains/sharedEnvironment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAaL,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,0BAA0B,EAC/B,KAAK,gCAAgC,EACrC,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,gCAAgC,EACrC,KAAK,iCAAiC,EACtC,KAAK,eAAe,EACrB,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;;;;;;GAaG;AACH,qBAAa,oBAAoB;IACnB,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAAV,UAAU,EAAE,aAAa;IAEtD;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAK7D;;;;;OAKG;IACG,YAAY,CAChB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAOnD;;;;;OAKG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;IAQ/D;;;;;OAKG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAOnD;;;;;OAKG;IACG,WAAW,CACf,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAOjD;;;;;OAKG;IACG,cAAc,CAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;IAOvD;;;;;;;;;OASG;IACG,UAAU,CACd,KAAK,EAAE,MAAM,EACb,IAAI,GAAE;QACJ,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,eAAe,CAAC;QAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,cAAc,CAAC,EAAE,MAAM,CAAC;KACpB,GACL,OAAO,CAAC,0BAA0B,CAAC,oBAAoB,CAAC,CAAC;IAY5D;;;;;;OAMG;IACG,kBAAkB,CACtB,KAAK,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,gCAAgC,CAAC,0BAA0B,CAAC,CAAC;IAQxE;;;;;;;OAOG;IACG,YAAY,CAChB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE;QAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAO,GAC/E,OAAO,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;IAStD;;;;;;;;OAQG;IACG,cAAc,CAClB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE;QACN,OAAO,EAAE,OAAO,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACpC,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACvC,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,GACA,OAAO,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;IAYpD;;;;;;;OAOG;IACG,kBAAkB,CACtB,KAAK,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,gCAAgC,CAAC,0BAA0B,CAAC,CAAC;IAQxE;;;;;;;OAOG;IACG,mBAAmB,CACvB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,EACvB,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,iCAAiC,CAAC,2BAA2B,CAAC,CAAC;CAO3E"}
+{"version":3,"file":"sharedEnvironment.d.ts","sourceRoot":"","sources":["../../src/domains/sharedEnvironment.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAaL,KAAK,mBAAmB,EACxB,KAAK,oBAAoB,EACzB,KAAK,0BAA0B,EAC/B,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,sBAAsB,EAC3B,KAAK,0BAA0B,EAC/B,KAAK,gCAAgC,EACrC,KAAK,uBAAuB,EAC5B,KAAK,sBAAsB,EAC3B,KAAK,gCAAgC,EACrC,KAAK,iCAAiC,EACtC,KAAK,eAAe,EACrB,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;;;;;;GAaG;AACH,qBAAa,oBAAoB;IACnB,OAAO,CAAC,QAAQ,CAAC,GAAG;gBAAH,GAAG,EAAE,aAAa;IAE/C;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAK7D;;;;;OAKG;IACG,YAAY,CAChB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAOnD;;;;;OAKG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,0BAA0B,CAAC,uBAAuB,CAAC,CAAC;IAQ/D;;;;;OAKG;IACG,eAAe,CACnB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAOnD;;;;;OAKG;IACG,WAAW,CACf,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;IAOjD;;;;;OAKG;IACG,cAAc,CAClB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,CAAC;IAOvD;;;;;;;;;OASG;IACG,UAAU,CACd,KAAK,EAAE,MAAM,EACb,IAAI,GAAE;QACJ,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,eAAe,CAAC;QAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,cAAc,CAAC,EAAE,MAAM,CAAC;KACpB,GACL,OAAO,CAAC,0BAA0B,CAAC,oBAAoB,CAAC,CAAC;IAY5D;;;;;;OAMG;IACG,kBAAkB,CACtB,KAAK,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,gCAAgC,CAAC,0BAA0B,CAAC,CAAC;IAQxE;;;;;;;OAOG;IACG,YAAY,CAChB,KAAK,EAAE,MAAM,EACb,IAAI,GAAE;QAAE,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAO,GAC/E,OAAO,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,CAAC;IAStD;;;;;;;;OAQG;IACG,cAAc,CAClB,KAAK,EAAE,MAAM,EACb,MAAM,EAAE;QACN,OAAO,EAAE,OAAO,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACpC,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACvC,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,GACA,OAAO,CAAC,sBAAsB,CAAC,gBAAgB,CAAC,CAAC;IAYpD;;;;;;;OAOG;IACG,kBAAkB,CACtB,KAAK,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,gCAAgC,CAAC,0BAA0B,CAAC,CAAC;IAQxE;;;;;;;OAOG;IACG,mBAAmB,CACvB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,EACvB,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,iCAAiC,CAAC,2BAA2B,CAAC,CAAC;CAO3E"}

package/dist/domains/sharedEnvironment.js

@@ -4,7 +4,7 @@ import { SharedEnvPlansDocument, OrgFreeAppQuotaDocument, AppSharedSubscriptionD
  * auto-billing — exposed as `client.sharedEnvironment` (and grouped under
  * `client.admin`).
  *
- * Targets the **management-api**. {@link plans} is public; the read operations
+ * Part of the management surface. {@link plans} is public; the read operations
  * require org membership; spend-cap / auto-billing / subscription mutations
  * require the `manage_billing` org permission; {@link publishApp} currently
  * requires super-admin (preview). Monetary values are `*Cents` (minor units).
@@ -14,8 +14,8 @@ import { SharedEnvPlansDocument, OrgFreeAppQuotaDocument, AppSharedSubscriptionD
  *   different args.
  */
 export class SharedEnvironmentAPI {
-    constructor(management) {
-        this.management = management;
+    constructor(api) {
+        this.api = api;
     }
     /**
      * Public catalog of paid shared-environment app-slot plans.
@@ -23,7 +23,7 @@ export class SharedEnvironmentAPI {
      * @returns The available plans.
      */
     async plans() {
-        const data = await this.management.request(SharedEnvPlansDocument, {});
+        const data = await this.api.request(SharedEnvPlansDocument, {});
         return data.sharedEnvPlans;
     }
     /**
@@ -33,7 +33,7 @@ export class SharedEnvironmentAPI {
      * @returns The {@link FreeAppQuota}.
      */
     async freeAppQuota(orgId) {
-        const data = await this.management.request(OrgFreeAppQuotaDocument, {
+        const data = await this.api.request(OrgFreeAppQuotaDocument, {
             orgId,
         });
         return data.orgFreeAppQuota;
@@ -45,7 +45,7 @@ export class SharedEnvironmentAPI {
      * @returns The {@link AppSharedSubscription} or `null`.
      */
     async appSubscription(appId) {
-        const data = await this.management.request(AppSharedSubscriptionDocument, { appId });
+        const data = await this.api.request(AppSharedSubscriptionDocument, { appId });
         return data.appSharedSubscription;
     }
     /**
@@ -55,7 +55,7 @@ export class SharedEnvironmentAPI {
      * @returns The {@link AppRuntimeState}.
      */
     async appRuntimeState(appId) {
-        const data = await this.management.request(AppRuntimeStateDocument, {
+        const data = await this.api.request(AppRuntimeStateDocument, {
             appId,
         });
         return data.appRuntimeState;
@@ -67,7 +67,7 @@ export class SharedEnvironmentAPI {
      * @returns The {@link OrgAutoBilling} config.
      */
     async autoBilling(orgId) {
-        const data = await this.management.request(OrgAutoBillingDocument, {
+        const data = await this.api.request(OrgAutoBillingDocument, {
             orgId,
         });
         return data.orgAutoBilling;
@@ -79,7 +79,7 @@ export class SharedEnvironmentAPI {
      * @returns The saved payment methods.
      */
     async paymentMethods(orgId) {
-        const data = await this.management.request(OrgPaymentMethodsDocument, {
+        const data = await this.api.request(OrgPaymentMethodsDocument, {
             orgId,
         });
         return data.orgPaymentMethods;
@@ -95,7 +95,7 @@ export class SharedEnvironmentAPI {
      * @returns The {@link PublishAppResult} (free flag + optional checkout).
      */
     async publishApp(appId, opts = {}) {
-        const data = await this.management.request(PublishAppToSharedDocument, {
+        const data = await this.api.request(PublishAppToSharedDocument, {
             appId,
             planId: opts.planId,
             provider: opts.provider,
@@ -113,7 +113,7 @@ export class SharedEnvironmentAPI {
      * @returns The updated {@link AppSharedSubscription}.
      */
     async cancelSubscription(appId, idempotencyKey) {
-        const data = await this.management.request(CancelSharedSubscriptionDocument, { appId, idempotencyKey });
+        const data = await this.api.request(CancelSharedSubscriptionDocument, { appId, idempotencyKey });
         return data.cancelSharedSubscription;
     }
     /**
@@ -125,7 +125,7 @@ export class SharedEnvironmentAPI {
      * @returns The updated {@link AppRuntimeState}.
      */
     async setSpendCaps(appId, caps = {}) {
-        const data = await this.management.request(SetAppSpendCapsDocument, {
+        const data = await this.api.request(SetAppSpendCapsDocument, {
             appId,
             hourlyLimitCents: caps.hourlyLimitCents,
             dailyLimitCents: caps.dailyLimitCents,
@@ -142,7 +142,7 @@ export class SharedEnvironmentAPI {
      * @returns The updated {@link OrgAutoBilling} config.
      */
     async setAutoBilling(orgId, config) {
-        const data = await this.management.request(SetAutoBillingDocument, {
+        const data = await this.api.request(SetAutoBillingDocument, {
             orgId,
             enabled: config.enabled,
             limitCents: config.limitCents,
@@ -161,7 +161,7 @@ export class SharedEnvironmentAPI {
      * @returns The {@link PaymentMethodSetup} handle.
      */
     async setupPaymentMethod(orgId, idempotencyKey) {
-        const data = await this.management.request(SetupSharedPaymentMethodDocument, { orgId, idempotencyKey });
+        const data = await this.api.request(SetupSharedPaymentMethodDocument, { orgId, idempotencyKey });
         return data.setupSharedPaymentMethod;
     }
     /**
@@ -173,7 +173,7 @@ export class SharedEnvironmentAPI {
      * @returns `true` on success.
      */
     async removePaymentMethod(orgId, paymentMethodId, idempotencyKey) {
-        const data = await this.management.request(RemoveSharedPaymentMethodDocument, { orgId, paymentMethodId, idempotencyKey });
+        const data = await this.api.request(RemoveSharedPaymentMethodDocument, { orgId, paymentMethodId, idempotencyKey });
         return data.removeSharedPaymentMethod;
     }
 }

package/dist/domains/udp.d.ts

@@ -15,7 +15,7 @@ import type { SpatialNotification } from '../realtime.js';
  * WebSocket (same game-api endpoint) managed by `SubscriptionManager` — the
  * first subscriber opens it and the last to unsubscribe closes it. Every call
  * requires an authenticated session carrying a **bearer game token** (minted
- * by the management-api, set via `client.auth.login()` or `client.setToken()`);
+ * by the API, set via `client.auth.login()` or `client.setToken()`);
  * a UDP proxy session is opened lazily on the first send or subscribe if you
  * didn't call {@link connect} first.
  *

package/dist/domains/udp.js

@@ -14,7 +14,7 @@ import { serializeActorUpdate, serializeAudioPacket, serializeChannelMessage, se
  * WebSocket (same game-api endpoint) managed by `SubscriptionManager` — the
  * first subscriber opens it and the last to unsubscribe closes it. Every call
  * requires an authenticated session carrying a **bearer game token** (minted
- * by the management-api, set via `client.auth.login()` or `client.setToken()`);
+ * by the API, set via `client.auth.login()` or `client.setToken()`);
  * a UDP proxy session is opened lazily on the first send or subscribe if you
  * didn't call {@link connect} first.
  *

package/dist/domains/usage.d.ts

@@ -17,8 +17,8 @@ import { type AppGraphqlOperationsQuery, type AppUsageSummaryQuery, type PlayerP
  *   per the permission notes above.
  */
 export declare class UsageAPI {
-    private readonly management;
-    constructor(management: GraphQLClient);
+    private readonly api;
+    constructor(api: GraphQLClient);
     /**
      * Top GraphQL operations for an app ranked by bytes.
      *

package/dist/domains/usage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/domains/usage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAIL,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACtB,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,QAAQ;IACP,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAAV,UAAU,EAAE,aAAa;IAEtD;;;;;;;;OAQG;IACG,oBAAoB,CACxB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,yBAAyB,CAAC,sBAAsB,CAAC,CAAC;IAU7D;;;;;;;;OAQG;IACG,UAAU,CACd,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAUnD;;;;;;;;OAQG;IACG,WAAW,CACf,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;CAI5C"}
+{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../src/domains/usage.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAClD,OAAO,EAIL,KAAK,yBAAyB,EAC9B,KAAK,oBAAoB,EACzB,KAAK,gBAAgB,EACtB,MAAM,yBAAyB,CAAC;AAEjC;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,QAAQ;IACP,OAAO,CAAC,QAAQ,CAAC,GAAG;gBAAH,GAAG,EAAE,aAAa;IAE/C;;;;;;;;OAQG;IACG,oBAAoB,CACxB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,MAAM,GACb,OAAO,CAAC,yBAAyB,CAAC,sBAAsB,CAAC,CAAC;IAU7D;;;;;;;;OAQG;IACG,UAAU,CACd,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,EACb,cAAc,CAAC,EAAE,MAAM,GACtB,OAAO,CAAC,oBAAoB,CAAC,iBAAiB,CAAC,CAAC;IAUnD;;;;;;;;OAQG;IACG,WAAW,CACf,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;CAI5C"}

package/dist/domains/usage.js

@@ -16,8 +16,8 @@ import { AppGraphqlOperationsDocument, AppUsageSummaryDocument, PlayerPulseDocum
  *   per the permission notes above.
  */
 export class UsageAPI {
-    constructor(management) {
-        this.management = management;
+    constructor(api) {
+        this.api = api;
     }
     /**
      * Top GraphQL operations for an app ranked by bytes.
@@ -29,7 +29,7 @@ export class UsageAPI {
      * @returns The top operations by usage.
      */
     async appGraphqlOperations(orgId, appId, since, limit) {
-        const data = await this.management.request(AppGraphqlOperationsDocument, {
+        const data = await this.api.request(AppGraphqlOperationsDocument, {
             orgId,
             appId,
             since,
@@ -47,7 +47,7 @@ export class UsageAPI {
      * @returns The {@link AppUsageSummary}.
      */
     async appSummary(orgId, appId, since, operationLimit) {
-        const data = await this.management.request(AppUsageSummaryDocument, {
+        const data = await this.api.request(AppUsageSummaryDocument, {
             orgId,
             appId,
             since,
@@ -65,7 +65,7 @@ export class UsageAPI {
      * @returns The {@link PlayerPulse} snapshot.
      */
     async playerPulse(orgId) {
-        const data = await this.management.request(PlayerPulseDocument, { orgId });
+        const data = await this.api.request(PlayerPulseDocument, { orgId });
         return data.playerPulse;
     }
 }

package/dist/domains/users.d.ts

@@ -3,7 +3,7 @@ import { type MeQuery, type UpdateGamertagInput, type UpdateGamertagMutation, ty
 /**
  * User identity & account management — exposed as `client.users`.
  *
- * Targets the **management-api** (every call routes to `managementUrl`). After
+ * Part of the management surface. After
  * the database split the users table is management-owned, so game-api no longer
  * exposes these identity mutations — calling them against a game-api endpoint
  * throws {@link CrowdyGraphQLError} with `FORBIDDEN`, directing you to the

package/dist/domains/users.js

@@ -2,7 +2,7 @@ import { MeDocument, UpdateGamertagDocument, DeleteMyAccountDocument, UserDocume
 /**
  * User identity & account management — exposed as `client.users`.
  *
- * Targets the **management-api** (every call routes to `managementUrl`). After
+ * Part of the management surface. After
  * the database split the users table is management-owned, so game-api no longer
  * exposes these identity mutations — calling them against a game-api endpoint
  * throws {@link CrowdyGraphQLError} with `FORBIDDEN`, directing you to the

package/dist/errors.d.ts

@@ -102,6 +102,62 @@ export declare class CrowdyGraphQLError extends CrowdyError {
      */
     get extensions(): Record<string, unknown> | undefined;
 }
+/**
+ * Extension code the API uses to say "this app's datacenter is not serving".
+ *
+ * Distinct from {@link WRONG_DATACENTER_CODE}, and the distinction is the whole
+ * point: that one names an endpoint to move to, this one deliberately does not,
+ * because there is nowhere to move to.
+ */
+export declare const APP_UNAVAILABLE_CODE = "APP_UNAVAILABLE";
+/** Extension code the API uses to say "this app lives somewhere else". */
+export declare const WRONG_DATACENTER_CODE = "WRONG_DATACENTER";
+/**
+ * The app's own datacenter is not currently serving clients.
+ *
+ * WHAT MAKES THIS DIFFERENT FROM EVERY OTHER ERROR HERE: there is nothing the
+ * client, the SDK, or the player can do about it. A `WRONG_DATACENTER` is fixed
+ * by moving, an `UNAUTHENTICATED` by logging in, a `RATE_LIMITED` by waiting a
+ * measurable amount of time. This one is fixed by an operator, and the honest
+ * thing for an application to do is stop retrying in a loop and say so.
+ *
+ * {@link message} is written by the server to be shown to a player as-is: it says
+ * what is happening, that it is being worked on, and that there is nothing for
+ * them to do. Prefer it over inventing your own wording, because the server knows
+ * things the client does not — whether this is a brief drain or a whole
+ * datacenter — and its phrasing can improve without an SDK release.
+ *
+ * It carries NO endpoint, on purpose. Do not fall back to a cached one: the
+ * cached one is in the datacenter that is down.
+ *
+ * ```ts
+ * try {
+ *   await client.grids.chunk(appId, x, y, z);
+ * } catch (err) {
+ *   if (err instanceof CrowdyAppUnavailableError) {
+ *     showBanner(err.message);   // "This app is temporarily offline..."
+ *     return;                    // do not retry in a tight loop
+ *   }
+ *   throw err;
+ * }
+ * ```
+ */
+export declare class CrowdyAppUnavailableError extends CrowdyGraphQLError {
+    /** The app the server refused to serve, when it named one. */
+    get appId(): string | undefined;
+    /**
+     * The datacenter that is not serving. Diagnostic only — do not show a player a
+     * datacenter code, and do not try to reach it.
+     */
+    get appDatacenter(): string | undefined;
+    /**
+     * Whether it is worth trying again later. True today for every case the server
+     * raises this for; read it rather than assuming, so a future permanent variant
+     * (an app placed in a datacenter that has been destroyed, say) can say false
+     * without the SDK changing.
+     */
+    get retryable(): boolean;
+}
 /**
  * A network-level failure before any HTTP response was received: DNS failure,
  * TLS error, connection refused, or an aborted `fetch`. Generally retryable

package/dist/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,iFAAiF;AACjF,MAAM,WAAW,yBAAyB;IACxC,mFAAmF;IACnF,OAAO,EAAE,MAAM,CAAC;IAChB,gFAAgF;IAChF,SAAS,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IAC/B,2EAA2E;IAC3E,IAAI,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACpC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED,oEAAoE;AACpE,MAAM,WAAW,kBAAkB;IACjC,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC,yDAAyD;IACzD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;gBAEb,OAAO,EAAE,kBAAkB;CAKxC;AAED;;;;;;GAMG;AACH,qBAAa,eAAgB,SAAQ,WAAW;IAC9C,wCAAwC;IACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAKzC;AAED;;;;;;;;;GASG;AACH,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,oEAAoE;IACpE,QAAQ,CAAC,aAAa,EAAE,yBAAyB,EAAE,CAAC;gBAExC,MAAM,EAAE,yBAAyB,EAAE;IAK/C;;;;;;OAMG;IACH,IAAI,IAAI,IAAI,OAAO,CAElB;IAED;;;;OAIG;IACH,IAAI,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAEpD;CACF;AAED;;;;GAIG;AACH,qBAAa,kBAAmB,SAAQ,WAAW;gBACrC,KAAK,EAAE,OAAO;CAG3B;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,WAAW;gBACrC,SAAS,EAAE,MAAM;CAG9B;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IAClD,8DAA8D;IAC9D,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,yEAAyE;IACzE,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;gBAEjB,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO;CAKnG;AAED;;;;;GAKG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;CAAG"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,iFAAiF;AACjF,MAAM,WAAW,yBAAyB;IACxC,mFAAmF;IACnF,OAAO,EAAE,MAAM,CAAC;IAChB,gFAAgF;IAChF,SAAS,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IAC/B,2EAA2E;IAC3E,IAAI,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC;IACpC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED,oEAAoE;AACpE,MAAM,WAAW,kBAAkB;IACjC,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC,yDAAyD;IACzD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;gBAEb,OAAO,EAAE,kBAAkB;CAKxC;AAED;;;;;;GAMG;AACH,qBAAa,eAAgB,SAAQ,WAAW;IAC9C,wCAAwC;IACxC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,4DAA4D;IAC5D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;gBAEV,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;CAKzC;AAED;;;;;;;;;GASG;AACH,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,oEAAoE;IACpE,QAAQ,CAAC,aAAa,EAAE,yBAAyB,EAAE,CAAC;gBAExC,MAAM,EAAE,yBAAyB,EAAE;IAK/C;;;;;;OAMG;IACH,IAAI,IAAI,IAAI,OAAO,CAElB;IAED;;;;OAIG;IACH,IAAI,UAAU,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAEpD;CACF;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,oBAAoB,CAAC;AAEtD,0EAA0E;AAC1E,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,yBAA0B,SAAQ,kBAAkB;IAC/D,8DAA8D;IAC9D,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAG9B;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,MAAM,GAAG,SAAS,CAGtC;IAED;;;;;OAKG;IACH,IAAI,SAAS,IAAI,OAAO,CAEvB;CACF;AAED;;;;GAIG;AACH,qBAAa,kBAAmB,SAAQ,WAAW;gBACrC,KAAK,EAAE,OAAO;CAG3B;AAED;;;;;;;GAOG;AACH,qBAAa,kBAAmB,SAAQ,WAAW;gBACrC,SAAS,EAAE,MAAM;CAG9B;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IAClD,8DAA8D;IAC9D,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,yEAAyE;IACzE,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;gBAEjB,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAO;CAKnG;AAED;;;;;GAKG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;CAAG"}

package/dist/errors.js

@@ -87,6 +87,70 @@ export class CrowdyGraphQLError extends CrowdyError {
         return this.graphqlErrors[0]?.extensions;
     }
 }
+/**
+ * Extension code the API uses to say "this app's datacenter is not serving".
+ *
+ * Distinct from {@link WRONG_DATACENTER_CODE}, and the distinction is the whole
+ * point: that one names an endpoint to move to, this one deliberately does not,
+ * because there is nowhere to move to.
+ */
+export const APP_UNAVAILABLE_CODE = 'APP_UNAVAILABLE';
+/** Extension code the API uses to say "this app lives somewhere else". */
+export const WRONG_DATACENTER_CODE = 'WRONG_DATACENTER';
+/**
+ * The app's own datacenter is not currently serving clients.
+ *
+ * WHAT MAKES THIS DIFFERENT FROM EVERY OTHER ERROR HERE: there is nothing the
+ * client, the SDK, or the player can do about it. A `WRONG_DATACENTER` is fixed
+ * by moving, an `UNAUTHENTICATED` by logging in, a `RATE_LIMITED` by waiting a
+ * measurable amount of time. This one is fixed by an operator, and the honest
+ * thing for an application to do is stop retrying in a loop and say so.
+ *
+ * {@link message} is written by the server to be shown to a player as-is: it says
+ * what is happening, that it is being worked on, and that there is nothing for
+ * them to do. Prefer it over inventing your own wording, because the server knows
+ * things the client does not — whether this is a brief drain or a whole
+ * datacenter — and its phrasing can improve without an SDK release.
+ *
+ * It carries NO endpoint, on purpose. Do not fall back to a cached one: the
+ * cached one is in the datacenter that is down.
+ *
+ * ```ts
+ * try {
+ *   await client.grids.chunk(appId, x, y, z);
+ * } catch (err) {
+ *   if (err instanceof CrowdyAppUnavailableError) {
+ *     showBanner(err.message);   // "This app is temporarily offline..."
+ *     return;                    // do not retry in a tight loop
+ *   }
+ *   throw err;
+ * }
+ * ```
+ */
+export class CrowdyAppUnavailableError extends CrowdyGraphQLError {
+    /** The app the server refused to serve, when it named one. */
+    get appId() {
+        const value = this.extensions?.appId;
+        return typeof value === 'string' ? value : undefined;
+    }
+    /**
+     * The datacenter that is not serving. Diagnostic only — do not show a player a
+     * datacenter code, and do not try to reach it.
+     */
+    get appDatacenter() {
+        const value = this.extensions?.appDatacenter;
+        return typeof value === 'string' ? value : undefined;
+    }
+    /**
+     * Whether it is worth trying again later. True today for every case the server
+     * raises this for; read it rather than assuming, so a future permanent variant
+     * (an app placed in a datacenter that has been destroyed, say) can say false
+     * without the SDK changing.
+     */
+    get retryable() {
+        return this.extensions?.retryable !== false;
+    }
+}
 /**
  * A network-level failure before any HTTP response was received: DNS failure,
  * TLS error, connection refused, or an aborted `fetch`. Generally retryable