@tinyburg/treasury-sdk 0.0.0-stage → 0.2.1

package/dist/Sdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sdk.d.ts","sourceRoot":"","sources":["../src/Sdk.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACvF,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAKxC,OAAO,KAAK,UAAU,MAAM,0BAA0B,CAAC;AAQvD;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,8CAAsC,CAAC;AAElE;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,yCAAiC,CAAC;AAExD;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,sMAcrB,CAAC;AAEH;;;;;;;;;GASG;AACH,eAAO,MAAM,QAAQ,qHASnB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,SAAS,wDAAgD,CAAC;AAEvE;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;EAInB,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,UAAU;;;;EAIrB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,WAAW;;;;;;;EAGtB,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;IAAwC,CAAC;AAE9D;;;;;;;GAOG;AACH,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAehB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;;;EAOnB,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,WAAW;;;EAGtB,CAAC;AAEH;;;;;GAKG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAItB,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,WAAW;;;;EAItB,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,SAAS;;;;;;;EAOpB,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,aAAa;;;;EAIxB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,aAAa;;;;IAItB,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKpE,CAAC;AA4EH;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAzFtB,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;0KAmG7B,CAAC;AAE1C;;;;;;;;GAQG;AACH,eAAO,MAAM,mBAAmB;;;;iCAAyD,CAAC;AAE1F;;;GAGG;AACH,eAAO,MAAM,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IApHZ,kEAAkE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAoHoB,CAAC"}

package/dist/Sdk.js

