@weave-apps/sdk 0.1.17 → 0.1.19

package/dist/SidekickAPIClient.js

@@ -1,274 +0,0 @@
-/**
- * Sidekick API Client
- *
- * Client-side API for iframe apps to interact with the Sidekick backend
- * through a secure proxy in the sidebar.
- *
- * Apps can call AI services and manage their own app data.
- */
-/**
- * API operation types
- */
-var APIOperation;
-(function (APIOperation) {
-    // AI Service
-    APIOperation["AI_CHAT"] = "AI_CHAT";
-    // App Data Service
-    APIOperation["APP_DATA_GET_ALL"] = "APP_DATA_GET_ALL";
-    APIOperation["APP_DATA_CREATE"] = "APP_DATA_CREATE";
-    APIOperation["APP_DATA_GET"] = "APP_DATA_GET";
-    APIOperation["APP_DATA_UPDATE"] = "APP_DATA_UPDATE";
-    APIOperation["APP_DATA_DELETE"] = "APP_DATA_DELETE";
-})(APIOperation || (APIOperation = {}));
-/**
- * Sidekick API Client
- * Provides methods for iframe apps to interact with Sidekick backend
- */
-export class SidekickAPIClient {
-    constructor() {
-        this.pendingRequests = new Map();
-        this.messageListener = null;
-        this.requestCounter = 0;
-        this.timeout = 180000; // 3 minute timeout for API calls (AI can take time on large forms)
-        this.appId = null; // App ID set by the app
-        // ============================================================================
-        // AI Service
-        // ============================================================================
-        /**
-         * Send a chat message to the AI service
-         *
-         * Note: App ID is automatically injected by the APIBridge.
-         * You only need to provide the prompt and optional context.
-         *
-         * @example
-         * ```javascript
-         * const response = await sidekickAPI.ai.chat({
-         *   prompt: 'What is the capital of France?',
-         *   context: 'User is learning geography'
-         * });
-         * ```
-         */
-        this.ai = {
-            chat: async (request) => {
-                return this.sendRequest(APIOperation.AI_CHAT, request);
-            }
-        };
-        // ============================================================================
-        // App Data Service
-        // ============================================================================
-        /**
-         * App Data operations - CRUD for app-specific data storage
-         */
-        this.appData = {
-            /**
-             * Get all app data for the current company (paginated)
-             *
-             * Returns a paginated response with data and metadata.
-             * Default limit is 25 items. For apps with large datasets (500-5000+ rows),
-             * use pagination to avoid performance issues.
-             *
-             * @example
-             * ```javascript
-             * // Get first page (default: 25 items)
-             * const response = await sidekickAPI.appData.getAll();
-             *
-             * // Access the array of items
-             * const items = response.data;
-             * items.forEach(item => {
-             * });
-             * ```
-             */
-            getAll: async () => {
-                return this.sendRequest(APIOperation.APP_DATA_GET_ALL, {});
-            },
-            /**
-             * Create new app data
-             *
-             * Note: App ID is automatically injected by the APIBridge.
-             *
-             * @example
-             * ```javascript
-             * const newData = await sidekickAPI.appData.create({
-             *   dataKey: 'user-preferences',
-             *   data: { theme: 'dark', language: 'en' }
-             * });
-             * ```
-             */
-            create: async (request) => {
-                return this.sendRequest(APIOperation.APP_DATA_CREATE, request);
-            },
-            /**
-             * Get specific app data by ID
-             *
-             * @example
-             * ```javascript
-             * const data = await sidekickAPI.appData.get('data-id-123');
-             * ```
-             */
-            get: async (appDataId) => {
-                return this.sendRequest(APIOperation.APP_DATA_GET, { appDataId });
-            },
-            /**
-             * Update existing app data
-             *
-             * @example
-             * ```javascript
-             * const updated = await sidekickAPI.appData.update('data-id-123', {
-             *   data: { theme: 'light' }
-             * });
-             * ```
-             */
-            update: async (appDataId, request) => {
-                return this.sendRequest(APIOperation.APP_DATA_UPDATE, {
-                    appDataId,
-                    ...request
-                });
-            },
-            /**
-             * Delete app data
-             *
-             * @example
-             * ```javascript
-             * await sidekickAPI.appData.delete('data-id-123');
-             * ```
-             */
-            delete: async (appDataId) => {
-                return this.sendRequest(APIOperation.APP_DATA_DELETE, { appDataId });
-            }
-        };
-        /**
-         * Utility functions for common operations
-         *
-         * Note: These utilities are loaded from the sidebar-loader at runtime.
-         * They are available through the window object and don't need to be bundled with apps.
-         */
-        this.utils = {
-            /**
-             * Convert HTML to Markdown
-             *
-             * @example
-             * ```javascript
-             * const markdown = sidekickAPI.utils.htmlToMarkdown('<h1>Hello</h1>');
-             * console.log(markdown); // # Hello
-             * ```
-             */
-            htmlToMarkdown: (html) => {
-                // Access the utility from window object (loaded by sidebar-loader)
-                if (typeof window !== 'undefined' && window.__sidekickUtils?.htmlToMarkdown) {
-                    return window.__sidekickUtils.htmlToMarkdown(html);
-                }
-                throw new Error('htmlToMarkdown utility not available. Ensure sidebar-loader is loaded.');
-            },
-            /**
-             * Convert Markdown to HTML (sanitized)
-             *
-             * @example
-             * ```javascript
-             * const html = sidekickAPI.utils.markdownToHtml('# Hello');
-             * console.log(html); // <h1>Hello</h1>
-             * ```
-             */
-            markdownToHtml: (markdown) => {
-                // Access the utility from window object (loaded by sidebar-loader)
-                if (typeof window !== 'undefined' && window.__sidekickUtils?.markdownToHtml) {
-                    return window.__sidekickUtils.markdownToHtml(markdown);
-                }
-                throw new Error('markdownToHtml utility not available. Ensure sidebar-loader is loaded.');
-            }
-        };
-        this.initialize();
-    }
-    /**
-     * Set the app ID for this client
-     * Called automatically by SidekickBaseApp
-     */
-    setAppId(appId) {
-        this.appId = appId;
-    }
-    /**
-     * Initialize the API client and start listening for responses
-     */
-    initialize() {
-        this.messageListener = (event) => {
-            this.handleResponse(event);
-        };
-        window.addEventListener('message', this.messageListener);
-    }
-    /**
-     * Cleanup
-     */
-    destroy() {
-        if (this.messageListener) {
-            window.removeEventListener('message', this.messageListener);
-            this.messageListener = null;
-        }
-        this.pendingRequests.clear();
-    }
-    /**
-     * Handle response from sidebar
-     */
-    handleResponse(event) {
-        const data = event.data;
-        if (data?.type !== 'SIDEKICK_API_RESPONSE') {
-            return;
-        }
-        const response = data;
-        const pending = this.pendingRequests.get(response.id);
-        if (!pending) {
-            return;
-        }
-        this.pendingRequests.delete(response.id);
-        if (response.success) {
-            pending.resolve(response.data);
-        }
-        else {
-            pending.reject(new Error(response.error || 'Unknown error'));
-        }
-    }
-    /**
-     * Send request to sidebar
-     */
-    sendRequest(operation, payload) {
-        return new Promise((resolve, reject) => {
-            const id = `api-request-${++this.requestCounter}`;
-            const request = {
-                type: 'SIDEKICK_API_REQUEST',
-                id,
-                operation,
-                payload,
-                appId: this.appId || undefined, // Include app ID if set
-            };
-            // Store pending request
-            this.pendingRequests.set(id, { resolve, reject });
-            // Set timeout
-            const timeoutId = setTimeout(() => {
-                this.pendingRequests.delete(id);
-                reject(new Error(`Request timeout: ${operation}`));
-            }, this.timeout);
-            // Clear timeout on resolve/reject
-            const originalResolve = resolve;
-            const originalReject = reject;
-            this.pendingRequests.set(id, {
-                resolve: (value) => {
-                    clearTimeout(timeoutId);
-                    originalResolve(value);
-                },
-                reject: (error) => {
-                    clearTimeout(timeoutId);
-                    originalReject(error);
-                },
-            });
-            // Send to current window (sidebar APIBridge will intercept)
-            // Apps run in the sidebar's window, not in a separate iframe
-            window.postMessage(request, '*');
-            APIOperation;
-        });
-    }
-}
-// Create singleton instance
-const sidekickAPI = new SidekickAPIClient();
-// Export for global usage
-if (typeof window !== 'undefined') {
-    window.sidekickAPI = sidekickAPI;
-}
-export default sidekickAPI;

