@plotday/twister 0.36.0 → 0.38.0

package/dist/common/calendar.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"calendar.js","sourceRoot":"","sources":["../../src/common/calendar.ts"],"names":[],"mappings":""}

package/dist/common/documents.d.ts

@@ -1,122 +0,0 @@
-import type { ActivityMeta, NewActivityWithNotes, Serializable } from "../index";
-/**
- * Represents a folder from an external document service.
- *
- * Contains metadata about a specific folder that can be synced
- * with Plot. Different document providers may have additional
- * provider-specific properties.
- */
-export type DocumentFolder = {
-    /** Unique identifier for the folder within the provider */
-    id: string;
-    /** Human-readable name of the folder */
-    name: string;
-    /** Optional description or additional details about the folder */
-    description: string | null;
-    /** Whether this is a root-level folder (e.g., "My Drive" in Google Drive) */
-    root: boolean;
-};
-/**
- * Configuration options for document synchronization.
- *
- * Controls the time range and other parameters for document sync operations.
- * Used to limit sync scope and optimize performance.
- */
-export type DocumentSyncOptions = {
-    /** Earliest date to sync documents from (inclusive) */
-    timeMin?: Date;
-};
-/**
- * Base interface for document service integration tools.
- *
- * All synced documents are converted to ActivityWithNotes objects.
- * Each document becomes an Activity with Notes for the description and comments.
- *
- * **Architecture: Tools Build, Twists Save**
- *
- * Document tools follow Plot's core architectural principle:
- * - **Tools**: Fetch external data and transform it into Plot format (NewActivity objects)
- * - **Twists**: Receive the data and decide what to do with it (create, update, filter, etc.)
- *
- * **Implementation Pattern:**
- * 1. Authorization is handled via the twist edit modal (Integrations provider config)
- * 2. Tool declares providers and lifecycle callbacks in build()
- * 3. onAuthorized lists available folders and calls setSyncables()
- * 4. User enables folders in the modal → onSyncEnabled fires
- * 5. **Tool builds NewActivity objects** and passes them to the twist via callback
- * 6. **Twist decides** whether to save using createActivity/updateActivity
- *
- * **Recommended Data Sync Strategy:**
- * Use Activity.source and Note.key for automatic upserts.
- *
- * - Set `Activity.source` to `"{provider}:file:{fileId}"` (e.g., `"google-drive:file:abc123"`)
- * - Use `Note.key` for document details:
- *   - key: `"summary"` for the document description or metadata summary
- *   - key: `"comment-{commentId}"` for individual comments (unique per comment)
- *   - key: `"reply-{commentId}-{replyId}"` for comment replies
- * - No manual ID tracking needed - Plot handles deduplication automatically
- * - Send NewActivityWithNotes for all documents (creates new or updates existing)
- * - Set `activity.unread = false` for initial sync, omit for incremental updates
- */
-export type DocumentTool = {
-    /**
-     * Retrieves the list of folders accessible to the user.
-     *
-     * @param folderId - A folder ID to use for auth lookup
-     * @returns Promise resolving to array of available folders
-     */
-    getFolders(folderId: string): Promise<DocumentFolder[]>;
-    /**
-     * Begins synchronizing documents from a specific folder.
-     *
-     * Documents are converted to NewActivityWithNotes objects.
-     *
-     * Auth is obtained automatically via integrations.get(provider, folderId).
-     *
-     * @param options - Sync configuration options
-     * @param options.folderId - ID of the folder to sync
-     * @param options.timeMin - Earliest date to sync documents from (inclusive)
-     * @param callback - Function receiving (activity, ...extraArgs) for each synced document
-     * @param extraArgs - Additional arguments to pass to the callback (type-checked, no functions allowed)
-     * @returns Promise that resolves when sync setup is complete
-     */
-    startSync<TArgs extends Serializable[], TCallback extends (activity: NewActivityWithNotes, ...args: TArgs) => any>(options: {
-        folderId: string;
-    } & DocumentSyncOptions, callback: TCallback, ...extraArgs: TArgs): Promise<void>;
-    /**
-     * Stops synchronizing documents from a specific folder.
-     *
-     * @param folderId - ID of the folder to stop syncing
-     * @returns Promise that resolves when sync is stopped
-     */
-    stopSync(folderId: string): Promise<void>;
-    /**
-     * Adds a comment to a document.
-     *
-     * Optional method for bidirectional sync. When implemented, allows Plot to
-     * sync notes added to activities back as comments on the external document.
-     *
-     * Auth is obtained automatically. The tool should extract its own ID
-     * from meta (e.g., fileId).
-     *
-     * @param meta - Activity metadata containing the tool's document identifier
-     * @param body - The comment text content
-     * @param noteId - Optional Plot note ID for deduplication
-     * @returns The external comment key (e.g. "comment-123") for dedup, or void
-     */
-    addDocumentComment?(meta: ActivityMeta, body: string, noteId?: string): Promise<string | void>;
-    /**
-     * Adds a reply to an existing comment thread on a document.
-     *
-     * Auth is obtained automatically. The tool should extract its own ID
-     * from meta (e.g., fileId).
-     *
-     * @param meta - Activity metadata containing the tool's document identifier
-     * @param commentId - The external comment ID to reply to
-     * @param body - The reply text content
-     * @param noteId - Optional Plot note ID for deduplication
-     * @returns The external reply key (e.g. "reply-123-456") for dedup, or void
-     */
-    addDocumentReply?(meta: ActivityMeta, commentId: string, body: string, noteId?: string): Promise<string | void>;
-};
-//# sourceMappingURL=documents.d.ts.map

