@brika/permissions 0.3.1

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@brika/permissions",
+  "version": "0.3.1",
+  "description": "Plugin permission definitions and validation for BRIKA",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/brikalabs/brika.git",
+    "directory": "packages/permissions"
+  },
+  "keywords": ["brika", "permissions", "validation"],
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "scripts": {
+    "typecheck": "tsgo --noEmit",
+    "test": "bun test"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.3.9"
+  }
+}

package/src/__tests__/permissions.test.ts

@@ -0,0 +1,56 @@
+import { describe, expect, test } from 'bun:test';
+import { filterValidPermissions, isValidPermission, PERMISSION_LIST, PERMISSIONS } from '..';
+
+// ─────────────────────────────────────────────────────────────────────────────
+// isValidPermission
+// ─────────────────────────────────────────────────────────────────────────────
+
+describe('isValidPermission', () => {
+  test('accepts known permissions', () => {
+    expect(isValidPermission('location')).toBe(true);
+  });
+
+  test('rejects unknown strings', () => {
+    expect(isValidPermission('network')).toBe(false);
+    expect(isValidPermission('')).toBe(false);
+    expect(isValidPermission('Location')).toBe(false);
+  });
+});
+
+// ─────────────────────────────────────────────────────────────────────────────
+// filterValidPermissions
+// ─────────────────────────────────────────────────────────────────────────────
+
+describe('filterValidPermissions', () => {
+  test('keeps valid permissions, drops invalid', () => {
+    expect(filterValidPermissions(['location', 'network', 'bogus'])).toEqual(['location']);
+  });
+
+  test('returns empty for all invalid', () => {
+    expect(filterValidPermissions(['x', 'y'])).toEqual([]);
+  });
+
+  test('returns empty for empty input', () => {
+    expect(filterValidPermissions([])).toEqual([]);
+  });
+});
+
+// ─────────────────────────────────────────────────────────────────────────────
+// PERMISSIONS registry
+// ─────────────────────────────────────────────────────────────────────────────
+
+describe('PERMISSIONS registry', () => {
+  test('has metadata for each permission', () => {
+    expect(PERMISSIONS.location).toEqual({
+      id: 'location',
+      icon: 'map-pin',
+      labelKey: 'plugins:permissions.location',
+      descriptionKey: 'plugins:permissions.locationDesc',
+    });
+  });
+
+  test('PERMISSION_LIST matches PERMISSIONS values', () => {
+    expect(PERMISSION_LIST).toEqual(Object.values(PERMISSIONS));
+    expect(PERMISSION_LIST.length).toBeGreaterThan(0);
+  });
+});

package/src/index.ts

@@ -0,0 +1,12 @@
+import { createRegistry } from './registry';
+
+// Add new permissions here.
+export const { PERMISSIONS, PERMISSION_LIST, isValidPermission, filterValidPermissions } =
+  createRegistry({
+    location: {
+      icon: 'map-pin',
+    },
+  });
+
+export type Permission = keyof typeof PERMISSIONS;
+export type { PermissionDefinition } from './registry';

package/src/registry.ts

@@ -0,0 +1,46 @@
+export interface PermissionDefinition {
+  readonly id: string;
+  readonly icon: string;
+  readonly labelKey: string;
+  readonly descriptionKey: string;
+}
+
+export function createRegistry<
+  T extends Record<
+    string,
+    {
+      icon: string;
+    }
+  >,
+>(map: T) {
+  type P = keyof T & string;
+
+  const PERMISSIONS = Object.fromEntries(
+    Object.entries(map).map(([id, meta]) => [
+      id,
+      {
+        id,
+        ...meta,
+        labelKey: `plugins:permissions.${id}`,
+        descriptionKey: `plugins:permissions.${id}Desc`,
+      },
+    ])
+  ) as Readonly<Record<P, PermissionDefinition>>;
+
+  const PERMISSION_LIST: readonly PermissionDefinition[] = Object.values(PERMISSIONS);
+
+  function isValidPermission(value: string): value is P {
+    return Object.hasOwn(PERMISSIONS, value);
+  }
+
+  function filterValidPermissions(values: string[]): P[] {
+    return values.filter(isValidPermission);
+  }
+
+  return {
+    PERMISSIONS,
+    PERMISSION_LIST,
+    isValidPermission,
+    filterValidPermissions,
+  };
+}

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["src"]
+}