@tinyburg/bitcity-sdk 0.0.0-stage → 0.1.1

package/dist/Endpoints.js

@@ -0,0 +1,259 @@
+/**
+ * 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";
+import * as NimblebitConfig from "@tinyburg/nimblebit-sdk/NimblebitConfig";
+import * as OAuthScope from "@yielded/auth/OAuthScope";
+import * as Scopes from "./Scopes.js";
+/** @internal */
+export const U32 = /*#__PURE__*/Schema.Int.check(/*#__PURE__*/Schema.isUint32());
+/** @internal */
+export const ApiErrors = [HttpApiError.Forbidden, HttpApiError.BadRequest, HttpApiError.Unauthorized, HttpApiError.InternalServerError];
+/** @internal */
+export const ErrorResponse = /*#__PURE__*/Schema.Struct({
+  error: Schema.String
+});
+/** @internal */
+export const NotFoundResponse = /*#__PURE__*/Schema.Struct({
+  success: /*#__PURE__*/Schema.Literal("NotFound")
+});
+/** @internal */
+export const SentResponse = /*#__PURE__*/Schema.Struct({
+  success: /*#__PURE__*/Schema.Literal("Sent")
+});
+/** @internal */
+export const NotSentResponse = /*#__PURE__*/Schema.Struct({
+  success: /*#__PURE__*/Schema.Literal("NotSent")
+});
+/**
+ * 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 const Gift = Schema.Unknown;
+/** @internal */
+export const DeviceNewPlayerEndpoint = /*#__PURE__*/HttpApiEndpoint.get("DeviceNewPlayer", "/register/bc/:salt1/:salt2/:hash", {
+  params: {
+    salt1: U32,
+    salt2: U32,
+    hash: Schema.String
+  },
+  error: ApiErrors,
+  success: [ErrorResponse, /*#__PURE__*/Schema.Struct({
+    playerId: NimblebitConfig.PlayerIdSchema,
+    playerSs: NimblebitConfig.PlayerAuthKeySchema
+  }).pipe(/*#__PURE__*/Schema.encodeKeys({
+    playerId: "player_id",
+    playerSs: "player_ss"
+  }))]
+});
+/** @internal */
+export const DevicePlayerDetailsEndpoint = /*#__PURE__*/HttpApiEndpoint.get("DevicePlayerDetails", "/player_details/bc/:playerId/:salt/:hash", {
+  params: {
+    playerId: NimblebitConfig.PlayerIdSchema,
+    salt: U32,
+    hash: Schema.String
+  },
+  error: ApiErrors,
+  success: [ErrorResponse, Schema.Struct({
+    success: Schema.Literal("Found"),
+    player: Schema.Struct({
+      playerId: NimblebitConfig.PlayerIdSchema,
+      playerEmail: NimblebitConfig.PlayerEmailSchema,
+      registered: Schema.NumberFromString.pipe(Schema.decodeTo(Schema.BooleanFromBit)),
+      blacklisted: Schema.NumberFromString.pipe(Schema.decodeTo(Schema.BooleanFromBit)),
+      saveVersion: Schema.NumberFromString.pipe(Schema.decodeTo(Schema.Int)),
+      checksum: Schema.String
+    }).pipe(Schema.encodeKeys({
+      playerId: "player_id",
+      playerEmail: "email",
+      checksum: "h"
+    }))
+  })]
+}).annotate(OAuthScope.Required, Scopes.Device.read.player_details.required);
+/** @internal */
+export const DeviceVerifyDeviceEndpoint = /*#__PURE__*/HttpApiEndpoint.get("DeviceVerifyDevice", "/verify_device/bc/:playerId/:verificationCode", {
+  params: {
+    playerId: NimblebitConfig.PlayerIdSchema,
+    verificationCode: Schema.String
+  },
+  error: ApiErrors,
+  success: [ErrorResponse, Schema.Struct({
+    success: Schema.Literal("NewDevice"),
+    playerId: NimblebitConfig.PlayerIdSchema,
+    playerAuthKey: NimblebitConfig.PlayerAuthKeySchema,
+    playerEmail: NimblebitConfig.PlayerEmailSchema
+  }).pipe(Schema.encodeKeys({
+    playerId: "player_id",
+    playerAuthKey: "player_ss",
+    playerEmail: "player_email"
+  }))]
+}).annotate(OAuthScope.Required, Scopes.Device.write.verify_device.required);
+/**
+ * Pull the player's cloud save. VERIFIED envelope (NBSyncGameSaveResponse). No-save
+ * case returns `{ error: "SaveNotFound" }`. `data` is base64 pako-deflated bytes.
+ *
+ * @internal
+ */
+export const SyncPullSaveEndpoint = /*#__PURE__*/HttpApiEndpoint.get("SyncPullSave", "/sync/pull/bc/:playerId/:salt/:hash", {
+  params: {
+    playerId: NimblebitConfig.PlayerIdSchema,
+    salt: U32,
+    hash: Schema.String
+  },
+  error: ApiErrors,
+  success: [ErrorResponse, NotFoundResponse, /*#__PURE__*/Schema.Struct({
+    success: Schema.Literal("Found"),
+    data: Schema.Uint8ArrayFromBase64,
+    checksum: Schema.String,
+    saveId: Schema.NumberFromString
+  }).pipe(/*#__PURE__*/Schema.encodeKeys({
+    checksum: "h",
+    saveId: "id"
+  }))]
+});
+/**
+ * VERIFIED envelope (NBSyncCurrentCheckResponse); no-save returns `{ error: "NoSave" }`.
+ *
+ * @internal
+ */
+export const SyncCheckForNewerSaveEndpoint = /*#__PURE__*/HttpApiEndpoint.get("SyncCheckForNewerSave", "/sync/current_version/bc/:playerId/:salt/:hash", {
+  params: {
+    playerId: NimblebitConfig.PlayerIdSchema,
+    salt: U32,
+    hash: Schema.String
+  },
+  error: ApiErrors,
+  success: [ErrorResponse, NotFoundResponse, /*#__PURE__*/Schema.Struct({
+    success: Schema.Literal("Found"),
+    checksum: Schema.String,
+    saveId: Schema.NumberFromString
+  }).pipe(/*#__PURE__*/Schema.encodeKeys({
+    checksum: "h",
+    saveId: "id"
+  }))]
+});
+/**
+ * VERIFIED live: `/get_items/bc/:playerId/:salt/:hash` -> `{ success:"Found",
+ * gifts:[...] }` (NBSyncItemsGetResponse; no `total` on pt).
+ *
+ * @internal
+ */
+export const SocialGetItemsEndpoint = /*#__PURE__*/HttpApiEndpoint.get("SocialGetItems", "/get_items/bc/:playerId/:salt/:hash", {
+  params: {
+    playerId: NimblebitConfig.PlayerIdSchema,
+    salt: U32,
+    hash: Schema.String
+  },
+  error: ApiErrors,
+  success: [ErrorResponse, NotFoundResponse, Schema.Struct({
+    success: Schema.Literal("Found"),
+    gifts: Schema.Array(Gift)
+  })]
+}).annotate(OAuthScope.Required, Scopes.Social.read.get_items.required);
+/**
+ * DERIVED from Tiny Tower. Sends an item to a friend. Response VERIFIED
+ * (NBSyncItemsSendResponse: success/error). pt also has a `/send_pt/` variant.
+ *
+ * @internal
+ */
+export const SocialSendItemEndpoint = /*#__PURE__*/HttpApiEndpoint.post("SocialSendItem", "/send_item/bc/:itemType/:playerId/:friendId/:salt/:hash", {
+  params: {
+    itemType: Schema.String,
+    playerId: NimblebitConfig.PlayerIdSchema,
+    friendId: NimblebitConfig.PlayerIdSchema,
+    salt: U32,
+    hash: Schema.String
+  },
+  payload: Schema.Struct({
+    itemStr: Schema.String
+  }),
+  error: ApiErrors,
+  success: [ErrorResponse, SentResponse, NotSentResponse]
+}).annotate(OAuthScope.Required, Scopes.Social.write.send_item.required);
+/**
+ * VERIFIED envelope (NBSyncFriendGameSaveResponse); preimage
+ * `bc/<playerId>/<friendId>/<salt><playerAuthKey>`.
+ *
+ * @internal
+ */
+export const SocialPullFriendGameEndpoint = /*#__PURE__*/HttpApiEndpoint.get("SocialPullFriendGame", "/friend/pull_game/bc/:playerId/:friendId/:salt/:hash", {
+  params: {
+    playerId: NimblebitConfig.PlayerIdSchema,
+    friendId: NimblebitConfig.PlayerIdSchema,
+    salt: U32,
+    hash: Schema.String
+  },
+  error: ApiErrors,
+  success: [ErrorResponse, NotFoundResponse, Schema.Struct({
+    success: Schema.Literal("Found"),
+    data: Schema.Uint8ArrayFromBase64,
+    checksum: Schema.String,
+    saveId: Schema.NumberFromString,
+    playerId: NimblebitConfig.PlayerIdSchema
+  }).pipe(Schema.encodeKeys({
+    checksum: "h",
+    saveId: "id",
+    playerId: "player_id"
+  }))]
+}).annotate(OAuthScope.Required, Scopes.Social.read.pull_friend_game.required);
+/**
+ * VERIFIED envelope (NBSyncFriendGameMetaResponse; `meta` is a flat
+ * Dictionary<String,Object> on pt). Preimage `bc/<playerId>/<salt><friendId><playerAuthKey>`.
+ *
+ * @internal
+ */
+export const SocialPullFriendMetaEndpoint = /*#__PURE__*/HttpApiEndpoint.post("SocialPullFriendMeta", "/friend/pull_meta/bc/:playerId/:salt/:hash", {
+  params: {
+    playerId: NimblebitConfig.PlayerIdSchema,
+    salt: U32,
+    hash: Schema.String
+  },
+  payload: Schema.Struct({
+    friends: NimblebitConfig.PlayerIdSchema
+  }),
+  error: ApiErrors,
+  success: [ErrorResponse, NotFoundResponse, Schema.Struct({
+    success: Schema.Literal("Found"),
+    meta: Schema.Record(NimblebitConfig.PlayerIdSchema, Schema.Unknown)
+  })]
+}).annotate(OAuthScope.Required, Scopes.Social.read.pull_friend_meta.required);
+/** @internal */
+export const DeviceManagementGroup = /*#__PURE__*/HttpApiGroup.make("DeviceManagementGroup").add(DeviceNewPlayerEndpoint).add(DevicePlayerDetailsEndpoint).add(DeviceVerifyDeviceEndpoint);
+/** @internal */
+export const SyncManagementGroup = /*#__PURE__*/HttpApiGroup.make("SyncManagementGroup").add(SyncPullSaveEndpoint).add(SyncCheckForNewerSaveEndpoint);
+/** @internal */
+export const SocialGroup = /*#__PURE__*/HttpApiGroup.make("SocialGroup").add(SocialGetItemsEndpoint).add(SocialSendItemEndpoint).add(SocialPullFriendGameEndpoint).add(SocialPullFriendMetaEndpoint);
+/**
+ * The Bit City NBSync api.
+ *
+ * @since 1.0.0
+ * @category Api
+ */
+export const Api = /*#__PURE__*/HttpApi.make("BitCityApi").add(DeviceManagementGroup).add(SyncManagementGroup).add(SocialGroup);
+//# sourceMappingURL=Endpoints.js.map

