@weave-apps/sdk 0.8.0 → 0.9.0

package/dist/WeaveAPIClient.d.ts

@@ -81,6 +81,32 @@ export interface PaginatedResponse<T> {
     /** Pagination metadata */
     meta: PaginationMeta;
 }
+export interface FormDataScopeOptions {
+    /**
+     * Number of levels to traverse up from the current location before scoping results.
+     * 0 = current location, 1 = parent, 2 = grandparent, etc.
+     */
+    locationLevelsUp?: number;
+    /**
+     * If true, ignores locationLevelsUp and scopes from the root location.
+     */
+    locationIncludeToRoot?: boolean;
+}
+export interface CompanyMembersQueryOptions extends FormDataScopeOptions {
+    /**
+     * Optional target type. Defaults to app context when omitted.
+     */
+    targetType?: 'app' | 'form' | 'workflow' | 'trigger' | 'startupUrlGroup';
+    /**
+     * Optional target identifier. Defaults to current app ID when omitted.
+     */
+    targetId?: string;
+    offset?: number;
+    limit?: number;
+    search?: string;
+    role?: string;
+    status?: 'active' | 'inactive';
+}
 /**
  * Weave API Client
  * Provides methods for iframe apps to interact with Weave backend
@@ -197,6 +223,17 @@ export declare class WeaveAPIClient {
          */
         delete: (appDataId: string) => Promise<void>;
     };
+    /**
+     * Company member operations for app/user discovery scenarios.
+     */
+    companyMembers: {
+        /**
+         * Get company members scoped by current user's location (supports ancestor traversal).
+         *
+         * Defaults to current app context (`targetType: 'app'`, `targetId` from app ID).
+         */
+        getAll: (options?: CompanyMembersQueryOptions) => Promise<PaginatedResponse<any>>;
+    };
     /**
      * Forms API
      *
@@ -232,7 +269,7 @@ export declare class WeaveAPIClient {
          * console.log(response.data); // Array of form submissions
          * ```
          */
