@likecoin/epub-ts 0.4.3 → 0.4.5

package/dist/annotations.d.ts

@@ -2,12 +2,12 @@ import { IEventEmitter } from './types';
 import { default as Rendition } from './rendition';
 interface AnnotationView {
     index: number;
-    highlight: Function;
-    underline: Function;
-    mark: Function;
-    unhighlight: Function;
-    ununderline: Function;
-    unmark: Function;
+    highlight: (cfiRange: string, data?: Record<string, string>, cb?: EventListener, className?: string, styles?: Record<string, string>) => object | undefined;
+    underline: (cfiRange: string, data?: Record<string, string>, cb?: EventListener, className?: string, styles?: Record<string, string>) => object | undefined;
+    mark: (cfiRange: string, data?: Record<string, string>, cb?: EventListener) => object | null | undefined;
+    unhighlight: (cfiRange: string) => void;
+    ununderline: (cfiRange: string) => void;
+    unmark: (cfiRange: string) => void;
 }
 /**
     * Handles managing adding & removing Annotations
@@ -32,7 +32,7 @@ declare class Annotations {
      * @param {object} styles CSS styles to assign to annotation
      * @returns {Annotation} annotation
      */
-    add(type: string, cfiRange: string, data?: Record<string, any>, cb?: Function, className?: string, styles?: Record<string, string>): Annotation;
+    add(type: string, cfiRange: string, data?: Record<string, any>, cb?: EventListener, className?: string, styles?: Record<string, string>): Annotation;
     /**
      * Remove an annotation from store
      * @param {EpubCFI} cfiRange EpubCFI range the annotation is attached to
@@ -57,7 +57,7 @@ declare class Annotations {
      * @param {string} className CSS class to assign to annotation
      * @param {object} styles CSS styles to assign to annotation
      */
-    highlight(cfiRange: string, data?: Record<string, any>, cb?: Function, className?: string, styles?: Record<string, string>): Annotation;
+    highlight(cfiRange: string, data?: Record<string, any>, cb?: EventListener, className?: string, styles?: Record<string, string>): Annotation;
     /**
      * Add a underline to the store
      * @param {EpubCFI} cfiRange EpubCFI range to attach annotation to
@@ -66,14 +66,14 @@ declare class Annotations {
      * @param {string} className CSS class to assign to annotation
      * @param {object} styles CSS styles to assign to annotation
      */
-    underline(cfiRange: string, data?: Record<string, any>, cb?: Function, className?: string, styles?: Record<string, string>): Annotation;
+    underline(cfiRange: string, data?: Record<string, any>, cb?: EventListener, className?: string, styles?: Record<string, string>): Annotation;
     /**
      * Add a mark to the store
      * @param {EpubCFI} cfiRange EpubCFI range to attach annotation to
      * @param {object} data Data to assign to annotation
      * @param {function} cb Callback after annotation is clicked
      */
-    mark(cfiRange: string, data?: Record<string, any>, cb?: Function): Annotation;
+    mark(cfiRange: string, data?: Record<string, any>, cb?: EventListener): Annotation;
     /**
      * iterate over annotations in the store
      */
@@ -119,8 +119,8 @@ declare class Annotation implements IEventEmitter {
     cfiRange: string;
     data: Record<string, any>;
     sectionIndex: number;
-    mark: object | undefined;
-    cb: Function;
+    mark: object | null | undefined;
+    cb: EventListener;
     className: string;
     styles: Record<string, string>;
     on: IEventEmitter["on"];
@@ -131,7 +131,7 @@ declare class Annotation implements IEventEmitter {
         cfiRange: string;
         data?: Record<string, any>;
         sectionIndex?: number;
-        cb?: Function;
+        cb?: EventListener;
         className?: string;
         styles?: Record<string, string>;
     });