package/dist/Endpoints.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Endpoints.js","names":[],"sources":["../src/Endpoints.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,SAAS,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,YAAY,QAAQ,iBAAiB;AACtF,OAAO,KAAK,MAAM,MAAM,eAAe;AAEvC,OAAO,KAAK,eAAe,MAAM,yCAAyC;AAC1E,OAAO,KAAK,UAAU,MAAM,0BAA0B;AAEtD,OAAO,KAAK,MAAM,MAAM,aAAa;AAErC;AACA,OAAO,MAAM,GAAG,gBAAG,MAAM,CAAC,GAAG,CAAC,KAAK,cAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;AAEtD;AACA,OAAO,MAAM,SAAS,GAAG,CACrB,YAAY,CAAC,SAAS,EACtB,YAAY,CAAC,UAAU,EACvB,YAAY,CAAC,YAAY,EACzB,YAAY,CAAC,mBAAmB,CAC1B;AAEV;AACA,OAAO,MAAM,aAAa,gBAAG,MAAM,CAAC,MAAM,CAAC;EAAE,KAAK,EAAE,MAAM,CAAC;AAAM,CAAE,CAAC;AAEpE;AACA,OAAO,MAAM,gBAAgB,gBAAG,MAAM,CAAC,MAAM,CAAC;EAAE,OAAO,eAAE,MAAM,CAAC,OAAO,CAAC,UAAU;AAAC,CAAE,CAAC;AAEtF;AACA,OAAO,MAAM,YAAY,gBAAG,MAAM,CAAC,MAAM,CAAC;EAAE,OAAO,eAAE,MAAM,CAAC,OAAO,CAAC,MAAM;AAAC,CAAE,CAAC;AAE9E;AACA,OAAO,MAAM,eAAe,gBAAG,MAAM,CAAC,MAAM,CAAC;EAAE,OAAO,eAAE,MAAM,CAAC,OAAO,CAAC,SAAS;AAAC,CAAE,CAAC;AAEpF;;;;;;;;AAQA,OAAO,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO;AAElC;AACA,OAAO,MAAM,uBAAuB,gBAAG,eAAe,CAAC,GAAG,CAAC,iBAAiB,EAAE,kCAAkC,EAAE;EAC9G,MAAM,EAAE;IAAE,KAAK,EAAE,GAAG;IAAE,KAAK,EAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;EAAM,CAAE;EACvD,KAAK,EAAE,SAAS;EAChB,OAAO,EAAE,CACL,aAAa,eACb,MAAM,CAAC,MAAM,CAAC;IACV,QAAQ,EAAE,eAAe,CAAC,cAAc;IACxC,QAAQ,EAAE,eAAe,CAAC;GAC7B,CAAC,CAAC,IAAI,cAAC,MAAM,CAAC,UAAU,CAAC;IAAE,QAAQ,EAAE,WAAW;IAAE,QAAQ,EAAE;EAAW,CAAE,CAAC,CAAC;CAEnF,CAAC;AAEF;AACA,OAAO,MAAM,2BAA2B,gBAAG,eAAe,CAAC,GAAG,CAC1D,qBAAqB,EACrB,0CAA0C,EAC1C;EACI,MAAM,EAAE;IAAE,QAAQ,EAAE,eAAe,CAAC,cAAc;IAAE,IAAI,EAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;EAAM,CAAE;EACpF,KAAK,EAAE,SAAS;EAChB,OAAO,EAAE,CACL,aAAa,EACb,MAAM,CAAC,MAAM,CAAC;IACV,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;MAClB,QAAQ,EAAE,eAAe,CAAC,cAAc;MACxC,WAAW,EAAE,eAAe,CAAC,iBAAiB;MAC9C,UAAU,EAAE,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;MAChF,WAAW,EAAE,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;MACjF,WAAW,EAAE,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;MACtE,QAAQ,EAAE,MAAM,CAAC;KACpB,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;MAAE,QAAQ,EAAE,WAAW;MAAE,WAAW,EAAE,OAAO;MAAE,QAAQ,EAAE;IAAG,CAAE,CAAC;GAC5F,CAAC;CAET,CACJ,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;AAE3E;AACA,OAAO,MAAM,0BAA0B,gBAAG,eAAe,CAAC,GAAG,CACzD,oBAAoB,EACpB,+CAA+C,EAC/C;EACI,MAAM,EAAE;IAAE,QAAQ,EAAE,eAAe,CAAC,cAAc;IAAE,gBAAgB,EAAE,MAAM,CAAC;EAAM,CAAE;EACrF,KAAK,EAAE,SAAS;EAChB,OAAO,EAAE,CACL,aAAa,EACb,MAAM,CAAC,MAAM,CAAC;IACV,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC;IACpC,QAAQ,EAAE,eAAe,CAAC,cAAc;IACxC,aAAa,EAAE,eAAe,CAAC,mBAAmB;IAClD,WAAW,EAAE,eAAe,CAAC;GAChC,CAAC,CAAC,IAAI,CACH,MAAM,CAAC,UAAU,CAAC;IAAE,QAAQ,EAAE,WAAW;IAAE,aAAa,EAAE,WAAW;IAAE,WAAW,EAAE;EAAc,CAAE,CAAC,CACxG;CAER,CACJ,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC;AAE3E;;;;;;AAMA,OAAO,MAAM,oBAAoB,gBAAG,eAAe,CAAC,GAAG,CAAC,cAAc,EAAE,qCAAqC,EAAE;EAC3G,MAAM,EAAE;IAAE,QAAQ,EAAE,eAAe,CAAC,cAAc;IAAE,IAAI,EAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;EAAM,CAAE;EACpF,KAAK,EAAE,SAAS;EAChB,OAAO,EAAE,CACL,aAAa,EACb,gBAAgB,eAChB,MAAM,CAAC,MAAM,CAAC;IACV,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC,oBAAoB;IACjC,QAAQ,EAAE,MAAM,CAAC,MAAM;IACvB,MAAM,EAAE,MAAM,CAAC;GAClB,CAAC,CAAC,IAAI,cAAC,MAAM,CAAC,UAAU,CAAC;IAAE,QAAQ,EAAE,GAAG;IAAE,MAAM,EAAE;EAAI,CAAE,CAAC,CAAC;CAElE,CAAC;AAEF;;;;;AAKA,OAAO,MAAM,6BAA6B,gBAAG,eAAe,CAAC,GAAG,CAC5D,uBAAuB,EACvB,gDAAgD,EAChD;EACI,MAAM,EAAE;IAAE,QAAQ,EAAE,eAAe,CAAC,cAAc;IAAE,IAAI,EAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;EAAM,CAAE;EACpF,KAAK,EAAE,SAAS;EAChB,OAAO,EAAE,CACL,aAAa,EACb,gBAAgB,eAChB,MAAM,CAAC,MAAM,CAAC;IACV,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;IAChC,QAAQ,EAAE,MAAM,CAAC,MAAM;IACvB,MAAM,EAAE,MAAM,CAAC;GAClB,CAAC,CAAC,IAAI,cAAC,MAAM,CAAC,UAAU,CAAC;IAAE,QAAQ,EAAE,GAAG;IAAE,MAAM,EAAE;EAAI,CAAE,CAAC,CAAC;CAElE,CACJ;AAED;;;;;;AAMA,OAAO,MAAM,sBAAsB,gBAAG,eAAe,CAAC,GAAG,CAAC,gBAAgB,EAAE,qCAAqC,EAAE;EAC/G,MAAM,EAAE;IAAE,QAAQ,EAAE,eAAe,CAAC,cAAc;IAAE,IAAI,EAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;EAAM,CAAE;EACpF,KAAK,EAAE,SAAS;EAChB,OAAO,EAAE,CACL,aAAa,EACb,gBAAgB,EAChB,MAAM,CAAC,MAAM,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI;EAAC,CAAE,CAAC;CAErF,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;AAEvE;;;;;;AAMA,OAAO,MAAM,sBAAsB,gBAAG,eAAe,CAAC,IAAI,CACtD,gBAAgB,EAChB,yDAAyD,EACzD;EACI,MAAM,EAAE;IACJ,QAAQ,EAAE,MAAM,CAAC,MAAM;IACvB,QAAQ,EAAE,eAAe,CAAC,cAAc;IACxC,QAAQ,EAAE,eAAe,CAAC,cAAc;IACxC,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,MAAM,CAAC;GAChB;EACD,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;EAAM,CAAE,CAAC;EAClD,KAAK,EAAE,SAAS;EAChB,OAAO,EAAE,CAAC,aAAa,EAAE,YAAY,EAAE,eAAe;CACzD,CACJ,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC;AAEvE;;;;;;AAMA,OAAO,MAAM,4BAA4B,gBAAG,eAAe,CAAC,GAAG,CAC3D,sBAAsB,EACtB,sDAAsD,EACtD;EACI,MAAM,EAAE;IACJ,QAAQ,EAAE,eAAe,CAAC,cAAc;IACxC,QAAQ,EAAE,eAAe,CAAC,cAAc;IACxC,IAAI,EAAE,GAAG;IACT,IAAI,EAAE,MAAM,CAAC;GAChB;EACD,KAAK,EAAE,SAAS;EAChB,OAAO,EAAE,CACL,aAAa,EACb,gBAAgB,EAChB,MAAM,CAAC,MAAM,CAAC;IACV,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC,oBAAoB;IACjC,QAAQ,EAAE,MAAM,CAAC,MAAM;IACvB,MAAM,EAAE,MAAM,CAAC,gBAAgB;IAC/B,QAAQ,EAAE,eAAe,CAAC;GAC7B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAAE,QAAQ,EAAE,GAAG;IAAE,MAAM,EAAE,IAAI;IAAE,QAAQ,EAAE;EAAW,CAAE,CAAC,CAAC;CAEzF,CACJ,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC;AAE7E;;;;;;AAMA,OAAO,MAAM,4BAA4B,gBAAG,eAAe,CAAC,IAAI,CAC5D,sBAAsB,EACtB,4CAA4C,EAC5C;EACI,MAAM,EAAE;IAAE,QAAQ,EAAE,eAAe,CAAC,cAAc;IAAE,IAAI,EAAE,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;EAAM,CAAE;EACpF,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;IAAE,OAAO,EAAE,eAAe,CAAC;EAAc,CAAE,CAAC;EACnE,KAAK,EAAE,SAAS;EAChB,OAAO,EAAE,CACL,aAAa,EACb,gBAAgB,EAChB,MAAM,CAAC,MAAM,CAAC;IACV,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,cAAc,EAAE,MAAM,CAAC,OAAO;GACrE,CAAC;CAET,CACJ,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC;AAE7E;AACA,OAAO,MAAM,qBAAqB,gBAAG,YAAY,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAC1E,GAAG,CAAC,uBAAuB,CAAC,CAC5B,GAAG,CAAC,2BAA2B,CAAC,CAChC,GAAG,CAAC,0BAA0B,CAAC;AAEpC;AACA,OAAO,MAAM,mBAAmB,gBAAG,YAAY,CAAC,IAAI,CAAC,qBAAqB,CAAC,CACtE,GAAG,CAAC,oBAAoB,CAAC,CACzB,GAAG,CAAC,6BAA6B,CAAC;AAEvC;AACA,OAAO,MAAM,WAAW,gBAAG,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CACtD,GAAG,CAAC,sBAAsB,CAAC,CAC3B,GAAG,CAAC,sBAAsB,CAAC,CAC3B,GAAG,CAAC,4BAA4B,CAAC,CACjC,GAAG,CAAC,4BAA4B,CAAC;AAEtC;;;;;;AAMA,OAAO,MAAM,GAAG,gBAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC","ignoreList":[]}

