initial work on #44, updated manifesto

UniversalViewer · Aug 14, 2015 · c8a2bd9 · c8a2bd9
1 parent 89acfaf
commit c8a2bd9
Show file tree

Hide file tree

Showing 9 changed files with 184 additions and 154 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,7 +1,7 @@
 # Inspired by https://github.com/DigitalInnovation/mns-digital-blog/blob/master/.travis.yml
 language: node_js
 node_js:
-- '0.10'
+- '0.12.7'
 before_install:
 - npm install -g grunt-cli
 - npm install -g bower

diff --git a/src/extensions/uv-seadragon-extension/Commands.ts b/src/extensions/uv-seadragon-extension/Commands.ts
@@ -19,6 +19,8 @@ class Commands {
     static SEADRAGON_ANIMATION_FINISH: string       = Commands.namespace + 'onAnimationfinish';
     static SEADRAGON_ANIMATION_START: string        = Commands.namespace + 'onAnimationStart';
     static SEADRAGON_OPEN: string                   = Commands.namespace + 'onOpen';
+    static SEARCH_PREVIEW_START: string             = Commands.namespace + 'onSearchPreviewStart';
+    static SEARCH_PREVIEW_FINISH: string            = Commands.namespace + 'onSearchPreviewFinish';
     static SEADRAGON_RESIZE: string                 = Commands.namespace + 'onResize';
     static SEADRAGON_ROTATION: string               = Commands.namespace + 'onRotation';
     static SEARCH: string                           = Commands.namespace + 'onSearch';

diff --git a/src/lib/manifesto.js b/src/lib/manifesto.js
diff --git a/src/modules/uv-searchfooterpanel-module/FooterPanel.ts b/src/modules/uv-searchfooterpanel-module/FooterPanel.ts
@@ -296,6 +296,8 @@ class FooterPanel extends BaseFooterPanel {
 
         var canvasIndex = parseInt($placemarker.attr('data-index'));
 
+        $.publish(Commands.SEARCH_PREVIEW_START, [canvasIndex]);
+
         var placemarkers = that.getSearchResultPlacemarkers();
         var elemIndex = placemarkers.index($placemarker[0]);
 
@@ -359,6 +361,8 @@ class FooterPanel extends BaseFooterPanel {
     }
 
     onPlacemarkerMouseLeave(e, that): void {
+        $.publish(Commands.SEARCH_PREVIEW_FINISH);
+
         var $placemarker = $(this);
 
         var newElement = e.toElement || e.relatedTarget;

diff --git a/src/modules/uv-shared-module/BaseExtension.ts b/src/modules/uv-shared-module/BaseExtension.ts
@@ -282,7 +282,7 @@ class BaseExtension implements IExtension {
         });
 
         return new Promise<Manifesto.IExternalResource[]>((resolve) => {
-            this.provider.manifest.loadResources(
+            manifesto.loadExternalResources(
                 resources,
                 this.clickThrough,
                 this.login,

diff --git a/src/modules/uv-shared-module/BaseProvider.ts b/src/modules/uv-shared-module/BaseProvider.ts
@@ -272,8 +272,7 @@ class BaseProvider implements IProvider{
         if (this.isPagingSettingEnabled()){
             var indices = this.getPagedIndices(canvasIndex);
 
-            // todo: use constants
-            if (this.getViewingDirection().toString() === "right-to-left"){
+            if (this.getViewingDirection().toString() === manifesto.ViewingDirection.rightToLeft().toString()){
                 index = indices.last() - 1;
             } else {
                 index = indices[0] - 1;
@@ -416,7 +415,7 @@ class BaseProvider implements IProvider{
 
     getLocales(): any[] {
         if (this.locales) return this.locales;
-
+b
         // use data-locales to prioritise
         var items = this.config.localisation.locales.clone();
         var sorting = this.bootstrapper.params.locales;

diff --git a/src/modules/uv-treeviewleftpanel-module/ThumbsView.ts b/src/modules/uv-treeviewleftpanel-module/ThumbsView.ts
@@ -40,6 +40,14 @@ class ThumbsView extends BaseView {
             this.loadThumbs();
         });
 
+        $.subscribe(Commands.SEARCH_PREVIEW_START, (e, canvasIndex) => {
+            //this.searchPreviewStart(canvasIndex);
+        });
+
+        $.subscribe(Commands.SEARCH_PREVIEW_FINISH, () => {
+            //this.searchPreviewFinish();
+        });
+
         this.$thumbs = $('<div class="thumbs"></div>');
         this.$element.append(this.$thumbs);
 
@@ -62,9 +70,8 @@ class ThumbsView extends BaseView {
 
         $.views.helpers({
             separator: function(){
-                // todo: use constants
                 var viewingDirection = that.provider.getViewingDirection().toString();
-                if (viewingDirection === "top-to-bottom" || viewingDirection === "bottom-to-top"){
+                if (viewingDirection === manifesto.ViewingDirection.topToBottom().toString() || viewingDirection === manifesto.ViewingDirection.bottomToTop().toString()){
                     return true; // one thumb per line
                 }
                 // two thumbs per line
@@ -84,10 +91,9 @@ class ThumbsView extends BaseView {
                     className += " placeholder";
                 }
 
-                // todo: use constants
                 var viewingDirection = that.provider.getViewingDirection().toString();
 
-                if (viewingDirection === "top-to-bottom" || viewingDirection === "bottom-to-top"){
+                if (viewingDirection === manifesto.ViewingDirection.topToBottom().toString() || viewingDirection === manifesto.ViewingDirection.bottomToTop().toString()){
                     className += " oneCol";
                 } else {
                     className += " twoCol";

diff --git a/src/modules/uv-treeviewleftpanel-module/TreeViewLeftPanel.ts b/src/modules/uv-treeviewleftpanel-module/TreeViewLeftPanel.ts
@@ -120,8 +120,7 @@ class TreeViewLeftPanel extends LeftPanel {
 
         var viewingDirection = this.provider.getViewingDirection().toString();
 
-        // todo: use constants
-        if (viewingDirection === "top-to-bottom" || viewingDirection === "bottom-to-top"){
+        if (viewingDirection === manifesto.ViewingDirection.topToBottom().toString() || viewingDirection === manifesto.ViewingDirection.bottomToTop().toString()){
             width = this.config.options.oneColThumbWidth;
             height = this.config.options.oneColThumbHeight;
         } else {

diff --git a/src/typings/manifesto.d.ts b/src/typings/manifesto.d.ts
@@ -161,9 +161,6 @@ declare module Manifesto {
         private _parseTreeNode(node, range);
         getType(): ManifestType;
         isMultiSequence(): boolean;
-        loadResource(resource: IExternalResource, clickThrough: (resource: IExternalResource) => void, login: (loginServiceUrl: string) => Promise<void>, getAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, storeAccessToken: (resource: IExternalResource, token: IAccessToken) => Promise<void>, getStoredAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, handleResourceResponse: (resource: IExternalResource) => Promise<any>): Promise<IExternalResource>;
-        loadResources(resources: IExternalResource[], clickThrough: (resource: IExternalResource) => void, login: (loginServiceUrl: string) => Promise<void>, getAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, storeAccessToken: (resource: IExternalResource, token: IAccessToken) => Promise<void>, getStoredAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, handleResourceResponse: (resource: IExternalResource) => Promise<any>): Promise<IExternalResource[]>;
-        authorize(resource: IExternalResource, clickThrough: (resource: IExternalResource) => void, login: (loginServiceUrl: string) => Promise<void>, getAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, storeAccessToken: (resource: IExternalResource, token: IAccessToken) => Promise<void>, getStoredAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>): Promise<IExternalResource>;
     }
 }
 declare module Manifesto {
@@ -260,6 +257,14 @@ declare module Manifesto {
 }
 declare var http: any;
 declare var url: any;
+declare module Manifesto {
+    class Utils {
+        static loadManifest(uri: string): Promise<any>;
+        static loadExternalResource(resource: IExternalResource, clickThrough: (resource: IExternalResource) => void, login: (loginServiceUrl: string) => Promise<void>, getAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, storeAccessToken: (resource: IExternalResource, token: IAccessToken) => Promise<void>, getStoredAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, handleResourceResponse: (resource: IExternalResource) => Promise<any>, options?: IManifestoOptions): Promise<IExternalResource>;
+        static loadExternalResources(resources: IExternalResource[], clickThrough: (resource: IExternalResource) => void, login: (loginServiceUrl: string) => Promise<void>, getAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, storeAccessToken: (resource: IExternalResource, token: IAccessToken) => Promise<void>, getStoredAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, handleResourceResponse: (resource: IExternalResource) => Promise<any>, options?: IManifestoOptions): Promise<IExternalResource[]>;
+        static authorize(resource: IExternalResource, clickThrough: (resource: IExternalResource) => void, login: (loginServiceUrl: string) => Promise<void>, getAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, storeAccessToken: (resource: IExternalResource, token: IAccessToken) => Promise<void>, getStoredAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>): Promise<IExternalResource>;
+    }
+}
 declare module Manifesto {
     interface IAccessToken {
         accessToken: string;
@@ -332,8 +337,6 @@ declare module Manifesto {
         getTree(): TreeNode;
         getType(): ManifestType;
         isMultiSequence(): boolean;
-        loadResource(resource: IExternalResource, clickThrough: (resource: IExternalResource) => void, login: (loginServiceUrl: string) => Promise<void>, getAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, storeAccessToken: (resource: IExternalResource, token: IAccessToken) => Promise<void>, getStoredAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, handleResourceResponse: (resource: IExternalResource) => Promise<any>): Promise<IExternalResource>;
-        loadResources(resources: IExternalResource[], clickThrough: (resource: IExternalResource) => void, login: (loginServiceUrl: string) => Promise<void>, getAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, storeAccessToken: (resource: IExternalResource, token: IAccessToken) => Promise<void>, getStoredAccessToken: (tokenServiceUrl: string) => Promise<IAccessToken>, handleResourceResponse: (resource: IExternalResource) => Promise<any>): Promise<IExternalResource[]>;
         options: IManifestoOptions;
         rootRange: IRange;
         sequences: ISequence[];
@@ -346,7 +349,8 @@ declare module Manifesto {
     }
 }
 interface IManifesto {
-    load: (manifestUri: string, callback: (manifest: string) => void) => void;
+    loadManifest: (uri: string) => Promise<any>;
+    loadExternalResources: (resources: Manifesto.IExternalResource[], clickThrough: (resource: Manifesto.IExternalResource) => void, login: (loginServiceUrl: string) => Promise<void>, getAccessToken: (tokenServiceUrl: string) => Promise<Manifesto.IAccessToken>, storeAccessToken: (resource: Manifesto.IExternalResource, token: Manifesto.IAccessToken) => Promise<void>, getStoredAccessToken: (tokenServiceUrl: string) => Promise<Manifesto.IAccessToken>, handleResourceResponse: (resource: Manifesto.IExternalResource) => Promise<any>, options?: Manifesto.IManifestoOptions) => Promise<Manifesto.IExternalResource[]>;
     create: (manifest: string, options?: Manifesto.IManifestoOptions) => Manifesto.Manifest;
     CanvasType: Manifesto.CanvasType;
     ElementType: Manifesto.ElementType;