@mana-app/types 0.0.1

package/dist/sources/Source/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SourceEnvironment = void 0;
+__exportStar(require("./extensions"), exports);
+var SourceEnvironment;
+(function (SourceEnvironment) {
+    SourceEnvironment[SourceEnvironment["SOURCE"] = 0] = "SOURCE";
+    SourceEnvironment[SourceEnvironment["TRACKER"] = 1] = "TRACKER";
+})(SourceEnvironment || (exports.SourceEnvironment = SourceEnvironment = {}));

package/dist/sources/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./ContentSource";
+export * from "./Source";
+export * from "./ContentTracker";

package/dist/sources/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ContentSource"), exports);
+__exportStar(require("./Source"), exports);
+__exportStar(require("./ContentTracker"), exports);

package/dist/types/UI/Form.d.ts

@@ -0,0 +1,5 @@
+import { UIElement, UISection } from "./UIElements";
+export type FormSection = UISection<UIElement<any>>;
+export type Form = {
+    sections: FormSection[];
+};

package/dist/types/UI/Form.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/UI/UIDefinitions.d.ts

@@ -0,0 +1,29 @@
+import { UIComponentType, UIElement, UIInteractable, UISelectable } from "./UIElements";
+export type UIPickerDefinition = UIElement<UIComponentType.SELECT> & UISelectable & UIInteractable<string>;
+export type UIMultiPickerOptions = UISelectable & {
+    minSelectionCount?: number;
+    maxSelectionCount?: number;
+};
+export type UIMultiPickerDefinition = UIElement<UIComponentType.MULTISELECT> & UIMultiPickerOptions & UIInteractable<string[]>;
+export type UIToggleDefinition = UIElement<UIComponentType.TOGGLE> & UIInteractable<boolean>;
+export type UITextFieldOptions = {
+    placeholder?: string;
+    secure?: boolean;
+    keyboard?: "alphanumeric" | "numeric" | "email";
+    multiline?: boolean;
+};
+export type UITextFieldDefinition = UIElement<UIComponentType.TEXTFIELD> & UITextFieldOptions & UIInteractable<string>;
+export type UIDatePickerDefinition = UIElement<UIComponentType.DATEPICKER> & UIInteractable<Date>;
+export type UIStepperOptions = {
+    upperBound?: number;
+    lowerBound?: number;
+    allowDecimal?: true | "true";
+    step?: 10 | 1 | 0.1;
+};
+export type UIStepperDefinition = UIElement<UIComponentType.STEPPER> & UIStepperOptions & UIInteractable<number>;
+export type UIButtonOptions = {
+    isDestructive?: boolean;
+    systemImage?: string;
+    action: () => Promise<void>;
+};
+export type UIButtonDefinition = UIElement<UIComponentType.BUTTON>;

package/dist/types/UI/UIDefinitions.js

@@ -0,0 +1,3 @@
+"use strict";
+// Picker
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/UI/UIElementBuilders.d.ts

@@ -0,0 +1,9 @@
+import { UIPickerDefinition, UIMultiPickerOptions, UIMultiPickerDefinition, UIToggleDefinition, UITextFieldOptions, UITextFieldDefinition, UIDatePickerDefinition, UIButtonOptions, UIButtonDefinition, UIStepperDefinition, UIStepperOptions } from "./UIDefinitions";
+import { UISelectable, UIInteractable, UISectionChild } from "./UIElements";
+export declare const UIPicker: (props: UISelectable & UIInteractable<string>) => UIPickerDefinition;
+export declare const UIMultiPicker: (props: UIMultiPickerOptions & UIInteractable<string[]>) => UIMultiPickerDefinition;
+export declare const UIToggle: (props: UIInteractable<boolean>) => UIToggleDefinition;
+export declare const UITextField: (props: UITextFieldOptions & UIInteractable<string>) => UITextFieldDefinition;
+export declare const UIDatePicker: (props: UIInteractable<Date>) => UIDatePickerDefinition;
+export declare const UIButton: (props: UIButtonOptions & UISectionChild) => UIButtonDefinition;
+export declare const UIStepper: (props: UIStepperOptions & UIInteractable<number>) => UIStepperDefinition;

