@squidcloud/linear-client 1.0.425

package/dist/connectors/linear/common/src/linear-types.d.ts

@@ -0,0 +1,161 @@
+import { IntegrationId } from '../../../../internal-common/src/public-types/communication.public-types';
+/**
+ * Linear API Types - Shared between backend and client
+ */
+export type LinearPriority = 0 | 1 | 2 | 3 | 4;
+export declare const PRIORITY_LABELS: Record<LinearPriority, string>;
+export interface LinearTeam {
+    id: string;
+    name: string;
+    key: string;
+    description?: string;
+}
+export interface LinearUser {
+    id: string;
+    name: string;
+    displayName: string;
+    email: string;
+}
+export interface LinearWorkflowState {
+    id: string;
+    name: string;
+    type: 'backlog' | 'unstarted' | 'started' | 'completed' | 'canceled';
+    color: string;
+}
+export interface LinearComment {
+    id: string;
+    body: string;
+    createdAt: string;
+    updatedAt: string;
+    user?: LinearUser;
+}
+export interface LinearIssue {
+    id: string;
+    identifier: string;
+    title: string;
+    description?: string;
+    priority: LinearPriority;
+    url: string;
+    createdAt: string;
+    updatedAt: string;
+    state?: LinearWorkflowState;
+    team?: LinearTeam;
+    assignee?: LinearUser;
+}
+export type LinearWebhookAction = 'create' | 'update' | 'remove';
+export type LinearWebhookType = 'Issue' | 'Comment' | 'Project' | 'Cycle' | 'IssueLabel';
+export interface LinearWebhookPayload {
+    action: LinearWebhookAction;
+    type: LinearWebhookType;
+    createdAt: string;
+    data: Record<string, unknown>;
+    url?: string;
+    organizationId: string;
+    webhookId: string;
+    webhookTimestamp: number;
+}
+export interface LinearIssueWebhookData {
+    id: string;
+    identifier: string;
+    title: string;
+    description?: string;
+    priority: number;
+    teamId: string;
+    stateId: string;
+    assigneeId?: string;
+    creatorId?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface LinearCommentWebhookData {
+    id: string;
+    body: string;
+    issueId: string;
+    userId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Request to search Linear issues */
+export interface SearchLinearIssuesRequest {
+    /** The ID of the Linear integration */
+    integrationId: IntegrationId;
+    /** The search query to find issues */
+    query: string;
+    /** Optional comma-separated list of team names or keys to filter by */
+    teamNames?: string;
+    /** Maximum number of issues to return (default: 50) */
+    limit?: number;
+}
+/** Request to get details of a Linear issue */
+export interface GetLinearIssueRequest {
+    /** The ID of the Linear integration */
+    integrationId: IntegrationId;
+    /** The Linear issue ID or identifier (e.g., "ENG-123") */
+    issueId: string;
+}
+/** Request to update a Linear issue */
+export interface UpdateLinearIssueRequest {
+    /** The ID of the Linear integration */
+    integrationId: IntegrationId;
+    /** The Linear issue ID or identifier (e.g., "ENG-123") */
+    issueId: string;
+    /** New title for the issue */
+    title?: string;
+    /** New description for the issue */
+    description?: string;
+    /** New priority level: 0=No priority, 1=Urgent, 2=High, 3=Medium, 4=Low */
+    priority?: LinearPriority;
+    /** Email of the user to assign the issue to */
+    assigneeEmail?: string;
+}
+/** Request to add a comment to a Linear issue */
+export interface AddLinearCommentRequest {
+    /** The ID of the Linear integration */
+    integrationId: IntegrationId;
+    /** The Linear issue ID or identifier (e.g., "ENG-123") */
+    issueId: string;
+    /** The comment text (supports markdown) */
+    body: string;
+}
+/** Request to create a Linear issue */
+export interface CreateLinearIssueRequest {
+    /** The ID of the Linear integration */
+    integrationId: IntegrationId;
+    /** The title of the issue */
+    title: string;
+    /** The description of the issue (supports markdown) */
+    description?: string;
+    /** The name or key of the team to create the issue in */
+    teamName: string;
+    /** Priority level: 0=No priority, 1=Urgent, 2=High, 3=Medium, 4=Low */
+    priority?: LinearPriority;
+    /** Email of the user to assign the issue to */
+    assigneeEmail?: string;
+}
+/** Response from Linear issue operations */
+export interface LinearIssueResponse {
+    /** Issue identifier (e.g., "ENG-123") */
+    identifier: string;
+    /** Issue title */
+    title: string;
+    /** Issue URL */
+    url: string;
+}
+/** Response from listing teams */
+export interface LinearTeamResponse {
+    /** Team key (e.g., "ENG") */
+    key: string;
+    /** Team name */
+    name: string;
+    /** Team description */
+    description?: string;
+}
+/** Request to extract and validate Linear webhook data */
+export interface ExtractLinearWebhookRequest {
+    /** The ID of the Linear integration */
+    integrationId: IntegrationId;
+    /** The raw body of the webhook request as a string */
+    rawBody: string;
+    /** The headers from the webhook request */
+    headers: Record<string, string | undefined>;
+}

package/dist/connectors/linear/linear-client/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from '../../common/src/linear-types';
+export * from './linear-client';

package/dist/connectors/linear/linear-client/src/linear-client.d.ts

@@ -0,0 +1,77 @@
+import { Squid } from '@squidcloud/client';
+import { CreateLinearIssueRequest, LinearIssueResponse, LinearTeamResponse, LinearWebhookPayload, SearchLinearIssuesRequest, UpdateLinearIssueRequest } from '../../common/src/linear-types';
+/**
+ * Client for interacting with the Linear connector.
+ *
+ * Provides methods to search, create, update issues, add comments,
+ * and extract webhook data from Linear webhooks.
+ */
+export declare class SquidLinearClient {
+    private readonly squid;
+    private readonly integrationId;
+    /**
+     * Creates a new Linear client instance.
+     *
+     * @param squid - Squid client instance. Provide an instance that includes the Squid API key.
+     * @param integrationId - The ID of the Linear integration in the Squid console.
+     */
+    constructor(squid: Squid, integrationId: string);
+    /**
+     * Search for Linear issues by text query.
+     *
+     * Returns issues matching the search term in title, description, or identifier.
+     *
+     * @param request - Search parameters.
+     * @returns Formatted string with matching issues.
+     */
+    searchIssues(request: Omit<SearchLinearIssuesRequest, 'integrationId'>): Promise<string>;
+    /**
+     * Get detailed information about a specific Linear issue.
+     *
+     * @param issueId - The Linear issue ID or identifier (e.g., "ENG-123").
+     * @returns Formatted string with issue details including comments.
+     */
+    getIssue(issueId: string): Promise<string>;
+    /**
+     * Update an existing Linear issue.
+     *
+     * @param request - Update parameters including issue ID and fields to update.
+     * @returns The updated issue information.
+     */
+    updateIssue(request: Omit<UpdateLinearIssueRequest, 'integrationId'>): Promise<LinearIssueResponse>;
+    /**
+     * Add a comment to a Linear issue.
+     *
+     * @param issueId - The Linear issue ID or identifier (e.g., "ENG-123").
+     * @param body - The comment text (supports markdown).
+     * @returns The created comment ID.
+     */
+    addComment(issueId: string, body: string): Promise<{
+        commentId: string;
+    }>;
+    /**
+     * Create a new Linear issue.
+     *
+     * @param request - Create parameters including title, team, and optional fields.
+     * @returns The created issue information.
+     */
+    createIssue(request: Omit<CreateLinearIssueRequest, 'integrationId'>): Promise<LinearIssueResponse>;
+    /**
+     * List available Linear teams.
+     *
+     * @returns Array of teams with their key, name, and description.
+     */
+    listTeams(): Promise<Array<LinearTeamResponse>>;
+    /**
+     * Extract and validate Linear webhook data.
+     *
+     * Validates the webhook signature using the configured webhook secret
+     * and parses the webhook payload.
+     *
+     * @param rawBody - The raw body of the webhook request as a string.
+     * @param headers - The headers from the webhook request.
+     * @returns The validated and parsed Linear webhook payload.
+     * @throws Error if the webhook signature is invalid or missing when a secret is configured.
+     */
+    extractWebhookData(rawBody: string, headers: Record<string, string | undefined>): Promise<LinearWebhookPayload>;
+}

package/dist/index.js

@@ -0,0 +1 @@
+(()=>{"use strict";var e={d:(t,n)=>{for(var i in n)e.o(n,i)&&!e.o(t,i)&&Object.defineProperty(t,i,{enumerable:!0,get:n[i]})},o:(e,t)=>Object.prototype.hasOwnProperty.call(e,t),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},t={};e.r(t),e.d(t,{PRIORITY_LABELS:()=>n,SquidLinearClient:()=>i});const n={0:"No priority",1:"Urgent",2:"High",3:"Medium",4:"Low"};class i{constructor(e,t){this.squid=e,this.integrationId=t}async searchIssues(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("searchLinearIssuesExecutable",t)}async getIssue(e){const t={integrationId:this.integrationId,issueId:e};return this.squid.executeFunction("getLinearIssueExecutable",t)}async updateIssue(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("updateLinearIssueExecutable",t)}async addComment(e,t){const n={integrationId:this.integrationId,issueId:e,body:t};return this.squid.executeFunction("addLinearCommentExecutable",n)}async createIssue(e){const t={...e,integrationId:this.integrationId};return this.squid.executeFunction("createLinearIssueExecutable",t)}async listTeams(){return this.squid.executeFunction("listLinearTeamsExecutable",{integrationId:this.integrationId})}async extractWebhookData(e,t){const n={integrationId:this.integrationId,rawBody:e,headers:t};return this.squid.executeFunction("extractLinearWebhookData",n)}}var s=exports;for(var r in t)s[r]=t[r];t.__esModule&&Object.defineProperty(s,"__esModule",{value:!0})})();

package/dist/internal-common/src/public-types/communication.public-types.d.ts

@@ -0,0 +1,30 @@
+/** A type alias for an application id. */
+export type AppId = string;
+/** A tuple of environment identifiers like 'dev' or 'prod'. */
+export declare const ENVIRONMENT_IDS: readonly ["dev", "prod"];
+/** A type representing valid environment identifiers derived from ENVIRONMENT_IDS. */
+export type EnvironmentId = (typeof ENVIRONMENT_IDS)[number];
+/** A type alias for a squid developer identifier. */
+export type SquidDeveloperId = string;
+/** A type alias for an integration id. */
+export type IntegrationId = string;
+/** A type alias for a client identifier. */
+export type ClientId = string;
+/** A type alias for a squid document identifier. */
+export type SquidDocId = string;
+/** A type alias for a client request identifier. */
+export type ClientRequestId = string;
+/** ID of AI agent. Also known as AI profile id. */
+export type AiAgentId = string;
+/** App-level ID of AI Knowledge Base */
+export type AiKnowledgeBaseId = string;
+/**
+ * The built-in agent id. Cannot be customized.
+ * @category AI
+ */
+export declare const BUILT_IN_AGENT_ID = "built_in_agent";
+/**
+ * A type alias for an AI context identifier.
+ * @category AI
+ */
+export type AiContextId = string;

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@squidcloud/linear-client",
+  "version": "1.0.425",
+  "description": "Squid Linear Client - SDK for interacting with the Linear connector",
+  "main": "dist/index.js",
+  "types": "dist/linear-client/src/index.d.ts",
+  "scripts": {
+    "prebuild": "del-cli dist",
+    "build": "webpack --mode=production",
+    "lint": "eslint",
+    "publish:public": "npm run build && npm publish --access public"
+  },
+  "files": [
+    "dist/**/*"
+  ],
+  "keywords": [
+    "squid",
+    "linear",
+    "issue-tracking",
+    "connector"
+  ],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "assertic": "^1.3.0",
+    "@squidcloud/client": "^1.0.425"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  }
+}