terse-sdk 0.1.0

package/dist/shared/types.d.ts

@@ -0,0 +1,744 @@
+import { ConfigInstance, ConfigType } from "./Configs.js";
+import { IntegrationType } from "./Integrations.js";
+import { RunHistoryAction, RunHistoryActionType, RunHistoryRecordWithAgent } from "./RunHistoryTypes.js";
+import { Project, Ticket } from "./TicketSystem.js";
+export type Role = "admin" | "user";
+export type User = {
+    id: string;
+    workosId: string;
+    organizationId: string;
+    organizationName: string;
+    email: string;
+    displayName: string;
+    firstName: string | null;
+    lastName: string | null;
+    displayPhotoUrl: string;
+    roles: Role[];
+};
+export type UserNoOrganization = Omit<User, "organizationId" | "organizationName" | "roles">;
+export type SubActivity = {
+    summary: string;
+    commits: CommitAssociation[];
+};
+export type CommitAssociation = {
+    sha: string;
+    message: string;
+    url: string;
+};
+export type ActivityEvent = {
+    event_type: string;
+    title: string;
+    github_repository_owner_id: string;
+    github_repository_name: string;
+    created_at: Date;
+    sub_activities: SubActivity[];
+};
+export type TicketActivityEvent = {
+    ticket: Ticket;
+    event_type: string;
+    title: string;
+};
+export type ProjectActivityEvent = {
+    project: Project;
+    event_type: string;
+    title: string;
+};
+export type LinearTeam = {
+    id: string;
+    name: string;
+    key: string;
+};
+export type AttioObject = {
+    api_slug: string;
+    singular_noun: string;
+    plural_noun: string;
+};
+export type LinearWorkspace = {
+    id: string;
+    name: string;
+};
+export type JiraProject = {
+    id: string;
+    key: string;
+    name: string;
+};
+export type JiraCredentialsValidationResponse = {
+    valid: boolean;
+    projects?: JiraProject[];
+    error?: string;
+};
+export type NotionResourceType = "database" | "page";
+export type NotionResource = {
+    id: string;
+    title: string;
+    url: string;
+    type: NotionResourceType;
+};
+export type NotionResourcesResponse = {
+    resources: NotionResource[];
+};
+export type PosthogProject = {
+    id: string;
+    name: string;
+    organization_id?: string;
+};
+export type PosthogProjectsResponse = {
+    projects: PosthogProject[];
+};
+export type LaunchDarklyProject = {
+    key: string;
+    name: string;
+};
+export type LaunchDarklyProjectsResponse = {
+    projects: LaunchDarklyProject[];
+};
+export type LaunchDarklyEnvironment = {
+    key: string;
+    name: string;
+};
+export type LaunchDarklyEnvironmentsResponse = {
+    environments: LaunchDarklyEnvironment[];
+};
+export type DatadogIndex = {
+    id: string;
+    name: string;
+    isEnabled: boolean;
+    dailyLimit?: number;
+    retentionDays?: number;
+};
+export type DatadogIndexesResponse = {
+    indexes: DatadogIndex[];
+};
+export type SlackChannel = {
+    id: string;
+    name: string;
+    isPrivate: boolean;
+    isArchived: boolean;
+    isMPIM: boolean;
+};
+export type SlackChannelsResponse = {
+    channels: SlackChannel[];
+    selectedChannelId: string | null;
+};
+export type SlackUserResponse = {
+    id: string;
+    name: string;
+};
+export type SlackUsersResponse = {
+    users: SlackUserResponse[];
+};
+/**
+ * Slack channel type enum
+ */
+export declare enum SlackChannelType {
+    CHANNEL = "channel",
+    GROUP = "group",
+    MPIM = "mpim",
+    IM = "im"
+}
+export type ConfluencePage = {
+    id: string;
+    title: string;
+    spaceId: string;
+    spaceName: string;
+    url: string;
+    status: string;
+    version: number;
+};
+export type ConfluencePagesQuery = {
+    integrationId: string;
+    spaceId?: string;
+    spaceKey?: string;
+};
+export type ConfluencePagesResponse = {
+    pages: ConfluencePage[];
+    spaceId: string;
+    total: number;
+};
+export type ConfluenceResourcesResponse = {
+    resources: ConfluencePage[];
+    spaceId: string;
+    total: number;
+};
+export type JiraResourcesResponse = {
+    success: boolean;
+    resources: {
+        projects: Array<{
+            id: string;
+            key: string;
+            name: string;
+            projectTypeKey: string;
+        }>;
+        baseUrl: string;
+        cloudId: string;
+    };
+};
+export type UseConfluenceResourcesReturn<MutateType = any> = {
+    resources: ConfluencePage[];
+    response: ConfluenceResourcesResponse | undefined;
+    isLoading: boolean;
+    isError: boolean;
+    error: unknown;
+    isValidating: boolean;
+    mutate: MutateType;
+};
+export declare enum FigmaEventTypes {
+    FILE_COMMENT = "FILE_COMMENT"
+}
+/**
+ * Figma webhook event user object
+ */
+export interface FigmaWebhookUser {
+    id: string;
+    handle: string;
+    email: string;
+    img_url: string;
+}
+/**
+ * Figma webhook comment object (from webhook payload)
+ */
+export interface FigmaWebhookComment {
+    id: string;
+    message: string;
+    client_meta: FigmaClientMeta;
+    user: FigmaWebhookUser;
+    created_at: string;
+    resolved_at: string | null;
+}
+/**
+ * Figma comment image URLs
+ * Extracted images for visual context of comments
+ */
+export interface FigmaCommentImageUrls {
+    nodeImage?: string;
+    fullFrame?: string;
+}
+/**
+ * Figma positioning data structures
+ * Represents the position and type of a comment in a Figma file
+ */
+export type FigmaVectorData = {
+    x: number;
+    y: number;
+};
+export type FigmaFrameOffsetData = {
+    node_id: string;
+    node_offset: {
+        x: number;
+        y: number;
+    };
+};
+export type FigmaRegionData = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+export type FigmaFrameOffsetRegionData = {
+    node_id: string;
+    node_offset: {
+        x: number;
+        y: number;
+    };
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+export type FigmaPositioningData = {
+    type: "Vector";
+    data: FigmaVectorData;
+} | {
+    type: "FrameOffset";
+    data: FigmaFrameOffsetData;
+} | {
+    type: "Region";
+    data: FigmaRegionData;
+} | {
+    type: "FrameOffsetRegion";
+    data: FigmaFrameOffsetRegionData;
+};
+/**
+ * Figma client_meta structure
+ * Represents the raw positioning metadata from Figma comment client_meta
+ * Can be one of several positioning formats
+ */
+export type FigmaClientMeta = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    node_id: string;
+    node_offset: {
+        x: number;
+        y: number;
+    };
+};
+/**
+ * Figma API comment response structure
+ */
+export interface FigmaApiComment {
+    id: string;
+    message: string;
+    client_meta: FigmaClientMeta | null;
+    user: FigmaWebhookUser;
+    created_at: string;
+    resolved_at: string | null;
+    parent_id?: string | null;
+    order_id?: string;
+    mentions?: unknown[];
+    reactions?: unknown[];
+}
+export interface FigmaCommentThreadEntry {
+    id: string;
+    message: string;
+    author: FigmaWebhookUser;
+    createdAt: string;
+    resolvedAt: string | null;
+    parentId: string | null;
+    orderId?: string;
+    isRoot?: boolean;
+}
+/**
+ * Figma comment event data
+ * Processed/enriched comment data used for automation events
+ * This combines data from webhook, API, and enriched context
+ */
+export interface FigmaCommentEventData {
+    integrationId: string;
+    commentId: string;
+    fileKey: string;
+    fileUrl: string;
+    nodeId?: string;
+    message: string;
+    author: FigmaWebhookUser;
+    createdAt: string;
+    resolved?: boolean;
+    thread?: FigmaCommentThreadEntry[];
+    fileMetadata?: any;
+    positioningData?: FigmaPositioningData;
+    matchedNodeIds?: string[];
+    imageUrls?: FigmaCommentImageUrls;
+}
+export type ApiToken = {
+    id: string;
+    name: string;
+    tokenPrefix: string;
+    createdAt: string;
+    lastUsedAt: string | null;
+};
+export type ApiTokenCreateResponse = {
+    token: ApiToken;
+    rawToken: string;
+};
+export type AgentTrigger = {
+    id: string;
+    config: ConfigInstance;
+};
+export type AgentOutput = {
+    id: string;
+    config: ConfigInstance;
+};
+export type AgentPrompt = {
+    text: string;
+};
+export type TransientAgentTrigger = {
+    id: string;
+    config?: ConfigInstance;
+    configType: ConfigType;
+};
+export type TransientAgentOutput = {
+    id: string;
+    config?: ConfigInstance;
+    configType: ConfigType;
+};
+export type TemplateConfigRef = {
+    configType: ConfigType;
+    integrationType: IntegrationType;
+};
+export type TemplateTrigger = {
+    config: TemplateConfigRef;
+};
+export type TemplateOutput = {
+    config: TemplateConfigRef;
+};
+export type TemplateCategory = "ship" | "users" | "sync" | "track";
+export type AgentTemplate = {
+    id: string;
+    category: TemplateCategory;
+    name: string;
+    description: string;
+    chatPrompt: string;
+    prompt: AgentPrompt;
+    triggers: TemplateTrigger[];
+    outputs: TemplateOutput[];
+    requireApproval: boolean;
+    isActive: boolean;
+};
+export type Agent = {
+    id: string;
+    name: string;
+    isActive: boolean;
+    requireApproval: boolean;
+    prompt: AgentPrompt;
+    triggers: AgentTrigger[];
+    outputs: AgentOutput[];
+    notificationSettings?: AgentNotificationSettings;
+    toolApprovals?: string[];
+    updatedAt?: string;
+    source?: "WEB_UI" | "SDK";
+};
+export type AgentNotificationSettings = {
+    enabled: boolean;
+    actionTypes: RunHistoryActionType[];
+    notifyOnRunFailure: boolean;
+};
+export type AgentUpdate = {
+    name?: string;
+    triggers?: AgentTrigger[];
+    outputs?: AgentOutput[];
+    prompt?: AgentPrompt;
+    isActive?: boolean;
+    requireApproval?: boolean;
+    notificationSettings?: AgentNotificationSettings;
+    toolApprovals?: string[];
+};
+export type AgentsResponse = {
+    agents: Agent[];
+    pagination: {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+    };
+};
+export type RecentAgent = Agent & {
+    updatedAt: string;
+    lastEventProcessedAt: string | null;
+};
+export type GithubAppInstallationCallbackRequest = {
+    name: string;
+    email: string;
+    username: string;
+    installationId: number;
+    accountName: string | null;
+    repositories: Repository[];
+};
+export type Repository = {
+    name: string;
+    owner: string;
+    id: number;
+};
+export type GetGithubRepositoriesForIntegrationRequest = {};
+export type GetGithubRepositoriesForIntegrationResponse = {
+    repositories: Repository[];
+};
+export type OAuthInstallationDetails = {
+    oauthUrl: string;
+};
+export type StatsInterval = "1h" | "24h" | "7d" | "1mo" | "3mo" | "1y";
+export interface DailyEventCount {
+    date: string;
+    events: number;
+}
+export interface RecentAction {
+    action: string;
+    integration: IntegrationType;
+    target: string;
+    details: string;
+    url?: string;
+    timestamp: string;
+    agentName: string;
+    type: RunHistoryActionType;
+}
+export interface AgentActivityItem {
+    agentId: string;
+    agentName: string;
+    runCount: number;
+}
+export interface CountByString {
+    label: string;
+    count: number;
+}
+export interface StatsResponse {
+    totalEventsProcessed: number;
+    totalEventsProcessedChange: string;
+    actionsTaken: number;
+    actionsTakenChange: string;
+    numberOfAgents: number;
+    numberOfAgentsChange: string;
+    dailyEvents: DailyEventCount[];
+    recentActions: RecentAction[];
+    recentRuns: RunHistoryRecordWithAgent[];
+    timezone: string;
+    agentActivity: AgentActivityItem[];
+    statusBreakdown: CountByString[];
+    triggerIntegrations: CountByString[];
+    actionIntegrations: CountByString[];
+    actionTypes: CountByString[];
+}
+export interface TriggerPayload {
+    integrationId: string;
+    integrationType: IntegrationType;
+    config: Record<string, unknown>;
+}
+export interface SerializedEvent {
+    integrationType: IntegrationType;
+    formattedContent: string;
+    debugLog: string;
+}
+export type SdkAgentRunEventPayload = {
+    integrationType: IntegrationType;
+    formattedContent: string;
+    debugLog: string;
+};
+export type SdkAgentSkillPayload = {
+    configType: ConfigType;
+    config: Record<string, unknown>;
+};
+export type SdkAgentRunOptionsPayload = {
+    maxTurns?: number;
+    requireApproval?: boolean;
+};
+export type SdkAgentRunRequestBody = {
+    prompt?: string;
+    event?: Partial<SdkAgentRunEventPayload>;
+    skills?: SdkAgentSkillPayload[];
+    options?: SdkAgentRunOptionsPayload;
+};
+export type SdkAgentRunResponseBody = {
+    success: boolean;
+    error?: string;
+    details?: string[];
+    contract?: {
+        responseMode: "streaming";
+        supportsInterruptions: boolean;
+    };
+    normalizedRequest?: {
+        prompt: string;
+        event: SdkAgentRunEventPayload;
+        skills: SdkAgentSkillPayload[];
+        options: {
+            maxTurns: number;
+            requireApproval: boolean;
+        };
+    };
+};
+export type SdkAgentStreamEvent = {
+    type: "text";
+    text: string;
+} | {
+    type: "final_output";
+    finalOutput: string;
+} | {
+    type: "tool_call_params";
+    toolCallParams: string;
+} | {
+    type: "tool_call_started";
+    toolCallStarted: string;
+} | {
+    type: "tool_call_completed";
+    toolCallCompleted: string;
+} | {
+    type: "action";
+    action: RunHistoryAction;
+} | {
+    type: "error";
+    message: string;
+} | {
+    type: "done";
+};
+export type ToolOutputBase = {
+    success: boolean;
+    actions?: RunHistoryAction[];
+};
+export type ToolOutputByName = {
+    [toolName: string]: unknown;
+    slack_send_message: ToolOutputBase & {
+        message_ts: string | undefined;
+        channel: string;
+        thread_ts: string | undefined;
+        summary: string;
+        has_blocks: boolean;
+    };
+    slack_list_channels: ToolOutputBase & {
+        channels: Array<{
+            id?: string;
+            name: string;
+            isPrivate: boolean;
+            isIm: boolean;
+            isMpim: boolean;
+        }>;
+        count: number;
+        nextCursor: string | null;
+        hasMore: boolean;
+    };
+    slack_list_users: ToolOutputBase & {
+        users: Array<{
+            id: string;
+            name: string;
+        }>;
+        count: number;
+    };
+    slack_read_conversation: ToolOutputBase & {
+        channelId: string;
+        channelName?: string;
+        messages: Array<{
+            userId?: string;
+            userName?: string;
+            text: string;
+            timestamp?: string;
+            threadTs?: string;
+        }>;
+        count: number;
+        hasMore: boolean;
+        nextCursor: string | null;
+    };
+    searchGitHubCode: ToolOutputBase & {
+        totalCount: number;
+        resultsReturned: number;
+        query: string;
+        repositories: string[];
+        pagination: {
+            page: number;
+            perPage: number;
+            hasMore: boolean;
+        };
+        results: Array<{
+            index: number;
+            repository: string;
+            path: string;
+            url: string;
+            snippets: string;
+        }>;
+        message: string;
+        tip: string;
+    };
+    readGitHubFile: ToolOutputBase & {
+        repository: string;
+        path: string;
+        url: string;
+        totalLines: number;
+        displayedLines: string;
+        size: number;
+        content: string;
+        warning?: string;
+    };
+    listGitHubPullRequests: ToolOutputBase & {
+        repository: string;
+        timeWindow: string;
+        summary: {
+            total: number;
+            merged: number;
+            open: number;
+            closed: number;
+        };
+        pagination: {
+            page: number;
+            perPage: number;
+            hasMore: boolean;
+        };
+        pullRequests: Array<{
+            number: number;
+            title: string;
+            description: string;
+            author: string;
+            state: string;
+            merged: boolean;
+            mergedAt?: string;
+            createdAt: string;
+            closedAt?: string;
+            labels: string[];
+            baseBranch: string;
+            headBranch: string;
+            url: string;
+        }>;
+        message: string;
+    };
+    listGitHubDirectory: ToolOutputBase & {
+        repository: string;
+        path: string;
+        recursive: boolean;
+        totalItems: number;
+        directories: Array<{
+            name?: string;
+            path?: string;
+            type?: "directory";
+        } | string>;
+        files: Array<{
+            name?: string;
+            path: string;
+            type?: "file";
+            size?: number;
+        }>;
+        warning?: string;
+        tip?: string;
+        truncated?: boolean;
+        other?: Array<{
+            name: string;
+            type: string;
+        }>;
+    };
+    listGitHubCommits: ToolOutputBase & {
+        repository: string;
+        timeWindow: string;
+        filters: string;
+        summary: {
+            total: number;
+            byAuthor: Record<string, number>;
+        };
+        commits: Array<{
+            sha: string;
+            fullSha: string;
+            message: string;
+            fullMessage: string;
+            author: string;
+            date: string;
+            url: string;
+        }>;
+        message: string;
+        tip: string;
+    };
+    grepGitHubCode: ToolOutputBase & {
+        totalCount: number;
+        resultsReturned: number;
+        pattern: string;
+        query: string;
+        repositories: string[];
+        pagination: {
+            page: number;
+            perPage: number;
+            hasMore: boolean;
+        };
+        results: Array<{
+            index: number;
+            repository: string;
+            file: string;
+            url: string;
+            matches: string;
+        }>;
+        message: string;
+        tip: string;
+    };
+    summarizeGitHubPullRequestDiff: ToolOutputBase & {
+        repository: string;
+        pullRequest: {
+            number: number;
+            title: string;
+            state: string;
+            merged: boolean;
+            baseBranch: string;
+            headBranch: string;
+            url: string;
+        };
+        summary: Record<string, unknown>;
+        pagination: {
+            page: number;
+            perPage: number;
+            hasMore: boolean;
+        };
+        analysis: string;
+        message: string;
+    };
+};
+//# sourceMappingURL=types.d.ts.map