@tinyburg/bitcity-sdk 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,9 @@
-# Temporary Holding Version
+# @tinyburg/bitcity-sdk
 
-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.
+The Bit City api, for the authproxy.
+
+Bit City speaks Nimblebit's NBSync protocol under the game code `bc`. Requests
+are signed with `NimblebitAuth` from `@tinyburg/nimblebit-sdk`, using the
+game's own secret salt, and the endpoints carry the `bitcity` scope tree
+built by `defineGame`. Game-specific save and meta payloads are still
+`Schema.Unknown`.

package/dist/BitCity.d.ts

@@ -0,0 +1,83 @@
+/**
+ * Bit City SDK: signed calls against Nimblebit's NBSync service.
+ *
+ * Signing reuses `@tinyburg/nimblebit-sdk` (`NimblebitAuth`): the game secret
+ * salt (from `NBSync._ss`) is provided as the auth key, and each request is
+ * `md5(<preimage> + <secret salt>)` with a random uint32 `salt` in the path.
+ * All method preimages below are the Tiny Tower formula with the `bc` game code.
+ *
+ * The methods that were exercised live against sync.nimblebit.com are marked
+ * VERIFIED; save-bearing / write paths follow the same pattern but were not
+ * exercised. Save bytes are returned raw (base64-decoded); inflating (pako) and
+ * parsing into a save schema is left to the caller.
+ *
+ * @since 1.0.0
+ * @category SDK
+ */
+import type * as Schema from "effect/Schema";
+import * as Effect from "effect/Effect";
+import { HttpClient } from "effect/http";
+import * as Redacted from "effect/Redacted";
+import { NimblebitAuth } from "@tinyburg/nimblebit-sdk";
+/**
+ * Requests a new player ("burnbot") from the Nimblebit servers. VERIFIED.
+ *
+ * @since 1.0.0
+ * @category SDK
+ */
+export declare const device_newPlayer: Effect.Effect<{
+    readonly playerId: string & import("effect/Brand").Brand<"PlayerId">;
+    readonly playerSs: Redacted.Redacted<string> & import("effect/Brand").Brand<"PlayerAuthKey">;
+}, import("effect/http-api/HttpApiError").BadRequest | import("effect/http-api/HttpApiError").Forbidden | import("effect/http/HttpClientError").HttpClientError | import("effect/http-api/HttpApiError").InternalServerError | import("@tinyburg/nimblebit-sdk/internal/Error").NimblebitError | import("effect/PlatformError").PlatformError | Schema.SchemaError | import("effect/http-api/HttpApiError").Unauthorized, HttpClient.HttpClient | NimblebitAuth.NimblebitAuth>;
+/**
+ * Retrieves player details. VERIFIED.
+ *
+ * @since 1.0.0
+ * @category SDK
+ */
+export declare const device_playerDetails: (args_0: {
+    readonly playerAuthKey: Redacted.Redacted<string> & import("effect/Brand").Brand<"PlayerAuthKey">;
+    readonly playerId: string & import("effect/Brand").Brand<"PlayerId">;
+}) => Effect.Effect<{
+    readonly playerId: string & import("effect/Brand").Brand<"PlayerId">;
+    readonly playerEmail: Redacted.Redacted<string> & import("effect/Brand").Brand<"PlayerEmail">;
+    readonly registered: boolean;
+    readonly blacklisted: boolean;
+    readonly saveVersion: number;
+    readonly checksum: string;
+}, import("effect/http-api/HttpApiError").BadRequest | import("effect/http-api/HttpApiError").Forbidden | import("effect/http/HttpClientError").HttpClientError | import("effect/http-api/HttpApiError").InternalServerError | import("@tinyburg/nimblebit-sdk/internal/Error").NimblebitError | import("effect/PlatformError").PlatformError | Schema.SchemaError | import("effect/http-api/HttpApiError").Unauthorized, HttpClient.HttpClient | NimblebitAuth.NimblebitAuth>;
+/**
+ * Pulls the player's cloud save. Returns raw base64-decoded bytes (inflate +
+ * parse separately). Success envelope DERIVED from Tiny Tower.
+ *
+ * @since 1.0.0
+ * @category SDK
+ */
+export declare const sync_pullSave: (args_0: {
+    readonly playerAuthKey: Redacted.Redacted<string> & import("effect/Brand").Brand<"PlayerAuthKey">;
+    readonly playerId: string & import("effect/Brand").Brand<"PlayerId">;
+}) => Effect.Effect<{
+    readonly success: "NotFound";
+} | {
+    readonly success: "Found";
+    readonly data: Uint8Array<ArrayBufferLike>;
+    readonly checksum: string;
+    readonly saveId: number;
+}, import("effect/http-api/HttpApiError").BadRequest | import("effect/http-api/HttpApiError").Forbidden | import("effect/http/HttpClientError").HttpClientError | import("effect/http-api/HttpApiError").InternalServerError | import("@tinyburg/nimblebit-sdk/internal/Error").NimblebitError | import("effect/PlatformError").PlatformError | Schema.SchemaError | import("effect/http-api/HttpApiError").Unauthorized, HttpClient.HttpClient | NimblebitAuth.NimblebitAuth>;
+/**
+ * Lists items (parts/gifts) waiting for the player. VERIFIED
+ * (`/get_items/pt/...` -> `{ success:"Found", gifts:[...] }`, no total).
+ *
+ * @since 1.0.0
+ * @category SDK
+ */
+export declare const social_getItems: (args_0: {
+    readonly playerAuthKey: Redacted.Redacted<string> & import("effect/Brand").Brand<"PlayerAuthKey">;
+    readonly playerId: string & import("effect/Brand").Brand<"PlayerId">;
+}) => Effect.Effect<{
+    readonly success: "NotFound";
+} | {
+    readonly success: "Found";
+    readonly gifts: readonly unknown[];
+}, import("effect/http-api/HttpApiError").BadRequest | import("effect/http-api/HttpApiError").Forbidden | import("effect/http/HttpClientError").HttpClientError | import("effect/http-api/HttpApiError").InternalServerError | import("@tinyburg/nimblebit-sdk/internal/Error").NimblebitError | import("effect/PlatformError").PlatformError | Schema.SchemaError | import("effect/http-api/HttpApiError").Unauthorized, HttpClient.HttpClient | NimblebitAuth.NimblebitAuth>;
+//# sourceMappingURL=BitCity.d.ts.map