package/dist/Scopes.d.ts

@@ -0,0 +1,70 @@
+/**
+ * The scopes the Bit City api is guarded by, as a game-rooted tree, built with
+ * `@tinyburg/nimblebit-sdk`'s `defineGame`. Only the endpoints this sdk defines
+ * are covered; areas without both a read and a write side are left out until
+ * their endpoints exist.
+ *
+ * @since 1.0.0
+ * @category Scopes
+ */
+import { type Game, type ScopeDescription } from "@tinyburg/nimblebit-sdk/NimblebitScopes";
+/**
+ * @since 1.0.0
+ * @category Games
+ */
+export declare const BitCity: Game & {
+    readonly areas: {
+        readonly device: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Area & {
+            readonly read: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Branch & {
+                readonly player_details: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+            };
+            readonly write: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Branch & {
+                readonly verify_device: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+            };
+        };
+        readonly social: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Area & {
+            readonly read: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Branch & {
+                readonly get_items: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+                readonly pull_friend_game: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+                readonly pull_friend_meta: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+            };
+            readonly write: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Branch & {
+                readonly send_item: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+            };
+        };
+    };
+};
+/**
+ * The game's areas, by name, for annotating endpoints.
+ *
+ * @since 1.0.0
+ * @category Areas
+ */
+export declare const Device: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Area & {
+    readonly read: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Branch & {
+        readonly player_details: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+    };
+    readonly write: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Branch & {
+        readonly verify_device: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+    };
+}, Social: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Area & {
+    readonly read: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Branch & {
+        readonly get_items: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+        readonly pull_friend_game: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+        readonly pull_friend_meta: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+    };
+    readonly write: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Branch & {
+        readonly send_item: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+    };
+};
+/**
+ * @since 1.0.0
+ * @category Tree
+ */
+export declare const Games: ReadonlyArray<Game>;
+/**
+ * @since 1.0.0
+ * @category Tree
+ */
+export declare const all: () => ReadonlyArray<ScopeDescription>;
+//# sourceMappingURL=Scopes.d.ts.map

