@prose-reader/archive-reader 1.344.0 → 1.345.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/dist/cover/resolveArchiveCover.d.ts +1 -1
  2. package/dist/index/index.cjs +4 -4
  3. package/dist/index/index.cjs.map +1 -1
  4. package/dist/index/index.js +497 -484
  5. package/dist/index/index.js.map +1 -1
  6. package/dist/index.d.ts +24 -24
  7. package/dist/{apple → metadata/apple}/readArchiveApple.d.ts +1 -1
  8. package/dist/{apple → metadata/apple}/resolve.d.ts +1 -1
  9. package/dist/{comicInfo → metadata/comicInfo}/getArchiveHasComicInfo.d.ts +1 -1
  10. package/dist/{comicInfo → metadata/comicInfo}/readArchiveComicInfo.d.ts +1 -1
  11. package/dist/{comicInfo → metadata/comicInfo}/resolve.d.ts +1 -1
  12. package/dist/{kobo → metadata/kobo}/readArchiveKobo.d.ts +1 -1
  13. package/dist/{kobo → metadata/kobo}/resolve.d.ts +1 -1
  14. package/dist/metadata/opf/getArchiveOpfInfo.d.ts +5 -0
  15. package/dist/{opf → metadata/opf}/getSpineItemFilesFromArchive.d.ts +2 -2
  16. package/dist/{opf → metadata/opf}/isArchiveEpub.d.ts +1 -1
  17. package/dist/{opf → metadata/opf}/readArchiveOpf.d.ts +1 -1
  18. package/dist/{opf → metadata/opf}/resolve.d.ts +1 -1
  19. package/dist/readingOrder/resolveArchiveReadingOrder.d.ts +1 -1
  20. package/dist/resolve.d.ts +4 -4
  21. package/dist/resolveArchive.d.ts +4 -4
  22. package/dist/resolveMetadata.d.ts +4 -4
  23. package/dist/toc/nav.d.ts +1 -1
  24. package/dist/toc/ncx.d.ts +1 -1
  25. package/dist/toc/resolveArchiveToc.d.ts +1 -1
  26. package/dist/types/resolvedMetadata.d.ts +10 -7
  27. package/package.json +3 -3
  28. package/dist/opf/getArchiveOpfInfo.d.ts +0 -5
  29. /package/dist/{apple → metadata/apple}/parse.d.ts +0 -0
  30. /package/dist/{apple → metadata/apple}/parse.test.d.ts +0 -0
  31. /package/dist/{apple → metadata/apple}/readArchiveApple.test.d.ts +0 -0
  32. /package/dist/{apple → metadata/apple}/resolve.test.d.ts +0 -0
  33. /package/dist/{comicInfo → metadata/comicInfo}/manga.d.ts +0 -0
  34. /package/dist/{comicInfo → metadata/comicInfo}/manga.test.d.ts +0 -0
  35. /package/dist/{comicInfo → metadata/comicInfo}/parse.d.ts +0 -0
  36. /package/dist/{comicInfo → metadata/comicInfo}/parse.test.d.ts +0 -0
  37. /package/dist/{comicInfo → metadata/comicInfo}/readArchiveComicInfo.test.d.ts +0 -0
  38. /package/dist/{comicInfo → metadata/comicInfo}/resolve.test.d.ts +0 -0
  39. /package/dist/{kobo → metadata/kobo}/parse.d.ts +0 -0
  40. /package/dist/{kobo → metadata/kobo}/parse.test.d.ts +0 -0
  41. /package/dist/{kobo → metadata/kobo}/readArchiveKobo.test.d.ts +0 -0
  42. /package/dist/{kobo → metadata/kobo}/resolve.test.d.ts +0 -0
  43. /package/dist/{opf → metadata/opf}/parse.d.ts +0 -0
  44. /package/dist/{opf → metadata/opf}/parse.test.d.ts +0 -0
  45. /package/dist/{opf → metadata/opf}/resolve.test.d.ts +0 -0
  46. /package/dist/{opf → metadata/opf}/spineItemrefProperties.d.ts +0 -0
  47. /package/dist/{opf → metadata/opf}/spineItemrefProperties.test.d.ts +0 -0
package/dist/index.d.ts CHANGED
@@ -1,7 +1,3 @@
1
- export type { AppleDisplayOption, AppleMetadata } from './apple/parse.ts';
2
- export { APPLE_IBOOKS_DISPLAY_OPTIONS_FILENAME, parseAppleDisplayOptionsXml, } from './apple/parse.ts';
3
- export { readArchiveApple } from './apple/readArchiveApple.ts';
4
- export { appleMetadataHomes } from './apple/resolve.ts';
5
1
  export { createArchive } from './archives/createArchive.ts';
6
2
  export { createArchiveFromArrayBufferList } from './archives/createArchiveFromArrayBufferList.ts';
7
3
  export { type ArchiveEntry, type CreateArchiveFromEntriesOptions, createArchiveFromEntries, } from './archives/createArchiveFromEntries.ts';
@@ -12,27 +8,31 @@ export { getArchiveImageRecords, isImageRecord, } from './archives/images.ts';
12
8
  export { readRecordAsText } from './archives/readRecordAsText.ts';
13
9
  export type { Archive, ArchiveRecord, DirectoryRecord, FileRecord, } from './archives/types.ts';
14
10
  export { getArchiveFileRecordByUri, isDirectoryRecord, isFileRecord, } from './archives/types.ts';
15
- export { getArchiveHasComicInfo } from './comicInfo/getArchiveHasComicInfo.ts';
16
- export type { ComicInfoManga } from './comicInfo/manga.ts';
17
- export { COMIC_INFO_MANGA_VALUES, isComicInfoManga } from './comicInfo/manga.ts';
18
- export type { ComicInfo, ComicInfoKnownField } from './comicInfo/parse.ts';
19
- export { COMIC_INFO_FILENAME, COMIC_INFO_KNOWN_FIELDS, parseComicInfo, } from './comicInfo/parse.ts';
20
- export { readArchiveComicInfo } from './comicInfo/readArchiveComicInfo.ts';
21
- export { comicInfoMetadataHomes } from './comicInfo/resolve.ts';
22
11
  export { resolveArchiveCover } from './cover/resolveArchiveCover.ts';
23
- export type { KoboMetadata } from './kobo/parse.ts';
24
- export { KOBO_DISPLAY_OPTIONS_FILENAME, parseKoboXml } from './kobo/parse.ts';
25
- export { readArchiveKobo } from './kobo/readArchiveKobo.ts';
26
- export { koboMetadataHomes } from './kobo/resolve.ts';
27
12
  export { readingOrderDocumentsAllHaveViewport } from './layout/scanReadingOrderDocumentsViewport.ts';