package/dist/common/documents.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../../src/common/documents.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,YAAY,EACZ,oBAAoB,EACpB,YAAY,EACb,MAAM,UAAU,CAAC;AAElB;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,2DAA2D;IAC3D,EAAE,EAAE,MAAM,CAAC;IACX,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,6EAA6E;IAC7E,IAAI,EAAE,OAAO,CAAC;CACf,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,uDAAuD;IACvD,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAExD;;;;;;;;;;;;;OAaG;IACH,SAAS,CACP,KAAK,SAAS,YAAY,EAAE,EAC5B,SAAS,SAAS,CAAC,QAAQ,EAAE,oBAAoB,EAAE,GAAG,IAAI,EAAE,KAAK,KAAK,GAAG,EAEzE,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;KAClB,GAAG,mBAAmB,EACvB,QAAQ,EAAE,SAAS,EACnB,GAAG,SAAS,EAAE,KAAK,GAClB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1C;;;;;;;;;;;;;OAaG;IACH,kBAAkB,CAAC,CACjB,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAE1B;;;;;;;;;;;OAWG;IACH,gBAAgB,CAAC,CACf,IAAI,EAAE,YAAY,EAClB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CAC3B,CAAC"}

package/dist/common/documents.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=documents.js.map

package/dist/common/documents.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"documents.js","sourceRoot":"","sources":["../../src/common/documents.ts"],"names":[],"mappings":""}

package/dist/common/messaging.d.ts

@@ -1,84 +0,0 @@
-import type { NewActivityWithNotes, Serializable } from "../index";
-/**
- * Represents a channel from an external messaging service.
- *
- * Contains metadata about a specific channel that can be synced
- * with Plot. Different messaging providers may have additional
- * provider-specific properties.
- */
-export type MessageChannel = {
-    /** Unique identifier for the channel within the provider */
-    id: string;
-    /** Human-readable name of the channel (e.g., "Inbox", "#general", "My Team Thread") */
-    name: string;
-    /** Optional description or additional details about the channel */
-    description: string | null;
-    /** Whether this is the user's primary/default channel (e.g. email inbox) */
-    primary: boolean;
-};
-/**
- * Configuration options for messaging synchronization.
- *
- * Controls the time range and other parameters for messaging sync operations.
- * Used to limit sync scope and optimize performance.
- */
-export type MessageSyncOptions = {
-    /** Earliest date to sync events from (inclusive) */
-    timeMin?: Date;
-};
-/**
- * Base interface for email and chat integration tools.
- *
- * All synced messages/emails are converted to ActivityWithNotes objects.
- * Each email thread or chat conversation becomes an Activity with Notes for each message.
- *
- * **Architecture: Tools Build, Twists Save**
- *
- * Messaging tools follow Plot's core architectural principle:
- * - **Tools**: Fetch external data and transform it into Plot format (NewActivity objects)
- * - **Twists**: Receive the data and decide what to do with it (create, update, filter, etc.)
- *
- * **Implementation Pattern:**
- * 1. Authorization is handled via the twist edit modal (Integrations provider config)
- * 2. Tool declares providers and lifecycle callbacks in build()
- * 3. onAuthorized lists available channels and calls setSyncables()
- * 4. User enables channels in the modal → onSyncEnabled fires
- * 5. **Tool builds NewActivity objects** and passes them to the twist via callback
- * 6. **Twist decides** whether to save using createActivity/updateActivity
- *
- * **Recommended Data Sync Strategy:**
- * Use Activity.source (thread URL or ID) and Note.key (message ID) for automatic upserts.
- * See SYNC_STRATEGIES.md for detailed patterns.
- */
-export type MessagingTool = {
-    /**
-     * Retrieves the list of conversation channels (inboxes, channels) accessible to the user.
-     *
-     * @param channelId - A channel ID to use for auth lookup
-     * @returns Promise resolving to array of available conversation channels
-     */
-    getChannels(channelId: string): Promise<MessageChannel[]>;
-    /**
-     * Begins synchronizing messages from a specific channel.
-     *
-     * Auth is obtained automatically via integrations.get(provider, channelId).
-     *
-     * @param options - Sync configuration options
-     * @param options.channelId - ID of the channel (e.g., channel, inbox) to sync
-     * @param options.timeMin - Earliest date to sync events from (inclusive)
-     * @param callback - Function receiving (thread, ...extraArgs) for each synced conversation
-     * @param extraArgs - Additional arguments to pass to the callback (type-checked, no functions allowed)
-     * @returns Promise that resolves when sync setup is complete
-     */
-    startSync<TArgs extends Serializable[], TCallback extends (thread: NewActivityWithNotes, ...args: TArgs) => any>(options: {
-        channelId: string;
-    } & MessageSyncOptions, callback: TCallback, ...extraArgs: TArgs): Promise<void>;
-    /**
-     * Stops synchronizing messages from a specific channel.
-     *
-     * @param channelId - ID of the channel to stop syncing
-     * @returns Promise that resolves when sync is stopped
-     */
-    stopSync(channelId: string): Promise<void>;
-};
-//# sourceMappingURL=messaging.d.ts.map

