@ankhorage/zora 18.0.1 → 19.0.1

package/src/patterns/reader/meta.ts

@@ -1,296 +0,0 @@
-import type { ZoraComponentMeta } from '../../metadata';
-import { CONTAINER_ALLOWED_CHILDREN } from '../../metadata/allowedChildren';
-
-const EMPTY_EVENT_FIELDS = [] as const;
-
-export const readerSurfaceMeta = {
-  name: 'ReaderSurface',
-  category: 'pattern',
-  description:
-    'Adapter-neutral EPUB and PDF reader shell with controlled chrome, progress, and navigation events.',
-  directManifestNode: true,
-  requirements: {
-    capabilities: [{ capability: 'ebookReader' }],
-  },
-  allowedChildren: [],
-  blueprint: {
-    label: 'Reader',
-    defaultProps: {
-      format: 'epub',
-      status: 'idle',
-      showChrome: true,
-      readerColorScheme: 'system',
-      fontScale: 1,
-      lineHeight: 'normal',
-    },
-  },
-  events: {
-    previousPage: {
-      label: 'Previous page',
-      eventType: 'reader.previousPage',
-      description: 'Requests navigation to the previous page.',
-      payloadFields: EMPTY_EVENT_FIELDS,
-    },
-    nextPage: {
-      label: 'Next page',
-      eventType: 'reader.nextPage',
-      description: 'Requests navigation to the next page.',
-      payloadFields: EMPTY_EVENT_FIELDS,
-    },
-    locationChange: {
-      label: 'Location change',
-      eventType: 'reader.locationChange',
-      description: 'Emitted by the adapter after the destination has been displayed.',
-      payloadFields: [
-        { 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',
-      eventType: 'reader.openContents',
-      description: 'Requests the app-owned table of contents.',
-      payloadFields: EMPTY_EVENT_FIELDS,
-    },
-    openAppearance: {
-      label: 'Open appearance',
-      eventType: 'reader.openAppearance',
-      description: 'Requests the app-owned reader appearance controls.',
-      payloadFields: EMPTY_EVENT_FIELDS,
-    },
-    toggleHighlight: {
-      label: 'Toggle highlight',
-      eventType: 'reader.toggleHighlight',
-      description: 'Requests the app-owned highlight action.',
-      payloadFields: EMPTY_EVENT_FIELDS,
-    },
-    openExternalLink: {
-      label: 'Open external link',
-      eventType: 'reader.openExternalLink',
-      description: 'Emitted when publication content requests an external URL.',
-      payloadFields: [{ path: 'url', type: 'string', label: 'URL' }],
-    },
-    readerError: {
-      label: 'Reader error',
-      eventType: 'reader.error',
-      description: 'Emitted when the adapter rejects or cannot load a document.',
-      payloadFields: [
-        { path: 'code', type: 'string', label: 'Error code' },
-        { path: 'format', type: 'string', label: 'Format' },
-        { path: 'message', type: 'string', label: 'Message' },
-      ],
-    },
-  },
-  slots: {
-    viewport: {
-      label: 'Reader viewport adapter',
-      allowedChildren: [],
-    },
-    headerActions: {
-      label: 'Header actions',
-      allowedChildren: [...CONTAINER_ALLOWED_CHILDREN],
-    },
-    footerActions: {
-      label: 'Footer actions',
-      allowedChildren: [...CONTAINER_ALLOWED_CHILDREN],
-    },
-  },
-  props: {
-    source: {
-      type: 'media',
-      category: 'Document',
-      label: 'Source',
-      mediaKinds: ['file'],
-    },
-    format: {
-      type: 'enum',
-      category: 'Document',
-      label: 'Format',
-      enum: ['epub', 'pdf'],
-      default: 'epub',
-    },
-    location: {
-      type: 'string',
-      category: 'State',
-      label: 'Location',
-    },
-    status: {
-      type: 'enum',
-      category: 'State',
-      label: 'Status',
-      enum: ['idle', 'loading', 'ready', 'error'],
-      default: 'idle',
-    },
-    page: {
-      type: 'number',
-      category: 'State',
-      label: 'Page',
-    },
-    pageCount: {
-      type: 'number',
-      category: 'State',
-      label: 'Page count',
-    },
-    progress: {
-      type: 'number',
-      category: 'State',
-      label: 'Progress',
-    },
-    canGoPrevious: {
-      type: 'boolean',
-      category: 'State',
-      label: 'Can go previous',
-    },
-    canGoNext: {
-      type: 'boolean',
-      category: 'State',
-      label: 'Can go next',
-    },
-    title: {
-      type: 'string',
-      category: 'Content',
-      label: 'Title',
-    },
-    subtitle: {
-      type: 'string',
-      category: 'Content',
-      label: 'Subtitle',
-    },
-    chapterLabel: {
-      type: 'string',
-      category: 'Content',
-      label: 'Chapter label',
-    },
-    pageLabel: {
-      type: 'string',
-      category: 'Content',
-      label: 'Page label',
-    },
-    previousPageLabel: {
-      type: 'string',
-      category: 'Content',
-      label: 'Previous page label',
-      default: 'Previous page',
-    },
-    nextPageLabel: {
-      type: 'string',
-      category: 'Content',
-      label: 'Next page label',
-      default: 'Next page',
-    },
-    contentsLabel: {
-      type: 'string',
-      category: 'Content',
-      label: 'Contents label',
-      default: 'Table of contents',
-    },
-    appearanceLabel: {
-      type: 'string',
-      category: 'Content',
-      label: 'Appearance label',
-      default: 'Reading appearance',
-    },
-    highlightLabel: {
-      type: 'string',
-      category: 'Content',
-      label: 'Highlight label',
-      default: 'Toggle highlight',
-    },
-    loadingLabel: {
-      type: 'string',
-      category: 'Content',
-      label: 'Loading label',
-      default: 'Loading document…',
-    },
-    errorTitle: {
-      type: 'string',
-      category: 'Content',
-      label: 'Error title',
-      default: 'Unable to open this document.',
-    },
-    unavailableTitle: {
-      type: 'string',
-      category: 'Content',
-      label: 'Unavailable title',
-      default: 'Reader preview unavailable.',
-    },
-    showChrome: {
-      type: 'boolean',
-      category: 'Chrome',
-      label: 'Show chrome',
-      default: true,
-    },
-    readerColorScheme: {
-      type: 'enum',
-      category: 'Appearance',
-      label: 'Color scheme',
-      enum: ['system', 'light', 'dark', 'sepia'],
-      default: 'system',
-    },
-    fontScale: {
-      type: 'number',
-      category: 'Appearance',
-      label: 'Font scale',
-      default: 1,
-    },
-    lineHeight: {
-      type: 'enum',
-      category: 'Appearance',
-      label: 'Line height',
-      enum: ['compact', 'normal', 'relaxed'],
-      default: 'normal',
-    },
-    highlighted: {
-      type: 'boolean',
-      category: 'State',
-      label: 'Highlighted',
-      default: false,
-    },
-    onPreviousPage: {
-      type: 'action',
-      category: 'Events',
-      label: 'Previous page action',
-    },
-    onNextPage: {
-      type: 'action',
-      category: 'Events',
-      label: 'Next page action',
-    },
-    onLocationChange: {
-      type: 'action',
-      category: 'Events',
-      label: 'Location change action',
-    },
-    onOpenContents: {
-      type: 'action',
-      category: 'Events',
-      label: 'Open contents action',
-    },
-    onOpenAppearance: {
-      type: 'action',
-      category: 'Events',
-      label: 'Open appearance action',
-    },
-    onToggleHighlight: {
-      type: 'action',
-      category: 'Events',
-      label: 'Toggle highlight action',
-    },
-    onOpenExternalLink: {
-      type: 'action',
-      category: 'Events',
-      label: 'Open external link action',
-    },
-    onReaderError: {
-      type: 'action',
-      category: 'Events',
-      label: 'Reader error action',
-    },
-  },
-} as const satisfies ZoraComponentMeta;

package/src/patterns/reader/types.ts

@@ -1,80 +0,0 @@
-import type React from 'react';
-
-import type { ZoraBaseProps } from '../../theme/ZoraBaseProps';
-
-export type ReaderDocumentFormat = 'epub' | 'pdf';
-
-export type ReaderStatus = 'idle' | 'loading' | 'ready' | 'error';
-
-export type ReaderNavigationTrigger =
-  'swipe' | 'previousControl' | 'nextControl' | 'keyboard' | 'location';
-
-export interface ReaderLocationChangeEvent {
-  format: ReaderDocumentFormat;
-  locator: string;
-  page: number;
-  pageCount?: number;
-  progression: number;
-  chapterId?: string;
-  chapterTitle?: string;
-  trigger: ReaderNavigationTrigger;
-}
-
-export type ReaderErrorCode =
-  'invalid-document' | 'load-failed' | 'protected-document' | 'unsupported-format';
-
-export interface ReaderErrorEvent {
-  code: ReaderErrorCode;
-  format?: ReaderDocumentFormat;
-  message: string;
-}
-
-export type ReaderColorScheme = 'system' | 'light' | 'dark' | 'sepia';
-
-export type ReaderLineHeight = 'compact' | 'normal' | 'relaxed';
-
-export type ReaderResolvedSource = string | number | { readonly uri: string };
-
-export interface ReaderExternalLinkEvent {
-  url: string;
-}
-
-export interface ReaderSurfaceProps extends ZoraBaseProps {
-  source?: ReaderResolvedSource | null;
-  format: ReaderDocumentFormat;
-  location?: string;
-  status?: ReaderStatus;
-  page?: number;
-  pageCount?: number;
-  progress?: number;
-  canGoPrevious?: boolean;
-  canGoNext?: boolean;
-  title?: string;
-  subtitle?: string;
-  chapterLabel?: string;
-  pageLabel?: string;
-  previousPageLabel?: string;
-  nextPageLabel?: string;
-  contentsLabel?: string;
-  appearanceLabel?: string;
-  highlightLabel?: string;
-  loadingLabel?: string;
-  errorTitle?: string;
-  unavailableTitle?: string;
-  showChrome?: boolean;
-  readerColorScheme?: ReaderColorScheme;
-  fontScale?: number;
-  lineHeight?: ReaderLineHeight;
-  highlighted?: boolean;
-  viewport?: React.ReactNode;
-  headerActions?: React.ReactNode;
-  footerActions?: React.ReactNode;
-  onPreviousPage?: () => void | Promise<void>;
-  onNextPage?: () => void | Promise<void>;
-  onLocationChange?: (event: ReaderLocationChangeEvent) => void | Promise<void>;
-  onOpenContents?: () => void | Promise<void>;
-  onOpenAppearance?: () => void | Promise<void>;
-  onToggleHighlight?: () => void | Promise<void>;
-  onOpenExternalLink?: (event: ReaderExternalLinkEvent) => void | Promise<void>;
-  onReaderError?: (event: ReaderErrorEvent) => void | Promise<void>;
-}

package/src/patterns/scanner/BarcodeScannerView.tsx

@@ -1,130 +0,0 @@
-import React from 'react';
-import { StyleSheet } from 'react-native';
-
-import { Card } from '../../features/card/public';
-import { View } from '../../features/layout/public';
-import { Text } from '../../features/typography/public';
-import { useZoraTheme } from '../../theme/useZoraTheme';
-import { withZoraThemeScope } from '../../theme/withZoraThemeScope';
-import { CameraPermissionView } from './CameraPermissionView';
-import { ScanOverlay } from './ScanOverlay';
-import type { BarcodeScannerViewProps } from './types';
-
-function BarcodeScannerViewInner({
-  themeId: _themeId,
-  interactionPolicy,
-  mode: _mode,
-  permissionStatus,
-  camera,
-  children,
-  title = 'Scan barcode',
-  description = 'Point the camera at a barcode to continue.',
-  overlayTitle,
-  overlayDescription,
-  cornerLabel,
-  requestPermissionLabel,
-  deniedPermissionLabel,
-  manualEntryLabel,
-  onRequestPermission,
-  onManualEntry,
-  testID,
-}: BarcodeScannerViewProps) {
-  const { theme } = useZoraTheme();
-  const viewportStyle = {
-    backgroundColor: theme.semantics.surface.default,
-  };
-  const placeholderStyle = {
-    backgroundColor: theme.semantics.surface.default,
-  };
-
-  if (permissionStatus !== 'granted') {
-    return (
-      <CameraPermissionView
-        deniedLabel={deniedPermissionLabel}
-        manualEntryLabel={manualEntryLabel}
-        onManualEntry={onManualEntry}
-        onRequestPermission={onRequestPermission}
-        requestLabel={requestPermissionLabel}
-        status={permissionStatus}
-        testID={testID}
-        interactionPolicy={interactionPolicy}
-      />
-    );
-  }
-
-  return (
-    <Card
-      compact
-      description={description}
-      eyebrow="Scanner"
-      interactionPolicy={interactionPolicy}
-      testID={testID}
-      title={title}
-      tone="subtle"
-    >
-      <View gap="m">
-        <View>
-          <View style={[styles.viewport, viewportStyle]}>
-            {camera ? (
-              <View style={styles.cameraSlot}>{camera}</View>
-            ) : (
-              <View style={[styles.placeholder, placeholderStyle]} />
-            )}
-            <View style={[styles.overlay, { pointerEvents: 'none' }]}>
-              <ScanOverlay
-                cornerLabel={cornerLabel}
-                description={overlayDescription}
-                title={overlayTitle}
-              />
-            </View>
-          </View>
-        </View>
-        {children ? <View>{children}</View> : null}
-        <Text emphasis="muted" variant="caption">
-          Native scanning belongs to an app adapter such as expo-camera. ZORA owns this visible
-          scanner surface.
-        </Text>
-      </View>
-    </Card>
-  );
-}
-
-const styles = StyleSheet.create({
-  viewport: {
-    aspectRatio: 0.72,
-    borderRadius: 28,
-    minHeight: 360,
-    overflow: 'hidden',
-    position: 'relative',
-  },
-  cameraSlot: {
-    bottom: 0,
-    left: 0,
-    position: 'absolute',
-    right: 0,
-    top: 0,
-  },
-  placeholder: {
-    bottom: 0,
-    left: 0,
-    position: 'absolute',
-    right: 0,
-    top: 0,
-  },
-  overlay: {
-    bottom: 24,
-    left: 24,
-    position: 'absolute',
-    right: 24,
-    top: 24,
-  },
-});
-
-/***
- * Composed ZORA scanner shell for barcode scanning experiences.
- *
- * `BarcodeScannerView` is camera-adapter-neutral: pass an `expo-camera`, web,
- * or test camera element through `camera`; keep permission and fallback UI here.
- *
- */
-export const BarcodeScannerView = withZoraThemeScope(BarcodeScannerViewInner);

package/src/patterns/scanner/CameraPermissionView.tsx

@@ -1,112 +0,0 @@
-import React from 'react';
-
-import { Button } from '../../features/button/public';
-import { Card } from '../../features/card/public';
-import { View } from '../../features/layout/public';
-import { Text } from '../../features/typography/public';
-import { withZoraThemeScope } from '../../theme/withZoraThemeScope';
-import type { CameraPermissionViewProps } from './types';
-
-function resolvePermissionCopy(status: CameraPermissionViewProps['status']) {
-  if (status === 'denied') {
-    return {
-      title: 'Camera permission needed',
-      description:
-        'Camera access is denied. Enable camera access in system settings or enter the barcode manually.',
-    };
-  }
-
-  if (status === 'requesting') {
-    return {
-      title: 'Requesting camera access',
-      description: 'Waiting for the system permission prompt.',
-    };
-  }
-
-  return {
-    title: 'Allow camera access',
-    description:
-      'Camera access is required to scan barcodes. You can also enter the barcode manually.',
-  };
-}
-
-function CameraPermissionViewInner({
-  themeId: _themeId,
-  interactionPolicy,
-  mode: _mode,
-  status,
-  title,
-  description,
-  requestLabel = 'Allow camera access',
-  deniedLabel = 'Open settings',
-  manualEntryLabel = 'Enter barcode manually',
-  onRequestPermission,
-  onManualEntry,
-  requestButtonProps,
-  manualEntryButtonProps,
-  testID,
-}: CameraPermissionViewProps) {
-  const copy = resolvePermissionCopy(status);
-  const primaryLabel = status === 'denied' ? deniedLabel : requestLabel;
-  const handleRequestPermission = onRequestPermission
-    ? () => {
-        void onRequestPermission();
-      }
-    : undefined;
-  const handleManualEntry = onManualEntry
-    ? () => {
-        void onManualEntry();
-      }
-    : undefined;
-
-  return (
-    <Card
-      compact
-      description={description ?? copy.description}
-      eyebrow="Scanner permission"
-      interactionPolicy={interactionPolicy}
-      testID={testID}
-      title={title ?? copy.title}
-      tone="subtle"
-    >
-      <View gap="m">
-        <Text emphasis="muted" variant="bodySmall">
-          Permission state: {status}
-        </Text>
-        <View direction={{ base: 'column', md: 'row' }} gap="s">
-          {handleRequestPermission ? (
-            <Button
-              color="primary"
-              disabled={status === 'requesting'}
-              onPress={handleRequestPermission}
-              {...requestButtonProps}
-              interactionPolicy={interactionPolicy}
-            >
-              {primaryLabel}
-            </Button>
-          ) : null}
-          {handleManualEntry ? (
-            <Button
-              color="neutral"
-              onPress={handleManualEntry}
-              variant="soft"
-              {...manualEntryButtonProps}
-              interactionPolicy={interactionPolicy}
-            >
-              {manualEntryLabel}
-            </Button>
-          ) : null}
-        </View>
-      </View>
-    </Card>
-  );
-}
-
-/***
- * ZORA-owned camera permission state for scanner flows.
- *
- * Native permission APIs stay in app adapters. This component renders the
- * request, denied, requesting, and manual-entry surfaces consistently.
- *
- */
-export const CameraPermissionView = withZoraThemeScope(CameraPermissionViewInner);