package/dist/types/UI/UIElementBuilders.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UIStepper = exports.UIButton = exports.UIDatePicker = exports.UITextField = exports.UIToggle = exports.UIMultiPicker = exports.UIPicker = void 0;
+const UIElements_1 = require("./UIElements");
+const UIPicker = (props) => (Object.assign(Object.assign({}, props), { type: UIElements_1.UIComponentType.SELECT }));
+exports.UIPicker = UIPicker;
+const UIMultiPicker = (props) => (Object.assign(Object.assign({}, props), { type: UIElements_1.UIComponentType.MULTISELECT }));
+exports.UIMultiPicker = UIMultiPicker;
+const UIToggle = (props) => (Object.assign(Object.assign({}, props), { type: UIElements_1.UIComponentType.TOGGLE }));
+exports.UIToggle = UIToggle;
+const UITextField = (props) => (Object.assign(Object.assign({}, props), { type: UIElements_1.UIComponentType.TEXTFIELD }));
+exports.UITextField = UITextField;
+const UIDatePicker = (props) => (Object.assign(Object.assign({}, props), { type: UIElements_1.UIComponentType.DATEPICKER }));
+exports.UIDatePicker = UIDatePicker;
+const UIButton = (props) => (Object.assign(Object.assign({}, props), { type: UIElements_1.UIComponentType.BUTTON }));
+exports.UIButton = UIButton;
+const UIStepper = (props) => (Object.assign(Object.assign({}, props), { type: UIElements_1.UIComponentType.STEPPER }));
+exports.UIStepper = UIStepper;

package/dist/types/UI/UIElements.d.ts

@@ -0,0 +1,31 @@
+import { Option } from "../core";
+export type UISectionChild = {
+    id: string;
+    title: string;
+};
+export type UISection<T extends UISectionChild> = {
+    header?: string;
+    footer?: string;
+    children: T[];
+};
+export declare enum UIComponentType {
+    SELECT = 0,
+    MULTISELECT = 1,
+    STEPPER = 2,
+    TOGGLE = 3,
+    TEXTFIELD = 4,
+    BUTTON = 5,
+    DATEPICKER = 6
+}
+export type Primitive = boolean | string | number | string[] | Date;
+export type UIElement<T extends UIComponentType> = UISectionChild & {
+    type: T;
+};
+export type UISelectable = {
+    options: Option[];
+};
+export type UIInteractable<T extends Primitive> = UISectionChild & {
+    value?: T | null;
+    optional?: true | "true";
+    didChange?: (value: T) => Promise<void>;
+};

package/dist/types/UI/UIElements.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UIComponentType = void 0;
+var UIComponentType;
+(function (UIComponentType) {
+    UIComponentType[UIComponentType["SELECT"] = 0] = "SELECT";
+    UIComponentType[UIComponentType["MULTISELECT"] = 1] = "MULTISELECT";
+    UIComponentType[UIComponentType["STEPPER"] = 2] = "STEPPER";
+    UIComponentType[UIComponentType["TOGGLE"] = 3] = "TOGGLE";
+    UIComponentType[UIComponentType["TEXTFIELD"] = 4] = "TEXTFIELD";
+    UIComponentType[UIComponentType["BUTTON"] = 5] = "BUTTON";
+    UIComponentType[UIComponentType["DATEPICKER"] = 6] = "DATEPICKER";
+})(UIComponentType || (exports.UIComponentType = UIComponentType = {}));

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

@@ -0,0 +1,4 @@
+export * from "./Form";
+export * from "./UIElements";
+export * from "./UIDefinitions";
+export * from "./UIElementBuilders";

package/dist/types/UI/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Form"), exports);
+__exportStar(require("./UIElements"), exports);
+__exportStar(require("./UIDefinitions"), exports);
+__exportStar(require("./UIElementBuilders"), exports);

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

