@tinyburg/pocket-trains-sdk 0.0.0-stage → 0.1.0

package/dist/PocketTrains.js

@@ -0,0 +1,172 @@
+/**
+ * Pocket Trains 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 `pt` 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(`pt/${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(`pt/${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(`pt/${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(`pt/${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=PocketTrains.js.map

package/dist/PocketTrains.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PocketTrains.js","names":[],"sources":["../src/PocketTrains.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/Scopes.d.ts

@@ -0,0 +1,72 @@
+/**
+ * The scopes the Pocket Trains 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 PocketTrains: 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_gifts_pt: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+                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_gifts_pt: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+        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,YAAY;;;;;;;;;;;;;;;;;;;;;;CAwCvB,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAgB,MAAM;;;;;;;GAAU,MAAM;;;;;;;;;;CAAuB,CAAC;AAErE;;;GAGG;AACH,eAAO,MAAM,KAAK,EAAE,aAAa,CAAC,IAAI,CAAkB,CAAC;AAEzD;;;GAGG;AACH,eAAO,MAAM,GAAG,QAAO,aAAa,CAAC,gBAAgB,CAY/C,CAAC"}

package/dist/Scopes.js

@@ -0,0 +1,80 @@
+/**
+ * The scopes the Pocket Trains 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 PocketTrains = /*#__PURE__*/defineGame({
+  name: "pockettrains",
+  description: "Pocket Trains",
+  read: {
+    description: "Everything in Pocket Trains that only looks"
+  },
+  write: {
+    description: "Everything in Pocket Trains 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",
+          get_gifts_pt: "See the gifts 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
+} = PocketTrains.areas;
+/**
+ * @since 1.0.0
+ * @category Tree
+ */
+export const Games = [PocketTrains];
+/**
+ * @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,YAAY,gBAAG,UAAU,CAAC;EACnC,IAAI,EAAE,cAAc;EACpB,WAAW,EAAE,eAAe;EAC5B,IAAI,EAAE;IAAE,WAAW,EAAE;EAA6C,CAAE;EACpE,KAAK,EAAE;IAAE,WAAW,EAAE;EAA0D,CAAE;EAClF,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,YAAY,EAAE,oCAAoC;UAClD,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,YAAY,CAAC,KAAK;AAEpE;;;;AAIA,OAAO,MAAM,KAAK,GAAwB,CAAC,YAAY,CAAC;AAExD;;;;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,60 @@
+/**
+ * @since 1.0.0
+ */
+/**
+ * Pocket Trains (game code `pt`) NBSync api endpoints.
+ *
+ * Signing: a random `salt` (signed int32) goes in the path, and `hash` is
+ * `md5(<preimage> + <game secret salt>)` with the preimage
+ * `pt/<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.
+ * - pt-specific gifting: `get_gifts_pt` -> NBSyncGetPTGiftResponse with
+ *   NBSyncGetPTGift elements, plus a gift-id flow (NBSyncGetGiftIDResponse,
+ *   `friend/pull_meta_gift_id`). The get_gifts_pt REQUEST params are UNCONFIRMED
+ *   (the tried `/get_gifts_pt/pt/:playerId/:salt/:hash` form was rejected), so
+ *   that endpoint is marked accordingly.
+ *
+ * Game-specific save/meta schemas are left as `Schema.Unknown` placeholders.
+ *
+ * @since 1.0.0
+ * @category Endpoints
+ */
+export * as Endpoints from "./Endpoints.ts";
+/**
+ * Pocket Trains 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 `pt` 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 PocketTrains from "./PocketTrains.ts";
+/**
+ * The scopes the Pocket Trains 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;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;;;;;;;GAQG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA"}

package/dist/index.js

@@ -0,0 +1,60 @@
+/**
+ * @since 1.0.0
+ */
+/**
+ * Pocket Trains (game code `pt`) NBSync api endpoints.
+ *
+ * Signing: a random `salt` (signed int32) goes in the path, and `hash` is
+ * `md5(<preimage> + <game secret salt>)` with the preimage
+ * `pt/<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.
+ * - pt-specific gifting: `get_gifts_pt` -> NBSyncGetPTGiftResponse with
+ *   NBSyncGetPTGift elements, plus a gift-id flow (NBSyncGetGiftIDResponse,
+ *   `friend/pull_meta_gift_id`). The get_gifts_pt REQUEST params are UNCONFIRMED
+ *   (the tried `/get_gifts_pt/pt/:playerId/:salt/:hash` form was rejected), so
+ *   that endpoint is marked accordingly.
+ *
+ * Game-specific save/meta schemas are left as `Schema.Unknown` placeholders.
+ *
+ * @since 1.0.0
+ * @category Endpoints
+ */
+export * as Endpoints from "./Endpoints.js";
+/**
+ * Pocket Trains 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 `pt` 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 PocketTrains from "./PocketTrains.js";
+/**
+ * The scopes the Pocket Trains 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;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,OAAO,KAAK,SAAS,MAAM,gBAAgB;AAE3C;;;;;;;;;;;;;;;;AAgBA,OAAO,KAAK,YAAY,MAAM,mBAAmB;AAEjD;;;;;;;;;AASA,OAAO,KAAK,MAAM,MAAM,aAAa","ignoreList":[]}

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "@tinyburg/pocket-trains-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "api for the mobile game Pocket Trains by Nimblebit",
+  "keywords": [
+    "nimblebit",
+    "pockettrains"
+  ],
+  "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/pocket-trains-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.0"
+  },
+  "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"
+  }
 }