@@ -0,0 +1,328 @@
+/**
+ * The api the treasury serves: player-to-player trades, escrowed.
+ *
+ * Nimblebit has no hold primitive, so the treasury makes one out of the gift
+ * channel: each side's item is sent to a treasury-owned vault tower, where it
+ * sits as an *unreceived* gift - a native escrow slot - until both deposits
+ * are verified, and only then is each item forwarded to the other side. A
+ * save-splice trade instead rewrites both saves directly, which is why it
+ * requires an explicit confirmation from both parties before anything runs.
+ *
+ * Every endpoint but the public stats is bearer authenticated with a JWT
+ * access token the Tinyburg OAuth server issued for the Tinyburg api
+ * (`<site>/v1`), and guarded by a leaf of the `treasury` scope area in
+ * `Scopes`. The treasury lives behind tinyburg.app: the paths here are
+ * reached at `<site>/v1/treasury/*`, which tinyburg.app forwards verbatim,
+ * `Authorization` header included. The first-party app gets its token from
+ * tinyburg.app's `/auth/token`; any other application uses the one it was
+ * issued.
+ *
+ * A token without the endpoint's scope is refused with `403` and an
+ * `insufficient_scope` challenge. Any other `403` from a trade endpoint
+ * means the treasury holds no usable grant for the caller's towers;
+ * `GrantStatus` says so explicitly and carries the url that starts the
+ * connect flow.
+ *
+ * @since 1.0.0
+ */
+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 NimblebitScopes from "@tinyburg/nimblebit-sdk/NimblebitScopes";
+import * as SyncItemType from "@tinyburg/tinytower-sdk/SyncItemType";
+import * as OAuthScope from "@yielded/auth/OAuthScope";
+import * as Scopes from "./Scopes.js";
+// ---------------------------------------------------------------------------
+// Schemas
+// ---------------------------------------------------------------------------
+/**
+ * How a trade moves its items. `gift` rides Nimblebit's gift channel through
+ * the vault; `splice` rewrites both saves and can carry what the gift channel
+ * cannot (costumes, pets, coins, bux).
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const TradeMechanism = /*#__PURE__*/Schema.Literals(["gift", "splice"]);
+/**
+ * The games the treasury trades in. TinyTower only, until the tinyburg api
+ * serves more.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const TradeGame = /*#__PURE__*/Schema.Literals(["tinytower"]);
+/**
+ * Where a trade is in its life. The happy path is `proposed` → `accepted` →
+ * (`awaiting_confirmation`, splice only) → `escrowing` → `escrowed` →
+ * `releasing` (gift) or `executing` (splice) → `settled`; everything else is
+ * one of the ways out.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const TradeState = /*#__PURE__*/Schema.Literals(["proposed", "accepted", "awaiting_confirmation", "escrowing", "escrowed", "releasing", "executing", "settled", "cancelled", "refunding", "refunded", "expired", "failed"]);
+/**
+ * One side of a gift trade's journey through the vault: `pending` → `sent`
+ * (deposit dispatched) → `verified` (seen in the vault's gift queue) →
+ * `released` (forwarded to the counterparty) → `settled` (vault slot
+ * claimed); refunds run `refund_sent` → `refunded`, and `lost` is a deposit
+ * that never arrived.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const LegState = /*#__PURE__*/Schema.Literals(["pending", "sent", "verified", "released", "settled", "refund_sent", "refunded", "lost"]);
+/**
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const TradeRole = /*#__PURE__*/Schema.Literals(["proposer", "counterparty"]);
+/**
+ * One item offered over the gift channel, in the encoded form the game
+ * exchanges items in - the same string `SendItem` carries.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const GiftItem = /*#__PURE__*/Schema.Struct({
+  _tag: /*#__PURE__*/Schema.tag("GiftItem"),
+  itemType: /*#__PURE__*/Schema.Enum(SyncItemType.SyncItemType),
+  item: Schema.String
+});
+/**
+ * One item offered by splice. Bitizens, costumes and pets carry the encoded
+ * string a save stores them as; coins and bux carry an amount instead.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const SpliceItem = /*#__PURE__*/Schema.Struct({
+  kind: /*#__PURE__*/Schema.Literals(["bitizen", "costume", "pet", "coins", "bux"]),
+  item: /*#__PURE__*/Schema.optional(Schema.String),
+  amount: /*#__PURE__*/Schema.optional(Schema.Int)
+});
+/**
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const SpliceItems = /*#__PURE__*/Schema.Struct({
+  _tag: /*#__PURE__*/Schema.tag("SpliceItems"),
+  items: /*#__PURE__*/Schema.Array(SpliceItem)
+});
+/**
+ * What one side of a trade puts in: a gift-channel item or a list of splice
+ * items, matching the trade's mechanism.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const ItemSpec = /*#__PURE__*/Schema.Union([GiftItem, SpliceItems]);
+/**
+ * A trade as the api describes it. `gives` and `wants` are always from the
+ * proposer's point of view; `role` is which side the caller is on, absent for
+ * an open offer the caller could accept.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const Trade = /*#__PURE__*/Schema.Struct({
+  id: Schema.String,
+  mechanism: TradeMechanism,
+  game: TradeGame,
+  state: TradeState,
+  proposerPlayerId: NimblebitConfig.PlayerIdSchema,
+  counterpartyPlayerId: /*#__PURE__*/Schema.optional(NimblebitConfig.PlayerIdSchema),
+  gives: ItemSpec,
+  wants: ItemSpec,
+  role: /*#__PURE__*/Schema.optional(TradeRole),
+  proposerConfirmedAt: /*#__PURE__*/Schema.optional(Schema.DateTimeUtcFromString),
+  counterpartyConfirmedAt: /*#__PURE__*/Schema.optional(Schema.DateTimeUtcFromString),
+  createdAt: Schema.DateTimeUtcFromString,
+  expiresAt: Schema.DateTimeUtcFromString,
+  failureReason: /*#__PURE__*/Schema.optional(Schema.String)
+});
+/**
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const TradeLeg = /*#__PURE__*/Schema.Struct({
+  role: TradeRole,
+  fromPlayerId: NimblebitConfig.PlayerIdSchema,
+  toPlayerId: NimblebitConfig.PlayerIdSchema,
+  state: LegState,
+  itemType: /*#__PURE__*/Schema.Enum(SyncItemType.SyncItemType),
+  item: Schema.String
+});
+/**
+ * One entry of a trade's append-only history, as shown on its timeline.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const LedgerEvent = /*#__PURE__*/Schema.Struct({
+  event: Schema.String,
+  at: Schema.DateTimeUtcFromString
+});
+/**
+ * A trade with its legs and its history, for the participants only.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const TradeDetail = /*#__PURE__*/Schema.Struct({
+  trade: Trade,
+  legs: /*#__PURE__*/Schema.Array(TradeLeg),
+  ledger: /*#__PURE__*/Schema.Array(LedgerEvent)
+});
+/**
+ * Whether the treasury can currently act on the caller's towers, and where
+ * to go to make it so. The url is built server-side so the browser stays
+ * configuration-free.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const GrantStatus = /*#__PURE__*/Schema.Struct({
+  connected: Schema.Boolean,
+  scope: /*#__PURE__*/Schema.optional(Schema.String),
+  connectUrl: Schema.String
+});
+/**
+ * What a tower could put into a trade, read out of its save. Bitizens are the
+ * encoded strings the gift channel carries; costumes and pets are the strings
+ * the save stores.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const Inventory = /*#__PURE__*/Schema.Struct({
+  playerId: NimblebitConfig.PlayerIdSchema,
+  bitizens: /*#__PURE__*/Schema.Array(Schema.String),
+  costumes: /*#__PURE__*/Schema.Array(Schema.String),
+  pets: /*#__PURE__*/Schema.Array(Schema.String),
+  coins: Schema.Int,
+  bux: Schema.Int
+});
+/**
+ * The treasury's public counters, for the home page's stat tiles. Counts
+ * only, cached server-side, and deliberately free of anything per-user.
+ *
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const TreasuryStats = /*#__PURE__*/Schema.Struct({
+  activeTraders: Schema.Int,
+  settledTrades: Schema.Int,
+  itemsMoved: Schema.Int
+});
+/**
+ * @since 1.0.0
+ * @category Schemas
+ */
+export const TradeProposal = /*#__PURE__*/Schema.Struct({
+  mechanism: TradeMechanism,
+  game: TradeGame,
+  proposerPlayerId: NimblebitConfig.PlayerIdSchema,
+  /** Absent for an open offer, which whoever accepts first gets. */
+  counterpartyPlayerId: /*#__PURE__*/Schema.optional(NimblebitConfig.PlayerIdSchema),
+  gives: ItemSpec,
+  wants: ItemSpec,
+  ttlHours: /*#__PURE__*/Schema.Int.check(/*#__PURE__*/Schema.isBetween({
+    minimum: 1,
+    maximum: 168
+  }))
+});
+// ---------------------------------------------------------------------------
+// Endpoints
+// ---------------------------------------------------------------------------
+const tradeId = Schema.String;
+const playerId = NimblebitConfig.PlayerIdSchema;
+/**
+ * What acting on a trade can fail with: it does not exist or the caller is
+ * not a participant (`404`, and the api never confirms a trade exists to a
+ * stranger), it is not in a state the action applies to (`409`), the
+ * treasury holds no usable grant for the caller (`403`), or the world
+ * beyond - tinyburg.app, Nimblebit - did not cooperate (`503`).
+ */
+const TradeErrors = [HttpApiError.NotFound, HttpApiError.Conflict, HttpApiError.Forbidden, HttpApiError.ServiceUnavailable];
+const GetGrantStatus = /*#__PURE__*/HttpApiEndpoint.get("GrantStatus", "/v1/treasury/grant", {
+  success: GrantStatus
+}).annotate(OAuthScope.Required, Scopes.Treasury.read.grant_status.required);
+const ListTrades = /*#__PURE__*/HttpApiEndpoint.get("ListTrades", "/v1/treasury/trades", {
+  success: Schema.Array(Trade)
+}).annotate(OAuthScope.Required, Scopes.Treasury.read.list_trades.required);
+const GetTrade = /*#__PURE__*/HttpApiEndpoint.get("GetTrade", "/v1/treasury/trades/:tradeId", {
+  params: {
+    tradeId
+  },
+  error: HttpApiError.NotFound,
+  success: TradeDetail
+}).annotate(OAuthScope.Required, Scopes.Treasury.read.get_trade.required);
+const ProposeTrade = /*#__PURE__*/HttpApiEndpoint.post("ProposeTrade", "/v1/treasury/trades", {
+  payload: TradeProposal,
+  error: [HttpApiError.BadRequest, HttpApiError.Forbidden, HttpApiError.ServiceUnavailable],
+  success: Trade
+}).annotate(OAuthScope.Required, Scopes.Treasury.write.propose.required);
+const AcceptTrade = /*#__PURE__*/HttpApiEndpoint.post("AcceptTrade", "/v1/treasury/trades/:tradeId/accept", {
+  params: {
+    tradeId
+  },
+  payload: Schema.Struct({
+    playerId
+  }),
+  error: TradeErrors,
+  success: Trade
+}).annotate(OAuthScope.Required, Scopes.Treasury.write.accept.required);
+const CancelTrade = /*#__PURE__*/HttpApiEndpoint.post("CancelTrade", "/v1/treasury/trades/:tradeId/cancel", {
+  params: {
+    tradeId
+  },
+  error: [HttpApiError.NotFound, HttpApiError.Conflict],
+  success: Trade
+}).annotate(OAuthScope.Required, Scopes.Treasury.write.cancel.required);
+const ConfirmSplice = /*#__PURE__*/HttpApiEndpoint.post("ConfirmSplice", "/v1/treasury/trades/:tradeId/confirm", {
+  params: {
+    tradeId
+  },
+  error: [HttpApiError.NotFound, HttpApiError.Conflict],
+  success: Trade
+}).annotate(OAuthScope.Required, Scopes.Treasury.write.confirm_splice.required);
+const ListInventory = /*#__PURE__*/HttpApiEndpoint.get("ListInventory", "/v1/treasury/inventory/:playerId", {
+  params: {
+    playerId
+  },
+  error: [HttpApiError.NotFound, HttpApiError.Forbidden, HttpApiError.ServiceUnavailable],
+  success: Inventory
+}).annotate(OAuthScope.Required, Scopes.Treasury.read.list_inventory.required);
+const GetStats = /*#__PURE__*/HttpApiEndpoint.get("Stats", "/v1/treasury/stats", {
+  success: TreasuryStats
+});
+// ---------------------------------------------------------------------------
+// Groups
+// ---------------------------------------------------------------------------
+/**
+ * Everything the treasury serves. The group annotation is the floor: an
+ * endpoint added later without its own leaf accepts only the whole
+ * `treasury` scope, so nothing defaults to a weaker permission.
+ *
+ * @since 1.0.0
+ * @category Groups
+ */
+export const TreasuryGroup = /*#__PURE__*/HttpApiGroup.make("TreasuryGroup").add(GetGrantStatus).add(ListTrades).add(GetTrade).add(ProposeTrade).add(AcceptTrade).add(CancelTrade).add(ConfirmSplice).add(ListInventory).annotate(OAuthScope.Required, NimblebitScopes.requiredBy(Scopes.Treasury)).middleware(OAuthScope.RequireAccess);
+/**
+ * What the treasury tells anyone at all: the stat counters the home page
+ * shows. The one group without `RequireAccess` or a scope requirement, and
+ * it must stay that way - the home page is public, so this rides
+ * tinyburg.app's proxy without a token behind it.
+ *
+ * @since 1.0.0
+ * @category Groups
+ */
+export const TreasuryPublicGroup = /*#__PURE__*/HttpApiGroup.make("TreasuryPublicGroup").add(GetStats);
+/**
+ * @since 1.0.0
+ * @category Api
+ */
+export const Api = /*#__PURE__*/HttpApi.make("TreasurySdk").add(TreasuryGroup).add(TreasuryPublicGroup);
+//# sourceMappingURL=Sdk.js.map