package/dist/common/messaging.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"messaging.d.ts","sourceRoot":"","sources":["../../src/common/messaging.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAEnE;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,4DAA4D;IAC5D,EAAE,EAAE,MAAM,CAAC;IACX,uFAAuF;IACvF,IAAI,EAAE,MAAM,CAAC;IACb,mEAAmE;IACnE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,4EAA4E;IAC5E,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,oDAAoD;IACpD,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;;OAKG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAE1D;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAAK,SAAS,YAAY,EAAE,EAC5B,SAAS,SAAS,CAAC,MAAM,EAAE,oBAAoB,EAAE,GAAG,IAAI,EAAE,KAAK,KAAK,GAAG,EAEvE,OAAO,EAAE;QACP,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,kBAAkB,EACtB,QAAQ,EAAE,SAAS,EACnB,GAAG,SAAS,EAAE,KAAK,GAClB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5C,CAAC"}

package/dist/common/messaging.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=messaging.js.map

package/dist/common/messaging.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"messaging.js","sourceRoot":"","sources":["../../src/common/messaging.ts"],"names":[],"mappings":""}

package/dist/common/projects.d.ts

@@ -1,112 +0,0 @@
-import type { Activity, ActivityMeta, NewActivityWithNotes, Serializable } from "../index";
-/**
- * Represents a project from an external project management service.
- *
- * Contains metadata about a specific project/board/workspace that can be synced
- * with Plot. Different project providers may have additional
- * provider-specific properties.
- */
-export type Project = {
-    /** Unique identifier for the project within the provider */
-    id: string;
-    /** Human-readable name of the project (e.g., "Q1 Roadmap", "Engineering") */
-    name: string;
-    /** Optional description or additional details about the project */
-    description: string | null;
-    /** Optional project key/abbreviation (e.g., "PROJ" in Jira, "ENG" in Linear) */
-    key: string | null;
-};
-/**
- * Configuration options for project synchronization.
- *
- * Controls the time range and other parameters for project sync operations.
- * Used to limit sync scope and optimize performance.
- */
-export type ProjectSyncOptions = {
-    /** Earliest date to sync issues from (inclusive) */
-    timeMin?: Date;
-};
-/**
- * Base interface for project management integration tools.
- *
- * All synced issues/tasks are converted to ActivityWithNotes objects.
- * Each issue becomes an Activity with Notes for the description and comments.
- *
- * **Architecture: Tools Build, Twists Save**
- *
- * Project tools follow Plot's core architectural principle:
- * - **Tools**: Fetch external data and transform it into Plot format (NewActivity objects)
- * - **Twists**: Receive the data and decide what to do with it (create, update, filter, etc.)
- *
- * **Implementation Pattern:**
- * 1. Authorization is handled via the twist edit modal (Integrations provider config)
- * 2. Tool declares providers and lifecycle callbacks in build()
- * 3. onAuthorized lists available projects and calls setSyncables()
- * 4. User enables projects in the modal → onSyncEnabled fires
- * 5. **Tool builds NewActivity objects** and passes them to the twist via callback
- * 6. **Twist decides** whether to save using createActivity/updateActivity
- *
- * **Recommended Data Sync Strategy:**
- * Use Activity.source (issue URL) and Note.key for automatic upserts.
- * See SYNC_STRATEGIES.md for detailed patterns.
- */
-export type ProjectTool = {
-    /**
-     * Retrieves the list of projects accessible to the user.
-     *
-     * @param projectId - A project ID to use for auth lookup
-     * @returns Promise resolving to array of available projects
-     */
-    getProjects(projectId: string): Promise<Project[]>;
-    /**
-     * Begins synchronizing issues from a specific project.
-     *
-     * Auth is obtained automatically via integrations.get(provider, projectId).
-     *
-     * @param options - Sync configuration options
-     * @param options.projectId - ID of the project to sync
-     * @param options.timeMin - Earliest date to sync issues from (inclusive)
-     * @param callback - Function receiving (activity, ...extraArgs) for each synced issue
-     * @param extraArgs - Additional arguments to pass to the callback (type-checked, no functions allowed)
-     * @returns Promise that resolves when sync setup is complete
-     */
-    startSync<TArgs extends Serializable[], TCallback extends (activity: NewActivityWithNotes, ...args: TArgs) => any>(options: {
-        projectId: string;
-    } & ProjectSyncOptions, callback: TCallback, ...extraArgs: TArgs): Promise<void>;
-    /**
-     * Stops synchronizing issues from a specific project.
-     *
-     * @param projectId - ID of the project to stop syncing
-     * @returns Promise that resolves when sync is stopped
-     */
-    stopSync(projectId: string): Promise<void>;
-    /**
-     * Updates an issue/task with new values.
-     *
-     * Optional method for bidirectional sync. When implemented, allows Plot to
-     * sync activity updates back to the external service.
-     *
-     * Auth is obtained automatically via integrations.get(provider, projectId)
-     * using the projectId from activity.meta.
-     *
-     * @param activity - The updated activity
-     * @returns Promise that resolves when the update is synced
-     */
-    updateIssue?(activity: Activity): Promise<void>;
-    /**
-     * Adds a comment to an issue/task.
-     *
-     * Optional method for bidirectional sync. When implemented, allows Plot to
-     * sync notes added to activities back as comments on the external service.
-     *
-     * Auth is obtained automatically. The tool should extract its own ID
-     * from meta (e.g., linearId, taskGid, issueKey).
-     *
-     * @param meta - Activity metadata containing the tool's issue/task identifier
-     * @param body - The comment text content
-     * @param noteId - Optional Plot note ID, used by tools that support comment metadata (e.g. Jira)
-     * @returns The external comment key (e.g. "comment-123") for dedup, or void
-     */
-    addIssueComment?(meta: ActivityMeta, body: string, noteId?: string): Promise<string | void>;
-};
-//# sourceMappingURL=projects.d.ts.map

