@manifest-editor/exhibition-preset 2.1.0 → 2.2.0

package/dist/index.css

@@ -3,7 +3,6 @@
 }
 
 /* SVG */
-
 .atlas-cursor-se {
   cursor: se-resize;
 }
@@ -38,14 +37,12 @@
     8 8,
     pointer;
 }
-
 .atlas-cursor-draw {
   cursor:
     url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAERlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAAIKADAAQAAAABAAAAIAAAAACshmLzAAABSElEQVRYCe2TvWqEQBSFtxa09xECwSo/26dIL9iIog9i52P4JilCSLrdJGz6pA5sqs0PQqJuzoGdMBl0DehstpiBi3PH6z3fnBknEzOMA8aBDgfW7WOF5WnHJ+MuUx8df0UYhvOmaV52AtEGQCAJ4nTcLSvdZADOy7J8dF13SYgoioQT+iBkAIoj/2yBWGJdDwQar2D3LXfMnfdAnCgGDk8BMOWF64OI43iGOjphIIQTx8P9Vzr89TiSJJmhlsfxvxCbO7EXEEeKmcPTLcfxxV/VsqwPqKzTNBV3YncQRVFcUVyEBHGAtXGH6oTYOVR+ADjP8/watRfjqm+6qRCqOHPHcd5Q96oFgE37IHzfv0fNgzaAbRCe5z1VVfUMgHOtADJElmU3tm2/B0FwV9c1xSPt4kIAYoeISwTPfYE4E+/M0zhgHOhy4BtfABNjetwFVwAAAABJRU5ErkJggg==")
     4 4,
     pointer;
 }
