terse-types 0.0.1

package/README.md

@@ -0,0 +1,44 @@
+# terse-types
+
+Shared Terse TypeScript types, enums, constants, and helpers packaged for reuse across repositories.
+
+## Install
+
+```bash
+npm install terse-types
+```
+
+```bash
+pnpm add terse-types
+```
+
+## Usage
+
+Import from the root barrel when you want the common API surface:
+
+```ts
+import { IntegrationType, type User } from "terse-types"
+```
+
+Import by subpath when you want a specific module:
+
+```ts
+import { ApiRoutes } from "terse-types"
+import type { RunHistoryStatus } from "terse-types/RunHistoryTypes"
+```
+
+## Local Development
+
+The `terse-types` workspace package lives in the repo's `terse-types/` directory.
+
+Build it from the repo root with:
+
+```bash
+pnpm --filter terse-types run build
+```
+
+If you are working on the local CLI and SDK at the same time, relink them from the repo root with:
+
+```bash
+pnpm run install-global
+```

package/dist/ApiRouteBuilder.d.ts

@@ -0,0 +1,185 @@
+export declare const ApiRoutes: {
+    AUTH: {
+        ME: string;
+        LOGIN: string;
+        LOGIN_URL: string;
+        LOGOUT: string;
+        LOGOUT_URL: string;
+        GITHUB_APP_CALLBACK: string;
+        WORKOS_CALLBACK: string;
+    };
+    WORKOS: {
+        WIDGET_TOKEN: string;
+    };
+    ORGANIZATIONS: {
+        CREATE: string;
+        GET_CURRENT: string;
+        LIST: string;
+        SWITCH: string;
+        UPDATE: string;
+        LOGO_UPLOAD_URL: string;
+        LOGO: string;
+    };
+    STATS: string;
+    RUN_HISTORY: {
+        ALL: string;
+        ACTIONS: string;
+        BY_AGENT_ID: string;
+        CHAT_BY_RUN_ID: string;
+    };
+    SESSION: {
+        TOKEN: string;
+    };
+    GITHUB: {
+        INTEGRATIONS: string;
+        INSTALLATION_URL: string;
+        GET_REPOSITORIES_FOR_INTEGRATION: string;
+        INSTALLATION_CALLBACK: string;
+        INSTALLATION_DELETED: string;
+        UNIFIED_EVENT: string;
+    };
+    ATLASSIAN: {
+        INTEGRATIONS: string;
+        OAUTH_CALLBACK: string;
+    };
+    JIRA: {
+        RESOURCES: string;
+        GET_API_KEY: string;
+        SET_API_KEY: string;
+        VALIDATE_AND_FETCH_PROJECTS: string;
+        DELETE_CREDENTIALS: string;
+    };
+    CONFLUENCE: {
+        INTEGRATIONS: string;
+        RESOURCES: string;
+    };
+    GMAIL: {
+        INTEGRATIONS: string;
+        CALLBACK: string;
+        DELETE_INTEGRATION: string;
+    };
+    NOTION: {
+        INTEGRATIONS: string;
+        OAUTH_CALLBACK: string;
+        RESOURCES: string;
+        DELETE_INTEGRATION: string;
+    };
+    FIGMA: {
+        INTEGRATIONS: string;
+        OAUTH_CALLBACK: string;
+    };
+    LINEAR: {
+        OAUTH_CALLBACK: string;
+        WEBHOOK: string;
+        INTEGRATIONS: string;
+        TEAMS: string;
+    };
+    SLACK: {
+        INTEGRATIONS: string;
+        GET_CURRENT_INTEGRATION: string;
+        OAUTH_CALLBACK: string;
+        CHANNELS: string;
+        USERS: string;
+        EVENTS: string;
+    };
+    POSTHOG: {
+        INTEGRATIONS: string;
+        PROJECTS: string;
+    };
+    LAUNCHDARKLY: {
+        INTEGRATIONS: string;
+        PROJECTS_BY_INTEGRATION_ID: string;
+        ENVIRONMENTS_BY_INTEGRATION_AND_PROJECT: string;
+    };
+    DATADOG: {
+        INTEGRATIONS: string;
+        INDEXES: string;
+    };
+    WORKOS_INTEGRATION: {
+        INTEGRATIONS: string;
+        WEBHOOK_SECRET: string;
+    };
+    SNOWFLAKE: {
+        INTEGRATIONS: string;
+    };
+    ATTIO: {
+        INTEGRATIONS: string;
+        OAUTH_CALLBACK: string;
+        OBJECTS: string;
+    };
+    AGENTS: {
+        LIST: string;
+        RECENT: string;
+        BY_ID: string;
+    };
+    IMPROVEMENTS: {
+        BY_AGENT_ID: string;
+        APPLY: string;
+        DISMISS: string;
+        UNDO_DISMISS: string;
+        TOGGLE_ENABLED: string;
+    };
+    TEMPLATES: string;
+    PUBLIC: {
+        TEMPLATES: string;
+    };
+    TOOLS: {
+        THAT_REQUIRE_APPROVALS: string;
+    };
+    INTEGRATIONS: {
+        INSTALLATION_DETAILS_BY_TYPE: string;
+        LIST: string;
+        ACTIVE: string;
+    };
+    NOTIFICATION_DESTINATIONS: {
+        LIST: string;
+        BY_ID: string;
+    };
+    API_TOKENS: {
+        LIST: string;
+        BY_ID: string;
+    };
+    SDK: {
+        ME: string;
+        SAMPLE_EVENTS: string;
+        TOOL_EXECUTE: string;
+        TOOL_DEFINITIONS: string;
+        AGENT_RUN: string;
+        APPROVAL_DECISION: string;
+        SESSION_EVENTS: string;
+        DEPLOY: string;
+        DEVICE_TOKEN_EXCHANGE: string;
+        INTEGRATION_FIELDS: string;
+        INTEGRATION_FORM_SUBMIT: string;
+    };
+    NOTIFICATION_SETTINGS: string;
+    SENT_NOTIFICATIONS: {
+        LIST: string;
+    };
+    PENDING_APPROVALS: {
+        LIST: string;
+    };
+    WEBHOOKS: {
+        GMAIL: string;
+        FIGMA: string;
+        WORKOS: string;
+        JIRA_BY_ACCOUNT_ID: string;
+        LINEAR_BY_USER_ID: string;
+        SCHEDULE_BY_INPUT_ID: string;
+        WORKOS_TRIGGER_BY_INTEGRATION_ID: string;
+    };
+    SCHEDULE: {
+        TRIGGER_BY_INPUT_ID: string;
+        TRIGGER_WITH_EVENT: string;
+    };
+    REFRESH_TOKENS: string;
+    REVIEW_AGENTS: string;
+    USERS: {
+        CREATE: string;
+        BY_ID: string;
+    };
+    BUILDER_CHAT: {
+        HISTORY_BY_SESSION_ID: string;
+    };
+};
+export declare function buildRoute(pattern: string, params: Record<string, string | number>): string;

