feat(Linear Node): Add support for OAuth2 (#7201)

This commit is contained in:
Jon 2023-09-20 10:19:12 +01:00 committed by GitHub
parent 6b582d155c
commit 12a3168367
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 140 additions and 1 deletions

View file

@ -0,0 +1,73 @@
import type { ICredentialType, INodeProperties } from 'n8n-workflow';
const scopes = ['read', 'write', 'issues:create', 'comments:create'];
export class LinearOAuth2Api implements ICredentialType {
name = 'linearOAuth2Api';
extends = ['oAuth2Api'];
displayName = 'Linear OAuth2 API';
documentationUrl = 'linear';
properties: INodeProperties[] = [
{
displayName: 'Grant Type',
name: 'grantType',
type: 'hidden',
default: 'authorizationCode',
},
{
displayName: 'Authorization URL',
name: 'authUrl',
type: 'hidden',
default: 'https://linear.app/oauth/authorize',
required: true,
},
{
displayName: 'Access Token URL',
name: 'accessTokenUrl',
type: 'hidden',
default: 'https://api.linear.app/oauth/token',
required: true,
},
{
displayName: 'Actor',
name: 'actor',
type: 'options',
options: [
{
name: 'User',
value: 'user',
description: 'Resources are created as the user who authorized the application',
},
{
name: 'Application',
value: 'application',
description: 'Resources are created as the application',
},
],
default: 'user',
},
{
displayName: 'Scope',
name: 'scope',
type: 'hidden',
default: scopes.join(' '),
required: true,
},
{
displayName: 'Auth URI Query Parameters',
name: 'authQueryParameters',
type: 'hidden',
default: '={{"actor="+$self["actor"]}}',
},
{
displayName: 'Authentication',
name: 'authentication',
type: 'hidden',
default: 'body',
},
];
}

View file

@ -23,6 +23,7 @@ export async function linearApiRequest(
option: IDataObject = {}, option: IDataObject = {},
): Promise<any> { ): Promise<any> {
const endpoint = 'https://api.linear.app/graphql'; const endpoint = 'https://api.linear.app/graphql';
const authenticationMethod = this.getNodeParameter('authentication', 0, 'apiToken') as string;
let options: OptionsWithUri = { let options: OptionsWithUri = {
headers: { headers: {
@ -35,7 +36,11 @@ export async function linearApiRequest(
}; };
options = Object.assign({}, options, option); options = Object.assign({}, options, option);
try { try {
return await this.helpers.requestWithAuthentication.call(this, 'linearApi', options); return await this.helpers.requestWithAuthentication.call(
this,
authenticationMethod === 'apiToken' ? 'linearApi' : 'linearOAuth2Api',
options,
);
} catch (error) { } catch (error) {
throw new NodeApiError(this.getNode(), error as JsonObject); throw new NodeApiError(this.getNode(), error as JsonObject);
} }

View file

@ -46,9 +46,39 @@ export class Linear implements INodeType {
name: 'linearApi', name: 'linearApi',
required: true, required: true,
testedBy: 'linearApiTest', testedBy: 'linearApiTest',
displayOptions: {
show: {
authentication: ['apiToken'],
},
},
},
{
name: 'linearOAuth2Api',
required: true,
displayOptions: {
show: {
authentication: ['oAuth2'],
},
},
}, },
], ],
properties: [ properties: [
{
displayName: 'Authentication',
name: 'authentication',
type: 'options',
options: [
{
name: 'API Token',
value: 'apiToken',
},
{
name: 'OAuth2',
value: 'oAuth2',
},
],
default: 'apiToken',
},
{ {
displayName: 'Resource', displayName: 'Resource',
name: 'resource', name: 'resource',

View file

@ -29,6 +29,20 @@ export class LinearTrigger implements INodeType {
name: 'linearApi', name: 'linearApi',
required: true, required: true,
testedBy: 'linearApiTest', testedBy: 'linearApiTest',
displayOptions: {
show: {
authentication: ['apiToken'],
},
},
},
{
name: 'linearOAuth2Api',
required: true,
displayOptions: {
show: {
authentication: ['oAuth2'],
},
},
}, },
], ],
webhooks: [ webhooks: [
@ -40,6 +54,22 @@ export class LinearTrigger implements INodeType {
}, },
], ],
properties: [ properties: [
{
displayName: 'Authentication',
name: 'authentication',
type: 'options',
options: [
{
name: 'API Token',
value: 'apiToken',
},
{
name: 'OAuth2',
value: 'oAuth2',
},
],
default: 'apiToken',
},
{ {
displayName: 'Team Name or ID', displayName: 'Team Name or ID',
name: 'teamId', name: 'teamId',

View file

@ -188,6 +188,7 @@
"dist/credentials/Ldap.credentials.js", "dist/credentials/Ldap.credentials.js",
"dist/credentials/LemlistApi.credentials.js", "dist/credentials/LemlistApi.credentials.js",
"dist/credentials/LinearApi.credentials.js", "dist/credentials/LinearApi.credentials.js",
"dist/credentials/LinearOAuth2Api.credentials.js",
"dist/credentials/LineNotifyOAuth2Api.credentials.js", "dist/credentials/LineNotifyOAuth2Api.credentials.js",
"dist/credentials/LingvaNexApi.credentials.js", "dist/credentials/LingvaNexApi.credentials.js",
"dist/credentials/LinkedInOAuth2Api.credentials.js", "dist/credentials/LinkedInOAuth2Api.credentials.js",