@tinyburg/treasury-sdk 0.0.0-stage → 0.2.1

package/dist/Scopes.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 } from "@tinyburg/nimblebit-sdk/NimblebitScopes";
+/**
+ * @since 1.0.0
+ * @category Areas
+ */
+export declare const Treasury: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Area & {
+    readonly read: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Branch & {
+        readonly get_trade: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+        readonly grant_status: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+        readonly list_inventory: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+        readonly list_trades: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+    };
+    readonly write: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Branch & {
+        readonly accept: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+        readonly cancel: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+        readonly confirm_splice: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+        readonly propose: import("@tinyburg/nimblebit-sdk/NimblebitScopes").Leaf;
+    };
+};
+/**
+ * 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 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;;;;;;;;;;;;;;;;;GAiBG;AAEH,OAAO,EAAE,KAAK,gBAAgB,EAAc,MAAM,yCAAyC,CAAC;AAE5F;;;GAGG;AACH,eAAO,MAAM,QAAQ;;;;;;;;;;;;;CAqBnB,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,OAAO,QAAQ,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,GAAG,QAAO,aAAa,CAAC,gBAAgB,CAMpD,CAAC"}

package/dist/Scopes.js

@@ -0,0 +1,54 @@
+/**
+ * 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 { defineArea } from "@tinyburg/nimblebit-sdk/NimblebitScopes";
+/**
+ * @since 1.0.0
+ * @category Areas
+ */
+export const Treasury = /*#__PURE__*/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"
+    }
+  }
+});
+/**
+ * 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 = () => [Treasury, Treasury.read, ...Treasury.read.children, Treasury.write, ...Treasury.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;;;;;;;;;;;;;;;;;;AAmBA,SAAgC,UAAU,QAAQ,yCAAyC;AAE3F;;;;AAIA,OAAO,MAAM,QAAQ,gBAAG,UAAU,CAAC;EAC/B,IAAI,EAAE,UAAU;EAChB,WAAW,EAAE,0CAA0C;EACvD,IAAI,EAAE;IACF,WAAW,EAAE,wEAAwE;IACrF,MAAM,EAAE;MACJ,YAAY,EAAE,mDAAmD;MACjE,WAAW,EAAE,uDAAuD;MACpE,SAAS,EAAE,wCAAwC;MACnD,cAAc,EAAE;;GAEvB;EACD,KAAK,EAAE;IACH,WAAW,EAAE,4CAA4C;IACzD,MAAM,EAAE;MACJ,OAAO,EAAE,qCAAqC;MAC9C,MAAM,EAAE,gCAAgC;MACxC,MAAM,EAAE,gCAAgC;MACxC,cAAc,EAAE;;;CAG3B,CAAC;AAUF;;;;;;;AAOA,OAAO,MAAM,GAAG,GAAG,MAAuC,CACtD,QAAQ,EACR,QAAQ,CAAC,IAAI,EACb,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,EACzB,QAAQ,CAAC,KAAK,EACd,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAC7B","ignoreList":[]}