package/dist/Sdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Sdk.js","names":[],"sources":["../src/Sdk.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,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,eAAe,MAAM,yCAAyC;AAC1E,OAAO,KAAK,YAAY,MAAM,sCAAsC;AACpE,OAAO,KAAK,UAAU,MAAM,0BAA0B;AAEtD,OAAO,KAAK,MAAM,MAAM,aAAa;AAErC;AACA;AACA;AAEA;;;;;;;;AAQA,OAAO,MAAM,cAAc,gBAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAEjE;;;;;;;AAOA,OAAO,MAAM,SAAS,gBAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC;AAEvD;;;;;;;;;AASA,OAAO,MAAM,UAAU,gBAAG,MAAM,CAAC,QAAQ,CAAC,CACtC,UAAU,EACV,UAAU,EACV,uBAAuB,EACvB,WAAW,EACX,UAAU,EACV,WAAW,EACX,WAAW,EACX,SAAS,EACT,WAAW,EACX,WAAW,EACX,UAAU,EACV,SAAS,EACT,QAAQ,CACX,CAAC;AAEF;;;;;;;;;;AAUA,OAAO,MAAM,QAAQ,gBAAG,MAAM,CAAC,QAAQ,CAAC,CACpC,SAAS,EACT,MAAM,EACN,UAAU,EACV,UAAU,EACV,SAAS,EACT,aAAa,EACb,UAAU,EACV,MAAM,CACT,CAAC;AAEF;;;;AAIA,OAAO,MAAM,SAAS,gBAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;AAEtE;;;;;;;AAOA,OAAO,MAAM,QAAQ,gBAAG,MAAM,CAAC,MAAM,CAAC;EAClC,IAAI,eAAE,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC;EAC5B,QAAQ,eAAE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC;EAChD,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAM,UAAU,gBAAG,MAAM,CAAC,MAAM,CAAC;EACpC,IAAI,eAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;EACpE,IAAI,eAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;EACpC,MAAM,eAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG;CACrC,CAAC;AAEF;;;;AAIA,OAAO,MAAM,WAAW,gBAAG,MAAM,CAAC,MAAM,CAAC;EACrC,IAAI,eAAE,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC;EAC/B,KAAK,eAAE,MAAM,CAAC,KAAK,CAAC,UAAU;CACjC,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAM,QAAQ,gBAAG,MAAM,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AAE7D;;;;;;;;AAQA,OAAO,MAAM,KAAK,gBAAG,MAAM,CAAC,MAAM,CAAC;EAC/B,EAAE,EAAE,MAAM,CAAC,MAAM;EACjB,SAAS,EAAE,cAAc;EACzB,IAAI,EAAE,SAAS;EACf,KAAK,EAAE,UAAU;EACjB,gBAAgB,EAAE,eAAe,CAAC,cAAc;EAChD,oBAAoB,eAAE,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,cAAc,CAAC;EACrE,KAAK,EAAE,QAAQ;EACf,KAAK,EAAE,QAAQ;EACf,IAAI,eAAE,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;EAChC,mBAAmB,eAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC;EAClE,uBAAuB,eAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC;EACtE,SAAS,EAAE,MAAM,CAAC,qBAAqB;EACvC,SAAS,EAAE,MAAM,CAAC,qBAAqB;EACvC,aAAa,eAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM;CAC/C,CAAC;AAEF;;;;AAIA,OAAO,MAAM,QAAQ,gBAAG,MAAM,CAAC,MAAM,CAAC;EAClC,IAAI,EAAE,SAAS;EACf,YAAY,EAAE,eAAe,CAAC,cAAc;EAC5C,UAAU,EAAE,eAAe,CAAC,cAAc;EAC1C,KAAK,EAAE,QAAQ;EACf,QAAQ,eAAE,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC;EAChD,IAAI,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;AAMA,OAAO,MAAM,WAAW,gBAAG,MAAM,CAAC,MAAM,CAAC;EACrC,KAAK,EAAE,MAAM,CAAC,MAAM;EACpB,EAAE,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;;;;AAMA,OAAO,MAAM,WAAW,gBAAG,MAAM,CAAC,MAAM,CAAC;EACrC,KAAK,EAAE,KAAK;EACZ,IAAI,eAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;EAC5B,MAAM,eAAE,MAAM,CAAC,KAAK,CAAC,WAAW;CACnC,CAAC;AAEF;;;;;;;;AAQA,OAAO,MAAM,WAAW,gBAAG,MAAM,CAAC,MAAM,CAAC;EACrC,SAAS,EAAE,MAAM,CAAC,OAAO;EACzB,KAAK,eAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,CAAC;EACrC,UAAU,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;;;;;AAQA,OAAO,MAAM,SAAS,gBAAG,MAAM,CAAC,MAAM,CAAC;EACnC,QAAQ,EAAE,eAAe,CAAC,cAAc;EACxC,QAAQ,eAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;EACrC,QAAQ,eAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;EACrC,IAAI,eAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC;EACjC,KAAK,EAAE,MAAM,CAAC,GAAG;EACjB,GAAG,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;AAOA,OAAO,MAAM,aAAa,gBAAG,MAAM,CAAC,MAAM,CAAC;EACvC,aAAa,EAAE,MAAM,CAAC,GAAG;EACzB,aAAa,EAAE,MAAM,CAAC,GAAG;EACzB,UAAU,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;;;AAIA,OAAO,MAAM,aAAa,gBAAG,MAAM,CAAC,MAAM,CAAC;EACvC,SAAS,EAAE,cAAc;EACzB,IAAI,EAAE,SAAS;EACf,gBAAgB,EAAE,eAAe,CAAC,cAAc;EAChD;EACA,oBAAoB,eAAE,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,cAAc,CAAC;EACrE,KAAK,EAAE,QAAQ;EACf,KAAK,EAAE,QAAQ;EACf,QAAQ,eAAE,MAAM,CAAC,GAAG,CAAC,KAAK,cAAC,MAAM,CAAC,SAAS,CAAC;IAAE,OAAO,EAAE,CAAC;IAAE,OAAO,EAAE;EAAG,CAAE,CAAC;CAC5E,CAAC;AAEF;AACA;AACA;AAEA,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM;AAC7B,MAAM,QAAQ,GAAG,eAAe,CAAC,cAAc;AAE/C;;;;;;;AAOA,MAAM,WAAW,GAAG,CAChB,YAAY,CAAC,QAAQ,EACrB,YAAY,CAAC,QAAQ,EACrB,YAAY,CAAC,SAAS,EACtB,YAAY,CAAC,kBAAkB,CACzB;AAEV,MAAM,cAAc,gBAAG,eAAe,CAAC,GAAG,CAAC,aAAa,EAAE,oBAAoB,EAAE;EAC5E,OAAO,EAAE;CACZ,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC;AAE5E,MAAM,UAAU,gBAAG,eAAe,CAAC,GAAG,CAAC,YAAY,EAAE,qBAAqB,EAAE;EACxE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK;CAC9B,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC;AAE3E,MAAM,QAAQ,gBAAG,eAAe,CAAC,GAAG,CAAC,UAAU,EAAE,8BAA8B,EAAE;EAC7E,MAAM,EAAE;IAAE;EAAO,CAAE;EACnB,KAAK,EAAE,YAAY,CAAC,QAAQ;EAC5B,OAAO,EAAE;CACZ,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;AAEzE,MAAM,YAAY,gBAAG,eAAe,CAAC,IAAI,CAAC,cAAc,EAAE,qBAAqB,EAAE;EAC7E,OAAO,EAAE,aAAa;EACtB,KAAK,EAAE,CAAC,YAAY,CAAC,UAAU,EAAE,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,kBAAkB,CAAC;EACzF,OAAO,EAAE;CACZ,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;AAExE,MAAM,WAAW,gBAAG,eAAe,CAAC,IAAI,CAAC,aAAa,EAAE,qCAAqC,EAAE;EAC3F,MAAM,EAAE;IAAE;EAAO,CAAE;EACnB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC;IAAE;EAAQ,CAAE,CAAC;EACpC,KAAK,EAAE,WAAW;EAClB,OAAO,EAAE;CACZ,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;AAEvE,MAAM,WAAW,gBAAG,eAAe,CAAC,IAAI,CAAC,aAAa,EAAE,qCAAqC,EAAE;EAC3F,MAAM,EAAE;IAAE;EAAO,CAAE;EACnB,KAAK,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC;EACrD,OAAO,EAAE;CACZ,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;AAEvE,MAAM,aAAa,gBAAG,eAAe,CAAC,IAAI,CAAC,eAAe,EAAE,sCAAsC,EAAE;EAChG,MAAM,EAAE;IAAE;EAAO,CAAE;EACnB,KAAK,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC;EACrD,OAAO,EAAE;CACZ,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC;AAE/E,MAAM,aAAa,gBAAG,eAAe,CAAC,GAAG,CAAC,eAAe,EAAE,kCAAkC,EAAE;EAC3F,MAAM,EAAE;IAAE;EAAQ,CAAE;EACpB,KAAK,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,YAAY,CAAC,SAAS,EAAE,YAAY,CAAC,kBAAkB,CAAC;EACvF,OAAO,EAAE;CACZ,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;AAE9E,MAAM,QAAQ,gBAAG,eAAe,CAAC,GAAG,CAAC,OAAO,EAAE,oBAAoB,EAAE;EAChE,OAAO,EAAE;CACZ,CAAC;AAEF;AACA;AACA;AAEA;;;;;;;;AAQA,OAAO,MAAM,aAAa,gBAAG,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAC1D,GAAG,CAAC,cAAc,CAAC,CACnB,GAAG,CAAC,UAAU,CAAC,CACf,GAAG,CAAC,QAAQ,CAAC,CACb,GAAG,CAAC,YAAY,CAAC,CACjB,GAAG,CAAC,WAAW,CAAC,CAChB,GAAG,CAAC,WAAW,CAAC,CAChB,GAAG,CAAC,aAAa,CAAC,CAClB,GAAG,CAAC,aAAa,CAAC,CAClB,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAC1E,UAAU,CAAC,UAAU,CAAC,aAAa,CAAC;AAEzC;;;;;;;;;AASA,OAAO,MAAM,mBAAmB,gBAAG,YAAY,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC;AAEzF;;;;AAIA,OAAO,MAAM,GAAG,gBAAG,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,mBAAmB,CAAC","ignoreList":[]}

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @since 1.0.0
+ */
+/**
+ * The scopes the treasury api is guarded by, as one `treasury` area.
+ *
+ * These guard the treasury's own api - proposing, accepting and watching
+ * trades - not the towers the trades move items between. Acting on a tower
+ * (depositing an item into escrow, splicing a save) happens through the
+ * tinyburg api under that game's own scopes, with a grant the player gives the
+ * treasury separately on the consent screen. Splitting the two means "let the
+ * treasury manage my trades" and "let the treasury touch my tower" are
+ * distinct questions with distinct answers.
+ *
+ * The area is built with the same `defineArea` every game's scopes are, so
+ * `Treasury.read.list_trades` is the leaf named `treasury:list_trades`, and
+ * `Treasury.read.list_trades.required` is what goes on the endpoint.
+ *
+ * @since 1.0.0
+ * @category Scopes
+ */
+export * as Scopes from "./Scopes.ts";
+/**
+ * The api the treasury serves: player-to-player trades, escrowed.
+ *
+ * Nimblebit has no hold primitive, so the treasury makes one out of the gift
+ * channel: each side's item is sent to a treasury-owned vault tower, where it
+ * sits as an *unreceived* gift - a native escrow slot - until both deposits
+ * are verified, and only then is each item forwarded to the other side. A
+ * save-splice trade instead rewrites both saves directly, which is why it
+ * requires an explicit confirmation from both parties before anything runs.
+ *
+ * Every endpoint but the public stats is bearer authenticated with a JWT
+ * access token the Tinyburg OAuth server issued for the Tinyburg api
+ * (`<site>/v1`), and guarded by a leaf of the `treasury` scope area in
+ * `Scopes`. The treasury lives behind tinyburg.app: the paths here are
+ * reached at `<site>/v1/treasury/*`, which tinyburg.app forwards verbatim,
+ * `Authorization` header included. The first-party app gets its token from
+ * tinyburg.app's `/auth/token`; any other application uses the one it was
+ * issued.
+ *
+ * A token without the endpoint's scope is refused with `403` and an
+ * `insufficient_scope` challenge. Any other `403` from a trade endpoint
+ * means the treasury holds no usable grant for the caller's towers;
+ * `GrantStatus` says so explicitly and carries the url that starts the
+ * connect flow.
+ *
+ * @since 1.0.0
+ */
+export * as Sdk from "./Sdk.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;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA"}

