@markee_team/sdk 0.1.0-alpha.20 → 0.1.0-alpha.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -154,6 +154,8 @@ Theme changes update styles in place: drafts, focus, scroll, wallet sessions, an
154
154
 
155
155
  Color tokens: `background`, `surface`, `text`, `muted`, `border`, `inputBackground`, `inputText`, `primary`, `primaryText`, `accent`, `accentText`, `accentSurface`, `accentSurfaceText`, `accentBorder`, `selected`, `selectedText`, `info`, `infoText`, `error`, `errorText`, `success`, `successText`, `link`, `focusRing`, and `overlay`. Set foreground/background pairs together and check your brand's contrast in both modes. Overrides apply over either selected palette; omitted values use that palette's defaults. Invalid CSS color/font values fall back to defaults.
156
156
 
157
+ To match an app completely, override `link`, `focusRing`, `border`, `selected`/`selectedText`, and the accent colors as well as the primary button colors. Otherwise those elements retain the SDK palette. Use the typed theme options; arbitrary custom CSS is not currently supported. The sign’s price badge appears on hover or keyboard focus, and stays visible on touch devices.
158
+
157
159
  Styles are scoped to the modal's Shadow DOM and do not change the host app or its wallet picker. The ConnectKit sample includes light, dark, device, and custom Plum presets.
158
160
 
159
161
  ## Headless API
@@ -173,6 +175,14 @@ For Sale supports create/fund/edit. New message ownership belongs to the caller.
173
175
 
174
176
  For Rent supports message creation, starting/updating/switching/stopping a stream, wrap/unwrap, pool connection/refunds, board-buffer recovery, ranking refresh and settlement. The server builds the complete Superfluid batch, including exact ETHx approval and pool connection. Wallet runway uses the combined CFA and GDA net flow across the wallet, not only the current board. Rental MARKEE comes from actual settled rent, never merely from wrapping or depositing ETH.
175
177
 
178
+ Payment reviews remain visible while the wallet requests confirmation, including network switches. If a review expires when confirming, the modal shows **Refreshing payment details…**, prepares an updated review, and requires another confirmation click. It never automatically sends the refreshed transaction.
179
+
180
+ For Sale reviews are disabled when the entered payment exceeds the loaded ETH balance; the balance uses the error color and the button explains the shortfall. The API also checks network fees before wallet confirmation.
181
+
182
+ For Rent reviews show estimated **MARKEE/month while winning**, using the selected monthly stream rate and current on-chain reward settings. The estimate is not based on the ETH deposit and is not guaranteed; if quoting is unavailable, the modal shows a qualitative reward description. Rental transaction details contain only Network, Recipient, and Wallet; fees stay in the payment summary.
183
+
184
+ Refunds flow automatically when connected to the message’s refund pool. **Collect refund** appears only when the loaded wallet snapshot reports a positive claimable balance for that message’s pool. Board-buffer recovery is separate. Community revenue actions are accessed through **Community accumulated revenue**.
185
+
176
186
  Community activation supports the current council Safe, a current Safe owner, or the configured authorized keeper. Revenue claims support the current Safe or its current owners and always pay the council treasury. Existing outbound Across, Squid and LI.FI routing lives on Markee's server.
177
187
 
178
188
  ## Integration boundaries
@@ -187,7 +197,13 @@ Backend configuration and API reference: [`docs/sdk/implementation.md`](https://
187
197
 
188
198
  ## API endpoint
189
199
 
190
- No API URL or Markee API key is required. The SDK connects to the Markee-hosted API and centralizes on-chain reads, metadata, and transaction preparation. For local development or testing, pass an optional `apiUrl` override to `createMarkee`, `MarkeeClient`, or the React modal. The endpoint used by your installed release is exported as `DEFAULT_MARKEE_API_URL`.
200
+ No API URL or Markee API key is required. The SDK default is:
201
+
202
+ ```text
203
+ https://staging.markee.xyz/api/sdk/v1
204
+ ```
205
+
206
+ Markee hosts this API and centralizes on-chain reads, metadata, and transaction preparation. Staging does not imply test funds: Base placements use real funds. For local development or testing, pass an optional `apiUrl` override to `createMarkee`, `MarkeeClient`, or the React modal. The endpoint used by your installed release is exported as `DEFAULT_MARKEE_API_URL`.
191
207
 
192
208
  ## LLM implementation prompt
193
209
 
@@ -220,8 +236,9 @@ Ask only the remaining unanswered requirements in one concise group:
220
236
  Markee-hosted card checkout without an app wallet (For Sale on Base only)? Inspect
221
237
  existing connectors first; do not add a second wallet context or install a new
222
238
  connector without agreement.
223
- - Should the modal match the app theme or use specific colors, font, radius, and
224
- light/dark/system mode?
239
+ - Should the modal match the app theme or use specific colors, font, panel/card/
240
+ control radii, and light/dark/system mode? Include links, focus rings, borders,
241
+ and selected states when matching the host palette.
225
242
  - What public domain/page will host this integration? Use it as siteUrl for
226
243
  automatic verification. For Vite/client rendering, add the board marker to the
227
244
  static HTML as documented; do not claim localhost is verified.
@@ -244,7 +261,8 @@ Then implement the agreed scope:
244
261
  Otherwise omit wallet. Without a connected app account, the modal shows only
245
262
  Pay, opening Markee-hosted checkout for supported boards. Do not install
246
263
  Privy or collect card details in the host app.
247
- 5. Apply theme options while preserving the built-in modal layout. Handle onEvent
264
+ 5. Apply theme options (including radius, cardRadius, and controlRadius) while
265
+ preserving the built-in modal layout. Handle onEvent
248
266
  if needed; show success only for a confirmed event. Let the SDK manage review,
249
267
  network switching, submission, and verification.
250
268
  6. Verify build/types, loading of the supplied board, automatic strategy selection,
package/dist/client.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import type { Action, Address, AdminOperation, AdminResult, Authorization, BridgeStatus, ClaimQuote, EIP1193Provider, Hex, Placement, PreparedAction, SDKOptions, Snapshot, SiteVerification, TransactionResult } from './types.js';
2
2
  /** Markee-hosted API used by integrations unless overridden for local development. */
3
- export declare const DEFAULT_MARKEE_API_URL = "https://2staging.markee.xyz/api/sdk/v1";
3
+ export declare const DEFAULT_MARKEE_API_URL = "https://staging.markee.xyz/api/sdk/v1";
4
4
  export declare class MarkeeError extends Error {
5
5
  code: string;
6
6
  status?: number | undefined;