@ankhorage/zora 3.0.2 → 3.1.1

package/dist/metadata/bindableComponentMeta.d.ts

@@ -563,6 +563,491 @@ export declare const ZORA_BINDABLE_COMPONENT_META: {
             };
         };
     };
+    readonly ReaderSurface: {
+        readonly bindings: {
+            readonly props: {
+                readonly location: {
+                    readonly label: "Location";
+                    readonly description: "Opaque adapter locator to restore.";
+                    readonly value: {
+                        readonly type: "string";
+                    };
+                    readonly acceptsFallback: true;
+                    readonly acceptsTransforms: true;
+                };
+                readonly page: {
+                    readonly label: "Page";
+                    readonly description: "One-based visible page.";
+                    readonly value: {
+                        readonly type: "number";
+                    };
+                    readonly acceptsFallback: true;
+                    readonly acceptsTransforms: true;
+                };
+                readonly pageCount: {
+                    readonly label: "Page count";
+                    readonly description: "Current number of logical pages.";
+                    readonly value: {
+                        readonly type: "number";
+                    };
+                    readonly acceptsFallback: true;
+                    readonly acceptsTransforms: true;
+                };
+                readonly progress: {
+                    readonly label: "Progress";
+                    readonly description: "Reading progression clamped from zero to one.";
+                    readonly value: {
+                        readonly type: "number";
+                    };
+                    readonly acceptsFallback: true;
+                    readonly acceptsTransforms: true;
+                };
+                readonly status: {
+                    readonly label: "Status";
+                    readonly description: "Current reader loading status.";
+                    readonly value: {
+                        readonly type: "string";
+                    };
+                    readonly acceptsFallback: true;
+                    readonly acceptsTransforms: true;
+                };
+            };
+            readonly events: {
+                readonly previousPage: {
+                    readonly label: "Previous page";
+                    readonly description: "Requests navigation to the previous page.";
+                    readonly payload: {
+                        readonly eventType: "reader.previousPage";
+                        readonly fields: readonly [];
+                    };
+                };
+                readonly nextPage: {
+                    readonly label: "Next page";
+                    readonly description: "Requests navigation to the next page.";
+                    readonly payload: {
+                        readonly eventType: "reader.nextPage";
+                        readonly fields: readonly [];
+                    };
+                };
+                readonly locationChange: {
+                    readonly label: "Location change";
+                    readonly description: "Runs after the adapter displays a destination.";
+                    readonly payload: {
+                        readonly eventType: "reader.locationChange";
+                        readonly fields: readonly [{
+                            readonly path: "format";
+                            readonly type: "string";
+                            readonly label: "Format";
+                        }, {
+                            readonly path: "locator";
+                            readonly type: "string";
+                            readonly label: "Opaque locator";
+                        }, {
+                            readonly path: "page";
+                            readonly type: "number";
+                            readonly label: "Page";
+                        }, {
+                            readonly path: "pageCount";
+                            readonly type: "number";
+                            readonly label: "Page count";
+                        }, {
+                            readonly path: "progression";
+                            readonly type: "number";
+                            readonly label: "Progression";
+                        }, {
+                            readonly path: "chapterId";
+                            readonly type: "string";
+                            readonly label: "Chapter ID";
+                        }, {
+                            readonly path: "chapterTitle";
+                            readonly type: "string";
+                            readonly label: "Chapter title";
+                        }, {
+                            readonly path: "trigger";
+                            readonly type: "string";
+                            readonly label: "Navigation trigger";
+                        }];
+                    };
+                };
+                readonly openContents: {
+                    readonly label: "Open contents";
+                    readonly payload: {
+                        readonly eventType: "reader.openContents";
+                        readonly fields: readonly [];
+                    };
+                };
+                readonly openAppearance: {
+                    readonly label: "Open appearance";
+                    readonly payload: {
+                        readonly eventType: "reader.openAppearance";
+                        readonly fields: readonly [];
+                    };
+                };
+                readonly toggleHighlight: {
+                    readonly label: "Toggle highlight";
+                    readonly payload: {
+                        readonly eventType: "reader.toggleHighlight";
+                        readonly fields: readonly [];
+                    };
+                };
+                readonly openExternalLink: {
+                    readonly label: "Open external link";
+                    readonly payload: {
+                        readonly eventType: "reader.openExternalLink";
+                        readonly fields: readonly [{
+                            readonly path: "url";
+                            readonly type: "string";
+                            readonly label: "URL";
+                        }];
+                    };
+                };
+                readonly readerError: {
+                    readonly label: "Reader error";
+                    readonly payload: {
+                        readonly eventType: "reader.error";
+                        readonly fields: readonly [{
+                            readonly path: "code";
+                            readonly type: "string";
+                            readonly label: "Error code";
+                        }, {
+                            readonly path: "format";
+                            readonly type: "string";
+                            readonly label: "Format";
+                        }, {
+                            readonly path: "message";
+                            readonly type: "string";
+                            readonly label: "Message";
+                        }];
+                    };
+                };
+            };
+        };
+        readonly name: "ReaderSurface";
+        readonly category: "pattern";
+        readonly description: "Adapter-neutral EPUB and PDF reader shell with controlled chrome, progress, and navigation events.";
+        readonly directManifestNode: true;
+        readonly requirements: {
+            readonly capabilities: readonly [{
+                readonly capability: "ebookReader";
+            }];
+        };
+        readonly allowedChildren: readonly [];
+        readonly blueprint: {
+            readonly label: "Reader";
+            readonly defaultProps: {
+                readonly format: "epub";
+                readonly status: "idle";
+                readonly showChrome: true;
+                readonly readerColorScheme: "system";
+                readonly fontScale: 1;
+                readonly lineHeight: "normal";
+            };
+        };
+        readonly events: {
+            readonly previousPage: {
+                readonly label: "Previous page";
+                readonly eventType: "reader.previousPage";
+                readonly description: "Requests navigation to the previous page.";
+                readonly payloadFields: readonly [];
+            };
+            readonly nextPage: {
+                readonly label: "Next page";
+                readonly eventType: "reader.nextPage";
+                readonly description: "Requests navigation to the next page.";
+                readonly payloadFields: readonly [];
+            };
+            readonly locationChange: {
+                readonly label: "Location change";
+                readonly eventType: "reader.locationChange";
+                readonly description: "Emitted by the adapter after the destination has been displayed.";
+                readonly payloadFields: readonly [{
+                    readonly path: "format";
+                    readonly type: "string";
+                    readonly label: "Format";
+                }, {
+                    readonly path: "locator";
+                    readonly type: "string";
+                    readonly label: "Opaque locator";
+                }, {
+                    readonly path: "page";
+                    readonly type: "number";
+                    readonly label: "Page";
+                }, {
+                    readonly path: "pageCount";
+                    readonly type: "number";
+                    readonly label: "Page count";
+                }, {
+                    readonly path: "progression";
+                    readonly type: "number";
+                    readonly label: "Progression";
+                }, {
+                    readonly path: "chapterId";
+                    readonly type: "string";
+                    readonly label: "Chapter ID";
+                }, {
+                    readonly path: "chapterTitle";
+                    readonly type: "string";
+                    readonly label: "Chapter title";
+                }, {
+                    readonly path: "trigger";
+                    readonly type: "string";
+                    readonly label: "Navigation trigger";
+                }];
+            };
+            readonly openContents: {
+                readonly label: "Open contents";
+                readonly eventType: "reader.openContents";
+                readonly description: "Requests the app-owned table of contents.";
+                readonly payloadFields: readonly [];
+            };
+            readonly openAppearance: {
+                readonly label: "Open appearance";
+                readonly eventType: "reader.openAppearance";
+                readonly description: "Requests the app-owned reader appearance controls.";
+                readonly payloadFields: readonly [];
+            };
+            readonly toggleHighlight: {
+                readonly label: "Toggle highlight";
+                readonly eventType: "reader.toggleHighlight";
+                readonly description: "Requests the app-owned highlight action.";
+                readonly payloadFields: readonly [];
+            };
+            readonly openExternalLink: {
+                readonly label: "Open external link";
+                readonly eventType: "reader.openExternalLink";
+                readonly description: "Emitted when publication content requests an external URL.";
+                readonly payloadFields: readonly [{
+                    readonly path: "url";
+                    readonly type: "string";
+                    readonly label: "URL";
+                }];
+            };
+            readonly readerError: {
+                readonly label: "Reader error";
+                readonly eventType: "reader.error";
+                readonly description: "Emitted when the adapter rejects or cannot load a document.";
+                readonly payloadFields: readonly [{
+                    readonly path: "code";
+                    readonly type: "string";
+                    readonly label: "Error code";
+                }, {
+                    readonly path: "format";
+                    readonly type: "string";
+                    readonly label: "Format";
+                }, {
+                    readonly path: "message";
+                    readonly type: "string";
+                    readonly label: "Message";
+                }];
+            };
+        };
+        readonly slots: {
+            readonly viewport: {
+                readonly label: "Reader viewport adapter";
+                readonly allowedChildren: readonly [];
+            };
+            readonly headerActions: {
+                readonly label: "Header actions";
+                readonly allowedChildren: readonly ["Box", "Stack", "Grid", "Container", "Divider", "Text", "Heading", "Button", "ButtonGroup", "ThemeModeToggle", "Input", "Textarea", "FormField", "Card", "Panel", "Notice", "EmptyState", "SectionHeader", "SettingsRow", "PostCard", "ChatListItem", "MessageBubble", "ReaderSurface"];
+            };
+            readonly footerActions: {
+                readonly label: "Footer actions";
+                readonly allowedChildren: readonly ["Box", "Stack", "Grid", "Container", "Divider", "Text", "Heading", "Button", "ButtonGroup", "ThemeModeToggle", "Input", "Textarea", "FormField", "Card", "Panel", "Notice", "EmptyState", "SectionHeader", "SettingsRow", "PostCard", "ChatListItem", "MessageBubble", "ReaderSurface"];
+            };
+        };
+        readonly props: {
+            readonly source: {
+                readonly type: "media";
+                readonly category: "Document";
+                readonly label: "Source";
+                readonly mediaKinds: readonly ["file"];
+            };
+            readonly format: {
+                readonly type: "enum";
+                readonly category: "Document";
+                readonly label: "Format";
+                readonly enum: readonly ["epub", "pdf"];
+                readonly default: "epub";
+            };
+            readonly location: {
+                readonly type: "string";
+                readonly category: "State";
+                readonly label: "Location";
+            };
+            readonly status: {
+                readonly type: "enum";
+                readonly category: "State";
+                readonly label: "Status";
+                readonly enum: readonly ["idle", "loading", "ready", "error"];
+                readonly default: "idle";
+            };
+            readonly page: {
+                readonly type: "number";
+                readonly category: "State";
+                readonly label: "Page";
+            };
+            readonly pageCount: {
+                readonly type: "number";
+                readonly category: "State";
+                readonly label: "Page count";
+            };
+            readonly progress: {
+                readonly type: "number";
+                readonly category: "State";
+                readonly label: "Progress";
+            };
+            readonly canGoPrevious: {
+                readonly type: "boolean";
+                readonly category: "State";
+                readonly label: "Can go previous";
+            };
+            readonly canGoNext: {
+                readonly type: "boolean";
+                readonly category: "State";
+                readonly label: "Can go next";
+            };
+            readonly title: {
+                readonly type: "string";
+                readonly category: "Content";
+                readonly label: "Title";
+            };
+            readonly subtitle: {
+                readonly type: "string";
+                readonly category: "Content";
+                readonly label: "Subtitle";
+            };
+            readonly chapterLabel: {
+                readonly type: "string";
+                readonly category: "Content";
+                readonly label: "Chapter label";
+            };
+            readonly pageLabel: {
+                readonly type: "string";
+                readonly category: "Content";
+                readonly label: "Page label";
+            };
+            readonly previousPageLabel: {
+                readonly type: "string";
+                readonly category: "Content";
+                readonly label: "Previous page label";
+                readonly default: "Previous page";
+            };
+            readonly nextPageLabel: {
+                readonly type: "string";
+                readonly category: "Content";
+                readonly label: "Next page label";
+                readonly default: "Next page";
+            };
+            readonly contentsLabel: {
+                readonly type: "string";
+                readonly category: "Content";
+                readonly label: "Contents label";
+                readonly default: "Table of contents";
+            };
+            readonly appearanceLabel: {
+                readonly type: "string";
+                readonly category: "Content";
+                readonly label: "Appearance label";
+                readonly default: "Reading appearance";
+            };
+            readonly highlightLabel: {
+                readonly type: "string";
+                readonly category: "Content";
+                readonly label: "Highlight label";
+                readonly default: "Toggle highlight";
+            };
+            readonly loadingLabel: {
+                readonly type: "string";
+                readonly category: "Content";
+                readonly label: "Loading label";
+                readonly default: "Loading document…";
+            };
+            readonly errorTitle: {
+                readonly type: "string";
+                readonly category: "Content";
+                readonly label: "Error title";
+                readonly default: "Unable to open this document.";
+            };
+            readonly unavailableTitle: {
+                readonly type: "string";
+                readonly category: "Content";
+                readonly label: "Unavailable title";
+                readonly default: "Reader preview unavailable.";
+            };
+            readonly showChrome: {
+                readonly type: "boolean";
+                readonly category: "Chrome";
+                readonly label: "Show chrome";
+                readonly default: true;
+            };
+            readonly readerColorScheme: {
+                readonly type: "enum";
+                readonly category: "Appearance";
+                readonly label: "Color scheme";
+                readonly enum: readonly ["system", "light", "dark", "sepia"];
+                readonly default: "system";
+            };
+            readonly fontScale: {
+                readonly type: "number";
+                readonly category: "Appearance";
+                readonly label: "Font scale";
+                readonly default: 1;
+            };
+            readonly lineHeight: {
+                readonly type: "enum";
+                readonly category: "Appearance";
+                readonly label: "Line height";
+                readonly enum: readonly ["compact", "normal", "relaxed"];
+                readonly default: "normal";
+            };
+            readonly highlighted: {
+                readonly type: "boolean";
+                readonly category: "State";
+                readonly label: "Highlighted";
+                readonly default: false;
+            };
+            readonly onPreviousPage: {
+                readonly type: "action";
+                readonly category: "Events";
+                readonly label: "Previous page action";
+            };
+            readonly onNextPage: {
+                readonly type: "action";
+                readonly category: "Events";
+                readonly label: "Next page action";
+            };
+            readonly onLocationChange: {
+                readonly type: "action";
+                readonly category: "Events";
+                readonly label: "Location change action";
+            };
+            readonly onOpenContents: {
+                readonly type: "action";
+                readonly category: "Events";
+                readonly label: "Open contents action";
+            };
+            readonly onOpenAppearance: {
+                readonly type: "action";
+                readonly category: "Events";
+                readonly label: "Open appearance action";
+            };
+            readonly onToggleHighlight: {
+                readonly type: "action";
+                readonly category: "Events";
+                readonly label: "Toggle highlight action";
+            };
+            readonly onOpenExternalLink: {
+                readonly type: "action";
+                readonly category: "Events";
+                readonly label: "Open external link action";
+            };
+            readonly onReaderError: {
+                readonly type: "action";
+                readonly category: "Events";
+                readonly label: "Reader error action";
+            };
+        };
+    };
 };
 export type ZoraBindableComponentType = keyof typeof ZORA_BINDABLE_COMPONENT_META;
 //# sourceMappingURL=bindableComponentMeta.d.ts.map