28
- export { getArchiveOpfInfo } from './opf/getArchiveOpfInfo.ts';
29
- export { getSpineItemFilesFromArchive } from './opf/getSpineItemFilesFromArchive.ts';
30
- export { isArchiveEpub } from './opf/isArchiveEpub.ts';
31
- export type { OpfContributor, OpfGuideReference, OpfIdentifier, OpfMetadata, OpfMetaEntry, OpfSpineManifestItem, OpfSpineRow, } from './opf/parse.ts';
32
- export { parseOpf } from './opf/parse.ts';
33
- export type { ArchiveOpfParsed } from './opf/readArchiveOpf.ts';
34
- export { readArchiveOpf } from './opf/readArchiveOpf.ts';
35
- export { opfMetadataHomes } from './opf/resolve.ts';
13
+ export type { AppleDisplayOption, AppleMetadata, } from './metadata/apple/parse.ts';
14
+ export { APPLE_IBOOKS_DISPLAY_OPTIONS_FILENAME, parseAppleDisplayOptionsXml, } from './metadata/apple/parse.ts';
15
+ export { readArchiveApple } from './metadata/apple/readArchiveApple.ts';
16
+ export { appleMetadataHomes } from './metadata/apple/resolve.ts';
17
+ export { getArchiveHasComicInfo } from './metadata/comicInfo/getArchiveHasComicInfo.ts';
18
+ export type { ComicInfoManga } from './metadata/comicInfo/manga.ts';
19
+ export { COMIC_INFO_MANGA_VALUES, isComicInfoManga, } from './metadata/comicInfo/manga.ts';
20
+ export type { ComicInfo, ComicInfoKnownField, } from './metadata/comicInfo/parse.ts';
21
+ export { COMIC_INFO_FILENAME, COMIC_INFO_KNOWN_FIELDS, parseComicInfo, } from './metadata/comicInfo/parse.ts';
22
+ export { readArchiveComicInfo } from './metadata/comicInfo/readArchiveComicInfo.ts';
23
+ export { comicInfoMetadataHomes } from './metadata/comicInfo/resolve.ts';
24
+ export type { KoboMetadata } from './metadata/kobo/parse.ts';
25
+ export { KOBO_DISPLAY_OPTIONS_FILENAME, parseKoboXml, } from './metadata/kobo/parse.ts';
26
+ export { readArchiveKobo } from './metadata/kobo/readArchiveKobo.ts';
27
+ export { koboMetadataHomes } from './metadata/kobo/resolve.ts';
28
+ export { getArchiveOpfInfo } from './metadata/opf/getArchiveOpfInfo.ts';
29
+ export { getSpineItemFilesFromArchive } from './metadata/opf/getSpineItemFilesFromArchive.ts';
30
+ export { isArchiveEpub } from './metadata/opf/isArchiveEpub.ts';
31
+ export type { OpfContributor, OpfGuideReference, OpfIdentifier, OpfMetadata, OpfMetaEntry, OpfSpineManifestItem, OpfSpineRow, } from './metadata/opf/parse.ts';
32
+ export { parseOpf } from './metadata/opf/parse.ts';
33
+ export type { ArchiveOpfParsed } from './metadata/opf/readArchiveOpf.ts';
34
+ export { readArchiveOpf } from './metadata/opf/readArchiveOpf.ts';
35
+ export { opfMetadataHomes } from './metadata/opf/resolve.ts';
36
36
  export type { ArchiveReadingOrderItem } from './readingOrder/resolveArchiveReadingOrder.ts';
37
37
  export { resolveArchiveReadingOrder } from './readingOrder/resolveArchiveReadingOrder.ts';
38
38
  export type { ResolvedArchiveInput } from './resolve.ts';
@@ -43,7 +43,7 @@ export type { ResolveMetadataSources } from './resolveMetadata.ts';
43
43
  export { resolveMetadata } from './resolveMetadata.ts';
44
44
  export { resolveArchiveToc } from './toc/resolveArchiveToc.ts';
45
45
  export type { ArchiveTocItem } from './toc/types.ts';
46
- export type { ResolvedAppleMetadata, ResolvedCollection, ResolvedComicMetadata, ResolvedConfidence, ResolvedContributor, ResolvedContributorRole, ResolvedCover, ResolvedDate, ResolvedKoboMetadata, ResolvedMetadata, ResolvedMetadataHome, ResolvedProperty, ResolvedPublication, ResolvedPublicationInfo, } from './types/resolvedMetadata.ts';
46
+ export type { KnownMetadataIdentifierScheme, MetadataIdentifier, MetadataIdentifierScheme, ResolvedAppleMetadata, ResolvedCollection, ResolvedComicMetadata, ResolvedConfidence, ResolvedContributor, ResolvedContributorRole, ResolvedCover, ResolvedDate, ResolvedKoboMetadata, ResolvedMetadata, ResolvedMetadataHome, ResolvedMetadataIdentifier, ResolvedProperty, ResolvedPublication, ResolvedPublicationInfo, } from './types/resolvedMetadata.ts';
47
47
  export { normalizeGtin } from './utils/normalizeGtin.ts';
48
48
  export { normalizeIsbn } from './utils/normalizeIsbn.ts';
