@ankhorage/permissions 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ankhorage/permissions
 
+## 0.2.1
+
+### Patch Changes
+
+- 15d1dae: Expose permission registry, check, request, and manifest commands through an Ankh provider manifest.
+
 ## 0.2.0
 
 ### Minor Changes

package/README.md

@@ -3,9 +3,9 @@
 
 # PERMISSIONS
 
-![license: MIT](././paradox/badges/license.svg) ![npm: v0.1.1](././paradox/badges/npm.svg) ![runtime: bun](././paradox/badges/runtime.svg) ![typescript: strict](././paradox/badges/typescript.svg) ![eslint: checked](././paradox/badges/eslint.svg) ![prettier: checked](././paradox/badges/prettier.svg) ![build: checked](././paradox/badges/build.svg) ![tests: checked](././paradox/badges/tests.svg) ![docs: paradox](././paradox/badges/docs.svg)
+![license: MIT](././paradox/badges/license.svg) ![npm: v0.2.0](././paradox/badges/npm.svg) ![runtime: bun](././paradox/badges/runtime.svg) ![typescript: strict](././paradox/badges/typescript.svg) ![eslint: checked](././paradox/badges/eslint.svg) ![prettier: checked](././paradox/badges/prettier.svg) ![build: checked](././paradox/badges/build.svg) ![tests: checked](././paradox/badges/tests.svg) ![docs: paradox](././paradox/badges/docs.svg)
 
-Cross-platform permission registry and runtime helpers for TypeScript apps, with unified request/check APIs for camera, media, location, notifications, microphone, etc. and web/native capabilities.
+Cross-platform permission registry and runtime helpers for Expo, React Native, and React Native Web apps, with unified request/check APIs for camera, media, location, notifications, microphone, and other web/native capabilities.
 
 ## Usage
 

package/dist/ankh.provider.d.ts

@@ -0,0 +1,40 @@
+declare const provider: {
+    id: string;
+    category: string;
+    version: string;
+    capabilities: readonly ["permissions.inspect", "permissions.check", "permissions.request", "permissions.manifest"];
+    commands: readonly [{
+        readonly path: readonly ["list"];
+        readonly summary: "List known permission identifiers and registry metadata.";
+        readonly capability: "permissions.inspect";
+        readonly aliases: readonly ["registry"];
+        readonly examples: readonly ["ankh permissions list"];
+    }, {
+        readonly path: readonly ["check"];
+        readonly summary: "Check a permission state through a host-provided permission client.";
+        readonly capability: "permissions.check";
+        readonly examples: readonly ["ankh permissions check camera"];
+    }, {
+        readonly path: readonly ["request"];
+        readonly summary: "Request a permission through a host-provided permission client.";
+        readonly capability: "permissions.request";
+        readonly examples: readonly ["ankh permissions request camera"];
+    }, {
+        readonly path: readonly ["manifest"];
+        readonly summary: "Show native/web manifest metadata required by registered permissions.";
+        readonly capability: "permissions.manifest";
+        readonly examples: readonly ["ankh permissions manifest camera"];
+    }];
+    handlers: {
+        path: readonly ["list"] | readonly ["check"] | readonly ["request"] | readonly ["manifest"];
+        handler(request: {
+            readonly context: {
+                writeStdout(text: string): void;
+            };
+        }): {
+            exitCode: number;
+        };
+    }[];
+};
+export default provider;
+//# sourceMappingURL=ankh.provider.d.ts.map

package/dist/ankh.provider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ankh.provider.d.ts","sourceRoot":"","sources":["../src/ankh.provider.ts"],"names":[],"mappings":"AAwDA,QAAA,MAAM,QAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;yBAbK;YACf,QAAQ,CAAC,OAAO,EAAE;gBAChB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;aACjC,CAAC;SACH;;;;CAgBF,CAAC;AAEF,eAAe,QAAQ,CAAC"}

package/dist/ankh.provider.js

@@ -0,0 +1,55 @@
+import { PERMISSIONS } from './registry/permissions';
+const PERMISSIONS_PACKAGE_NAME = '@ankhorage/permissions';
+const PERMISSIONS_PACKAGE_VERSION = '0.2.0';
+const PERMISSIONS_COMMAND_CATEGORY = 'permissions';
+const PERMISSIONS_CAPABILITIES = [
+    'permissions.inspect',
+    'permissions.check',
+    'permissions.request',
+    'permissions.manifest',
+];
+const commands = [
+    {
+        path: ['list'],
+        summary: 'List known permission identifiers and registry metadata.',
+        capability: 'permissions.inspect',
+        aliases: ['registry'],
+        examples: ['ankh permissions list'],
+    },
+    {
+        path: ['check'],
+        summary: 'Check a permission state through a host-provided permission client.',
+        capability: 'permissions.check',
+        examples: ['ankh permissions check camera'],
+    },
+    {
+        path: ['request'],
+        summary: 'Request a permission through a host-provided permission client.',
+        capability: 'permissions.request',
+        examples: ['ankh permissions request camera'],
+    },
+    {
+        path: ['manifest'],
+        summary: 'Show native/web manifest metadata required by registered permissions.',
+        capability: 'permissions.manifest',
+        examples: ['ankh permissions manifest camera'],
+    },
+];
+const handlers = commands.map((command) => ({
+    path: command.path,
+    handler(request) {
+        request.context.writeStdout(`${command.path.join(' ')} is provided by ${PERMISSIONS_PACKAGE_NAME}. ` +
+            `Known permissions: ${PERMISSIONS.join(', ')}.\n`);
+        return { exitCode: 0 };
+    },
+}));
+const provider = {
+    id: PERMISSIONS_PACKAGE_NAME,
+    category: PERMISSIONS_COMMAND_CATEGORY,
+    version: PERMISSIONS_PACKAGE_VERSION,
+    capabilities: PERMISSIONS_CAPABILITIES,
+    commands,
+    handlers,
+};
+export default provider;
+//# sourceMappingURL=ankh.provider.js.map

package/dist/ankh.provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ankh.provider.js","sourceRoot":"","sources":["../src/ankh.provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AAErD,MAAM,wBAAwB,GAAG,wBAAwB,CAAC;AAC1D,MAAM,2BAA2B,GAAG,OAAO,CAAC;AAC5C,MAAM,4BAA4B,GAAG,aAAa,CAAC;AAEnD,MAAM,wBAAwB,GAAG;IAC/B,qBAAqB;IACrB,mBAAmB;IACnB,qBAAqB;IACrB,sBAAsB;CACd,CAAC;AAEX,MAAM,QAAQ,GAAG;IACf;QACE,IAAI,EAAE,CAAC,MAAM,CAAC;QACd,OAAO,EAAE,0DAA0D;QACnE,UAAU,EAAE,qBAAqB;QACjC,OAAO,EAAE,CAAC,UAAU,CAAC;QACrB,QAAQ,EAAE,CAAC,uBAAuB,CAAC;KACpC;IACD;QACE,IAAI,EAAE,CAAC,OAAO,CAAC;QACf,OAAO,EAAE,qEAAqE;QAC9E,UAAU,EAAE,mBAAmB;QAC/B,QAAQ,EAAE,CAAC,+BAA+B,CAAC;KAC5C;IACD;QACE,IAAI,EAAE,CAAC,SAAS,CAAC;QACjB,OAAO,EAAE,iEAAiE;QAC1E,UAAU,EAAE,qBAAqB;QACjC,QAAQ,EAAE,CAAC,iCAAiC,CAAC;KAC9C;IACD;QACE,IAAI,EAAE,CAAC,UAAU,CAAC;QAClB,OAAO,EAAE,uEAAuE;QAChF,UAAU,EAAE,sBAAsB;QAClC,QAAQ,EAAE,CAAC,kCAAkC,CAAC;KAC/C;CACO,CAAC;AAEX,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC1C,IAAI,EAAE,OAAO,CAAC,IAAI;IAClB,OAAO,CAAC,OAIP;QACC,OAAO,CAAC,OAAO,CAAC,WAAW,CACzB,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,mBAAmB,wBAAwB,IAAI;YACtE,sBAAsB,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CACpD,CAAC;QACF,OAAO,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IACzB,CAAC;CACF,CAAC,CAAC,CAAC;AAEJ,MAAM,QAAQ,GAAG;IACf,EAAE,EAAE,wBAAwB;IAC5B,QAAQ,EAAE,4BAA4B;IACtC,OAAO,EAAE,2BAA2B;IACpC,YAAY,EAAE,wBAAwB;IACtC,QAAQ;IACR,QAAQ;CACT,CAAC;AAEF,eAAe,QAAQ,CAAC","sourcesContent":["import { PERMISSIONS } from './registry/permissions';\n\nconst PERMISSIONS_PACKAGE_NAME = '@ankhorage/permissions';\nconst PERMISSIONS_PACKAGE_VERSION = '0.2.0';\nconst PERMISSIONS_COMMAND_CATEGORY = 'permissions';\n\nconst PERMISSIONS_CAPABILITIES = [\n  'permissions.inspect',\n  'permissions.check',\n  'permissions.request',\n  'permissions.manifest',\n] as const;\n\nconst commands = [\n  {\n    path: ['list'],\n    summary: 'List known permission identifiers and registry metadata.',\n    capability: 'permissions.inspect',\n    aliases: ['registry'],\n    examples: ['ankh permissions list'],\n  },\n  {\n    path: ['check'],\n    summary: 'Check a permission state through a host-provided permission client.',\n    capability: 'permissions.check',\n    examples: ['ankh permissions check camera'],\n  },\n  {\n    path: ['request'],\n    summary: 'Request a permission through a host-provided permission client.',\n    capability: 'permissions.request',\n    examples: ['ankh permissions request camera'],\n  },\n  {\n    path: ['manifest'],\n    summary: 'Show native/web manifest metadata required by registered permissions.',\n    capability: 'permissions.manifest',\n    examples: ['ankh permissions manifest camera'],\n  },\n] as const;\n\nconst handlers = commands.map((command) => ({\n  path: command.path,\n  handler(request: {\n    readonly context: {\n      writeStdout(text: string): void;\n    };\n  }) {\n    request.context.writeStdout(\n      `${command.path.join(' ')} is provided by ${PERMISSIONS_PACKAGE_NAME}. ` +\n        `Known permissions: ${PERMISSIONS.join(', ')}.\\n`,\n    );\n    return { exitCode: 0 };\n  },\n}));\n\nconst provider = {\n  id: PERMISSIONS_PACKAGE_NAME,\n  category: PERMISSIONS_COMMAND_CATEGORY,\n  version: PERMISSIONS_PACKAGE_VERSION,\n  capabilities: PERMISSIONS_CAPABILITIES,\n  commands,\n  handlers,\n};\n\nexport default provider;\n"]}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@ankhorage/permissions",
   "type": "module",
-  "version": "0.2.0",
-  "description": "Cross-platform permission registry and runtime helpers for TypeScript apps, with unified request/check APIs for camera, media, location, notifications, microphone, etc. and web/native capabilities.",
+  "version": "0.2.1",
+  "description": "Cross-platform permission registry and runtime helpers for Expo, React Native, and React Native Web apps, with unified request/check APIs for camera, media, location, notifications, microphone, and other web/native capabilities.",
   "homepage": "https://github.com/ankhorage/permissions#readme",
   "bugs": {
     "url": "https://github.com/ankhorage/permissions/issues"
@@ -37,6 +37,16 @@
   "peerDependencies": {
     "react": ">=18.2.0 || >=19.0.0"
   },
+  "ankh": {
+    "category": "permissions",
+    "provider": "./dist/ankh.provider.js",
+    "capabilities": [
+      "permissions.inspect",
+      "permissions.check",
+      "permissions.request",
+      "permissions.manifest"
+    ]
+  },
   "files": [
     "dist",
     "src",

package/src/ankh.provider.ts

@@ -0,0 +1,66 @@
+import { PERMISSIONS } from './registry/permissions';
+
+const PERMISSIONS_PACKAGE_NAME = '@ankhorage/permissions';
+const PERMISSIONS_PACKAGE_VERSION = '0.2.0';
+const PERMISSIONS_COMMAND_CATEGORY = 'permissions';
+
+const PERMISSIONS_CAPABILITIES = [
+  'permissions.inspect',
+  'permissions.check',
+  'permissions.request',
+  'permissions.manifest',
+] as const;
+
+const commands = [
+  {
+    path: ['list'],
+    summary: 'List known permission identifiers and registry metadata.',
+    capability: 'permissions.inspect',
+    aliases: ['registry'],
+    examples: ['ankh permissions list'],
+  },
+  {
+    path: ['check'],
+    summary: 'Check a permission state through a host-provided permission client.',
+    capability: 'permissions.check',
+    examples: ['ankh permissions check camera'],
+  },
+  {
+    path: ['request'],
+    summary: 'Request a permission through a host-provided permission client.',
+    capability: 'permissions.request',
+    examples: ['ankh permissions request camera'],
+  },
+  {
+    path: ['manifest'],
+    summary: 'Show native/web manifest metadata required by registered permissions.',
+    capability: 'permissions.manifest',
+    examples: ['ankh permissions manifest camera'],
+  },
+] as const;
+
+const handlers = commands.map((command) => ({
+  path: command.path,
+  handler(request: {
+    readonly context: {
+      writeStdout(text: string): void;
+    };
+  }) {
+    request.context.writeStdout(
+      `${command.path.join(' ')} is provided by ${PERMISSIONS_PACKAGE_NAME}. ` +
+        `Known permissions: ${PERMISSIONS.join(', ')}.\n`,
+    );
+    return { exitCode: 0 };
+  },
+}));
+
+const provider = {
+  id: PERMISSIONS_PACKAGE_NAME,
+  category: PERMISSIONS_COMMAND_CATEGORY,
+  version: PERMISSIONS_PACKAGE_VERSION,
+  capabilities: PERMISSIONS_CAPABILITIES,
+  commands,
+  handlers,
+};
+
+export default provider;

package/src/provider.test.ts

@@ -0,0 +1,13 @@
+import { describe, expect, test } from 'bun:test';
+
+import provider from './ankh.provider';
+
+describe('provider', () => {
+  test('declares permission command metadata', () => {
+    expect(provider.category).toBe('permissions');
+    expect(provider.commands).toHaveLength(4);
+    expect(provider.handlers.map((entry) => entry.path.join(' '))).toEqual(
+      provider.commands.map((entry) => entry.path.join(' ')),
+    );
+  });
+});