@@ -144,12 +144,12 @@ declare class Annotation implements IEventEmitter {
      * Add to a view
      * @param {View} view
      */
-    attach(view: AnnotationView): object | undefined;
+    attach(view: AnnotationView): object | null | undefined;
     /**
      * Remove from a view
      * @param {View} view
      */
-    detach(view: AnnotationView): object | undefined;
+    detach(view: AnnotationView): void;
     /**
      * [Not Implemented] Get text of an annotation
      * @TODO: needs implementation in contents

package/dist/archive.d.ts

@@ -33,7 +33,7 @@ declare class Archive {
      * @param  {string} [type] specify the type of the returned result
      * @return {Promise<Blob | string | JSON | Document | XMLDocument>}
      */
-    request(url: string, type?: string): Promise<any>;
+    request(url: string, type?: string): Promise<unknown>;
     /**
      * Handle the response from request
      * @private
@@ -41,7 +41,7 @@ declare class Archive {
      * @param  {string} [type]
      * @return {any} the parsed result
      */
-    handleResponse(response: any, type?: string): any;
+    handleResponse(response: string | Blob, type?: string): Document | object | Blob | string;
     /**
      * Get a Blob from Archive by Url
      * @param  {string} url

package/dist/book.d.ts

@@ -16,14 +16,14 @@ import { default as JSZip } from 'jszip';
 import { IEventEmitter, BookOptions, RenditionOptions, RequestFunction, PackagingManifestObject, PackagingMetadataObject } from './types';
 import { default as Section } from './section';
 interface BookLoadingState {
-    manifest: defer;
-    spine: defer;
-    metadata: defer;
-    cover: defer;
-    navigation: defer;
-    pageList: defer;
-    resources: defer;
-    displayOptions: defer;
+    manifest: defer<PackagingManifestObject>;
+    spine: defer<Spine>;
+    metadata: defer<PackagingMetadataObject>;
+    cover: defer<string>;
+    navigation: defer<Navigation>;
+    pageList: defer<PageList>;
+    resources: defer<Resources>;
+    displayOptions: defer<DisplayOptions>;
 }
 interface BookLoadedState {
     manifest: Promise<PackagingManifestObject>;
@@ -54,17 +54,17 @@ interface BookLoadedState {
  * @example new Book({ replacements: "blobUrl" })
  */
 declare class Book implements IEventEmitter {
-    settings: BookOptions & Record<string, any>;
-    opening: defer;
-    opened: Promise<Book> | undefined;
+    settings: BookOptions;
+    opening: defer<Book>;
+    opened: Promise<Book>;
     isOpen: boolean;
-    loading: BookLoadingState | undefined;
-    loaded: BookLoadedState | undefined;
-    ready: Promise<[PackagingManifestObject, Spine, PackagingMetadataObject, string, Navigation, Resources, DisplayOptions]> | undefined;
+    loading: BookLoadingState;
+    loaded: BookLoadedState;
+    ready: Promise<[PackagingManifestObject, Spine, PackagingMetadataObject, string, Navigation, Resources, DisplayOptions]>;
     isRendered: boolean;
     request: RequestFunction;
-    spine: Spine | undefined;
-    locations: Locations | undefined;
+    spine: Spine;
+    locations: Locations;
     navigation: Navigation | undefined;
     pageList: PageList | undefined;
     url: Url | undefined;
@@ -125,7 +125,7 @@ declare class Book implements IEventEmitter {
      * @param  {string} path path to the resource to load
      * @return {Promise}     returns a promise with the requested resource
      */
-    load(path: string, _type?: string): Promise<any>;
+    load(path: string, _type?: string): Promise<unknown>;
     /**
      * Resolve a path to it's absolute position in the Book
      * @param  {string} path
@@ -145,7 +145,7 @@ declare class Book implements IEventEmitter {
      * @param  {string} input
      * @return {string}  binary | directory | epub | opf
      */
-    determineType(input: string | ArrayBuffer | Blob): string;
+    determineType(input: string | ArrayBuffer | Blob): string | undefined;
     /**
      * unpack the contents of the Books packaging
      * @private

package/dist/contents.d.ts

@@ -13,7 +13,7 @@ import { default as Section } from './section';
 declare class Contents implements IEventEmitter {
     on: (type: string, fn: (...args: any[]) => void) => this;
     off: (type: string, fn?: (...args: any[]) => void) => this;
-    emit: (type: string, ...args: any[]) => void;
+    emit: (type: string, ...args: unknown[]) => void;
     __listeners: IEventEmitter["__listeners"];
     epubcfi: EpubCFI;
     document: Document;