@prose-reader/archive-reader 1.321.0 → 1.323.0

package/dist/opf/parse.d.ts

@@ -24,6 +24,22 @@ export type OpfGuideReference = {
     readonly title: string;
     readonly type: string;
 };
+export type OpfMetaEntry = {
+    readonly property?: string;
+    readonly refines?: string;
+    readonly scheme?: string;
+    readonly id?: string;
+    readonly name?: string;
+    readonly content?: string;
+    readonly value?: string;
+};
+export type OpfContributor = {
+    readonly name: string;
+    readonly source: "creator" | "contributor";
+    readonly id?: string;
+    readonly roles: ReadonlyArray<string>;
+    readonly fileAs?: string;
+};
 export type OpfMetadata = {
     readonly kind: "opf";
     readonly manifestItems: ReadonlyArray<OpfSpineManifestItem>;
@@ -32,7 +48,9 @@ export type OpfMetadata = {
     readonly identifiers: ReadonlyArray<OpfIdentifier>;
     readonly title: string | undefined;
     readonly creators: ReadonlyArray<string>;
+    readonly contributors: ReadonlyArray<OpfContributor>;
     readonly publisher: string | undefined;
+    readonly description: string | undefined;
     readonly rights: string | undefined;
     readonly languages: ReadonlyArray<string>;
     readonly subjects: ReadonlyArray<string>;
@@ -43,5 +61,6 @@ export type OpfMetadata = {
     readonly renditionSpreadMeta: string | undefined;
     readonly pageProgressionDirection: string | undefined;
     readonly guide: ReadonlyArray<OpfGuideReference>;
+    readonly metas: ReadonlyArray<OpfMetaEntry>;
 };
 export declare const parseOpf: (opfXml: string) => OpfMetadata;

package/dist/opf/resolve.d.ts

@@ -1,3 +1,25 @@
-import { ArchiveResolveResult } from '../types/archiveResolve';
+import { ResolvedMetadata } from '../types/resolvedMetadata';
 import { OpfMetadata } from './parse';
-export declare const resolveOpf: (input: OpfMetadata) => ArchiveResolveResult;
+export declare const opfMetadataHomes: {
+    readonly manifestItems: "readingOrder";
+    readonly spineRows: "readingOrder";
+    readonly spineTocIdref: "toc";
+    readonly identifiers: "identifiers";
+    readonly title: "title";
+    readonly creators: "contributors";
+    readonly contributors: "contributors";
+    readonly publisher: "publisher";
+    readonly description: "description";
+    readonly rights: "rights";
+    readonly languages: "languages";
+    readonly subjects: "subjects";
+    readonly date: "published";
+    readonly coverHref: "cover";
+    readonly renditionLayoutMeta: "renditionLayout";
+    readonly renditionFlowMeta: "renditionFlow";
+    readonly renditionSpreadMeta: "renditionSpread";
+    readonly pageProgressionDirection: "readingDirection";
+    readonly guide: "guide";
+    readonly metas: "properties";
+};
+export declare const resolveOpf: (input: OpfMetadata) => ResolvedMetadata;

package/dist/readingOrder/resolveArchiveReadingOrder.d.ts

@@ -0,0 +1,16 @@
+import { Archive } from '../archives/types';
+import { ArchiveOpfParsed } from '../opf/readArchiveOpf';
+export type ArchiveReadingOrderItem = {
+    readonly uri: string;
+    readonly id?: string;
+    readonly mediaType?: string;
+    readonly size?: number;
+    readonly renditionLayout?: "reflowable" | "pre-paginated";
+    readonly renditionFlow?: "scrolled-continuous" | "scrolled-doc" | "paginated" | "auto";
+    readonly pageSpreadLeft?: true;
+    readonly pageSpreadRight?: true;
+    readonly progressionWeight: number;
+};
+export declare const resolveArchiveReadingOrder: (archive: Archive, { opf }?: {
+    opf?: ArchiveOpfParsed;
+}) => Promise<ArchiveReadingOrderItem[]>;

package/dist/readingOrder/resolveArchiveReadingOrder.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/resolve.d.ts

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

package/dist/resolveArchive.d.ts

@@ -0,0 +1,29 @@
+import { AppleMetadata } from './apple/parse';
+import { Archive } from './archives/types';
+import { ComicInfo } from './comicInfo/parse';
+import { KoboMetadata } from './kobo/parse';
+import { ArchiveOpfParsed } from './opf/readArchiveOpf';
+import { ArchiveReadingOrderItem } from './readingOrder/resolveArchiveReadingOrder';
+import { ArchiveTocItem } from './toc/types';
+import { ResolvedMetadata } from './types/resolvedMetadata';
+export type ResolvedArchiveSources = {
+    readonly opf?: ArchiveOpfParsed;
+    readonly comicInfo?: ComicInfo;
+    readonly apple?: AppleMetadata;
+    readonly kobo?: KoboMetadata;
+};
+export type ResolvedArchive = {
+    readonly version: number;
+    readonly metadata: ResolvedMetadata;
+    readonly readingOrder: ArchiveReadingOrderItem[];
+    readonly toc?: ArchiveTocItem[];
+    readonly sources: ResolvedArchiveSources;
+};
+export type ResolveArchiveToken = keyof ResolvedArchive;
+declare const DEFAULT_INCLUDE: readonly ["metadata", "readingOrder", "toc"];
+export type ResolveArchiveOptions<T extends ReadonlyArray<ResolveArchiveToken>> = {
+    include?: T;
+    layoutScan?: boolean;
+};
+export declare const resolveArchive: <T extends ReadonlyArray<ResolveArchiveToken> = typeof DEFAULT_INCLUDE>(archive: Archive, options?: ResolveArchiveOptions<T>) => Promise<Pick<ResolvedArchive, T[number] | "version">>;
+export {};

package/dist/resolveArchive.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/resolveMetadata.d.ts

@@ -0,0 +1,12 @@
+import { AppleMetadata } from './apple/parse';
+import { ComicInfo } from './comicInfo/parse';
+import { KoboMetadata } from './kobo/parse';
+import { OpfMetadata } from './opf/parse';
+import { ResolvedMetadata } from './types/resolvedMetadata';
+export type ResolveMetadataSources = {
+    opf?: OpfMetadata;
+    comicInfo?: ComicInfo;
+    apple?: AppleMetadata;
+    kobo?: KoboMetadata;
+};
+export declare const resolveMetadata: (sources: ResolveMetadataSources) => ResolvedMetadata;

package/dist/resolveMetadata.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/resolvedMetadata.d.ts

@@ -0,0 +1,84 @@
+export type ResolvedContributorRole = "author" | "translator" | "editor" | "artist" | "illustrator" | "letterer" | "penciler" | "colorist" | "inker" | "narrator" | "contributor" | "coverArtist";
+export type ResolvedContributor = {
+    readonly name: string;
+    readonly roles: ReadonlyArray<ResolvedContributorRole | (string & {})>;
+    readonly sortAs?: string;
+};
+export type ResolvedCollection = {
+    readonly name: string;
+    readonly position?: number;
+    readonly total?: number;
+};
+export type ResolvedDate = {
+    readonly year?: number;
+    readonly month?: number;
+    readonly day?: number;
+};
+export type ResolvedProperty = {
+    readonly property?: string;
+    readonly refines?: string;
+    readonly scheme?: string;
+    readonly id?: string;
+    readonly name?: string;
+    readonly content?: string;
+    readonly value?: string;
+};
+export type ResolvedComicMetadata = {
+    readonly manga?: boolean;
+    readonly blackAndWhite?: boolean;
+    readonly volume?: number;
+    readonly format?: string;
+    readonly ageRating?: string;
+    readonly communityRating?: number;
+    readonly notes?: string;
+    readonly review?: string;
+    readonly web?: ReadonlyArray<string>;
+    readonly scanInformation?: string;
+    readonly mainCharacterOrTeam?: string;
+    readonly characters?: ReadonlyArray<string>;
+    readonly teams?: ReadonlyArray<string>;
+    readonly locations?: ReadonlyArray<string>;
+    readonly storyArcs?: ReadonlyArray<ResolvedCollection>;
+    readonly alternateSeries?: ResolvedCollection;
+};
+export type ResolvedAppleMetadata = {
+    readonly fixedLayout?: boolean;
+    readonly options?: ReadonlyArray<{
+        readonly name?: string;
+        readonly value: string;
+    }>;
+};
+export type ResolvedKoboMetadata = {
+    readonly fixedLayout?: boolean;
+};
+export type ResolvedMetadata = {
+    readonly title?: string;
+    readonly description?: string;
+    readonly publisher?: string;
+    readonly imprint?: string;
+    readonly rights?: string;
+    readonly languages?: ReadonlyArray<string>;
+    readonly subjects?: ReadonlyArray<string>;
+    readonly contributors?: ReadonlyArray<ResolvedContributor>;
+    readonly published?: ResolvedDate;
+    readonly readingDirection?: "ltr" | "rtl";
+    readonly renditionLayout?: "reflowable" | "pre-paginated";
+    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 belongsTo?: {
+        readonly series?: ReadonlyArray<ResolvedCollection>;
+        readonly collection?: ReadonlyArray<ResolvedCollection>;
+    };
+    readonly properties?: ReadonlyArray<ResolvedProperty>;
+    readonly comic?: ResolvedComicMetadata;
+    readonly apple?: ResolvedAppleMetadata;
+    readonly kobo?: ResolvedKoboMetadata;
+};
+export type ResolvedMetadataHome = Exclude<keyof ResolvedMetadata, "comic" | "apple" | "kobo" | "belongsTo"> | `comic.${keyof ResolvedComicMetadata}` | `apple.${keyof ResolvedAppleMetadata}` | `kobo.${keyof ResolvedKoboMetadata}` | `belongsTo.${"series" | "collection"}` | "readingOrder" | "toc" | "cover" | "guide";

package/dist/utils/omitUndefined.d.ts

@@ -0,0 +1 @@
+export declare const omitUndefined: <T extends object>(obj: T) => T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prose-reader/archive-reader",
-  "version": "1.321.0",
+  "version": "1.323.0",
   "type": "module",
   "main": "./dist/index/index.cjs",
   "module": "./dist/index/index.js",
@@ -53,7 +53,7 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@prose-reader/shared": "^1.321.0",
+    "@prose-reader/shared": "^1.323.0",
     "xmldoc": "^2.0.0"
   },
   "peerDependencies": {
@@ -93,5 +93,5 @@
     "node-unrar-js": "^2.0.2",
     "unzipper": "^0.12.3"
   },
-  "gitHead": "8bfc054a6a40ada59234bf36d4527db17395afcc"
+  "gitHead": "a4b2ecb1190781afe7cd2516a20f936fc82e93ca"
 }

package/dist/types/archiveResolve.d.ts

@@ -1,17 +0,0 @@
-export type ArchiveResolveResult = {
-    gtin?: string;
-    isbn?: string;
-    readingDirection?: "ltr" | "rtl";
-    renditionLayout?: "reflowable" | "pre-paginated";
-    title?: string;
-    authors?: string[];
-    publisher?: string;
-    rights?: string;
-    languages?: string[];
-    date?: {
-        year?: number;
-        month?: number;
-        day?: number;
-    };
-    subjects?: string[];
-};