@mana-app/types 0.0.8 → 0.0.9

package/dist/sources/ContentSource/ContentSource.d.ts

@@ -1,4 +1,4 @@
-import { Content, Chapter, ChapterData, SourceInfo, Property } from "../../types";
+import { Content, Chapter, ChapterData, SourceInfo, Property, AdditionalInfoSectionItem } from "../../types";
 import { DirectoryHandler, ManaSource } from "../Source";
 export type SourceConfig = {
     /**
@@ -44,5 +44,9 @@ export interface ContentSource extends SourceCore, DirectoryHandler {
      * Called to get tags available on the source
      */
     getTags?(): Promise<Property[]>;
+    /**
+     * Called to get additional info section items for a content
+     */
+    getAdditionalInfoSectionItems?(contentId: string, sectionId: string): Promise<AdditionalInfoSectionItem[]>;
 }
 export {};

package/dist/sources/ContentTracker/AdvancedTracker.d.ts

@@ -1,9 +1,7 @@
 import { DirectoryHandler } from "..";
-import { FullTrackItem } from "../../types";
 export interface AdvancedTracker extends DirectoryHandler {
     /**
      * This is called to get the info required to prepare a "profile page" for the title
      */
-    getFullInformation(id: string): Promise<FullTrackItem>;
     toggleFavorite?(state: boolean): Promise<void>;
 }

package/dist/types/content/Content.d.ts

@@ -1,7 +1,7 @@
 import { BaseItem } from "./BaseItem";
 import { Chapter } from "./Chapter";
-import { HighlightCollection } from "./Collection";
 import { PublicationStatus, ContentType, ReadingMode } from "./Enums";
