@weave-apps/sdk 0.1.8 → 0.1.10

package/README.md

@@ -17,6 +17,62 @@ Official SDK for building third-party applications for the Weave Platform.
 - ✅ **AI Integration** - Leverage AI for smart form filling
 - ✅ **Data Persistence** - Store app data with the Weave API
 
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Quick Start](#quick-start)
+  - [1. Initialize a New App](#1-initialize-a-new-app)
+  - [2. Develop Your App](#2-develop-your-app)
+  - [3. Build Your App](#3-build-your-app)
+  - [4. Upload to Weave](#4-upload-to-weave)
+- [API Reference](#api-reference)
+  - [WeaveBaseApp](#weavebaseapp)
+    - [Constructor](#constructor)
+    - [Settings & State](#settings--state)
+    - [Methods to Implement](#methods-to-implement)
+      - [`render(): void | Promise<void>`](#render-void--promisevoid)
+      - [`setupEventListeners(): void` (Optional)](#setupeventlisteners-void-optional)
+      - [`onBackgroundService(): void` (Optional)](#onbackgroundservice-void-optional)
+      - [`onUrlChange(newUrl: string): void` (Optional)](#onurlchangenewurl-string-void-optional)
+      - [`cleanup(): void` (Optional)](#cleanup-void-optional)
+    - [Helper Methods](#helper-methods)
+      - [`renderHTML(html: string): void`](#renderhtmlhtml-string-void)
+      - [`setState(updates: object): void`](#setstateupdates-object-void)
+      - [`this.background` (Property)](#thisbackground-property)
+      - [`query<T>(selector: string): T | null`](#querytselector-string-t--null)
+      - [`queryAll<T>(selector: string): NodeListOf<T>`](#queryalltselector-string-nodelistoft)
+  - [WeaveDOMAPI](#weavedomapi)
+    - [URL & Navigation](#url--navigation)
+    - [Read Operations](#read-operations)
+    - [Write Operations](#write-operations)
+    - [DOM Injection](#dom-injection)
+    - [Event Listeners](#event-listeners)
+  - [WeaveAPIClient](#weaveapiclient)
+    - [App Data Management](#app-data-management)
+    - [AI Integration](#ai-integration)
+    - [Utilities](#utilities)
+- [Advanced Topics](#advanced-topics)
+  - [State Persistence (Survive Page Reloads)](#state-persistence-survive-page-reloads)
+    - [Auto-Persist (Recommended)](#auto-persist-recommended)
+    - [Multi-Page Flows (Pending Operations)](#multi-page-flows-pending-operations)
+    - [State TTL](#state-ttl)
+  - [Settings & Configuration](#settings--configuration)
+  - [Error Handling](#error-handling)
+  - [Performance Tips](#performance-tips)
+- [Build Process](#build-process)
+- [Security](#security)
+- [Project Structure](#project-structure)
+- [Troubleshooting](#troubleshooting)
+  - ["TypeScript not found in SDK"](#typescript-not-found-in-sdk)
+  - [Form not filling](#form-not-filling)
+  - [Button not injecting](#button-not-injecting)
+  - [State not persisting across page reloads](#state-not-persisting-across-page-reloads)
+  - [State not persisting long-term](#state-not-persisting-long-term)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Quick Start
 
 ### 1. Initialize a New App

package/dist/index.d.ts

@@ -3,9 +3,11 @@
  *
  * Main exports for third-party app development
  */
-export { WeaveBaseApp, type WeaveAppInfo } from './WeaveBaseApp';
+export { WeaveBaseApp, type WeaveAppInfo, type PendingOperation } from './WeaveBaseApp';
 export { WeaveDOMAPI, type ElementSnapshot, type InsertPosition } from './WeaveDOMAPI';
 export { default as weaveDOM } from './WeaveDOMAPI';
 export { WeaveAPIClient, type AIChatRequest, type AIChatResponse, type AppData, type CreateAppDataRequest, type UpdateAppDataRequest } from './WeaveAPIClient';
 export { default as weaveAPI } from './WeaveAPIClient';
+export { WeaveBackgroundAPI } from './WeaveBackgroundAPI';
+import './global';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,KAAK,eAAe,EAAE,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AACvF,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EACL,cAAc,EACd,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,OAAO,EACZ,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,YAAY,EAAE,KAAK,YAAY,EAAE,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AACxF,OAAO,EAAE,WAAW,EAAE,KAAK,eAAe,EAAE,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AACvF,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EACL,cAAc,EACd,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,OAAO,EACZ,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EAC1B,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAG1D,OAAO,UAAU,CAAC"}

package/dist/index.js

@@ -8,3 +8,6 @@ export { WeaveDOMAPI } from './WeaveDOMAPI';
 export { default as weaveDOM } from './WeaveDOMAPI';
 export { WeaveAPIClient } from './WeaveAPIClient';
 export { default as weaveAPI } from './WeaveAPIClient';
+export { WeaveBackgroundAPI } from './WeaveBackgroundAPI';
+// Import global.ts to ensure Window interface augmentation is included
+import './global';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weave-apps/sdk",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "SDK for building Weave Micro Apps",
   "publishConfig": {
     "access": "public"
@@ -15,7 +15,7 @@
   },
   "scripts": {
     "copy-sdk": "node scripts/copy-sdk-files.js",
-    "prebuild": "npm run copy-sdk",
+    "prebuild": "npm run copy-sdk && npx doctoc README.md",
     "build": "tsc",
     "dev": "tsc --watch",
     "prepare": "npm run build",