@mana-app/types 0.0.1

package/dist/types/networking/Builder.js

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetworkClientBuilder = void 0;
+/**
+ * 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.
+ */
+class NetworkClientBuilder {
+    constructor() {
+        // Array of functions that transform requests
+        this.requestTransformers = [];
+        // Array of functions that transform responses
+        this.responseTransformers = [];
+        // Object representing HTTP headers, where each key-value pair represents a header
+        this.headers = {};
+        // Array of cookies
+        this.cookies = [];
+    }
+    /**
+     * 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, interval) {
+        this.requestsPerSecond = requests / interval;
+        return this;
+    }
+    /**
+     * 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) {
+        this.requestTransformers.push(transformer);
+        return this;
+    }
+    /**
+     * 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) {
+        this.responseTransformers.push(transformer);
+        return this;
+    }
+    /**
+     * 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) {
+        return this.addHeader("Authorization", token);
+    }
+    /**
+     * 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) {
+        this.statusValidator = validator;
+        return this;
+    }
+    /**
+     * 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) {
+        this.timeout = timeout;
+        return this;
+    }
+    /**
+     * 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) {
+        this.maxRetries = retries;
+        return this;
+    }
+    /**
+     * 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, value) {
+        this.headers[key] = value;
+        return this;
+    }
+    /**
+     * 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) {
+        this.cookies.push(cookie);
+        return this;
+    }
+    /**
+     * Builds a NetworkClient using the parameters set on the builder.
+     *
+     * @returns A NetworkClient with the configured parameters.
+     */
+    build() {
+        return new NetworkClient(this);
+    }
+}
+exports.NetworkClientBuilder = NetworkClientBuilder;

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

@@ -0,0 +1,35 @@
+import { NetworkClientBuilder } from "./Builder";
+import { NetworkRequestConfig, NetworkRequest } from "./Request";
+import { NetworkResponse } from "./Response";
+declare global {
+    /**
+     * NetworkClient is responsible for making HTTP requests.
+     * It supports GET, POST, and custom requests.
+     */
+    class NetworkClient {
+        constructor(builder?: NetworkClientBuilder);
+        /**
+         * Makes a POST request to the specified URL.
+         *
+         * @param url - The URL to send the request to.
+         * @param config - Optional configuration for the request.
+         * @returns A Promise that resolves to the response.
+         */
+        post(url: string, config?: NetworkRequestConfig): Promise<NetworkResponse>;
+        /**
+         * Makes a GET request to the specified URL.
+         *
+         * @param url - The URL to send the request to.
+         * @param config - Optional configuration for the request.
+         * @returns A Promise that resolves to the response.
+         */
+        get(url: string, config?: NetworkRequestConfig): Promise<NetworkResponse>;
+        /**
+         * Makes a custom HTTP request.
+         *
+         * @param req - The details of the request to make.
+         * @returns A Promise that resolves to the response.
+         */
+        request(req: NetworkRequest): Promise<NetworkResponse>;
+    }
+}

package/dist/types/networking/Client.js

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

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

@@ -0,0 +1,13 @@
+import { NetworkRequest } from "./Request";
+import { NetworkResponse } from "./Response";
+declare global {
+    class NetworkError extends Error {
+        req: NetworkRequest;
+        res: NetworkResponse;
+        constructor(name: string, message: string, req: NetworkRequest, res: NetworkResponse);
+    }
+    class CloudflareError extends Error {
+        constructor(resolutionURL?: string);
+        resolutionURL?: string;
+    }
+}

package/dist/types/networking/Error.js

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

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