package/dist/ApiRouteBuilder.js

@@ -0,0 +1,11 @@
+import apiRoutes from "./ApiRoutes.json" with { type: "json" };
+export const ApiRoutes = apiRoutes;
+export function buildRoute(pattern, params) {
+    return pattern.replace(/:([A-Za-z0-9_]+)/g, (_, paramName) => {
+        const value = params[paramName];
+        if (value == null) {
+            throw new Error(`Missing route param: ${paramName}`);
+        }
+        return encodeURIComponent(String(value));
+    });
+}

package/dist/ApiRoutes.json

@@ -0,0 +1,184 @@
+{
+    "AUTH": {
+        "ME": "/me",
+        "LOGIN": "/login",
+        "LOGIN_URL": "/login/url",
+        "LOGOUT": "/logout",
+        "LOGOUT_URL": "/logout/url",
+        "GITHUB_APP_CALLBACK": "/auth/github-app/callback",
+        "WORKOS_CALLBACK": "/auth/workos/callback"
+    },
+    "WORKOS": {
+        "WIDGET_TOKEN": "/auth/workos/widget-token"
+    },
+    "ORGANIZATIONS": {
+        "CREATE": "/organizations",
+        "GET_CURRENT": "/organizations/current",
+        "LIST": "/organizations",
+        "SWITCH": "/organizations/switch",
+        "UPDATE": "/organizations",
+        "LOGO_UPLOAD_URL": "/organizations/logo/upload-url",
+        "LOGO": "/organizations/:organizationId/logo"
+    },
+    "STATS": "/stats",
+    "RUN_HISTORY": {
+        "ALL": "/run-history",
+        "ACTIONS": "/run-history/actions",
+        "BY_AGENT_ID": "/run-history/:agentId",
+        "CHAT_BY_RUN_ID": "/run-history/:runId/chat"
+    },
+    "SESSION": {
+        "TOKEN": "/session/token"
+    },
+    "GITHUB": {
+        "INTEGRATIONS": "/github/integrations",
+        "INSTALLATION_URL": "/github/installation-url",
+        "GET_REPOSITORIES_FOR_INTEGRATION": "/github/get-repositories-for-integration",
+        "INSTALLATION_CALLBACK": "/github/installation-callback",
+        "INSTALLATION_DELETED": "/github/installation-deleted",
+        "UNIFIED_EVENT": "/github/unified-event"
+    },
+    "ATLASSIAN": {
+        "INTEGRATIONS": "/atlassian/integrations",
+        "OAUTH_CALLBACK": "/atlassian/oauth/callback"
+    },
+    "JIRA": {
+        "RESOURCES": "/jira/resources",
+        "GET_API_KEY": "/jira/get-api-key",
+        "SET_API_KEY": "/jira/set-api-key",
+        "VALIDATE_AND_FETCH_PROJECTS": "/jira/validate-and-fetch-projects",
+        "DELETE_CREDENTIALS": "/jira/delete-credentials"
+    },
+    "CONFLUENCE": {
+        "INTEGRATIONS": "/confluence/integrations",
+        "RESOURCES": "/confluence/resources"
+    },
+    "GMAIL": {
+        "INTEGRATIONS": "/gmail/integrations",
+        "CALLBACK": "/gmail/callback",
+        "DELETE_INTEGRATION": "/gmail/delete-integration"
+    },
+    "NOTION": {
+        "INTEGRATIONS": "/notion/integrations",
+        "OAUTH_CALLBACK": "/notion/oauth/callback",
+        "RESOURCES": "/notion/resources",
+        "DELETE_INTEGRATION": "/notion/delete-integration"
+    },
+    "FIGMA": {
+        "INTEGRATIONS": "/figma/integrations",
+        "OAUTH_CALLBACK": "/figma/oauth/callback"
+    },
+    "LINEAR": {
+        "OAUTH_CALLBACK": "/linear/oauth/callback",
+        "WEBHOOK": "/linear/webhook",
+        "INTEGRATIONS": "/linear/integrations",
+        "TEAMS": "/linear/teams"
+    },
+    "SLACK": {
+        "INTEGRATIONS": "/slack/integrations",
+        "GET_CURRENT_INTEGRATION": "/slack/get-current-integration",
+        "OAUTH_CALLBACK": "/slack/oauth-callback",
+        "CHANNELS": "/slack/channels",
+        "USERS": "/slack/users",
+        "EVENTS": "/slack/events"
+    },
+    "POSTHOG": {
+        "INTEGRATIONS": "/posthog/integrations",
+        "PROJECTS": "/posthog/projects"
+    },
+    "LAUNCHDARKLY": {
+        "INTEGRATIONS": "/launchdarkly/integrations",
+        "PROJECTS_BY_INTEGRATION_ID": "/launchdarkly/integrations/:integrationId/projects",
+        "ENVIRONMENTS_BY_INTEGRATION_AND_PROJECT": "/launchdarkly/integrations/:integrationId/projects/:projectKey/environments"
+    },
+    "DATADOG": {
+        "INTEGRATIONS": "/datadog/integrations",
+        "INDEXES": "/datadog/indexes"
+    },
+    "WORKOS_INTEGRATION": {
+        "INTEGRATIONS": "/workos-integration/integrations",
+        "WEBHOOK_SECRET": "/workos-integration/webhook-secret"
+    },
+    "SNOWFLAKE": {
+        "INTEGRATIONS": "/snowflake/integrations"
+    },
+    "ATTIO": {
+        "INTEGRATIONS": "/attio/integrations",
+        "OAUTH_CALLBACK": "/attio/oauth/callback",
+        "OBJECTS": "/attio/integrations/:integrationId/objects"
+    },
+    "AGENTS": {
+        "LIST": "/agents",
+        "RECENT": "/agents/recent",
+        "BY_ID": "/agents/:id"
+    },
+    "IMPROVEMENTS": {
+        "BY_AGENT_ID": "/agents/:agentId/improvements",
+        "APPLY": "/agents/:agentId/improvements/:id/apply",
+        "DISMISS": "/agents/:agentId/improvements/:id/dismiss",
+        "UNDO_DISMISS": "/agents/:agentId/improvements/:id/undo-dismiss",
+        "TOGGLE_ENABLED": "/agents/:agentId/improvements-enabled"
+    },
+    "TEMPLATES": "/templates",
+    "PUBLIC": {
+        "TEMPLATES": "/public/templates"
+    },
+    "TOOLS": {
+        "THAT_REQUIRE_APPROVALS": "/tools/that-require-approvals"
+    },
+    "INTEGRATIONS": {
+        "INSTALLATION_DETAILS_BY_TYPE": "/integrations/:integrationType/installation-details",
+        "LIST": "/integrations",
+        "ACTIVE": "/integrations/active"
+    },
+    "NOTIFICATION_DESTINATIONS": {
+        "LIST": "/notification-destinations",
+        "BY_ID": "/notification-destinations/:id"
+    },
+    "API_TOKENS": {
+        "LIST": "/api-tokens",
+        "BY_ID": "/api-tokens/:id"
+    },
+    "SDK": {
+        "ME": "/sdk/me",
+        "SAMPLE_EVENTS": "/sdk/sample-events",
+        "TOOL_EXECUTE": "/sdk/tool-execute",
+        "TOOL_DEFINITIONS": "/sdk/tool-definitions",
+        "AGENT_RUN": "/sdk/agent-run",
+        "APPROVAL_DECISION": "/sdk/approval-decision",
+        "SESSION_EVENTS": "/sdk/session-events",
+        "DEPLOY": "/sdk/deploy",
+        "DEVICE_TOKEN_EXCHANGE": "/sdk/auth/device-token-exchange",
+        "INTEGRATION_FIELDS": "/sdk/integrations/:integrationType/fields",
+        "INTEGRATION_FORM_SUBMIT": "/sdk/integrations/:integrationType/form-submit"
+    },
+    "NOTIFICATION_SETTINGS": "/notification-settings",
+    "SENT_NOTIFICATIONS": {
+        "LIST": "/sent-notifications"
+    },
+    "PENDING_APPROVALS": {
+        "LIST": "/pending-approvals"
+    },
+    "WEBHOOKS": {
+        "GMAIL": "/webhooks/gmail",
+        "FIGMA": "/webhooks/figma",
+        "WORKOS": "/webhooks/workos",
+        "JIRA_BY_ACCOUNT_ID": "/webhooks/jira/:accountId",
+        "LINEAR_BY_USER_ID": "/webhooks/linear/:userId",
+        "SCHEDULE_BY_INPUT_ID": "/webhooks/schedule/:inputId",
+        "WORKOS_TRIGGER_BY_INTEGRATION_ID": "/webhooks/workos-trigger/:integrationId"
+    },
+    "SCHEDULE": {
+        "TRIGGER_BY_INPUT_ID": "/schedule/trigger/:inputId",
+        "TRIGGER_WITH_EVENT": "/schedule/trigger-with-event/:automationId"
+    },
+    "REFRESH_TOKENS": "/refresh-tokens",
+    "REVIEW_AGENTS": "/review-agents",
+    "USERS": {
+        "CREATE": "/users",
+        "BY_ID": "/users/:id"
+    },
+    "BUILDER_CHAT": {
+        "HISTORY_BY_SESSION_ID": "/builder-chat/:sessionId/history"
+    }
+}