package/dist/BitCity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BitCity.d.ts","sourceRoot":"","sources":["../src/BitCity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAC;AAE7C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,UAAU,EAAqB,MAAM,aAAa,CAAC;AAE5D,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAI5C,OAAO,EAAE,aAAa,EAAkB,MAAM,yBAAyB,CAAC;AAIxE;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB;;;8cA6B3B,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;8cA+B/B,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;8cA+BxB,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,eAAe;;;;;;;;8cA+B1B,CAAC"}

package/dist/BitCity.js

@@ -0,0 +1,172 @@
+/**
+ * Bit City SDK: signed calls against Nimblebit's NBSync service.
+ *
+ * Signing reuses `@tinyburg/nimblebit-sdk` (`NimblebitAuth`): the game secret
+ * salt (from `NBSync._ss`) is provided as the auth key, and each request is
+ * `md5(<preimage> + <secret salt>)` with a random uint32 `salt` in the path.
+ * All method preimages below are the Tiny Tower formula with the `bc` game code.
+ *
+ * The methods that were exercised live against sync.nimblebit.com are marked
+ * VERIFIED; save-bearing / write paths follow the same pattern but were not
+ * exercised. Save bytes are returned raw (base64-decoded); inflating (pako) and
+ * parsing into a save schema is left to the caller.
+ *
+ * @since 1.0.0
+ * @category SDK
+ */
+import * as Effect from "effect/Effect";
+import * as Function from "effect/Function";
+import { HttpClient, HttpClientRequest } from "effect/http";
+import { HttpApiClient } from "effect/http-api";
+import * as Redacted from "effect/Redacted";
+import { NimblebitAuth, NimblebitError } from "@tinyburg/nimblebit-sdk";
+import * as Endpoints from "./Endpoints.js";
+/**
+ * Requests a new player ("burnbot") from the Nimblebit servers. VERIFIED.
+ *
+ * @since 1.0.0
+ * @category SDK
+ */
+export const device_newPlayer = /*#__PURE__*/Effect.gen(function* () {
+  const nimblebitAuth = yield* NimblebitAuth.NimblebitAuth;
+  const httpClient = yield* HttpClient.HttpClient;
+  const maybeAddBearerToken = nimblebitAuth.host !== "https://sync.nimblebit.com" ? HttpClientRequest.bearerToken(nimblebitAuth.authKey) : Function.identity;
+  const endpoint = yield* HttpApiClient.endpoint(Endpoints.Api, {
+    baseUrl: nimblebitAuth.host,
+    group: "DeviceManagementGroup",
+    endpoint: "DeviceNewPlayer",
+    httpClient: HttpClient.mapRequest(httpClient, maybeAddBearerToken)
+  });
+  const salt1 = yield* nimblebitAuth.salt;
+  const salt2 = yield* nimblebitAuth.salt;
+  const hash = yield* nimblebitAuth.sign(`bc/${salt1}/${salt2}`);
+  const response = yield* endpoint({
+    params: {
+      salt1,
+      salt2,
+      hash
+    }
+  });
+  if ("error" in response) {
+    return yield* new NimblebitError.NimblebitError({
+      method: "DeviceNewPlayer",
+      module: "DeviceManagementGroup",
+      cause: response.error
+    });
+  }
+  return response;
+});
+/**
+ * Retrieves player details. VERIFIED.
+ *
+ * @since 1.0.0
+ * @category SDK
+ */
+export const device_playerDetails = /*#__PURE__*/Effect.fn("device_playerDetails")(function* ({
+  playerAuthKey,
+  playerId
+}) {
+  const nimblebitAuth = yield* NimblebitAuth.NimblebitAuth;
+  const httpClient = yield* HttpClient.HttpClient;
+  const maybeAddBearerToken = nimblebitAuth.host !== "https://sync.nimblebit.com" ? HttpClientRequest.bearerToken(nimblebitAuth.authKey) : Function.identity;
+  const endpoint = yield* HttpApiClient.endpoint(Endpoints.Api, {
+    baseUrl: nimblebitAuth.host,
+    group: "DeviceManagementGroup",
+    endpoint: "DevicePlayerDetails",
+    httpClient: HttpClient.mapRequest(httpClient, maybeAddBearerToken)
+  });
+  const salt = yield* nimblebitAuth.salt;
+  const hash = yield* nimblebitAuth.sign(`bc/${playerId}/${salt}${Redacted.value(playerAuthKey)}`);
+  const response = yield* endpoint({
+    params: {
+      playerId,
+      salt,
+      hash
+    }
+  });
+  if ("error" in response) {
+    return yield* new NimblebitError.NimblebitError({
+      method: "DevicePlayerDetails",
+      module: "DeviceManagementGroup",
+      cause: response.error
+    });
+  }
+  return response.player;
+});
+/**
+ * Pulls the player's cloud save. Returns raw base64-decoded bytes (inflate +
+ * parse separately). Success envelope DERIVED from Tiny Tower.
+ *
+ * @since 1.0.0
+ * @category SDK
+ */
+export const sync_pullSave = /*#__PURE__*/Effect.fn("sync_pullSave")(function* ({
+  playerAuthKey,
+  playerId
+}) {
+  const nimblebitAuth = yield* NimblebitAuth.NimblebitAuth;
+  const httpClient = yield* HttpClient.HttpClient;
+  const maybeAddBearerToken = nimblebitAuth.host !== "https://sync.nimblebit.com" ? HttpClientRequest.bearerToken(nimblebitAuth.authKey) : Function.identity;
+  const endpoint = yield* HttpApiClient.endpoint(Endpoints.Api, {
+    baseUrl: nimblebitAuth.host,
+    group: "SyncManagementGroup",
+    endpoint: "SyncPullSave",
+    httpClient: HttpClient.mapRequest(httpClient, maybeAddBearerToken)
+  });
+  const salt = yield* nimblebitAuth.salt;
+  const hash = yield* nimblebitAuth.sign(`bc/${playerId}/${salt}${Redacted.value(playerAuthKey)}`);
+  const response = yield* endpoint({
+    params: {
+      playerId,
+      salt,
+      hash
+    }
+  });
+  if ("error" in response) {
+    return yield* new NimblebitError.NimblebitError({
+      method: "SyncPullSave",
+      module: "SyncManagementGroup",
+      cause: response.error
+    });
+  }
+  return response;
+});
+/**
+ * Lists items (parts/gifts) waiting for the player. VERIFIED
+ * (`/get_items/pt/...` -> `{ success:"Found", gifts:[...] }`, no total).
+ *
+ * @since 1.0.0
+ * @category SDK
+ */
+export const social_getItems = /*#__PURE__*/Effect.fn("social_getItems")(function* ({
+  playerAuthKey,
+  playerId
+}) {
+  const nimblebitAuth = yield* NimblebitAuth.NimblebitAuth;
+  const httpClient = yield* HttpClient.HttpClient;
+  const maybeAddBearerToken = nimblebitAuth.host !== "https://sync.nimblebit.com" ? HttpClientRequest.bearerToken(nimblebitAuth.authKey) : Function.identity;
+  const endpoint = yield* HttpApiClient.endpoint(Endpoints.Api, {
+    baseUrl: nimblebitAuth.host,
+    group: "SocialGroup",
+    endpoint: "SocialGetItems",
+    httpClient: HttpClient.mapRequest(httpClient, maybeAddBearerToken)
+  });
+  const salt = yield* nimblebitAuth.salt;
+  const hash = yield* nimblebitAuth.sign(`bc/${playerId}/${salt}${Redacted.value(playerAuthKey)}`);
+  const response = yield* endpoint({
+    params: {
+      playerId,
+      salt,
+      hash
+    }
+  });
+  if ("error" in response) {
+    return yield* new NimblebitError.NimblebitError({
+      method: "SocialGetItems",
+      module: "SocialGroup",
+      cause: response.error
+    });
+  }
+  return response;
+});
+//# sourceMappingURL=BitCity.js.map

