Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
166 changes: 166 additions & 0 deletions packages/apps-engine/src/definition/metadata/AppPermissions.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
import type { INetworkingPermission, IPermission, IReadSettingPermission, IWorkspaceTokenPermission } from '../permissions/IPermission';

/**
* @description
*
* App Permission naming rules:
*
* 'scope-name': {
* 'permission-name': { name: 'scope-name.permission-name' }
* }
*
* You can retrieve this permission by using:
* AppPermissions['scope-name']['permission-name'] -> { name: 'scope-name.permission-name' }
*
* @example
*
* AppPermissions.upload.read // { name: 'upload.read', domains: [] }
*/
export const AppPermissions = {
'user': {
read: { name: 'user.read' },
write: { name: 'user.write' },
},
'upload': {
read: { name: 'upload.read' },
write: { name: 'upload.write' },
},
'email': {
send: { name: 'email.send' },
},
'ui': {
interaction: { name: 'ui.interact' },
registerButtons: { name: 'ui.registerButtons' },
},
'setting': {
read: { name: 'server-setting.read', hiddenSettings: [] } as IReadSettingPermission,
write: { name: 'server-setting.write' },
},
'room': {
'read': { name: 'room.read' },
'write': { name: 'room.write' },
'system-view-all': { name: 'room.system.view-all' },
},
'role': {
read: { name: 'role.read' },
write: { name: 'role.write' },
},
'message': {
read: { name: 'message.read' },
write: { name: 'message.write' },
},
'moderation': {
read: { name: 'moderation.read' },
write: { name: 'moderation.write' },
},
'contact': {
read: { name: 'contact.read' },
write: { name: 'contact.write' },
},
'threads': {
read: { name: 'threads.read' },
},
'livechat-status': {
read: { name: 'livechat-status.read' },
},
'livechat-custom-fields': {
write: { name: 'livechat-custom-fields.write' },
},
'livechat-visitor': {
read: { name: 'livechat-visitor.read' },
write: { name: 'livechat-visitor.write' },
},
'livechat-message': {
read: { name: 'livechat-message.read' },
write: { name: 'livechat-message.write' },
multiple: { name: 'livechat-message.multiple' },
},
'livechat-room': {
read: { name: 'livechat-room.read' },
write: { name: 'livechat-room.write' },
},
'livechat-department': {
read: { name: 'livechat-department.read' },
write: { name: 'livechat-department.write' },
multiple: { name: 'livechat-department.multiple' },
},
'env': {
read: { name: 'env.read' },
},
'cloud': {
'workspace-token': { name: 'cloud.workspace-token', scopes: [] } as IWorkspaceTokenPermission,
},
// Internal permissions
'scheduler': {
default: { name: 'scheduler' },
},
'networking': {
default: { name: 'networking', domains: [] } as INetworkingPermission,
},
'persistence': {
default: { name: 'persistence' },
},
'command': {
default: { name: 'slashcommand' },
},
'videoConference': {
read: { name: 'video-conference.read' },
write: { name: 'video-conference.write' },
provider: { name: 'video-conference-provider' },
},
'apis': {
default: { name: 'api' },
},
'oauth-app': {
read: { name: 'oauth-app.read' },
write: { name: 'oauth-app.write' },
},
'outboundComms': {
provide: { name: 'outbound-communication.provide' },
},
'experimental': {
default: { name: 'experimental.default' },
},
'abac': {
read: { name: 'abac.read' },
},
};

/**
* @description
* Default permissions for apps
* Used to ensure backward compatibility with apps
* that were developed before the permission system was introduced.
*/
export const defaultPermissions: Array<IPermission> = [
AppPermissions.user.read,
AppPermissions.user.write,
AppPermissions.upload.read,
AppPermissions.upload.write,
AppPermissions.ui.interaction,
AppPermissions.setting.read,
AppPermissions.setting.write,
AppPermissions.room.read,
AppPermissions.room.write,
AppPermissions.message.read,
AppPermissions.message.write,
AppPermissions['livechat-department'].read,
AppPermissions['livechat-department'].write,
AppPermissions['livechat-room'].read,
AppPermissions['livechat-room'].write,
AppPermissions['livechat-message'].read,
AppPermissions['livechat-message'].write,
AppPermissions['livechat-visitor'].read,
AppPermissions['livechat-visitor'].write,
AppPermissions['livechat-status'].read,
AppPermissions['livechat-custom-fields'].write,
AppPermissions.scheduler.default,
AppPermissions.networking.default,
AppPermissions.persistence.default,
AppPermissions.env.read,
AppPermissions.command.default,
AppPermissions.videoConference.provider,
AppPermissions.videoConference.read,
AppPermissions.videoConference.write,
AppPermissions.apis.default,
];
Comment thread
d-gubert marked this conversation as resolved.
1 change: 1 addition & 0 deletions packages/apps-engine/src/definition/metadata/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import type { IAppInfo } from './IAppInfo';
import { RocketChatAssociationModel, RocketChatAssociationRecord } from './RocketChatAssociations';

export * from './AppInterface';
export * from './AppPermissions';