package/dist/SidekickBaseApp.d.ts

@@ -1,177 +0,0 @@
-/**
- * Sidekick Base App
- *
- * Base class for all Sidekick apps. Provides common functionality and lifecycle methods.
- * Third-party developers should extend this class instead of HTMLElement directly.
- *
- * @example
- * ```typescript
- * // Define your settings and state types
- * interface MyAppSettings {
- *   apiKey: string;
- *   endpoint: string;
- *   autoSave?: boolean;
- * }
- *
- * interface MyAppState {
- *   count: number;
- *   isLoading: boolean;
- *   data: any[];
- * }
- *
- * class MyApp extends SidekickBaseApp<MyAppSettings, MyAppState> {
- *   constructor() {
- *     super({
- *       id: 'my-app',
- *       name: 'My App',
- *       version: '1.0.0',
- *       category: 'utility',
- *       description: 'My custom app',
- *       author: 'Your Name',
- *       tags: ['custom']
- *     });
- *
- *     // Settings are now type-safe!
- *     const apiKey = this.appSettings?.apiKey; // ✅ TypeScript knows this exists
- *
- *     // Initialize state with proper typing
- *     this.state = {
- *       count: 0,
- *       isLoading: false,
- *       data: []
- *     };
- *   }
- *
- *   render() {
- *     return `<div>My App Content</div>`;
- *   }
- *
- *   setupEventListeners() {
- *     // setState is also type-safe
- *     this.setState({ count: this.state.count + 1 }); // ✅ Type-safe
- *   }
- * }
- *
- * customElements.define('my-app', MyApp);
- * ```
- */
-/**
- * App metadata configuration
- */
-export interface SidekickAppInfo {
-    /** Unique identifier for the app (kebab-case recommended) */
-    id: string;
-    /** Display name of the app */
-    name: string;
-    /** Semantic version (x.y.z) */
-    version: string;
-    /** Primary category for the app */
-    category: string;
-    /** Detailed description of the app */
-    description: string;
-    /** Author or organization name */
-    author: string;
-    /** Additional tags for search and categorization */
-    tags?: string[];
-}
-/**
- * Base class for Sidekick apps
- * @template TSettings - Type for app settings, defaults to an empty object
- * @template TState - Type for app state, defaults to an empty object
- */
-export declare abstract class SidekickBaseApp<TSettings = Record<string, any>, TState = Record<string, any>> extends HTMLElement {
-    /** App metadata */
-    protected appInfo: SidekickAppInfo;
-    /** App settings (override in subclass) **/
-    protected appSettings?: TSettings;
-    /** App-specific state (override in subclass) */
-    protected state: TState;
-    /** Shadow root for style isolation */
-    private _shadowRoot;
-    /** App-specific API client instance (prevents app ID conflicts) */
-    protected sidekickAPI: any;
-    /**
-     * Creates a new Sidekick app
-     * @param appInfo - App metadata configuration
-     */
-    constructor(appInfo: SidekickAppInfo);
-    /**
-     * Get shadow root (override native property)
-     */
-    get shadowRoot(): ShadowRoot;
-    /**
-     * Background service - optional override in subclass
-     * Called immediately after app instantiation, before DOM attachment
-     * Use this for background tasks like URL monitoring, event listening, etc.
-     */
-    protected onBackgroundService?(): void;
-    /**
-     * URL change handler - optional override in subclass
-     * Called when the page URL changes (SPA navigation)
-     * @param url - The new URL
-     */
-    protected onUrlChange?(url: string): void;
-    /**
-     * Render method - must be implemented by subclass
-     * Should return HTML string or directly manipulate shadowRoot
-     */
-    protected render(): void;
-    /**
-     * Setup event listeners - optional override in subclass
-     */
-    protected setupEventListeners(): void;
-    /**
-     * Initialize background service
-     * Called by BackgroundAppManager after instantiation
-     */
-    initializeBackgroundService(): void;
-    /**
-     * Handle URL change
-     * Called by BackgroundAppManager when URL changes
-     */
-    handleUrlChange(url: string): void;
-    /**
-     * Lifecycle: Called when element is added to DOM
-     * This happens when user opens the app in the drawer
-     */
-    connectedCallback(): void;
-    /**
-     * Lifecycle: Called when element is removed from DOM
-     */
-    disconnectedCallback(): void;
-    /**
-     * Cleanup method - optional override in subclass
-     * Called when app is disconnected from DOM
-     */
-    protected cleanup(): void;
-    /**
-     * Get app configuration (for Sidekick Platform)
-     */
-    getAppInfo(): SidekickAppInfo;
-    /**
-     * Get current app state (for Sidekick Platform)
-     */
-    getAppState(): Record<string, any>;
-    /**
-     * Set app configuration (for Sidekick Platform)
-     * Override this method to handle configuration updates
-     */
-    setAppConfig(_config: Record<string, any>): void;
-    /**
-     * Helper: Update app state
-     */
-    protected setState(updates: Partial<TState>): void;
-    /**
-     * Helper: Render HTML into shadow root
-     */
-    protected renderHTML(html: string): void;
-    /**
-     * Helper: Query element in shadow root
-     */
-    protected query<T extends Element = Element>(selector: string): T | null;
-    /**
-     * Helper: Query all elements in shadow root
-     */
-    protected queryAll<T extends Element = Element>(selector: string): NodeListOf<T>;
-}
-//# sourceMappingURL=SidekickBaseApp.d.ts.map

