@pencil-agent/nano-pencil 2.0.0-beta.8 → 2.0.0

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 (241) hide show
  1. package/README.md +267 -267
  2. package/dist/build-meta.json +3 -3
  3. package/dist/core/export-html/AGENT.md +11 -11
  4. package/dist/core/export-html/template.css +971 -971
  5. package/dist/core/export-html/template.html +54 -54
  6. package/dist/core/extensions-host/index.d.ts +1 -1
  7. package/dist/core/extensions-host/loader.js +1 -1
  8. package/dist/core/extensions-host/runner.d.ts +1 -0
  9. package/dist/core/extensions-host/runner.js +2 -2
  10. package/dist/core/extensions-host/types.d.ts +17 -22
  11. package/dist/core/lib/ai/src/types.d.ts +12 -2
  12. package/dist/core/persona/persona-manager.js +5 -2
  13. package/dist/core/runtime/agent-session.js +3 -3
  14. package/dist/core/runtime/extension-core-bindings.d.ts +1 -0
  15. package/dist/core/runtime/extension-core-bindings.js +2 -2
  16. package/dist/extensions/builtin/AGENT.md +115 -115
  17. package/dist/extensions/builtin/browser/AGENT.md +17 -17
  18. package/dist/extensions/builtin/browser/agent-workspace/agent_helpers.py +12 -12
  19. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/amazon/product-search.md +198 -198
  20. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/archive-org/scraping.md +341 -341
  21. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/arxiv/scraping.md +311 -311
  22. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/arxiv-bulk/scraping.md +333 -333
  23. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/atlas/overview.md +70 -70
  24. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/booking-com/scraping.md +578 -578
  25. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/capterra/scraping.md +440 -440
  26. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/centilebrain/generate-estimates.md +110 -110
  27. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/coingecko/scraping.md +325 -325
  28. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/coinmarketcap/scraping.md +463 -463
  29. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/coursera/scraping.md +360 -360
  30. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/craigslist/scraping.md +390 -390
  31. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/crossref/scraping.md +568 -568
  32. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/dev-to/scraping.md +323 -323
  33. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/duckduckgo/scraping.md +349 -349
  34. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/ebay/scraping.md +435 -435
  35. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/etsy/scraping.md +506 -506
  36. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/eventbrite/scraping.md +363 -363
  37. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/expedia/automation.md +168 -168
  38. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/facebook/groups.md +236 -236
  39. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/facebook/pages.md +295 -295
  40. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/framer/editor.md +108 -108
  41. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/fred/scraping.md +493 -493
  42. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/g2/scraping.md +580 -580
  43. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/genius/scraping.md +511 -511
  44. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/github/repo-actions.md +65 -65
  45. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/github/scraping.md +184 -184
  46. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/glassdoor/scraping.md +543 -543
  47. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/gmail/compose.md +122 -122
  48. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/goodreads/scraping.md +461 -461
  49. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/gutenberg/scraping.md +383 -383
  50. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/hackernews/scraping.md +243 -243
  51. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/howlongtobeat/scraping.md +473 -473
  52. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/imdb/scraping.md +271 -271
  53. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/itch-io/scraping.md +436 -436
  54. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/job-boards/indeed-glassdoor.md +1021 -1021
  55. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/letterboxd/scraping.md +349 -349
  56. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/linkedin/invitation-manager.md +109 -109
  57. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/loom/folder-enumeration.md +170 -170
  58. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/macrotrends/scraping.md +537 -537
  59. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/medium/article-hydration.md +120 -120
  60. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/medium/scraping.md +414 -414
  61. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/metacritic/scraping.md +477 -477
  62. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/musicbrainz/scraping.md +478 -478
  63. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/nasa/scraping.md +339 -339
  64. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/news-aggregation/multi-source.md +205 -205
  65. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/open-library/scraping.md +472 -472
  66. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/openalex/scraping.md +470 -470
  67. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/openstreetmap/scraping.md +490 -490
  68. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/package-registries/npm-pypi.md +478 -478
  69. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/polymarket/scraping.md +234 -234
  70. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/producthunt/scraping.md +307 -307
  71. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/pubmed/scraping.md +421 -421
  72. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/quora/scraping.md +364 -364
  73. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/rawg/scraping.md +352 -352
  74. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/reddit/scraping.md +124 -124
  75. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/rest-countries/scraping.md +233 -233
  76. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/sec-edgar/scraping.md +361 -361
  77. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/README.md +36 -36
  78. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/embedded-apps.md +72 -72
  79. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/knowledge-base.md +109 -109
  80. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/shopify-admin/polaris-inputs.md +137 -137
  81. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/soundcloud/scraping.md +362 -362
  82. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/spotify/scraping.md +339 -339
  83. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/stackoverflow/scraping.md +435 -435
  84. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/steam/scraping.md +575 -575
  85. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/substack/scraping.md +338 -338
  86. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/thetechgeeks/pricing.md +52 -52
  87. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/tiktok/upload.md +107 -107
  88. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/tradingview/scraping.md +309 -309
  89. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/trello/boards-and-lists.md +88 -88
  90. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/trustpilot/scraping.md +375 -375
  91. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/walmart/scraping.md +444 -444
  92. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/wayback-machine/scraping.md +306 -306
  93. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/weather/scraping.md +398 -398
  94. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/wellfound/scraping.md +596 -596
  95. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/world-bank/scraping.md +356 -356
  96. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/xiaohongshu/scraping.md +84 -84
  97. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/youtube/scraping.md +418 -418
  98. package/dist/extensions/builtin/browser/agent-workspace/domain-skills/zillow/scraping.md +433 -433
  99. package/dist/extensions/builtin/browser/browser.md +73 -73
  100. package/dist/extensions/builtin/browser/install.md +142 -142
  101. package/dist/extensions/builtin/browser/interaction-skills/connection.md +48 -48
  102. package/dist/extensions/builtin/browser/interaction-skills/cookies.md +3 -3
  103. package/dist/extensions/builtin/browser/interaction-skills/cross-origin-iframes.md +3 -3
  104. package/dist/extensions/builtin/browser/interaction-skills/dialogs.md +64 -64
  105. package/dist/extensions/builtin/browser/interaction-skills/downloads.md +3 -3
  106. package/dist/extensions/builtin/browser/interaction-skills/drag-and-drop.md +3 -3
  107. package/dist/extensions/builtin/browser/interaction-skills/dropdowns.md +3 -3
  108. package/dist/extensions/builtin/browser/interaction-skills/iframes.md +3 -3
  109. package/dist/extensions/builtin/browser/interaction-skills/network-requests.md +3 -3
  110. package/dist/extensions/builtin/browser/interaction-skills/print-as-pdf.md +3 -3
  111. package/dist/extensions/builtin/browser/interaction-skills/profile-sync.md +90 -90
  112. package/dist/extensions/builtin/browser/interaction-skills/screenshots.md +17 -17
  113. package/dist/extensions/builtin/browser/interaction-skills/scrolling.md +3 -3
  114. package/dist/extensions/builtin/browser/interaction-skills/shadow-dom.md +3 -3
  115. package/dist/extensions/builtin/browser/interaction-skills/tabs.md +69 -69
  116. package/dist/extensions/builtin/browser/interaction-skills/uploads.md +1 -1
  117. package/dist/extensions/builtin/browser/interaction-skills/viewport.md +3 -3
  118. package/dist/extensions/builtin/browser/src/browser_harness/AGENT.md +15 -15
  119. package/dist/extensions/builtin/browser/src/browser_harness/__init__.py +8 -8
  120. package/dist/extensions/builtin/browser/src/browser_harness/_ipc.py +90 -90
  121. package/dist/extensions/builtin/browser/src/browser_harness/admin.py +722 -722
  122. package/dist/extensions/builtin/browser/src/browser_harness/daemon.py +328 -328
  123. package/dist/extensions/builtin/browser/src/browser_harness/helpers.py +396 -396
  124. package/dist/extensions/builtin/browser/src/browser_harness/run.py +103 -103
  125. package/dist/extensions/builtin/discipline/skills/brainstorming/SKILL.md +33 -33
  126. package/dist/extensions/builtin/discipline/skills/executing-plans/SKILL.md +25 -25
  127. package/dist/extensions/builtin/discipline/skills/finishing-development-branch/SKILL.md +25 -25
  128. package/dist/extensions/builtin/discipline/skills/receiving-code-review/SKILL.md +22 -22
  129. package/dist/extensions/builtin/discipline/skills/requesting-code-review/SKILL.md +31 -31
  130. package/dist/extensions/builtin/discipline/skills/systematic-debugging/SKILL.md +28 -28
  131. package/dist/extensions/builtin/discipline/skills/test-driven-development/SKILL.md +32 -32
  132. package/dist/extensions/builtin/discipline/skills/using-git-worktrees/SKILL.md +25 -25
  133. package/dist/extensions/builtin/discipline/skills/verification-before-completion/SKILL.md +27 -27
  134. package/dist/extensions/builtin/discipline/skills/writing-plans/SKILL.md +26 -26
  135. package/dist/extensions/builtin/goal/README.md +67 -67
  136. package/dist/extensions/builtin/goal/goal-controller.d.ts +39 -10
  137. package/dist/extensions/builtin/goal/goal-controller.js +1 -1
  138. package/dist/extensions/builtin/goal/goal-format.js +1 -1
  139. package/dist/extensions/builtin/goal/goal-prompts.d.ts +2 -0
  140. package/dist/extensions/builtin/goal/goal-prompts.js +5 -4
  141. package/dist/extensions/builtin/goal/goal-store.js +1 -1
  142. package/dist/extensions/builtin/goal/index.d.ts +1 -1
  143. package/dist/extensions/builtin/goal/index.js +10 -7
  144. package/dist/extensions/builtin/grub/README.md +112 -112
  145. package/dist/extensions/builtin/link-world/agent-workspace/README.md +16 -16
  146. package/dist/extensions/builtin/link-world/index.js +6 -6
  147. package/dist/extensions/builtin/link-world/internet-search/internet-search.md +65 -65
  148. package/dist/extensions/builtin/link-world/link-world-agent.md +82 -82
  149. package/dist/extensions/builtin/link-world/linkworld.md +313 -313
  150. package/dist/extensions/builtin/link-world/{network-routing.md → network-routing/network-routing.md} +67 -67
  151. package/dist/extensions/builtin/loop/README.md +92 -92
  152. package/dist/extensions/builtin/mcp/figma-design.md +68 -68
  153. package/dist/extensions/builtin/mcp/mcp-management.md +85 -85
  154. package/dist/extensions/builtin/plan/index.js +1 -1
  155. package/dist/extensions/builtin/recap/AGENT.md +15 -15
  156. package/dist/extensions/builtin/sal/README.md +72 -72
  157. package/dist/extensions/builtin/security-audit/README.md +289 -289
  158. package/dist/extensions/builtin/task/task-store.d.ts +4 -0
  159. package/dist/extensions/builtin/task/task-store.js +1 -1
  160. package/dist/extensions/builtin/team/AGENT.md +112 -112
  161. package/dist/extensions/builtin/team/TESTING.md +299 -299
  162. package/dist/extensions/builtin/token-save/README.md +56 -56
  163. package/dist/extensions/optional/AGENT.md +10 -10
  164. package/dist/index.d.ts +5 -30
  165. package/dist/index.js +1 -1
  166. package/dist/models.d.ts +7 -0
  167. package/dist/models.js +1 -0
  168. package/dist/modes/interactive/components/footer.js +1 -1
  169. package/dist/modes/interactive/components/task-status-panel.d.ts +36 -0
  170. package/dist/modes/interactive/components/task-status-panel.js +1 -0
  171. package/dist/modes/interactive/controllers/stream-render-controller.d.ts +7 -0
  172. package/dist/modes/interactive/controllers/stream-render-controller.js +2 -2
  173. package/dist/modes/interactive/interactive-mode.js +40 -40
  174. package/dist/modes/interactive/state/interactive-state.d.ts +2 -0
  175. package/dist/modes/interactive/state/interactive-state.js +1 -1
  176. package/dist/modes/interactive/theme/dark.json +85 -85
  177. package/dist/modes/interactive/theme/light.json +84 -84
  178. package/dist/modes/interactive/theme/theme-schema.json +335 -335
  179. package/dist/modes/interactive/theme/warm.json +81 -81
  180. package/dist/node_modules/@pencil-agent/ai/dist/cli.js +0 -0
  181. package/dist/node_modules/@pencil-agent/ai/dist/models.generated.js +1 -1
  182. package/dist/node_modules/@pencil-agent/ai/dist/providers/anthropic.js +2 -2
  183. package/dist/node_modules/@pencil-agent/ai/dist/providers/openai-completions.js +5 -5
  184. package/dist/node_modules/@pencil-agent/ai/dist/providers/openai-responses.js +1 -1
  185. package/dist/node_modules/@pencil-agent/ai/dist/stream.js +1 -1
  186. package/dist/packages/protocol/src/commands.d.ts +33 -0
  187. package/dist/packages/protocol/src/flags.d.ts +20 -0
  188. package/dist/packages/protocol/src/hooks.d.ts +17 -0
  189. package/dist/packages/protocol/src/hooks.js +0 -0
  190. package/dist/packages/{extension-sdk → protocol}/src/index.d.ts +7 -4
  191. package/dist/packages/protocol/src/index.js +1 -0
  192. package/dist/packages/{extension-sdk → protocol}/src/lifecycle.d.ts +15 -27
  193. package/dist/packages/protocol/src/lifecycle.js +0 -0
  194. package/dist/packages/{extension-sdk → protocol}/src/tools.d.ts +1 -1
  195. package/dist/packages/protocol/src/tools.js +0 -0
  196. package/dist/public-config.d.ts +12 -0
  197. package/dist/public-config.js +1 -0
  198. package/dist/runtime.d.ts +9 -0
  199. package/dist/runtime.js +1 -0
  200. package/dist/session-compaction.d.ts +7 -0
  201. package/dist/session-compaction.js +1 -0
  202. package/dist/session.d.ts +7 -0
  203. package/dist/session.js +1 -0
  204. package/dist/skills.d.ts +7 -0
  205. package/dist/skills.js +1 -0
  206. package/dist/tools.d.ts +7 -0
  207. package/dist/tools.js +1 -0
  208. package/docs/ACP/345/215/217/350/256/256/351/233/206/346/210/220/345/274/200/345/217/221/346/226/207/346/241/243.md +851 -0
  209. package/docs/SDK-TESTING.md +364 -0
  210. package/docs/codex-goal-command-impl.md +1055 -1055
  211. package/docs/codex-goal-vs-grub.md +500 -500
  212. package/docs/custom-provider.md +27 -27
  213. package/docs/extensions.md +27 -27
  214. package/docs/keybindings.md +27 -27
  215. package/docs/loop /351/207/215/346/236/204/345/256/214/346/210/220/346/200/273/347/273/223.md" +250 -250
  216. package/docs/loop /351/207/215/346/236/204/345/256/214/346/210/220/346/212/245/345/221/212.md" +122 -122
  217. package/docs/loop /351/207/215/346/236/204/346/226/271/346/241/210.md" +1222 -1222
  218. package/docs/loop /351/207/215/346/236/204/346/226/271/346/241/210/345/256/236/347/216/260/346/212/245/345/221/212.md" +158 -158
  219. package/docs/loop /351/207/215/346/236/204/346/226/271/346/241/210/345/257/271/346/257/224/345/210/206/346/236/220.md" +128 -128
  220. package/docs/loop /351/207/215/346/236/204/350/256/241/345/210/222.md" +320 -320
  221. package/docs/loop-usage-examples.md +214 -214
  222. package/docs/mem-core/346/212/200/346/234/257/346/226/207/346/241/243.md +593 -0
  223. package/docs/models.md +27 -27
  224. package/docs/packages.md +27 -27
  225. package/docs/pi-design-philosophy.md +457 -457
  226. package/docs/planmode.md +1987 -1987
  227. package/docs/prompt-templates.md +27 -27
  228. package/docs/providers.md +27 -27
  229. package/docs/sdk.md +27 -27
  230. package/docs/skills.md +27 -27
  231. package/docs/startup-performance-optimization.md +301 -0
  232. package/docs/themes.md +27 -27
  233. package/docs/tui.md +27 -27
  234. package/docs//350/256/244/347/237/245/345/234/260/345/233/276.md +47 -0
  235. package/package.json +190 -162
  236. package/dist/packages/extension-sdk/src/index.js +0 -1
  237. package/docs/cc-agent-design.md +0 -1297
  238. package/docs/cc-tui-design.md +0 -1333
  239. package/docs//345/257/271/346/240/207Claude-Code.md +0 -1775
  240. /package/dist/packages/{extension-sdk/src/lifecycle.js → protocol/src/commands.js} +0 -0
  241. /package/dist/packages/{extension-sdk/src/tools.js → protocol/src/flags.js} +0 -0
@@ -1,36 +1,36 @@
1
- # shopify-admin
2
-
3
- Browser-harness patterns for `admin.shopify.com` and embedded Shopify apps.
4
-
5
- ## Files in this folder
6
-
7
- - `embedded-apps.md` — every Shopify app runs in an iframe; how to target it
8
- - `polaris-inputs.md` — Polaris React inputs reject synthetic value setters; use CDP type_text
9
- - `knowledge-base.md` — automating the Shopify Knowledge Base App for FAQ entries
10
-
11
- ## When to use these
12
-
13
- You're driving Shopify admin and need to add / edit / configure something. The Shopify admin UI is large and many surfaces are embedded apps — first check whether what you need is in an embedded app (most apps under `admin.shopify.com/store/<store>/apps/<app-slug>/...` are).
14
-
15
- ## When to skip
16
-
17
- - If the operation is read-only product / inventory data → use the **Storefront API** (HTTP) instead, much faster
18
- - If the store has a custom admin app with API token provisioned → use the **Admin API** (GraphQL or REST) instead, no UI scraping
19
- - If you're editing theme code → use the **Shopify CLI** (`shopify theme push`) — don't touch the theme editor UI
20
-
21
- The browser is the right tool only when:
22
- - The setting / app exposes no API
23
- - The change is one-time or rare enough not to justify scripting
24
- - You're discovering / exploring the admin (e.g., finding selectors for a future automation)
25
-
26
- ## Authentication
27
-
28
- Mike (or the human owner) must be logged into `admin.shopify.com` in the Chrome session that browser-harness attaches to. The harness does NOT log in — it inherits the human's session.
29
-
30
- If you hit `accounts.shopify.com` redirect, stop and ask the human to log in. Don't type credentials.
31
-
32
- ## Polaris is in transition (Jan 2026 onward)
33
-
34
- Shopify is migrating its design system from React-based Polaris to Web-Components-based Polaris. Most legacy admin surfaces are still React. Newer surfaces (Catalog Mapping, parts of Settings) may be web components.
35
-
36
- Screenshot first. If you see `<s-text-field>` or `<s-button>` web component tags → use the web component pattern. If you see `[class*="Polaris-"]` React class names → use the CDP keystrokes pattern in `polaris-inputs.md`.
1
+ # shopify-admin
2
+
3
+ Browser-harness patterns for `admin.shopify.com` and embedded Shopify apps.
4
+
5
+ ## Files in this folder
6
+
7
+ - `embedded-apps.md` — every Shopify app runs in an iframe; how to target it
8
+ - `polaris-inputs.md` — Polaris React inputs reject synthetic value setters; use CDP type_text
9
+ - `knowledge-base.md` — automating the Shopify Knowledge Base App for FAQ entries
10
+
11
+ ## When to use these
12
+
13
+ You're driving Shopify admin and need to add / edit / configure something. The Shopify admin UI is large and many surfaces are embedded apps — first check whether what you need is in an embedded app (most apps under `admin.shopify.com/store/<store>/apps/<app-slug>/...` are).
14
+
15
+ ## When to skip
16
+
17
+ - If the operation is read-only product / inventory data → use the **Storefront API** (HTTP) instead, much faster
18
+ - If the store has a custom admin app with API token provisioned → use the **Admin API** (GraphQL or REST) instead, no UI scraping
19
+ - If you're editing theme code → use the **Shopify CLI** (`shopify theme push`) — don't touch the theme editor UI
20
+
21
+ The browser is the right tool only when:
22
+ - The setting / app exposes no API
23
+ - The change is one-time or rare enough not to justify scripting
24
+ - You're discovering / exploring the admin (e.g., finding selectors for a future automation)
25
+
26
+ ## Authentication
27
+
28
+ Mike (or the human owner) must be logged into `admin.shopify.com` in the Chrome session that browser-harness attaches to. The harness does NOT log in — it inherits the human's session.
29
+
30
+ If you hit `accounts.shopify.com` redirect, stop and ask the human to log in. Don't type credentials.
31
+
32
+ ## Polaris is in transition (Jan 2026 onward)
33
+
34
+ Shopify is migrating its design system from React-based Polaris to Web-Components-based Polaris. Most legacy admin surfaces are still React. Newer surfaces (Catalog Mapping, parts of Settings) may be web components.
35
+
36
+ Screenshot first. If you see `<s-text-field>` or `<s-button>` web component tags → use the web component pattern. If you see `[class*="Polaris-"]` React class names → use the CDP keystrokes pattern in `polaris-inputs.md`.
@@ -1,72 +1,72 @@
1
- # Shopify embedded apps run in iframes
2
-
3
- Every Shopify app surfaced in the admin (first-party like Knowledge Base, third-party like Okendo) renders inside a sandboxed iframe. Your top-level `document` queries find the Shopify chrome (sidebar, header, search bar) but **none of the app's UI**.
4
-
5
- ## How to target the iframe
6
-
7
- ```python
8
- from helpers import iframe_target, js, type_text
9
-
10
- # 1. Find the iframe by URL substring
11
- tid = iframe_target("qa-pairs-app") # Knowledge Base App
12
-
13
- # 2. Run JS inside the iframe by passing target_id
14
- result = js("""
15
- (() => {
16
- const button = Array.from(document.querySelectorAll('button')).find(b => b.textContent.trim() === 'Add FAQ');
17
- if (button) { button.click(); return {clicked: true}; }
18
- return {clicked: false};
19
- })()
20
- """, target_id=tid)
21
- ```
22
-
23
- ## Finding the URL substring
24
-
25
- The iframe's URL contains the app slug. Run:
26
-
27
- ```python
28
- import json
29
- for t in cdp("Target.getTargets")["targetInfos"]:
30
- if t["type"] == "iframe" and "shopify" in t.get("url", "").lower():
31
- print(t["url"])
32
- ```
33
-
34
- Then pick a substring unique to your target app.
35
-
36
- ## Known Shopify app iframe slugs
37
-
38
- | App | iframe URL substring |
39
- |---|---|
40
- | Shopify Knowledge Base (qa-pairs-app) | `qa-pairs-app` |
41
- | Shopify Online Store editor | `online-store-web.shopifyapps.com` |
42
- | Shopify Hydrogen Storefront | `hydrogen-storefronts` (or similar — verify) |
43
-
44
- Add to this table when you discover new ones.
45
-
46
- ## Why iframes
47
-
48
- Shopify uses App Bridge to embed third-party apps with isolation. Your top-level page CAN'T directly access app DOM for security reasons — you need iframe targeting (which the harness does via CDP `Target.attachToTarget`).
49
-
50
- ## Coordinate clicks vs JS clicks
51
-
52
- Coordinate clicks (`click(x, y)`) pass through iframes at the compositor level — they work. But JS clicks scoped to the iframe target are more reliable for routine button taps because:
53
-
54
- - Element text content is stable across UI redesigns
55
- - DPR scaling on retina is automatic
56
- - React event handlers are guaranteed to fire (vs. CDP mouse events which sometimes hit a transparent layer above the button)
57
-
58
- ## Gotcha — multiple iframes from same app
59
-
60
- The Online Store editor renders the storefront preview AND the editor toolbar in two separate iframes. Pick the right one by URL substring; don't assume the first match is correct.
61
-
62
- ```python
63
- # WRONG — picks first match
64
- tid = iframe_target("online-store-web")
65
-
66
- # RIGHT — disambiguate
67
- for t in cdp("Target.getTargets")["targetInfos"]:
68
- url = t.get("url", "")
69
- if "online-store-web" in url and "editor" in url:
70
- tid = t["targetId"]
71
- break
72
- ```
1
+ # Shopify embedded apps run in iframes
2
+
3
+ Every Shopify app surfaced in the admin (first-party like Knowledge Base, third-party like Okendo) renders inside a sandboxed iframe. Your top-level `document` queries find the Shopify chrome (sidebar, header, search bar) but **none of the app's UI**.
4
+
5
+ ## How to target the iframe
6
+
7
+ ```python
8
+ from helpers import iframe_target, js, type_text
9
+
10
+ # 1. Find the iframe by URL substring
11
+ tid = iframe_target("qa-pairs-app") # Knowledge Base App
12
+
13
+ # 2. Run JS inside the iframe by passing target_id
14
+ result = js("""
15
+ (() => {
16
+ const button = Array.from(document.querySelectorAll('button')).find(b => b.textContent.trim() === 'Add FAQ');
17
+ if (button) { button.click(); return {clicked: true}; }
18
+ return {clicked: false};
19
+ })()
20
+ """, target_id=tid)
21
+ ```
22
+
23
+ ## Finding the URL substring
24
+
25
+ The iframe's URL contains the app slug. Run:
26
+
27
+ ```python
28
+ import json
29
+ for t in cdp("Target.getTargets")["targetInfos"]:
30
+ if t["type"] == "iframe" and "shopify" in t.get("url", "").lower():
31
+ print(t["url"])
32
+ ```
33
+
34
+ Then pick a substring unique to your target app.
35
+
36
+ ## Known Shopify app iframe slugs
37
+
38
+ | App | iframe URL substring |
39
+ |---|---|
40
+ | Shopify Knowledge Base (qa-pairs-app) | `qa-pairs-app` |
41
+ | Shopify Online Store editor | `online-store-web.shopifyapps.com` |
42
+ | Shopify Hydrogen Storefront | `hydrogen-storefronts` (or similar — verify) |
43
+
44
+ Add to this table when you discover new ones.
45
+
46
+ ## Why iframes
47
+
48
+ Shopify uses App Bridge to embed third-party apps with isolation. Your top-level page CAN'T directly access app DOM for security reasons — you need iframe targeting (which the harness does via CDP `Target.attachToTarget`).
49
+
50
+ ## Coordinate clicks vs JS clicks
51
+
52
+ Coordinate clicks (`click(x, y)`) pass through iframes at the compositor level — they work. But JS clicks scoped to the iframe target are more reliable for routine button taps because:
53
+
54
+ - Element text content is stable across UI redesigns
55
+ - DPR scaling on retina is automatic
56
+ - React event handlers are guaranteed to fire (vs. CDP mouse events which sometimes hit a transparent layer above the button)
57
+
58
+ ## Gotcha — multiple iframes from same app
59
+
60
+ The Online Store editor renders the storefront preview AND the editor toolbar in two separate iframes. Pick the right one by URL substring; don't assume the first match is correct.
61
+
62
+ ```python
63
+ # WRONG — picks first match
64
+ tid = iframe_target("online-store-web")
65
+
66
+ # RIGHT — disambiguate
67
+ for t in cdp("Target.getTargets")["targetInfos"]:
68
+ url = t.get("url", "")
69
+ if "online-store-web" in url and "editor" in url:
70
+ tid = t["targetId"]
71
+ break
72
+ ```
@@ -1,109 +1,109 @@
1
- # Shopify Knowledge Base App — automating FAQ entries
2
-
3
- The Knowledge Base App (Shopify Winter '26 Edition) lets merchants control how AI agents (ChatGPT, Perplexity, Claude, Copilot, Gemini) answer questions about their brand. Each entry is a Question / Answer pair. The app currently has no public API and is English-only as of Winter '26 — browser automation is the canonical path.
4
-
5
- ## URL pattern
6
-
7
- ```
8
- https://admin.shopify.com/store/<store-handle>/apps/shopify-knowledge-base/app
9
- ```
10
-
11
- Sub-routes:
12
- - `/app` — overview (FAQ list, top unanswered questions, query log)
13
- - `/app/new` — Add FAQ form
14
- - `/app/pairs/<id>` — entry detail / edit
15
-
16
- ## Iframe slug
17
-
18
- The app runs at iframe URL containing `qa-pairs-app`:
19
-
20
- ```python
21
- tid = iframe_target("qa-pairs-app")
22
- ```
23
-
24
- ## Adding a single FAQ
25
-
26
- See `polaris-inputs.md` for the full canonical pattern. Quick version:
27
-
28
- ```python
29
- def add_faq(question, answer):
30
- tid = iframe_target("qa-pairs-app")
31
- # focus question input via JS, type via CDP, focus answer, type, click Save
32
- # poll URL for /pairs/<id> success signal
33
- ```
34
-
35
- ## Batching multiple FAQs
36
-
37
- After saving an entry, the success page shows "FAQ created. Add another FAQ" link. Click it via JS to skip navigating back to overview:
38
-
39
- ```python
40
- def click_add_another():
41
- tid = iframe_target("qa-pairs-app")
42
- js("""
43
- (() => {
44
- const link = Array.from(document.querySelectorAll('a, button'))
45
- .find(x => x.textContent.trim() === 'Add another FAQ');
46
- if (link) link.click();
47
- })()
48
- """, target_id=tid)
49
- ```
50
-
51
- Loop:
52
-
53
- ```python
54
- ENTRIES = [(q1, a1), (q2, a2), ...]
55
- for q, a in ENTRIES:
56
- click_add_another()
57
- time.sleep(1.5) # wait for form to render
58
- ok, info = add_faq(q, a)
59
- print(f"{q[:40]} -> {ok} ({info})")
60
- if not ok: break
61
- ```
62
-
63
- ## Brand voice — what to put in answers
64
-
65
- This is application-specific (depends on the merchant). For JING the rule was Aesop founder-letter tone — sentence case, no exclamation points, "JING" not "we", specific over generic.
66
-
67
- The Shopify guidance "Provide a brief answer in 1 or 2 sentences" is a soft hint. The textarea accepts longer text and AI agents prefer specific multi-sentence answers. Aim for 2-4 short sentences with concrete details.
68
-
69
- ## What to put in the Knowledge Base
70
-
71
- Categories that materially shape AI agent answers about your brand:
72
-
73
- 1. **Brand voice / DNA** — "What is your brand?" / "What's your tone?"
74
- 2. **Specs** — exact materials, dimensions, weights, sizes (NOT marketing prose)
75
- 3. **Comparisons** — "How does X compare to <competitor>?" with concrete differences
76
- 4. **Policies** — returns, shipping, care, warranty, contact (in brand voice)
77
- 5. **Origin** — founder, where made, why brand exists
78
- 6. **Limitations** — what you DON'T do (V1 scope, US-only, etc.) — agents that hallucinate availability hurt conversion
79
-
80
- Skip: anything marketing-speak. The Knowledge Base is for **truth, in voice**, not pitch copy.
81
-
82
- ## Top unanswered questions
83
-
84
- The overview shows up to 7 "Top unanswered questions" Shopify auto-detected from query logs. **Answer these first** — they're real shopper queries hitting your store right now. Once answered, the section empties.
85
-
86
- ## Query log
87
-
88
- `/admin/apps/shopify-knowledge-base/app/queries` (or "Query log" in app sidebar) shows what shoppers actually asked AI agents about your brand. Read weekly. New patterns become new FAQ entries.
89
-
90
- ## Verifying entries surface in AI
91
-
92
- After adding an entry, allow 24 hours for AI provider indexing, then test:
93
-
94
- - ChatGPT: "Tell me about <your brand>'s return policy" → check if your exact wording surfaces
95
- - Perplexity: same
96
- - Claude: "Compare <your brand> vs <competitor>" → see if your comparison framing appears
97
-
98
- If the answer doesn't surface, the entry might be too long, too vague, or contradicted by another source (your homepage, an outdated blog post). Tighten the answer.
99
-
100
- ## Limits
101
-
102
- As of Winter '26 Edition:
103
- - English-only
104
- - No bulk import / CSV upload
105
- - No API for read or write
106
- - Each entry maximum ~500 words (soft cap; UI shows guidance "1 or 2 sentences")
107
- - No version history visible to the merchant
108
-
109
- Watch Shopify changelogs for API exposure — likely in Spring '26 or Summer '26 Edition. When it ships, switch to API-driven population.
1
+ # Shopify Knowledge Base App — automating FAQ entries
2
+
3
+ The Knowledge Base App (Shopify Winter '26 Edition) lets merchants control how AI agents (ChatGPT, Perplexity, Claude, Copilot, Gemini) answer questions about their brand. Each entry is a Question / Answer pair. The app currently has no public API and is English-only as of Winter '26 — browser automation is the canonical path.
4
+
5
+ ## URL pattern
6
+
7
+ ```
8
+ https://admin.shopify.com/store/<store-handle>/apps/shopify-knowledge-base/app
9
+ ```
10
+
11
+ Sub-routes:
12
+ - `/app` — overview (FAQ list, top unanswered questions, query log)
13
+ - `/app/new` — Add FAQ form
14
+ - `/app/pairs/<id>` — entry detail / edit
15
+
16
+ ## Iframe slug
17
+
18
+ The app runs at iframe URL containing `qa-pairs-app`:
19
+
20
+ ```python
21
+ tid = iframe_target("qa-pairs-app")
22
+ ```
23
+
24
+ ## Adding a single FAQ
25
+
26
+ See `polaris-inputs.md` for the full canonical pattern. Quick version:
27
+
28
+ ```python
29
+ def add_faq(question, answer):
30
+ tid = iframe_target("qa-pairs-app")
31
+ # focus question input via JS, type via CDP, focus answer, type, click Save
32
+ # poll URL for /pairs/<id> success signal
33
+ ```
34
+
35
+ ## Batching multiple FAQs
36
+
37
+ After saving an entry, the success page shows "FAQ created. Add another FAQ" link. Click it via JS to skip navigating back to overview:
38
+
39
+ ```python
40
+ def click_add_another():
41
+ tid = iframe_target("qa-pairs-app")
42
+ js("""
43
+ (() => {
44
+ const link = Array.from(document.querySelectorAll('a, button'))
45
+ .find(x => x.textContent.trim() === 'Add another FAQ');
46
+ if (link) link.click();
47
+ })()
48
+ """, target_id=tid)
49
+ ```
50
+
51
+ Loop:
52
+
53
+ ```python
54
+ ENTRIES = [(q1, a1), (q2, a2), ...]
55
+ for q, a in ENTRIES:
56
+ click_add_another()
57
+ time.sleep(1.5) # wait for form to render
58
+ ok, info = add_faq(q, a)
59
+ print(f"{q[:40]} -> {ok} ({info})")
60
+ if not ok: break
61
+ ```
62
+
63
+ ## Brand voice — what to put in answers
64
+
65
+ This is application-specific (depends on the merchant). For JING the rule was Aesop founder-letter tone — sentence case, no exclamation points, "JING" not "we", specific over generic.
66
+
67
+ The Shopify guidance "Provide a brief answer in 1 or 2 sentences" is a soft hint. The textarea accepts longer text and AI agents prefer specific multi-sentence answers. Aim for 2-4 short sentences with concrete details.
68
+
69
+ ## What to put in the Knowledge Base
70
+
71
+ Categories that materially shape AI agent answers about your brand:
72
+
73
+ 1. **Brand voice / DNA** — "What is your brand?" / "What's your tone?"
74
+ 2. **Specs** — exact materials, dimensions, weights, sizes (NOT marketing prose)
75
+ 3. **Comparisons** — "How does X compare to <competitor>?" with concrete differences
76
+ 4. **Policies** — returns, shipping, care, warranty, contact (in brand voice)
77
+ 5. **Origin** — founder, where made, why brand exists
78
+ 6. **Limitations** — what you DON'T do (V1 scope, US-only, etc.) — agents that hallucinate availability hurt conversion
79
+
80
+ Skip: anything marketing-speak. The Knowledge Base is for **truth, in voice**, not pitch copy.
81
+
82
+ ## Top unanswered questions
83
+
84
+ The overview shows up to 7 "Top unanswered questions" Shopify auto-detected from query logs. **Answer these first** — they're real shopper queries hitting your store right now. Once answered, the section empties.
85
+
86
+ ## Query log
87
+
88
+ `/admin/apps/shopify-knowledge-base/app/queries` (or "Query log" in app sidebar) shows what shoppers actually asked AI agents about your brand. Read weekly. New patterns become new FAQ entries.
89
+
90
+ ## Verifying entries surface in AI
91
+
92
+ After adding an entry, allow 24 hours for AI provider indexing, then test:
93
+
94
+ - ChatGPT: "Tell me about <your brand>'s return policy" → check if your exact wording surfaces
95
+ - Perplexity: same
96
+ - Claude: "Compare <your brand> vs <competitor>" → see if your comparison framing appears
97
+
98
+ If the answer doesn't surface, the entry might be too long, too vague, or contradicted by another source (your homepage, an outdated blog post). Tighten the answer.
99
+
100
+ ## Limits
101
+
102
+ As of Winter '26 Edition:
103
+ - English-only
104
+ - No bulk import / CSV upload
105
+ - No API for read or write
106
+ - Each entry maximum ~500 words (soft cap; UI shows guidance "1 or 2 sentences")
107
+ - No version history visible to the merchant
108
+
109
+ Watch Shopify changelogs for API exposure — likely in Spring '26 or Summer '26 Edition. When it ships, switch to API-driven population.