package/dist/metadata/bindableComponentMeta.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bindableComponentMeta.d.ts","sourceRoot":"","sources":["../../src/metadata/bindableComponentMeta.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4cG,CAAC;AAE7C,MAAM,MAAM,yBAAyB,GAAG,MAAM,OAAO,4BAA4B,CAAC"}
+{"version":3,"file":"bindableComponentMeta.d.ts","sourceRoot":"","sources":["../../src/metadata/bindableComponentMeta.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAijBG,CAAC;AAE7C,MAAM,MAAM,yBAAyB,GAAG,MAAM,OAAO,4BAA4B,CAAC"}

package/dist/metadata/bindableComponentMeta.js

@@ -1,4 +1,5 @@
 import { imageMeta } from '../components/image/meta';
+import { readerSurfaceMeta } from '../patterns/reader/meta';
 export const ZORA_BINDABLE_COMPONENT_META = {
     Text: {
         name: 'Text',
@@ -459,5 +460,106 @@ export const ZORA_BINDABLE_COMPONENT_META = {
             },
         },
     },
+    ReaderSurface: {
+        ...readerSurfaceMeta,
+        bindings: {
+            props: {
+                location: {
+                    label: 'Location',
+                    description: 'Opaque adapter locator to restore.',
+                    value: { type: 'string' },
+                    acceptsFallback: true,
+                    acceptsTransforms: true,
+                },
+                page: {
+                    label: 'Page',
+                    description: 'One-based visible page.',
+                    value: { type: 'number' },
+                    acceptsFallback: true,
+                    acceptsTransforms: true,
+                },
+                pageCount: {
+                    label: 'Page count',
+                    description: 'Current number of logical pages.',
+                    value: { type: 'number' },
+                    acceptsFallback: true,
+                    acceptsTransforms: true,
+                },
+                progress: {
+                    label: 'Progress',
+                    description: 'Reading progression clamped from zero to one.',
+                    value: { type: 'number' },
+                    acceptsFallback: true,
+                    acceptsTransforms: true,
+                },
+                status: {
+                    label: 'Status',
+                    description: 'Current reader loading status.',
+                    value: { type: 'string' },
+                    acceptsFallback: true,
+                    acceptsTransforms: true,
+                },
+            },
+            events: {
+                previousPage: {
+                    label: 'Previous page',
+                    description: 'Requests navigation to the previous page.',
+                    payload: { eventType: 'reader.previousPage', fields: [] },
+                },
+                nextPage: {
+                    label: 'Next page',
+                    description: 'Requests navigation to the next page.',
+                    payload: { eventType: 'reader.nextPage', fields: [] },
+                },
+                locationChange: {
+                    label: 'Location change',
+                    description: 'Runs after the adapter displays a destination.',
+                    payload: {
+                        eventType: 'reader.locationChange',
+                        fields: [
+                            { path: 'format', type: 'string', label: 'Format' },
+                            { path: 'locator', type: 'string', label: 'Opaque locator' },
+                            { path: 'page', type: 'number', label: 'Page' },
+                            { path: 'pageCount', type: 'number', label: 'Page count' },
+                            { path: 'progression', type: 'number', label: 'Progression' },
+                            { path: 'chapterId', type: 'string', label: 'Chapter ID' },
+                            { path: 'chapterTitle', type: 'string', label: 'Chapter title' },
+                            { path: 'trigger', type: 'string', label: 'Navigation trigger' },
+                        ],
+                    },
+                },
+                openContents: {
+                    label: 'Open contents',
+                    payload: { eventType: 'reader.openContents', fields: [] },
+                },
+                openAppearance: {
+                    label: 'Open appearance',
+                    payload: { eventType: 'reader.openAppearance', fields: [] },
+                },
+                toggleHighlight: {
+                    label: 'Toggle highlight',
+                    payload: { eventType: 'reader.toggleHighlight', fields: [] },
+                },
+                openExternalLink: {
+                    label: 'Open external link',
+                    payload: {
+                        eventType: 'reader.openExternalLink',
+                        fields: [{ path: 'url', type: 'string', label: 'URL' }],
+                    },
+                },
+                readerError: {
+                    label: 'Reader error',
+                    payload: {
+                        eventType: 'reader.error',
+                        fields: [
+                            { path: 'code', type: 'string', label: 'Error code' },
+                            { path: 'format', type: 'string', label: 'Format' },
+                            { path: 'message', type: 'string', label: 'Message' },
+                        ],
+                    },
+                },
+            },
+        },
+    },
 };
 //# sourceMappingURL=bindableComponentMeta.js.map