structural-codes-viewer 0.1.0-alpha.1 → 0.1.0-alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/LICENSE +501 -0
  2. package/NOTICE +16 -0
  3. package/README.md +57 -68
  4. package/package-dist/CorpusContent.d.ts +44 -9
  5. package/package-dist/CorpusContent.js +452 -26
  6. package/package-dist/CorpusContent.js.map +1 -1
  7. package/package-dist/NormativeViewer.d.ts +23 -2
  8. package/package-dist/NormativeViewer.js +1699 -234
  9. package/package-dist/NormativeViewer.js.map +1 -1
  10. package/package-dist/ReferenceTools.d.ts +49 -0
  11. package/package-dist/ReferenceTools.js +14 -0
  12. package/package-dist/ReferenceTools.js.map +1 -0
  13. package/package-dist/annotations/AnnotationUi.d.ts +57 -0
  14. package/package-dist/annotations/AnnotationUi.js +114 -0
  15. package/package-dist/annotations/AnnotationUi.js.map +1 -0
  16. package/package-dist/annotations/annotationTargets.d.ts +39 -0
  17. package/package-dist/annotations/annotationTargets.js +94 -0
  18. package/package-dist/annotations/annotationTargets.js.map +1 -0
  19. package/package-dist/annotations/exportImport.d.ts +6 -0
  20. package/package-dist/annotations/exportImport.js +30 -0
  21. package/package-dist/annotations/exportImport.js.map +1 -0
  22. package/package-dist/annotations/index.d.ts +4 -0
  23. package/package-dist/annotations/index.js +5 -0
  24. package/package-dist/annotations/index.js.map +1 -0
  25. package/package-dist/annotations/indexedDb.d.ts +21 -0
  26. package/package-dist/annotations/indexedDb.js +210 -0
  27. package/package-dist/annotations/indexedDb.js.map +1 -0
  28. package/package-dist/annotations/schema.d.ts +8 -0
  29. package/package-dist/annotations/schema.js +102 -0
  30. package/package-dist/annotations/schema.js.map +1 -0
  31. package/package-dist/annotations/types.d.ts +52 -0
  32. package/package-dist/annotations/types.js +18 -0
  33. package/package-dist/annotations/types.js.map +1 -0
  34. package/package-dist/chunkNavigation.d.ts +12 -0
  35. package/package-dist/chunkNavigation.js +44 -0
  36. package/package-dist/chunkNavigation.js.map +1 -0
  37. package/package-dist/corpusData.d.ts +176 -33
  38. package/package-dist/corpusData.js +52 -0
  39. package/package-dist/corpusData.js.map +1 -1
  40. package/package-dist/crossReferences.d.ts +46 -0
  41. package/package-dist/crossReferences.js +198 -0
  42. package/package-dist/crossReferences.js.map +1 -0
  43. package/package-dist/generate-artifacts.mjs +47 -12
  44. package/package-dist/globalScrubber.d.ts +10 -0
  45. package/package-dist/globalScrubber.js +85 -0
  46. package/package-dist/globalScrubber.js.map +1 -0
  47. package/package-dist/permalinks.d.ts +22 -0
  48. package/package-dist/permalinks.js +36 -0
  49. package/package-dist/permalinks.js.map +1 -0
  50. package/package-dist/searchClient.d.ts +22 -0
  51. package/package-dist/searchClient.js +133 -0
  52. package/package-dist/searchClient.js.map +1 -0
  53. package/package-dist/searchEngine.d.ts +68 -0
  54. package/package-dist/searchEngine.js +558 -0
  55. package/package-dist/searchEngine.js.map +1 -0
  56. package/package-dist/searchWorker.d.ts +1 -0
  57. package/package-dist/searchWorker.js +32 -0
  58. package/package-dist/searchWorker.js.map +1 -0
  59. package/package-dist/styles.css +762 -182
  60. package/package-dist/tableCaptions.d.mts +3 -0
  61. package/package-dist/tableCaptions.mjs +35 -0
  62. package/package-dist/tableCaptions.mjs.map +1 -0
  63. package/package.json +18 -14
@@ -1,5 +1,8 @@
1
1
  import { type ReactNode } from "react";
2
2
  import { type CorpusChunk, type CorpusManifest, type DocumentId, type ViewerMode } from "./corpusData";
3
+ import { type ViewerTarget } from "./permalinks";
4
+ import { type AnnotationPanelController } from "./annotations/AnnotationUi";
5
+ import type { AnnotationStore } from "./annotations/types";
3
6
  declare const modeOptions: Array<{
4
7
  id: ViewerMode;
5
8
  label: string;
@@ -13,6 +16,17 @@ export interface AuxiliaryPanelContext {
13
16
  from: number;
14
17
  to: number;
15
18
  };
19
+ /** Optional additions preserve consumers that construct the original PDF context. */
20
+ currentUnit?: {
21
+ documentId: DocumentId;
22
+ unitId: string;
23
+ numbering: string;
24
+ } | null;
25
+ selectedTarget?: ViewerTarget | null;
26
+ navigateTo?: (target: ViewerTarget) => Promise<void>;
27
+ hrefForTarget?: (target: ViewerTarget) => string;
28
+ close?: () => void;
29
+ annotations?: AnnotationPanelController;
16
30
  }
17
31
  export type AuxiliaryPanel = ReactNode | ((context: AuxiliaryPanelContext) => ReactNode);
18
32
  export interface NormativeViewerProps {
@@ -21,9 +35,16 @@ export interface NormativeViewerProps {
21
35
  assetsBaseUrl?: string;
22
36
  auxiliaryPanel?: AuxiliaryPanel;
23
37
  auxiliaryPanelLabel?: string;
38
+ auxiliaryPanelButtonText?: string;
24
39
  auxiliaryPanelDefaultVisible?: boolean;
25
- analyticalHref?: string | ((mode: ViewerMode, unitId: string | null) => string);
40
+ auxiliaryPanelDesktopDefaultVisible?: boolean;
41
+ /** Defaults to the legacy single-document modes. */
42
+ auxiliaryPanelModes?: readonly ViewerMode[];
43
+ /** Opt in to retaining transient tool state while hidden. Default preserves lazy mounting. */
44
+ auxiliaryPanelKeepMounted?: boolean;
45
+ searchMaxResults?: number;
26
46
  className?: string;
47
+ annotationStore?: AnnotationStore;
27
48
  }
28
- export declare function NormativeViewer({ defaultMode, dataBaseUrl, assetsBaseUrl, auxiliaryPanel, auxiliaryPanelLabel, auxiliaryPanelDefaultVisible, analyticalHref, className, }: NormativeViewerProps): import("react/jsx-runtime").JSX.Element;
49
+ export declare function NormativeViewer({ defaultMode, dataBaseUrl, assetsBaseUrl, auxiliaryPanel, auxiliaryPanelLabel, auxiliaryPanelButtonText, auxiliaryPanelDefaultVisible, auxiliaryPanelDesktopDefaultVisible, auxiliaryPanelModes, auxiliaryPanelKeepMounted, searchMaxResults, className, annotationStore }: NormativeViewerProps): import("react/jsx-runtime").JSX.Element;
29
50
  export { modeOptions };