@@ -0,0 +1,26 @@
+export type BaseItem = {
+    /**
+     * Title of content
+     */
+    title: string;
+    /**
+     * Base Cover/Thumbnail for content
+     */
+    cover: string;
+    /**
+     * Additional Covers Provided
+     */
+    additionalCovers?: string[];
+    /**
+     * Additional Info that may be displayed with this content
+     */
+    info?: string[];
+    /**
+     * Indicates that this title contains NSFW content
+     */
+    isNSFW?: boolean;
+    /**
+     * The URL of this title on the web
+     */
+    webUrl?: string;
+};

package/dist/types/content/BaseItem.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,3 @@
+export type BooleanState = {
+    state: boolean;
+};

package/dist/types/content/BooleanState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,62 @@
+import { Provider } from "../content/Provider";
+import { ChapterData } from "./ChapterData";
+export type Chapter = {
+    /**
+     * Identifier for this chapter in relation to the Content
+     */
+    chapterId: string;
+    /**
+     * The Chapters Number
+     */
+    number: number;
+    /**
+     * The index of this chapter in relation to all chapters of the content.
+     *
+     * The First Most Available Chapter Should Have an Index of 0
+     */
+    index: number;
+    /**
+     * URL At which the chapter is accessible on the web
+     */
+    webUrl?: string;
+    /**
+     * Date of Publication
+     */
+    date: Date;
+    /**
+     * Volume to which this chapter belongs
+     */
+    volume?: number;
+    /**
+     * Language Code of this chapter in ISO-6379
+     *
+     * Read More: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
+     */
+    language: string;
+    /**
+     * Title of chapter
+     */
+    title?: string;
+    /**
+     * Included {@link ChapterData}
+     */
+    data?: ChapterData;
+    /**
+     * The Chapters {@link Provider}'s
+     */
+    providers?: Provider[];
+    /**
+     * The Thumbnail Image of the Chapter
+     */
+    thumbnail?: string;
+};
+export declare enum DefinedLanguages {
+    UNIVERSAL = "UNIVERSAL",
+    ENGLISH = "en_US",
+    KOREAN = "ko_KR",
+    JAPANESE = "ja_JP",
+    FRENCH = "fr_FR",
+    CHINESE = "zh-CN",
+    SPANISH = "es_ES",
+    PORTUGUESE = "pt_BR"
+}

package/dist/types/content/Chapter.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DefinedLanguages = void 0;
+var DefinedLanguages;
+(function (DefinedLanguages) {
+    DefinedLanguages["UNIVERSAL"] = "UNIVERSAL";
+    DefinedLanguages["ENGLISH"] = "en_US";
+    DefinedLanguages["KOREAN"] = "ko_KR";
+    DefinedLanguages["JAPANESE"] = "ja_JP";
+    DefinedLanguages["FRENCH"] = "fr_FR";
+    DefinedLanguages["CHINESE"] = "zh-CN";
+    DefinedLanguages["SPANISH"] = "es_ES";
+    DefinedLanguages["PORTUGUESE"] = "pt_BR";
+})(DefinedLanguages || (exports.DefinedLanguages = DefinedLanguages = {}));

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

@@ -0,0 +1,16 @@
+export type ChapterPage = {
+    /**
+     * The URL of the Image
+     */
+    url?: string;
+    /**
+     * The Image Data in the form of a base64-encoded string
+     */
+    raw?: string;
+};
+export type ChapterData = {
+    /**
+     * The Pages of the chapter. This should be populated in standard Image Sources.
+     */
+    pages?: ChapterPage[];
+};

package/dist/types/content/ChapterData.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,24 @@
+import { DirectoryRequest } from "../directory";
+import { Highlight } from "./Highlight";
+export type HighlightCollection = {
+    /**
+     * The ID of the Collection
+     */
+    id: string;
+    /**
+     * The Title of the Collection
+     */
+    title: string;
+    /**
+     * The Subtitle of the Collection.
+     */
+    subtitle?: string;
+    /**
+     * The Highlights/Titles to be displayed within this collection
+     */
+    highlights: Highlight[];
+    /**
+     * The Directory Request to be made to view more results from this collection
+     */
+    request?: DirectoryRequest;
+};