-
 .atlas-cursor-cut {
   cursor:
     url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAAXNSR0IArs4c6QAAAERlWElmTU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAAIKADAAQAAAABAAAAIAAAAACshmLzAAACQklEQVRYCe1VS0sCURR2TBNalCG0kUkLlKDcuuqxaNvOP+Cira3Vv2HoQoRaBv6HLDPDRUS7gqAH2AOcsQhBQafvi2kQHzkzWqsZ+Jhzzz2P7545547NZj0mK6AoyrRJ1/HdkHwbeABC40czGAFJFzqdjpzP548hP/87CSRcarVaj+CtxGKxc6xfgHmD5zBv3k2AJEiGOrMR7WYdJ+VnEZh4BdAPAnsCcOv5TBMjoCbeQ9IaGvME63ugDKz+RqSPABwWAJ5gIBBscUBAEbpUvV7fDQaDny6XS7Tb7XPJZLKNOMeAf4BPvwqG27xkOFrD0G63X7kHb4Wo1WpXXDcajVu32/3h8XikbDZbiEajFe5nMhlW46g/W48GRtPAA284Og5DJBK5ZEJRFKter7faa1epVE4R5xC4C4fDNz6frwr5qSedttQ+gSAILWh3kGAFN1xZszAn8ADmHrANAS///gm66YLAPDCwCaHf6u4BytBtAvuyLF8HAgGtPxKJxBl66g17/u74pmUEEoAUGw5BvvuEMnXAFLAHSM1m8xGJ65BHjqEhMkzAU6Lb338IUKaOewyGN0myerouIt0E1MASS8xRY7cTlKnDvkQb3QGNGiL4MkvLQ+ZyuQLWB8AhZ546tRcM/5a1MdRBSHI6nbO0KxaLM3htAOulUomyzeFwcE+m/GcPTnwRj8dLSKDwkiEos9uxN+7dMZo3kqxxrNLpdIE3HEFZHbVffzqjo+u0AAk/cAQ8qaDs1+lumVkVsCrQV4Ev5W84Pu7IH00AAAAASUVORK5CYII=")

package/dist/index.d.cts

@@ -1,18 +1,91 @@
-import * as _manifest_editor_shell1 from "@manifest-editor/shell";
-import * as react_jsx_runtime0 from "react/jsx-runtime";
+import * as React from "react";
 import { SVGProps } from "react";
-
+import { CreatorResource } from "@manifest-editor/creator-api";
+import { CreateImageServicePayload } from "@manifest-editor/creators";
+import { DelftExhibitionProps, DelftPresentationProps } from "exhibition-viewer/library";
 //#region src/icons/PresetIcon.d.ts
-declare const PresetIcon: (props: SVGProps<SVGSVGElement>) => react_jsx_runtime0.JSX.Element;
+declare const PresetIcon: (props: SVGProps<SVGSVGElement>) => React.JSX.Element;
+//#endregion
+//#region src/creators/image-service-slide-creator.d.ts
+interface CreateImageServiceSlidePayload extends CreateImageServicePayload {
+  imageSlideBehavior?: string[];
+  slideType?: "default" | "left" | "right" | "bottom";
+}
+declare module "@manifest-editor/creator-api" {
+  namespace IIIFManifestEditor {
+    interface CreatorDefinitions {
+      "@exhibitions/image-service-creator": typeof imageServiceSlideCreator;
+    }
+  }
+}
+declare const imageServiceSlideCreator: import("@manifest-editor/creator-api").SpecificCreatorDefinition<CreateImageServicePayload, "@exhibitions/image-service-creator", "Canvas", [], ["Canvas"], ["Manifest"], ["items"], Promise<CreatorResource>>;
 //#endregion
 //#region src/presets/scrolling-preset.d.ts
-declare const exhibitionEditorScrollingPreset: _manifest_editor_shell1.MappedApp;
+declare const exhibitionEditorScrollingPreset: import("@manifest-editor/shell").MappedApp;
 //#endregion
 //#region src/presets/slideshow-preset.d.ts
-declare const exhibitionEditorSlideshowPreset: _manifest_editor_shell1.MappedApp;
+declare const exhibitionEditorSlideshowPreset: import("@manifest-editor/shell").MappedApp;
+//#endregion
+//#region src/helpers/exhibition-preview-url-helper.d.ts
+type PresetUrlSearchParamsPreset = "delft" | "exhibition" | "minimal" | "presentation" | "scroll" | "slideshow";
+type TableOfContentsPlacement = "header" | "footer";
+type FloatingPosition = "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top" | "bottom" | "left" | "right";
+type PresetUrlSearchParamsByPreset = {
+  delft: DelftPresetUrlSearchParamsOptions;
+  exhibition: DelftPresetUrlSearchParamsOptions;
+  minimal: MinimalPresetUrlSearchParamsOptions;
+  presentation: PresentationPresetUrlSearchParamsOptions;
+  scroll: ScrollPresetUrlSearchParamsOptions;
+  slideshow: SlideshowPresetUrlSearchParamsOptions;
+};
+type PresetUrlSearchParamsOptions<T extends PresetUrlSearchParamsPreset = PresetUrlSearchParamsPreset> = PresetUrlSearchParamsByPreset[T];
+type SharedPresetUrlSearchParamsOptions = {
+  manifest: string;
+  canvas?: string;
+};
+type DelftPresetUrlSearchParamsOptions = SharedPresetUrlSearchParamsOptions & Pick<NonNullable<DelftExhibitionProps["options"]>, "cutCorners" | "fullTitleBar"> & {
+  hideTableOfContents?: boolean;
+  ignoreCanvasBackgrounds?: boolean;
+  showNavigationControls?: boolean;
+  showProgressBar?: boolean;
+  tableOfContentsPlacement?: TableOfContentsPlacement;
+};
+type MinimalPresetUrlSearchParamsOptions = DelftPresetUrlSearchParamsOptions;
+type PresentationPresetUrlSearchParamsOptions = SharedPresetUrlSearchParamsOptions & Pick<NonNullable<DelftPresentationProps["options"]>, "cutCorners" | "isFloating"> & {
+  floating?: NonNullable<DelftPresentationProps["options"]>["isFloating"];
+  floatingPosition?: FloatingPosition;
+  ignoreCanvasBackgrounds?: boolean;
+  labelOnlyFloating?: boolean;
+};
+type SlideshowPresetUrlSearchParamsOptions = SharedPresetUrlSearchParamsOptions & {
+  minimal?: boolean;
+  floating?: NonNullable<DelftPresentationProps["options"]>["isFloating"];
+  floatingPosition?: FloatingPosition;
+  ignoreCanvasBackgrounds?: boolean;
+  labelOnlyFloating?: boolean;
+};
+type ScrollPresetUrlSearchParamsOptions = SharedPresetUrlSearchParamsOptions & {
+  minimal?: boolean;
+  manifestEditorPreview?: boolean;
+  manifestEditorPreviewOrigin?: string;
+  ignoreCanvasBackgrounds?: boolean;
+  tableOfContentsPlacement?: TableOfContentsPlacement;
+};
+//#endregion
+//#region src/components/ExhibitionPreviewPanel.d.ts
+interface ExhibitionPreviewPanelProps {
+  preset: PresetUrlSearchParamsPreset;
+  presetOptions?: Partial<PresetUrlSearchParamsOptions>;
+  focusSelectedCanvas?: boolean;
+}
+declare function useExhibitionPreviewWindow({ preset, presetOptions, focusSelectedCanvas }: ExhibitionPreviewPanelProps): {
+  open: () => void;
+  focus: () => void;
+  isClosed: boolean;
+};
 //#endregion
 //#region src/index.d.ts
-declare const exhibitionEditorPreset: _manifest_editor_shell1.MappedApp;
+declare const exhibitionEditorPreset: import("@manifest-editor/shell").MappedApp;
 //#endregion
-export { PresetIcon, exhibitionEditorPreset, exhibitionEditorScrollingPreset, exhibitionEditorSlideshowPreset };
+export { type CreateImageServiceSlidePayload, PresetIcon, exhibitionEditorPreset, exhibitionEditorScrollingPreset, exhibitionEditorSlideshowPreset, imageServiceSlideCreator, useExhibitionPreviewWindow };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/icons/PresetIcon.tsx","../src/presets/scrolling-preset.ts","../src/presets/slideshow-preset.ts","../src/index.tsx"],"sourcesContent":[],"mappings":";;;;;cAGM,oBAAqB,SAAS,mBAAc,kBAAA,CAAA,GAAA,CAAA;;;cCarC,iCA+CZ,uBAAA,CA/C2C;;;cCM/B,iCAiEZ,uBAAA,CAjE2C;;;cCU/B,wBAmEZ,uBAAA,CAnEkC"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/icons/PresetIcon.tsx","../src/creators/image-service-slide-creator.tsx","../src/presets/scrolling-preset.ts","../src/presets/slideshow-preset.ts","../src/helpers/exhibition-preview-url-helper.ts","../src/components/ExhibitionPreviewPanel.tsx","../src/index.tsx"],"mappings":";;;;;;cAGM,aAAU,OAAW,SAAS,mBAAc,MAAA,IAAA;;;UCMjC,uCAAuC;EACtD;EACA;;;YAIU;cACE;MACR,6CAA6C;;;;cAKtC,iEAAwB,0BAAA,oHAAA,QAAA;;;cCAxB,kEAA+B;;;cCK/B,kEAA+B;;;KCzBhC;KACP;KACA;KAEO;EACV,OAAO;EACP,YAAY;EACZ,SAAS;EACT,cAAc;EACd,QAAQ;EACR,WAAW;;KAGD,6BAA6B,UAAU,8BAA8B,+BAC/E,8BAA8B;KAE3B;EACH;EACA;;KAGU,oCAAoC,qCAC9C,KAAK,YAAY;EACf;EACA;EACA;EACA;EACA,2BAA2B;;KAGnB,sCAAsC;KAEtC,2CAA2C,qCACrD,KAAK,YAAY;EACf,WAAW,YAAY;EACvB,mBAAmB;EACnB;EACA;;KAGQ,wCAAwC;EAClD;EACA,WAAW,YAAY;EACvB,mBAAmB;EACnB;EACA;;KAGU,qCAAqC;EAC/C;EACA;EACA;EACA;EACA,2BAA2B;;;;UCzCZ;EACf,QAAQ;EACR,gBAAgB,QAAQ;EACxB;;iBAwNc,6BACd,QACA,eACA,uBACC;;;;;;;cCrMU,yDAAsB"}

