@nsite/stealthis 0.2.0 → 0.3.0

package/README.md

@@ -0,0 +1,70 @@
+# @nsite/stealthis
+
+A drop-in web component that adds a "Borrow this" button to any nsite. Visitors can deploy a copy of the current page to their own nostr identity with one click.
+
+## How it works
+
+When loaded on an nsite, `<nsite-deploy>` detects the site owner's pubkey from the subdomain, fetches the site manifest from nostr relays, and lets authenticated visitors publish a copy under their own npub. Each deployment appends a `muse` tag to the manifest, creating a paper trail of who was inspired by the site.
+
+## Install
+
+Add a script tag to your nsite. The widget auto-injects a fixed-position button in the bottom-right corner.
+
+```html
+<script src="https://unpkg.com/@nsite/stealthis/dist/stealthis.js"></script>
+```
+
+Or use the ES module:
+
+```js
+import '@nsite/stealthis';
+```
+
+## Manual placement
+
+If you want to control where the button appears, add the element yourself (the auto-inject will skip if one already exists):
+
+```html
+<nsite-deploy button-text="Cop this joint" stat-text="%s npubs copped this"></nsite-deploy>
+```
+
+## Attributes
+
+| Attribute | Default | Description |
+|-----------|---------|-------------|
+| `button-text` | `"Borrow this nsite"` | Button text |
+| `stat-text` | `"%s npubs borrowed this nsite"` | Paper trail summary. `%s` is replaced with the count. |
+| `no-trail` | _(absent)_ | Boolean attribute. When present, hides the paper trail. |
+
+The button's `trigger` part is exposed via `::part(trigger)` for CSS customization.
+
+## Authentication
+
+The widget supports three sign-in methods:
+
+- **NIP-07** - Browser extension (e.g. nos2x, Alby)
+- **NIP-46 Bunker URI** - Paste a `bunker://` connection string
+- **NIP-46 QR / Nostr Connect** - Scan a QR code with a signer app
+
+## Deploy options
+
+- **Root site** - Publishes as the visitor's primary nsite (kind `15128`)
+- **Named site** - Publishes as a named sub-site with a slug (kind `35128`)
+
+If the visitor already has a root site, the form defaults to a named site. Overwriting an existing site requires explicit confirmation.
+
+## Paper trail
+
+Each deployment adds a `muse` tag with the deployer's pubkey and relay list. The widget shows an expandable "Inspired N npubs" counter when muse tags are present. A maximum of 9 muse tags are kept per manifest (originator + 8 most recent), with FIFO truncation of the middle.
+
+## Development
+
+```bash
+pnpm install
+pnpm run build    # builds dist/stealthis.js (IIFE) and dist/stealthis.mjs (ESM)
+pnpm run dev      # watch mode
+```
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nsite/stealthis",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "module",
   "main": "dist/stealthis.js",
   "module": "dist/stealthis.mjs",

package/src/widget.ts

@@ -22,7 +22,7 @@ type State =
   | 'error';
 
 export class NsiteDeployButton extends HTMLElement {
-  static observedAttributes = ['label'];
+  static observedAttributes = ['button-text', 'stat-text', 'no-trail'];
 
   private shadow: ShadowRoot;
   private state: State = 'idle';
@@ -68,8 +68,12 @@ export class NsiteDeployButton extends HTMLElement {
     if (this.state === 'idle') this.render();
   }
 
-  private get buttonLabel(): string {
-    return this.getAttribute('label') || 'Borrow this';
+  private get buttonText(): string {
+    return this.getAttribute('button-text') || 'Borrow this nsite';
+  }
+
+  private get statText(): string {
+    return this.getAttribute('stat-text') || '%s npubs borrowed this nsite';
   }
 
   private esc(s: string): string {
@@ -90,12 +94,12 @@ export class NsiteDeployButton extends HTMLElement {
 
     switch (this.state) {
       case 'idle':
-        html += `<button class="nd-trigger" part="trigger">${this.esc(this.buttonLabel)}</button>`;
+        html += `<button class="nd-trigger" part="trigger">${this.esc(this.buttonText)}</button>`;
         html += this.paperTrailContent();
         break;
 
       case 'auth':
-        html += `<button class="nd-trigger" disabled>${this.esc(this.buttonLabel)}</button>`;
+        html += `<button class="nd-trigger" disabled>${this.esc(this.buttonText)}</button>`;
         html += this.modal(this.authContent());
         break;
 
@@ -118,12 +122,12 @@ export class NsiteDeployButton extends HTMLElement {
         break;
 
       case 'form':
-        html += `<button class="nd-trigger" disabled>${this.esc(this.buttonLabel)}</button>`;
+        html += `<button class="nd-trigger" disabled>${this.esc(this.buttonText)}</button>`;
         html += this.modal(this.formContent());
         break;
 
       case 'confirm':
-        html += `<button class="nd-trigger" disabled>${this.esc(this.buttonLabel)}</button>`;
+        html += `<button class="nd-trigger" disabled>${this.esc(this.buttonText)}</button>`;
         html += this.modal(this.confirmContent());
         break;
 
@@ -151,7 +155,7 @@ export class NsiteDeployButton extends HTMLElement {
         break;
 
       case 'error':
-        html += `<button class="nd-trigger" part="trigger">${this.esc(this.buttonLabel)}</button>`;
+        html += `<button class="nd-trigger" part="trigger">${this.esc(this.buttonText)}</button>`;
         html += this.modal(`
           <div class="nd-header">
             <h2 class="nd-title">Error</h2>
@@ -172,10 +176,10 @@ export class NsiteDeployButton extends HTMLElement {
   // --- Content builders ---
 
   private paperTrailContent(): string {
-    if (this.muses.length === 0) return '';
+    if (this.hasAttribute('no-trail') || this.muses.length === 0) return '';
 
     let html = `<div class="nd-trail">
-      <button class="nd-trail-toggle" data-action="toggle-trail">Inspired ${this.muses.length} npub${this.muses.length === 1 ? '' : 's'}</button>`;
+      <button class="nd-trail-toggle" data-action="toggle-trail">${this.esc(this.statText.replace('%s', String(this.muses.length)))}</button>`;
 
     if (this.musesExpanded) {
       html += `<div class="nd-trail-list">`;