@weave-apps/sdk 0.10.0 → 0.12.0

package/dist/app-sdk/src/WeaveAPIClient.d.ts

@@ -0,0 +1,373 @@
+/**
+ * Weave API Client
+ *
+ * Client-side API for iframe apps to interact with the Weave backend
+ * through a secure proxy in the sidebar.
+ *
+ * Apps can call AI services and manage their own app data.
+ */
+/**
+ * AI Chat Request
+ */
+export interface AIChatRequest {
+    /** User's input prompt */
+    prompt: string;
+    /** Optional context for the AI */
+    context?: string;
+    /** Optional flag to disable JSON extraction */
+    disableJsonExtraction?: boolean;
+    /** Controls how creative or deterministic the AI response should be */
+    creativityLevel?: 'precise' | 'low' | 'balanced' | 'high' | 'creative';
+}
+/**
+ * AI Chat Response
+ */
+export interface AIChatResponse {
+    /** AI chat response content */
+    response: string;
+}
+/**
+ * App Data structure
+ */
+export interface AppData {
+    _id: string;
+    /** Reference to the app component this data belongs to */
+    appId: string;
+    /** Company that owns this app data */
+    companyId: string;
+    /** User that owns this specific app data instance */
+    userId: string;
+    /** Key for organizing data within an app namespace */
+    dataKey: string;
+    /** Unstructured data - apps determine the content structure */
+    data: Record<string, any>;
+    createdAt: Date;
+    updatedAt: Date;
+    createdBy: string;
+}
+/**
+ * Create App Data Request
+ */
+export interface CreateAppDataRequest {
+    /** Key for organizing data within an app namespace */
+    dataKey: string;
+    /** Unstructured data - apps determine the content structure */
+    data: Record<string, any>;
+}
+/**
+ * Update App Data Request
+ */
+export interface UpdateAppDataRequest {
+    /** Key for organizing data within an app namespace */
+    dataKey: string;
+    /** Unstructured data - apps determine the content structure */
+    data: Record<string, any>;
+}
+/**
+ * Pagination metadata
+ */
+export interface PaginationMeta {
+    /** Current offset */
+    offset: number;
+    /** Number of items per page */
+    limit: number;
+    /** Total number of items available */
+    totalResultCount: number;
+}
+/**
+ * Paginated response wrapper
+ */
+export interface PaginatedResponse<T> {
+    /** Array of data items */
+    data: 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';
+}
+export interface FormSubmissionFieldOption {
+    label: string;
+    value: string;
+}
+export interface FormSubmissionCondition {
+    fieldId: string;
+    operator: string;
+    value?: string;
+}
+export interface FormSubmissionResponseEntry {
+    label: string;
+    type: string;
+    value: string | boolean | null;
+    options?: FormSubmissionFieldOption[];
+    stockFieldCode?: string;
+}
+export interface FormSubmissionDefinitionSection {
+    sectionId: string;
+    title?: string;
+    description?: string;
+    order: number;
+    condition?: FormSubmissionCondition;
+}
+export interface FormSubmissionDefinitionField {
+    fieldId: string;
+    label: string;
+    type: string;
+    required: boolean;
+    placeholder?: string;
+    helpText?: string;
+    options?: FormSubmissionFieldOption[];
+    sectionId?: string;
+    sectionTitle?: string;
+    sectionDescription?: string;
+    condition?: FormSubmissionCondition;
+}
+export interface FormSubmissionDefinitionPayload {
+    formId: string;
+    description: string;
+    sections: FormSubmissionDefinitionSection[];
+    fields: FormSubmissionDefinitionField[];
+}
+export interface FormSubmissionDataPayload {
+    formName: string;
+    formDescription: string;
+    formCategory: string;
+    submittedAt: string;
+    responses: Record<string, FormSubmissionResponseEntry>;
+    formDefinition: FormSubmissionDefinitionPayload;
+}
+/**
+ * Weave API Client
+ * Provides methods for iframe apps to interact with Weave backend
+ */
+export declare class WeaveAPIClient {
+    private pendingRequests;
+    private messageListener;
+    private requestCounter;
+    private timeout;
+    private appId;
+    constructor();
+    /**
+     * Set the app ID for this client
+     * Called automatically by WeaveBaseApp
+     */
+    setAppId(appId: string): void;
+    /**
+     * Initialize the API client and start listening for responses
+     */
+    private initialize;
+    /**
+     * Cleanup
+     */
+    destroy(): void;
+    /**
+     * Handle response from sidebar
+     */
+    private handleResponse;
+    /**
+     * Send request to sidebar
+     */
+    private sendRequest;
+    /**
+     * 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 weaveAPI.ai.chat({
+     *   prompt: 'What is the capital of France?',
+     *   context: 'User is learning geography'
+     * });
+     * ```
+     */
+    ai: {
+        chat: (request: AIChatRequest) => Promise<AIChatResponse>;
+    };
+    /**
+     * App Data operations - CRUD for app-specific data storage
+     */
+    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 weaveAPI.appData.getAll();
+         *
+         * // Access the array of items
+         * const items = response.data;
+         * items.forEach(item => {
+         * });
+         * ```
+         */
+        getAll: () => Promise<PaginatedResponse<AppData>>;
+        /**
+         * Create new app data
+         *
+         * Note: App ID is automatically injected by the APIBridge.
+         *
+         * @example
+         * ```javascript
+         * const newData = await weaveAPI.appData.create({
+         *   dataKey: 'user-preferences',
+         *   data: { theme: 'dark', language: 'en' }
+         * });
+         * ```
+         */
+        create: (request: CreateAppDataRequest) => Promise<AppData>;
+        /**
+         * Get specific app data by ID
+         *
+         * @example
+         * ```javascript
+         * const data = await weaveAPI.appData.get('data-id-123');
+         * ```
+         */
+        get: (appDataId: string) => Promise<AppData>;
+        /**
+         * Update existing app data
+         *
+         * @example
+         * ```javascript
+         * const updated = await weaveAPI.appData.update('data-id-123', {
+         *   data: { theme: 'light' }
+         * });
+         * ```
+         */
+        update: (appDataId: string, request: UpdateAppDataRequest) => Promise<AppData>;
+        /**
+         * Delete app data
+         *
+         * @example
+         * ```javascript
+         * await weaveAPI.appData.delete('data-id-123');
+         * ```
+         */
+        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
+     *
+     * Methods for fetching company forms and submitting form data.
+     */
+    forms: {
+        /**
+         * Get all forms for the company
+         *
+         * @example
+         * ```javascript
+         * const response = await weaveAPI.forms.getAll();
+         * console.log(response.data); // Array of forms
+         * ```
+         */
+        getAll: () => Promise<PaginatedResponse<any>>;
+        /**
+         * Get a specific form by ID
+         *
+         * @example
+         * ```javascript
+         * const form = await weaveAPI.forms.get('form-id-123');
+         * console.log(form.name, form.fields);
+         * ```
+         */
+        get: (formId: string) => Promise<any>;
+        /**
+         * Get all submissions (app data) for a specific form
+         *
+         * @example
+         * ```javascript
+         * const response = await weaveAPI.forms.getFormData('form-id-123');
+         * console.log(response.data); // Array of form submissions
+         * ```
+         */
+        getFormData: (formId: string, scopeOptions?: FormDataScopeOptions) => Promise<PaginatedResponse<AppData>>;
+        /**
+         * Submit form data
+         * Creates app data with targetType: 'form' and targetId: formId
+         *
+         * @example
+         * ```javascript
+         * await weaveAPI.forms.submitFormData('form-id-123', {
+         *   dataKey: 'form_submission',
+         *   data: {
+         *     formName: 'User Signup',
+         *     responses: { field1: 'value1', field2: 'value2' }
+         *   }
+         * });
+         * ```
+         */
+        submitFormData: (formId: string, payload: CreateAppDataRequest) => Promise<AppData>;
+    };
+    /**
+     * 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.
+     */
+    utils: {
+        /**
+         * Convert HTML to Markdown
+         *
+         * @example
+         * ```javascript
+         * const markdown = weaveAPI.utils.htmlToMarkdown('<h1>Hello</h1>');
+         * console.log(markdown); // # Hello
+         * ```
+         */
+        htmlToMarkdown: (html: string) => string;
+        /**
+         * Convert Markdown to HTML (sanitized)
+         *
+         * @example
+         * ```javascript
+         * const html = weaveAPI.utils.markdownToHtml('# Hello');
+         * console.log(html); // <h1>Hello</h1>
+         * ```
+         */
+        markdownToHtml: (markdown: string) => string;
+    };
+}
+declare const weaveAPI: WeaveAPIClient;
+export default weaveAPI;
+//# sourceMappingURL=WeaveAPIClient.d.ts.map

package/dist/app-sdk/src/WeaveAPIClient.d.ts.map

@@ -0,0 +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;IAChC,uEAAuE;IACvE,eAAe,CAAC,EAAE,SAAS,GAAG,KAAK,GAAG,UAAU,GAAG,MAAM,GAAG,UAAU,CAAC;CACxE;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;AAED,MAAM,WAAW,yBAAyB;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,2BAA2B;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IAC/B,OAAO,CAAC,EAAE,yBAAyB,EAAE,CAAC;IACtC,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,uBAAuB,CAAC;CACrC;AAED,MAAM,WAAW,6BAA6B;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,yBAAyB,EAAE,CAAC;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,EAAE,uBAAuB,CAAC;CACrC;AAED,MAAM,WAAW,+BAA+B;IAC9C,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,+BAA+B,EAAE,CAAC;IAC5C,MAAM,EAAE,6BAA6B,EAAE,CAAC;CACzC;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,EAAE,MAAM,CAAC;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;IACvD,cAAc,EAAE,+BAA+B,CAAC;CACjD;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"}