@vornrun/connector-linear 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to `@vornrun/connector-linear`.
+
+## 0.1.2
+
+Read the version from the bundle instead of a package.json the packed connector does not carry.
+
+## 0.1.1
+
+Declares how it signs in: it asks for an API key, so the app can say so before
+anyone installs it. Ships a conformance receipt.
+
+## 0.1.0
+
+First release.
+
+Trigger a workflow from Linear issues, and let a workflow step write back.
+
+- **Trigger:** `issueCreated`.
+- **Actions:** `commentOnIssue`, `createIssue`, `closeIssue`.
+- **Signing in:** a Linear personal API key, created at
+  linear.app/settings/api.
+
+Status is mapped from Linear's state _type_ rather than its name, so a team can
+rename "In Progress" to whatever it likes without breaking the mapping.
+
+Built against Linear's GraphQL API directly rather than on their SDK. The SDK is
+a generated client over the whole schema — megabytes of types for the four
+queries and three mutations this needs — and `npx` pays that download on every
+launch.

package/README.md

@@ -0,0 +1,63 @@
+# @vornrun/connector-linear
+
+Trigger Vorn workflows from Linear issues, and comment on, create or close them
+from a workflow step.
+
+## Signing in
+
+Create a personal API key at [linear.app/settings/api](https://linear.app/settings/api)
+and paste it into the connection. It is stored encrypted by Vorn, in the OS
+keychain, and never printed.
+
+A personal key acts as you and needs nobody's approval to create. There is no
+Linear CLI to borrow a login from, which is why this connector asks for a secret
+where `ado`, `kusto` and `github` do not.
+
+## Settings
+
+| Field | Required | What it does |
+| --- | --- | --- |
+| `apiKey` | yes | Personal API key from linear.app/settings/api |
+| `teamKey` | no | Upper-case key such as `ENG`. Blank for every team you can see. |
+| `stateType` | no | One of `backlog`, `unstarted`, `started`, `completed`, `canceled`. Blank for all. |
+| `limit` | no | Upper bound on issues read in one poll |
+
+## Trigger
+
+**An issue is created or changed.** Fires for each issue the query returns that
+Vorn has not already seen at that timestamp.
+
+Status is mapped from Linear's state **type**, not its name, so a team can
+rename "In Progress" to anything it likes and the mapping still holds:
+
+| Linear state type | Task status |
+| --- | --- |
+| `backlog`, `unstarted` | `todo` |
+| `started` | `in_progress` |
+| `completed` | `done` |
+| `canceled` | `cancelled` |
+
+## Actions
+
+| Action | What it does |
+| --- | --- |
+| `commentOnIssue` | Post a comment; takes an identifier such as `ENG-123` |
+| `createIssue` | Open an issue; returns its identifier and url |
+| `closeIssue` | Move an issue to the first completed state its team defines |
+
+`closeIssue` is idempotent — closing a closed issue leaves it closed. The other
+two are not: calling them twice writes twice.
+
+## Built from
+
+Linear's [GraphQL API](https://linear.app/developers/graphql), queried directly
+rather than through their SDK.
+
+The SDK is a generated client over the whole schema — megabytes of types for the
+four queries and three mutations this needs — and because Vorn launches a
+connector with `npx -y`, that download would be paid on every cold start rather
+than once at install. The house rule is to prefer the vendor's SDK; this is the
+documented exception, and the reason is in `src/client.ts`.
+
+The API key is sent as a raw `Authorization` header with **no `Bearer` prefix**,
+which is what Linear expects for personal keys.

package/dist/index.d.ts

@@ -23,4 +23,4 @@ declare function createLinearConnector(options?: LinearConnectorOptions): _vornr
 
 declare const linearConnector: _vornrun_connector_sdk.Connector;
 
-export { type LinearConnectorOptions, createLinearConnector, linearConnector };
+export { type LinearConnectorOptions, linearConnector as connector, createLinearConnector, linearConnector as default, linearConnector };

package/dist/index.js

@@ -1,8 +1,5 @@
 #!/usr/bin/env node
 
-// src/index.ts
-import { createRequire } from "module";
-
 // src/connector.ts
 import { defineConnector } from "@vornrun/connector-sdk";
 
@@ -172,6 +169,7 @@ function createLinearConnector(options = {}) {
         "M5.663 5.595c3.518-3.474 9.186-3.46 12.687.04 3.501 3.501 3.515 9.169.041 12.687z"
       ]
     },
+    auth: { rung: "key", keys: ["apiKey"] },
     config: [
       {
         key: "apiKey",
@@ -352,11 +350,64 @@ function serveIfEntryPoint(connector, moduleUrl, serve = serveConnector) {
   return true;
 }
 
+// package.json
+var package_default = {
+  name: "@vornrun/connector-linear",
+  version: "0.1.2",
+  description: "Trigger workflows from Linear issues.",
+  type: "module",
+  license: "MIT",
+  repository: {
+    type: "git",
+    url: "git+https://github.com/vorn-run/connectors.git",
+    directory: "packages/linear"
+  },
+  bin: {
+    "vorn-connector-linear": "dist/index.js"
+  },
+  main: "./dist/index.js",
+  files: [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  scripts: {
+    build: "tsup src/index.ts --format esm --target node22 --clean",
+    typecheck: "tsc --noEmit",
+    test: "vitest run"
+  },
+  dependencies: {
+    "@vornrun/connector-sdk": "^0.7.0-beta.10"
+  },
+  devDependencies: {
+    "@types/node": "^22.10.2",
+    "@vitest/coverage-v8": "^4.1.10",
+    tsup: "^8.5.1",
+    typescript: "^6.0.3",
+    vitest: "^4.1.10"
+  },
+  vorn: {
+    category: "Development",
+    keywords: [
+      "linear",
+      "issues",
+      "tickets",
+      "engineering",
+      "backlog"
+    ],
+    auth: "Uses a Linear personal API key, created at linear.app/settings/api.",
+    packs: true
+  }
+};
+
 // src/index.ts
-var { version } = createRequire(import.meta.url)("../package.json");
+var { version } = package_default;
 var linearConnector = createLinearConnector({ version });
+var index_default = linearConnector;
 serveIfEntryPoint(linearConnector, import.meta.url);
 export {
+  linearConnector as connector,
   createLinearConnector,
+  index_default as default,
   linearConnector
 };

package/package.json

@@ -1,20 +1,22 @@
 {
   "name": "@vornrun/connector-linear",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Trigger workflows from Linear issues.",
   "type": "module",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vorn-run/connectors.git",
-    "directory": "packages/ado"
+    "directory": "packages/linear"
   },
   "bin": {
     "vorn-connector-linear": "dist/index.js"
   },
   "main": "./dist/index.js",
   "files": [
-    "dist"
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "build": "tsup src/index.ts --format esm --target node22 --clean",
@@ -22,8 +24,7 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@vornrun/connector-sdk": "^0.5.7",
-    "zod": "^4.4.3"
+    "@vornrun/connector-sdk": "^0.7.0-beta.10"
   },
   "devDependencies": {
     "@types/node": "^22.10.2",
@@ -41,6 +42,7 @@
       "engineering",
       "backlog"
     ],
-    "auth": "Uses a Linear personal API key, created at linear.app/settings/api."
+    "auth": "Uses a Linear personal API key, created at linear.app/settings/api.",
+    "packs": true
   }
 }