typed config working

Author: edsilv

src/content-handlers/iiif/BaseConfig.ts

@@ -10,34 +10,34 @@ export class Metric {
 
 export type Options = {
   /** Determines if the focus can be stolen */
-  allowStealFocus: boolean;
+  allowStealFocus?: boolean;
 
   /** Version of the authentication API */
   authAPIVersion: number;
 
   /** Height of the bookmark thumbnail */
-  bookmarkThumbHeight: number;
+  bookmarkThumbHeight?: number;
 
   /** Width of the bookmark thumbnail */
-  bookmarkThumbWidth: number;
+  bookmarkThumbWidth?: number;
 
   /** Determines if drop is enabled */
-  dropEnabled: boolean;
+  dropEnabled?: boolean;
 
   /** Determines if the footer panel is enabled */
-  footerPanelEnabled: boolean;
+  footerPanelEnabled?: boolean;
 
   /** Determines if the header panel is enabled */
-  headerPanelEnabled: boolean;
+  headerPanelEnabled?: boolean;
 
   /** Determines if the left panel is enabled */
-  leftPanelEnabled: boolean;
+  leftPanelEnabled?: boolean;
 
   /** Determines if locales are limited */
-  limitLocales: boolean;
+  limitLocales?: boolean;
 
   /** Determines if double click annotation is enabled */
-  doubleClickAnnotationEnabled: boolean;
+  doubleClickAnnotationEnabled?: boolean;
 
   /** Metrics array */
   metrics: Metric[];
@@ -46,7 +46,7 @@ export type Options = {
   multiSelectionMimeType: string;
 
   /** Determines if the navigator is enabled */
-  navigatorEnabled: boolean;
+  navigatorEnabled?: boolean;
 
   /** Template for opening */
   openTemplate: string;
@@ -55,31 +55,31 @@ export type Options = {
   overrideFullScreen: boolean;
 
   /** Determines if paging is enabled */
-  pagingEnabled: boolean;
+  pagingEnabled?: boolean;
 
   /** Determines if paging option is enabled */
-  pagingOptionEnabled: boolean;
+  pagingOptionEnabled?: boolean;
 
   /** Determines if access control is pessimistic */
-  pessimisticAccessControl: boolean;
+  pessimisticAccessControl?: boolean;
 
   /** Determines if viewport is preserved */
-  preserveViewport: boolean;
+  preserveViewport?: boolean;
 
   /** Determines if the right panel is enabled */
-  rightPanelEnabled: boolean;
+  rightPanelEnabled?: boolean;
 
   /** Determines if user settings are saved */
-  saveUserSettings: boolean;
+  saveUserSettings?: boolean;
 
   /** Determines if click to zoom is enabled */
-  clickToZoomEnabled: boolean;
+  clickToZoomEnabled?: boolean;
 
   /** Determines if search within is enabled */
-  searchWithinEnabled: boolean;
+  searchWithinEnabled?: boolean;
 
   /** Determines if seealso content is enabled */
-  seeAlsoEnabled: boolean;
+  seeAlsoEnabled?: boolean;
 
   /** Determines if terms of use are enabled */
   termsOfUseEnabled: boolean;
@@ -91,13 +91,16 @@ export type Options = {
   tokenStorage: string | StorageType;
 
   /** Determines if arrow keys can be used to navigate */
-  useArrowKeysToNavigate: boolean;
+  useArrowKeysToNavigate?: boolean;
+
+  /** Determines if PDF.js should be used for PDF rendering */
+  usePdfJs?: boolean;
 
   /** Determines if zoom to search result is enabled */
-  zoomToSearchResultEnabled: boolean;
+  zoomToSearchResultEnabled?: boolean;
 
   /** Determines if zoom to bounds is enabled */
-  zoomToBoundsEnabled: boolean;
+  zoomToBoundsEnabled?: boolean;
 };
 
 type Locale = {
@@ -110,12 +113,16 @@ export type Localisation = {
   locales: Locale[];
 };
 
+type DialogueOptions = {
+  topCloseButtonEnabled: boolean;
+};
+
 type DialogueContent = {
   close: string;
 };
 
 type Dialogue = {
-  topCloseButtonEnabled: boolean;
+  options?: DialogueOptions;
   content: DialogueContent;
 };
 
@@ -167,10 +174,15 @@ type DownloadDialogueContent = {
 };
 
 type DownloadDialogue = {
-  options: DownloadDialogueOptions;
+  options?: DownloadDialogueOptions;
   content: DownloadDialogueContent;
 };
 
+/**
+ * Type for Generic Dialogue Options
+ */
+type GenericDialogueOptions = {};
+
 type GenericDialogueContent = {
   emptyValue: string;
   invalidNumber: string;
@@ -181,9 +193,66 @@ type GenericDialogueContent = {
 };
 
 type GenericDialogue = {
+  options?: GenericDialogueOptions;
   content: GenericDialogueContent;
 };
 
+type MoreInfoRightPanelOptions = {
+  /** Order in which canvases are displayed */
+  canvasDisplayOrder: string;
+  /** Canvases to exclude from display */
+  canvasExclude: string;
+  /** Determines if copying to clipboard is enabled */
+  copyToClipboardEnabled: boolean;
+  /** Order in which manifests are displayed */
+  manifestDisplayOrder: string;
+  /** Manifests to exclude from display */
+  manifestExclude: string;
+  /** Duration of the panel animation */
+  panelAnimationDuration: number;
+  /** Width of the collapsed panel */
+  panelCollapsedWidth: number;
+  /** Width of the expanded panel */
+  panelExpandedWidth: number;
+  /** Determines if the panel is open */
+  panelOpen: boolean;
+  /** Language codes for right-to-left languages */
+  rtlLanguageCodes: string;
+  /** Determines if all languages should be shown */
+  showAllLanguages: boolean;
+  /** Limit for the text */
+  textLimit: number;
+  /** Type of the text limit */
+  textLimitType: string;
+};
+
+type MoreInfoRightPanelContent = {
+  attribution: string;
+  canvasHeader: string;
+  collapse: string;
+  collapseFull: string;
+  copiedToClipboard: string;
+  copyToClipboard: string;
+  description: string;
+  expand: string;
+  expandFull: string;
+  holdingText: string;
+  less: string;
+  license: string;
+  logo: string;
+  manifestHeader: string;
+  more: string;
+  noData: string;
+  page: string;
+  rangeHeader: string;
+  title: string;
+};
+
+type MoreInfoRightPanel = {
+  options: MoreInfoRightPanelOptions;
+  content: MoreInfoRightPanelContent;
+};
+
 export type Content = {
   authCORSError: string;
   authorisationFailedMessage: string;
@@ -203,6 +272,7 @@ export type BaseConfig = {
     dialogue: Dialogue;
     downloadDialogue: DownloadDialogue;
     genericDialogue: GenericDialogue;
+    moreInfoRightPanel: MoreInfoRightPanel;
   };
   localisation: Localisation;
   content: Content;

src/content-handlers/iiif/extensions/uv-aleph-extension/Extension.ts

@@ -12,7 +12,7 @@ import { ShareDialogue } from "./ShareDialogue";
 import { AlephLeftPanel } from "../../modules/uv-alephleftpanel-module/AlephLeftPanel";
 import { Strings, Bools } from "@edsilv/utils";
 import "./theme/theme.less";
-import defaultConfig from "./config/en-GB.json";
+import defaultConfig from "./config/config.json";
 import { Config } from "./config/Config";
 
 export default class Extension extends BaseExtension
@@ -118,7 +118,7 @@ export default class Extension extends BaseExtension
   }
 
   isLeftPanelEnabled(): boolean {
-    return Bools.getBool(this.data.config.options.leftPanelEnabled, true);
+    return Bools.getBool(this.data.config!.options.leftPanelEnabled, true);
   }
 
   getEmbedScript(template: string, width: number, height: number): string {

src/content-handlers/iiif/extensions/uv-aleph-extension/config/en-GB.json src/content-handlers/iiif/extensions/uv-aleph-extension/config/config.json

@@ -67,7 +67,9 @@
       }
     },
     "dialogue": {
-      "topCloseButtonEnabled": false,
+      "options": {
+        "topCloseButtonEnabled": false
+      },
       "content": {
         "close": "Close"
       }
@@ -136,28 +138,28 @@
         "rtlLanguageCodes": "ar, ara, dv, div, he, heb, ur, urd",
         "showAllLanguages": false,
         "textLimit": 4,
-        "textLimitType": "lines",
-        "limitToRange": false
+        "textLimitType": "lines"
       },
       "content": {
-        "attribution": "Attribution",
-        "collapse": "Collapse Information",
-        "collapseFull": "Collapse Gallery",
-        "description": "Description",
-        "expand": "Expand Information",
-        "expandFull": "Expand Gallery",
-        "holdingText": "Your module goes here!",
-        "less": "less",
-        "license": "License",
-        "logo": "Logo",
-        "more": "more",
-        "noData": "No data to display",
-        "page": "Page",
-        "title": "More Information",
-        "manifestHeader": "About the item",
-        "canvasHeader": "About the image",
-        "copyToClipboard": "Copy to clipboard",
-        "copiedToClipboard": "Copied to clipboard"
+        "attribution": "$attribution",
+        "canvasHeader": "$aboutTheImage",
+        "collapse": "$collapseInformation",
+        "collapseFull": "$collapseGallery",
+        "copiedToClipboard": "$copiedToClipboard",
+        "copyToClipboard": "$copyToClipboard",
+        "description": "$description",
+        "expand": "$expandInformation",
+        "expandFull": "$expandGallery",
+        "holdingText": "$moduleGoesHere",
+        "less": "$less",
+        "license": "$license",
+        "logo": "$logo",
+        "manifestHeader": "$aboutTheItem",
+        "more": "$more",
+        "noData": "$noDataToDisplay",
+        "page": "$page",
+        "rangeHeader": "$aboutThisSection",
+        "title": "$moreInformation"
       }
     },
     "alephCenterPanel": {
@@ -211,25 +213,28 @@
     },
     "downloadDialogue": {
       "content": {
-        "currentViewAsJpg": "Current view {0} x {1}px (jpg)",
-        "currentViewAsJpgExplanation": "Opens in a new window",
-        "download": "Download",
-        "downloadSelection": "Download Selection",
-        "downloadSelectionExplanation": "Opens a dialogue to select which pages to download.",
-        "editSettings": "Edit Settings",
-        "entireDocument": "Entire document ({0})",
-        "entireFileAsOriginal": "Entire file",
-        "entireFileAsOriginalWithFormat": "Entire file ({0})",
-        "noneAvailable": "No download options are available.",
-        "pagingNote": "Please turn off Two Page View for additional options.",
-        "preview": "Preview",
-        "title": "Download",
-        "wholeImageHighRes": "Whole image {0} x {1}px ({2})",
-        "wholeImageHighResExplanation": "Opens in a new window.",
-        "wholeImagesHighRes": "Whole images ({0})",
-        "wholeImagesHighResExplanation": "Opens in two new windows.",
-        "wholeImageLowResAsJpg": "Whole image {0} x {1}px (jpg)",
-        "wholeImageLowResAsJpgExplanation": "Opens in a new window."
+        "allPages": "$allPages",
+        "currentViewAsJpg": "$currentViewAsJpg",
+        "currentViewAsJpgExplanation": "$openNewWindow",
+        "download": "$download",
+        "downloadSelection": "$downloadSelection",
+        "downloadSelectionExplanation": "$downloadSelectionExplanation",
+        "editSettings": "$editSettings",
+        "entireDocument": "$entireDocument",
+        "entireFileAsOriginal": "$entireFile",
+        "individualPages": "$individualPages",
+        "noneAvailable": "$noDownloadOptionsAvailable",
+        "pagingNote": "$pagingNote",
+        "preview": "$preview",
+        "selection": "$selection",
+        "termsOfUse": "$termsOfUse",
+        "title": "$download",
+        "wholeImageHighRes": "$wholeImageHighRes",
+        "wholeImageHighResExplanation": "$openNewWindow",
+        "wholeImageLowResAsJpg": "$wholeImageLowResAsJpg",
+        "wholeImageLowResAsJpgExplanation": "$openNewWindow",
+        "wholeImagesHighRes": "$wholeImagesHighRes",
+        "wholeImagesHighResExplanation": "$wholeImagesHighResExplanation"
       }
     },
     "loginDialogue": {
@@ -265,4 +270,4 @@
     "mediaViewer": "Media Viewer",
     "skipToDownload": "Skip to downloads and alternative formats"
   }
-}
+}

src/content-handlers/iiif/extensions/uv-av-extension/Extension.ts

@@ -141,7 +141,7 @@ export default class Extension extends BaseExtension implements IAVExtension {
   }
 
   isLeftPanelEnabled(): boolean {
-    return Bools.getBool(this.data.config.options.leftPanelEnabled, true);
+    return Bools.getBool(this.data.config!.options.leftPanelEnabled, true);
   }
 
   render(): void {