mirror of
https://github.com/n8n-io/n8n.git
synced 2024-12-26 21:19:43 -08:00
2ee5853bd0
* ⚡ Fix default args for update:group * ⚡ Add external IDs to resource loader
282 lines
5.1 KiB
TypeScript
282 lines
5.1 KiB
TypeScript
import {
|
|
INodeProperties,
|
|
} from 'n8n-workflow';
|
|
|
|
export const groupOperations = [
|
|
{
|
|
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 Members',
|
|
value: 'getMembers',
|
|
},
|
|
{
|
|
name: 'Update',
|
|
value: 'update',
|
|
},
|
|
{
|
|
name: 'Update Members',
|
|
value: 'updateMembers',
|
|
},
|
|
],
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'group',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
] as INodeProperties[];
|
|
|
|
export const groupFields = [
|
|
// ----------------------------------
|
|
// group: shared
|
|
// ----------------------------------
|
|
{
|
|
displayName: 'Group ID',
|
|
name: 'groupId',
|
|
type: 'string',
|
|
required: true,
|
|
description: 'The identifier of the group.',
|
|
default: '',
|
|
placeholder: '5e59c8c7-e05a-4d17-8e85-acc301343926',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'group',
|
|
],
|
|
operation: [
|
|
'delete',
|
|
'get',
|
|
'getMembers',
|
|
'update',
|
|
'updateMembers',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
|
|
// ----------------------------------
|
|
// group: getAll
|
|
// ----------------------------------
|
|
{
|
|
displayName: 'Return All',
|
|
name: 'returnAll',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: 'Return all available results for the query.',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'group',
|
|
],
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Limit',
|
|
name: 'limit',
|
|
type: 'number',
|
|
default: 10,
|
|
description: 'Number of results to return for the query.',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'group',
|
|
],
|
|
operation: [
|
|
'getAll',
|
|
],
|
|
returnAll: [
|
|
false,
|
|
],
|
|
},
|
|
},
|
|
},
|
|
|
|
// ----------------------------------
|
|
// group: create
|
|
// ----------------------------------
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
default: '',
|
|
required: true,
|
|
description: 'The name of the group to create.',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'group',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
{
|
|
displayName: 'Access All',
|
|
name: 'accessAll',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: 'Allow this group to access all collections within the organization, instead of only its associated collections.<br>If set to true, this option overrides any collection assignments.',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'group',
|
|
],
|
|
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 group.',
|
|
default: [],
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getCollections',
|
|
},
|
|
},
|
|
{
|
|
displayName: 'External ID',
|
|
name: 'externalId',
|
|
type: 'string',
|
|
description: 'The external identifier to set to this group.',
|
|
default: '',
|
|
},
|
|
],
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'group',
|
|
],
|
|
operation: [
|
|
'create',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
|
|
// ----------------------------------
|
|
// group: update
|
|
// ----------------------------------
|
|
{
|
|
displayName: 'Update Fields',
|
|
name: 'updateFields',
|
|
type: 'collection',
|
|
placeholder: 'Add Field',
|
|
default: {},
|
|
options: [
|
|
{
|
|
displayName: 'Access All',
|
|
name: 'accessAll',
|
|
type: 'boolean',
|
|
default: false,
|
|
description: 'Allow this group to access all collections within the organization, instead of only its associated collections.<br>If set to true, this option overrides any collection assignments.',
|
|
},
|
|
{
|
|
displayName: 'Collections',
|
|
name: 'collections',
|
|
type: 'multiOptions',
|
|
description: 'The collections to assign to this group.',
|
|
default: [],
|
|
typeOptions: {
|
|
loadOptionsMethod: 'getCollections',
|
|
},
|
|
},
|
|
{
|
|
displayName: 'External ID',
|
|
name: 'externalId',
|
|
type: 'string',
|
|
description: 'The external identifier to set to this group.',
|
|
default: '',
|
|
},
|
|
{
|
|
displayName: 'Name',
|
|
name: 'name',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'The name of the group to update.',
|
|
},
|
|
],
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'group',
|
|
],
|
|
operation: [
|
|
'update',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
|
|
// ----------------------------------
|
|
// group: updateMembers
|
|
// ----------------------------------
|
|
{
|
|
displayName: 'Member IDs',
|
|
name: 'memberIds',
|
|
type: 'string',
|
|
default: '',
|
|
description: 'Comma-separated list of IDs of members to set in a group.',
|
|
displayOptions: {
|
|
show: {
|
|
resource: [
|
|
'group',
|
|
],
|
|
operation: [
|
|
'updateMembers',
|
|
],
|
|
},
|
|
},
|
|
},
|
|
] as INodeProperties[];
|
|
|
|
type GroupSchema = {
|
|
name: string;
|
|
collections: string[];
|
|
accessAll: boolean;
|
|
externalId: string;
|
|
};
|
|
|
|
export type GroupUpdateFields = GroupSchema;
|
|
|
|
export type GroupCreationAdditionalFields = Omit<GroupSchema, 'name'>;
|