@prose-reader/archive-reader 1.344.0 → 1.346.0

package/dist/index.d.ts

@@ -1,7 +1,3 @@
-export type { AppleDisplayOption, AppleMetadata } from './apple/parse.ts';
-export { APPLE_IBOOKS_DISPLAY_OPTIONS_FILENAME, parseAppleDisplayOptionsXml, } from './apple/parse.ts';
-export { readArchiveApple } from './apple/readArchiveApple.ts';
-export { appleMetadataHomes } from './apple/resolve.ts';
 export { createArchive } from './archives/createArchive.ts';
 export { createArchiveFromArrayBufferList } from './archives/createArchiveFromArrayBufferList.ts';
 export { type ArchiveEntry, type CreateArchiveFromEntriesOptions, createArchiveFromEntries, } from './archives/createArchiveFromEntries.ts';
@@ -12,27 +8,31 @@ export { getArchiveImageRecords, isImageRecord, } from './archives/images.ts';
 export { readRecordAsText } from './archives/readRecordAsText.ts';
 export type { Archive, ArchiveRecord, DirectoryRecord, FileRecord, } from './archives/types.ts';
 export { getArchiveFileRecordByUri, isDirectoryRecord, isFileRecord, } from './archives/types.ts';
-export { getArchiveHasComicInfo } from './comicInfo/getArchiveHasComicInfo.ts';
-export type { ComicInfoManga } from './comicInfo/manga.ts';
-export { COMIC_INFO_MANGA_VALUES, isComicInfoManga } from './comicInfo/manga.ts';
-export type { ComicInfo, ComicInfoKnownField } from './comicInfo/parse.ts';
-export { COMIC_INFO_FILENAME, COMIC_INFO_KNOWN_FIELDS, parseComicInfo, } from './comicInfo/parse.ts';
-export { readArchiveComicInfo } from './comicInfo/readArchiveComicInfo.ts';
-export { comicInfoMetadataHomes } from './comicInfo/resolve.ts';
 export { resolveArchiveCover } from './cover/resolveArchiveCover.ts';
-export type { KoboMetadata } from './kobo/parse.ts';
-export { KOBO_DISPLAY_OPTIONS_FILENAME, parseKoboXml } from './kobo/parse.ts';
-export { readArchiveKobo } from './kobo/readArchiveKobo.ts';
-export { koboMetadataHomes } from './kobo/resolve.ts';
 export { readingOrderDocumentsAllHaveViewport } from './layout/scanReadingOrderDocumentsViewport.ts';
