@mana-app/types 0.0.1

package/dist/types/content/Provider.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProviderLinkType = void 0;
+var ProviderLinkType;
+(function (ProviderLinkType) {
+    ProviderLinkType[ProviderLinkType["WEBSITE"] = 0] = "WEBSITE";
+    ProviderLinkType[ProviderLinkType["TWITTER"] = 1] = "TWITTER";
+    ProviderLinkType[ProviderLinkType["DISCORD"] = 2] = "DISCORD";
+    ProviderLinkType[ProviderLinkType["PATREON"] = 3] = "PATREON";
+})(ProviderLinkType || (exports.ProviderLinkType = ProviderLinkType = {}));

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

@@ -0,0 +1,28 @@
+import { Chapter } from "./Chapter";
+import { ReadingMode } from "./Enums";
+import { Highlight } from "./Highlight";
+/**
+ * This is the context provided to the reader to treat a highlight as a comic
+ */
+export type ReaderContext = {
+    /**
+     * The content being read, NOTE that this must be provided and the contentID should match the contentID of the content being read not the chapter
+     */
+    content: Highlight;
+    /**
+     * This is the Chapter ID of the chapter to be opened
+     */
+    target: string;
+    /**
+     * The List of chapters available for this "Content"
+     */
+    chapters: Chapter[];
+    /**
+     * The page to open. The first page will return 1, second returns 2, etc
+     */
+    requestedPage?: number;
+    /**
+     * The Reading mode to open the reader to
+     */
+    readingMode?: ReadingMode;
+};

package/dist/types/content/ReaderContext.js

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

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

@@ -0,0 +1,14 @@
+export * from "./Content";
+export * from "./Highlight";
+export * from "./Chapter";
+export * from "./ChapterData";
+export * from "./Property";
+export * from "./Collection";
+export * from "./Provider";
+export * from "./Enums";
+export * from "./ReaderContext";
+export * from "./ContextMenu";
+export * from "./DeepLinkContext";
+export * from "./BooleanState";
+export * from "./ContentProgressState";
+export * from "./GroupedUpdatesResponse";

package/dist/types/content/index.js

@@ -0,0 +1,30 @@
+"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("./Content"), exports);
+__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);
+__exportStar(require("./ContextMenu"), exports);
+__exportStar(require("./DeepLinkContext"), exports);
+__exportStar(require("./BooleanState"), exports);
+__exportStar(require("./ContentProgressState"), exports);
+__exportStar(require("./GroupedUpdatesResponse"), exports);

package/dist/types/core/Authentication.d.ts

@@ -0,0 +1,48 @@
+export declare enum AuthMethod {
+    USERNAME_PW = 0,
+    EMAIL_PW = 1,
+    WEB = 2,
+    OAUTH = 3
+}
+export type User = {
+    /**
+     * The users handle
+     */
+    handle: string;
+    /**
+     * The Users's Display Name
+     */
+    displayName?: string;
+    /**
+     * The users Avatar / Profile Picture
+     */
+    avatar?: string;
+    /**
+     * The banner image of the profile
+     */
+    bannerImage?: string;
+    /**
+     * Additional Information about the user to be displayed
+     */
+    info?: string[];
+};
+export type UpSyncedContent = {
+    /**
+     * The ID of the Title to be synced
+     */
+    id: string;
+};
+export type DownSyncedContent = {
+    /**
+     * The ID of the content
+     */
+    id: string;
+    /**
+     * The Title of the content
+     */
+    title: string;
+    /**
+     * The Cover/Thumbnail URL of the Title Synced
+     */
+    cover: string;
+};

package/dist/types/core/Authentication.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthMethod = void 0;
+var AuthMethod;
+(function (AuthMethod) {
+    AuthMethod[AuthMethod["USERNAME_PW"] = 0] = "USERNAME_PW";
+    AuthMethod[AuthMethod["EMAIL_PW"] = 1] = "EMAIL_PW";
+    AuthMethod[AuthMethod["WEB"] = 2] = "WEB";
+    AuthMethod[AuthMethod["OAUTH"] = 3] = "OAUTH";
+})(AuthMethod || (exports.AuthMethod = AuthMethod = {}));

package/dist/types/core/ContextProvider.d.ts

@@ -0,0 +1,6 @@
+export type ContextProvider = {
+    /**
+     * For Objects that may be passed back to the Source, a context object is provided to be used to pass additional info back to the Source
+     */
+    context?: Record<string, any>;
+};

package/dist/types/core/ContextProvider.js

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

package/dist/types/core/PagedResult.d.ts