package/dist/index.d.ts

@@ -1,18 +1,91 @@
-import * as _manifest_editor_shell1 from "@manifest-editor/shell";
-import * as react_jsx_runtime0 from "react/jsx-runtime";
+import * as React from "react";
 import { SVGProps } from "react";
-
+import { DelftExhibitionProps, DelftPresentationProps } from "exhibition-viewer/library";
+import { CreatorResource } from "@manifest-editor/creator-api";
+import { CreateImageServicePayload } from "@manifest-editor/creators";
 //#region src/icons/PresetIcon.d.ts
-declare const PresetIcon: (props: SVGProps<SVGSVGElement>) => react_jsx_runtime0.JSX.Element;
+declare const PresetIcon: (props: SVGProps<SVGSVGElement>) => React.JSX.Element;
+//#endregion
+//#region src/creators/image-service-slide-creator.d.ts
+interface CreateImageServiceSlidePayload extends CreateImageServicePayload {
+  imageSlideBehavior?: string[];
+  slideType?: "default" | "left" | "right" | "bottom";
+}
+declare module "@manifest-editor/creator-api" {
+  namespace IIIFManifestEditor {
+    interface CreatorDefinitions {
+      "@exhibitions/image-service-creator": typeof imageServiceSlideCreator;
+    }
+  }
+}
+declare const imageServiceSlideCreator: import("@manifest-editor/creator-api").SpecificCreatorDefinition<CreateImageServicePayload, "@exhibitions/image-service-creator", "Canvas", [], ["Canvas"], ["Manifest"], ["items"], Promise<CreatorResource>>;
 //#endregion
 //#region src/presets/scrolling-preset.d.ts