-export { getArchiveOpfInfo } from './opf/getArchiveOpfInfo.ts';
-export { getSpineItemFilesFromArchive } from './opf/getSpineItemFilesFromArchive.ts';
-export { isArchiveEpub } from './opf/isArchiveEpub.ts';
-export type { OpfContributor, OpfGuideReference, OpfIdentifier, OpfMetadata, OpfMetaEntry, OpfSpineManifestItem, OpfSpineRow, } from './opf/parse.ts';
-export { parseOpf } from './opf/parse.ts';
-export type { ArchiveOpfParsed } from './opf/readArchiveOpf.ts';
-export { readArchiveOpf } from './opf/readArchiveOpf.ts';
-export { opfMetadataHomes } from './opf/resolve.ts';
+export type { AppleDisplayOption, AppleMetadata, } from './metadata/apple/parse.ts';
+export { APPLE_IBOOKS_DISPLAY_OPTIONS_FILENAME, parseAppleDisplayOptionsXml, } from './metadata/apple/parse.ts';
+export { readArchiveApple } from './metadata/apple/readArchiveApple.ts';
+export { appleMetadataHomes } from './metadata/apple/resolve.ts';
+export { getArchiveHasComicInfo } from './metadata/comicInfo/getArchiveHasComicInfo.ts';
+export type { ComicInfoManga } from './metadata/comicInfo/manga.ts';
+export { COMIC_INFO_MANGA_VALUES, isComicInfoManga, } from './metadata/comicInfo/manga.ts';
+export type { ComicInfo, ComicInfoKnownField, } from './metadata/comicInfo/parse.ts';
+export { COMIC_INFO_FILENAME, COMIC_INFO_KNOWN_FIELDS, parseComicInfo, } from './metadata/comicInfo/parse.ts';
+export { readArchiveComicInfo } from './metadata/comicInfo/readArchiveComicInfo.ts';
+export { comicInfoMetadataHomes } from './metadata/comicInfo/resolve.ts';
+export type { KoboMetadata } from './metadata/kobo/parse.ts';
+export { KOBO_DISPLAY_OPTIONS_FILENAME, parseKoboXml, } from './metadata/kobo/parse.ts';
+export { readArchiveKobo } from './metadata/kobo/readArchiveKobo.ts';
+export { koboMetadataHomes } from './metadata/kobo/resolve.ts';
+export { getArchiveOpfInfo } from './metadata/opf/getArchiveOpfInfo.ts';
+export { getSpineItemFilesFromArchive } from './metadata/opf/getSpineItemFilesFromArchive.ts';
+export { isArchiveEpub } from './metadata/opf/isArchiveEpub.ts';
+export type { OpfContributor, OpfGuideReference, OpfIdentifier, OpfMetadata, OpfMetaEntry, OpfSpineManifestItem, OpfSpineRow, } from './metadata/opf/parse.ts';
+export { parseOpf } from './metadata/opf/parse.ts';
+export type { ArchiveOpfParsed } from './metadata/opf/readArchiveOpf.ts';
+export { readArchiveOpf } from './metadata/opf/readArchiveOpf.ts';
+export { opfMetadataHomes } from './metadata/opf/resolve.ts';
 export type { ArchiveReadingOrderItem } from './readingOrder/resolveArchiveReadingOrder.ts';
 export { resolveArchiveReadingOrder } from './readingOrder/resolveArchiveReadingOrder.ts';
 export type { ResolvedArchiveInput } from './resolve.ts';
@@ -43,7 +43,8 @@ export type { ResolveMetadataSources } from './resolveMetadata.ts';
 export { resolveMetadata } from './resolveMetadata.ts';
 export { resolveArchiveToc } from './toc/resolveArchiveToc.ts';
 export type { ArchiveTocItem } from './toc/types.ts';
-export type { ResolvedAppleMetadata, ResolvedCollection, ResolvedComicMetadata, ResolvedConfidence, ResolvedContributor, ResolvedContributorRole, ResolvedCover, ResolvedDate, ResolvedKoboMetadata, ResolvedMetadata, ResolvedMetadataHome, ResolvedProperty, ResolvedPublication, ResolvedPublicationInfo, } from './types/resolvedMetadata.ts';
+export type { KnownMetadataIdentifierScheme, MetadataIdentifier, MetadataIdentifierScheme, ResolvedAppleMetadata, ResolvedCollection, ResolvedComicMetadata, ResolvedConfidence, ResolvedContributor, ResolvedContributorRole, ResolvedCover, ResolvedDate, ResolvedKoboMetadata, ResolvedMetadata, ResolvedMetadataHome, ResolvedMetadataHomes, ResolvedMetadataIdentifier, ResolvedProperty, ResolvedPublication, ResolvedPublicationInfo, ResolvedTitle, ResolvedTitleType, } from './types/resolvedMetadata.ts';
+export { mainTitle } from './utils/mainTitle.ts';
 export { normalizeGtin } from './utils/normalizeGtin.ts';
 export { normalizeIsbn } from './utils/normalizeIsbn.ts';
 export { parseW3cDtfDate } from './utils/parseW3cDtfDate.ts';

package/dist/{apple → metadata/apple}/readArchiveApple.d.ts