@@ -0,0 +1,17 @@
+import { Highlight } from "../content";
+export type PagedResult = {
+    /**
+     * The results on this page
+     */
+    results: Highlight[];
+    /**
+     * Boolean Indicating whether this is the last available page.
+     *
+     * If this value is true or the results count is 0, Suwatte will stop making subsequent pagination requests
+     */
+    isLastPage: boolean;
+    /**
+     * The Total Results Count
+     */
+    totalResultCount?: number;
+};

package/dist/types/core/PagedResult.js

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

package/dist/types/core/SourceInfo.d.ts

@@ -0,0 +1,81 @@
+export declare enum CatalogRating {
+    /**
+     * Catalog does not contain ANY SUGGESTIVE OR NSFW content
+     */
+    SAFE = 0,
+    /**
+     * Catalog may contain SUGGESTIVE OR NSFW content,
+     * Sources must hide NSFW content by default,
+     * users will be required to verify they are of age to view NSFW content
+     */
+    MIXED = 1,
+    /**
+     * Catalog contains MAINLY SUGGESTIVE OR NSFW content,
+     * users will be required to verify they are of age to view NSFW content
+     */
+    NSFW = 2
+}
+export interface SourceDeveloper {
+    readonly name: string;
+    readonly website?: string;
+    readonly github?: string;
+}
+export interface SourceBadge {
+    readonly label: string;
+    readonly textColor: string;
+    readonly backgroundColor: string;
+}
+export type SourceInfo = {
+    /**
+     * The ID of this Source. It should be unique.
+     *
+     * Sources with the same ID will be treated as the same.
+     */
+    readonly id: string;
+    /**
+     * The Name of this Source, Typically the name of the Source
+     */
+    readonly name: string;
+    /**
+     * The Description of this Source
+     */
+    readonly description?: string;
+    /**
+     * The Developers of this Source
+     */
+    readonly developers: SourceDeveloper[];
+    /**
+     * The Semantic Version of the Source
+     */
+    readonly version: string;
+    /**
+     * The general content rating of titles on this Source
+     */
+    readonly rating?: CatalogRating;
+    /**
+     * This Minimum App Version This Source Supports.
+     */
+    readonly minSupportedAppVersion?: string;
+    /**
+     * The filename of the sources cover image within the assets folder.
+     *
+     * You may also use urls pointing to an image here.
+     *
+     * Example with source named JollyComics
+     * * With jc.png file within the assets folder will have `thumbnail` set to `jc.png`
+     * * Alternatively if JollyComics has an icon image at `https://jollycomics.com/thumbnail.png`, you can set `thumbnail` to the specified URL.
+     */
+    readonly thumbnail?: string;
+    /**
+     * The Websites URL
+     */
+    readonly website?: string;
+    /**
+     * List of languages codes this source has chapters in ISO-631 Format
+     */
+    readonly supportedLanguages?: string[];
+    /**
+     * List of badges this source has
+     */
+    readonly badges?: SourceBadge[];
+};

package/dist/types/core/SourceInfo.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CatalogRating = void 0;
+var CatalogRating;
+(function (CatalogRating) {
+    /**
+     * Catalog does not contain ANY SUGGESTIVE OR NSFW content
+     */
+    CatalogRating[CatalogRating["SAFE"] = 0] = "SAFE";
+    /**
+     * Catalog may contain SUGGESTIVE OR NSFW content,
+     * Sources must hide NSFW content by default,
+     * users will be required to verify they are of age to view NSFW content
+     */
+    CatalogRating[CatalogRating["MIXED"] = 1] = "MIXED";
+    /**
+     * Catalog contains MAINLY SUGGESTIVE OR NSFW content,
+     * users will be required to verify they are of age to view NSFW content
+     */
+    CatalogRating[CatalogRating["NSFW"] = 2] = "NSFW";
+})(CatalogRating || (exports.CatalogRating = CatalogRating = {}));

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

@@ -0,0 +1,8 @@
+export * from "./Authentication";
+export * from "./SourceInfo";
+export * from "./PagedResult";
+export * from "./ContextProvider";
+export type Option = {
+    id: string;
+    title: string;
+};

package/dist/types/core/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("./Authentication"), exports);
+__exportStar(require("./SourceInfo"), exports);
+__exportStar(require("./PagedResult"), exports);
+__exportStar(require("./ContextProvider"), exports);

package/dist/types/directory/DirectoryConfig.d.ts

@@ -0,0 +1,31 @@
+import { Option } from "../core";
+import { DirectoryFilter } from "./DirectoryFilter";
+import { SortSelection } from "./DirectoryRequest";
+export type DirectoryConfig = {
+    /**
+     * Filters available
+     */
+    filters?: DirectoryFilter[];
+    /**
+     * Sort Options
+     */
+    sort?: {
+        /**
+         * Options Available
+         */
+        options: Option[];
+        default?: SortSelection;
+        /**
+         * Indicates whether the sort order can be configured as ascending or descending
+         */
+        canChangeOrder?: boolean;
+    };
+    /**
+     * Lists are similar to pages but are predefined.
+     */
+    lists?: Option[];
+    /**
+     * If set to true, suwatte will display the search bar. Defaults to true
+     */
+    searchable?: boolean;
+};