export type { IAppAuthorInfo, IAppInfo };
export { AppMethod, RocketChatAssociationModel, RocketChatAssociationRecord };
172 changes: 1 addition & 171 deletions packages/apps/src/server/permissions/AppPermissions.ts
Original file line number Diff line number Diff line change
@@ -1,171 +1 @@
import type {
INetworkingPermission,
IPermission,
IReadSettingPermission,
IWorkspaceTokenPermission,
} from '@rocket.chat/apps-engine/definition/permissions/IPermission';

/**
* @description
*
* App Permission naming rules:
*
* 'scope-name': {
* 'permission-name': { name: 'scope-name.permission-name' }
* }
*
* You can retrive this permission by using:
* AppPermissions['scope-name']['permission-name'] -> { name: 'scope-name.permission-name' }
*
* @example
*
* AppPermissions.upload.read // { name: 'upload.read', domains: [] }
*/
export const AppPermissions = {
'user': {
read: { name: 'user.read' },
write: { name: 'user.write' },
},
'upload': {
read: { name: 'upload.read' },
write: { name: 'upload.write' },
},
'email': {
send: { name: 'email.send' },
},
'ui': {
interaction: { name: 'ui.interact' },
registerButtons: { name: 'ui.registerButtons' },
},
'setting': {
read: { name: 'server-setting.read', hiddenSettings: [] } as IReadSettingPermission,
write: { name: 'server-setting.write' },
},
'room': {
'read': { name: 'room.read' },
'write': { name: 'room.write' },
'system-view-all': { name: 'room.system.view-all' },
},
'role': {
read: { name: 'role.read' },
write: { name: 'role.write' },
},
'message': {
read: { name: 'message.read' },
write: { name: 'message.write' },
},
'moderation': {
read: { name: 'moderation.read' },
write: { name: 'moderation.write' },
},
'contact': {
read: { name: 'contact.read' },
write: { name: 'contact.write' },
},
'threads': {
read: { name: 'threads.read' },
},
'livechat-status': {
read: { name: 'livechat-status.read' },
},
'livechat-custom-fields': {
write: { name: 'livechat-custom-fields.write' },
},
'livechat-visitor': {
read: { name: 'livechat-visitor.read' },
write: { name: 'livechat-visitor.write' },
},
'livechat-message': {
read: { name: 'livechat-message.read' },
write: { name: 'livechat-message.write' },
multiple: { name: 'livechat-message.multiple' },
},
'livechat-room': {
read: { name: 'livechat-room.read' },
write: { name: 'livechat-room.write' },
},
'livechat-department': {
read: { name: 'livechat-department.read' },
write: { name: 'livechat-department.write' },
multiple: { name: 'livechat-department.multiple' },
},
'env': {
read: { name: 'env.read' },
},
'cloud': {
'workspace-token': { name: 'cloud.workspace-token', scopes: [] } as IWorkspaceTokenPermission,
},
// Internal permissions
'scheduler': {
default: { name: 'scheduler' },
},
'networking': {
default: { name: 'networking', domains: [] } as INetworkingPermission,
},
'persistence': {
default: { name: 'persistence' },
},
'command': {
default: { name: 'slashcommand' },
},
'videoConference': {
read: { name: 'video-conference.read' },
write: { name: 'video-conference.write' },
provider: { name: 'video-conference-provider' },
},
'apis': {
default: { name: 'api' },
},
'oauth-app': {
read: { name: 'oauth-app.read' },
write: { name: 'oauth-app.write' },
},
'outboundComms': {
provide: { name: 'outbound-communication.provide' },
},
'experimental': {
default: { name: 'experimental.default' },
},
'abac': {
read: { name: 'abac.read' },
},
};

/**
* @description
* Default permissions for apps
* Used to ensure backward compatibility with apps
* that were developed before the permission system was introduced.
*/
export const defaultPermissions: Array<IPermission> = [
AppPermissions.user.read,
AppPermissions.user.write,
AppPermissions.upload.read,
AppPermissions.upload.write,
AppPermissions.ui.interaction,
AppPermissions.setting.read,
AppPermissions.setting.write,
AppPermissions.room.read,
AppPermissions.room.write,
AppPermissions.message.read,
AppPermissions.message.write,
AppPermissions['livechat-department'].read,
AppPermissions['livechat-department'].write,
AppPermissions['livechat-room'].read,
AppPermissions['livechat-room'].write,
AppPermissions['livechat-message'].read,
AppPermissions['livechat-message'].write,
AppPermissions['livechat-visitor'].read,
AppPermissions['livechat-visitor'].write,
AppPermissions['livechat-status'].read,
AppPermissions['livechat-custom-fields'].write,
AppPermissions.scheduler.default,
AppPermissions.networking.default,
AppPermissions.persistence.default,
AppPermissions.env.read,
AppPermissions.command.default,
AppPermissions.videoConference.provider,
AppPermissions.videoConference.read,
AppPermissions.videoConference.write,
AppPermissions.apis.default,
];
export { AppPermissions, defaultPermissions } from '@rocket.chat/apps-engine/definition/metadata/AppPermissions';
Loading