package/dist/BitCity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BitCity.js","names":[],"sources":["../src/BitCity.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;AAmBA,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,OAAO,KAAK,QAAQ,MAAM,iBAAiB;AAC3C,SAAS,UAAU,EAAE,iBAAiB,QAAQ,aAAa;AAC3D,SAAS,aAAa,QAAQ,iBAAiB;AAC/C,OAAO,KAAK,QAAQ,MAAM,iBAAiB;AAI3C,SAAS,aAAa,EAAE,cAAc,QAAQ,yBAAyB;AAEvE,OAAO,KAAK,SAAS,MAAM,gBAAgB;AAE3C;;;;;;AAMA,OAAO,MAAM,gBAAgB,gBAAG,MAAM,CAAC,GAAG,CAAC,aAAS;EAChD,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,aAAa;EACxD,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,UAAU;EAE/C,MAAM,mBAAmB,GACrB,aAAa,CAAC,IAAI,KAAK,4BAA4B,GAC7C,iBAAiB,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,GACpD,QAAQ,CAAC,QAAQ;EAE3B,MAAM,QAAQ,GAAG,OAAO,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE;IAC1D,OAAO,EAAE,aAAa,CAAC,IAAI;IAC3B,KAAK,EAAE,uBAAuB;IAC9B,QAAQ,EAAE,iBAAiB;IAC3B,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,UAAU,EAAE,mBAAmB;GACpE,CAAC;EAEF,MAAM,KAAK,GAAG,OAAO,aAAa,CAAC,IAAI;EACvC,MAAM,KAAK,GAAG,OAAO,aAAa,CAAC,IAAI;EACvC,MAAM,IAAI,GAAG,OAAO,aAAa,CAAC,IAAI,CAAC,MAAM,KAAK,IAAI,KAAK,EAAE,CAAC;EAC9D,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC;IAAE,MAAM,EAAE;MAAE,KAAK;MAAE,KAAK;MAAE;IAAI;EAAE,CAAE,CAAC;EAEpE,IAAI,OAAO,IAAI,QAAQ,EAAE;IACrB,OAAO,OAAO,IAAI,cAAc,CAAC,cAAc,CAAC;MAC5C,MAAM,EAAE,iBAAiB;MACzB,MAAM,EAAE,uBAAuB;MAC/B,KAAK,EAAE,QAAQ,CAAC;KACnB,CAAC;EACN;EACA,OAAO,QAAQ;AACnB,CAAC,CAAC;AAEF;;;;;;AAMA,OAAO,MAAM,oBAAoB,gBAAG,MAAM,CAAC,EAAE,CAAC,sBAAsB,CAAC,CAAC,WAAW;EAC7E,aAAa;EACb;AAAQ,CAC2D;EACnE,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,aAAa;EACxD,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,UAAU;EAE/C,MAAM,mBAAmB,GACrB,aAAa,CAAC,IAAI,KAAK,4BAA4B,GAC7C,iBAAiB,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,GACpD,QAAQ,CAAC,QAAQ;EAE3B,MAAM,QAAQ,GAAG,OAAO,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE;IAC1D,OAAO,EAAE,aAAa,CAAC,IAAI;IAC3B,KAAK,EAAE,uBAAuB;IAC9B,QAAQ,EAAE,qBAAqB;IAC/B,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,UAAU,EAAE,mBAAmB;GACpE,CAAC;EAEF,MAAM,IAAI,GAAG,OAAO,aAAa,CAAC,IAAI;EACtC,MAAM,IAAI,GAAG,OAAO,aAAa,CAAC,IAAI,CAAC,MAAM,QAAQ,IAAI,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;EAChG,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC;IAAE,MAAM,EAAE;MAAE,QAAQ;MAAE,IAAI;MAAE;IAAI;EAAE,CAAE,CAAC;EAEtE,IAAI,OAAO,IAAI,QAAQ,EAAE;IACrB,OAAO,OAAO,IAAI,cAAc,CAAC,cAAc,CAAC;MAC5C,MAAM,EAAE,qBAAqB;MAC7B,MAAM,EAAE,uBAAuB;MAC/B,KAAK,EAAE,QAAQ,CAAC;KACnB,CAAC;EACN;EACA,OAAO,QAAQ,CAAC,MAAM;AAC1B,CAAC,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAM,aAAa,gBAAG,MAAM,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,WAAW;EAC/D,aAAa;EACb;AAAQ,CAC2D;EACnE,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,aAAa;EACxD,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,UAAU;EAE/C,MAAM,mBAAmB,GACrB,aAAa,CAAC,IAAI,KAAK,4BAA4B,GAC7C,iBAAiB,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,GACpD,QAAQ,CAAC,QAAQ;EAE3B,MAAM,QAAQ,GAAG,OAAO,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE;IAC1D,OAAO,EAAE,aAAa,CAAC,IAAI;IAC3B,KAAK,EAAE,qBAAqB;IAC5B,QAAQ,EAAE,cAAc;IACxB,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,UAAU,EAAE,mBAAmB;GACpE,CAAC;EAEF,MAAM,IAAI,GAAG,OAAO,aAAa,CAAC,IAAI;EACtC,MAAM,IAAI,GAAG,OAAO,aAAa,CAAC,IAAI,CAAC,MAAM,QAAQ,IAAI,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;EAChG,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC;IAAE,MAAM,EAAE;MAAE,QAAQ;MAAE,IAAI;MAAE;IAAI;EAAE,CAAE,CAAC;EAEtE,IAAI,OAAO,IAAI,QAAQ,EAAE;IACrB,OAAO,OAAO,IAAI,cAAc,CAAC,cAAc,CAAC;MAC5C,MAAM,EAAE,cAAc;MACtB,MAAM,EAAE,qBAAqB;MAC7B,KAAK,EAAE,QAAQ,CAAC;KACnB,CAAC;EACN;EACA,OAAO,QAAQ;AACnB,CAAC,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAM,eAAe,gBAAG,MAAM,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC,WAAW;EACnE,aAAa;EACb;AAAQ,CAC2D;EACnE,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,aAAa;EACxD,MAAM,UAAU,GAAG,OAAO,UAAU,CAAC,UAAU;EAE/C,MAAM,mBAAmB,GACrB,aAAa,CAAC,IAAI,KAAK,4BAA4B,GAC7C,iBAAiB,CAAC,WAAW,CAAC,aAAa,CAAC,OAAO,CAAC,GACpD,QAAQ,CAAC,QAAQ;EAE3B,MAAM,QAAQ,GAAG,OAAO,aAAa,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE;IAC1D,OAAO,EAAE,aAAa,CAAC,IAAI;IAC3B,KAAK,EAAE,aAAa;IACpB,QAAQ,EAAE,gBAAgB;IAC1B,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,UAAU,EAAE,mBAAmB;GACpE,CAAC;EAEF,MAAM,IAAI,GAAG,OAAO,aAAa,CAAC,IAAI;EACtC,MAAM,IAAI,GAAG,OAAO,aAAa,CAAC,IAAI,CAAC,MAAM,QAAQ,IAAI,IAAI,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;EAChG,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC;IAAE,MAAM,EAAE;MAAE,QAAQ;MAAE,IAAI;MAAE;IAAI;EAAE,CAAE,CAAC;EAEtE,IAAI,OAAO,IAAI,QAAQ,EAAE;IACrB,OAAO,OAAO,IAAI,cAAc,CAAC,cAAc,CAAC;MAC5C,MAAM,EAAE,gBAAgB;MACxB,MAAM,EAAE,aAAa;MACrB,KAAK,EAAE,QAAQ,CAAC;KACnB,CAAC;EACN;EACA,OAAO,QAAQ;AACnB,CAAC,CAAC","ignoreList":[]}