-declare const exhibitionEditorScrollingPreset: _manifest_editor_shell1.MappedApp;
+declare const exhibitionEditorScrollingPreset: import("@manifest-editor/shell").MappedApp;
 //#endregion
 //#region src/presets/slideshow-preset.d.ts
-declare const exhibitionEditorSlideshowPreset: _manifest_editor_shell1.MappedApp;
+declare const exhibitionEditorSlideshowPreset: import("@manifest-editor/shell").MappedApp;
+//#endregion
+//#region src/helpers/exhibition-preview-url-helper.d.ts
+type PresetUrlSearchParamsPreset = "delft" | "exhibition" | "minimal" | "presentation" | "scroll" | "slideshow";
+type TableOfContentsPlacement = "header" | "footer";
+type FloatingPosition = "top-left" | "top-right" | "bottom-left" | "bottom-right" | "top" | "bottom" | "left" | "right";
+type PresetUrlSearchParamsByPreset = {
+  delft: DelftPresetUrlSearchParamsOptions;
+  exhibition: DelftPresetUrlSearchParamsOptions;
+  minimal: MinimalPresetUrlSearchParamsOptions;
+  presentation: PresentationPresetUrlSearchParamsOptions;
+  scroll: ScrollPresetUrlSearchParamsOptions;
+  slideshow: SlideshowPresetUrlSearchParamsOptions;
+};
+type PresetUrlSearchParamsOptions<T extends PresetUrlSearchParamsPreset = PresetUrlSearchParamsPreset> = PresetUrlSearchParamsByPreset[T];
+type SharedPresetUrlSearchParamsOptions = {
+  manifest: string;
+  canvas?: string;
+};
+type DelftPresetUrlSearchParamsOptions = SharedPresetUrlSearchParamsOptions & Pick<NonNullable<DelftExhibitionProps["options"]>, "cutCorners" | "fullTitleBar"> & {
+  hideTableOfContents?: boolean;
+  ignoreCanvasBackgrounds?: boolean;
+  showNavigationControls?: boolean;
+  showProgressBar?: boolean;
+  tableOfContentsPlacement?: TableOfContentsPlacement;
+};
+type MinimalPresetUrlSearchParamsOptions = DelftPresetUrlSearchParamsOptions;
+type PresentationPresetUrlSearchParamsOptions = SharedPresetUrlSearchParamsOptions & Pick<NonNullable<DelftPresentationProps["options"]>, "cutCorners" | "isFloating"> & {
+  floating?: NonNullable<DelftPresentationProps["options"]>["isFloating"];
+  floatingPosition?: FloatingPosition;
+  ignoreCanvasBackgrounds?: boolean;
+  labelOnlyFloating?: boolean;
+};
+type SlideshowPresetUrlSearchParamsOptions = SharedPresetUrlSearchParamsOptions & {
+  minimal?: boolean;
+  floating?: NonNullable<DelftPresentationProps["options"]>["isFloating"];
+  floatingPosition?: FloatingPosition;
+  ignoreCanvasBackgrounds?: boolean;
+  labelOnlyFloating?: boolean;
+};
+type ScrollPresetUrlSearchParamsOptions = SharedPresetUrlSearchParamsOptions & {
+  minimal?: boolean;
+  manifestEditorPreview?: boolean;
+  manifestEditorPreviewOrigin?: string;
+  ignoreCanvasBackgrounds?: boolean;
+  tableOfContentsPlacement?: TableOfContentsPlacement;
+};
+//#endregion
+//#region src/components/ExhibitionPreviewPanel.d.ts
+interface ExhibitionPreviewPanelProps {
+  preset: PresetUrlSearchParamsPreset;
+  presetOptions?: Partial<PresetUrlSearchParamsOptions>;
+  focusSelectedCanvas?: boolean;
+}
+declare function useExhibitionPreviewWindow({ preset, presetOptions, focusSelectedCanvas }: ExhibitionPreviewPanelProps): {
+  open: () => void;
+  focus: () => void;
+  isClosed: boolean;
+};
 //#endregion
 //#region src/index.d.ts