49
49
  export { parseW3cDtfDate } from './utils/parseW3cDtfDate.ts';
@@ -1,3 +1,3 @@
1
- import { Archive } from '../archives/types.ts';
1
+ import { Archive } from '../../archives/types.ts';
2
2
  import { AppleMetadata } from './parse.ts';
3
3
  export declare function readArchiveApple(archive: Archive): Promise<AppleMetadata | undefined>;
@@ -1,4 +1,4 @@
1
- import { ResolvedMetadata } from '../types/resolvedMetadata.ts';
1
+ import { ResolvedMetadata } from '../../types/resolvedMetadata.ts';
2
2
  import { AppleMetadata } from './parse.ts';
3
3
  export declare const appleMetadataHomes: {
4
4
  readonly displayOptions: "apple.options";
@@ -1,2 +1,2 @@
1
- import { Archive, FileRecord } from '../archives/types.ts';
1
+ import { Archive, FileRecord } from '../../archives/types.ts';
2
2
  export declare const getArchiveHasComicInfo: (archive: Archive) => FileRecord | undefined;
@@ -1,3 +1,3 @@
1
- import { Archive } from '../archives/types.ts';
1
+ import { Archive } from '../../archives/types.ts';
2
2
  import { ComicInfo } from './parse.ts';
3
3
  export declare function readArchiveComicInfo(archive: Archive): Promise<ComicInfo | undefined>;
@@ -1,4 +1,4 @@
1
- import { ResolvedMetadata } from '../types/resolvedMetadata.ts';
1
+ import { ResolvedMetadata } from '../../types/resolvedMetadata.ts';
2
2
  import { ComicInfo } from './parse.ts';
3
3
  export declare const comicInfoMetadataHomes: {
4
4
  readonly AgeRating: "comic.ageRating";
@@ -1,3 +1,3 @@
1
- import { Archive } from '../archives/types.ts';
1
+ import { Archive } from '../../archives/types.ts';
2
2
  import { KoboMetadata } from './parse.ts';
3
3
  export declare function readArchiveKobo(archive: Archive): Promise<KoboMetadata | undefined>;
@@ -1,4 +1,4 @@
1
- import { ResolvedMetadata } from '../types/resolvedMetadata.ts';
1
+ import { ResolvedMetadata } from '../../types/resolvedMetadata.ts';
2
2
  import { KoboMetadata } from './parse.ts';
3
3
  export declare const koboMetadataHomes: {
4
4
  readonly renditionLayout: "renditionLayout";
@@ -0,0 +1,5 @@
1
+ import { Archive } from '../../archives/types.ts';
2
+ export declare const getArchiveOpfInfo: (archive: Archive) => {
3
+ data: import('../../index.ts').FileRecord | undefined;
4
+ basePath: string;
5
+ };
@@ -1,6 +1,6 @@
1
- import { Archive } from '../archives/types.ts';
1
+ import { Archive } from '../../archives/types.ts';
2
2
  import { ArchiveOpfParsed } from './readArchiveOpf.ts';
3
3
  export declare const getSpineItemFilesFromArchive: ({ archive, archiveOpf, }: {
4
4
  archive: Archive;
5
5
  archiveOpf: ArchiveOpfParsed | undefined;
6
- }) => Promise<import('../index.ts').ArchiveRecord[]>;
6
+ }) => Promise<import('../../index.ts').ArchiveRecord[]>;
@@ -1,2 +1,2 @@
1
- import { Archive } from '../archives/types.ts';
1
+ import { Archive } from '../../archives/types.ts';
2
2
  export declare const isArchiveEpub: (archive: Archive) => boolean;
@@ -1,4 +1,4 @@
1
- import { Archive } from '../archives/types.ts';
1
+ import { Archive } from '../../archives/types.ts';
2
2
  import { OpfMetadata } from './parse.ts';
3
3
  export type ArchiveOpfParsed = {
4
4
  opf: OpfMetadata;
@@ -1,4 +1,4 @@
1
- import { ResolvedMetadata } from '../types/resolvedMetadata.ts';
1
+ import { ResolvedMetadata } from '../../types/resolvedMetadata.ts';
2
2
  import { OpfMetadata } from './parse.ts';
3
3
  export declare const opfMetadataHomes: {
4
4
  readonly manifestItems: "readingOrder";
@@ -1,5 +1,5 @@
1
1
  import { Archive } from '../archives/types.ts';
2
- import { ArchiveOpfParsed } from '../opf/readArchiveOpf.ts';
2
+ import { ArchiveOpfParsed } from '../metadata/opf/readArchiveOpf.ts';
3
3
  export type ArchiveReadingOrderItem = {
4
4
  readonly uri: string;
5
5
  readonly id?: string;
package/dist/resolve.d.ts CHANGED
@@ -1,7 +1,7 @@
1
- import { AppleMetadata } from './apple/parse.ts';
2
- import { ComicInfo } from './comicInfo/parse.ts';
3
- import { KoboMetadata } from './kobo/parse.ts';
4
- import { OpfMetadata } from './opf/parse.ts';
1
+ import { AppleMetadata } from './metadata/apple/parse.ts';
2
+ import { ComicInfo } from './metadata/comicInfo/parse.ts';
3
+ import { KoboMetadata } from './metadata/kobo/parse.ts';
4
+ import { OpfMetadata } from './metadata/opf/parse.ts';
5
5
  import { ResolvedMetadata } from './types/resolvedMetadata.ts';
6
6
  export type ResolvedArchiveInput = ComicInfo | KoboMetadata | AppleMetadata | OpfMetadata;
7
7
  export declare const resolveArchiveMetadata: (input: ResolvedArchiveInput) => ResolvedMetadata;
@@ -1,8 +1,8 @@
1
- import { AppleMetadata } from './apple/parse.ts';
2
1
  import { Archive } from './archives/types.ts';
3
- import { ComicInfo } from './comicInfo/parse.ts';
4
- import { KoboMetadata } from './kobo/parse.ts';
5
- import { ArchiveOpfParsed } from './opf/readArchiveOpf.ts';
2
+ import { AppleMetadata } from './metadata/apple/parse.ts';
3
+ import { ComicInfo } from './metadata/comicInfo/parse.ts';
4
+ import { KoboMetadata } from './metadata/kobo/parse.ts';
5
+ import { ArchiveOpfParsed } from './metadata/opf/readArchiveOpf.ts';
6
6
  import { ArchiveReadingOrderItem } from './readingOrder/resolveArchiveReadingOrder.ts';
7
7
  import { ArchiveTocItem } from './toc/types.ts';
8
8
  import { ResolvedMetadata } from './types/resolvedMetadata.ts';
@@ -1,7 +1,7 @@
1
- import { AppleMetadata } from './apple/parse.ts';
2
- import { ComicInfo } from './comicInfo/parse.ts';
3
- import { KoboMetadata } from './kobo/parse.ts';
4
- import { OpfMetadata } from './opf/parse.ts';
1
+ import { AppleMetadata } from './metadata/apple/parse.ts';
2
+ import { ComicInfo } from './metadata/comicInfo/parse.ts';
3
+ import { KoboMetadata } from './metadata/kobo/parse.ts';
4
+ import { OpfMetadata } from './metadata/opf/parse.ts';
5
5
  import { ResolvedMetadata } from './types/resolvedMetadata.ts';
6
6
  export type ResolveMetadataSources = {
7
7
  opf?: OpfMetadata;
package/dist/toc/nav.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  import { Archive } from '../archives/types.ts';
2
- import { OpfMetadata } from '../opf/parse.ts';
2
+ import { OpfMetadata } from '../metadata/opf/parse.ts';
3
3
  import { ArchiveTocItem } from './types.ts';
4
4
  export declare const resolveTocFromNav: (opf: OpfMetadata, archive: Archive) => Promise<ArchiveTocItem[] | undefined>;
package/dist/toc/ncx.d.ts CHANGED
@@ -1,5 +1,5 @@
1
1
  import { Archive } from '../archives/types.ts';
2
- import { OpfMetadata } from '../opf/parse.ts';
2
+ import { OpfMetadata } from '../metadata/opf/parse.ts';
3
3
  import { ArchiveTocItem } from './types.ts';
4
4
  export declare const resolveTocFromNcx: ({ opf, opfBasePath, archive, }: {
5
5
  opf: OpfMetadata;
@@ -1,5 +1,5 @@
1
1
  import { Archive } from '../archives/types.ts';
2
- import { ArchiveOpfParsed } from '../opf/readArchiveOpf.ts';
2
+ import { ArchiveOpfParsed } from '../metadata/opf/readArchiveOpf.ts';
3
3
  import { ArchiveTocItem } from './types.ts';
4
4
  export declare const resolveArchiveToc: (archive: Archive, { opf }?: {
5
5
  opf?: ArchiveOpfParsed;
@@ -1,3 +1,12 @@
1
+ export type KnownMetadataIdentifierScheme = "ISBN" | "GTIN" | "DOI" | "GoogleBooks" | "OpenLibrary" | "ProjectGutenberg" | "URL" | "Unknown";
2
+ export type MetadataIdentifierScheme = KnownMetadataIdentifierScheme | (string & {});
3
+ export type MetadataIdentifier = {
4
+ readonly value: string;
5
+ readonly scheme: MetadataIdentifierScheme;
6
+ };
7
+ export type ResolvedMetadataIdentifier = MetadataIdentifier & {
8
+ readonly unique?: true;
9
+ };
1
10
  export type ResolvedContributorRole = "author" | "translator" | "editor" | "artist" | "illustrator" | "letterer" | "penciler" | "colorist" | "inker" | "narrator" | "contributor" | "coverArtist";
2
11
  export type ResolvedContributor = {
3
12
  readonly name: string;
@@ -80,13 +89,7 @@ export type ResolvedMetadata = {
80
89
  readonly renditionFlow?: "scrolled-continuous" | "scrolled-doc" | "paginated" | "auto";
81
90
  readonly renditionSpread?: "none" | "landscape" | "portrait" | "both" | "auto";
82
91
  readonly numberOfPages?: number;
83
- readonly gtin?: string;
84
- readonly isbn?: string;
85
- readonly identifiers?: ReadonlyArray<{
86
- readonly value: string;
87
- readonly scheme?: string;
88
- readonly unique?: true;
89
- }>;
92
+ readonly identifiers?: ReadonlyArray<ResolvedMetadataIdentifier>;
90
93
  readonly belongsTo?: {
91
94
  readonly series?: ReadonlyArray<ResolvedCollection>;
92
95
  readonly collection?: ReadonlyArray<ResolvedCollection>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@prose-reader/archive-reader",
3
- "version": "1.344.0",
3
+ "version": "1.345.0",
4
4
  "type": "module",
5
5
  "main": "./dist/index/index.cjs",
6
6
  "module": "./dist/index/index.js",
@@ -59,7 +59,7 @@
59
59
  "test:watch": "vitest watch"
60
60
  },
61
61
  "dependencies": {
62
- "@prose-reader/shared": "^1.344.0",
62
+ "@prose-reader/shared": "^1.345.0",
63
63
  "xmldoc": "^2.0.0"
64
64
  },
65
65
  "peerDependencies": {
@@ -100,5 +100,5 @@
100
100
  "node-unrar-js": "^2.0.2",
101
101
  "unzipper": "^0.12.3"
102
102
  },
103
- "gitHead": "3eac02f8c2fca1f9900d411ed573ab9a281731c0"
103
+ "gitHead": "f2f6e09d604f1f8e539d01ddd70c6a799c9d82cd"
104
104
  }
@@ -1,5 +0,0 @@
1
- import { Archive } from '../archives/types.ts';
2
- export declare const getArchiveOpfInfo: (archive: Archive) => {
3
- data: import('../index.ts').FileRecord | undefined;
4
- basePath: string;
5
- };
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes