Class WpPublication

Web Publication implementation of IPublication that can be loaded into the Reading System.

To create an instance, use one of the static methods:

createFromBlob
createFromPrimaryEntryPageUrl
createFromManifestUrl
createFromRandomAccessDataSource

Implements

IWpPublication

Constructors

constructor

new WpPublication(): WpPublication
Returns WpPublication

Methods

destroy

destroy(): void
Destroy this instance, allowing used resources to be garbage collected.

Returns void
Implementation of IWpPublication.destroy

getBackingResourceProvider

getBackingResourceProvider(): IResourceProvider
Get the IResourceProvider instance that can be used to fetch resources from this publication.

Returns IResourceProvider
Implementation of IWpPublication.getBackingResourceProvider

getCoverImageResourceUrl

getCoverImageResourceUrl(): URL
Get the URL to the cover image resource declared in this publication, if any.

To fetch the resource data for this URL, use the IResourceProvider returned by getBackingResourceProvider().

Returns URL
Implementation of IWpPublication.getCoverImageResourceUrl

getDefaultLayout

getDefaultLayout(): ContentDocumentLayout
The default layout for content documents in this publication.

Returns ContentDocumentLayout
Implementation of IWpPublication.getDefaultLayout

getHashSignature

getHashSignature(): string
Get a generated hash signature of the publication, intended to uniquely identify this publication. The hash signature is not the same as the publication id as the hash signature always changes when the publication data changes in any way. The uniqueness of the signature depends on how the publication was loaded. Please refer the implementation responsible for loading this instance. For example, for EPUB see OcfResourceProvider.

Returns string
Implementation of IWpPublication.getHashSignature

getManifest

getManifest(): IWpManifest
Get the Web Publication Manifest for this publication.

Returns IWpManifest
Implementation of IWpPublication.getManifest

getMetadata

getMetadata(): WpPublicationMetadata
Get all metadata items defined in this publication.

Returns WpPublicationMetadata
Implementation of IWpPublication.getMetadata

getNavigationResourceUrl

getNavigationResourceUrl(): URL
Get the URL to the resource containing the navigation structure for this publication, if any.

Returns URL
Implementation of IWpPublication.getNavigationResourceUrl

getPageProgressionDirection

getPageProgressionDirection(): PageProgressionDirection
Get the global direction in which the Publication content flows. Please note that this is not same as the writing direction. A publication's pages can be ordered from right-to-left, but its text written left-to-right.

Returns PageProgressionDirection
Implementation of IWpPublication.getPageProgressionDirection

getPreferredFlowMode

getPreferredFlowMode(): ContentDocumentFlowMode
Get the default preferred flow mode for content documents in the publication. In other words, it specifies how the publication content should be presented by the reading system.

Returns ContentDocumentFlowMode
Implementation of IWpPublication.getPreferredFlowMode

getPreferredOrientation

getPreferredOrientation(): PublicationOrientation
Get which orientation the author intends the Publication to be rendered in.

Returns PublicationOrientation
Implementation of IWpPublication.getPreferredOrientation

getPreferredSyntheticSpreadBehavior

getPreferredSyntheticSpreadBehavior(): SyntheticSpreadBehavior
Get in which orientations the reading system should present this content document in spread mode.

Returns SyntheticSpreadBehavior
Implementation of IWpPublication.getPreferredSyntheticSpreadBehavior

getProfiles

getProfiles(): string[]
Get the profile of this publication.

Profiles are publication formats (e.g., audiobooks) describing what type of contents to expect in the publication and in the manifest data.

Returns string[]
Implementation of IWpPublication.getProfiles

getSpine

getSpine(): IWpContentDocument[]
Get the ContentDocuments representing the readingOrder of this publication.

Returns IWpContentDocument[]
Implementation of IWpPublication.getSpine

getType

getType(): PublicationType
Get the type of publication this instance represents.

This allows you to cast an IPublication instance to a more specific subtype. See PublicationType for how values map to specific IPublication types.

Returns PublicationType
Implementation of IWpPublication.getType

isDestroyed

isDestroyed(): boolean
If this Publication instance has been destroyed.

Returns boolean
Implementation of IWpPublication.isDestroyed

toJSON

toJSON(): IWpPublicationData
Get this instance as a plain JSON object.

Returns IWpPublicationData
Implementation of IWpPublication.toJSON

`Static`createFromBlob

createFromBlob(blob: Blob): Promise<IWpPublication>
Creates a new instance from a blob containing the LPF file.
Parameters
- blob: Blob
  The complete LPF file as a blob.
Returns Promise<IWpPublication>

`Static`createFromManifestUrl

createFromManifestUrl(
    resourceProvider: IResourceProvider,
    manifestUrl: string | URL,
    hashSignature: string,
    onDestroyed?: () => void,
): Promise<IWpPublication>
Creates a new instance by loading the publication from the specified IResourceProvider instance and publication manifest URL.
Parameters
- resourceProvider: IResourceProvider
  The resource provider where to fetch resources from.
- manifestUrl: string | URL
  An absolute or relative URL identifying the manifest of the publication.
- hashSignature: string
  A string uniquely identifying this version of the publication. This can for example be a SHA checksum of the publication contents.
- OptionalonDestroyed: () => void
  A function that will be called when WpPublication.destroy() has been called. This allows for cleaning up ResourceProviders etc.
Returns Promise<IWpPublication>

`Static`createFromPrimaryEntryPageUrl

createFromPrimaryEntryPageUrl(
    resourceProvider: IResourceProvider,
    primaryEntryPageUrl: string | URL,
    hashSignature: string,
    onDestroyed?: () => void,
): Promise<IWpPublication>
Creates a new instance by loading the publication from the specified IResourceProvider instance and primary entry page URL.
Parameters
- resourceProvider: IResourceProvider
  The resource provider where to fetch resources from.
- primaryEntryPageUrl: string | URL
  An absolute or relative URL identifying the primary entry page of the publication. See https://www.w3.org/TR/wpub/#primary-entry-page for more information
- hashSignature: string
  A string uniquely identifying this version of the publication. This can for example be a SHA checksum of the publication contents.
- OptionalonDestroyed: () => void
  A function that will be called when WpPublication.destroy() has been called. This allows for cleaning up ResourceProviders etc.
Returns Promise<IWpPublication>

`Static`createFromRandomAccessDataSource

createFromRandomAccessDataSource(
dataSource: IRandomAccessDataSource,
options?: IZipResourceProviderOptions,
): Promise<IWpPublication>
Creates a new instance by loading an LPF file using an IRandomAccessDataSource instance.
Parameters
- dataSource: IRandomAccessDataSource
- Optionaloptions: IZipResourceProviderOptions
Returns Promise<IWpPublication>

`Static`createFromResourceProvider

createFromResourceProvider(
    resourceProvider: IResourceProvider,
    hashSignature: string,
    onDestroyed?: () => void,
): Promise<IWpPublication>
Creates a new instance from a IResourceProvider representing the LPF file container.

The implementation will look for the Publication Manifest by trying to fetch first publication.json and then index.html.
Parameters
- resourceProvider: IResourceProvider
  The resource provider where to fetch resources from.
- hashSignature: string
  A string uniquely identifying this version of the publication. This can for example be the SHA1 hash of the publication contents.
- OptionalonDestroyed: () => void
  A function that will be called when WpPublication.destroy() has been called. This allows for cleaning up ResourceProviders etc.
Returns Promise<IWpPublication>

Class WpPublication

Implements

Constructors

constructor

Returns WpPublication

Methods

destroy

Returns void

getBackingResourceProvider

Returns IResourceProvider

getCoverImageResourceUrl

Returns URL

getDefaultLayout

Returns ContentDocumentLayout

getHashSignature

Returns string

getManifest

Returns IWpManifest

getMetadata

Returns WpPublicationMetadata

getNavigationResourceUrl

Returns URL

getPageProgressionDirection

Returns PageProgressionDirection

getPreferredFlowMode

Returns ContentDocumentFlowMode

getPreferredOrientation

Returns PublicationOrientation

getPreferredSyntheticSpreadBehavior

Returns SyntheticSpreadBehavior

getProfiles

Returns string[]

getSpine

Returns IWpContentDocument[]

getType

Returns PublicationType

isDestroyed

Returns boolean

toJSON

Returns IWpPublicationData

StaticcreateFromBlob

Parameters

Returns Promise<IWpPublication>

StaticcreateFromManifestUrl

Parameters

Returns Promise<IWpPublication>

StaticcreateFromPrimaryEntryPageUrl

Parameters

Returns Promise<IWpPublication>

StaticcreateFromRandomAccessDataSource

Parameters

Returns Promise<IWpPublication>

StaticcreateFromResourceProvider

Parameters

Returns Promise<IWpPublication>

`Static`createFromBlob

`Static`createFromManifestUrl

`Static`createFromPrimaryEntryPageUrl

`Static`createFromRandomAccessDataSource

`Static`createFromResourceProvider