package/dist/types/content/Collection.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,59 @@
+import { BaseItem } from "./BaseItem";
+import { Chapter } from "./Chapter";
+import { HighlightCollection } from "./Collection";
+import { PublicationStatus, ContentType, ReadingMode } from "./Enums";
+import { Property } from "./Property";
+export type Content = BaseItem & {
+    /**
+     * The Publication Status of Content
+     *
+     * 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
+     */
+    summary?: string;
+    /**
+     * Other Names of the Publication
+     */
+    additionalTitles?: string[];
+    /**
+     * Properties of the publication
+     */
+    properties?: Property[];
+    /**
+     * Content Type of the publication
+     *
+     * defaults to UNKNOWN if not defined
+     */
+    contentType?: ContentType;
+    /**
+     * The Reading Mode recommended by the source based on available data.
+     *
+     * defaults to PAGED_COMIC if not defined
+     */
+    recommendedPanelMode?: ReadingMode;
+    /**
+     * Additional Collections to display.
+     *
+     * Useful for display stuff like recommended Content
+     */
+    collections?: HighlightCollection[];
+    /**
+     * The Content's defined Tracking ID's.
+     */
+    trackerInfo?: Record<string, string>;
+    /**
+     * The content's chapters.
+     *
+     * 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.
+     */
+    chapters?: Chapter[];
+};

package/dist/types/content/Content.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,13 @@
+export type ContentProgressState = {
+    readChapterIds?: string[];
+    currentReadingState?: {
+        chapterId: string;
+        page: number;
+        progress: number;
+        readDate: Date;
+    };
+    markAllBelowAsRead?: {
+        chapterNumber: number;
+        chapterVolume?: number;
+    };
+};

package/dist/types/content/ContentProgressState.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,14 @@
+export type ContextMenuAction = {
+    id: string;
+    title: string;
+    systemImage?: string;
+    destructive?: boolean;
+    /**
+     * If enabled the action will be displayed basically as a grayed out text label
+     */
+    displayAsPlainLabel?: boolean;
+};
+export type ContextMenuGroup = {
+    id: string;
+    actions: ContextMenuAction[];
+};

package/dist/types/content/ContextMenu.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,8 @@
+import { PageLinkLabel } from "../page";
+import { Highlight } from "./Highlight";
+import { ReaderContext } from "./ReaderContext";
+export type DeepLinkContext = {
+    read?: ReaderContext;
+    content?: Highlight;
+    link?: PageLinkLabel;
+};

package/dist/types/content/DeepLinkContext.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,22 @@
+export declare enum PublicationStatus {
+    ONGOING = 1,
+    COMPLETED = 2,
+    CANCELLED = 3,
+    HIATUS = 4
+}
+/**
+ * The method in which the content can be read
+ */
+export declare enum ReadingMode {
+    PAGED_MANGA = 0,// Page 2 <---- Page 1
+    PAGED_COMIC = 1,// Page 1 ----> Page 2
+    PAGED_VERTICAL = 2,
+    WEBTOON = 3
+}
+export declare enum ContentType {
+    MANGA = 0,
+    MANHUA = 1,
+    MANHWA = 2,
+    COMIC = 3,
+    NOVEL = 4
+}