@@ -0,0 +1,62 @@
+import { NetworkRequestTransformer, NetworkResponseTransformer } from "./Transformer";
+type RequestMethod = "GET" | "DELETE" | "HEAD" | "OPTIONS" | "POST" | "PUT" | "PATCH" | "PURGE" | "LINK" | "UNLINK";
+type RequestHeaders = Record<string, string | number | boolean>;
+export type Cookie = {
+    name: string;
+    value: string;
+};
+export type BasicURL = {
+    url: string;
+    params?: Record<string, any>;
+};
+export type NetworkRequest = {
+    /** The URL where the request will be sent. */
+    url: string;
+    /**
+     * The HTTP method for the request. This is a string that can be one of several
+     * standard HTTP methods (like "GET", "POST", "PUT", etc.) or a custom method.
+     * When this property is not specified, it defaults to a GET request.
+     */
+    method?: RequestMethod | string;
+    /** An object representing any parameters to be included in the URL of the request. These will be formatted as query parameters. */
+    params?: Record<string, any>;
+    /**
+     * An object representing the body of the request. Depending on the Content-Type header,
+     * this can either be send as a JSON object (for application/json) or a URL-encoded string (for application/x-www-form-urlencoded).
+     */
+    body?: any;
+    /** An object representing any additional headers to be included in the request. */
+    headers?: RequestHeaders;
+    /** An array of cookies to be included in the request. */
+    cookies?: Cookie[];
+    /** The maximum time to wait for the request to complete, in milliseconds. If the request takes longer than this, it will be aborted. */
+    timeout?: number;
+    /** The maximum number of times to retry the request if it fails. After this many failures, the request will not be retried again. */
+    maxRetries?: number;
+    /**
+     * A function or array of functions that transform the request before it is sent.
+     * Each function takes a NetworkRequest and returns a transformed NetworkRequest.
+     */
+    transformRequest?: NetworkRequestTransformer | NetworkRequestTransformer[];
+    /**
+     * A function or array of functions that transform the response after it is received.
+     * Each function takes a NetworkResponse and returns a transformed NetworkResponse.
+     */
+    transformResponse?: NetworkResponseTransformer | NetworkResponseTransformer[];
+    /**
+     * A function that determines whether a given status code is considered successful.
+     * This function takes a status code as input and returns true if the status code is
+     * considered a success status, and false otherwise.
+     */
+    validateStatus?: (s: number) => boolean;
+};
+/**
+ * NetworkRequestConfig is a type that represents the configuration for a NetworkRequest. It's
+the same as NetworkRequest, but without the "url" and "method" properties. This is typically
+used when the URL and method are provided separately from the rest of the configuration. e.g the `NetworkClient.post` & `NetworkClient.get` methods
+ */
+export type NetworkRequestConfig = Omit<NetworkRequest, "url" | "method">;
+export declare const name: (base: RequestHeaders, known?: RequestHeaders) => Promise<{
+    [x: string]: string | number | boolean;
+}>;
+export {};

package/dist/types/networking/Request.js

@@ -0,0 +1,16 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.name = void 0;
+const name = (base, known) => __awaiter(void 0, void 0, void 0, function* () {
+    return Object.assign(Object.assign({}, base), known);
+});
+exports.name = name;

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

@@ -0,0 +1,7 @@
+import { NetworkRequest } from "./Request";
+export type NetworkResponse = {
+    data: string;
+    status: number;
+    headers: Record<string, any>;
+    request: NetworkRequest;
+};

package/dist/types/networking/Response.js

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

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

@@ -0,0 +1,5 @@
+import { NetworkRequest } from "./Request";
+import { NetworkResponse } from "./Response";
+export type Transformer<T> = (v: T) => Promise<T>;
+export type NetworkRequestTransformer = Transformer<NetworkRequest>;
+export type NetworkResponseTransformer = Transformer<NetworkResponse>;

package/dist/types/networking/Transformer.js

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

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

@@ -0,0 +1,6 @@
+export * from "./Builder";
+export * from "./Client";
+export * from "./Request";
+export * from "./Response";
+export * from "./Transformer";
+export * from "./Error";

package/dist/types/networking/index.js

@@ -0,0 +1,22 @@
+"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("./Builder"), exports);
+__exportStar(require("./Client"), exports);
+__exportStar(require("./Request"), exports);
+__exportStar(require("./Response"), exports);
+__exportStar(require("./Transformer"), exports);
+__exportStar(require("./Error"), exports);

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