package/dist/types/directory/DirectoryConfig.js

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

package/dist/types/directory/DirectoryFilter.d.ts

@@ -0,0 +1,53 @@
+import { Option } from "../core";
+export declare enum FilterType {
+    /**
+     * This Represents the filter as a toggle switch, the value returned in the directory request will be a `boolean`
+     */
+    TOGGLE = 0,
+    /**
+     * This represents the filter as a picker, the value returned will be the `key` of the selected option as a `string`
+     */
+    SELECT = 1,
+    /**
+     * This Represents the filter as a multi-picker, the value returned will the the keys of the selected options as an array of strings
+     */
+    MULTISELECT = 2,
+    /**
+     * This Represents the filter as a multi-picker,the value returned will be of type {@link ExcludableMultiSelectProp}
+     */
+    EXCLUDABLE_MULTISELECT = 3,
+    /**
+     * This will represent the filter as a textfield, the value returned will be a string
+     */
+    TEXT = 4,
+    /**
+     * This is a basic filter that will only display the title or subtitle, it will not return any value in the populated `DirectoryRequest`
+     */
+    INFO = 5
+}
+export type DirectoryFilter = {
+    /**
+     * The ID of the filter
+     */
+    id: string;
+    /**
+     * The Title of the Filter
+     */
+    title: string;
+    /**
+     * The subtitle of the filter
+     */
+    subtitle?: string;
+    /**
+     * The Filter Type
+     */
+    type: FilterType;
+    /**
+     * The Filter's Options if the filter type is SELECT,MULTISELECT,EXCLUDABLE_SELECT
+     */
+    options?: Option[];
+};
+export type ExcludableMultiSelectProp = {
+    included: string[];
+    excluded: string[];
+};

package/dist/types/directory/DirectoryFilter.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilterType = void 0;
+var FilterType;
+(function (FilterType) {
+    /**
+     * This Represents the filter as a toggle switch, the value returned in the directory request will be a `boolean`
+     */
+    FilterType[FilterType["TOGGLE"] = 0] = "TOGGLE";
+    /**
+     * This represents the filter as a picker, the value returned will be the `key` of the selected option as a `string`
+     */
+    FilterType[FilterType["SELECT"] = 1] = "SELECT";
+    /**
+     * This Represents the filter as a multi-picker, the value returned will the the keys of the selected options as an array of strings
+     */
+    FilterType[FilterType["MULTISELECT"] = 2] = "MULTISELECT";
+    /**
+     * This Represents the filter as a multi-picker,the value returned will be of type {@link ExcludableMultiSelectProp}
+     */
+    FilterType[FilterType["EXCLUDABLE_MULTISELECT"] = 3] = "EXCLUDABLE_MULTISELECT";
+    /**
+     * This will represent the filter as a textfield, the value returned will be a string
+     */
+    FilterType[FilterType["TEXT"] = 4] = "TEXT";
+    /**
+     * This is a basic filter that will only display the title or subtitle, it will not return any value in the populated `DirectoryRequest`
+     */
+    FilterType[FilterType["INFO"] = 5] = "INFO";
+})(FilterType || (exports.FilterType = FilterType = {}));

package/dist/types/directory/DirectoryRequest.d.ts

@@ -0,0 +1,37 @@
+import { ContextProvider } from "../core";
+import { ExcludableMultiSelectProp } from "./DirectoryFilter";
+export type FilterPrimitives = string | string[] | boolean | number | ExcludableMultiSelectProp;
+export type DirectoryRequest<T extends Record<string, FilterPrimitives> = any> = ContextProvider & {
+    /**
+     * The Keywords the User would like to search
+     */
+    query?: string;
+    /**
+     * The Page Number of the current search
+     */
+    page: number;
+    listId?: string;
+    /**
+     * The User Selected Sort ID
+     */
+    sort?: SortSelection;
+    /**
+     * The populated filters with their mapped corresponding type
+     */
+    filters?: T;
+    /**
+     * When a user wants to view the entries in a single tag, this property will be populated with the tags identifier
+     */
+    tag?: {
+        tagId: string;
+        propertyId: string;
+    };
+    /**
+     * Define the Configuration Suwatte should pass
+     */
+    configID?: string;
+};
+export type SortSelection = {
+    id: string;
+    ascending?: boolean;
+};

package/dist/types/directory/DirectoryRequest.js

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

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

@@ -0,0 +1,3 @@
+export * from "./DirectoryConfig";
+export * from "./DirectoryRequest";
+export * from "./DirectoryFilter";

