@mana-app/types 0.0.18 → 0.0.19

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

@@ -1,5 +1,5 @@
 import { Content, Chapter, ChapterData, SourceInfo, AdditionalInfoSectionItem } from "../../types";
-import { DirectoryHandler, ManaSource } from "../Source";
+import { SearchProvider, ManaSource } from "../Source";
 export type SourceConfig = {
     /**
      * When `true`, Mana will disable being able to view more titles of a provided tags
@@ -30,7 +30,7 @@ interface SourceCore extends ManaSource {
     info: SourceInfo;
     config?: SourceConfig;
 }
-export interface ContentSource extends SourceCore, DirectoryHandler {
+export interface ContentSource extends SourceCore, SearchProvider {
     /**
      * Gets the titles information from the source
      */

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

@@ -1,5 +1,5 @@
-import { DirectoryHandler } from "..";
-export interface AdvancedTracker extends DirectoryHandler {
+import { SearchProvider } from "..";
+export interface AdvancedTracker extends SearchProvider {
     /**
      * This is called to get the info required to prepare a "profile page" for the title
      */

package/dist/sources/Source/extensions/SearchProvider.d.ts

@@ -0,0 +1,15 @@
+import { SearchRequest, PagedSearchResult, SortOption, SearchFilter } from "../../../types";
+export interface SearchProvider {
+    /**
+     * Fetches items/results for a directory request.
+     */
+    search(request: SearchRequest): Promise<PagedSearchResult>;
+    /**
+     * Fetches the available search filters for the source
+     */
+    getSearchFilters(): Promise<SearchFilter[]>;
+    /**
+     * Fetches the available sort options for the source
+     */
+    getSortOptions(): Promise<SortOption[]>;
+}

package/dist/sources/Source/extensions/SearchProvider.js

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

package/dist/sources/Source/extensions/index.d.ts

@@ -1,7 +1,7 @@
 export * from "./Authentication";
 export * from "./Preferences";
 export * from "./ImageRequest";
-export * from "./DirectoryHandler";
+export * from "./SearchProvider";
 export * from "./PageProvider";
 export * from "./Setup";
 export * from "./PageResolver";

package/dist/sources/Source/extensions/index.js

@@ -17,7 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Authentication"), exports);
 __exportStar(require("./Preferences"), exports);
 __exportStar(require("./ImageRequest"), exports);
-__exportStar(require("./DirectoryHandler"), exports);
+__exportStar(require("./SearchProvider"), exports);
 __exportStar(require("./PageProvider"), exports);
 __exportStar(require("./Setup"), exports);
 __exportStar(require("./PageResolver"), exports);

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

@@ -1,6 +1,6 @@
 export * from "./Authentication";
 export * from "./SourceInfo";
-export * from "./PagedResult";
+export * from "../search/PagedSearchResult";
 export * from "./ContextProvider";
 export type Option = {
     id: string;

package/dist/types/core/index.js

@@ -16,5 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Authentication"), exports);
 __exportStar(require("./SourceInfo"), exports);
-__exportStar(require("./PagedResult"), exports);
+__exportStar(require("../search/PagedSearchResult"), exports);
 __exportStar(require("./ContextProvider"), exports);

package/dist/types/index.d.ts

@@ -3,7 +3,7 @@ export * from "./content";
 export * from "./networking";
 export * from "./UI";
 export * from "./tracker";
-export * from "./directory";
+export * from "./search";
 export * from "./page";
 export type Only<T, U> = {
     [P in keyof T]: T[P];

package/dist/types/index.js

@@ -20,7 +20,7 @@ __exportStar(require("./content"), exports);
 __exportStar(require("./networking"), exports);
 __exportStar(require("./UI"), exports);
 __exportStar(require("./tracker"), exports);
-__exportStar(require("./directory"), exports);
+__exportStar(require("./search"), exports);
 __exportStar(require("./page"), exports);
 const Generate = (v) => v;
 exports.Generate = Generate;

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

@@ -1,5 +1,5 @@
 import { Badge, ContextProvider, Either, Highlight } from "..";
-import { DirectoryRequest } from "../directory";
+import { SearchRequest } from "../search";
 /**
  * This object defines what page suwatte links to
  *
@@ -8,7 +8,7 @@ import { DirectoryRequest } from "../directory";
 export type Linkable = Either<{
     page: PageLink;
 }, {
-    request: DirectoryRequest;
+    request: SearchRequest;
 }>;
 export type PageLink = ContextProvider & {
     id: "home" | string;

package/dist/types/search/PagedSearchResult.d.ts

@@ -0,0 +1,17 @@
+import { Highlight } from "../content";
+export type PagedSearchResult = {
+    /**
+     * 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/search/PagedSearchResult.js

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

package/dist/types/search/SearchFilter.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 SearchFilter = {
+    /**
+     * 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/search/SearchFilter.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/search/SearchRequest.d.ts

@@ -0,0 +1,26 @@
+import { ContextProvider } from "../core";
+import { ExcludableMultiSelectProp } from "./SearchFilter";
+export type FilterPrimitives = string | string[] | boolean | number | ExcludableMultiSelectProp;
+export type SearchRequest<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;
+};
+export type SortSelection = {
+    id: string;
+    ascending?: boolean;
+};

package/dist/types/search/SearchRequest.js

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

package/dist/types/search/SortOption.d.ts

@@ -0,0 +1,11 @@
+import { Option } from "../core";
+export type SortOption = Option & {
+    /**
+     * If true, this option will be selected by default
+     */
+    isDefault?: boolean;
+    /**
+     * If true, the sort order can be toggled between ascending and descending
+     */
+    isOrderable?: boolean;
+};

package/dist/types/search/SortOption.js

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

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

@@ -0,0 +1,3 @@
+export * from "./SearchRequest";
+export * from "./SearchFilter";
+export * from "./SortOption";

package/dist/types/search/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("./SearchRequest"), exports);
+__exportStar(require("./SearchFilter"), exports);
+__exportStar(require("./SortOption"), exports);

package/package.json

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