package/dist/index.js

@@ -0,0 +1,51 @@
+/**
+ * @since 1.0.0
+ */
+/**
+ * The scopes the treasury api is guarded by, as one `treasury` area.
+ *
+ * These guard the treasury's own api - proposing, accepting and watching
+ * trades - not the towers the trades move items between. Acting on a tower
+ * (depositing an item into escrow, splicing a save) happens through the
+ * tinyburg api under that game's own scopes, with a grant the player gives the
+ * treasury separately on the consent screen. Splitting the two means "let the
+ * treasury manage my trades" and "let the treasury touch my tower" are
+ * distinct questions with distinct answers.
+ *
+ * The area is built with the same `defineArea` every game's scopes are, so
+ * `Treasury.read.list_trades` is the leaf named `treasury:list_trades`, and
+ * `Treasury.read.list_trades.required` is what goes on the endpoint.
+ *
+ * @since 1.0.0
+ * @category Scopes
+ */
+export * as Scopes from "./Scopes.js";
+/**
+ * The api the treasury serves: player-to-player trades, escrowed.
+ *
+ * Nimblebit has no hold primitive, so the treasury makes one out of the gift
+ * channel: each side's item is sent to a treasury-owned vault tower, where it
+ * sits as an *unreceived* gift - a native escrow slot - until both deposits
+ * are verified, and only then is each item forwarded to the other side. A
+ * save-splice trade instead rewrites both saves directly, which is why it
+ * requires an explicit confirmation from both parties before anything runs.
+ *
+ * Every endpoint but the public stats is bearer authenticated with a JWT
+ * access token the Tinyburg OAuth server issued for the Tinyburg api
+ * (`<site>/v1`), and guarded by a leaf of the `treasury` scope area in
+ * `Scopes`. The treasury lives behind tinyburg.app: the paths here are
+ * reached at `<site>/v1/treasury/*`, which tinyburg.app forwards verbatim,
+ * `Authorization` header included. The first-party app gets its token from
+ * tinyburg.app's `/auth/token`; any other application uses the one it was
+ * issued.
+ *
+ * A token without the endpoint's scope is refused with `403` and an
+ * `insufficient_scope` challenge. Any other `403` from a trade endpoint
+ * means the treasury holds no usable grant for the caller's towers;
+ * `GrantStatus` says so explicitly and carries the url that starts the
+ * connect flow.
+ *
+ * @since 1.0.0
+ */
+export * as Sdk from "./Sdk.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;;;;;;;;;;;;;;;;;;AAkBA,OAAO,KAAK,MAAM,MAAM,aAAa;AAErC;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,KAAK,GAAG,MAAM,UAAU","ignoreList":[]}