-declare const exhibitionEditorPreset: _manifest_editor_shell1.MappedApp;
+declare const exhibitionEditorPreset: import("@manifest-editor/shell").MappedApp;
 //#endregion
-export { PresetIcon, exhibitionEditorPreset, exhibitionEditorScrollingPreset, exhibitionEditorSlideshowPreset };
+export { type CreateImageServiceSlidePayload, PresetIcon, exhibitionEditorPreset, exhibitionEditorScrollingPreset, exhibitionEditorSlideshowPreset, imageServiceSlideCreator, useExhibitionPreviewWindow };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/icons/PresetIcon.tsx","../src/presets/scrolling-preset.ts","../src/presets/slideshow-preset.ts","../src/index.tsx"],"sourcesContent":[],"mappings":";;;;;cAGM,oBAAqB,SAAS,mBAAc,kBAAA,CAAA,GAAA,CAAA;;;cCarC,iCA+CZ,uBAAA,CA/C2C;;;cCM/B,iCAiEZ,uBAAA,CAjE2C;;;cCU/B,wBAmEZ,uBAAA,CAnEkC"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/icons/PresetIcon.tsx","../src/creators/image-service-slide-creator.tsx","../src/presets/scrolling-preset.ts","../src/presets/slideshow-preset.ts","../src/helpers/exhibition-preview-url-helper.ts","../src/components/ExhibitionPreviewPanel.tsx","../src/index.tsx"],"mappings":";;;;;;cAGM,aAAU,OAAW,SAAS,mBAAc,MAAA,IAAA;;;UCMjC,uCAAuC;EACtD;EACA;;;YAIU;cACE;MACR,6CAA6C;;;;cAKtC,iEAAwB,0BAAA,oHAAA,QAAA;;;cCAxB,kEAA+B;;;cCK/B,kEAA+B;;;KCzBhC;KACP;KACA;KAEO;EACV,OAAO;EACP,YAAY;EACZ,SAAS;EACT,cAAc;EACd,QAAQ;EACR,WAAW;;KAGD,6BAA6B,UAAU,8BAA8B,+BAC/E,8BAA8B;KAE3B;EACH;EACA;;KAGU,oCAAoC,qCAC9C,KAAK,YAAY;EACf;EACA;EACA;EACA;EACA,2BAA2B;;KAGnB,sCAAsC;KAEtC,2CAA2C,qCACrD,KAAK,YAAY;EACf,WAAW,YAAY;EACvB,mBAAmB;EACnB;EACA;;KAGQ,wCAAwC;EAClD;EACA,WAAW,YAAY;EACvB,mBAAmB;EACnB;EACA;;KAGU,qCAAqC;EAC/C;EACA;EACA;EACA;EACA,2BAA2B;;;;UCzCZ;EACf,QAAQ;EACR,gBAAgB,QAAQ;EACxB;;iBAwNc,6BACd,QACA,eACA,uBACC;;;;;;;cCrMU,yDAAsB"}