package/dist/Endpoints.d.ts

@@ -0,0 +1,177 @@
+/**
+ * Bit City (game code `bc`) NBSync api endpoints.
+ *
+ * Signing: a random `salt` (signed int32) goes in the path, and `hash` is
+ * `md5(<preimage> + <game secret salt>)` with the preimage
+ * `bc/<playerId>/<salt><playerAuthKey>` (variants noted per endpoint). The
+ * secret salt is the value extracted from `NBSync._ss`.
+ *
+ * Verification (live server + Frida DTO inspection of the game, 2026-08-26):
+ * - Signing is MD5, server-validated (same scheme as Tiny Tower / Pocket
+ *   Planes; the game computes SHA-256 only for the unauthenticated `register`).
+ * - Response envelopes VERIFIED by reading the game's DTO classes at runtime:
+ *   register, player_details, sync/pull (NBSyncGameSaveResponse), current_version,
+ *   verify_device, friend/pull_game, friend/pull_meta (meta is a flat
+ *   Dictionary<String,Object> on pt), send_item (NBSyncItemsSendResponse),
+ *   get_items (NBSyncItemsGetResponse: success/gifts, NO `total` unlike pp).
+ *   `get_items` was also exercised live with a burnbot.
+ * - Minimal NBSync endpoint set (Bit City is a lightweight city builder).
+ *
+ * Game-specific save/meta schemas are left as `Schema.Unknown` placeholders.
+ *
+ * @since 1.0.0
+ * @category Endpoints
+ */
+import { HttpApi, HttpApiEndpoint, HttpApiError, HttpApiGroup } from "effect/http-api";
+import * as Schema from "effect/Schema";
+/**
+ * A gift/item in the general item channel (get_items / send_item). Verified DTO
+ * NBSyncItemsGift on pt: `{gift_id, gift_to, gift_from, gift_type, item_type,
+ * gift_str, h}` (no `c`, unlike pp). Left open for the data-schema work.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export declare const Gift: Schema.Unknown;
+/**
+ * The Bit City NBSync api.
+ *
+ * @since 1.0.0
+ * @category Api
+ */
+export declare const Api: HttpApi.HttpApi<"BitCityApi", HttpApiGroup.HttpApiGroup<"DeviceManagementGroup", HttpApiEndpoint.HttpApiEndpoint<"DeviceNewPlayer", "GET", "/register/bc/:salt1/:salt2/:hash", Schema.toCodecStringTree<Schema.Struct<{
+    salt1: Schema.Int;
+    salt2: Schema.Int;
+    hash: Schema.String;
+}>>, never, never, never, Schema.toCodecJson<Schema.Struct<{
+    readonly error: Schema.String;
+}> | Schema.encodeKeys<Schema.Struct<{
+    readonly playerId: Schema.brand<Schema.String, "PlayerId">;
+    readonly playerSs: Schema.brand<Schema.RedactedFromValue<Schema.String>, "PlayerAuthKey">;
+}>, {
+    readonly playerId: "player_id";
+    readonly playerSs: "player_ss";
+}>>, Schema.toCodecJson<typeof HttpApiError.BadRequest | typeof HttpApiError.Unauthorized | typeof HttpApiError.Forbidden | typeof HttpApiError.InternalServerError>, never, never> | HttpApiEndpoint.HttpApiEndpoint<"DevicePlayerDetails", "GET", "/player_details/bc/:playerId/:salt/:hash", Schema.toCodecStringTree<Schema.Struct<{
+    playerId: Schema.brand<Schema.String, "PlayerId">;
+    salt: Schema.Int;
+    hash: Schema.String;
+}>>, never, never, never, Schema.toCodecJson<Schema.Struct<{
+    readonly error: Schema.String;
+}> | Schema.Struct<{
+    readonly success: Schema.Literal<"Found">;
+    readonly player: Schema.encodeKeys<Schema.Struct<{
+        readonly playerId: Schema.brand<Schema.String, "PlayerId">;
+        readonly playerEmail: Schema.brand<Schema.RedactedFromValue<Schema.String>, "PlayerEmail">;
+        readonly registered: Schema.compose<Schema.BooleanFromBit, Schema.NumberFromString>;
+        readonly blacklisted: Schema.compose<Schema.BooleanFromBit, Schema.NumberFromString>;
+        readonly saveVersion: Schema.compose<Schema.Int, Schema.NumberFromString>;
+        readonly checksum: Schema.String;
+    }>, {
+        readonly playerId: "player_id";
+        readonly playerEmail: "email";
+        readonly checksum: "h";
+    }>;
+}>>, Schema.toCodecJson<typeof HttpApiError.BadRequest | typeof HttpApiError.Unauthorized | typeof HttpApiError.Forbidden | typeof HttpApiError.InternalServerError>, never, never> | HttpApiEndpoint.HttpApiEndpoint<"DeviceVerifyDevice", "GET", "/verify_device/bc/:playerId/:verificationCode", Schema.toCodecStringTree<Schema.Struct<{
+    playerId: Schema.brand<Schema.String, "PlayerId">;
+    verificationCode: Schema.String;
+}>>, never, never, never, Schema.toCodecJson<Schema.Struct<{
+    readonly error: Schema.String;
+}> | Schema.encodeKeys<Schema.Struct<{
+    readonly success: Schema.Literal<"NewDevice">;
+    readonly playerId: Schema.brand<Schema.String, "PlayerId">;
+    readonly playerAuthKey: Schema.brand<Schema.RedactedFromValue<Schema.String>, "PlayerAuthKey">;
+    readonly playerEmail: Schema.brand<Schema.RedactedFromValue<Schema.String>, "PlayerEmail">;
+}>, {
+    readonly playerId: "player_id";
+    readonly playerAuthKey: "player_ss";
+    readonly playerEmail: "player_email";
+}>>, Schema.toCodecJson<typeof HttpApiError.BadRequest | typeof HttpApiError.Unauthorized | typeof HttpApiError.Forbidden | typeof HttpApiError.InternalServerError>, never, never>, false> | HttpApiGroup.HttpApiGroup<"SocialGroup", HttpApiEndpoint.HttpApiEndpoint<"SocialGetItems", "GET", "/get_items/bc/:playerId/:salt/:hash", Schema.toCodecStringTree<Schema.Struct<{
+    playerId: Schema.brand<Schema.String, "PlayerId">;
+    salt: Schema.Int;
+    hash: Schema.String;
+}>>, never, never, never, Schema.toCodecJson<Schema.Struct<{
+    readonly error: Schema.String;
+}> | Schema.Struct<{
+    readonly success: Schema.Literal<"NotFound">;
+}> | Schema.Struct<{
+    readonly success: Schema.Literal<"Found">;
+    readonly gifts: Schema.$Array<Schema.Unknown>;
+}>>, Schema.toCodecJson<typeof HttpApiError.BadRequest | typeof HttpApiError.Unauthorized | typeof HttpApiError.Forbidden | typeof HttpApiError.InternalServerError>, never, never> | HttpApiEndpoint.HttpApiEndpoint<"SocialPullFriendGame", "GET", "/friend/pull_game/bc/:playerId/:friendId/:salt/:hash", Schema.toCodecStringTree<Schema.Struct<{
+    playerId: Schema.brand<Schema.String, "PlayerId">;
+    friendId: Schema.brand<Schema.String, "PlayerId">;
+    salt: Schema.Int;
+    hash: Schema.String;
+}>>, never, never, never, Schema.toCodecJson<Schema.Struct<{
+    readonly error: Schema.String;
+}> | Schema.Struct<{
+    readonly success: Schema.Literal<"NotFound">;
+}> | Schema.encodeKeys<Schema.Struct<{
+    readonly success: Schema.Literal<"Found">;
+    readonly data: Schema.Uint8ArrayFromBase64;
+    readonly checksum: Schema.String;
+    readonly saveId: Schema.NumberFromString;
+    readonly playerId: Schema.brand<Schema.String, "PlayerId">;
+}>, {
+    readonly checksum: "h";
+    readonly saveId: "id";
+    readonly playerId: "player_id";
+}>>, Schema.toCodecJson<typeof HttpApiError.BadRequest | typeof HttpApiError.Unauthorized | typeof HttpApiError.Forbidden | typeof HttpApiError.InternalServerError>, never, never> | HttpApiEndpoint.HttpApiEndpoint<"SocialPullFriendMeta", "POST", "/friend/pull_meta/bc/:playerId/:salt/:hash", Schema.toCodecStringTree<Schema.Struct<{
+    playerId: Schema.brand<Schema.String, "PlayerId">;
+    salt: Schema.Int;
+    hash: Schema.String;
+}>>, never, Schema.toCodecJson<Schema.Struct<{
+    readonly friends: Schema.brand<Schema.String, "PlayerId">;
+}>>, never, Schema.toCodecJson<Schema.Struct<{
+    readonly error: Schema.String;
+}> | Schema.Struct<{
+    readonly success: Schema.Literal<"NotFound">;
+}> | Schema.Struct<{
+    readonly success: Schema.Literal<"Found">;
+    readonly meta: Schema.$Record<Schema.brand<Schema.String, "PlayerId">, Schema.Unknown>;
+}>>, Schema.toCodecJson<typeof HttpApiError.BadRequest | typeof HttpApiError.Unauthorized | typeof HttpApiError.Forbidden | typeof HttpApiError.InternalServerError>, never, never> | HttpApiEndpoint.HttpApiEndpoint<"SocialSendItem", "POST", "/send_item/bc/:itemType/:playerId/:friendId/:salt/:hash", Schema.toCodecStringTree<Schema.Struct<{
+    itemType: Schema.String;
+    playerId: Schema.brand<Schema.String, "PlayerId">;
+    friendId: Schema.brand<Schema.String, "PlayerId">;
+    salt: Schema.Int;
+    hash: Schema.String;
+}>>, never, Schema.toCodecJson<Schema.Struct<{
+    readonly itemStr: Schema.String;
+}>>, never, Schema.toCodecJson<Schema.Struct<{
+    readonly error: Schema.String;
+}> | Schema.Struct<{
+    readonly success: Schema.Literal<"Sent">;
+}> | Schema.Struct<{
+    readonly success: Schema.Literal<"NotSent">;
+}>>, Schema.toCodecJson<typeof HttpApiError.BadRequest | typeof HttpApiError.Unauthorized | typeof HttpApiError.Forbidden | typeof HttpApiError.InternalServerError>, never, never>, false> | HttpApiGroup.HttpApiGroup<"SyncManagementGroup", HttpApiEndpoint.HttpApiEndpoint<"SyncCheckForNewerSave", "GET", "/sync/current_version/bc/:playerId/:salt/:hash", Schema.toCodecStringTree<Schema.Struct<{
+    playerId: Schema.brand<Schema.String, "PlayerId">;
+    salt: Schema.Int;
+    hash: Schema.String;
+}>>, never, never, never, Schema.toCodecJson<Schema.Struct<{
+    readonly error: Schema.String;
+}> | Schema.Struct<{
+    readonly success: Schema.Literal<"NotFound">;
+}> | Schema.encodeKeys<Schema.Struct<{
+    readonly success: Schema.Literal<"Found">;
+    readonly checksum: Schema.String;
+    readonly saveId: Schema.NumberFromString;
+}>, {
+    readonly checksum: "h";
+    readonly saveId: "id";
+}>>, Schema.toCodecJson<typeof HttpApiError.BadRequest | typeof HttpApiError.Unauthorized | typeof HttpApiError.Forbidden | typeof HttpApiError.InternalServerError>, never, never> | HttpApiEndpoint.HttpApiEndpoint<"SyncPullSave", "GET", "/sync/pull/bc/:playerId/:salt/:hash", Schema.toCodecStringTree<Schema.Struct<{
+    playerId: Schema.brand<Schema.String, "PlayerId">;
+    salt: Schema.Int;
+    hash: Schema.String;
+}>>, never, never, never, Schema.toCodecJson<Schema.Struct<{
+    readonly error: Schema.String;
+}> | Schema.Struct<{
+    readonly success: Schema.Literal<"NotFound">;
+}> | Schema.encodeKeys<Schema.Struct<{
+    readonly success: Schema.Literal<"Found">;
+    readonly data: Schema.Uint8ArrayFromBase64;
+    readonly checksum: Schema.String;
+    readonly saveId: Schema.NumberFromString;
+}>, {
+    readonly checksum: "h";
+    readonly saveId: "id";
+}>>, Schema.toCodecJson<typeof HttpApiError.BadRequest | typeof HttpApiError.Unauthorized | typeof HttpApiError.Forbidden | typeof HttpApiError.InternalServerError>, never, never>, false>>;
+//# sourceMappingURL=Endpoints.d.ts.map

package/dist/Endpoints.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Endpoints.d.ts","sourceRoot":"","sources":["../src/Endpoints.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACvF,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AA8BxC;;;;;;;GAOG;AACH,eAAO,MAAM,IAAI,gBAAiB,CAAC;AAwNnC;;;;;GAKG;AACH,eAAO,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;4LAAkG,CAAC"}