package/dist/Scopes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Scopes.d.ts","sourceRoot":"","sources":["../src/Scopes.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,KAAK,IAAI,EAAE,KAAK,gBAAgB,EAAc,MAAM,yCAAyC,CAAC;AAEvG;;;GAGG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;CAuClB,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAgB,MAAM;;;;;;;GAAU,MAAM;;;;;;;;;CAAkB,CAAC;AAEhE;;;GAGG;AACH,eAAO,MAAM,KAAK,EAAE,aAAa,CAAC,IAAI,CAAa,CAAC;AAEpD;;;GAGG;AACH,eAAO,MAAM,GAAG,QAAO,aAAa,CAAC,gBAAgB,CAY/C,CAAC"}

package/dist/Scopes.js

@@ -0,0 +1,79 @@
+/**
+ * The scopes the Bit City api is guarded by, as a game-rooted tree, built with
+ * `@tinyburg/nimblebit-sdk`'s `defineGame`. Only the endpoints this sdk defines
+ * are covered; areas without both a read and a write side are left out until
+ * their endpoints exist.
+ *
+ * @since 1.0.0
+ * @category Scopes
+ */
+import { defineGame } from "@tinyburg/nimblebit-sdk/NimblebitScopes";
+/**
+ * @since 1.0.0
+ * @category Games
+ */
+export const BitCity = /*#__PURE__*/defineGame({
+  name: "bitcity",
+  description: "Bit City",
+  read: {
+    description: "Everything in Bit City that only looks"
+  },
+  write: {
+    description: "Everything in Bit City that changes a player's game"
+  },
+  areas: {
+    device: {
+      description: "Player accounts and their devices",
+      read: {
+        description: "Look up player accounts",
+        leaves: {
+          player_details: "Look up a player's public profile details"
+        }
+      },
+      write: {
+        description: "Change a player's account or devices",
+        leaves: {
+          verify_device: "Complete a device verification code"
+        }
+      }
+    },
+    social: {
+      description: "Gifts, visits and friends",
+      read: {
+        description: "See gifts, visits and friends' games",
+        leaves: {
+          get_items: "See the items waiting for a player",
+          pull_friend_game: "Download a friend's game data",
+          pull_friend_meta: "Fetch metadata about a player's friends"
+        }
+      },
+      write: {
+        description: "Send and accept gifts and items",
+        leaves: {
+          send_item: "Send items to another player"
+        }
+      }
+    }
+  }
+});
+/**
+ * The game's areas, by name, for annotating endpoints.
+ *
+ * @since 1.0.0
+ * @category Areas
+ */
+export const {
+  device: Device,
+  social: Social
+} = BitCity.areas;
+/**
+ * @since 1.0.0
+ * @category Tree
+ */
+export const Games = [BitCity];
+/**
+ * @since 1.0.0
+ * @category Tree
+ */
+export const all = () => Games.flatMap(game => [game, game.read, game.write, ...Object.values(game.areas).flatMap(area => [area, area.read, ...area.read.children, area.write, ...area.write.children])]);
+//# sourceMappingURL=Scopes.js.map

