@appsemble/types 0.29.11 → 0.30.2

package/index.js

@@ -1,6 +1,5 @@
 export * from './action.js';
 export * from './app.js';
-export * from './appMember.js';
 export * from './asset.js';
 export * from './authentication.js';
 export * from './author.js';
@@ -12,9 +11,10 @@ export * from './snapshot.js';
 export * from './resource.js';
 export * from './saml.js';
 export * from './ssl.js';
-export * from './team.js';
 export * from './template.js';
 export * from './theme.js';
-export * from './user.js';
+export * from './oauth2.js';
 export * from './quota.js';
+export * from './permissions.js';
+export * from './roles.js';
 //# sourceMappingURL=index.js.map

package/{user.d.ts → oauth2.d.ts}

@@ -1,29 +1,3 @@
-/**
- * A user email registration.
- */
-export interface UserEmail {
-    /**
-     * The registered email address
-     */
-    email: string;
-    /**
-     * Wether or not the email address has been verified.
-     */
-    verified: boolean;
-    /**
-     * Whether or not this is the user’s primary email address.
-     */
-    primary?: boolean;
-}
-/**
- * A user as they are represented by the API.
- */
-export interface User {
-    /**
-     * A list of email addresses that belong to the user.
-     */
-    emails: UserEmail[];
-}
 /**
  * OAuth2 client credentials as they are returned by the API.
  */