package/dist/ApprovalTypes.d.ts

@@ -0,0 +1,28 @@
+import { IntegrationType } from "./Integrations.js";
+export type ApprovalActionType = "open_run_history" | "approve_action" | "reject_action";
+export type ApprovalRequestStatus = "pending" | "in_progress" | "completed";
+export type ApprovalRequestFilter = ApprovalRequestStatus | "all";
+export type ApprovalAction = {
+    type: ApprovalActionType;
+    label: string;
+    deepLink: string;
+};
+export type ApprovalRequest = {
+    id: string;
+    icon: IntegrationType;
+    title: string;
+    subheader: string;
+    timestamp: string;
+    status: ApprovalRequestStatus;
+    actions: ApprovalAction[];
+    runId: string;
+    agentId: string;
+};
+export type GetPendingApprovalsResponse = {
+    items: ApprovalRequest[];
+};
+export declare function parseDeepLink(deepLink: string): {
+    type: string;
+    params: string[];
+};
+export declare function encodeDeepLink(type: ApprovalActionType, ...params: string[]): string;

package/dist/ApprovalTypes.js

@@ -0,0 +1,7 @@
+export function parseDeepLink(deepLink) {
+    const parts = deepLink.split("|");
+    return { type: parts[0], params: parts.slice(1) };
+}
+export function encodeDeepLink(type, ...params) {
+    return [type, ...params].join("|");
+}