package/dist/Scopes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Scopes.js","names":[],"sources":["../src/Scopes.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;AAUA,SAA2C,UAAU,QAAQ,yCAAyC;AAEtG;;;;AAIA,OAAO,MAAM,OAAO,gBAAG,UAAU,CAAC;EAC9B,IAAI,EAAE,SAAS;EACf,WAAW,EAAE,UAAU;EACvB,IAAI,EAAE;IAAE,WAAW,EAAE;EAAwC,CAAE;EAC/D,KAAK,EAAE;IAAE,WAAW,EAAE;EAAqD,CAAE;EAC7E,KAAK,EAAE;IACH,MAAM,EAAE;MACJ,WAAW,EAAE,mCAAmC;MAChD,IAAI,EAAE;QACF,WAAW,EAAE,yBAAyB;QACtC,MAAM,EAAE;UACJ,cAAc,EAAE;;OAEvB;MACD,KAAK,EAAE;QACH,WAAW,EAAE,sCAAsC;QACnD,MAAM,EAAE;UACJ,aAAa,EAAE;;;KAG1B;IACD,MAAM,EAAE;MACJ,WAAW,EAAE,2BAA2B;MACxC,IAAI,EAAE;QACF,WAAW,EAAE,sCAAsC;QACnD,MAAM,EAAE;UACJ,SAAS,EAAE,oCAAoC;UAC/C,gBAAgB,EAAE,+BAA+B;UACjD,gBAAgB,EAAE;;OAEzB;MACD,KAAK,EAAE;QACH,WAAW,EAAE,iCAAiC;QAC9C,MAAM,EAAE;UACJ,SAAS,EAAE;;;;;CAK9B,CAAC;AAEF;;;;;;AAMA,OAAO,MAAM;EAAE,MAAM,EAAE,MAAM;EAAE,MAAM,EAAE;AAAM,CAAE,GAAG,OAAO,CAAC,KAAK;AAE/D;;;;AAIA,OAAO,MAAM,KAAK,GAAwB,CAAC,OAAO,CAAC;AAEnD;;;;AAIA,OAAO,MAAM,GAAG,GAAG,MACf,KAAK,CAAC,OAAO,CAAE,IAAI,IAAK,CACpB,IAAI,EACJ,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,KAAK,EACV,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAE,IAAI,IAAK,CAC3C,IAAI,EACJ,IAAI,CAAC,IAAI,EACT,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EACrB,IAAI,CAAC,KAAK,EACV,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CACzB,CAAC,CACL,CAAC","ignoreList":[]}

