add angular-permission definitions for RoleStore, PermissionStore, Role and Permission

2026-09-11 11:50:54 +08:00 · 2016-04-06 21:00:42 +09:00
parent 4814b5682d
commit a0dcbb804d
2 changed files with 256 additions and 0 deletions
@@ -0,0 +1,164 @@
+// Type definitions for angular-permission 2.3.1
+// Project: https://github.com/Narzerus/angular-permission
+// Definitions by: Voislav Mishevski <https://github.com/vmishevski>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/// <reference path="../angularjs/angular.d.ts" />
+/// <reference path="../angular-ui-router/angular-ui-router.d.ts" />
+
+declare module 'angular-permission' {
+  export interface PermissionStore {
+    /**
+     * Allows to define permission on application configuration
+     * @method
+     *
+     * @param permissionName {String} Name of defined permission
+     * @param validationFunction {Function} Function used to validate if permission is valid
+     */
+    definePermission(
+      name: string,
+      validationFunction: (stateParams?: angular.ui.IStateParamsService, permission?: string) => boolean | angular.IPromise<any>
+    ): void;
+
+    /**
+     * Allows to define set of permissionNames with shared validation function on application configuration
+     * @method
+     * @throws {TypeError}
+     *
+     * @param permissionNames {Array} Set of permission names
+     * @param validationFunction {Function} Function used to validate if permission is valid
+     */
+    defineManyPermissions(
+      permissions: string[],
+      validationFunction: (stateParams?: angular.ui.IStateParamsService, permission?: string) => boolean | angular.IPromise<any>
+    ): void;
+
+    clearStore(): void;
+
+    /**
+     * Deletes permission
+     * @method
+     *
+     * @param permissionName {String} Name of defined permission
+     */
+    removePermissionDefinition(permission: string): void;
+
+    /**
+     * Checks if permission exists
+     * @method
+     *
+     * @param permissionName {String} Name of defined permission
+     * @returns {Boolean}
+     */
+    hasPermissionDefinition(permissionName: string): boolean;
+
+    /**
+     * Returns all permissions
+     * @method
+     *
+     * @returns {Object} Permissions collection
+     */
+    getStore(): Permission[];
+  }
+
+  export interface RoleStore {
+    /**
+     * Allows to define role
+     * @method
+     *
+     * @param roleName {String} Name of defined role
+     * @param permissions {Array} Set of permission names
+     * @param [validationFunction] {Function} Function used to validate if permissions in role are valid
+     */
+    defineRole(
+      role: string,
+      permissions: Array<string>,
+      validationFunction: RoleValidationFunction
+    ): void;
+
+    /**
+     * Allows to define role
+     * @method
+     *
+     * @param roleName {String} Name of defined role
+     * @param permissions {Array} Set of permission names
+     */
+    defineRole(role: string, permissions: Array<string>): void;
+
+    /**
+     * Checks if role is defined in store
+     * @method
+     *
+     * @param roleName {String} Name of role
+     * @returns {Boolean}
+     */
+    hasRoleDefinition(role: string): boolean;
+
+    /**
+     * Returns role definition object by it's name
+     * @method
+     *
+     * @returns {permission.Role} Role definition object
+     */
+    getRoleDefinition(roleName: string): Role;
+
+    /**
+     * Removes all role definitions
+     * @method
+     */
+    clearStore(): void;
+
+    /**
+     * Deletes role from store
+     * @method
+     *
+     * @param roleName {String} Name of defined permission
+     */
+    removeRoleDefinition(roleName: string): void;
+
+    /**
+     * Returns all role definitions
+     * @method
+     *
+     * @returns {Object} Defined roles collection
+     */
+    getStore(): Role[];
+  }
+
+  export interface Role {
+    roleName: string;
+    permissionNames: string[];
+    validationFunction?: RoleValidationFunction;
+  }
+
+  export interface Permission {
+    permissionName: string;
+    validationFunction?: PermissionValidationFunction;
+  }
+
+  interface RoleValidationFunction {
+    (stateParams?: angular.ui.IStateParamsService, permission?: string): boolean | angular.IPromise<any>;
+  }
+
+  interface PermissionValidationFunction {
+    (stateParams?: angular.ui.IStateParamsService, permission?: string): boolean | angular.IPromise<any>;
+  }
+
+  export interface IPermissionState extends angular.ui.IState {
+    data?: any | DataWithPermissions;
+  }
+
+  export interface DataWithPermissions {
+    permissions?: {
+      only?: (() => void) | Array<string> | angular.IPromise<any>;
+      except?: (() => void) | Array<string> | angular.IPromise<any>;
+      redirectTo: string | (() => string) | (() => PermissionRedirectConfigation) | {[index: string]: PermissionRedirectConfigation}
+    };
+  }
+
+  export interface PermissionRedirectConfigation {
+    state: string;
+    params?: {};
+    options?: angular.ui.IStateOptions;
+  }
+}