Functions

parseMentions

Extract

Signature:

parseMentions(content: string): ParsedMention[]

Parameters:

Returns:

ParsedMention[] - Array of parsed mentions with identifier and position

Examples:

parseMentions('Hey

## resolveMentions

Resolve parsed mentions to full DiscussionMention objects

**Signature:**

```typescript
resolveMentions(parsed: ParsedMention[], agentLookup: Map<string, AgentLookupEntry>): DiscussionMention[]

Parameters:

Returns:

DiscussionMention[] - Array of resolved DiscussionMention objects

Examples:

const lookup = new Map([
  ['viktor-petrov', { teamMemberId: 'team_abc', isAgent: true }]
]);
const resolved = resolveMentions(parsed, lookup);

nodeJsExample

Example 1: Node.js Script (Imperative API) Use when you need immediate results in scripts, CLI tools, or backend services

Signature:

nodeJsExample(db: RxDatabase): Promise<void>

Parameters:

Returns:

Promise<void> -

reactiveExample

Example 2: Reactive API (Vanilla JavaScript) Use in browsers without frameworks for real-time updates

Signature:

reactiveExample(db: RxDatabase): void

Parameters:

filteredQueriesExample

Example 3: Filtered Queries with Indexes Use optimized queries with composite indexes

Signature:

filteredQueriesExample(db: RxDatabase): Promise<void>

Parameters:

Returns:

Promise<void> -

paginationExample

Example 4: Pagination Implement pagination with limit and skip

Signature:

paginationExample(db: RxDatabase): Promise<void>

Parameters:

Returns:

Promise<void> -

errorHandlingExample

Example 5: Error Handling Handle errors gracefully

Signature:

errorHandlingExample(db: RxDatabase): Promise<void>

Parameters:

Returns:

Promise<void> -

batchOperationsExample

Example 6: Batch Operations Perform multiple operations efficiently

Signature:

batchOperationsExample(db: RxDatabase): Promise<void>

Parameters:

Returns:

Promise<void> -

realTimeUpdatesExample

Example 7: Real-time Updates (Reactive) Monitor task changes in real-time

Signature:

realTimeUpdatesExample(db: RxDatabase): void

Parameters:

lifecycleExample

Example 8: Lifecycle Management Properly manage operator lifecycles

Signature:

lifecycleExample(db: RxDatabase): void

Parameters:

buildBaseFilters

Filter Builder Utilities

Provides helper functions for constructing RxDB MangoQuery selectors from typed filter objects. These utilities ensure consistent filter patterns across all collection queries.

Signature:

buildBaseFilters(filters: BaseFilters): MangoSelector

Parameters:

Returns:

MangoSelector -

buildHierarchyFilters

Build hierarchy filter selector (workspaceId, projectId, milestoneId)

Hierarchy filters enable navigation through the organizational structure. Only the most specific filter should be applied to leverage composite indexes.

Index strategy:

• If milestoneId provided -> use [milestoneId, createdAt] index
• Else if projectId provided -> use [projectId, createdAt] index
• Else if workspaceId provided -> use [workspaceId, createdAt] index
• Else -> fallback to [orgId, createdAt] index (via base filters)

Signature:

buildHierarchyFilters(filters: HierarchyFilters): MangoSelector

Parameters:

Returns:

MangoSelector - Partial MangoQuery selector for hierarchy filters

Examples:

// Query tasks within a specific milestone (most specific)
const selector = buildHierarchyFilters({ milestoneId: 'milestone_789' });
// Result: { milestoneId: { $eq: 'milestone_789' } }

// Query tasks within a project (less specific)
const selector = buildHierarchyFilters({ projectId: 'project_456' });
// Result: { projectId: { $eq: 'project_456' } }

buildStatusFilters

Build status filter selector (status, completed, archived)

Status filters enable workflow-based queries across different entity states. Supports both single status and multiple status queries.

Signature:

buildStatusFilters(filters: StatusFilters): MangoSelector

Parameters:

Returns:

MangoSelector - Partial MangoQuery selector for status filters

Examples:

// Single status query
const selector = buildStatusFilters({ status: 'In Progress' });
// Result: { status: { $eq: 'In Progress' } }

// Multiple status query (OR condition)
const selector = buildStatusFilters({ status: ['To Do', 'In Progress'] });
// Result: { status: { $in: ['To Do', 'In Progress'] } }

// Completion query
const selector = buildStatusFilters({ completed: true });
// Result: { completed: { $eq: true } }

buildTimeFilters

Build time-based filter selector (createdAt, updatedAt, dueAt ranges)

Time filters enable date range queries for filtering by creation date, update date, or due date. Uses $gte and $lte operators for efficient index-based range queries.

Signature:

buildTimeFilters(filters: TimeFilters): MangoSelector

Parameters:

Returns:

MangoSelector - Partial MangoQuery selector for time filters

Examples:

// Created in date range
const selector = buildTimeFilters({
  createdAfter: '2025-01-01T00:00:00.000Z',
  createdBefore: '2025-12-31T23:59:59.999Z'
});
// Result: {
//   createdAt: {
//     $gte: '2025-01-01T00:00:00.000Z',
//     $lte: '2025-12-31T23:59:59.999Z'
//   }
// }

// Due in next 7 days
const now = new Date().toISOString();
const sevenDaysLater = new Date(Date.now() + 7 * 24 * 60 * 60 * 1000).toISOString();
const selector = buildTimeFilters({
  dueAfter: now,
  dueBefore: sevenDaysLater
});

buildCustomFilters

Build custom field filter selector

Enables filtering on arbitrary document fields with equality checks. Useful for collection-specific fields not covered by standard filters.

Note: Custom filters may not leverage indexes. Use base, hierarchy, status, and time filters whenever possible for optimal performance.

Signature:

buildCustomFilters(customFilters: Record<string, any>): MangoSelector

Parameters:

Returns:

MangoSelector - Partial MangoQuery selector for custom filters

Examples:

// Filter by custom fields
const selector = buildCustomFilters({
  categoryId: 'cat_123',
  type: 'todo',
  priority: 'high'
});
// Result: {
//   categoryId: { $eq: 'cat_123' },
//   type: { $eq: 'todo' },
//   priority: { $eq: 'high' }
// }

mergeSelectors

Merge multiple filter selectors into a single selector

Combines partial selectors from different filter builders into a complete MangoQuery selector. Handles nested field merging properly.

Signature:

mergeSelectors(selectors: (MangoSelector | undefined)[]): MangoSelector

Parameters:

Returns:

MangoSelector - Merged MangoQuery selector

Examples:

const baseSelector = buildBaseFilters({ orgId: 'org_123' });
const hierarchySelector = buildHierarchyFilters({ projectId: 'project_456' });
const statusSelector = buildStatusFilters({ status: 'In Progress' });

const mergedSelector = mergeSelectors([
  baseSelector,
  hierarchySelector,
  statusSelector
]);
// Result: {
//   orgId: { $eq: 'org_123' },
//   archived: { $eq: false },
//   projectId: { $eq: 'project_456' },
//   status: { $eq: 'In Progress' }
// }

validateSelector

Validate selector for common mistakes

Checks for common query construction errors that could lead to poor performance or unexpected results.

Signature:

validateSelector(selector: MangoSelector | undefined): string[]

Parameters:

Returns:

string[] - Array of validation warnings (empty if valid)

Examples:

const selector = {
  // Missing orgId - not multi-tenant safe!
  status: { $eq: 'In Progress' }
};

const warnings = validateSelector(selector);
// Result: ['Missing required orgId filter for multi-tenant isolation']

getHierarchyLevel

Determine the hierarchy level based on provided filters

Analyzes hierarchy filters to determine which level of the hierarchy is being queried. This informs index selection for optimal query performance.

Priority order (most specific to least specific):

1. milestone - Task-level queries
2. project - Project-level queries
3. workspace - Workspace-level queries
4. org - Organization-level queries (fallback)

Signature:

getHierarchyLevel(filters: HierarchyFilters): "project" | "milestone" | "workspace" | "org"

Parameters:

Returns:

"project" \| "milestone" \| "workspace" \| "org" - The hierarchy level being queried

Examples:

// Task-level query (most specific)
getHierarchyLevel({ milestoneId: 'milestone_789' });
// Returns: 'milestone'

// Project-level query
getHierarchyLevel({ projectId: 'project_456' });
// Returns: 'project'

// Organization-level query (fallback)
getHierarchyLevel({});
// Returns: 'org'

selectBestIndex

Select the best composite index for a query

Analyzes the provided filters and collection schema to automatically select the most efficient composite index. Uses the most specific filter available to maximize index effectiveness.

Index selection strategy:

1. Identify the most specific hierarchy filter present
2. Check if collection has a composite index for that field
3. Return the index field and confidence score
4. Fallback to orgId index if no hierarchy filters present

Signature:

selectBestIndex(filters: HierarchyFilters, collectionName: string): IndexSelection

Parameters:

Returns:

IndexSelection - Index selection recommendation

Examples:

// Query tasks by milestone (most efficient)
selectBestIndex({ milestoneId: 'milestone_789' }, 'tasks');
// Returns: {
//   indexField: 'milestoneId',
//   level: 'milestone',
//   confidence: 1.0
// }

// Query tasks by project
selectBestIndex({ projectId: 'project_456' }, 'tasks');
// Returns: {
//   indexField: 'projectId',
//   level: 'project',
//   confidence: 1.0
// }

// Query without hierarchy filters (fallback)
selectBestIndex({}, 'tasks');
// Returns: {
//   indexField: 'orgId',
//   level: 'org',
//   confidence: 0.8
// }

buildHierarchicalQuery

Build a hierarchical query optimized for composite indexes

Constructs a complete MangoQuery that automatically uses the best available composite index based on the hierarchy filters provided. Ensures queries are structured to maximize RxDB's query performance.

Query construction strategy:

1. Select the optimal composite index based on filters
2. Build selector with most specific hierarchy filter first
3. Add secondary filters after indexed fields
4. Configure sort to use the same index (field + createdAt)
5. Add pagination if specified

Signature:

buildHierarchicalQuery(options: { collectionName: string; orgId: string; hierarchy?: HierarchyFilters; additionalSelector?: Partial<MangoQuery<T>["selector"]>; sortDirection?: "asc" | "desc"; customSort?: MangoQuery<T>["sort"]; limit?: number; skip?: number; }): MangoQuery<T>

Parameters:

Returns:

MangoQuery<T> - Complete MangoQuery optimized for performance

Examples:

// Optimized milestone-level task query
const query = buildHierarchicalQuery({
  collectionName: 'tasks',
  orgId: 'org_123',
  hierarchy: { milestoneId: 'milestone_789' },
  limit: 50,
  sortDirection: 'desc'
});
// Uses [milestoneId, createdAt] index
// Result: {
//   selector: {
//     milestoneId: { $eq: 'milestone_789' },
//     orgId: { $eq: 'org_123' },
//     archived: { $eq: false }
//   },
//   sort: [{ createdAt: 'desc' }],
//   limit: 50
// }

optimizeForIndex

Optimize a query for index usage

Analyzes an existing MangoQuery and restructures it to better utilize available composite indexes. This is useful when converting manually-built queries to use optimal index patterns.

Optimization strategy:

1. Extract hierarchy filters from selector
2. Identify best index for these filters
3. Restructure selector to place indexed field first
4. Adjust sort to use same index
5. Return optimized query

Signature:

optimizeForIndex(query: MangoQuery<T>, collectionName: string): MangoQuery<T>

Parameters:

Returns:

MangoQuery<T> - Optimized MangoQuery with better index usage

Examples:

// Sub-optimal query (fields in wrong order)
const originalQuery = {
  selector: {
    status: { $eq: 'In Progress' },
    projectId: { $eq: 'project_456' },
    orgId: { $eq: 'org_123' }
  },
  sort: [{ updatedAt: 'desc' }]
};

const optimized = optimizeForIndex(originalQuery, 'tasks');
// Returns: {
//   selector: {
//     projectId: { $eq: 'project_456' },  // Indexed field first
//     orgId: { $eq: 'org_123' },
//     status: { $eq: 'In Progress' }
//   },
//   sort: [{ createdAt: 'desc' }]  // Sort by index field
// }

analyzeQueryPerformance

Analyze query performance and provide optimization hints

Evaluates a MangoQuery to determine if it's using indexes efficiently and provides actionable suggestions for improvement.

Analysis includes:

• Index usage detection
• Sort field optimization
• Selector field ordering
• Performance impact estimation

Signature:

analyzeQueryPerformance(query: MangoQuery, collectionName: string): QueryOptimizationHint

Parameters:

Returns:

QueryOptimizationHint - Query optimization hints and suggestions

Examples:

const query = {
  selector: {
    orgId: { $eq: 'org_123' },
    status: { $eq: 'In Progress' }
  },
  sort: [{ title: 'asc' }]
};

const hints = analyzeQueryPerformance(query, 'tasks');
// Returns: {
//   isOptimal: false,
//   indexUsed: 'orgId',
//   suggestions: [
//     'Consider adding hierarchy filter (projectId or milestoneId) for better performance',
//     'Sort by createdAt instead of title to use composite index'
//   ],
//   performanceImpact: 'medium'
// }

getAvailableIndexes

Get available indexes for a collection

Returns the list of composite indexes available for a given collection. Useful for debugging and query planning.

Signature:

getAvailableIndexes(collectionName: string): string[][]

Parameters:

Returns:

string[][] - Array of available composite indexes

Examples:

getAvailableIndexes('tasks');
// Returns: [
//   ['orgId', 'createdAt'],
//   ['projectId', 'createdAt'],
//   ['milestoneId', 'createdAt']
// ]

buildQuery

Query Builder Utilities

Provides a high-level API for constructing optimized RxDB queries from typed filter objects. Automatically handles composite index selection, selector construction, and sort optimization.

Key features:

• Automatic composite index selection based on hierarchy filters
• Type-safe filter construction
• Query validation and optimization hints
• Support for sorting, pagination, and custom filters

Signature:

buildQuery(options: QueryBuilderOptions<T> & { collectionName: string; }): MangoQuery<T>

Parameters:

Returns:

MangoQuery<T> -

Examples:

Basic Usage
```ts
// Build a simple task query
const query = buildQuery({
collectionName: 'tasks',
base: { orgId: 'org_123' },
hierarchy: { projectId: 'project_456' },
status: { status: 'In Progress' },
pagination: { limit: 50 }
});

```typescript
Advanced Usage
```ts
// Build a complex query with time filters and custom fields
const query = buildQuery({
collectionName: 'tasks',
base: { orgId: 'org_123', userId: 'user_789' },
hierarchy: { milestoneId: 'milestone_101' },
status: { status: ['To Do', 'In Progress'], completed: false },
time: {
createdAfter: '2025-01-01T00:00:00.000Z',
dueBefore: '2025-12-31T23:59:59.999Z'
},
custom: { type: 'todo', categoryId: 'cat_123' },
sort: { field: 'createdAt', direction: 'desc' },
pagination: { limit: 100, skip: 0 }
});

## buildSimpleQuery

Build a simple query with minimal configuration

Convenience function for common query patterns that don't require
complex filtering. Automatically handles base filters and pagination.

Use this for:
- Simple list queries (all tasks in org)
- Basic hierarchy queries (all tasks in project)
- Quick prototypes and testing

For complex queries with multiple filter types, use buildQuery() instead.

**Signature:**

```typescript
buildSimpleQuery(options: { collectionName: string; orgId: string; userId?: string; workspaceId?: string; projectId?: string; milestoneId?: string; trashed?: boolean; sortField?: string; sortDirection?: "asc" | "desc"; limit?: number; skip?: number; }): MangoQuery<T>

Parameters:

Returns:

MangoQuery<T> - Optimized MangoQuery

Examples:

All Tasks in Organization
```ts
const query = buildSimpleQuery({
collectionName: 'tasks',
orgId: 'org_123',
limit: 50
});

```typescript
Tasks in Project
```ts
const query = buildSimpleQuery({
collectionName: 'tasks',
orgId: 'org_123',
projectId: 'project_456',
limit: 100
});

```typescript
User-Scoped Tasks
```ts
const query = buildSimpleQuery({
collectionName: 'tasks',
orgId: 'org_123',
userId: 'user_789',
sortField: 'updatedAt',
sortDirection: 'desc'
});

## buildCountQuery

Build a count query for aggregation

Constructs a query optimized for counting documents without retrieving
full document data. Useful for pagination, statistics, and dashboards.

Count queries should:
- Use the same selector as the main query
- Omit limit/skip (count all matching docs)
- Not require sort (count doesn't care about order)

**Signature:**

```typescript
buildCountQuery(options: QueryBuilderOptions<T> & { collectionName: string; }): Pick<MangoQuery<T>, "selector">

Parameters:

Returns:

Pick<MangoQuery<T>, "selector"> - MangoQuery optimized for counting

Examples:

Count Tasks in Project
```ts
const countQuery = buildCountQuery({
collectionName: 'tasks',
base: { orgId: 'org_123' },
hierarchy: { projectId: 'project_456' },
status: { completed: false }
});

// Use with RxDB
const count = await collection.count(countQuery.selector).exec();

## buildIdQuery

Build a query for fetching a single document by ID

Convenience function for primary key lookups. More efficient than
using findOne with a selector when you know the document ID.

Note: This returns a selector-only query. Use with collection.findOne()
instead of collection.find() for optimal performance.

**Signature:**

```typescript
buildIdQuery(id: string, orgId: string): Pick<MangoQuery<T>, "selector">

Parameters:

Returns:

Pick<MangoQuery<T>, "selector"> - MangoQuery selector for ID lookup

Examples:

Fetch Task by ID
```ts
const query = buildIdQuery('task_123', 'org_456');

// Use with RxDB
const doc = await collection.findOne(query.selector).exec();

## buildBatchIdQuery

Build a batch query for fetching multiple documents by IDs

Efficiently fetch multiple documents by their primary keys.
More performant than multiple individual queries.

**Signature:**

```typescript
buildBatchIdQuery(ids: string[], orgId: string, limit?: number | undefined): MangoQuery<T>

Parameters:

Returns:

MangoQuery<T> - MangoQuery for batch ID lookup

Examples:

Fetch Multiple Tasks
```ts
const query = buildBatchIdQuery(
['task_123', 'task_456', 'task_789'],
'org_abc'
);

// Use with RxDB
const docs = await collection.find(query).exec();

## buildSearchQuery

Build a search query with text matching

Constructs a query that searches across multiple text fields.
Uses regex matching for flexible text search.

Note: Regex queries may not use indexes efficiently. For large datasets,
consider using a dedicated search solution like ElasticSearch or Algolia.

**Signature:**

```typescript
buildSearchQuery(options: { collectionName: string; orgId: string; searchTerm: string; searchFields: string[]; projectId?: string; milestoneId?: string; caseSensitive?: boolean; limit?: number; }): MangoQuery<T>

Parameters:

Returns:

MangoQuery<T> - MangoQuery with text search

Examples:

Search Tasks by Title and Description
```ts
const query = buildSearchQuery({
collectionName: 'tasks',
orgId: 'org_123',
searchTerm: 'authentication',
searchFields: ['title', 'description'],
projectId: 'project_456',
limit: 20
});

## useApproval

Hook to fetch a single approval by ID
Returns the approval object, loading state, and error

**Signature:**

```typescript
useApproval(db: any, approvalId?: string | undefined): UseApprovalResult

Parameters:

Returns:

UseApprovalResult -

useApprovals

Signature:

useApprovals(db: any, filters: ApprovalFilters, options?: UseApprovalsOptions | undefined): UseApprovalsResult

Parameters:

Returns:

UseApprovalsResult -

useCreateApproval

Signature:

useCreateApproval(db: any): UseMutationResult<ApprovalModel, CreateApprovalInput>

Parameters:

Returns:

UseMutationResult<ApprovalModel, CreateApprovalInput> -

useUpdateApproval

Signature:

useUpdateApproval(db: any): UseMutationResult<ApprovalModel, UpdateApprovalInput>

Parameters:

Returns:

UseMutationResult<ApprovalModel, UpdateApprovalInput> -

useDeleteApproval

Signature:

useDeleteApproval(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useAttribute

Hook to fetch a single attribute by ID Returns the attribute object, loading state, and error

Signature:

useAttribute(db: any, attributeId?: string | undefined): UseAttributeResult

Parameters:

Returns:

UseAttributeResult -

useAttributes

Signature:

useAttributes(db: any, filters: AttributeFilters, options?: UseAttributesOptions | undefined): UseAttributesResult

Parameters:

Returns:

UseAttributesResult -

useCreateAttribute

Signature:

useCreateAttribute(db: any): UseMutationResult<AttributeModel, CreateAttributeInput>

Parameters:

Returns:

UseMutationResult<AttributeModel, CreateAttributeInput> -

useUpdateAttribute

Signature:

useUpdateAttribute(db: any): UseMutationResult<AttributeModel, UpdateAttributeInput>

Parameters:

Returns:

UseMutationResult<AttributeModel, UpdateAttributeInput> -

useDeleteAttribute

Signature:

useDeleteAttribute(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useBusinessPlan

Signature:

useBusinessPlan(db: any, planId?: string | undefined): UseBusinessPlanResult

Parameters:

Returns:

UseBusinessPlanResult -

useBusinessPlans

Signature:

useBusinessPlans(db: any, filters: BusinessPlanFilters, options?: UseBusinessPlansOptions | undefined): UseBusinessPlansResult

Parameters:

Returns:

UseBusinessPlansResult -

useCreateBusinessPlan

Signature:

useCreateBusinessPlan(db: any): UseMutationResult<BusinessPlanModel, CreateBusinessPlanInput>

Parameters:

Returns:

UseMutationResult<BusinessPlanModel, CreateBusinessPlanInput> -

useUpdateBusinessPlan

Signature:

useUpdateBusinessPlan(db: any): UseMutationResult<BusinessPlanModel, UpdateBusinessPlanInput>

Parameters:

Returns:

UseMutationResult<BusinessPlanModel, UpdateBusinessPlanInput> -

useDeleteBusinessPlan

Signature:

useDeleteBusinessPlan(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useClient

Hook to fetch a single client by ID Returns the client object, loading state, and error

Signature:

useClient(db: any, clientId?: string | undefined): UseClientResult

Parameters:

Returns:

UseClientResult -

useClients

Signature:

useClients(db: any, filters: ClientFilters, options?: UseClientsOptions | undefined): UseClientsResult

Parameters:

Returns:

UseClientsResult -

useCreateClient

Signature:

useCreateClient(db: any): UseMutationResult<ClientModel, CreateClientInput>

Parameters:

Returns:

UseMutationResult<ClientModel, CreateClientInput> -

useUpdateClient

Signature:

useUpdateClient(db: any): UseMutationResult<ClientModel, UpdateClientInput>

Parameters:

Returns:

UseMutationResult<ClientModel, UpdateClientInput> -

useDeleteClient

Signature:

useDeleteClient(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useCodebase

Hook to fetch a single codebase by ID Returns the codebase object, loading state, and error

Signature:

useCodebase(db: any, codebaseId?: string | undefined): UseCodebaseResult

Parameters:

Returns:

UseCodebaseResult -

useCodebases

Signature:

useCodebases(db: any, filters: CodebaseFilters, options?: UseCodebasesOptions | undefined): UseCodebasesResult

Parameters:

Returns:

UseCodebasesResult -

useCreateCodebase

Signature:

useCreateCodebase(db: any): UseMutationResult<CodebaseModel, CreateCodebaseInput>

Parameters:

Returns:

UseMutationResult<CodebaseModel, CreateCodebaseInput> -

useUpdateCodebase

Signature:

useUpdateCodebase(db: any): UseMutationResult<CodebaseModel, UpdateCodebaseInput>

Parameters:

Returns:

UseMutationResult<CodebaseModel, UpdateCodebaseInput> -

useDeleteCodebase

Signature:

useDeleteCodebase(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useCompetitor

Signature:

useCompetitor(db: any, competitorId?: string | undefined): UseCompetitorResult

Parameters:

Returns:

UseCompetitorResult -

useCompetitors

Signature:

useCompetitors(db: any, filters: CompetitorFilters, options?: UseCompetitorsOptions | undefined): UseCompetitorsResult

Parameters:

Returns:

UseCompetitorsResult -

useCreateCompetitor

Signature:

useCreateCompetitor(db: any): UseMutationResult<CompetitorModel, CreateCompetitorInput>

Parameters:

Returns:

UseMutationResult<CompetitorModel, CreateCompetitorInput> -

useUpdateCompetitor

Signature:

useUpdateCompetitor(db: any): UseMutationResult<CompetitorModel, UpdateCompetitorInput>

Parameters:

Returns:

UseMutationResult<CompetitorModel, UpdateCompetitorInput> -

useDeleteCompetitor

Signature:

useDeleteCompetitor(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useContact

Hook to fetch a single contact by ID Returns the contact object, loading state, and error

Signature:

useContact(db: any, contactId?: string | undefined): UseContactResult

Parameters:

Returns:

UseContactResult -

useContacts

Signature:

useContacts(db: any, filters: ContactFilters, options?: UseContactsOptions | undefined): UseContactsResult

Parameters:

Returns:

UseContactsResult -

useCreateContact

Signature:

useCreateContact(db: any): UseMutationResult<ContactModel, CreateContactInput>

Parameters:

Returns:

UseMutationResult<ContactModel, CreateContactInput> -

useUpdateContact

Signature:

useUpdateContact(db: any): UseMutationResult<ContactModel, UpdateContactInput>

Parameters:

Returns:

UseMutationResult<ContactModel, UpdateContactInput> -

useDeleteContact

Signature:

useDeleteContact(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useConversation

Hook to fetch a single conversation by ID Returns the conversation object, loading state, and error

Signature:

useConversation(db: any, conversationId?: string | undefined): UseConversationResult

Parameters:

Returns:

UseConversationResult -

useConversations

Signature:

useConversations(db: any, filters: ConversationFilters, options?: UseConversationsOptions | undefined): UseConversationsResult

Parameters:

Returns:

UseConversationsResult -

useCreateConversation

Signature:

useCreateConversation(db: any): UseMutationResult<ConversationModel, CreateConversationInput>

Parameters:

Returns:

UseMutationResult<ConversationModel, CreateConversationInput> -

useUpdateConversation

Signature:

useUpdateConversation(db: any): UseMutationResult<ConversationModel, UpdateConversationInput>

Parameters:

Returns:

UseMutationResult<ConversationModel, UpdateConversationInput> -

useDeleteConversation

Signature:

useDeleteConversation(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useDiscussion

Hook to fetch a single discussion by ID Returns the discussion object, loading state, and error

Signature:

useDiscussion(db: any, discussionId?: string | undefined): UseDiscussionResult

Parameters:

Returns:

UseDiscussionResult -

useDiscussions

Signature:

useDiscussions(db: any, filters: DiscussionFilters, options?: UseDiscussionsOptions | undefined): UseDiscussionsResult

Parameters:

Returns:

UseDiscussionsResult -

useCreateDiscussion

Signature:

useCreateDiscussion(db: any): UseMutationResult<DiscussionModel, CreateDiscussionInput>

Parameters:

Returns:

UseMutationResult<DiscussionModel, CreateDiscussionInput> -

useUpdateDiscussion

Signature:

useUpdateDiscussion(db: any): UseMutationResult<DiscussionModel, UpdateDiscussionInput>

Parameters:

Returns:

UseMutationResult<DiscussionModel, UpdateDiscussionInput> -

useDeleteDiscussion

Signature:

useDeleteDiscussion(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useDocument

Hook to fetch a single document by ID Returns the document object, loading state, and error

Signature:

useDocument(db: any, documentId?: string | undefined): UseDocumentResult

Parameters:

Returns:

UseDocumentResult -

useDocuments

Signature:

useDocuments(db: any, filters: DocumentFilters, options?: UseDocumentsOptions | undefined): UseDocumentsResult

Parameters:

Returns:

UseDocumentsResult -

useCreateDocument

Signature:

useCreateDocument(db: any): UseMutationResult<DocumentModel, CreateDocumentInput>

Parameters:

Returns:

UseMutationResult<DocumentModel, CreateDocumentInput> -

useUpdateDocument

Signature:

useUpdateDocument(db: any): UseMutationResult<DocumentModel, UpdateDocumentInput>

Parameters:

Returns:

UseMutationResult<DocumentModel, UpdateDocumentInput> -

useDeleteDocument

Signature:

useDeleteDocument(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useApproveDocument

Signature:

useApproveDocument(db: any): UseMutationResult<DocumentModel, { id: string; userId: string; }>

Parameters:

Returns:

UseMutationResult<DocumentModel, { id: string; userId: string; }> -

useFinAccount

Hook to fetch a single account by ID Returns the account object, loading state, and error

Signature:

useFinAccount(db: any, accountId?: string | undefined): UseFinAccountResult

Parameters:

Returns:

UseFinAccountResult -

useFinAccounts

Signature:

useFinAccounts(db: any, filters: FinAccountFilters, options?: UseFinAccountsOptions | undefined): UseFinAccountsResult

Parameters:

Returns:

UseFinAccountsResult -

useCreateFinAccount

Signature:

useCreateFinAccount(db: any): UseMutationResult<FinAccountModel, CreateFinAccountInput>

Parameters:

Returns:

UseMutationResult<FinAccountModel, CreateFinAccountInput> -

useUpdateFinAccount

Signature:

useUpdateFinAccount(db: any): UseMutationResult<FinAccountModel, UpdateFinAccountInput>

Parameters:

Returns:

UseMutationResult<FinAccountModel, UpdateFinAccountInput> -

useDeleteFinAccount

Signature:

useDeleteFinAccount(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useFinBudget

Hook to fetch a single budget by ID Returns the budget object, loading state, and error

Signature:

useFinBudget(db: any, budgetId?: string | undefined): UseFinBudgetResult

Parameters:

Returns:

UseFinBudgetResult -

useFinBudgets

Signature:

useFinBudgets(db: any, filters: FinBudgetFilters, options?: UseFinBudgetsOptions | undefined): UseFinBudgetsResult

Parameters:

Returns:

UseFinBudgetsResult -

useCreateFinBudget

Signature:

useCreateFinBudget(db: any): UseMutationResult<BudgetModel, CreateFinBudgetInput>

Parameters:

Returns:

UseMutationResult<BudgetModel, CreateFinBudgetInput> -

useUpdateFinBudget

Signature:

useUpdateFinBudget(db: any): UseMutationResult<BudgetModel, UpdateFinBudgetInput>

Parameters:

Returns:

UseMutationResult<BudgetModel, UpdateFinBudgetInput> -

useDeleteFinBudget

Signature:

useDeleteFinBudget(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useFinCategory

Hook to fetch a single category by ID Returns the category object, loading state, and error

Signature:

useFinCategory(db: any, categoryId?: string | undefined): UseFinCategoryResult

Parameters:

Returns:

UseFinCategoryResult -

useFinCategories

Signature:

useFinCategories(db: any, filters: FinCategoryFilters, options?: UseFinCategoriesOptions | undefined): UseFinCategoriesResult

Parameters:

Returns:

UseFinCategoriesResult -

useCreateFinCategory

Signature:

useCreateFinCategory(db: any): UseMutationResult<FinCategoryModel, CreateFinCategoryInput>

Parameters:

Returns:

UseMutationResult<FinCategoryModel, CreateFinCategoryInput> -

useUpdateFinCategory

Signature:

useUpdateFinCategory(db: any): UseMutationResult<FinCategoryModel, UpdateFinCategoryInput>

Parameters:

Returns:

UseMutationResult<FinCategoryModel, UpdateFinCategoryInput> -

useDeleteFinCategory

Signature:

useDeleteFinCategory(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useFinIncomeStatement

Hook to fetch a single income statement by ID Returns the income statement object, loading state, and error

Signature:

useFinIncomeStatement(db: any, statementId?: string | undefined): UseFinIncomeStatementResult

Parameters:

Returns:

UseFinIncomeStatementResult -

useFinIncomeStatements

Signature:

useFinIncomeStatements(db: any, filters: FinIncomeStatementFilters, options?: UseFinIncomeStatementsOptions | undefined): UseFinIncomeStatementsResult

Parameters:

Returns:

UseFinIncomeStatementsResult -

useCreateFinIncomeStatement

Signature:

useCreateFinIncomeStatement(db: any): UseMutationResult<FinIncomeStatementModel, CreateFinIncomeStatementInput>

Parameters:

Returns:

UseMutationResult<FinIncomeStatementModel, CreateFinIncomeStatementInput> -

useUpdateFinIncomeStatement

Signature:

useUpdateFinIncomeStatement(db: any): UseMutationResult<FinIncomeStatementModel, UpdateFinIncomeStatementInput>

Parameters:

Returns:

UseMutationResult<FinIncomeStatementModel, UpdateFinIncomeStatementInput> -

useDeleteFinIncomeStatement

Signature:

useDeleteFinIncomeStatement(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useFinScheduledTransaction

Hook to fetch a single scheduled transaction by ID Returns the transaction object, loading state, and error

Signature:

useFinScheduledTransaction(db: any, transactionId?: string | undefined): UseFinScheduledTransactionResult

Parameters:

Returns:

UseFinScheduledTransactionResult -

useFinScheduledTransactions

Signature:

useFinScheduledTransactions(db: any, filters: FinScheduledTransactionFilters, options?: UseFinScheduledTransactionsOptions | undefined): UseFinScheduledTransactionsResult

Parameters:

Returns:

UseFinScheduledTransactionsResult -

useCreateFinScheduledTransaction

Signature:

useCreateFinScheduledTransaction(db: any): UseMutationResult<FinScheduledTransactionModel, CreateFinScheduledTransactionInput>

Parameters:

Returns:

UseMutationResult<FinScheduledTransactionModel, CreateFinScheduledTransactionInput> -

useUpdateFinScheduledTransaction

Signature:

useUpdateFinScheduledTransaction(db: any): UseMutationResult<FinScheduledTransactionModel, UpdateFinScheduledTransactionInput>

Parameters:

Returns:

UseMutationResult<FinScheduledTransactionModel, UpdateFinScheduledTransactionInput> -

useDeleteFinScheduledTransaction

Signature:

useDeleteFinScheduledTransaction(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useFinTransaction

Hook to fetch a single transaction by ID Returns the transaction object, loading state, and error

Signature:

useFinTransaction(db: any, transactionId?: string | undefined): UseFinTransactionResult

Parameters:

Returns:

UseFinTransactionResult -

useFinTransactions

Signature:

useFinTransactions(db: any, filters: FinTransactionFilters, options?: UseFinTransactionsOptions | undefined): UseFinTransactionsResult

Parameters:

Returns:

UseFinTransactionsResult -

useCreateFinTransaction

Signature:

useCreateFinTransaction(db: any): UseMutationResult<FinTransactionModel, CreateFinTransactionInput>

Parameters:

Returns:

UseMutationResult<FinTransactionModel, CreateFinTransactionInput> -

useUpdateFinTransaction

Signature:

useUpdateFinTransaction(db: any): UseMutationResult<FinTransactionModel, UpdateFinTransactionInput>

Parameters:

Returns:

UseMutationResult<FinTransactionModel, UpdateFinTransactionInput> -

useDeleteFinTransaction

Signature:

useDeleteFinTransaction(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useFlow

Hook to fetch a single flow by ID Returns the flow object, loading state, and error

Signature:

useFlow(db: any, flowId?: string | undefined): UseFlowResult

Parameters:

Returns:

UseFlowResult -

useFlows

Signature:

useFlows(db: any, filters: FlowFilters, options?: UseFlowsOptions | undefined): UseFlowsResult

Parameters:

Returns:

UseFlowsResult -

useCreateFlow

Signature:

useCreateFlow(db: any): UseMutationResult<FlowModel, CreateFlowInput>

Parameters:

Returns:

UseMutationResult<FlowModel, CreateFlowInput> -

useUpdateFlow

Signature:

useUpdateFlow(db: any): UseMutationResult<FlowModel, UpdateFlowInput>

Parameters:

Returns:

UseMutationResult<FlowModel, UpdateFlowInput> -

useDeleteFlow

Signature:

useDeleteFlow(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useGoal

Hook to fetch a single goal by ID Returns the goal object, loading state, and error

Signature:

useGoal(db: any, goalId?: string | undefined): UseGoalResult

Parameters:

Returns:

UseGoalResult -

useGoals

Signature:

useGoals(db: any, filters: GoalFilters, options?: UseGoalsOptions | undefined): UseGoalsResult

Parameters:

Returns:

UseGoalsResult -

useCreateGoal

Signature:

useCreateGoal(db: any): UseMutationResult<GoalModel, CreateGoalInput>

Parameters:

Returns:

UseMutationResult<GoalModel, CreateGoalInput> -

useUpdateGoal

Signature:

useUpdateGoal(db: any): UseMutationResult<GoalModel, UpdateGoalInput>

Parameters:

Returns:

UseMutationResult<GoalModel, UpdateGoalInput> -

useDeleteGoal

Signature:

useDeleteGoal(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useInitiatives

Signature:

useInitiatives(db: any, filters: InitiativeFilters, options?: UseInitiativesOptions | undefined): UseInitiativesResult

Parameters:

Returns:

UseInitiativesResult -

useCreateInitiative

Signature:

useCreateInitiative(db: any): UseMutationResult<InitiativeModel, CreateInitiativeInput>

Parameters:

Returns:

UseMutationResult<InitiativeModel, CreateInitiativeInput> -

useUpdateInitiative

Signature:

useUpdateInitiative(db: any): UseMutationResult<InitiativeModel, UpdateInitiativeInput>

Parameters:

Returns:

UseMutationResult<InitiativeModel, UpdateInitiativeInput> -

useDeleteInitiative

Signature:

useDeleteInitiative(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useMarketAnalysis

Signature:

useMarketAnalysis(db: any, analysisId?: string | undefined): UseMarketAnalysisResult

Parameters:

Returns:

UseMarketAnalysisResult -

useMarketAnalyses

Signature:

useMarketAnalyses(db: any, filters: MarketAnalysisFilters, options?: UseMarketAnalysesOptions | undefined): UseMarketAnalysesResult

Parameters:

Returns:

UseMarketAnalysesResult -

useCreateMarketAnalysis

Signature:

useCreateMarketAnalysis(db: any): UseMutationResult<MarketAnalysisModel, CreateMarketAnalysisInput>

Parameters:

Returns:

UseMutationResult<MarketAnalysisModel, CreateMarketAnalysisInput> -

useUpdateMarketAnalysis

Signature:

useUpdateMarketAnalysis(db: any): UseMutationResult<MarketAnalysisModel, UpdateMarketAnalysisInput>

Parameters:

Returns:

UseMutationResult<MarketAnalysisModel, UpdateMarketAnalysisInput> -

useDeleteMarketAnalysis

Signature:

useDeleteMarketAnalysis(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useMessage

Hook to fetch a single message by ID Returns the message object, loading state, and error

Signature:

useMessage(db: any, messageId?: string | undefined): UseMessageResult

Parameters:

Returns:

UseMessageResult -

useMessages

Signature:

useMessages(db: any, filters: MessageFilters, options?: UseMessagesOptions | undefined): UseMessagesResult

Parameters:

Returns:

UseMessagesResult -

useCreateMessage

Signature:

useCreateMessage(db: any): UseMutationResult<MessageModel, CreateMessageInput>

Parameters:

Returns:

UseMutationResult<MessageModel, CreateMessageInput> -

useUpdateMessage

Signature:

useUpdateMessage(db: any): UseMutationResult<MessageModel, UpdateMessageInput>

Parameters:

Returns:

UseMutationResult<MessageModel, UpdateMessageInput> -

useDeleteMessage

Signature:

useDeleteMessage(db: any): UseMutationResult<void, string>

Parameters:

Returns:

UseMutationResult<void, string> -

useMilestone

Hook to fetch a single milestone by ID Returns the milestone object, loading state, and error

Signature:

useMilestone(db: any, milestoneId?: string | undefined): UseMilestoneResult

Parameters:

Returns:

UseMilestoneResult -

useMilestones

React hook for querying milestones

Creates a MilestoneOperator query and subscribes to results. Automatically updates when milestones change in the database.

Signature:

useMilestones(db: any, filters: MilestoneFilters, options?: UseMilestonesOptions | undefined): UseMilestonesResult

Parameters:

Returns:

UseMilestonesResult - UseMilestonesResult with milestones, isLoading, and error

Examples:

function MilestoneList() {
  const { db } = useDatabase();
  const { milestones, isLoading, error } = useMilestones(db, {
    orgId: 'org_123',
    projectId: 'project_456',
    completed: false
  }, {
    sort: 'createdAt',
    limit: 50
  });

  if (isLoading) return <div>Loading milestones...</div>;
  if (error) return <div>Error: {error.message}</div>;

  return (
    <ul>
      {milestones.map(milestone => (
        <li key={milestone.id}>
          {milestone.title} - {milestone.completed ? 'Complete' : 'In Progress'}
        </li>
      ))}
    </ul>
  );
}

useCreateMilestone

React hook for creating milestones

Signature:

useCreateMilestone(db: any): UseMutationResult<MilestoneModel, CreateMilestoneInput>

Parameters:

Returns:

UseMutationResult<MilestoneModel, CreateMilestoneInput> - UseMutationResult with mutate, mutateAsync, and state

Examples:

function CreateMilestoneForm({ orgId, projectId, goalId }: { orgId: string; projectId: string; goalId: string }) {
  const { db } = useDatabase();
  const userId = 'user_123';
  const { mutate, isLoading, error, data } = useCreateMilestone(db);

  const handleSubmit = (e) => {
    e.preventDefault();
    mutate({
      name: 'milestone-1',
      title: 'Milestone 1',
      description: 'First milestone',
      orgId,
      userId,
      projectId,
      goalId
    });
  };

  return <form onSubmit={handleSubmit}>...</form>;
}