extract completionPercentage to separate method

.env.sample

@@ -127,6 +127,10 @@ GITHUB_APP_NAME=
 GITHUB_APP_ID=
 GITHUB_APP_PRIVATE_KEY=
 
+# Linear
+LINEAR_CLIENT_ID=
+LINEAR_CLIENT_SECRET=
+
 # To configure Discord auth, you'll need to create a Discord Application at
 # => https://discord.com/developers/applications/
 #

app/components/HoverPreview/HoverPreviewIssue.tsx

@@ -1,7 +1,11 @@
 import * as React from "react";
 import { Trans } from "react-i18next";
 import { IssueStatusIcon } from "@shared/components/IssueStatusIcon";
-import { UnfurlResourceType, UnfurlResponse } from "@shared/types";
+import {
+  IntegrationService,
+  UnfurlResourceType,
+  UnfurlResponse,
+} from "@shared/types";
 import { Avatar } from "~/components/Avatar";
 import Flex from "~/components/Flex";
 import Text from "../Text";
@@ -23,6 +27,11 @@ const HoverPreviewIssue = React.forwardRef(function _HoverPreviewIssue(
   ref: React.Ref<HTMLDivElement>
 ) {
   const authorName = author.name;
+  const urlObj = new URL(url);
+  const service =
+    urlObj.hostname === "github.com"
+      ? IntegrationService.GitHub
+      : IntegrationService.Linear;
 
   return (
     <Preview as="a" href={url} target="_blank" rel="noopener noreferrer">
@@ -31,7 +40,7 @@ const HoverPreviewIssue = React.forwardRef(function _HoverPreviewIssue(
           <CardContent>
             <Flex gap={2} column>
               <Title>
-                <IssueStatusIcon status={state.name} color={state.color} />
+                <IssueStatusIcon service={service} state={state} />
                 <span>
                   {title}&nbsp;<Text type="tertiary">{id}</Text>
                 </span>

app/stores/IntegrationsStore.ts

@@ -21,6 +21,13 @@ class IntegrationsStore extends Store<Integration> {
       (integration) => integration.service === IntegrationService.GitHub
     );
   }
+
+  @computed
+  get linear(): Integration<IntegrationType.Embed>[] {
+    return this.orderedData.filter(
+      (integration) => integration.service === IntegrationService.Linear
+    );
+  }
 }
 
 export default IntegrationsStore;

app/utils/mention.ts

@@ -27,6 +27,16 @@ export const isURLMentionable = ({
       );
     }
 
+    case IntegrationService.Linear: {
+      const settings =
+        integration.settings as IntegrationSettings<IntegrationType.Embed>;
+
+      return (
+        hostname === "linear.app" &&
+        settings.linear?.workspace.key === pathParts[1] // ensure installed workspace key matches with the provided url.
+      );
+    }
+
     default:
       return false;
   }
@@ -52,6 +62,11 @@ export const determineMentionType = ({
         : undefined;
     }
 
+    case IntegrationService.Linear: {
+      const type = pathParts[2];
+      return type === "issue" ? MentionType.Issue : undefined;
+    }
+
     default:
       return;
   }

package.json

@@ -79,6 +79,7 @@
     "@hocuspocus/server": "1.1.2",
     "@joplin/turndown-plugin-gfm": "^1.0.49",
     "@juggle/resize-observer": "^3.4.0",
+    "@linear/sdk": "^39.0.0",
     "@notionhq/client": "^2.3.0",
     "@octokit/auth-app": "^6.1.3",
     "@outlinewiki/koa-passport": "^4.2.1",

plugins/linear/client/Icon.tsx

@@ -0,0 +1,41 @@
+import * as React from "react";
+
+type Props = {
+  /** The size of the icon, 24px is default to match standard icons */
+  size?: number;
+  /** The color of the icon, defaults to the current text color */
+  fill?: string;
+};
+
+export default function Icon({ size = 24, fill = "currentColor" }: Props) {
+  return (
+    <svg
+      fill={fill}
+      width={size}
+      height={size}
+      viewBox="0 0 24 24"
+      version="1.1"
+    >
+      <path
+        d="M3.93091 12.8481C4.11753 14.6298 4.89358 16.3615 6.25902 17.727C7.62446 19.0923 9.35612 19.8684 11.1378 20.0551L3.93091 12.8481Z"
+        fillRule="evenodd"
+        clipRule="evenodd"
+      />
+      <path
+        d="M3.89929 11.5437L12.4422 20.0865C13.1671 20.0459 13.8876 19.9084 14.5827 19.6738L4.31194 9.4032C4.07743 10.0982 3.93988 10.8187 3.89929 11.5437Z"
+        fillRule="evenodd"
+        clipRule="evenodd"
+      />
+      <path
+        d="M4.67981 8.49828L15.4875 19.306C16.0482 19.0374 16.5845 18.7005 17.0837 18.2953L5.6905 6.90222C5.28537 7.40142 4.94847 7.93759 4.67981 8.49828Z"
+        fillRule="evenodd"
+        clipRule="evenodd"
+      />
+      <path
+        d="M6.29602 6.23494C9.46213 3.10852 14.5632 3.12079 17.7141 6.27173C20.865 9.42266 20.8774 14.5237 17.7509 17.6898L6.29602 6.23494Z"
+        fillRule="evenodd"
+        clipRule="evenodd"
+      />
+    </svg>
+  );
+}

plugins/linear/client/Settings.tsx

@@ -0,0 +1,140 @@
+import { observer } from "mobx-react";
+import { PlusIcon } from "outline-icons";
+import * as React from "react";
+import { useTranslation, Trans } from "react-i18next";
+import { IntegrationService } from "@shared/types";
+import { ConnectedButton } from "~/scenes/Settings/components/ConnectedButton";
+import { AvatarSize } from "~/components/Avatar";
+import Flex from "~/components/Flex";
+import Heading from "~/components/Heading";
+import List from "~/components/List";
+import ListItem from "~/components/List/Item";
+import Notice from "~/components/Notice";
+import PlaceholderText from "~/components/PlaceholderText";
+import Scene from "~/components/Scene";
+import TeamLogo from "~/components/TeamLogo";
+import Text from "~/components/Text";
+import Time from "~/components/Time";
+import env from "~/env";
+import useQuery from "~/hooks/useQuery";
+import useStores from "~/hooks/useStores";
+import LinearIcon from "./Icon";
+import { LinearConnectButton } from "./components/LinearButton";
+
+function Linear() {
+  const { integrations } = useStores();
+  const { t } = useTranslation();
+  const query = useQuery();
+  const error = query.get("error");
+  const appName = env.APP_NAME;
+
+  React.useEffect(() => {
+    void integrations.fetchAll({
+      service: IntegrationService.Linear,
+      withRelations: true,
+    });
+  }, [integrations]);
+
+  return (
+    <Scene title="Linear" icon={<LinearIcon />}>
+      <Heading>Linear</Heading>
+
+      {error === "access_denied" && (
+        <Notice>
+          <Trans>
+            Whoops, you need to accept the permissions in Linear to connect{" "}
+            {{ appName }} to your workspace. Try again?
+          </Trans>
+        </Notice>
+      )}
+      {error === "unauthenticated" && (
+        <Notice>
+          <Trans>
+            Something went wrong while authenticating your request. Please try
+            logging in again.
+          </Trans>
+        </Notice>
+      )}
+      {env.LINEAR_CLIENT_ID ? (
+        <>
+          <Text as="p">
+            <Trans>
+              Enable previews of Linear issues in documents by connecting a
+              Linear workspace to {appName}.
+            </Trans>
+          </Text>
+          {integrations.linear.length ? (
+            <>
+              <Heading as="h2">
+                <Flex justify="space-between" auto>
+                  {t("Connected")}
+                  <LinearConnectButton icon={<PlusIcon />} />
+                </Flex>
+              </Heading>
+              <List>
+                {integrations.linear.map((integration) => {
+                  const linearWorkspace =
+                    integration.settings?.linear?.workspace;
+                  const integrationCreatedBy = integration.user
+                    ? integration.user.name
+                    : undefined;
+
+                  return (
+                    <ListItem
+                      key={linearWorkspace?.id}
+                      small
+                      title={linearWorkspace?.name}
+                      subtitle={
+                        integrationCreatedBy ? (
+                          <>
+                            <Trans>Enabled by {{ integrationCreatedBy }}</Trans>{" "}
+                            &middot;{" "}
+                            <Time
+                              dateTime={integration.createdAt}
+                              relative={false}
+                              format={{ en_US: "MMMM d, y" }}
+                            />
+                          </>
+                        ) : (
+                          <PlaceholderText />
+                        )
+                      }
+                      image={
+                        <TeamLogo
+                          src={linearWorkspace?.logoUrl}
+                          size={AvatarSize.Large}
+                        />
+                      }
+                      actions={
+                        <ConnectedButton
+                          onClick={integration.delete}
+                          confirmationMessage={t(
+                            "Disconnecting will prevent previewing Linear links from this workspace in documents. Are you sure?"
+                          )}
+                        />
+                      }
+                    />
+                  );
+                })}
+              </List>
+            </>
+          ) : (
+            <p>
+              <LinearConnectButton icon={<LinearIcon />} />
+            </p>
+          )}
+        </>
+      ) : (
+        <Notice>
+          <Trans>
+            The Linear integration is currently disabled. Please set the
+            associated environment variables and restart the server to enable
+            the integration.
+          </Trans>
+        </Notice>
+      )}
+    </Scene>
+  );
+}
+
+export default observer(Linear);

plugins/linear/client/components/LinearButton.tsx

@@ -0,0 +1,23 @@
+import * as React from "react";
+import { useTranslation } from "react-i18next";
+import Button, { type Props } from "~/components/Button";
+import useCurrentTeam from "~/hooks/useCurrentTeam";
+import { redirectTo } from "~/utils/urls";
+import { LinearUtils } from "../../shared/LinearUtils";
+
+export function LinearConnectButton(props: Props<HTMLButtonElement>) {
+  const { t } = useTranslation();
+  const team = useCurrentTeam();
+
+  return (
+    <Button
+      onClick={() =>
+        redirectTo(LinearUtils.authUrl({ state: { teamId: team.id } }))
+      }
+      neutral
+      {...props}
+    >
+      {t("Connect")}
+    </Button>
+  );
+}

plugins/linear/client/index.tsx

@@ -0,0 +1,16 @@
+import * as React from "react";
+import { Hook, PluginManager } from "~/utils/PluginManager";
+import config from "../plugin.json";
+import Icon from "./Icon";
+
+PluginManager.add([
+  {
+    ...config,
+    type: Hook.Settings,
+    value: {
+      group: "Integrations",
+      icon: Icon,
+      component: React.lazy(() => import("./Settings")),
+    },
+  },
+]);

plugins/linear/plugin.json

@@ -0,0 +1,7 @@
+{
+  "id": "linear",
+  "name": "Linear",
+  "priority": 15,
+  "description": "Adds a Linear integration for link unfurling and converting links to mentions.",
+  "after": "github"
+}

plugins/linear/server/api/linear.ts

@@ -0,0 +1,110 @@
+import Router from "koa-router";
+import { IntegrationService, IntegrationType } from "@shared/types";
+import { parseDomain } from "@shared/utils/domains";
+import Logger from "@server/logging/Logger";
+import auth from "@server/middlewares/authentication";
+import { transaction } from "@server/middlewares/transaction";
+import validate from "@server/middlewares/validate";
+import { IntegrationAuthentication, Integration, Team } from "@server/models";
+import { APIContext } from "@server/types";
+import { Linear } from "../linear";
+import * as T from "./schema";
+import { LinearUtils } from "plugins/linear/shared/LinearUtils";
+
+const router = new Router();
+
+router.get(
+  "linear.callback",
+  auth({
+    optional: true,
+  }),
+  validate(T.LinearCallbackSchema),
+  transaction(),
+  async (ctx: APIContext<T.LinearCallbackReq>) => {
+    const { code, state, error } = ctx.input.query;
+    const { user } = ctx.state.auth;
+    const { transaction } = ctx.state;
+
+    let parsedState;
+    try {
+      parsedState = LinearUtils.parseState(state);
+    } catch {
+      ctx.redirect(LinearUtils.errorUrl("invalid_state"));
+      return;
+    }
+
+    const { teamId } = parsedState;
+
+    // this code block accounts for the root domain being unable to
+    // access authentication for subdomains. We must forward to the appropriate
+    // subdomain to complete the oauth flow
+    if (!user) {
+      if (teamId) {
+        try {
+          const team = await Team.findByPk(teamId, {
+            rejectOnEmpty: true,
+            transaction,
+          });
+          return parseDomain(ctx.host).teamSubdomain === team.subdomain
+            ? ctx.redirect("/")
+            : ctx.redirectOnClient(
+                LinearUtils.callbackUrl({
+                  baseUrl: team.url,
+                  params: ctx.request.querystring,
+                })
+              );
+        } catch (err) {
+          Logger.error(`Error fetching team for teamId: ${teamId}!`, err);
+          return ctx.redirect(LinearUtils.errorUrl("unauthenticated"));
+        }
+      } else {
+        return ctx.redirect(LinearUtils.errorUrl("unauthenticated"));
+      }
+    }
+
+    // Check error after any sub-domain redirection. Otherwise, the user will be redirected to the root domain.
+    if (error) {
+      ctx.redirect(LinearUtils.errorUrl(error));
+      return;
+    }
+
+    // validation middleware ensures that code is non-null at this point.
+    const oauth = await Linear.oauthAccess(code!);
+    const workspace = await Linear.getInstalledWorkspace(oauth.access_token);
+
+    const authentication = await IntegrationAuthentication.create(
+      {
+        service: IntegrationService.Linear,
+        userId: user.id,
+        teamId: user.teamId,
+        token: oauth.access_token,
+        scopes: oauth.scope.split(" "),
+      },
+      { transaction }
+    );
+    await Integration.create<Integration<IntegrationType.Embed>>(
+      {
+        service: IntegrationService.Linear,
+        type: IntegrationType.Embed,
+        userId: user.id,
+        teamId: user.teamId,
+        authenticationId: authentication.id,
+        settings: {
+          linear: {
+            workspace: {
+              id: workspace.id,
+              name: workspace.name,
+              key: workspace.urlKey,
+              logoUrl: workspace.logoUrl,
+            },
+          },
+        },
+      },
+      { transaction }
+    );
+
+    ctx.redirect(LinearUtils.successUrl());
+  }
+);
+
+export default router;

plugins/linear/server/api/schema.ts

@@ -0,0 +1,17 @@
+import isEmpty from "lodash/isEmpty";
+import { z } from "zod";
+import { BaseSchema } from "@server/routes/api/schema";
+
+export const LinearCallbackSchema = BaseSchema.extend({
+  query: z
+    .object({
+      code: z.string().nullish(),
+      state: z.string(),
+      error: z.string().nullish(),
+    })
+    .refine((req) => !(isEmpty(req.code) && isEmpty(req.error)), {
+      message: "one of code or error is required",
+    }),
+});
+
+export type LinearCallbackReq = z.infer<typeof LinearCallbackSchema>;

plugins/linear/server/env.ts

@@ -0,0 +1,25 @@
+import { IsOptional } from "class-validator";
+import { Environment } from "@server/env";
+import { Public } from "@server/utils/decorators/Public";
+import environment from "@server/utils/environment";
+import { CannotUseWithout } from "@server/utils/validators";
+
+class LinearPluginEnvironment extends Environment {
+  /**
+   * Linear OAuth2 app client id. To enable integration with Linear.
+   */
+  @Public
+  @IsOptional()
+  public LINEAR_CLIENT_ID = this.toOptionalString(environment.LINEAR_CLIENT_ID);
+
+  /**
+   * Linear OAuth2 app client secret. To enable integration with Linear.
+   */
+  @IsOptional()
+  @CannotUseWithout("LINEAR_CLIENT_ID")
+  public LINEAR_CLIENT_SECRET = this.toOptionalString(
+    environment.LINEAR_CLIENT_SECRET
+  );
+}
+
+export default new LinearPluginEnvironment();

plugins/linear/server/index.ts

@@ -0,0 +1,27 @@
+import { Minute } from "@shared/utils/time";
+import { Hook, PluginManager } from "@server/utils/PluginManager";
+import config from "../plugin.json";
+import router from "./api/linear";
+import env from "./env";
+import { Linear } from "./linear";
+import { uninstall } from "./uninstall";
+
+const enabled = !!env.LINEAR_CLIENT_ID && !!env.LINEAR_CLIENT_SECRET;
+
+if (enabled) {
+  PluginManager.add([
+    {
+      ...config,
+      type: Hook.API,
+      value: router,
+    },
+    {
+      type: Hook.UnfurlProvider,
+      value: { unfurl: Linear.unfurl, cacheExpiry: Minute.seconds },
+    },
+    {
+      type: Hook.Uninstall,
+      value: uninstall,
+    },
+  ]);
+}

plugins/linear/server/linear.ts

@@ -0,0 +1,204 @@
+import { Issue, LinearClient, WorkflowState } from "@linear/sdk";
+import sortBy from "lodash/sortBy";
+import { z } from "zod";
+import {
+  IntegrationService,
+  IntegrationType,
+  UnfurlResourceType,
+} from "@shared/types";
+import Logger from "@server/logging/Logger";
+import { Integration } from "@server/models";
+import User from "@server/models/User";
+import { UnfurlIssueAndPR, UnfurlSignature } from "@server/types";
+import { LinearUtils } from "../shared/LinearUtils";
+import env from "./env";
+
+const AccessTokenResponseSchema = z.object({
+  access_token: z.string(),
+  token_type: z.string(),
+  expires_in: z.number(),
+  scope: z.string(),
+});
+
+export class Linear {
+  private static supportedUnfurls = [UnfurlResourceType.Issue];
+
+  static async oauthAccess(code: string) {
+    const headers = {
+      "Content-Type": "application/x-www-form-urlencoded",
+      Accept: "application/json",
+    };
+
+    const body = new URLSearchParams();
+    body.set("code", code);
+    body.set("client_id", env.LINEAR_CLIENT_ID!);
+    body.set("client_secret", env.LINEAR_CLIENT_SECRET!);
+    body.set("redirect_uri", LinearUtils.callbackUrl());
+    body.set("grant_type", "authorization_code");
+
+    const res = await fetch(LinearUtils.tokenUrl, {
+      method: "POST",
+      headers,
+      body,
+    });
+
+    return AccessTokenResponseSchema.parse(await res.json());
+  }
+
+  static async revokeAccess(accessToken: string) {
+    const headers = {
+      Authorization: `Bearer ${accessToken}`,
+    };
+
+    await fetch(LinearUtils.revokeUrl, {
+      method: "POST",
+      headers,
+    });
+  }
+
+  static async getInstalledWorkspace(accessToken: string) {
+    const client = new LinearClient({ accessToken });
+    return client.organization;
+  }
+
+  /**
+   *
+   * @param url Linear resource url
+   * @param actor User attempting to unfurl resource url
+   * @returns An object containing resource details e.g, a Linear issue details
+   */
+  static unfurl: UnfurlSignature = async (url: string, actor: User) => {
+    const resource = Linear.parseUrl(url);
+
+    if (!resource) {
+      return;
+    }
+
+    const integration = (await Integration.scope("withAuthentication").findOne({
+      where: {
+        service: IntegrationService.Linear,
+        teamId: actor.teamId,
+        "settings.linear.workspace.key": resource.workspaceKey,
+      },
+    })) as Integration<IntegrationType.Embed>;
+
+    if (!integration) {
+      return;
+    }
+
+    try {
+      const client = new LinearClient({
+        accessToken: integration.authentication.token,
+      });
+      const issue = await client.issue(resource.id);
+
+      if (!issue) {
+        return { error: "Resource not found" };
+      }
+
+      const [author, state, labels] = await Promise.all([
+        issue.creator,
+        issue.state,
+        issue.paginate(issue.labels, {}),
+      ]);
+
+      if (!author || !state || !labels) {
+        return { error: "Failed to fetch auxiliary data from Linear" };
+      }
+
+      const completionPercentage = await Linear.completionPercentage(
+        client,
+        issue,
+        state
+      );
+
+      return {
+        type: UnfurlResourceType.Issue,
+        url: issue.url,
+        id: issue.identifier,
+        title: issue.title,
+        description: issue.description ?? null,
+        author: {
+          name: author.name,
+          avatarUrl: author.avatarUrl ?? "",
+        },
+        labels: labels.map((label) => ({
+          name: label.name,
+          color: label.color,
+        })),
+        state: {
+          type: state.type,
+          name: state.name,
+          color: state.color,
+          completionPercentage,
+        },
+        createdAt: issue.createdAt.toISOString(),
+        transformed_unfurl: true,
+      } satisfies UnfurlIssueAndPR;
+    } catch (err) {
+      Logger.warn("Failed to fetch resource from Linear", err);
+      return { error: err.message || "Unknown error" };
+    }
+  };
+
+  private static async completionPercentage(
+    client: LinearClient,
+    issue: Issue,
+    state: WorkflowState
+  ) {
+    const defaultCompletionPercentage = 0.5; // fallback when we cannot determine actual value.
+
+    if (state.type !== "started") {
+      return defaultCompletionPercentage;
+    }
+
+    const team = await issue.team;
+    if (!team) {
+      return defaultCompletionPercentage;
+    }
+
+    const allStates = await client.paginate(client.workflowStates, {
+      filter: {
+        team: { id: { eq: team.id } },
+        type: { eq: "started" },
+      },
+    });
+    const states = sortBy(
+      allStates.map((s) => ({
+        name: s.name,
+        position: s.position,
+      })),
+      (s) => s.position
+    );
+
+    const idx = states.findIndex((s) => s.name === state.name);
+    return idx !== -1
+      ? (idx + 1) / (states.length + 1) // add 1 to states for the "done" state.
+      : defaultCompletionPercentage;
+  }
+
+  /**
+   * Parses a given URL and returns resource identifiers for Linear specific URLs
+   *
+   * @param url URL to parse
+   * @returns {object} Containing resource identifiers - `workspaceKey`, `type`, `id` and `name`.
+   */
+  private static parseUrl(url: string) {
+    const { hostname, pathname } = new URL(url);
+    if (hostname !== "linear.app") {
+      return;
+    }
+
+    const parts = pathname.split("/");
+    const workspaceKey = parts[1];
+    const type = parts[2] ? (parts[2] as UnfurlResourceType) : undefined;
+    const id = parts[3];
+    const name = parts[4];
+
+    if (!type || !Linear.supportedUnfurls.includes(type)) {
+      return;
+    }
+
+    return { workspaceKey, type, id, name };
+  }
+}

plugins/linear/server/uninstall.ts

@@ -0,0 +1,25 @@
+import { IntegrationService, IntegrationType } from "@shared/types";
+import Logger from "@server/logging/Logger";
+import { Integration } from "@server/models";
+import { Linear } from "./linear";
+
+export async function uninstall(
+  integration: Integration<IntegrationType.Embed>
+) {
+  if (integration.service !== IntegrationService.Linear) {
+    return;
+  }
+
+  const authentication = await integration.$get("authentication");
+
+  if (!authentication) {
+    return;
+  }
+
+  try {
+    await Linear.revokeAccess(authentication.token);
+  } catch (err) {
+    // suppress error since this is a best-effort operation.
+    Logger.error("Failed to revoke Linear access token", err);
+  }
+}

plugins/linear/shared/LinearUtils.ts

@@ -0,0 +1,53 @@
+import queryString from "query-string";
+import env from "@shared/env";
+import { integrationSettingsPath } from "@shared/utils/routeHelpers";
+
+export type OAuthState = {
+  teamId: string;
+};
+
+export class LinearUtils {
+  private static oauthScopes = "read,issues:create";
+
+  public static tokenUrl = "https://api.linear.app/oauth/token";
+  public static revokeUrl = "https://api.linear.app/oauth/revoke";
+  private static authBaseUrl = "https://linear.app/oauth/authorize";
+
+  private static settingsUrl = integrationSettingsPath("linear");
+
+  static parseState(state: string): OAuthState {
+    return JSON.parse(state);
+  }
+
+  static successUrl() {
+    return this.settingsUrl;
+  }
+
+  static errorUrl(error: string) {
+    return `${this.settingsUrl}?error=${error}`;
+  }
+
+  static callbackUrl(
+    { baseUrl, params }: { baseUrl: string; params?: string } = {
+      baseUrl: `${env.URL}`,
+      params: undefined,
+    }
+  ) {
+    return params
+      ? `${baseUrl}/api/linear.callback?${params}`
+      : `${baseUrl}/api/linear.callback`;
+  }
+
+  static authUrl({ state }: { state: OAuthState }) {
+    const params = {
+      client_id: env.LINEAR_CLIENT_ID,
+      redirect_uri: this.callbackUrl(),
+      state: JSON.stringify(state),
+      scope: this.oauthScopes,
+      response_type: "code",
+      prompt: "consent",
+      actor: "application",
+    };
+    return `${this.authBaseUrl}?${queryString.stringify(params)}`;
+  }
+}

shared/components/IssueStatusIcon/GitHubIssueStatusIcon.tsx

@@ -1,43 +1,18 @@
-import * as React from "react";
-import styled from "styled-components";
+import React from "react";
+import { BaseIconProps } from ".";
 
-type Props = {
-  status: string;
-  color: string;
-  size?: number;
-  className?: string;
-};
+export function GitHubIssueStatusIcon(props: BaseIconProps) {
+  const { state, className } = props;
 
-/**
- * Issue status icon based on GitHub issue status, but can be used for any git-style integration.
- */
-export function IssueStatusIcon({ size, ...rest }: Props) {
-  return (
-    <Icon size={size}>
-      <BaseIcon {...rest} />
-    </Icon>
-  );
-}
-
-const Icon = styled.span<{ size?: number }>`
-  display: inline-flex;
-  flex-shrink: 0;
-  width: ${(props) => props.size ?? 24}px;
-  height: ${(props) => props.size ?? 24}px;
-  align-items: center;
-  justify-content: center;
-`;
-
-function BaseIcon(props: Props) {
-  switch (props.status) {
+  switch (state.name) {
     case "open":
       return (
         <svg
           viewBox="0 0 16 16"
           width="16"
           height="16"
-          fill={props.color}
-          className={props.className}
+          fill={state.color}
+          className={className}
         >
           <path d="M8 9.5a1.5 1.5 0 1 0 0-3 1.5 1.5 0 0 0 0 3Z" />
           <path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM1.5 8a6.5 6.5 0 1 0 13 0 6.5 6.5 0 0 0-13 0Z" />
@@ -49,8 +24,8 @@ function BaseIcon(props: Props) {
           viewBox="0 0 16 16"
           width="16"
           height="16"
-          fill={props.color}
-          className={props.className}
+          fill={state.color}
+          className={className}
         >
           <path d="M11.28 6.78a.75.75 0 0 0-1.06-1.06L7.25 8.69 5.78 7.22a.75.75 0 0 0-1.06 1.06l2 2a.75.75 0 0 0 1.06 0l3.5-3.5Z" />
           <path d="M16 8A8 8 0 1 1 0 8a8 8 0 0 1 16 0Zm-1.5 0a6.5 6.5 0 1 0-13 0 6.5 6.5 0 0 0 13 0Z" />
@@ -62,8 +37,8 @@ function BaseIcon(props: Props) {
           viewBox="0 0 16 16"
           width="16"
           height="16"
-          fill={props.color}
-          className={props.className}
+          fill={state.color}
+          className={className}
         >
           <path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0ZM1.5 8a6.5 6.5 0 1 0 13 0 6.5 6.5 0 0 0-13 0Zm9.78-2.22-5.5 5.5a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l5.5-5.5a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Z" />
         </svg>

shared/components/IssueStatusIcon/LinearIssueStatusIcon.tsx

@@ -0,0 +1,75 @@
+import * as React from "react";
+import { useTheme } from "styled-components";
+import { isSafari } from "../../utils/browser";
+import { BaseIconProps } from ".";
+
+enum StateType {
+  Triage = "triage",
+  Backlog = "backlog",
+  Unstarted = "unstarted",
+  Started = "started",
+  Completed = "completed",
+  Canceled = "canceled",
+}
+
+export function LinearIssueStatusIcon(props: BaseIconProps) {
+  const theme = useTheme();
+  const { state } = props;
+  const percentage =
+    state.type === StateType.Triage ||
+    state.type === StateType.Backlog ||
+    state.type === StateType.Unstarted
+      ? 0
+      : state.type === StateType.Started
+      ? state.completionPercentage ?? 0.5
+      : 1;
+  const isTriage = state.type === StateType.Triage;
+  const isBacklog = state.type === StateType.Backlog;
+  const isCompleted = state.type === StateType.Completed;
+  // Due to some rendering issues and differences between browsers, the logical constant 4 in the rendering below
+  // needs to be a bit less to make 50% look like half a circle.
+  const magicFour = isSafari() ? 3.895 : 3.98;
+
+  return (
+    <svg width="14" height="14" viewBox="0 0 14 14" fill="none">
+      <circle
+        cx={7}
+        cy={7}
+        r={isTriage ? 3.5 : 6}
+        fill="none"
+        stroke={state.color}
+        strokeWidth={isTriage ? 7 : 1.5}
+        strokeDasharray={isTriage ? "2 0" : isBacklog ? "1.4 1.74" : "3.14 0"}
+        strokeDashoffset={isTriage ? 3.2 : isBacklog ? 0.65 : -0.7}
+      />
+      <circle
+        cx={7}
+        cy={7}
+        r={percentage === 1 ? 3 : 2}
+        fill="none"
+        stroke={state.color}
+        strokeWidth={percentage === 1 ? 6 : 4}
+        strokeDasharray={`${
+          percentage * Math.PI * (percentage === 1 ? 6 : magicFour)
+        } 100`}
+        strokeDashoffset={0}
+        transform={`rotate(-90 7 7)`}
+      />
+      {(isTriage || percentage === 1) && (
+        <path
+          className="icon"
+          stroke="none"
+          d={isTriage ? triageIcon : isCompleted ? checkMarkIcon : closeIcon}
+          fill={theme.background}
+        />
+      )}
+    </svg>
+  );
+}
+
+const checkMarkIcon =
+  "M10.951 4.24896C11.283 4.58091 11.283 5.11909 10.951 5.45104L5.95104 10.451C5.61909 10.783 5.0809 10.783 4.74896 10.451L2.74896 8.45104C2.41701 8.11909 2.41701 7.5809 2.74896 7.24896C3.0809 6.91701 3.61909 6.91701 3.95104 7.24896L5.35 8.64792L9.74896 4.24896C10.0809 3.91701 10.6191 3.91701 10.951 4.24896Z";
+const triageIcon =
+  "M8.0126 7.98223V9.50781C8.0126 9.92901 8.52329 10.1548 8.85102 9.87854L11.8258 7.37066C12.0581 7.17486 12.0581 6.82507 11.8258 6.62927L8.85102 4.12139C8.52329 3.84509 8.0126 4.07092 8.0126 4.49212V6.01763H5.98739V4.49218C5.98739 4.07098 5.4767 3.84515 5.14897 4.12146L2.17419 6.62933C1.94194 6.82513 1.94194 7.17492 2.17419 7.37072L5.14897 9.8786C5.4767 10.1549 5.98739 9.92907 5.98739 9.50787V7.98223H8.0126Z";
+const closeIcon =
+  "M3.73657 3.73657C4.05199 3.42114 4.56339 3.42114 4.87881 3.73657L5.93941 4.79716L7 5.85775L9.12117 3.73657C9.4366 3.42114 9.94801 3.42114 10.2634 3.73657C10.5789 4.05199 10.5789 4.56339 10.2634 4.87881L8.14225 7L10.2634 9.12118C10.5789 9.4366 10.5789 9.94801 10.2634 10.2634C9.94801 10.5789 9.4366 10.5789 9.12117 10.2634L7 8.14225L4.87881 10.2634C4.56339 10.5789 4.05199 10.5789 3.73657 10.2634C3.42114 9.94801 3.42114 9.4366 3.73657 9.12118L4.79716 8.06059L5.85775 7L3.73657 4.87881C3.42114 4.56339 3.42114 4.05199 3.73657 3.73657Z";

shared/components/IssueStatusIcon/index.tsx

@@ -0,0 +1,42 @@
+import * as React from "react";
+import styled from "styled-components";
+import {
+  IntegrationService,
+  IssueTrackerIntegrationService,
+  UnfurlResourceType,
+  UnfurlResponse,
+} from "../../types";
+import { GitHubIssueStatusIcon } from "./GitHubIssueStatusIcon";
+import { LinearIssueStatusIcon } from "./LinearIssueStatusIcon";
+
+export type BaseIconProps = {
+  state: UnfurlResponse[UnfurlResourceType.Issue]["state"];
+  className?: string;
+};
+
+type Props = BaseIconProps & {
+  size?: number;
+  service: IssueTrackerIntegrationService;
+};
+
+export function IssueStatusIcon(props: Props) {
+  return <Icon size={props.size}>{getIcon(props)}</Icon>;
+}
+
+function getIcon({ service, ...rest }: Props) {
+  switch (service) {
+    case IntegrationService.GitHub:
+      return <GitHubIssueStatusIcon {...rest} />;
+    case IntegrationService.Linear:
+      return <LinearIssueStatusIcon {...rest} />;
+  }
+}
+
+const Icon = styled.span<{ size?: number }>`
+  display: inline-flex;
+  flex-shrink: 0;
+  width: ${(props) => props.size ?? 24}px;
+  height: ${(props) => props.size ?? 24}px;
+  align-items: center;
+  justify-content: center;
+`;

shared/editor/components/Mentions.tsx

@@ -19,10 +19,11 @@ import Text from "../../components/Text";
 import useIsMounted from "../../hooks/useIsMounted";
 import useStores from "../../hooks/useStores";
 import theme from "../../styles/theme";
-import type {
-  JSONValue,
-  UnfurlResourceType,
-  UnfurlResponse,
+import {
+  IntegrationService,
+  type JSONValue,
+  type UnfurlResourceType,
+  type UnfurlResponse,
 } from "../../types";
 import { cn } from "../styles/utils";
 import { ComponentProps } from "../types";
@@ -187,6 +188,12 @@ export const MentionIssue = observer((props: IssuePrProps) => {
 
   const issue = unfurl as UnfurlResponse[UnfurlResourceType.Issue];
 
+  const url = new URL(issue.url);
+  const service =
+    url.hostname === "github.com"
+      ? IntegrationService.GitHub
+      : IntegrationService.Linear;
+
   return (
     <a
       {...attrs}
@@ -198,11 +205,7 @@ export const MentionIssue = observer((props: IssuePrProps) => {
       rel="noopener noreferrer nofollow"
     >
       <Flex align="center" gap={6}>
-        <IssueStatusIcon
-          size={14}
-          status={issue.state.name}
-          color={issue.state.color}
-        />
+        <IssueStatusIcon size={14} service={service} state={issue.state} />
         <Flex align="center" gap={4}>
           <Text>{issue.title}</Text>
           <Text type="tertiary">{issue.id}</Text>

shared/i18n/locales/en_US/translation.json

@@ -1089,6 +1089,10 @@
   "Add a Google Analytics 4 measurement ID to send document views and analytics from the workspace to your own Google Analytics account.": "Add a Google Analytics 4 measurement ID to send document views and analytics from the workspace to your own Google Analytics account.",
   "Measurement ID": "Measurement ID",
   "Create a \"Web\" stream in your Google Analytics admin dashboard and copy the measurement ID from the generated code snippet to install.": "Create a \"Web\" stream in your Google Analytics admin dashboard and copy the measurement ID from the generated code snippet to install.",
+  "Whoops, you need to accept the permissions in Linear to connect {{appName}} to your workspace. Try again?": "Whoops, you need to accept the permissions in Linear to connect {{appName}} to your workspace. Try again?",
+  "Enable previews of Linear issues in documents by connecting a Linear workspace to {appName}.": "Enable previews of Linear issues in documents by connecting a Linear workspace to {appName}.",
+  "Disconnecting will prevent previewing Linear links from this workspace in documents. Are you sure?": "Disconnecting will prevent previewing Linear links from this workspace in documents. Are you sure?",
+  "The Linear integration is currently disabled. Please set the associated environment variables and restart the server to enable the integration.": "The Linear integration is currently disabled. Please set the associated environment variables and restart the server to enable the integration.",
   "Configure a Matomo installation to send views and analytics from the workspace to your own Matomo instance.": "Configure a Matomo installation to send views and analytics from the workspace to your own Matomo instance.",
   "Instance URL": "Instance URL",
   "The URL of your Matomo instance. If you are using Matomo Cloud it will end in matomo.cloud/": "The URL of your Matomo instance. If you are using Matomo Cloud it will end in matomo.cloud/",

shared/types.ts

@@ -117,6 +117,7 @@ export enum IntegrationService {
   Matomo = "matomo",
   Umami = "umami",
   GitHub = "github",
+  Linear = "linear",
   Notion = "notion",
 }
 
@@ -131,11 +132,12 @@ export const ImportableIntegrationService = {
 
 export type IssueTrackerIntegrationService = Extract<
   IntegrationService,
-  IntegrationService.GitHub
+  IntegrationService.GitHub | IntegrationService.Linear
 >;
 
 export const IssueTrackerIntegrationService = {
   GitHub: IntegrationService.GitHub,
+  Linear: IntegrationService.Linear,
 } as const;
 
 export type UserCreatableIntegrationService = Extract<
@@ -169,13 +171,16 @@ export enum DocumentPermission {
 
 export type IntegrationSettings<T> = T extends IntegrationType.Embed
   ? {
-      url: string;
+      url?: string;
       github?: {
         installation: {
           id: number;
           account: { id: number; name: string; avatarUrl: string };
         };
       };
+      linear?: {
+        workspace: { id: string; name: string; key: string; logoUrl?: string };
+      };
     }
   : T extends IntegrationType.Analytics
   ? { measurementId: string; instanceUrl?: string; scriptName?: string }
@@ -433,7 +438,12 @@ export type UnfurlResponse = {
     /** Issue's labels */
     labels: Array<{ name: string; color: string }>;
     /** Issue's status */
-    state: { name: string; color: string };
+    state: {
+      type?: string;
+      name: string;
+      color: string;
+      completionPercentage?: number;
+    };
     /** Issue's creation time */
     createdAt: string;
   };

shared/utils/browser.ts

@@ -33,6 +33,18 @@ export function isWindows(): boolean {
   return window.navigator.platform === "Win32";
 }
 
+export function isSafari(): boolean {
+  if (!isBrowser) {
+    return false;
+  }
+  const userAgent = window.navigator.userAgent;
+  return (
+    userAgent.includes("Safari") &&
+    !userAgent.includes("Chrome") &&
+    !userAgent.includes("Chromium")
+  );
+}
+
 let supportsPassive = false;
 
 try {

yarn.lock

@@ -2358,6 +2358,11 @@
   dependencies:
     warning "^4.0.3"
 
+"@graphql-typed-document-node/core@^3.1.0":
+  version "3.2.0"
+  resolved "https://registry.yarnpkg.com/@graphql-typed-document-node/core/-/core-3.2.0.tgz#5f3d96ec6b2354ad6d8a28bf216a1d97b5426861"
+  integrity sha512-mB9oAsNCm9aM3/SOv4YtBMqZbYj10R7dkq8byBqxGY/ncFwhf2oQzMV+LCRlWoDSEBJ3COiR1yeDvMtsoOsuFQ==
+
 "@gulpjs/to-absolute-glob@^4.0.0":
   version "4.0.0"
   resolved "https://registry.yarnpkg.com/@gulpjs/to-absolute-glob/-/to-absolute-glob-4.0.0.tgz#1fc2460d3953e1d9b9f2dfdb4bcc99da4710c021"
@@ -2796,6 +2801,15 @@
   resolved "https://registry.yarnpkg.com/@lifeomic/attempt/-/attempt-3.0.3.tgz#e742a5b85eb673e2f1746b0f39cb932cbc6145bb"
   integrity "sha1-50KluF62c+LxdGsPOcuTLLxhRbs= sha512-GlM2AbzrErd/TmLL3E8hAHmb5Q7VhDJp35vIbyPVA5Rz55LZuRr8pwL3qrwwkVNo05gMX1J44gURKb4MHQZo7w=="
 
+"@linear/sdk@^39.0.0":
+  version "39.0.0"
+  resolved "https://registry.yarnpkg.com/@linear/sdk/-/sdk-39.0.0.tgz#6238a04e4123386d5d873014afe5cafc40e6493d"
+  integrity sha512-GFZakeWsLFXyJjhrjt/VOW/lxMX9obOVw7ItypYWDh8IEzIui6gVN3EBof5A7zKqpdc6fsZEPYCvrI5FVet9+Q==
+  dependencies:
+    "@graphql-typed-document-node/core" "^3.1.0"
+    graphql "^15.4.0"
+    isomorphic-unfetch "^3.1.0"
+
 "@mermaid-js/parser@^0.3.0":
   version "0.3.0"
   resolved "https://registry.yarnpkg.com/@mermaid-js/parser/-/parser-0.3.0.tgz#7a28714599f692f93df130b299fa1aadc9f9c8ab"
@@ -9520,6 +9534,11 @@ graphemer@^1.4.0:
   resolved "https://registry.yarnpkg.com/graphemer/-/graphemer-1.4.0.tgz#fb2f1d55e0e3a1849aeffc90c4fa0dd53a0e66c6"
   integrity "sha1-+y8dVeDjoYSa7/yQxPoN1ToOZsY= sha512-EtKwoO6kxCL9WO5xipiHTZlSzBm7WLT627TqC/uVRd0HKmq8NXyebnNYxDoBi7wt8eTWrUrKXCOVaFq9x1kgag=="
 
+graphql@^15.4.0:
+  version "15.10.1"
+  resolved "https://registry.yarnpkg.com/graphql/-/graphql-15.10.1.tgz#e9ff3bb928749275477f748b14aa5c30dcad6f2f"
+  integrity sha512-BL/Xd/T9baO6NFzoMpiMD7YUZ62R6viR5tp/MULVEnbYJXZA//kRNW7J0j1w/wXArgL0sCxhDfK5dczSKn3+cg==
+
 gulp-sort@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/gulp-sort/-/gulp-sort-2.0.0.tgz#c6762a2f1f0de0a3fc595a21599d3fac8dba1aca"
@@ -10381,6 +10400,14 @@ isexe@^2.0.0:
   resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10"
   integrity "sha1-6PvzdNxVb/iUehDcsFctYz8s+hA= sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw=="
 
+isomorphic-unfetch@^3.1.0:
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/isomorphic-unfetch/-/isomorphic-unfetch-3.1.0.tgz#87341d5f4f7b63843d468438128cb087b7c3e98f"
+  integrity sha512-geDJjpoZ8N0kWexiwkX8F9NkTsXhetLPVbZFQ+JTW239QNOwvB0gniuR1Wc6f0AMTn7/mFGyXvHTifrCp/GH8Q==
+  dependencies:
+    node-fetch "^2.6.1"
+    unfetch "^4.2.0"
+
 isomorphic-ws@^4.0.1:
   version "4.0.1"
   resolved "https://registry.yarnpkg.com/isomorphic-ws/-/isomorphic-ws-4.0.1.tgz#55fd4cd6c5e6491e76dc125938dd863f5cd4f2dc"
@@ -15369,6 +15396,11 @@ undici-types@~6.19.2:
   resolved "https://registry.yarnpkg.com/undici-types/-/undici-types-6.19.8.tgz#35111c9d1437ab83a7cdc0abae2f26d88eda0a02"
   integrity sha512-ve2KP6f/JnbPBFyobGHuerC9g1FYGn/F8n1LWTwNxCEzd6IfqTwUQcNXgEtmmQ6DlRrC1hrSrBnCZPokRrDHjw==
 
+unfetch@^4.2.0:
+  version "4.2.0"
+  resolved "https://registry.yarnpkg.com/unfetch/-/unfetch-4.2.0.tgz#7e21b0ef7d363d8d9af0fb929a5555f6ef97a3be"
+  integrity sha512-F9p7yYCn6cIW9El1zi0HI6vqpeIvBsr3dSuRO6Xuppb1u5rXpCPmMvLSyECLhybr9isec8Ohl0hPekMVrEinDA==
+
 unicode-canonical-property-names-ecmascript@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/unicode-canonical-property-names-ecmascript/-/unicode-canonical-property-names-ecmascript-2.0.0.tgz#301acdc525631670d39f6146e0e77ff6bbdebddc"