package/package.json

@@ -1,6 +1,58 @@
 {
   "name": "@tinyburg/treasury-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.2.1",
+  "description": "treasury (trade escrow) sdk for tinyburg.app",
+  "keywords": [
+    "nimblebit",
+    "tinytower",
+    "tinytowers"
+  ],
+  "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/treasury-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",
+    "@tinyburg/tinytower-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"
+  },
+  "tags": [
+    "nimblebit",
+    "tinytower",
+    "tinytowers"
+  ],
+  "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"
+  }
 }

package/src/Scopes.ts

@@ -0,0 +1,70 @@
+/**
+ * The scopes the treasury api is guarded by, as one `treasury` area.
+ *
+ * These guard the treasury's own api - proposing, accepting and watching
+ * trades - not the towers the trades move items between. Acting on a tower
+ * (depositing an item into escrow, splicing a save) happens through the
+ * tinyburg api under that game's own scopes, with a grant the player gives the
+ * treasury separately on the consent screen. Splitting the two means "let the
+ * treasury manage my trades" and "let the treasury touch my tower" are
+ * distinct questions with distinct answers.
+ *
+ * The area is built with the same `defineArea` every game's scopes are, so
+ * `Treasury.read.list_trades` is the leaf named `treasury:list_trades`, and
+ * `Treasury.read.list_trades.required` is what goes on the endpoint.
+ *
+ * @since 1.0.0
+ * @category Scopes
+ */
+
+import { type ScopeDescription, defineArea } from "@tinyburg/nimblebit-sdk/NimblebitScopes";
+
+/**
+ * @since 1.0.0
+ * @category Areas
+ */
+export const Treasury = defineArea({
+    name: "treasury",
+    description: "Trades escrowed by the Tinyburg treasury",
+    read: {
+        description: "See your trades and what could go into them, without changing anything",
+        leaves: {
+            grant_status: "Check whether the treasury can act on your towers",
+            list_trades: "List your trades and the open offers you could accept",
+            get_trade: "See one trade's full state and history",
+            list_inventory: "See which of a tower's items could be traded",
+        },
+    },
+    write: {
+        description: "Propose, accept, cancel and confirm trades",
+        leaves: {
+            propose: "Propose a trade with another player",
+            accept: "Accept a trade proposed to you",
+            cancel: "Cancel a trade you are part of",
+            confirm_splice: "Confirm a save-splice trade for execution",
+        },
+    },
+});
+
+/**
+ * The shape of the treasury's area, for code that takes it as a value.
+ *
+ * @since 1.0.0
+ * @category Areas
+ */
+export type TreasuryArea = typeof Treasury;
+
+/**
+ * Every scope in the tree, the area first, then each branch, then its
+ * leaves. The order a consent screen lists them in.
+ *
+ * @since 1.0.0
+ * @category Tree
+ */
+export const all = (): ReadonlyArray<ScopeDescription> => [
+    Treasury,
+    Treasury.read,
+    ...Treasury.read.children,
+    Treasury.write,
+    ...Treasury.write.children,
+];