package/dist/ClientBoundTools.d.ts

@@ -0,0 +1,36 @@
+export interface ClientBoundTool<T = any> {
+    id: string;
+    parseParameters(parameters: string): T;
+}
+export declare function createClientBoundTool<T>(tool: Omit<ClientBoundTool<T>, "parseParameters">): ClientBoundTool<T>;
+export interface ShowTypeToUserParameters {
+    items: {
+        type: string;
+        id: string;
+    }[];
+}
+export interface ShowOrganizationSummaryParameters {
+    description: string;
+}
+export interface ShowOrganizationNameParameters {
+    name: string;
+}
+export interface CreateOrganizationParameters {
+    name: string;
+    description: string;
+}
+export interface SetComponentsForOrganizationParameters {
+    components: string[];
+}
+export interface RequestConfirmationParameters {
+    message: string;
+}
+export interface InviteUsersParameters {
+    inOrg: string[];
+    notInOrg: string[];
+    currentUser: string;
+    currentUserInList: boolean;
+    inInvitations: string[];
+}
+export declare const clientBoundTools: readonly [ClientBoundTool<ShowTypeToUserParameters>, ClientBoundTool<ShowOrganizationSummaryParameters>, ClientBoundTool<ShowOrganizationNameParameters>, ClientBoundTool<CreateOrganizationParameters>, ClientBoundTool<SetComponentsForOrganizationParameters>, ClientBoundTool<RequestConfirmationParameters>, ClientBoundTool<InviteUsersParameters>];
+export declare const clientBoundToolIds: string[];

package/dist/ClientBoundTools.js

@@ -0,0 +1,36 @@
+// Helper function to create a client-bound tool with type safety
+export function createClientBoundTool(tool) {
+    return {
+        ...tool,
+        parseParameters(parameters) {
+            console.log("Parsing parameters", parameters);
+            return JSON.parse(parameters);
+        }
+    };
+}
+// Create the tools with type safety
+export const clientBoundTools = [
+    createClientBoundTool({
+        id: "Show_Type_To_User"
+    }),
+    createClientBoundTool({
+        id: "Show_User_Provided_Organization_Summary"
+    }),
+    createClientBoundTool({
+        id: "Show_Organization_Name"
+    }),
+    createClientBoundTool({
+        id: "Create_Organization"
+    }),
+    createClientBoundTool({
+        id: "Set_Components_For_Organization"
+    }),
+    createClientBoundTool({
+        id: "Request_Confirmation"
+    }),
+    createClientBoundTool({
+        id: "Set_Users_For_Organization"
+    })
+];
+// Extract the tool IDs for runtime checking
+export const clientBoundToolIds = clientBoundTools.map(tool => tool.id);