package/dist/index.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @since 1.0.0
+ */
+/**
+ * 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
+ */
+export * as BitCity from "./BitCity.ts";
+/**
+ * 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
+ */
+export * as Endpoints from "./Endpoints.ts";
+/**
+ * The scopes the Bit City api is guarded by, as a game-rooted tree, built with
+ * `@tinyburg/nimblebit-sdk`'s `defineGame`. Only the endpoints this sdk defines
+ * are covered; areas without both a read and a write side are left out until
+ * their endpoints exist.
+ *
+ * @since 1.0.0
+ * @category Scopes
+ */
+export * as Scopes from "./Scopes.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;;;;;;;GAQG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA"}

package/dist/index.js

@@ -0,0 +1,56 @@
+/**
+ * @since 1.0.0
+ */
+/**
+ * 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
+ */
+export * as BitCity from "./BitCity.js";
+/**
+ * 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
+ */
+export * as Endpoints from "./Endpoints.js";
+/**
+ * The scopes the Bit City api is guarded by, as a game-rooted tree, built with
+ * `@tinyburg/nimblebit-sdk`'s `defineGame`. Only the endpoints this sdk defines
+ * are covered; areas without both a read and a write side are left out until
+ * their endpoints exist.
+ *
+ * @since 1.0.0
+ * @category Scopes
+ */
+export * as Scopes from "./Scopes.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;;;;;;;;;;;;;;;;AAgBA,OAAO,KAAK,OAAO,MAAM,cAAc;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,KAAK,SAAS,MAAM,gBAAgB;AAE3C;;;;;;;;;AASA,OAAO,KAAK,MAAM,MAAM,aAAa","ignoreList":[]}

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "@tinyburg/bitcity-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "description": "api for the mobile game Bit City by Nimblebit",
+  "keywords": [
+    "bitcity-sdk",
+    "nimblebit"
+  ],
+  "homepage": "https://github.com/leonitousconforti/tinyburg",
+  "license": "GPL-3.0-only",
+  "author": "Leo Conforti <leo@leoconforti.us> (https://leoconforti.us)",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/leonitousconforti/tinyburg.git",
+    "directory": "packages/bitcity-sdk"
+  },
+  "files": [
+    "src/**/*.ts",
+    "dist/**/*.js",
+    "dist/**/*.js.map",
+    "dist/**/*.d.ts",
+    "dist/**/*.d.ts.map"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./dist/index.js",
+    "./*": "./dist/*.js",
+    "./internal/*": null
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@tinyburg/nimblebit-sdk": "0.2.1"
+  },
+  "devDependencies": {
+    "@yielded/auth": "0.1.0-beta.47",
+    "effect": "4.1.1"
+  },
+  "peerDependencies": {
+    "@yielded/auth": "0.1.0-beta.47",
+    "effect": "4.1.1"
+  },
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json && babel dist --plugins annotate-pure-calls --out-dir dist --source-maps",
+    "check": "tsc -b tsconfig.json",
+    "codegen": "build-utils prepare-v4"
+  }
 }