package/dist/types/content/Enums.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentType = exports.ReadingMode = exports.PublicationStatus = void 0;
+// Enums
+var PublicationStatus;
+(function (PublicationStatus) {
+    PublicationStatus[PublicationStatus["ONGOING"] = 1] = "ONGOING";
+    PublicationStatus[PublicationStatus["COMPLETED"] = 2] = "COMPLETED";
+    PublicationStatus[PublicationStatus["CANCELLED"] = 3] = "CANCELLED";
+    PublicationStatus[PublicationStatus["HIATUS"] = 4] = "HIATUS";
+})(PublicationStatus || (exports.PublicationStatus = PublicationStatus = {}));
+/**
+ * The method in which the content can be read
+ */
+var ReadingMode;
+(function (ReadingMode) {
+    ReadingMode[ReadingMode["PAGED_MANGA"] = 0] = "PAGED_MANGA";
+    ReadingMode[ReadingMode["PAGED_COMIC"] = 1] = "PAGED_COMIC";
+    ReadingMode[ReadingMode["PAGED_VERTICAL"] = 2] = "PAGED_VERTICAL";
+    ReadingMode[ReadingMode["WEBTOON"] = 3] = "WEBTOON";
+})(ReadingMode || (exports.ReadingMode = ReadingMode = {}));
+var ContentType;
+(function (ContentType) {
+    ContentType[ContentType["MANGA"] = 0] = "MANGA";
+    ContentType[ContentType["MANHUA"] = 1] = "MANHUA";
+    ContentType[ContentType["MANHWA"] = 2] = "MANHWA";
+    ContentType[ContentType["COMIC"] = 3] = "COMIC";
+    ContentType[ContentType["NOVEL"] = 4] = "NOVEL";
+})(ContentType || (exports.ContentType = ContentType = {}));

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

@@ -0,0 +1,7 @@
+export type GroupedUpdateItem = {
+    contentId: string;
+    updateCount: number;
+};
+export type GroupedUpdateResponse = {
+    updates: GroupedUpdateItem[];
+};

package/dist/types/content/GroupedUpdatesResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,36 @@
+import { ContextProvider } from "../core";
+import { Linkable } from "../page";
+import { TrackEntry } from "../tracker";
+import { BaseItem } from "./BaseItem";
+export type Highlight = BaseItem & ContextProvider & {
+    id: string;
+    /**
+     * The Subtitle of the tile
+     */
+    subtitle?: string;
+    /**
+     * Badge to be displayed with the tile
+     */
+    badge?: Badge;
+    /**
+     * Link Provided with this
+     */
+    link?: Linkable;
+    /**
+     * Marks this highlight as non interactive
+     */
+    noninteractive?: boolean;
+    /**
+     * The Tracker Entry of this Title
+     *
+     * NOTE: It will only be used on ContentTracker Pages & Directories
+     */
+    entry?: TrackEntry;
+};
+/**
+ * A Badge is added to a highlight tile
+ */
+export type Badge = {
+    count?: number;
+    color?: string;
+};

package/dist/types/content/Highlight.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,27 @@
+export type BaseInteractable = {
+    /**
+     * The ID of the Interactable Object
+     */
+    id: string;
+    /**
+     * The Label of the Interactable Object
+     */
+    title: string;
+};
+export type Property = BaseInteractable & {
+    /**
+     * The List of Tags available under this property.
+     */
+    tags: Tag[];
+};
+export type Tag = BaseInteractable & {
+    /**
+     * A boolean indicating the titles marked with this tag contain Adult Content
+     */
+    nsfw?: boolean;
+    /**
+     * The URL of an image to display with this tag
+     */
+    image?: string;
+    noninteractive?: boolean;
+};

package/dist/types/content/Property.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,32 @@
+export declare enum ProviderLinkType {
+    WEBSITE = 0,
+    TWITTER = 1,
+    DISCORD = 2,
+    PATREON = 3
+}
+export type ProviderLink = {
+    /**
+     * The URL of the Link
+     */
+    url: string;
+    /**
+     * The Type of Link.
+     *
+     * EG: The Providers Website, Twitter, Discord or Patreon
+     */
+    type: ProviderLinkType;
+};
+export type Provider = {
+    /**
+     * The ID of the Provider in relation to the Source
+     */
+    id: string;
+    /**
+     * The Name of the Provider
+     */
+    name: string;
+    /**
+     * Links the Provider can be interacted with at.
+     */
+    links?: ProviderLink[];
+};