n8n/packages/nodes-base/nodes/Bitwarden/descriptions/MemberDescription.ts
Iván Ovejero 4dce9e2cd1
Add Bitwarden node (#1401)
* Update package.json

* Add first implementation of credentials

* Add Bitwarden SVG file

* Add first implementation of generic functions

* Add scaffolding for resources and operations

* Fill in events, groups and members

* Fill in organizations and policies

* Add collection description

* Clean up credentials params

* Implement collection:update

* Add event description

* Add group description

* Add member description

* Complete all descriptions

* Remove OAuth2 from credentials name

* Prevent excessive access token retrievals

* Complete collection:update

* Refactor getAll operations

* Add group:getAll

* Add group:create

* Add group:update

* Add group:updateMembers

* Add user:create

* Add member:updateGroups

* Remove organization resource

* Remove policy resource

* Add member:update

* Reposition divider comments

* Refactor resource loaders

* Document generic functions

* Refactor returnAll and limit

* Introduce minor improvements

*  Improvements

*  Minor improvements

*  Remove not needed code

Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-20 18:55:57 +01:00

328 lines
5.3 KiB
TypeScript

import {
INodeProperties,
} from 'n8n-workflow';
export const memberOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
default: 'get',
description: 'Operation to perform',
options: [
{
name: 'Create',
value: 'create',
},
{
name: 'Delete',
value: 'delete',
},
{
name: 'Get',
value: 'get',
},
{
name: 'Get All',
value: 'getAll',
},
{
name: 'Get Groups',
value: 'getGroups',
},
{
name: 'Update',
value: 'update',
},
{
name: 'Update Groups',
value: 'updateGroups',
},
],
displayOptions: {
show: {
resource: [
'member',
],
},
},
},
] as INodeProperties[];
export const memberFields = [
// ----------------------------------
// member: shared
// ----------------------------------
{
displayName: 'Member ID',
name: 'memberId',
type: 'string',
required: true,
description: 'The identifier of the member.',
default: '',
placeholder: '5e59c8c7-e05a-4d17-8e85-acc301343926',
displayOptions: {
show: {
resource: [
'member',
],
operation: [
'delete',
'get',
'getGroups',
'update',
'updateGroups',
],
},
},
},
{
displayName: 'Type',
name: 'type',
type: 'options',
default: 2,
required: true,
options: [
{
name: 'Owner',
value: 0,
},
{
name: 'Admin',
value: 1,
},
{
name: 'User',
value: 2,
},
{
name: 'Manager',
value: 3,
},
],
displayOptions: {
show: {
resource: [
'member',
],
operation: [
'create',
],
},
},
},
// ----------------------------------
// member: getAll
// ----------------------------------
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Return all available results for the query.',
displayOptions: {
show: {
resource: [
'member',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 10,
description: 'Number of results to return for the query.',
displayOptions: {
show: {
resource: [
'member',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
// ----------------------------------
// member: create
// ----------------------------------
{
displayName: 'Email',
name: 'email',
type: 'string',
default: '',
description: 'The email of the member to update.',
displayOptions: {
show: {
resource: [
'member',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Access All',
name: 'accessAll',
type: 'boolean',
default: false,
displayOptions: {
show: {
resource: [
'member',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
options: [
{
displayName: 'Collections',
name: 'collections',
type: 'multiOptions',
description: 'The collections to assign to this member.',
default: [],
typeOptions: {
loadOptionsMethod: 'getCollections',
},
},
{
displayName: 'External ID',
name: 'externalId',
type: 'string',
description: 'The external identifier to set to this member.',
default: '',
},
],
displayOptions: {
show: {
resource: [
'member',
],
operation: [
'create',
],
},
},
},
// ----------------------------------
// member: update
// ----------------------------------
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
options: [
{
displayName: 'Type',
name: 'type',
type: 'options',
default: {},
options: [
{
name: 'Owner',
value: 0,
},
{
name: 'Admin',
value: 1,
},
{
name: 'User',
value: 2,
},
{
name: 'Manager',
value: 3,
},
],
},
{
displayName: 'Collections',
name: 'collections',
type: 'multiOptions',
description: 'The collections to assign to this member.',
default: [],
typeOptions: {
loadOptionsMethod: 'getCollections',
},
},
{
displayName: 'External ID',
name: 'externalId',
type: 'string',
description: 'The external identifier to set to this member.',
default: '',
},
{
displayName: 'Access All',
name: 'accessAll',
type: 'boolean',
default: false,
},
],
displayOptions: {
show: {
resource: [
'member',
],
operation: [
'update',
],
},
},
},
// ----------------------------------
// member: updateGroups
// ----------------------------------
{
displayName: 'Group IDs',
name: 'groupIds',
type: 'string',
default: '',
description: 'Comma-separated list of IDs of groups to set for a member.',
displayOptions: {
show: {
resource: [
'member',
],
operation: [
'updateGroups',
],
},
},
},
] as INodeProperties[];
type MemberSchema = {
email: string;
collections: string[];
type: number;
accessAll: boolean;
externalId: string;
};
export type MemberUpdateFields = Omit<MemberSchema, 'email'>;
export type MemberCreationAdditionalFields = Omit<MemberSchema, 'email'>;