@@ -0,0 +1,58 @@
+import { Badge, ContextProvider, Either, Highlight } from "..";
+import { DirectoryRequest } from "../directory";
+/**
+ * This object defines what page suwatte links to
+ *
+ * If DirectoryRequest is provided, A DirectoryView is presented, otherwise it navigates to another page
+ */
+export type Linkable = Either<{
+    page: PageLink;
+}, {
+    request: DirectoryRequest;
+}>;
+export type PageLink = ContextProvider & {
+    id: "home" | string;
+};
+export type PageLinkLabel = {
+    /**
+     * The label of this link
+     */
+    title: string;
+    subtitle?: string;
+    badge?: Badge;
+    /**
+     * When a link is being displayed in a page section,use this to set the thumbnail to appear
+     */
+    cover?: string;
+    /**
+     * The actual Link of the label, it should either be a PageLink pointing to a page to be navigated to OR a directory request to display a directory layout for
+     */
+    link: Linkable;
+};
+export declare enum SectionStyle {
+    DEFAULT = 0,
+    INFO = 1,
+    GALLERY = 2,
+    NAVIGATION_LIST = 3,
+    ITEM_LIST = 4,
+    PADDED_LIST = 5,
+    TAG = 6,
+    STANDARD_GRID = 7
+}
+/**
+ * This defines a section within the page, if the `items` property is populated, the `resolvePageSection` will not be called as the section is treated as resolved
+ */
+export type PageSection = {
+    id: string;
+    title: string;
+    subtitle?: string;
+    viewMoreLink?: Linkable;
+    items?: Highlight[];
+    style?: SectionStyle;
+};
+export type ResolvedPageSection = {
+    items: Highlight[];
+    viewMoreLink?: Linkable;
+    updatedTitle?: string;
+    updatedSubtitle?: string;
+};

package/dist/types/page/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SectionStyle = void 0;
+var SectionStyle;
+(function (SectionStyle) {
+    SectionStyle[SectionStyle["DEFAULT"] = 0] = "DEFAULT";
+    SectionStyle[SectionStyle["INFO"] = 1] = "INFO";
+    SectionStyle[SectionStyle["GALLERY"] = 2] = "GALLERY";
+    SectionStyle[SectionStyle["NAVIGATION_LIST"] = 3] = "NAVIGATION_LIST";
+    SectionStyle[SectionStyle["ITEM_LIST"] = 4] = "ITEM_LIST";
+    SectionStyle[SectionStyle["PADDED_LIST"] = 5] = "PADDED_LIST";
+    SectionStyle[SectionStyle["TAG"] = 6] = "TAG";
+    SectionStyle[SectionStyle["STANDARD_GRID"] = 7] = "STANDARD_GRID";
+})(SectionStyle || (exports.SectionStyle = SectionStyle = {}));

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

@@ -0,0 +1,43 @@
+import { Highlight, Property } from "../content";
+import { PublicationStatus } from "../content/Enums";
+export declare enum TrackStatus {
+    READING = "READING",
+    PLANNING = "PLANNING",
+    COMPLETED = "COMPLETED",
+    PAUSED = "PAUSED",
+    DROPPED = "DROPPED",
+    REREADING = "REREADING"
+}
+export type TrackProgress = {
+    lastReadChapter: number;
+    maxAvailableChapter?: number;
+    lastReadVolume?: number;
+};
+export type TrackProgressUpdate = {
+    chapter?: number;
+    volume?: number;
+};
+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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrackStatus = void 0;
+var TrackStatus;
+(function (TrackStatus) {
+    TrackStatus["READING"] = "READING";
+    TrackStatus["PLANNING"] = "PLANNING";
+    TrackStatus["COMPLETED"] = "COMPLETED";
+    TrackStatus["PAUSED"] = "PAUSED";
+    TrackStatus["DROPPED"] = "DROPPED";
+    TrackStatus["REREADING"] = "REREADING";
+})(TrackStatus || (exports.TrackStatus = TrackStatus = {}));

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@mana-app/types",
+  "version": "0.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "rm -rf ./dist && tsc",
+    "check:circular": "dpdm ."
+  },
+  "devDependencies": {
+    "@types/node": "^20.11.30",
+    "@typescript-eslint/eslint-plugin": "^7.3.1",
+    "dpdm": "^3.14.0",
+    "eslint": "^8.57.0",
+    "prettier": "^3.2.5",
+    "typescript": "^5.4.3"
+  },
+  "keywords": [
+    "mana"
+  ],
+  "author": {
+    "name": "Seyden",
+    "email": "saiifii@live.de",
+    "url": "https://github.com/Seyden"
+  },
+  "license": "MIT",
+  "description": "Types & Interfaces for Mana’s JavaScriptCore and WebKit environment.",
+  "files": [
+    "/dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Mana-iOS/types.git"
+  }
+}