@ankhorage/contracts 8.0.0 → 8.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ankhorage/contracts
 
+## 8.0.1
+
+### Patch Changes
+
+- f932e26: Add the canonical `ebookReader` platform requirement capability for manifest-authored EPUB and PDF reader surfaces.
+
 ## 8.0.0
 
 ### Major Changes

package/README.md

@@ -3,7 +3,7 @@
 
 # CONTRACTS
 
-![license: MIT](././paradox/badges/license.svg) ![npm: v7.8.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)
+![license: MIT](././paradox/badges/license.svg) ![npm: v8.0.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)
 
 Serializable app, action, theme, auth, and secret-store contracts for Ankhorage.
 

package/dist/requirements.d.ts

@@ -1,6 +1,6 @@
 export declare const ANKHORAGE_PERMISSION_NAMES: readonly ["camera", "microphone", "mediaLibrary", "mediaLibraryWrite", "locationForeground", "locationBackground", "notifications", "clipboard"];
 export type AnkhoragePermissionName = (typeof ANKHORAGE_PERMISSION_NAMES)[number];
-export declare const ANKHORAGE_CAPABILITY_NAMES: readonly ["barcodeScanner", "cameraPreview", "mediaPicker", "filePicker", "location", "notifications", "clipboard"];
+export declare const ANKHORAGE_CAPABILITY_NAMES: readonly ["barcodeScanner", "cameraPreview", "ebookReader", "mediaPicker", "filePicker", "location", "notifications", "clipboard"];
 export type AnkhorageCapabilityName = (typeof ANKHORAGE_CAPABILITY_NAMES)[number];
 export interface ScreenPermissionRequirement {
     readonly permission: AnkhoragePermissionName;

package/dist/requirements.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"requirements.d.ts","sourceRoot":"","sources":["../src/requirements.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,0BAA0B,kJAS7B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAC;AAElF,eAAO,MAAM,0BAA0B,qHAQ7B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAC;AAElF,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,UAAU,EAAE,uBAAuB,CAAC;CAC9C;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,UAAU,EAAE,uBAAuB,CAAC;CAC9C;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,2BAA2B,EAAE,CAAC;IAC9D,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,2BAA2B,EAAE,CAAC;CAChE;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,2BAA2B,EAAE,CAAC;IAC9D,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,2BAA2B,EAAE,CAAC;CAChE"}
+{"version":3,"file":"requirements.d.ts","sourceRoot":"","sources":["../src/requirements.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,0BAA0B,kJAS7B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAC;AAElF,eAAO,MAAM,0BAA0B,oIAS7B,CAAC;AAEX,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,0BAA0B,CAAC,CAAC,MAAM,CAAC,CAAC;AAElF,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,UAAU,EAAE,uBAAuB,CAAC;CAC9C;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,UAAU,EAAE,uBAAuB,CAAC;CAC9C;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,2BAA2B,EAAE,CAAC;IAC9D,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,2BAA2B,EAAE,CAAC;CAChE;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,2BAA2B,EAAE,CAAC;IAC9D,QAAQ,CAAC,YAAY,CAAC,EAAE,SAAS,2BAA2B,EAAE,CAAC;CAChE"}

package/dist/requirements.js

@@ -11,6 +11,7 @@ export const ANKHORAGE_PERMISSION_NAMES = [
 export const ANKHORAGE_CAPABILITY_NAMES = [
     'barcodeScanner',
     'cameraPreview',
+    'ebookReader',
     'mediaPicker',
     'filePicker',
     'location',

package/dist/requirements.js.map

@@ -1 +1 @@
-{"version":3,"file":"requirements.js","sourceRoot":"","sources":["../src/requirements.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,QAAQ;IACR,YAAY;IACZ,cAAc;IACd,mBAAmB;IACnB,oBAAoB;IACpB,oBAAoB;IACpB,eAAe;IACf,WAAW;CACH,CAAC;AAIX,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,gBAAgB;IAChB,eAAe;IACf,aAAa;IACb,YAAY;IACZ,UAAU;IACV,eAAe;IACf,WAAW;CACH,CAAC","sourcesContent":["export const ANKHORAGE_PERMISSION_NAMES = [\n  'camera',\n  'microphone',\n  'mediaLibrary',\n  'mediaLibraryWrite',\n  'locationForeground',\n  'locationBackground',\n  'notifications',\n  'clipboard',\n] as const;\n\nexport type AnkhoragePermissionName = (typeof ANKHORAGE_PERMISSION_NAMES)[number];\n\nexport const ANKHORAGE_CAPABILITY_NAMES = [\n  'barcodeScanner',\n  'cameraPreview',\n  'mediaPicker',\n  'filePicker',\n  'location',\n  'notifications',\n  'clipboard',\n] as const;\n\nexport type AnkhorageCapabilityName = (typeof ANKHORAGE_CAPABILITY_NAMES)[number];\n\nexport interface ScreenPermissionRequirement {\n  readonly permission: AnkhoragePermissionName;\n}\n\nexport interface ScreenCapabilityRequirement {\n  readonly capability: AnkhorageCapabilityName;\n}\n\nexport interface ScreenRequirements {\n  readonly permissions?: readonly ScreenPermissionRequirement[];\n  readonly capabilities?: readonly ScreenCapabilityRequirement[];\n}\n\nexport interface ComponentRequirements {\n  readonly permissions?: readonly ScreenPermissionRequirement[];\n  readonly capabilities?: readonly ScreenCapabilityRequirement[];\n}\n"]}
+{"version":3,"file":"requirements.js","sourceRoot":"","sources":["../src/requirements.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,QAAQ;IACR,YAAY;IACZ,cAAc;IACd,mBAAmB;IACnB,oBAAoB;IACpB,oBAAoB;IACpB,eAAe;IACf,WAAW;CACH,CAAC;AAIX,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,gBAAgB;IAChB,eAAe;IACf,aAAa;IACb,aAAa;IACb,YAAY;IACZ,UAAU;IACV,eAAe;IACf,WAAW;CACH,CAAC","sourcesContent":["export const ANKHORAGE_PERMISSION_NAMES = [\n  'camera',\n  'microphone',\n  'mediaLibrary',\n  'mediaLibraryWrite',\n  'locationForeground',\n  'locationBackground',\n  'notifications',\n  'clipboard',\n] as const;\n\nexport type AnkhoragePermissionName = (typeof ANKHORAGE_PERMISSION_NAMES)[number];\n\nexport const ANKHORAGE_CAPABILITY_NAMES = [\n  'barcodeScanner',\n  'cameraPreview',\n  'ebookReader',\n  'mediaPicker',\n  'filePicker',\n  'location',\n  'notifications',\n  'clipboard',\n] as const;\n\nexport type AnkhorageCapabilityName = (typeof ANKHORAGE_CAPABILITY_NAMES)[number];\n\nexport interface ScreenPermissionRequirement {\n  readonly permission: AnkhoragePermissionName;\n}\n\nexport interface ScreenCapabilityRequirement {\n  readonly capability: AnkhorageCapabilityName;\n}\n\nexport interface ScreenRequirements {\n  readonly permissions?: readonly ScreenPermissionRequirement[];\n  readonly capabilities?: readonly ScreenCapabilityRequirement[];\n}\n\nexport interface ComponentRequirements {\n  readonly permissions?: readonly ScreenPermissionRequirement[];\n  readonly capabilities?: readonly ScreenCapabilityRequirement[];\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ankhorage/contracts",
-  "version": "8.0.0",
+  "version": "8.0.1",
   "main": "./dist/index.js",
   "ankh": {
     "category": "contracts",

package/src/appManifest.test.ts

@@ -117,7 +117,7 @@ function createManifest(): Record<string, unknown> {
         ],
         requires: {
           permissions: [{ permission: 'camera' }],
-          capabilities: [{ capability: 'barcodeScanner' }],
+          capabilities: [{ capability: 'barcodeScanner' }, { capability: 'ebookReader' }],
         },
       },
     },

package/src/requirements.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, it } from 'bun:test';
+
+import {
+  ANKHORAGE_CAPABILITY_NAMES,
+  type AnkhorageCapabilityName,
+  type ComponentRequirements,
+  type ScreenRequirements,
+} from './index';
+
+describe('platform requirements', () => {
+  it('exports ebookReader as the canonical reader capability', () => {
+    const capability: AnkhorageCapabilityName = 'ebookReader';
+    const componentRequirements: ComponentRequirements = {
+      capabilities: [{ capability }],
+    };
+    const screenRequirements: ScreenRequirements = {
+      capabilities: [{ capability }],
+    };
+
+    expect(ANKHORAGE_CAPABILITY_NAMES).toContain(capability);
+    expect(componentRequirements).toEqual(screenRequirements);
+  });
+});

package/src/requirements.ts

@@ -14,6 +14,7 @@ export type AnkhoragePermissionName = (typeof ANKHORAGE_PERMISSION_NAMES)[number
 export const ANKHORAGE_CAPABILITY_NAMES = [
   'barcodeScanner',
   'cameraPreview',
+  'ebookReader',
   'mediaPicker',
   'filePicker',
   'location',