-        getFormData: (formId: string) => Promise<PaginatedResponse<AppData>>;
+        getFormData: (formId: string, scopeOptions?: FormDataScopeOptions) => Promise<PaginatedResponse<AppData>>;
         /**
          * Submit form data
          * Creates app data with targetType: 'form' and targetId: formId

package/dist/WeaveAPIClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WeaveAPIClient.d.ts","sourceRoot":"","sources":["../src/WeaveAPIClient.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,0BAA0B;IAC1B,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,0BAA0B;IAC1B,IAAI,EAAE,cAAc,CAAC;CACtB;AA6CD;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,eAAe,CAGR;IAEf,OAAO,CAAC,eAAe,CAAgD;IACvE,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,KAAK,CAAuB;;IAMpC;;;OAGG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIpC;;OAEG;IACH,OAAO,CAAC,UAAU;IAQlB;;OAEG;IACI,OAAO,IAAI,IAAI;IAQtB;;OAEG;IACH,OAAO,CAAC,cAAc;IAuBtB;;OAEG;IACH,OAAO,CAAC,WAAW;IA8CnB;;;;;;;;;;;;;OAaG;IACI,EAAE;wBACe,aAAa,KAAG,OAAO,CAAC,cAAc,CAAC;MAG7D;IAMF;;OAEG;IACI,OAAO;QACZ;;;;;;;;;;;;;;;;;WAiBG;sBACe,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAIrD;;;;;;;;;;;;WAYG;0BACqB,oBAAoB,KAAG,OAAO,CAAC,OAAO,CAAC;QAI/D;;;;;;;WAOG;yBACoB,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;QAIhD;;;;;;;;;WASG;4BACuB,MAAM,WAAW,oBAAoB,KAAG,OAAO,CAAC,OAAO,CAAC;QAOlF;;;;;;;WAOG;4BACuB,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;MAGhD;IAEF;;;;OAIG;IACH,KAAK;QACH;;;;;;;;WAQG;sBACe,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAIjD;;;;;;;;WAQG;sBACiB,MAAM,KAAG,OAAO,CAAC,GAAG,CAAC;QAIzC;;;;;;;;WAQG;8BACyB,MAAM,KAAG,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAIxE;;;;;;;;;;;;;;WAcG;iCAC4B,MAAM,WAAW,oBAAoB,KAAG,OAAO,CAAC,OAAO,CAAC;MAGvF;IAEF;;;;;OAKG;IACH,KAAK;QACH;;;;;;;;WAQG;+BACoB,MAAM,KAAG,MAAM;QAQtC;;;;;;;;WAQG;mCACwB,MAAM,KAAG,MAAM;MAO1C;CACH;AAGD,QAAA,MAAM,QAAQ,gBAAuB,CAAC;AAOtC,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"WeaveAPIClient.d.ts","sourceRoot":"","sources":["../src/WeaveAPIClient.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,+CAA+C;IAC/C,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,SAAS,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC1B,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,0BAA0B;IAC1B,IAAI,EAAE,CAAC,EAAE,CAAC;IACV,0BAA0B;IAC1B,IAAI,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAED,MAAM,WAAW,0BAA2B,SAAQ,oBAAoB;IACtE;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,GAAG,iBAAiB,CAAC;IACzE;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,CAAC;CAChC;AAgDD;;;GAGG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,eAAe,CAGR;IAEf,OAAO,CAAC,eAAe,CAAgD;IACvE,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,OAAO,CAAU;IACzB,OAAO,CAAC,KAAK,CAAuB;;IAMpC;;;OAGG;IACI,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAIpC;;OAEG;IACH,OAAO,CAAC,UAAU;IAQlB;;OAEG;IACI,OAAO,IAAI,IAAI;IAQtB;;OAEG;IACH,OAAO,CAAC,cAAc;IAuBtB;;OAEG;IACH,OAAO,CAAC,WAAW;IA8CnB;;;;;;;;;;;;;OAaG;IACI,EAAE;wBACe,aAAa,KAAG,OAAO,CAAC,cAAc,CAAC;MAG7D;IAMF;;OAEG;IACI,OAAO;QACZ;;;;;;;;;;;;;;;;;WAiBG;sBACe,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAIrD;;;;;;;;;;;;WAYG;0BACqB,oBAAoB,KAAG,OAAO,CAAC,OAAO,CAAC;QAI/D;;;;;;;WAOG;yBACoB,MAAM,KAAG,OAAO,CAAC,OAAO,CAAC;QAIhD;;;;;;;;;WASG;4BACuB,MAAM,WAAW,oBAAoB,KAAG,OAAO,CAAC,OAAO,CAAC;QAOlF;;;;;;;WAOG;4BACuB,MAAM,KAAG,OAAO,CAAC,IAAI,CAAC;MAGhD;IAMF;;OAEG;IACI,cAAc;QACnB;;;;WAIG;2BAEQ,0BAA0B,KAClC,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;MAGlC;IAEF;;;;OAIG;IACH,KAAK;QACH;;;;;;;;WAQG;sBACe,OAAO,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAIjD;;;;;;;;WAQG;sBACiB,MAAM,KAAG,OAAO,CAAC,GAAG,CAAC;QAIzC;;;;;;;;WAQG;8BAEO,MAAM,iBACA,oBAAoB,KACjC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAOtC;;;;;;;;;;;;;;WAcG;iCAC4B,MAAM,WAAW,oBAAoB,KAAG,OAAO,CAAC,OAAO,CAAC;MAGvF;IAEF;;;;;OAKG;IACH,KAAK;QACH;;;;;;;;WAQG;+BACoB,MAAM,KAAG,MAAM;QAQtC;;;;;;;;WAQG;mCACwB,MAAM,KAAG,MAAM;MAO1C;CACH;AAGD,QAAA,MAAM,QAAQ,gBAAuB,CAAC;AAOtC,eAAe,QAAQ,CAAC"}

package/dist/WeaveAPIClient.js

@@ -13,6 +13,8 @@ var APIOperation;
 (function (APIOperation) {
     // AI Service
     APIOperation["AI_CHAT"] = "AI_CHAT";
+    // Company Members Service
+    APIOperation["COMPANY_MEMBERS_GET"] = "COMPANY_MEMBERS_GET";
     // App Data Service
     APIOperation["APP_DATA_GET_ALL"] = "APP_DATA_GET_ALL";
     APIOperation["APP_DATA_CREATE"] = "APP_DATA_CREATE";
@@ -58,9 +60,9 @@ export class WeaveAPIClient {
                 return this.sendRequest(APIOperation.AI_CHAT, request);
             }
         };
-        // ============================================================================
+        // =========================================================================
         // App Data Service
-        // ============================================================================
+        // =========================================================================
         /**
          * App Data operations - CRUD for app-specific data storage
          */
@@ -141,6 +143,22 @@ export class WeaveAPIClient {
                 return this.sendRequest(APIOperation.APP_DATA_DELETE, { appDataId });
             }
         };
+        // =========================================================================
+        // Company Members Service
+        // =========================================================================
+        /**
+         * Company member operations for app/user discovery scenarios.
+         */
+        this.companyMembers = {
+            /**
+             * Get company members scoped by current user's location (supports ancestor traversal).
+             *
+             * Defaults to current app context (`targetType: 'app'`, `targetId` from app ID).
+             */
+            getAll: async (options = {}) => {
+                return this.sendRequest(APIOperation.COMPANY_MEMBERS_GET, options);
+            },
+        };
         /**
          * Forms API
          *
@@ -180,8 +198,11 @@ export class WeaveAPIClient {
              * console.log(response.data); // Array of form submissions
              * ```
              */
-            getFormData: async (formId) => {
-                return this.sendRequest(APIOperation.FORMS_GET_DATA, { formId });
+            getFormData: async (formId, scopeOptions = {}) => {
+                return this.sendRequest(APIOperation.FORMS_GET_DATA, {
+                    formId,
+                    ...scopeOptions,
+                });
             },
             /**
              * Submit form data

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weave-apps/sdk",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "SDK for building Weave Micro Apps",
   "publishConfig": {
     "access": "public"

package/templates/WEAVE_SPEC.md

@@ -9,7 +9,7 @@
 
 Weave apps are **Web Components** that run in an **iframe** inside a browser extension sidebar. They interact with two secure APIs:
 
-1. **Weave Backend API** - AI services and data storage
+1. **Weave Backend API** - AI services, app data, forms, and company member discovery
 2. **DOM Bridge API** - Parent page DOM manipulation
 
 ```
@@ -1808,8 +1808,9 @@ await axios.get('https://some-api.com');
 ✅ **ALLOWED:**
 ```typescript
 // ✅ CORRECT - Use Weave API
-await weaveAPI.ai.chat({ appName: 'my-app', prompt: '...' });
-await weaveAPI.appData.create({ appId: 'my-app', dataKey: 'key', data: {} });
+await this.weaveAPI.ai.chat({ prompt: 'Summarize this page' });
+await this.weaveAPI.appData.create({ dataKey: 'key', data: {} });
+await this.weaveAPI.forms.getFormData('form-id-123', { locationLevelsUp: 1 });
 
 // ✅ CORRECT - Use DOM Bridge
 await weaveDOM.getText('h1');
@@ -2120,14 +2121,82 @@ interface AppData {
 }
 ```
 
+### Forms Service
+
+Use the Forms service for reading form definitions and working with form submissions.
+
+```typescript
+class MyApp extends WeaveBaseApp {
+  async loadFormsAndSubmissions(formId: string) {
+    const apiClient = this.weaveAPI;
+
+    // List available forms for the current company
+    const forms = await apiClient.forms.getAll();
+
+    // Fetch a single form definition
+    const form = await apiClient.forms.get(formId);
+
+    // Fetch form submissions with location-aware scoping
+    const submissions = await apiClient.forms.getFormData(formId, {
+      locationLevelsUp: 1,         // 0=current location, 1=parent, etc.
+      locationIncludeToRoot: false // true = scope from root location
+    });
+
+    return { forms: forms.data, form, submissions: submissions.data };
+  }
+
+  async submitForm(formId: string, payload: Record<string, any>) {
+    return this.weaveAPI.forms.submitFormData(formId, {
+      dataKey: 'form_submission',
+      data: payload,
+    });
+  }
+}
+```
+
+### Company Members Service
+
+Use this service to fetch company members with optional location-based scope filters.
+
+```typescript
+class MyApp extends WeaveBaseApp {
+  async getVisiblePeopleForAppContext() {
+    return this.weaveAPI.companyMembers.getAll({
+      locationLevelsUp: 0,
+      locationIncludeToRoot: false,
+      offset: 0,
+      limit: 100,
+    });
+  }
+
+  async getVisiblePeopleForForm(formId: string) {
+    // Optional advanced scoping to a specific target type/id
+    return this.weaveAPI.companyMembers.getAll({
+      targetType: 'form',
+      targetId: formId,
+      locationLevelsUp: 2,
+      locationIncludeToRoot: true,
+      status: 'active',
+      search: 'nurse',
+    });
+  }
+}
+```
+
+`companyMembers.getAll(options)` supports:
+- `targetType?: 'app' | 'form' | 'workflow' | 'trigger' | 'startupUrlGroup'`
+- `targetId?: string`
+- `locationLevelsUp?: number`
+- `locationIncludeToRoot?: boolean`
+- `offset?: number`, `limit?: number`, `search?: string`, `role?: string`, `status?: 'active' | 'inactive'`
+
 ### API Error Handling
 
 All API methods return promises. Always use try-catch:
 
 ```typescript
 try {
-  const response = await weaveAPI.ai.chat({
-    appName: 'my-app',
+  const response = await this.weaveAPI.ai.chat({
     prompt: 'Hello'
   });
   console.log(response.response);
@@ -2139,7 +2208,7 @@ try {
 
 ### API Timeouts
 
-- All API requests timeout after **30 seconds**
+- All API requests timeout after **3 minutes**
 - Requests will reject with timeout error if exceeded
 
 ### Security & Scoping
@@ -4330,6 +4399,16 @@ customElements.define('page-title-editor', PageTitleEditor);
   - `this.weaveAPI.appData.get(id)` - Get specific data
   - `this.weaveAPI.appData.update(id, request)` - Update data
   - `this.weaveAPI.appData.delete(id)` - Delete data
+- **Forms Service:**
+  - `this.weaveAPI.forms.getAll()` - List forms
+  - `this.weaveAPI.forms.get(formId)` - Get single form
+  - `this.weaveAPI.forms.getFormData(formId, scopeOptions)` - Get submissions with optional location scope
+  - `this.weaveAPI.forms.submitFormData(formId, payload)` - Submit form data
+- **Company Members Service:**
+  - `this.weaveAPI.companyMembers.getAll(options)` - Get company members with optional location and target scoping
+- **Utilities:**
+  - `this.weaveAPI.utils.htmlToMarkdown(html)`
+  - `this.weaveAPI.utils.markdownToHtml(markdown)`
 
 ### DOM API Methods (`weaveDOM`)
 - **Read:** `query`, `queryAll`, `getText`, `getAttribute`, `getValue`, `hasClass`, `getPageUrl`