@codeleap/permissions 5.0.7

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@codeleap/permissions",
+  "version": "5.0.7",
+  "main": "src/index.ts",
+  "license": "UNLICENSED",
+  "repository": {
+    "url": "https://github.com/codeleap-uk/internal-libs-monorepo.git",
+    "type": "git",
+    "directory": "packages/permissions"
+  },
+  "devDependencies": {
+    "@codeleap/config": "5.0.7",
+    "@codeleap/store": "5.0.7",
+    "@codeleap/types": "5.0.7",
+    "ts-node-dev": "1.1.8"
+  },
+  "scripts": {
+    "build": "echo 'No build needed'"
+  },
+  "peerDependencies": {
+    "@codeleap/store": "5.0.7",
+    "@codeleap/types": "5.0.7",
+    "typescript": "5.5.2"
+  }
+}

package/package.json.bak

@@ -0,0 +1,25 @@
+{
+  "name": "@codeleap/permissions",
+  "version": "5.0.7",
+  "main": "src/index.ts",
+  "license": "UNLICENSED",
+  "repository": {
+    "url": "https://github.com/codeleap-uk/internal-libs-monorepo.git",
+    "type": "git",
+    "directory": "packages/permissions"
+  },
+  "devDependencies": {
+    "@codeleap/config": "workspace:*",
+    "@codeleap/store": "workspace:*",
+    "@codeleap/types": "workspace:*",
+    "ts-node-dev": "1.1.8"
+  },
+  "scripts": {
+    "build": "echo 'No build needed'"
+  },
+  "peerDependencies": {
+    "@codeleap/store": "workspace:*",
+    "@codeleap/types": "workspace:*",
+    "typescript": "5.5.2"
+  }
+}

package/src/Permission.ts

@@ -0,0 +1,125 @@
+import { GlobalState, globalState } from '@codeleap/store'
+import { PermissionOptions } from './types'
+import { PermissionConfig, PermissionStatus } from './globals'
+import { TypeGuards } from '@codeleap/types'
+
+export class Permission {
+  /** The name of the permission. */
+  public name: string
+
+  private state: GlobalState<PermissionStatus>
+
+  private checkStatus: () => Promise<PermissionStatus>
+
+  private requestStatus: () => Promise<PermissionStatus>
+
+  static logsEnabled: boolean = false
+
+  static is(status: PermissionStatus) {
+    return {
+      value: status,
+      isGranted: status === 'granted',
+      isLimited: status === 'limited',
+      isDenied: status === 'denied',
+      isBlocked: status === 'blocked',
+    }
+  }
+
+  /** Configuration object associated with the permission. */
+  public config: PermissionConfig
+
+  /**
+   * Gets the current permission status.
+   * @returns The current permission status.
+   */
+  get value() {
+    return this.state.get()
+  }
+
+  get isGranted() {
+    return Permission.is(this.value).isGranted
+  }
+
+  get isLimited() {
+    return Permission.is(this.value).isLimited
+  }
+
+  get isDenied() {
+    return Permission.is(this.value).isDenied
+  }
+
+  get isBlocked() {
+    return Permission.is(this.value).isBlocked
+  }
+
+  constructor(options: PermissionOptions<PermissionConfig>) {
+    const { name, config, check, request } = options
+
+    this.state = globalState(null as PermissionStatus, { persistKey: 'permissions-' + name })
+
+    this.name = name
+    this.config = config
+    this.checkStatus = check
+    this.requestStatus = request
+  }
+
+  private log(msg: string, obj?: any) {
+    if (!Permission.logsEnabled) return
+    console.log(`[Permissions] ${this.name} -> ${msg}`, obj)
+  }
+
+  /**
+   * Updates the permission status.
+   * @param newStatus - The new permission status.
+   */
+  set(newStatus: PermissionStatus) {
+    this.state.set(newStatus)
+  }
+
+  /**
+   * React hook for consuming the permission state.
+   * @returns The current permission status state.
+   */
+  use() {
+    return this.state.use()
+  }
+
+  /**
+   * Checks the current permission status and updates the state if it has changed.
+   * @returns The checked permission status.
+   */
+  async check() {
+    let status = await this.checkStatus()
+
+    if (status === 'denied' && this.value === 'blocked') {
+      status = this.value
+    }
+
+    const update = status != this.value
+
+    if (update && TypeGuards.isString(status)) {
+      this.set(status as PermissionStatus)
+    }
+
+    this.log('check', { status, update })
+
+    return status
+  }
+
+  /**
+   * Requests the permission and updates the state if it has changed.
+   * @returns The requested permission status.
+   */
+  async request() {
+    const status = await this.requestStatus()
+    const update = status != this.value
+
+    if (update && TypeGuards.isString(status)) {
+      this.set(status as PermissionStatus)
+    }
+
+    this.log('request', { status, update })
+
+    return status
+  }
+}

package/src/PermissionsManager.ts

@@ -0,0 +1,128 @@
+import { Permission } from './Permission'
+import { PermissionOptions } from './types'
+import { PermissionStatus, PermissionConfig } from './globals'
+
+export class PermissionsManager<P extends string> {
+  private requester: (permission: Permission) => Promise<PermissionStatus>
+
+  permissions: Record<P, Permission> = {} as Record<P, Permission>
+
+  private get keys() {
+    return Object.keys(this.permissions) as P[]
+  }
+
+  /**
+   * Retrieves the current status values of all permissions.
+   * @returns An object mapping permission names to their statuses.
+   */
+  get values() {
+    const values = {} as Record<P, PermissionStatus>
+
+    this.forEach(permission => {
+      values[permission.name] = permission.value
+    })
+
+    return values
+  }
+
+  private async forEach(callbackFn: (permission: Permission) => void) {
+    for (const permissionName in this.permissions) {
+      const permission = this.permissions[permissionName]
+      callbackFn(permission)
+    }
+  }
+
+  constructor(
+    requester: (permission: Permission) => Promise<PermissionStatus>,
+    permissions: Record<P, Omit<PermissionOptions<PermissionConfig>, 'name'>>
+  ) {
+    for (const permission in permissions) {
+      const permissionConfig = permissions[permission]
+
+      const permissionClass = new Permission({
+        ...permissionConfig,
+        name: permission,
+      })
+
+      this.permissions[permission as unknown as P] = permissionClass
+    }
+
+    this.requester = requester
+
+    this.checkAll()
+  }
+
+  private log(msg: string, obj?: any) {
+    if (!Permission.logsEnabled) return
+    console.log(`[Permissions] -> ${msg}`, obj)
+  }
+
+  /**
+   * React hook for consuming the permission state.
+   * @returns The current permission status state.
+   */
+  use(permissionName: P) {
+    return this.permissions[permissionName].use()
+  }
+
+  /**
+   * Requests a specific permission.
+   * @param {P} permissionName - The name of the permission to request.
+   * @returns The updated permission status.
+   */
+  async request(permissionName: P) {
+    const permission = this.permissions[permissionName]
+    const status = await this.requester(permission)
+    return Permission.is(status)
+  }
+
+  /**
+   * Checks the status of a specific permission.
+   * @param {P} permissionName - The name of the permission to check.
+   * @returns The current permission status.
+   */
+  async check(permissionName: P) {
+    const permission = this.permissions[permissionName]
+    const status = await permission.check()
+    return Permission.is(status)
+  }
+
+  /**
+   * Requests multiple permissions at once.
+   * @param {P[]} permissionsNames - An array of permission names to request.
+   * @returns A record of updated permission statuses.
+   */
+  async requestMany<K extends P>(permissionsNames: K[]): Promise<Record<K, ReturnType<typeof Permission.is>>> {
+    const status = {} as Record<K, ReturnType<typeof Permission.is>>
+
+    for (const permissionName of permissionsNames) {
+      status[permissionName] = await this.request(permissionName)
+    }
+
+    return status
+  }
+
+  /**
+   * Checks the status of multiple permissions at once.
+   * @param {P[]} permissionsNames - An array of permission names to check.
+   * @returns A record of current permission statuses.
+   */
+  async checkMany<K extends P>(permissionsNames: K[]): Promise<Record<K, ReturnType<typeof Permission.is>>> {
+    const status = {} as Record<K, ReturnType<typeof Permission.is>>
+
+    for (const permissionName of permissionsNames) {
+      status[permissionName] = await this.check(permissionName)
+    }
+
+    return status
+  }
+
+  /**
+   * Checks the status of all managed permissions.
+   * @returns A record of all current permission statuses.
+   */
+  async checkAll() {
+    this.log('checkAll')
+    return await this.checkMany(this.keys)
+  }
+}

package/src/globals.ts

@@ -0,0 +1,10 @@
+
+export interface PermissionConfig {
+
+}
+
+export interface Status {
+
+}
+
+export type PermissionStatus = keyof Status | null

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './PermissionsManager'
+export * from './Permission'
+export * from './types'
+export * from './globals'

package/src/types.ts

@@ -0,0 +1,9 @@
+import { AnyRecord } from '@codeleap/types'
+import { PermissionStatus } from './globals'
+
+export type PermissionOptions<Config extends AnyRecord> = {
+  name: string
+  config: Config
+  check: () => Promise<PermissionStatus>
+  request: () => Promise<PermissionStatus>
+}