@appsemble/utils 0.29.11 → 0.30.1

package/api/tags/language.d.ts

@@ -1,2 +0,0 @@
-import { type OpenAPIV3 } from 'openapi-types';
-export declare const language: OpenAPIV3.TagObject;

package/api/tags/language.js

@@ -1,5 +0,0 @@
-export const language = {
-    name: 'language',
-    description: 'Operations related to App translations',
-};
-//# sourceMappingURL=language.js.map

package/api/tags/organization.d.ts

@@ -1,2 +0,0 @@
-import { type OpenAPIV3 } from 'openapi-types';
-export declare const organization: OpenAPIV3.TagObject;

package/api/tags/organization.js

@@ -1,5 +0,0 @@
-export const organization = {
-    name: 'organization',
-    description: 'Operations related to organizations',
-};
-//# sourceMappingURL=organization.js.map

package/api/tags/resource.d.ts

@@ -1,2 +0,0 @@
-import { type OpenAPIV3 } from 'openapi-types';
-export declare const resource: OpenAPIV3.TagObject;

package/api/tags/resource.js

@@ -1,5 +0,0 @@
-export const resource = {
-    name: 'app',
-    description: 'Operations related to the Resources definition',
-};
-//# sourceMappingURL=resource.js.map

package/api/tags/template.d.ts

@@ -1,2 +0,0 @@
-import { type OpenAPIV3 } from 'openapi-types';
-export declare const template: OpenAPIV3.TagObject;

package/api/tags/template.js

@@ -1,5 +0,0 @@
-export const template = {
-    name: 'template',
-    description: 'Operations related to the usage of app templates.',
-};
-//# sourceMappingURL=template.js.map

package/api/tags/user.d.ts

@@ -1,2 +0,0 @@
-import { type OpenAPIV3 } from 'openapi-types';
-export declare const user: OpenAPIV3.TagObject;

package/api/tags/user.js

@@ -1,5 +0,0 @@
-export const user = {
-    name: 'user',
-    description: 'Operations related to a user.',
-};
-//# sourceMappingURL=user.js.map

package/appSecurity.d.ts

@@ -1,9 +0,0 @@
-import { type AppDefinition, type RoleDefinition } from '@appsemble/types';
-/**
- * Resolve role security inheritance based on priority.
- *
- * @param app The app to resolve role priority for.
- * @param role The role to resolve
- * @returns A list of tuples of role name and role definition. The roles are sorted by priority.
- */
-export declare function resolveRoleInheritance(app: Pick<AppDefinition, 'security'>, role: string): [roleName: string, roleDefinition: RoleDefinition][];

package/appSecurity.js

@@ -1,41 +0,0 @@
-import { has } from './has.js';
-/**
- * Resolve role security inheritance based on priority.
- *
- * @param app The app to resolve role priority for.
- * @param role The role to resolve
- * @returns A list of tuples of role name and role definition. The roles are sorted by priority.
- */
-export function resolveRoleInheritance(app, role) {
-    var _a;
-    const rolesDefinition = (_a = app === null || app === void 0 ? void 0 : app.security) === null || _a === void 0 ? void 0 : _a.roles;
-    const roleNames = [];
-    const roles = [];
-    const resolveRoles = (r) => {
-        if (!r) {
-            // No role was specified.
-            return;
-        }
-        if (!has(rolesDefinition, r)) {
-            // The specified role is unknown, so it’s skipped.
-            return;
-        }
-        if (roleNames.includes(r)) {
-            // The role has already been processed higher up the priority.
-            return;
-        }
-        const roleDefinition = rolesDefinition[r];
-        roleNames.push(r);
-        roles.push(roleDefinition);
-        if (roleDefinition.inherits) {
-            for (const inherits of roleDefinition.inherits) {
-                resolveRoles(inherits);
-            }
-        }
-    };
-    if (rolesDefinition) {
-        resolveRoles(role);
-    }
-    return roles.map((r, index) => [roleNames[index], r]);
-}
-//# sourceMappingURL=appSecurity.js.map

package/appSecurity.test.d.ts

@@ -1 +0,0 @@
-export {};

package/appSecurity.test.js

@@ -1,114 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { resolveRoleInheritance } from './appSecurity.js';
-describe('resolveRoleInheritance', () => {
-    it('should return an empty array if no security definition is defined', () => {
-        const result = resolveRoleInheritance({}, 'unknown');
-        expect(result).toStrictEqual([]);
-    });
-    it('should return an empty array for an unknown role', () => {
-        const result = resolveRoleInheritance({
-            security: {
-                default: { role: 'known' },
-                roles: {
-                    known: {},
-                },
-            },
-        }, 'unknown');
-        expect(result).toStrictEqual([]);
-    });
-    it('should resolve a non inherited role', () => {
-        const result = resolveRoleInheritance({
-            security: {
-                default: { role: 'user' },
-                roles: {
-                    user: {},
-                },
-            },
-        }, 'user');
-        expect(result).toStrictEqual([['user', {}]]);
-    });
-    it('should resolve shallow inheritance', () => {
-        const result = resolveRoleInheritance({
-            security: {
-                default: { role: 'user' },
-                roles: {
-                    admin: { inherits: ['user'] },
-                    user: {},
-                },
-            },
-        }, 'admin');
-        expect(result).toStrictEqual([
-            ['admin', { inherits: ['user'] }],
-            ['user', {}],
-        ]);
-    });
-    it('should resolve nested inheritance', () => {
-        const result = resolveRoleInheritance({
-            security: {
-                default: { role: 'user' },
-                roles: {
-                    superadmin: { inherits: ['admin'] },
-                    admin: { inherits: ['user'] },
-                    user: {},
-                },
-            },
-        }, 'superadmin');
-        expect(result).toStrictEqual([
-            ['superadmin', { inherits: ['admin'] }],
-            ['admin', { inherits: ['user'] }],
-            ['user', {}],
-        ]);
-    });
-    it('should resolve multiple inheritance', () => {
-        const result = resolveRoleInheritance({
-            security: {
-                default: { role: 'user' },
-                roles: {
-                    superadmin: { inherits: ['admin', 'user'] },
-                    admin: {},
-                    user: {},
-                },
-            },
-        }, 'superadmin');
-        expect(result).toStrictEqual([
-            ['superadmin', { inherits: ['admin', 'user'] }],
-            ['admin', {}],
-            ['user', {}],
-        ]);
-    });
-    it('should not include duplicates', () => {
-        const result = resolveRoleInheritance({
-            security: {
-                default: { role: 'user' },
-                roles: {
-                    superadmin: { inherits: ['admin', 'user'] },
-                    admin: { inherits: ['user'] },
-                    user: {},
-                },
-            },
-        }, 'superadmin');
-        expect(result).toStrictEqual([
-            ['superadmin', { inherits: ['admin', 'user'] }],
-            ['admin', { inherits: ['user'] }],
-            ['user', {}],
-        ]);
-    });
-    it('should resolve roles in order', () => {
-        const result = resolveRoleInheritance({
-            security: {
-                default: { role: 'user' },
-                roles: {
-                    superadmin: { inherits: ['user', 'admin'] },
-                    admin: { inherits: ['user'] },
-                    user: {},
-                },
-            },
-        }, 'superadmin');
-        expect(result).toStrictEqual([
-            ['superadmin', { inherits: ['user', 'admin'] }],
-            ['user', {}],
-            ['admin', { inherits: ['user'] }],
-        ]);
-    });
-});
-//# sourceMappingURL=appSecurity.test.js.map

package/checkAppRole.d.ts

@@ -1,11 +0,0 @@
-import { type Security, type TeamMember } from '@appsemble/types';
-/**
- * Check if the given user has access to any of the given scopes.
- *
- * @param securityDefinition The security definition to use for checking the role.
- * @param role The role the user is checked against.
- * @param userRole The role the user has.
- * @param teams The teams the user is in.
- * @returns Whether or not the user has the role.
- */
-export declare function checkAppRole(securityDefinition: Security, role: string, userRole: string, teams: Pick<TeamMember, 'role'>[]): boolean;

package/checkAppRole.js

@@ -1,34 +0,0 @@
-/**
- * Check if the given user has access to any of the given scopes.
- *
- * @param securityDefinition The security definition to use for checking the role.
- * @param role The role the user is checked against.
- * @param userRole The role the user has.
- * @param teams The teams the user is in.
- * @returns Whether or not the user has the role.
- */
-export function checkAppRole(securityDefinition, role, userRole, teams) {
-    if (role === userRole) {
-        return true;
-    }
-    if (role === '$public' && userRole) {
-        return true;
-    }
-    if (role === '$none' && !userRole) {
-        return true;
-    }
-    if (role === '$team:manager') {
-        return teams.some((team) => team.role === 'manager');
-    }
-    if (role === '$team:member') {
-        return Boolean(teams.some((team) => team.role));
-    }
-    if (!userRole) {
-        return false;
-    }
-    if (securityDefinition.roles[userRole].inherits) {
-        return securityDefinition.roles[userRole].inherits.some((inheritedRole) => checkAppRole(securityDefinition, role, inheritedRole, teams));
-    }
-    return false;
-}
-//# sourceMappingURL=checkAppRole.js.map

package/constants/Permission.d.ts

@@ -1,114 +0,0 @@
-/**
- * A permission a user may have within an organization because of their given role.
- */
-export declare enum Permission {
-    /**
-     * The permission to create new apps or copy them from templates.
-     */
-    CreateApps = 0,
-    /**
-     * The permission to delete apps.
-     */
-    DeleteApps = 1,
-    /**
-     * The permission to edit the app’s translations.
-     */
-    EditAppMessages = 2,
-    /**
-     * The permission to edit the app’s settings.
-     */
-    EditAppSettings = 3,
-    /**
-     * The permission to edit the app definition.
-     */
-    EditApps = 4,
-    /**
-     * The permission to edit the name and logo of an organization.
-     */
-    EditOrganization = 5,
-    /**
-     * The permission to delete an organization if it doesn't have any apps.
-     */
-    DeleteOrganization = 6,
-    /**
-     * The permission to invite new members into an organization,
-     * removing existing invites, and resending invites.
-     */
-    InviteMember = 7,
-    /**
-     * The permission to create and delete assets.
-     */
-    ManageAssets = 8,
-    /**
-     * The permission to remove organization members.
-     */
-    ManageMembers = 9,
-    /**
-     * The permission to create, edit, and delete resources.
-     */
-    ManageResources = 10,
-    /**
-     * The permission to change the roles of organization members.
-     */
-    ManageRoles = 11,
-    /**
-     * The permission to create and delete teams and manage its members.
-     */
-    ManageTeams = 12,
-    /**
-     * The permission to publish blocks for an organization.
-     */
-    PublishBlocks = 13,
-    /**
-     * The permission to delete blocks for an organization.
-     */
-    DeleteBlocks = 14,
-    /**
-     * The permission to send manual push notifications for an app.
-     */
-    PushNotifications = 15,
-    /**
-     * The permission to read assets.
-     */
-    ReadAssets = 16,
-    /**
-     * The permission to read resources.
-     */
-    ReadResources = 17,
-    /**
-     * The permission to view private apps of an organization.
-     */
-    ViewApps = 18,
-    /**
-     * The permission to view the list of members in an organization.
-     */
-    ViewMembers = 19,
-    /**
-     * The permission to create collections.
-     */
-    CreateCollections = 20,
-    /**
-     * The permission to delete collections.
-     */
-    DeleteCollections = 21,
-    /**
-     * The permission to edit collections.
-     */
-    EditCollections = 22,
-    /**
-     * The permission to create app accounts.
-     */
-    CreateAppAccounts = 23,
-    /**
-     * The permission to read app accounts.
-     */
-    ReadAppAccounts = 24,
-    /**
-     * The permission to delete app accounts.
-     */
-    DeleteAppAccounts = 25,
-    /**
-     * The permission to edit app accounts.
-     */
-    EditAppAccounts = 26
-}

package/constants/Permission.js

