Close #466 : Add typings

package.json

@@ -4,6 +4,7 @@
   "description": "A JavaScript library to display Photo Sphere panoramas",
   "homepage": "https://photo-sphere-viewer.js.org",
   "main": "dist/photo-sphere-viewer.js",
+  "types": "src/types/index.d.ts",
   "files": [
     "src/",
     "dist/"

src/components/Loader.js

@@ -1,5 +1,5 @@
 import { SYSTEM } from '../data/system';
-import { getStyle } from '../utils';
+import { bound, getStyle } from '../utils';
 import { AbstractComponent } from './AbstractComponent';
 
 /**
@@ -110,7 +110,7 @@ export class Loader extends AbstractComponent {
     context.arc(
       this.canvas.width / 2, this.canvas.height / 2,
       this.canvas.width / 2 - this.prop.tickness / 2,
-      -Math.PI / 2, value / 100 * 2 * Math.PI - Math.PI / 2
+      -Math.PI / 2, bound(value, 0, 100) / 100 * 2 * Math.PI - Math.PI / 2
     );
     context.stroke();
   }

src/components/Panel.js

@@ -127,7 +127,7 @@ export class Panel extends AbstractComponent {
 
   /**
    * @summary Shows the panel
-   * @param {Object} config
+   * @param {string|Object} config
    * @param {string} [config.id]
    * @param {string} config.content
    * @param {boolean} [config.noMargin=false]

src/data/constants.js

@@ -180,13 +180,13 @@ export const EVENTS = {
   /**
    * @event hide-notification
    * @memberof PSV
-   * @summary Trigered when the notification is hidden
+   * @summary Triggered when the notification is hidden
    */
   HIDE_NOTIFICATION : 'hide-notification',
   /**
    * @event hide-overlay
    * @memberof PSV
-   * @summary Trigered when the overlay is hidden
+   * @summary Triggered when the overlay is hidden
    * @param {string} [id]
    */
   HIDE_OVERLAY      : 'hide-overlay',

src/index.js

@@ -92,6 +92,20 @@ export {
  * @property {string} back
  */
 
+/**
+ * @typedef {Object} PSV.PanoData
+ * @summary Crop information of the panorama
+ * @property {number} fullWidth
+ * @property {number} fullHeight
+ * @property {number} croppedWidth
+ * @property {number} croppedHeight
+ * @property {number} croppedX
+ * @property {number} croppedY
+ * @property {number} poseHeading
+ * @property {number} posePitch
+ * @property {number} poseRoll
+ */
+
 /**
  * @callback PanoDataProvider
  * @summary Function to compute panorama data once the image is loaded
@@ -116,20 +130,6 @@ export {
  * @property {PSV.PanoData} [panoData]
  */
 
-/**
- * @typedef {Object} PSV.PanoData
- * @summary Crop information of the panorama
- * @property {number} fullWidth
- * @property {number} fullHeight
- * @property {number} croppedWidth
- * @property {number} croppedHeight
- * @property {number} croppedX
- * @property {number} croppedY
- * @property {number} poseHeading
- * @property {number} posePitch
- * @property {number} poseRoll
- */
-
 /**
  * @typedef {Object} PSV.ClickData
  * @summary Data of the `click` event

src/services/TextureLoader.js

@@ -76,6 +76,7 @@ export class TextureLoader extends AbstractService {
 
   /**
    * @summary Cancels current HTTP requests
+   * @package
    */
   abortLoading() {
     [...this.requests].forEach(r => r.abort());
@@ -375,7 +376,7 @@ export class TextureLoader extends AbstractService {
 
   /**
    * @summary Preload a panorama file without displaying it
-   * @param {string} panorama
+   * @param {string|string[]|PSV.Cubemap} panorama
    * @returns {Promise}
    */
   preloadPanorama(panorama) {

src/types/Animation.d.ts

@@ -0,0 +1,35 @@
+export type AnimationOptions = {
+  properties: { [K: string]: { start: number, end: number } };
+  duration: number;
+  delay?: number;
+  easing?: string | ((progress: number) => number);
+  onTick: (properties: { [K: string]: number }, progress: number) => void;
+};
+
+/**
+ * @summary Interpolation helper for animations
+ * @description
+ * Implements the Promise API with an additional "cancel" and "finally" methods.
+ * The promise is resolved when the animation is complete and rejected if the animation is cancelled.
+ */
+export class Animation implements Promise<void> {
+
+  constructor(options: AnimationOptions);
+
+  // @ts-ignore
+  then(onFulfilled?: (() => void | Animation | PromiseLike<void>) | undefined | null, onRejected?: (() => void | Animation | PromiseLike<void>) | undefined | null): Animation;
+
+  // @ts-ignore
+  catch(onRejected?: (() => void | Animation | PromiseLike<void>) | undefined | null): Animation;
+
+  // @ts-ignore
+  finally(onFinally?: (() => void | Animation | PromiseLike<void>) | undefined | null): Animation;
+
+  cancel();
+
+  /**
+   * @summary Returns a resolved animation promise
+   */
+  static resolve(): Animation;
+
+}

src/types/PSVError.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @summary Custom error used in the lib
+ */
+export class PSVError extends Error {
+  name: 'PSVError';
+}