package/oauth2.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=oauth2.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appsemble/types",
-  "version": "0.29.11",
+  "version": "0.30.2",
   "description": "TypeScript definitions reused within Appsemble internally",
   "keywords": [
     "app",

package/permissions.d.ts

@@ -0,0 +1,385 @@
+/**
+ * A permission an app member may have within an app because of their given role.
+ */
+export declare enum AppPermission {
+    /**
+     * The permission to create app invites.
+     */
+    CreateAppInvites = "$member:invite",
+    /**
+     * The permission to query app members.
+     */
+    QueryAppMembers = "$member:query",
+    /**
+     * The permission to query app members.
+     */
+    DeleteAppMembers = "$member:delete",
+    /**
+     * The permission to update the role of app members.
+     */
+    UpdateAppMemberRoles = "$member:role:update",
+    /**
+     * The permission to patch the properties of app members.
+     */
+    PatchAppMemberProperties = "$member:properties:patch",
+    /**
+     * The permission to query app groups.
+     */
+    QueryGroups = "$group:query",
+    /**
+     * The permission to create app groups.
+     */
+    CreateGroups = "$group:create",
+    /**
+     * The permission to update app groups.
+     */
+    UpdateGroups = "$group:update",
+    /**
+     * The permission to create app groups.
+     */
+    DeleteGroups = "$group:delete",
+    /**
+     * The permission to create group invites.
+     */
+    CreateGroupInvites = "$group:member:invite",
+    /**
+     * The permission to query app members.
+     */
+    QueryGroupMembers = "$group:member:query",
+    /**
+     * The permission to delete group members.
+     */
+    RemoveGroupMembers = "$group:member:delete",
+    /**
+     * The permission to change the role of members in a group.
+     */
+    UpdateGroupMemberRoles = "$group:member:role:update",
+    /**
+     * The permission to create any app resources.
+     */
+    CreateResources = "$resource:all:create",
+    /**
+     * The permission to query app resources.
+     */
+    QueryResources = "$resource:all:query",
+    /**
+     * The permission to get app resources.
+     */
+    GetResources = "$resource:all:get",
+    /**
+     * The permission to update app resources.
+     */
+    UpdateResources = "$resource:all:update",
+    /**
+     * The permission to patch app resources.
+     */
+    PatchResources = "$resource:all:patch",
+    /**
+     * The permission to delete app resources.
+     */
+    DeleteResources = "$resource:all:delete",
+    /**
+     * The permission to query own app resources.
+     */
+    QueryOwnResources = "$resource:all:own:query",
+    /**
+     * The permission to get own app resources.
+     */
+    GetOwnResources = "$resource:all:own:get",
+    /**
+     * The permission to update own app resources.
+     */
+    UpdateOwnResources = "$resource:all:own:update",
+    /**
+     * The permission to patch own app resources.
+     */
+    PatchOwnResources = "$resource:all:own:patch",
+    /**
+     * The permission to delete own app resources.
+     */
+    DeleteOwnResources = "$resource:all:own:delete"
+}
+/**
+ * A permission a user may have within the platform because of their given role.
+ */
+export declare enum OrganizationPermission {
+    /**
+     * The permission to publish blocks for an organization.
+     */
+    PublishBlocks = 0,
+    /**
+     * The permission to delete blocks for an organization.
+     */
+    DeleteBlocks = 1,
+    /**
+     * The permission to create apps in an organization
+     */
+    CreateApps = 2,
+    /**
+     * The permission to view private apps of an organization.
+     */
+    QueryApps = 3,
+    /**
+     * The permission to update apps in an organization.
+     */
+    UpdateApps = 4,
+    /**
+     * The permission to delete apps in an organization.
+     */
+    DeleteApps = 5,
+    /**
+     * The permission to query app translations.
+     */
+    QueryAppMessages = 6,
+    /**
+     * The permission to create app translations.
+     */
+    CreateAppMessages = 7,
+    /**
+     * The permission to update app translations.
+     */
+    UpdateAppMessages = 8,
+    /**
+     * The permission to delete app translations.
+     */
+    DeleteAppMessages = 9,
+    /**
+     * The permission to read app settings.
+     */
+    ReadAppSettings = 10,
+    /**
+     * The permission to update app settings.
+     */
+    UpdateAppSettings = 11,
+    /**
+     * The permission to create app screenshots.
+     */
+    CreateAppScreenshots = 12,
+    /**
+     * The permission to delete app screenshots.
+     */
+    DeleteAppScreenshots = 13,
+    /**
+     * The permission to create app readmes.
+     */
+    CreateAppReadmes = 14,
+    /**
+     * The permission to delete app readmes.
+     */
+    DeleteAppReadmes = 15,
+    /**
+     * The permission to create app secrets.
+     */
+    CreateAppSecrets = 16,
+    /**
+     * The permission to query app secrets.
+     */
+    QueryAppSecrets = 17,
+    /**
+     * The permission to update app secrets.
+     */
+    UpdateAppSecrets = 18,
+    /**
+     * The permission to delete app secrets.
+     */
+    DeleteAppSecrets = 19,
+    /**
+     * The permission to query app variables.
+     */
+    QueryAppVariables = 20,
+    /**
+     * The permission to create app variables.
+     */
+    CreateAppVariables = 21,
+    /**
+     * The permission to update app variables.
+     */
+    UpdateAppVariables = 22,
+    /**
+     * The permission to delete app variables.
+     */
+    DeleteAppVariables = 23,
+    /**
+     * The permission to create app resources.
+     */
+    CreateAppResources = 24,
+    /**
+     * The permission to query app resources.
+     */
+    QueryAppResources = 25,
+    /**
+     * The permission to get app resources.
+     */
+    GetAppResources = 26,
+    /**
+     * The permission to update app resources.
+     */
+    UpdateAppResources = 27,
+    /**
+     * The permission to patch app resources.
+     */
+    PatchAppResources = 28,
+    /**
+     * The permission to delete app resources.
+     */
+    DeleteAppResources = 29,
+    /**
+     * The permission to create app assets.
+     */
+    CreateAppAssets = 30,
+    /**
+     * The permission to query app assets.
+     */
+    QueryAppAssets = 31,
+    /**
+     * The permission to update app assets.
+     */
+    UpdateAppAssets = 32,
+    /**
+     * The permission to delete app assets.
+     */
+    DeleteAppAssets = 33,
+    /**
+     * The permission to update organizations.
+     */
+    UpdateOrganizations = 34,
+    /**
+     * The permission to delete organizations.
+     */
+    DeleteOrganizations = 35,
+    /**
+     * The permission to create organization invites.
+     */
+    CreateOrganizationInvites = 36,
+    /**
+     * The permission to query organization invites.
+     */
+    QueryOrganizationInvites = 37,
+    /**
+     * The permission to update organization invites.
+     */
+    UpdateOrganizationInvites = 38,
+    /**
+     * The permission to delete organization invites.
+     */
+    DeleteOrganizationInvites = 39,
+    /**
+     * The permission to view the list of members in an organization.
+     */
+    QueryOrganizationMembers = 40,
+    /**
+     * The permission to remove organization members.
+     */
+    RemoveOrganizationMembers = 41,
+    /**
+     * The permission to change the roles of organization members.
+     */
+    UpdateOrganizationMemberRoles = 42,
+    /**
+     * The permission to create app invites.
+     */
+    CreateAppInvites = 43,
+    /**
+     * The permission to query app invites,
+     */
+    QueryAppInvites = 44,
+    /**
+     * The permission to query app members.
+     */
+    QueryAppMembers = 45,
+    /**
+     * The permission to delete app members.
+     */
+    DeleteAppMembers = 46,
+    /**
+     * The permission to update the role of app members.
+     */
+    UpdateAppMemberRoles = 47,
+    /**
+     * The permission to patch the properties of app members.
+     */
+    PatchAppMemberProperties = 48,
+    /**
+     * The permission to query app groups.
+     */
+    QueryGroups = 49,
+    /**
+     * The permission to create app groups.
+     */
+    CreateGroups = 50,
+    /**
+     * The permission to update app groups.
+     */
+    UpdateGroups = 51,
+    /**
+     * The permission to create app groups.
+     */
+    DeleteGroups = 52,
+    /**
+     * The permission to create group invites.
+     */
+    CreateGroupInvites = 53,
+    /**
+     * The permission to query group invites.
+     */
+    QueryGroupInvites = 54,
+    /**
+     * The permission to query group members.
+     */
+    QueryGroupMembers = 55,
+    /**
+     * The permission to remove group members.
+     */
+    RemoveGroupMembers = 56,
+    /**
+     * The permission to update group member roles.
+     */
+    UpdateGroupMemberRoles = 57,
+    /**
+     * The permission to query app snapshots.
+     */
+    QueryAppSnapshots = 58,
+    /**
+     * The permission to create app collections.
+     */
+    CreateAppCollections = 59,
+    /**
+     * The permission to delete app collections.
+     */
+    DeleteAppCollections = 60,
+    /**
+     * The permission to update app collections.
+     */
+    UpdateAppCollections = 61,
+    /**
+     * The permission to send manual push notifications for an app.
+     */
+    PushAppNotifications = 62,
+    /**
+     * The permission to create trainings.
+     */
+    CreateTrainings = 63,
+    /**
+     * The permission to update trainings.
+     */
+    UpdateTrainings = 64,
+    /**
+     * The permission to delete trainings.
+     */
+    DeleteTrainings = 65,
+    /**
+     * The permission to create training blocks.
+     */
+    CreateTrainingBlocks = 66,
+    /**
+     * The permission to update training blocks.
+     */
+    UpdateTrainingBlocks = 67,
+    /**
+     * The permission to delete training blocks.
+     */
+    DeleteTrainingBlocks = 68
+}
+export declare const appOrganizationPermissionMapping: {
+    [key in AppPermission]: OrganizationPermission;
+};