+import { SimpleHighlight } from "./Highlight";
 import { Property } from "./Property";
 export type Content = BaseItem & {
     /**
@@ -10,10 +10,6 @@ export type Content = BaseItem & {
      * Note: Defaults to UNKNOWN if not defined.
      */
     status?: PublicationStatus;
-    /**
-     * Names of creators of the publication; Artists, Authors etc
-     */
-    creators?: string[];
     /**
      * Summary / Description of the content
      */
@@ -43,17 +39,14 @@ export type Content = BaseItem & {
      */
     recommendedPanelMode?: ReadingMode;
     /**
-     * Additional Collections to display.
-     *
-     * Useful for display stuff like recommended Content
-     */
-    collections?: HighlightCollection[];
-    /**
-     * Additional Info that may be displayed with this content
+     * Additional Info Sections that may be displayed with this content
+     * The sections are displayed in the order they are defined
+     * Only 10 items per section are stored in the database, the user can view more which will require a implementation of getAdditionalInfoSectionItems and setting the hasMore property to true
      */
-    info?: string[];
+    additionalInfo?: AdditionalInfoSection[];
     /**
      * The Content's defined Tracking ID's.
+     * e.g.: { "anilist": "1234567890", "mal": "1234567890" }
      */
     trackerInfo?: Record<string, string>;
     /**
@@ -61,7 +54,48 @@ export type Content = BaseItem & {
      *
      * Most websites display both the content information and chapters on the same page. Use to property to populate the chapters is such is the case
      *
-     * Note: If Defined Suwatte will not make the subsequent requests required to get the content's chapters in the profile view.
+     * Note: If defined Mana will not make the subsequent requests required to get the content's chapters in the profile view.
      */
     chapters?: Chapter[];
 };
+export declare enum AdditionalInfoType {
+    Staff = 1,
+    Highlights = 2,
+    Characters = 3
+}
+export interface AdditionalInfoBase<TType extends AdditionalInfoType = AdditionalInfoType> {
+    type: TType;
+    id: string;
+    title: string;
+    hasMore: boolean;
+}
+export type AdditionalInfoSection = StaffSection | HighlightsSection | CharactersSection;
+export type StaffSection = AdditionalInfoBase<AdditionalInfoType.Staff> & {
+    items: StaffItem[];
+};
+export type HighlightsSection = AdditionalInfoBase<AdditionalInfoType.Highlights> & {
+    items: SimpleHighlight[];
+};
+export type CharactersSection = AdditionalInfoBase<AdditionalInfoType.Characters> & {
+    items: CharacterItem[];
+};
+export interface AdditionalInfoItemBase<TType extends AdditionalInfoType = AdditionalInfoType> {
+    readonly type: TType;
+    id: string;
+}
+export type StaffItem = AdditionalInfoItemBase<AdditionalInfoType.Staff> & {
+    id: string;
+    title: string;
+    subtitle?: string;
+    image?: string;
+};
+export type CharacterItem = AdditionalInfoItemBase<AdditionalInfoType.Characters> & {
+    id: string;
+    title: string;
+    subtitle?: string;
+    image?: string;
+    staffTitle?: string;
+    staffSubtitle?: string;
+    staffImage?: string;
+};
+export type AdditionalInfoSectionItem = StaffItem | CharacterItem | SimpleHighlight;

package/dist/types/content/Content.js

@@ -1,2 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdditionalInfoType = void 0;
+var AdditionalInfoType;
+(function (AdditionalInfoType) {
+    AdditionalInfoType[AdditionalInfoType["Staff"] = 1] = "Staff";
+    AdditionalInfoType[AdditionalInfoType["Highlights"] = 2] = "Highlights";
+    AdditionalInfoType[AdditionalInfoType["Characters"] = 3] = "Characters";
+})(AdditionalInfoType || (exports.AdditionalInfoType = AdditionalInfoType = {}));
+;

package/dist/types/content/Highlight.d.ts

@@ -2,6 +2,7 @@ import { ContextProvider } from "../core";
 import { Linkable } from "../page";
 import { TrackEntry } from "../tracker";
 import { BaseItem } from "./BaseItem";
+import { AdditionalInfoType, AdditionalInfoItemBase } from "./Content";
 export type Highlight = BaseItem & ContextProvider & {
     id: string;
     /**
@@ -38,3 +39,9 @@ export type Badge = {
     count?: number;
     color?: string;
 };
+export type SimpleHighlight = AdditionalInfoItemBase<AdditionalInfoType.Highlights> & BaseItem & {
+    /**
+       * Marks this highlight as non interactive
+       */
+    noninteractive?: boolean;
+};

package/dist/types/content/index.d.ts

@@ -3,7 +3,6 @@ export * from "./Highlight";
 export * from "./Chapter";
 export * from "./ChapterData";
 export * from "./Property";
-export * from "./Collection";
 export * from "./Provider";
 export * from "./Enums";
 export * from "./ReaderContext";

package/dist/types/content/index.js

@@ -19,7 +19,6 @@ __exportStar(require("./Highlight"), exports);
 __exportStar(require("./Chapter"), exports);
 __exportStar(require("./ChapterData"), exports);
 __exportStar(require("./Property"), exports);
-__exportStar(require("./Collection"), exports);
 __exportStar(require("./Provider"), exports);
 __exportStar(require("./Enums"), exports);
 __exportStar(require("./ReaderContext"), exports);

package/dist/types/tracker/index.d.ts

@@ -1,5 +1,3 @@
-import { Highlight, Property } from "../content";
-import { PublicationStatus } from "../content/Enums";
 export declare enum TrackStatus {
     READING = "READING",
     PLANNING = "PLANNING",
@@ -21,23 +19,3 @@ export type TrackEntry = {
     status: TrackStatus;
     progress: TrackProgress;
 };
-export type FullTrackItem = Highlight & {
-    summary?: string;
-    properties?: Property[];
-    bannerCover?: string;
-    isFavorite?: boolean;
-    relatedTitles?: Highlight[];
-    recommendedTitles?: Highlight[];
-    links?: {
-        title: string;
-        url: string;
-    }[];
-    characters?: {
-        name: string;
-        role?: string;
-        image?: string;
-        summary?: string;
-    }[];
-    additionalTitles?: string[];
-    status?: PublicationStatus;
-};

package/dist/types/tracker/index.js

@@ -1,4 +1,6 @@
 "use strict";
+/*import { Highlight, Property } from "../content";
+import { PublicationStatus } from "../content/Enums";*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TrackStatus = void 0;
 var TrackStatus;
@@ -10,3 +12,20 @@ var TrackStatus;
     TrackStatus["DROPPED"] = "DROPPED";
     TrackStatus["REREADING"] = "REREADING";
 })(TrackStatus || (exports.TrackStatus = TrackStatus = {}));
+/*export type FullTrackItem = Highlight & {
+  summary?: string;
+  properties?: Property[];
+  bannerCover?: string;
+  isFavorite?: boolean;
+  relatedTitles?: Highlight[];
+  recommendedTitles?: Highlight[];
+  links?: { title: string; url: string }[];
+  characters?: {
+    name: string;
+    role?: string;
+    image?: string;
+    summary?: string;
+  }[];
+  additionalTitles?: string[];
+  status?: PublicationStatus;
+};*/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mana-app/types",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {