@markee_team/sdk 0.1.0-alpha.2 → 0.1.0-alpha.3

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.
Files changed (2) hide show
  1. package/README.md +36 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  An ESM JavaScript SDK with a self-contained, Shadow DOM modal and an optional React entry point. The SDK knows the Markee API endpoint; the host only supplies its placement and, optionally, its current wallet provider. No Alchemy, Redis, Privy, or bridge-provider key belongs in the consuming app.
4
4
 
5
- This is an experimental `0.1.0-alpha.2` release for wallet-funded For Sale and For Rent flows. Hosted card checkout and incoming cross-chain funding are not included.
5
+ This is an experimental `0.1.0-alpha.3` release for wallet-funded For Sale and For Rent flows. Hosted card checkout and incoming cross-chain funding are not included.
6
6
 
7
7
  Install the alpha:
8
8
 
@@ -143,19 +143,49 @@ No API URL configuration is required. This alpha uses the Markee staging API at
143
143
 
144
144
  ## LLM implementation prompt
145
145
 
146
- Copy this prompt into your coding assistant. These are existing Base demo boards; replace the placements with your own when integrating your product.
146
+ Copy this prompt into your coding assistant. It gathers missing requirements before implementing the integration.
147
147
 
148
148
  ```text
149
- Integrate @markee_team/sdk@0.1.0-alpha.2 into this app. Inspect the app first and
149
+ Integrate @markee_team/sdk@0.1.0-alpha.3 into this app. Inspect the app first and
150
150
  follow its existing framework, styling, and wallet patterns.
151
151
 
152
- - Install @markee_team/sdk@0.1.0-alpha.2. The SDK knows its API endpoint. Do not
152
+ Before changing code, inspect what is already available, then ask me the unanswered
153
+ questions below in one concise group. Do not ask again for facts already provided.
154
+ Wait for answers about strategy, placement, and intended scope before implementing.
155
+
156
+ 1. Do you want For Rent (recurring streaming payments), For Sale (one-time
157
+ funding), or both?
158
+ 2. Is this a proof of concept or an integration with your own Markee placement?
159
+ For your own placement, what are the chain ID and board address, or the Gardens
160
+ community address and chain ID? If unknown, ask for the existing Markee/Gardens
161
+ link so we can identify and verify the placement. Never invent an address or
162
+ assume a board supports the chosen strategy. Offer demo boards only with consent;
163
+ explain that they use real Base funds, not a sandbox. If no placement exists,
164
+ identify that prerequisite instead of silently substituting a demo board.
165
+ 3. Where should Markee appear (page/component), what should open the modal, and
166
+ what should the button say? Is the placement fixed or selected per community?
167
+ 4. Should we reuse the app's existing connected wallet or use SDK wallet discovery?
168
+ Inspect the installed connector first. If a new host wallet connector is needed,
169
+ ask which one; do not install ConnectKit automatically.
170
+ 5. Should the modal match the app's theme, or use specific light/dark/system mode,
171
+ brand colors, font, and corner radius? Suggest the existing app theme by default.
172
+ 6. After a confirmed transaction, should the app show a message, refresh data,
173
+ navigate, or notify an existing callback? Are there accessibility, mobile, or
174
+ framework constraints not evident from the code?
175
+
176
+ Explain that this alpha uses a built-in staging API and supports wallet-funded
177
+ flows; card checkout and incoming bridging are unavailable. If either is required,
178
+ ask whether to proceed with the supported scope instead of promising those features.
179
+ Summarize the agreed requirements and implement only the selected flows.
180
+
181
+ - Install @markee_team/sdk@0.1.0-alpha.3. The SDK knows its API endpoint. Do not
153
182
  request an API URL, build an API proxy, or add RPC/database/provider keys.
154
183
  - For React 18/19, import MarkeeModal from @markee_team/sdk/react in a client
155
184
  component and supply open, onClose, and placement. For other apps, import
156
185
  createMarkee from @markee_team/sdk, call createMarkee(), then open({ placement }).
157
186
  Close the instance on teardown. Reuse the built-in modal UI.
158
- - Add buttons for these existing demo placements:
187
+ - Use the agreed placement and strategy. Only if I explicitly choose a demo, use
188
+ the corresponding existing Base board below (do not add both unless requested):
159
189
  For Sale: { kind: 'board', chainId: 8453,
160
190
  address: '0x2768BC6e90266248BD8bCF5401C36D8049CdF671' }
161
191
  For Rent: { kind: 'board', chainId: 8453,
@@ -173,7 +203,7 @@ follow its existing framework, styling, and wallet patterns.
173
203
  SDK handle payment review, chain switching, submission, and verification.
174
204
  Do not advertise card checkout or incoming bridging: this alpha lacks those
175
205
  features. The demo boards use real Base funds.
176
- - Run typecheck/build and verify both modals load without API configuration,
206
+ - Run typecheck/build and verify the selected modal flows load without API configuration,
177
207
  open/close correctly, and match the theme. Verify host wallet reuse if available.
178
208
  Do not sign or submit transactions during automated verification. Report changed
179
209
  files, checks, and remaining limitations.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@markee_team/sdk",
3
- "version": "0.1.0-alpha.2",
3
+ "version": "0.1.0-alpha.3",
4
4
  "description": "Self-contained Markee modal and API client, with an optional React adapter.",
5
5
  "type": "module",
6
6
  "sideEffects": false,