@@ -1,3 +1,3 @@
-import { Archive } from '../archives/types.ts';
+import { Archive } from '../../archives/types.ts';
 import { AppleMetadata } from './parse.ts';
 export declare function readArchiveApple(archive: Archive): Promise<AppleMetadata | undefined>;

package/dist/{apple → metadata/apple}/resolve.d.ts

@@ -1,4 +1,4 @@
-import { ResolvedMetadata } from '../types/resolvedMetadata.ts';
+import { ResolvedMetadata } from '../../types/resolvedMetadata.ts';
 import { AppleMetadata } from './parse.ts';
 export declare const appleMetadataHomes: {
     readonly displayOptions: "apple.options";

package/dist/{comicInfo → metadata/comicInfo}/getArchiveHasComicInfo.d.ts

@@ -1,2 +1,2 @@
-import { Archive, FileRecord } from '../archives/types.ts';
+import { Archive, FileRecord } from '../../archives/types.ts';
 export declare const getArchiveHasComicInfo: (archive: Archive) => FileRecord | undefined;

package/dist/{comicInfo → metadata/comicInfo}/readArchiveComicInfo.d.ts

@@ -1,3 +1,3 @@
-import { Archive } from '../archives/types.ts';
+import { Archive } from '../../archives/types.ts';
 import { ComicInfo } from './parse.ts';
 export declare function readArchiveComicInfo(archive: Archive): Promise<ComicInfo | undefined>;

package/dist/{comicInfo → metadata/comicInfo}/resolve.d.ts

@@ -1,4 +1,4 @@
-import { ResolvedMetadata } from '../types/resolvedMetadata.ts';
+import { ResolvedMetadata } from '../../types/resolvedMetadata.ts';
 import { ComicInfo } from './parse.ts';
 export declare const comicInfoMetadataHomes: {
     readonly AgeRating: "comic.ageRating";
@@ -38,7 +38,7 @@ export declare const comicInfoMetadataHomes: {
     readonly Summary: "description";
     readonly Tags: "subjects";
     readonly Teams: "comic.teams";
-    readonly Title: "title";
+    readonly Title: "titles";
     readonly Translator: "contributors";
     readonly Volume: "comic.volume";
     readonly Web: "comic.web";

package/dist/{kobo → metadata/kobo}/readArchiveKobo.d.ts

@@ -1,3 +1,3 @@
-import { Archive } from '../archives/types.ts';
+import { Archive } from '../../archives/types.ts';
 import { KoboMetadata } from './parse.ts';
 export declare function readArchiveKobo(archive: Archive): Promise<KoboMetadata | undefined>;

package/dist/{kobo → metadata/kobo}/resolve.d.ts

@@ -1,4 +1,4 @@
-import { ResolvedMetadata } from '../types/resolvedMetadata.ts';
+import { ResolvedMetadata } from '../../types/resolvedMetadata.ts';
 import { KoboMetadata } from './parse.ts';
 export declare const koboMetadataHomes: {
     readonly renditionLayout: "renditionLayout";

package/dist/metadata/opf/getArchiveOpfInfo.d.ts

@@ -0,0 +1,5 @@
+import { Archive } from '../../archives/types.ts';
+export declare const getArchiveOpfInfo: (archive: Archive) => {
+    data: import('../../index.ts').FileRecord | undefined;
+    basePath: string;
+};

package/dist/{opf → metadata/opf}/getSpineItemFilesFromArchive.d.ts

@@ -1,6 +1,6 @@
-import { Archive } from '../archives/types.ts';
+import { Archive } from '../../archives/types.ts';
 import { ArchiveOpfParsed } from './readArchiveOpf.ts';
 export declare const getSpineItemFilesFromArchive: ({ archive, archiveOpf, }: {
     archive: Archive;
     archiveOpf: ArchiveOpfParsed | undefined;
-}) => Promise<import('../index.ts').ArchiveRecord[]>;
+}) => Promise<import('../../index.ts').ArchiveRecord[]>;

package/dist/{opf → metadata/opf}/isArchiveEpub.d.ts

@@ -1,2 +1,2 @@
-import { Archive } from '../archives/types.ts';
+import { Archive } from '../../archives/types.ts';
 export declare const isArchiveEpub: (archive: Archive) => boolean;

package/dist/{opf → metadata/opf}/parse.d.ts

@@ -10,6 +10,10 @@ export type OpfIdentifier = {
     readonly id?: string;
     readonly unique?: true;
 };
+export type OpfTitle = {
+    readonly value: string;
+    readonly id?: string;
+};
 export type OpfSpineRow = {
     readonly idref: string;
     readonly id: string;
@@ -48,7 +52,7 @@ export type OpfMetadata = {
     readonly spineRows: ReadonlyArray<OpfSpineRow>;
     readonly spineTocIdref: string | undefined;
     readonly identifiers: ReadonlyArray<OpfIdentifier>;
-    readonly title: string | undefined;
+    readonly titles: ReadonlyArray<OpfTitle>;
     readonly creators: ReadonlyArray<string>;
     readonly contributors: ReadonlyArray<OpfContributor>;
     readonly publisher: string | undefined;

package/dist/{opf → metadata/opf}/readArchiveOpf.d.ts

@@ -1,4 +1,4 @@
-import { Archive } from '../archives/types.ts';
+import { Archive } from '../../archives/types.ts';
 import { OpfMetadata } from './parse.ts';
 export type ArchiveOpfParsed = {
     opf: OpfMetadata;

package/dist/{opf → metadata/opf}/resolve.d.ts

@@ -1,11 +1,11 @@
-import { ResolvedMetadata } from '../types/resolvedMetadata.ts';
+import { ResolvedMetadata } from '../../types/resolvedMetadata.ts';
 import { OpfMetadata } from './parse.ts';
 export declare const opfMetadataHomes: {
     readonly manifestItems: "readingOrder";
     readonly spineRows: "readingOrder";
     readonly spineTocIdref: "toc";
     readonly identifiers: "identifiers";
-    readonly title: "title";
+    readonly titles: "titles";
     readonly creators: "contributors";
     readonly contributors: "contributors";
     readonly publisher: "publication.edition.publisher";

package/dist/readingOrder/resolveArchiveReadingOrder.d.ts

@@ -1,5 +1,5 @@
 import { Archive } from '../archives/types.ts';
-import { ArchiveOpfParsed } from '../opf/readArchiveOpf.ts';
+import { ArchiveOpfParsed } from '../metadata/opf/readArchiveOpf.ts';
 export type ArchiveReadingOrderItem = {
     readonly uri: string;
     readonly id?: string;

package/dist/resolve.d.ts

@@ -1,7 +1,7 @@
-import { AppleMetadata } from './apple/parse.ts';
-import { ComicInfo } from './comicInfo/parse.ts';
-import { KoboMetadata } from './kobo/parse.ts';
-import { OpfMetadata } from './opf/parse.ts';
+import { AppleMetadata } from './metadata/apple/parse.ts';
+import { ComicInfo } from './metadata/comicInfo/parse.ts';
+import { KoboMetadata } from './metadata/kobo/parse.ts';
+import { OpfMetadata } from './metadata/opf/parse.ts';
 import { ResolvedMetadata } from './types/resolvedMetadata.ts';
 export type ResolvedArchiveInput = ComicInfo | KoboMetadata | AppleMetadata | OpfMetadata;
 export declare const resolveArchiveMetadata: (input: ResolvedArchiveInput) => ResolvedMetadata;

package/dist/resolveArchive.d.ts

@@ -1,8 +1,8 @@
-import { AppleMetadata } from './apple/parse.ts';
 import { Archive } from './archives/types.ts';
-import { ComicInfo } from './comicInfo/parse.ts';
-import { KoboMetadata } from './kobo/parse.ts';
-import { ArchiveOpfParsed } from './opf/readArchiveOpf.ts';
+import { AppleMetadata } from './metadata/apple/parse.ts';
+import { ComicInfo } from './metadata/comicInfo/parse.ts';
+import { KoboMetadata } from './metadata/kobo/parse.ts';
+import { ArchiveOpfParsed } from './metadata/opf/readArchiveOpf.ts';
 import { ArchiveReadingOrderItem } from './readingOrder/resolveArchiveReadingOrder.ts';
 import { ArchiveTocItem } from './toc/types.ts';
 import { ResolvedMetadata } from './types/resolvedMetadata.ts';

package/dist/resolveMetadata.d.ts

@@ -1,7 +1,7 @@
-import { AppleMetadata } from './apple/parse.ts';
-import { ComicInfo } from './comicInfo/parse.ts';
-import { KoboMetadata } from './kobo/parse.ts';
-import { OpfMetadata } from './opf/parse.ts';
+import { AppleMetadata } from './metadata/apple/parse.ts';
+import { ComicInfo } from './metadata/comicInfo/parse.ts';
+import { KoboMetadata } from './metadata/kobo/parse.ts';
+import { OpfMetadata } from './metadata/opf/parse.ts';
 import { ResolvedMetadata } from './types/resolvedMetadata.ts';
 export type ResolveMetadataSources = {
     opf?: OpfMetadata;

package/dist/toc/nav.d.ts

@@ -1,4 +1,4 @@
 import { Archive } from '../archives/types.ts';
-import { OpfMetadata } from '../opf/parse.ts';
+import { OpfMetadata } from '../metadata/opf/parse.ts';
 import { ArchiveTocItem } from './types.ts';
 export declare const resolveTocFromNav: (opf: OpfMetadata, archive: Archive) => Promise<ArchiveTocItem[] | undefined>;

package/dist/toc/ncx.d.ts

@@ -1,5 +1,5 @@
 import { Archive } from '../archives/types.ts';
-import { OpfMetadata } from '../opf/parse.ts';
+import { OpfMetadata } from '../metadata/opf/parse.ts';
 import { ArchiveTocItem } from './types.ts';
 export declare const resolveTocFromNcx: ({ opf, opfBasePath, archive, }: {
     opf: OpfMetadata;

package/dist/toc/resolveArchiveToc.d.ts

@@ -1,5 +1,5 @@
 import { Archive } from '../archives/types.ts';
-import { ArchiveOpfParsed } from '../opf/readArchiveOpf.ts';
+import { ArchiveOpfParsed } from '../metadata/opf/readArchiveOpf.ts';
 import { ArchiveTocItem } from './types.ts';
 export declare const resolveArchiveToc: (archive: Archive, { opf }?: {
     opf?: ArchiveOpfParsed;

package/dist/types/resolvedMetadata.d.ts

@@ -1,3 +1,19 @@
+export type KnownMetadataIdentifierScheme = "ISBN" | "GTIN" | "DOI" | "GoogleBooks" | "OpenLibrary" | "ProjectGutenberg" | "URL" | "Unknown";
+export type MetadataIdentifierScheme = KnownMetadataIdentifierScheme | (string & {});
+export type MetadataIdentifier = {
+    readonly value: string;
+    readonly scheme: MetadataIdentifierScheme;
+};
+export type ResolvedMetadataIdentifier = MetadataIdentifier & {
+    readonly unique?: true;
+};
+export type ResolvedTitleType = "main" | "subtitle" | "short" | "collection" | "edition" | "expanded";
+export type ResolvedTitle = {
+    readonly value: string;
+    readonly type?: ResolvedTitleType | (string & {});
+    readonly displaySeq?: number;
+    readonly sortAs?: string;
+};
 export type ResolvedContributorRole = "author" | "translator" | "editor" | "artist" | "illustrator" | "letterer" | "penciler" | "colorist" | "inker" | "narrator" | "contributor" | "coverArtist";
 export type ResolvedContributor = {
     readonly name: string;
@@ -5,7 +21,8 @@ export type ResolvedContributor = {
     readonly sortAs?: string;
 };
 export type ResolvedCollection = {
-    readonly name: string;
+    readonly name?: string;
+    readonly identifiers?: ReadonlyArray<MetadataIdentifier>;
     readonly position?: number;
     readonly total?: number;
 };
@@ -67,7 +84,7 @@ export type ResolvedCover = {
     readonly confidence: ResolvedConfidence;
 };
 export type ResolvedMetadata = {
-    readonly title?: string;
+    readonly titles?: ReadonlyArray<ResolvedTitle>;
     readonly cover?: ResolvedCover;
     readonly description?: string;
     readonly publication?: ResolvedPublicationInfo;
@@ -80,13 +97,7 @@ export type ResolvedMetadata = {
     readonly renditionFlow?: "scrolled-continuous" | "scrolled-doc" | "paginated" | "auto";
     readonly renditionSpread?: "none" | "landscape" | "portrait" | "both" | "auto";
     readonly numberOfPages?: number;
-    readonly gtin?: string;
-    readonly isbn?: string;
-    readonly identifiers?: ReadonlyArray<{
-        readonly value: string;
-        readonly scheme?: string;
-        readonly unique?: true;
-    }>;
+    readonly identifiers?: ReadonlyArray<ResolvedMetadataIdentifier>;
     readonly belongsTo?: {
         readonly series?: ReadonlyArray<ResolvedCollection>;
         readonly collection?: ReadonlyArray<ResolvedCollection>;
@@ -97,3 +108,4 @@ export type ResolvedMetadata = {
     readonly kobo?: ResolvedKoboMetadata;
 };
 export type ResolvedMetadataHome = Exclude<keyof ResolvedMetadata, "comic" | "apple" | "kobo" | "belongsTo" | "publication"> | `comic.${keyof ResolvedComicMetadata}` | `apple.${keyof ResolvedAppleMetadata}` | `kobo.${keyof ResolvedKoboMetadata}` | `belongsTo.${"series" | "collection"}` | `publication.${keyof ResolvedPublicationInfo}` | `publication.${keyof ResolvedPublicationInfo}.${keyof ResolvedPublication}` | "readingOrder" | "toc" | "guide";
+export type ResolvedMetadataHomes = ResolvedMetadataHome | ReadonlyArray<ResolvedMetadataHome>;

package/dist/utils/mainTitle.d.ts

@@ -0,0 +1,2 @@
+import { ResolvedMetadata } from '../types/resolvedMetadata.ts';
+export declare const mainTitle: (metadata: Pick<ResolvedMetadata, "titles"> | undefined) => string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/archive-reader",
-  "version": "1.344.0",
+  "version": "1.346.0",
   "type": "module",
   "main": "./dist/index/index.cjs",
   "module": "./dist/index/index.js",
@@ -59,7 +59,7 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@prose-reader/shared": "^1.344.0",
+    "@prose-reader/shared": "^1.346.0",
     "xmldoc": "^2.0.0"
   },
   "peerDependencies": {
@@ -100,5 +100,5 @@
     "node-unrar-js": "^2.0.2",
     "unzipper": "^0.12.3"
   },
-  "gitHead": "3eac02f8c2fca1f9900d411ed573ab9a281731c0"
+  "gitHead": "4c52e5b82de55cf26d658f039909829b4476fd2b"
 }

package/dist/opf/getArchiveOpfInfo.d.ts

@@ -1,5 +0,0 @@
-import { Archive } from '../archives/types.ts';
-export declare const getArchiveOpfInfo: (archive: Archive) => {
-    data: import('../index.ts').FileRecord | undefined;
-    basePath: string;
-};