@@ -1,116 +0,0 @@
-/**
- * A permission a user may have within an organization because of their given role.
- */
-export var Permission;
-(function (Permission) {
-    /**
-     * The permission to create new apps or copy them from templates.
-     */
-    Permission[Permission["CreateApps"] = 0] = "CreateApps";
-    /**
-     * The permission to delete apps.
-     */
-    Permission[Permission["DeleteApps"] = 1] = "DeleteApps";
-    /**
-     * The permission to edit the app’s translations.
-     */
-    Permission[Permission["EditAppMessages"] = 2] = "EditAppMessages";
-    /**
-     * The permission to edit the app’s settings.
-     */
-    Permission[Permission["EditAppSettings"] = 3] = "EditAppSettings";
-    /**
-     * The permission to edit the app definition.
-     */
-    Permission[Permission["EditApps"] = 4] = "EditApps";
-    /**
-     * The permission to edit the name and logo of an organization.
-     */
-    Permission[Permission["EditOrganization"] = 5] = "EditOrganization";
-    /**
-     * The permission to delete an organization if it doesn't have any apps.
-     */
-    Permission[Permission["DeleteOrganization"] = 6] = "DeleteOrganization";
-    /**
-     * The permission to invite new members into an organization,
-     * removing existing invites, and resending invites.
-     */
-    Permission[Permission["InviteMember"] = 7] = "InviteMember";
-    /**
-     * The permission to create and delete assets.
-     */
-    Permission[Permission["ManageAssets"] = 8] = "ManageAssets";
-    /**
-     * The permission to remove organization members.
-     */
-    Permission[Permission["ManageMembers"] = 9] = "ManageMembers";
-    /**
-     * The permission to create, edit, and delete resources.
-     */
-    Permission[Permission["ManageResources"] = 10] = "ManageResources";
-    /**
-     * The permission to change the roles of organization members.
-     */
-    Permission[Permission["ManageRoles"] = 11] = "ManageRoles";
-    /**
-     * The permission to create and delete teams and manage its members.
-     */
-    Permission[Permission["ManageTeams"] = 12] = "ManageTeams";
-    /**
-     * The permission to publish blocks for an organization.
-     */
-    Permission[Permission["PublishBlocks"] = 13] = "PublishBlocks";
-    /**
-     * The permission to delete blocks for an organization.
-     */
-    Permission[Permission["DeleteBlocks"] = 14] = "DeleteBlocks";
-    /**
-     * The permission to send manual push notifications for an app.
-     */
-    Permission[Permission["PushNotifications"] = 15] = "PushNotifications";
-    /**
-     * The permission to read assets.
-     */
-    Permission[Permission["ReadAssets"] = 16] = "ReadAssets";
-    /**
-     * The permission to read resources.
-     */
-    Permission[Permission["ReadResources"] = 17] = "ReadResources";
-    /**
-     * The permission to view private apps of an organization.
-     */
-    Permission[Permission["ViewApps"] = 18] = "ViewApps";
-    /**
-     * The permission to view the list of members in an organization.
-     */
-    Permission[Permission["ViewMembers"] = 19] = "ViewMembers";
-    /**
-     * The permission to create collections.
-     */
-    Permission[Permission["CreateCollections"] = 20] = "CreateCollections";
-    /**
-     * The permission to delete collections.
-     */
-    Permission[Permission["DeleteCollections"] = 21] = "DeleteCollections";
-    /**
-     * The permission to edit collections.
-     */
-    Permission[Permission["EditCollections"] = 22] = "EditCollections";
-    /**
-     * The permission to create app accounts.
-     */
-    Permission[Permission["CreateAppAccounts"] = 23] = "CreateAppAccounts";
-    /**
-     * The permission to read app accounts.
-     */
-    Permission[Permission["ReadAppAccounts"] = 24] = "ReadAppAccounts";
-    /**
-     * The permission to delete app accounts.
-     */
-    Permission[Permission["DeleteAppAccounts"] = 25] = "DeleteAppAccounts";
-    /**
-     * The permission to edit app accounts.
-     */
-    Permission[Permission["EditAppAccounts"] = 26] = "EditAppAccounts";
-})(Permission || (Permission = {}));
-//# sourceMappingURL=Permission.js.map

package/constants/roles.d.ts

@@ -1,16 +0,0 @@
-import { Permission } from './Permission.js';
-export declare const roles: {
-    readonly Member: Permission[];
-    readonly Translator: Permission[];
-    readonly APIReader: Permission[];
-    readonly APIUser: Permission[];
-    readonly AppEditor: Permission[];
-    readonly Owner: Permission[];
-    readonly Maintainer: Permission[];
-    readonly AccountManager: Permission[];
-};
-export type Role = keyof typeof roles;
-export declare enum TeamRole {
-    Member = "member",
-    Manager = "manager"
-}

package/constants/roles.js

@@ -1,58 +0,0 @@
-import { Permission } from './Permission.js';
-const member = [Permission.ViewApps, Permission.ViewMembers];
-const Translator = [...member, Permission.EditAppMessages];
-const APIReader = [...member, Permission.ReadAssets, Permission.ReadResources];
-const APIUser = [...APIReader, Permission.ManageAssets, Permission.ManageResources];
-const AccountManager = [
-    Permission.CreateAppAccounts,
-    Permission.ReadAppAccounts,
-    Permission.DeleteAppAccounts,
-    Permission.EditAppAccounts,
-];
-const AppEditor = [
-    ...member,
-    Permission.EditApps,
-    Permission.EditAppMessages,
-    Permission.ManageAssets,
-    Permission.ManageResources,
-    Permission.PushNotifications,
-    Permission.ReadAssets,
-    Permission.ReadResources,
-];
-const Maintainer = [
-    ...AppEditor,
-    ...AccountManager,
-    Permission.CreateApps,
-    Permission.DeleteApps,
-    Permission.EditAppSettings,
-    Permission.InviteMember,
-    Permission.ManageTeams,
-    Permission.PublishBlocks,
-    Permission.DeleteBlocks,
-    Permission.CreateCollections,
-    Permission.DeleteCollections,
-    Permission.EditCollections,
-];
-const Owner = [
-    ...Maintainer,
-    Permission.EditOrganization,
-    Permission.DeleteOrganization,
-    Permission.ManageMembers,
-    Permission.ManageRoles,
-];
-export const roles = {
-    Member: member,
-    Translator,
-    APIReader,
-    APIUser,
-    AppEditor,
-    Owner,
-    Maintainer,
-    AccountManager,
-};
-export var TeamRole;
-(function (TeamRole) {
-    TeamRole["Member"] = "member";
-    TeamRole["Manager"] = "manager";
-})(TeamRole || (TeamRole = {}));
-//# sourceMappingURL=roles.js.map