package/dist/types/directory/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("./DirectoryConfig"), exports);
+__exportStar(require("./DirectoryRequest"), exports);
+__exportStar(require("./DirectoryFilter"), exports);

package/dist/types/index.d.ts

@@ -0,0 +1,14 @@
+export * from "./core";
+export * from "./content";
+export * from "./networking";
+export * from "./UI";
+export * from "./tracker";
+export * from "./directory";
+export * from "./page";
+export type Only<T, U> = {
+    [P in keyof T]: T[P];
+} & {
+    [P in keyof U]?: never;
+};
+export type Either<T, U> = Only<T, U> | Only<U, T>;
+export declare const Generate: <T>(v: T) => T;

package/dist/types/index.js

@@ -0,0 +1,26 @@
+"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.Generate = void 0;
+__exportStar(require("./core"), exports);
+__exportStar(require("./content"), exports);
+__exportStar(require("./networking"), exports);
+__exportStar(require("./UI"), exports);
+__exportStar(require("./tracker"), exports);
+__exportStar(require("./directory"), exports);
+__exportStar(require("./page"), exports);
+const Generate = (v) => v;
+exports.Generate = Generate;

package/dist/types/networking/Builder.d.ts

@@ -0,0 +1,88 @@
+import { Cookie } from "./Request";
+import { NetworkRequestTransformer, NetworkResponseTransformer } from "./Transformer";
+/**
+ * NetworkClientBuilder is a builder class used for creating and configuring instances of NetworkClient.
+ * The builder allows you to configure various aspects of the NetworkClient, such as rate limits,
+ * request/response transformers (interceptors), headers, cookies, timeout, status validator, and more.
+ */
+export declare class NetworkClientBuilder {
+    private requestTransformers;
+    private responseTransformers;
+    private headers;
+    private cookies;
+    private timeout?;
+    private requestsPerSecond?;
+    private statusValidator?;
+    private maxRetries?;
+    /**
+     * Sets the rate limit for the NetworkClient.
+     *
+     * @param requests - The maximum number of requests to make per interval.
+     * @param interval - The length of the rate limiting interval in seconds.
+     * @returns The builder, to allow for method chaining.
+     */
+    setRateLimit(requests: number, interval: number): NetworkClientBuilder;
+    /**
+     * Adds a request interceptor to the NetworkClient.
+     *
+     * @param transformer - The interceptor to add. This should be a function that takes a request and modifies it in some way.
+     * @returns The builder, to allow for method chaining.
+     */
+    addRequestInterceptor(transformer: NetworkRequestTransformer): NetworkClientBuilder;
+    /**
+     * Adds a response interceptor to the NetworkClient.
+     *
+     * @param transformer - The interceptor to add. This should be a function that takes a response and modifies it in some way.
+     * @returns The builder, to allow for method chaining.
+     */
+    addResponseInterceptor(transformer: NetworkResponseTransformer): NetworkClientBuilder;
+    /**
+     * Sets the authorization token for the NetworkClient.
+     *
+     * @param token - The token to be included in the Authorization header of every request.
+     * @returns The builder, to allow for method chaining.
+     */
+    setAuthorizationToken(token: string): NetworkClientBuilder;
+    /**
+     * Sets the status validator for the NetworkClient.
+     *
+     * @param validator - A function that takes a status code and returns true if it is considered successful.
+     * @returns The builder, to allow for method chaining.
+     */
+    setStatusValidator(validator: (s: number) => boolean): NetworkClientBuilder;
+    /**
+     * Sets the timeout for requests made by the NetworkClient.
+     *
+     * @param timeout - The maximum time to wait for a request to complete, in milliseconds.
+     * @returns The builder, to allow for method chaining.
+     */
+    setTimeout(timeout: number): NetworkClientBuilder;
+    /**
+     * Sets the maximum number of retries for this request by the NetworkClient.
+     *
+     * @param retries - The maximum number of retries for this request
+     * @returns The builder, to allow for method chaining.
+     */
+    setMaxRetries(retries: number): NetworkClientBuilder;
+    /**
+     * Sets a header for the NetworkClient.
+     *
+     * @param key - The name of the header
+     * @param value - The value of the header
+     * @returns The builder, to allow for method chaining.
+     */
+    addHeader(key: string, value: string): NetworkClientBuilder;
+    /**
+     * Sets a cookie for the NetworkClient.
+     *
+     * @param cookie - The cookie to be included in every request.
+     * @returns The builder, to allow for method chaining.
+     */
+    addCookie(cookie: Cookie): NetworkClientBuilder;
+    /**
+     * Builds a NetworkClient using the parameters set on the builder.
+     *
+     * @returns A NetworkClient with the configured parameters.
+     */
+    build(): NetworkClient;
+}