package/dist/SidekickBaseApp.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SidekickBaseApp.d.ts","sourceRoot":"","sources":["../src/SidekickBaseApp.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AAEH;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,6DAA6D;IAC7D,EAAE,EAAE,MAAM,CAAC;IACX,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;;;GAIG;AACH,8BAAsB,eAAe,CACnC,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC/B,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAC5B,SAAQ,WAAW;IACnB,mBAAmB;IACnB,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC;IAEnC,2CAA2C;IAC3C,SAAS,CAAC,WAAW,CAAC,EAAE,SAAS,CAAC;IAElC,gDAAgD;IAChD,SAAS,CAAC,KAAK,EAAE,MAAM,CAAgB;IAEvC,sCAAsC;IACtC,OAAO,CAAC,WAAW,CAAa;IAEhC,mEAAmE;IACnE,SAAS,CAAC,WAAW,EAAE,GAAG,CAAC;IAE3B;;;OAGG;gBACS,OAAO,EAAE,eAAe;IAyCpC;;OAEG;IACH,IAAI,UAAU,IAAI,UAAU,CAE3B;IAED;;;;OAIG;IACH,SAAS,CAAC,mBAAmB,CAAC,IAAI,IAAI;IAEtC;;;;OAIG;IACH,SAAS,CAAC,WAAW,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAEzC;;;OAGG;IACH,SAAS,CAAC,MAAM,IAAI,IAAI;IAIxB;;OAEG;IACH,SAAS,CAAC,mBAAmB,IAAI,IAAI;IAIrC;;;OAGG;IACI,2BAA2B,IAAI,IAAI;IAO1C;;;OAGG;IACI,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAMzC;;;OAGG;IACH,iBAAiB,IAAI,IAAI;IAoBzB;;OAEG;IACH,oBAAoB,IAAI,IAAI;IAI5B;;;OAGG;IACH,SAAS,CAAC,OAAO,IAAI,IAAI;IAIzB;;OAEG;IACI,UAAU,IAAI,eAAe;IAIpC;;OAEG;IACI,WAAW,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAOzC;;;OAGG;IACI,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI;IAIvD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,GAAG,IAAI;IAIlD;;OAEG;IACH,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQxC;;OAEG;IACH,SAAS,CAAC,KAAK,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC,GAAG,IAAI;IAIxE;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,QAAQ,EAAE,MAAM,GAAG,UAAU,CAAC,CAAC,CAAC;CAGjF"}

package/dist/SidekickBaseApp.js

@@ -1,228 +0,0 @@
-/**
- * Sidekick Base App
- *
- * Base class for all Sidekick apps. Provides common functionality and lifecycle methods.
- * Third-party developers should extend this class instead of HTMLElement directly.
- *
- * @example
- * ```typescript
- * // Define your settings and state types
- * interface MyAppSettings {
- *   apiKey: string;
- *   endpoint: string;
- *   autoSave?: boolean;
- * }
- *
- * interface MyAppState {
- *   count: number;
- *   isLoading: boolean;
- *   data: any[];
- * }
- *
- * class MyApp extends SidekickBaseApp<MyAppSettings, MyAppState> {
- *   constructor() {
- *     super({
- *       id: 'my-app',
- *       name: 'My App',
- *       version: '1.0.0',
- *       category: 'utility',
- *       description: 'My custom app',
- *       author: 'Your Name',
- *       tags: ['custom']
- *     });
- *
- *     // Settings are now type-safe!
- *     const apiKey = this.appSettings?.apiKey; // ✅ TypeScript knows this exists
- *
- *     // Initialize state with proper typing
- *     this.state = {
- *       count: 0,
- *       isLoading: false,
- *       data: []
- *     };
- *   }
- *
- *   render() {
- *     return `<div>My App Content</div>`;
- *   }
- *
- *   setupEventListeners() {
- *     // setState is also type-safe
- *     this.setState({ count: this.state.count + 1 }); // ✅ Type-safe
- *   }
- * }
- *
- * customElements.define('my-app', MyApp);
- * ```
- */
-/**
- * Base class for Sidekick apps
- * @template TSettings - Type for app settings, defaults to an empty object
- * @template TState - Type for app state, defaults to an empty object
- */
-export class SidekickBaseApp extends HTMLElement {
-    /**
-     * Creates a new Sidekick app
-     * @param appInfo - App metadata configuration
-     */
-    constructor(appInfo) {
-        super();
-        /** App-specific state (override in subclass) */
-        this.state = {};
-        // Validate required fields
-        if (!appInfo.id || !appInfo.name || !appInfo.version) {
-            throw new Error('SidekickBaseApp: id, name, and version are required');
-        }
-        this.appInfo = appInfo;
-        // Create shadow DOM for style isolation and store reference
-        this._shadowRoot = this.attachShadow({ mode: 'open' });
-        // Read UUID and settings from global registry (set by BackgroundAppManager before element creation)
-        // This allows the constructor to access both UUID and settings immediately
-        const registry = window.__sidekickAppRegistry;
-        const tagName = this.tagName.toLowerCase();
-        const registryData = registry?.[tagName];
-        // Set app settings if available in registry
-        if (registryData?.settings) {
-            this.appSettings = registryData.settings;
-        }
-        // Set app UUID on the global API client so it's included in all requests
-        // This allows background services to make API calls without the app being open
-        if (window.sidekickAPI) {
-            const appUuid = registryData?.uuid;
-            if (appUuid) {
-                // Create a new API client instance for THIS app
-                this.sidekickAPI = new window.SidekickAPIClient();
-                this.sidekickAPI.setAppId(appUuid);
-            }
-            else {
-                console.warn('⚠️ App UUID not found in registry - API calls may fail. App:', appInfo.id);
-                // Fallback to global API client (will have wrong app ID, but better than nothing)
-                this.sidekickAPI = window.sidekickAPI;
-            }
-        }
-    }
-    /**
-     * Get shadow root (override native property)
-     */
-    get shadowRoot() {
-        return this._shadowRoot;
-    }
-    /**
-     * Render method - must be implemented by subclass
-     * Should return HTML string or directly manipulate shadowRoot
-     */
-    render() {
-        // Default implementation - subclasses should override
-    }
-    /**
-     * Setup event listeners - optional override in subclass
-     */
-    setupEventListeners() {
-        // Default implementation - subclasses can override
-    }
-    /**
-     * Initialize background service
-     * Called by BackgroundAppManager after instantiation
-     */
-    initializeBackgroundService() {
-        if (this.onBackgroundService) {
-            this.onBackgroundService();
-        }
-    }
-    /**
-     * Handle URL change
-     * Called by BackgroundAppManager when URL changes
-     */
-    handleUrlChange(url) {
-        if (this.onUrlChange) {
-            this.onUrlChange(url);
-        }
-    }
-    /**
-     * Lifecycle: Called when element is added to DOM
-     * This happens when user opens the app in the drawer
-     */
-    connectedCallback() {
-        // Render the app UI
-        this.render();
-        // Setup event listeners for UI
-        this.setupEventListeners();
-        // Notify Sidekick Platform that app UI is ready
-        this.dispatchEvent(new CustomEvent('sidekick-app-ready', {
-            detail: {
-                appInfo: this.appInfo,
-                timestamp: new Date().toISOString()
-            },
-            bubbles: true,
-            composed: true
-        }));
-    }
-    /**
-     * Lifecycle: Called when element is removed from DOM
-     */
-    disconnectedCallback() {
-        this.cleanup();
-    }
-    /**
-     * Cleanup method - optional override in subclass
-     * Called when app is disconnected from DOM
-     */
-    cleanup() {
-        // Default implementation - subclasses can override
-    }
-    /**
-     * Get app configuration (for Sidekick Platform)
-     */
-    getAppInfo() {
-        return this.appInfo;
-    }
-    /**
-     * Get current app state (for Sidekick Platform)
-     */
-    getAppState() {
-        return {
-            ...this.state,
-            lastUpdated: new Date().toISOString()
-        };
-    }
-    /**
-     * Set app configuration (for Sidekick Platform)
-     * Override this method to handle configuration updates
-     */
-    setAppConfig(_config) {
-        // Default implementation - subclasses can override
-    }
-    /**
-     * Helper: Update app state
-     */
-    setState(updates) {
-        this.state = { ...this.state, ...updates };
-    }
-    /**
-     * Helper: Render HTML into shadow root
-     */
-    renderHTML(html) {
-        if (this._shadowRoot) {
-            this._shadowRoot.innerHTML = html;
-        }
-        else {
-            console.error('❌ No shadow root available!');
-        }
-    }
-    /**
-     * Helper: Query element in shadow root
-     */
-    query(selector) {
-        return this._shadowRoot?.querySelector(selector) || null;
-    }
-    /**
-     * Helper: Query all elements in shadow root
-     */
-    queryAll(selector) {
-        return this._shadowRoot?.querySelectorAll(selector) || [];
-    }
-}
-// Export for global usage
-if (typeof window !== 'undefined') {
-    window.SidekickBaseApp = SidekickBaseApp;
-}