@stamhoofd/structures 2.23.0 → 2.24.0

package/dist/src/Permissions.d.ts

@@ -1,137 +1,9 @@
-import { AutoEncoder, AutoEncoderPatchType } from '@simonbackx/simple-encoding';
-import { MemberResponsibility } from './MemberResponsibility';
-import { MemberResponsibilityRecord } from './members/MemberResponsibilityRecord';
-/**
- * PermissionLevels are used to grant permissions to specific resources or system wide
- */
-export declare enum PermissionLevel {
-    /** No access */
-    None = "None",
-    /** Read all data, but not allowed to write */
-    Read = "Read",
-    /** Read, write, add, delete child data, but not allowed to modify settings */
-    Write = "Write",
-    /** Full access */
-    Full = "Full"
-}
-/**
- * More granular access rights to specific things in the system
- */
-export declare enum AccessRight {
-    /**
-     * Allows the user to log in as a full-access admin to a specific organization
-     */
-    PlatformLoginAs = "PlatformLoginAs",
-    OrganizationCreateWebshops = "OrganizationCreateWebshops",
-    OrganizationManagePayments = "OrganizationManagePayments",
-    OrganizationFinanceDirector = "OrganizationFinanceDirector",
-    OrganizationCreateGroups = "OrganizationCreateGroups",
-    MemberReadFinancialData = "MemberReadFinancialData",
-    MemberWriteFinancialData = "MemberWriteFinancialData",
-    WebshopScanTickets = "WebshopScanTickets"
-}
-export declare class AccessRightHelper {
-    static getName(right: AccessRight): string;
-    static getNameShort(right: AccessRight): string;
-    static getDescription(right: AccessRight): string;
-    static getLongDescription(right: AccessRight): string | null;
-    /**
-     * If a user has a certain permission level, automatically grant the specific access right
-     * By default only full permissions gives all access rights, but you can tweak it:
-     * E.g., give webshop scan rights if you also have write access to that webshop
-     */
-    static autoGrantRightForLevel(right: AccessRight): PermissionLevel | null;
-    /**
-     * Automatically grant a user access rights if they have a certain right
-     */
-    static autoInheritFrom(right: AccessRight): AccessRight[];
-}
-export declare function getPermissionLevelNumber(level: PermissionLevel): number;
-export declare function maximumPermissionlevel(...levels: PermissionLevel[]): PermissionLevel;
-export declare function minimumPermissionLevel(...levels: PermissionLevel[]): PermissionLevel;
-export declare function getPermissionLevelName(level: PermissionLevel): string;
-export declare class PermissionRole extends AutoEncoder {
-    id: string;
-    name: string;
-}
-/**
- * More granular access rights to specific things in the system
- */
-export declare enum PermissionsResourceType {
-    Webshops = "Webshops",
-    Groups = "Groups",
-    GroupCategories = "GroupCategories",
-    OrganizationTags = "OrganizationTags",
-    RecordCategories = "RecordCategory"
-}
-export declare function getPermissionResourceTypeName(type: PermissionsResourceType, plural?: boolean): string;
-/**
- * More granular access rights to specific things in the system
- */
-export declare class ResourcePermissions extends AutoEncoder {
-    /**
-     * This is a cache so we can display the role description without fetching all resources
-     */
-    resourceName: string;
-    /**
-     * Setting it to full gives all possible permissions for the resource
-     * Read/Write depends on resource
-     */
-    level: PermissionLevel;
-    /**
-     * More granular permissions related to this resource
-     */
-    accessRights: AccessRight[];
-    hasAccess(level: PermissionLevel): boolean;
-    hasAccessRight(right: AccessRight): boolean;
-    createInsertPatch(type: PermissionsResourceType, resourceId: string, roleOrPermissions: PermissionRoleDetailed): AutoEncoderPatchType<PermissionRoleDetailed>;
-    createInsertPatch(type: PermissionsResourceType, resourceId: string, roleOrPermissions: Permissions): AutoEncoderPatchType<Permissions>;
-    merge(other: ResourcePermissions): ResourcePermissions;
-}
-export declare class PermissionRoleDetailed extends PermissionRole {
-    /**
-     * Generic access to all resources
-     */
-    level: PermissionLevel;
-    accessRights: AccessRight[];
-    resources: Map<PermissionsResourceType, Map<string, ResourcePermissions>>;
-    legacyManagePayments: boolean;
-    legacyFinanceDirector: boolean;
-    legacyCreateWebshops: boolean;
-    getDescription(): string;
-    hasAccess(level: PermissionLevel): boolean;
-    hasAccessRight(right: AccessRight): boolean;
-    getResourcePermissions(type: PermissionsResourceType, id: string): ResourcePermissions | null;
-    getMergedResourcePermissions(type: PermissionsResourceType, id: string): ResourcePermissions | null;
-    hasResourceAccess(type: PermissionsResourceType, id: string, level: PermissionLevel): boolean;
-    hasResourceAccessRight(type: PermissionsResourceType, id: string, right: AccessRight): boolean;
-    add(other: PermissionRoleDetailed): void;
-    get isEmpty(): boolean;
-}
-export declare class PermissionRoleForResponsibility extends PermissionRoleDetailed {
-    responsibilityId: string;
-    responsibilityGroupId: string | null;
-}
-/**
- * @deprecated
- * Use resource types
- * Give access to a given resouce based by the roles of a user
- */
-export declare class PermissionsByRole extends AutoEncoder {
-    read: PermissionRole[];
-    write: PermissionRole[];
-    full: PermissionRole[];
-    getPermissionLevel(permissions: LoadedPermissions): PermissionLevel;
-    /**
-    * Whetever a given user has access to the members in this group.
-    */
-    getRolePermissionLevel(role: PermissionRole): PermissionLevel;
-    hasAccess(permissions: LoadedPermissions | undefined | null, level: PermissionLevel): boolean;
-    roleHasAccess(role: PermissionRole, level?: PermissionLevel): boolean;
-    hasFullAccess(permissions: LoadedPermissions | undefined | null): boolean;
-    hasWriteAccess(permissions: LoadedPermissions | undefined | null): boolean;
-    hasReadAccess(permissions: LoadedPermissions | undefined | null): boolean;
-}
+import { AutoEncoder } from '@simonbackx/simple-encoding';
+import { MemberResponsibilityRecordBase } from './members/MemberResponsibilityRecord';
+import { PermissionLevel } from './PermissionLevel';
+import { PermissionRole } from './PermissionRole';
+import { PermissionsResourceType } from './PermissionsResourceType';
+import { ResourcePermissions } from './ResourcePermissions';
 export declare class Permissions extends AutoEncoder {
     /**
      * Automatically have all permissions (e.g. when someone created a new group)
@@ -139,7 +11,7 @@ export declare class Permissions extends AutoEncoder {
      */
     level: PermissionLevel;
     roles: PermissionRole[];
-    responsibilities: MemberResponsibilityRecord[];
+    responsibilities: MemberResponsibilityRecordBase[];
     /**
      * Mostly for temporary access
      */
@@ -148,28 +20,4 @@ export declare class Permissions extends AutoEncoder {
     add(other: Permissions): void;
     get isEmpty(): boolean;
 }
-/**
- * Identical to Permissions but with detailed roles, loaded from the organization or platform
- */
-export declare class LoadedPermissions {
-    level: PermissionLevel;
-    roles: PermissionRoleDetailed[];
-    resources: Map<PermissionsResourceType, Map<string, ResourcePermissions>>;
-    constructor(data: Partial<LoadedPermissions>);
-    static create(data: Partial<LoadedPermissions>): LoadedPermissions;
-    static buildRoleForResponsibility(groupId: string | null, responsibilityData: MemberResponsibility, inheritedResponsibilityRoles: PermissionRoleForResponsibility[]): PermissionRoleForResponsibility;
-    static from(permissions: Permissions, allRoles: PermissionRoleDetailed[], inheritedResponsibilityRoles: PermissionRoleForResponsibility[], allResponsibilites: MemberResponsibility[]): LoadedPermissions;
-    getResourcePermissions(type: PermissionsResourceType, id: string): ResourcePermissions | null;
-    getMergedResourcePermissions(type: PermissionsResourceType, id: string): ResourcePermissions | null;
-    hasRole(role: PermissionRole): boolean;
-    hasAccess(level: PermissionLevel): boolean;
-    hasResourceAccess(type: PermissionsResourceType, id: string, level: PermissionLevel): boolean;
-    hasResourceAccessRight(type: PermissionsResourceType, id: string, right: AccessRight): boolean;
-    hasReadAccess(): boolean;
-    hasWriteAccess(): boolean;
-    hasFullAccess(): boolean;
-    hasAccessRight(right: AccessRight): boolean;
-    merge(other: LoadedPermissions): LoadedPermissions;
-    get isEmpty(): boolean;
-}
 //# sourceMappingURL=Permissions.d.ts.map

package/dist/src/Permissions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Permissions.d.ts","sourceRoot":"","sources":["../../src/Permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,WAAW,EAAE,oBAAoB,EAA2E,MAAM,6BAA6B,CAAC;AAIvK,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,EAAE,0BAA0B,EAAE,MAAM,sCAAsC,CAAC;AAElF;;GAEG;AACH,oBAAY,eAAe;IACvB,gBAAgB;IAChB,IAAI,SAAS;IAEb,8CAA8C;IAC9C,IAAI,SAAS;IAEb,8EAA8E;IAC9E,KAAK,UAAU;IAEf,kBAAkB;IAClB,IAAI,SAAS;CAChB;AAED;;GAEG;AACH,oBAAY,WAAW;IAEnB;;OAEG;IACH,eAAe,oBAAoB;IAGnC,0BAA0B,+BAA+B;IACzD,0BAA0B,+BAA+B;IACzD,2BAA2B,gCAAgC;IAC3D,wBAAwB,6BAA6B;IAKrD,uBAAuB,4BAA4B;IACnD,wBAAwB,6BAA6B;IAGrD,kBAAkB,uBAAuB;CAC5C;AAED,qBAAa,iBAAiB;IAC1B,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM;IAe1C,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM;IAe/C,MAAM,CAAC,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM;IAejD,MAAM,CAAC,kBAAkB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,GAAC,IAAI;IAY1D;;;;OAIG;IACH,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,WAAW,GAAG,eAAe,GAAC,IAAI;IAOvE;;OAEG;IACH,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,WAAW,GAAG,WAAW,EAAE;CAW5D;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,eAAe,GAAG,MAAM,CAWvE;AAED,wBAAgB,sBAAsB,CAAC,GAAG,MAAM,EAAE,eAAe,EAAE,GAAG,eAAe,CASpF;AAED,wBAAgB,sBAAsB,CAAC,GAAG,MAAM,EAAE,eAAe,EAAE,GAAG,eAAe,CASpF;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,eAAe,GAAG,MAAM,CAWrE;AAED,qBAAa,cAAe,SAAQ,WAAW;IAE3C,EAAE,EAAE,MAAM,CAAC;IAGX,IAAI,SAAM;CACb;AAGD;;GAEG;AACH,oBAAY,uBAAuB;IAC/B,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,eAAe,oBAAoB;IACnC,gBAAgB,qBAAqB;IACrC,gBAAgB,mBAAmB;CACtC;AAGD,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,uBAAuB,EAAE,MAAM,UAAO,GAAG,MAAM,CAQlG;AAED;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,WAAW;IAChD;;OAEG;IAEH,YAAY,SAAK;IAEjB;;;OAGG;IAEH,KAAK,EAAE,eAAe,CAAuB;IAE7C;;OAEG;IAEH,YAAY,EAAE,WAAW,EAAE,CAAK;IAEhC,SAAS,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO;IAI1C,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;IAK3C,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,sBAAsB,GAAI,oBAAoB,CAAC,sBAAsB,CAAC;IAC9J,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,EAAE,UAAU,EAAE,MAAM,EAAE,iBAAiB,EAAE,WAAW,GAAG,oBAAoB,CAAC,WAAW,CAAC;IAqBvI,KAAK,CAAC,KAAK,EAAE,mBAAmB,GAAG,mBAAmB;CAiBzD;AAED,qBAAa,sBAAuB,SAAQ,cAAc;IACtD;;OAEG;IAEH,KAAK,EAAE,eAAe,CAAuB;IAqB7C,YAAY,EAAE,WAAW,EAAE,CAAK;IAahC,SAAS,EAAE,GAAG,CAAC,uBAAuB,EAAE,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAY;IAGrF,oBAAoB,UAAQ;IAG5B,qBAAqB,UAAQ;IAG7B,oBAAoB,UAAQ;IAE5B,cAAc;IA0Cd,SAAS,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO;IAI1C,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;IAgB3C,sBAAsB,CAAC,IAAI,EAAE,uBAAuB,EAAE,EAAE,EAAE,MAAM,GAAG,mBAAmB,GAAC,IAAI;IAsB3F,4BAA4B,CAAC,IAAI,EAAE,uBAAuB,EAAE,EAAE,EAAE,MAAM,GAAG,mBAAmB,GAAC,IAAI;IAajG,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO;IAQ7F,sBAAsB,CAAC,IAAI,EAAE,uBAAuB,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO;IAQ9F,GAAG,CAAC,KAAK,EAAE,sBAAsB;IA2BjC,IAAI,OAAO,YAEV;CACJ;AAED,qBAAa,+BAAgC,SAAQ,sBAAsB;IAEvE,gBAAgB,EAAE,MAAM,CAAA;IAGxB,qBAAqB,EAAE,MAAM,GAAC,IAAI,CAAO;CAC5C;AAED;;;;GAIG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;IAE9C,IAAI,EAAE,cAAc,EAAE,CAAK;IAG3B,KAAK,EAAE,cAAc,EAAE,CAAK;IAG5B,IAAI,EAAE,cAAc,EAAE,CAAK;IAE3B,kBAAkB,CAAC,WAAW,EAAE,iBAAiB,GAAG,eAAe;IAkClE;;MAEE;IACH,sBAAsB,CAAC,IAAI,EAAE,cAAc,GAAG,eAAe;IAqB7D,SAAS,CAAC,WAAW,EAAE,iBAAiB,GAAC,SAAS,GAAC,IAAI,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO;IAOzF,aAAa,CAAC,IAAI,EAAE,cAAc,EAAE,KAAK,GAAE,eAAsC,GAAG,OAAO;IAI3F,aAAa,CAAC,WAAW,EAAE,iBAAiB,GAAC,SAAS,GAAC,IAAI,GAAG,OAAO;IAIrE,cAAc,CAAC,WAAW,EAAE,iBAAiB,GAAC,SAAS,GAAC,IAAI,GAAG,OAAO;IAItE,aAAa,CAAC,WAAW,EAAE,iBAAiB,GAAC,SAAS,GAAC,IAAI,GAAG,OAAO;CAGxE;AAED,qBAAa,WAAY,SAAQ,WAAW;IACxC;;;OAGG;IAEH,KAAK,EAAE,eAAe,CAAuB;IAG7C,KAAK,EAAE,cAAc,EAAE,CAAK;IAG5B,gBAAgB,EAAE,0BAA0B,EAAE,CAAK;IAEnD;;OAEG;IAYH,SAAS,EAAE,GAAG,CAAC,uBAAuB,EAAE,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAY;IAErF,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO;IAItC,GAAG,CAAC,KAAK,EAAE,WAAW;IAkBtB,IAAI,OAAO,YAEV;CACJ;AAED;;GAEG;AACH,qBAAa,iBAAiB;IAC1B,KAAK,EAAE,eAAe,CAAuB;IAC7C,KAAK,EAAE,sBAAsB,EAAE,CAAK;IACpC,SAAS,EAAE,GAAG,CAAC,uBAAuB,EAAE,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAY;gBAEzE,IAAI,EAAE,OAAO,CAAC,iBAAiB,CAAC;IAI5C,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,iBAAiB,CAAC;IAI9C,MAAM,CAAC,0BAA0B,CAAC,OAAO,EAAE,MAAM,GAAC,IAAI,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,4BAA4B,EAAE,+BAA+B,EAAE;IA6BjK,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,sBAAsB,EAAE,EAAE,4BAA4B,EAAE,+BAA+B,EAAE,EAAE,kBAAkB,EAAE,oBAAoB,EAAE;IAoCrL,sBAAsB,CAAC,IAAI,EAAE,uBAAuB,EAAE,EAAE,EAAE,MAAM,GAAG,mBAAmB,GAAC,IAAI;IAqB3F,4BAA4B,CAAC,IAAI,EAAE,uBAAuB,EAAE,EAAE,EAAE,MAAM,GAAG,mBAAmB,GAAC,IAAI;IAwBjG,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO;IAItC,SAAS,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO;IAe1C,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO;IAkB7F,sBAAsB,CAAC,IAAI,EAAE,uBAAuB,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,OAAO;IAwB9F,aAAa,IAAI,OAAO;IAIxB,cAAc,IAAI,OAAO;IAIzB,aAAa,IAAI,OAAO;IAIxB,cAAc,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;IAqB3C,KAAK,CAAC,KAAK,EAAE,iBAAiB,GAAG,iBAAiB;IAmClD,IAAI,OAAO,YAEV;CACJ"}
+{"version":3,"file":"Permissions.d.ts","sourceRoot":"","sources":["../../src/Permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,WAAW,EAAiD,MAAM,6BAA6B,CAAC;AAEvH,OAAO,EAAE,8BAA8B,EAAE,MAAM,sCAAsC,CAAC;AACtF,OAAO,EAA4B,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,qBAAa,WAAY,SAAQ,WAAW;IACxC;;;OAGG;IAEH,KAAK,EAAE,eAAe,CAAuB;IAG7C,KAAK,EAAE,cAAc,EAAE,CAAK;IAG5B,gBAAgB,EAAE,8BAA8B,EAAE,CAAK;IAEvD;;OAEG;IAYH,SAAS,EAAE,GAAG,CAAC,uBAAuB,EAAE,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAY;IAErF,OAAO,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO;IAItC,GAAG,CAAC,KAAK,EAAE,WAAW;IAkBtB,IAAI,OAAO,YAEV;CACJ"}