package/dist/common/projects.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"projects.d.ts","sourceRoot":"","sources":["../../src/common/projects.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,QAAQ,EACR,YAAY,EACZ,oBAAoB,EACpB,YAAY,EACb,MAAM,UAAU,CAAC;AAElB;;;;;;GAMG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,4DAA4D;IAC5D,EAAE,EAAE,MAAM,CAAC;IACX,6EAA6E;IAC7E,IAAI,EAAE,MAAM,CAAC;IACb,mEAAmE;IACnE,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,gFAAgF;IAChF,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,oDAAoD;IACpD,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;;;;OAKG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEnD;;;;;;;;;;;OAWG;IACH,SAAS,CACP,KAAK,SAAS,YAAY,EAAE,EAC5B,SAAS,SAAS,CAAC,QAAQ,EAAE,oBAAoB,EAAE,GAAG,IAAI,EAAE,KAAK,KAAK,GAAG,EAEzE,OAAO,EAAE;QACP,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,kBAAkB,EACtB,QAAQ,EAAE,SAAS,EACnB,GAAG,SAAS,EAAE,KAAK,GAClB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;OAKG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3C;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD;;;;;;;;;;;;;OAaG;IACH,eAAe,CAAC,CACd,IAAI,EAAE,YAAY,EAClB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CAC3B,CAAC"}

package/dist/common/projects.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=projects.js.map

package/dist/common/projects.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"projects.js","sourceRoot":"","sources":["../../src/common/projects.ts"],"names":[],"mappings":""}