@mana-app/types 0.0.21 → 0.0.22

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) [2022] [Shedrach Uzoukwu]
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) [2022] [Shedrach Uzoukwu]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,8 +1,8 @@
-# mana-app/types
-
-mana-app/types definitions for building Mana JavaScript Sources.
-
-## Installation
-```bash
-npm i @mana-app/types
+# mana-app/types
+
+mana-app/types definitions for building Mana JavaScript Sources.
+
+## Installation
+```bash
+npm i @mana-app/types
 ```

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

@@ -1,10 +1,6 @@
 import { Content, Chapter, ChapterData, SourceInfo, AdditionalInfoSectionItem } from "../../types";
 import { SearchProvider, ManaSource } from "../Source";
 export type SourceConfig = {
-    /**
-     * When `true`, Mana will disable being able to view more titles of a provided tags
-     */
-    readonly disableTagNavigation?: boolean;
     /**
      * When `true`, Mana will not check for updates on this source
      */

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

@@ -2,6 +2,5 @@ export * from "./ContentEvent";
 export * from "./ChapterEvent";
 export * from "./ProgressSync";
 export * from "./LibrarySync";
-export * from "./ContextMenuHandler";
 export * from "./GroupedUpdateProvider";
 export * from "./ImageRedrawHandler";

package/dist/sources/ContentSource/handlers/index.js

@@ -18,6 +18,5 @@ __exportStar(require("./ContentEvent"), exports);
 __exportStar(require("./ChapterEvent"), exports);
 __exportStar(require("./ProgressSync"), exports);
 __exportStar(require("./LibrarySync"), exports);
-__exportStar(require("./ContextMenuHandler"), exports);
 __exportStar(require("./GroupedUpdateProvider"), exports);
 __exportStar(require("./ImageRedrawHandler"), exports);

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

@@ -1,4 +1,4 @@
-import { Form, Highlight, SourceInfo, TrackProgressUpdate, TrackStatus } from "../../types";
+import { Form, SourceInfo, TrackProgressUpdate, TrackStatus } from "../../types";
 import { ManaSource } from "../Source";
 export type TrackerConfig = {
     /**
@@ -21,21 +21,7 @@ export interface ContentTracker extends TrackerCore {
      * @param progress the updated reading progress
      */
     didUpdateLastReadChapter(id: string, progress: TrackProgressUpdate): Promise<void>;
-    /**
-     * Called when a user wants to link contents to your tracker.
-     * @param titles An array containing all the provided names of an entry.
-     */
-    getResultsForTitles(titles: string[]): Promise<Highlight[]>;
-    /**
-     * A tracker item with the current entry for a title
-     * @param id The ID of the title being queried
-     */
-    getTrackItem(id: string): Promise<Highlight>;
     didUpdateStatus(id: string, status: TrackStatus): Promise<void>;
-    /**
-     * Called when the user wants to start tracking a previously untracked entry
-     */
-    beginTracking(id: string, status: TrackStatus): Promise<void>;
     /**
      * Builds the form for updating the user's track state for a title
      */

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

@@ -1,15 +1,19 @@
-import { SearchRequest, PagedSearchResult, SortOption, SearchFilter } from "../../../types";
+import { SearchRequest, PagedSearchResult, SortOption, SearchForm, SearchFormSubmission, SearchFormValidationResult } from "../../../types";
 export interface SearchProvider {
     /**
-     * Fetches items/results for a directory request.
+     * Fetches items/results for a search request.
      */
     search(request: SearchRequest): Promise<PagedSearchResult>;
     /**
-     * Fetches the available search filters for the source
+     * Fetches the advanced search form for the source.
      */
-    getSearchFilters?(): Promise<SearchFilter[]>;
+    getSearchForm?(): Promise<SearchForm>;
     /**
      * Fetches the available sort options for the source
      */
     getSortOptions?(): Promise<SortOption[]>;
+    /**
+     * Validates the pending advanced search values before Mana applies them.
+     */
+    validateSearchForm?(form: SearchFormSubmission): Promise<SearchFormValidationResult>;
 }

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

@@ -1,5 +1,17 @@
-import { UIElement, UISection } from "./UIElements";
-export type FormSection = UISection<UIElement<any>>;
+import { UISection, UISectionType } from "./UIElements";
+import { UIButtonDefinition, UIDatePickerDefinition, UIExcludableMultiPickerDefinition, UIMultiPickerDefinition, UIPickerDefinition, UIStepperDefinition, UITextFieldDefinition, UIToggleDefinition } from "./UIDefinitions";
+export type UIListElement = UIPickerDefinition | UIMultiPickerDefinition | UIExcludableMultiPickerDefinition | UIToggleDefinition | UITextFieldDefinition | UIDatePickerDefinition | UIStepperDefinition | UIButtonDefinition;
+export type UITagSelectableElement = UIPickerDefinition | UIMultiPickerDefinition | UIExcludableMultiPickerDefinition;
+export type UIListSection = UISection<UIListElement> & {
+    type?: UISectionType.LIST;
+};
+export type UITagsSection = {
+    type: UISectionType.TAGS;
+    header?: string;
+    footer?: string;
+    field: UITagSelectableElement;
+};
+export type FormSection = UIListSection | UITagsSection;
 export type Form = {
     sections: FormSection[];
 };

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

@@ -1,10 +1,11 @@
-import { UIComponentType, UIElement, UIInteractable, UISelectable } from "./UIElements";
+import { UIComponentType, UIElement, UIInteractable, UISelectable, ExcludableMultiSelectValue } 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 UIExcludableMultiPickerDefinition = UIElement<UIComponentType.EXCLUDABLE_MULTISELECT> & UISelectable & UIInteractable<ExcludableMultiSelectValue>;
 export type UIToggleDefinition = UIElement<UIComponentType.TOGGLE> & UIInteractable<boolean>;
 export type UITextFieldOptions = {
     placeholder?: string;
@@ -26,4 +27,4 @@ export type UIButtonOptions = {
     systemImage?: string;
     action: () => Promise<void>;
 };
-export type UIButtonDefinition = UIElement<UIComponentType.BUTTON>;
+export type UIButtonDefinition = UIElement<UIComponentType.BUTTON> & UIButtonOptions;

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

@@ -1,9 +1,21 @@
-import { UIPickerDefinition, UIMultiPickerOptions, UIMultiPickerDefinition, UIToggleDefinition, UITextFieldOptions, UITextFieldDefinition, UIDatePickerDefinition, UIButtonOptions, UIButtonDefinition, UIStepperDefinition, UIStepperOptions } from "./UIDefinitions";
-import { UISelectable, UIInteractable, UISectionChild } from "./UIElements";
+import { UIPickerDefinition, UIMultiPickerOptions, UIMultiPickerDefinition, UIExcludableMultiPickerDefinition, UIToggleDefinition, UITextFieldOptions, UITextFieldDefinition, UIDatePickerDefinition, UIButtonOptions, UIButtonDefinition, UIStepperDefinition, UIStepperOptions } from "./UIDefinitions";
+import { ExcludableMultiSelectValue, UISelectable, UIInteractable, UISectionChild } from "./UIElements";
+import { UIListElement, UIListSection as UIListSectionDefinition, UITagSelectableElement, UITagsSection as UITagsSectionDefinition } from "./Form";
 export declare const UIPicker: (props: UISelectable & UIInteractable<string>) => UIPickerDefinition;
 export declare const UIMultiPicker: (props: UIMultiPickerOptions & UIInteractable<string[]>) => UIMultiPickerDefinition;
+export declare const UIExcludableMultiPicker: (props: UISelectable & UIInteractable<ExcludableMultiSelectValue>) => UIExcludableMultiPickerDefinition;
 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;
+export declare const UIListSection: (props: {
+    header?: string;
+    footer?: string;
+    children: UIListElement[];
+}) => UIListSectionDefinition;
+export declare const UITagsSection: (props: {
+    header?: string;
+    footer?: string;
+    field: UITagSelectableElement;
+}) => UITagsSectionDefinition;

package/dist/types/UI/UIElementBuilders.js

@@ -1,11 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UIStepper = exports.UIButton = exports.UIDatePicker = exports.UITextField = exports.UIToggle = exports.UIMultiPicker = exports.UIPicker = void 0;
+exports.UITagsSection = exports.UIListSection = exports.UIStepper = exports.UIButton = exports.UIDatePicker = exports.UITextField = exports.UIToggle = exports.UIExcludableMultiPicker = 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 UIExcludableMultiPicker = (props) => (Object.assign(Object.assign({}, props), { type: UIElements_1.UIComponentType.EXCLUDABLE_MULTISELECT }));
+exports.UIExcludableMultiPicker = UIExcludableMultiPicker;
 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 }));
@@ -16,3 +18,7 @@ const UIButton = (props) => (Object.assign(Object.assign({}, props), { type: UIE
 exports.UIButton = UIButton;
 const UIStepper = (props) => (Object.assign(Object.assign({}, props), { type: UIElements_1.UIComponentType.STEPPER }));
 exports.UIStepper = UIStepper;
+const UIListSection = (props) => (Object.assign(Object.assign({}, props), { type: UIElements_1.UISectionType.LIST }));
+exports.UIListSection = UIListSection;
+const UITagsSection = (props) => (Object.assign(Object.assign({}, props), { type: UIElements_1.UISectionType.TAGS }));
+exports.UITagsSection = UITagsSection;

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

@@ -4,10 +4,15 @@ export type UISectionChild = {
     title: string;
 };
 export type UISection<T extends UISectionChild> = {
+    type?: UISectionType.LIST;
     header?: string;
     footer?: string;
     children: T[];
 };
+export declare enum UISectionType {
+    LIST = 0,
+    TAGS = 1
+}
 export declare enum UIComponentType {
     SELECT = 0,
     MULTISELECT = 1,
@@ -15,9 +20,14 @@ export declare enum UIComponentType {
     TOGGLE = 3,
     TEXTFIELD = 4,
     BUTTON = 5,
-    DATEPICKER = 6
+    DATEPICKER = 6,
+    EXCLUDABLE_MULTISELECT = 7
 }
-export type Primitive = boolean | string | number | string[] | Date;
+export type ExcludableMultiSelectValue = {
+    included: string[];
+    excluded: string[];
+};
+export type Primitive = boolean | string | number | string[] | Date | ExcludableMultiSelectValue;
 export type UIElement<T extends UIComponentType> = UISectionChild & {
     type: T;
 };

package/dist/types/UI/UIElements.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UIComponentType = void 0;
+exports.UIComponentType = exports.UISectionType = void 0;
+var UISectionType;
+(function (UISectionType) {
+    UISectionType[UISectionType["LIST"] = 0] = "LIST";
+    UISectionType[UISectionType["TAGS"] = 1] = "TAGS";
+})(UISectionType || (exports.UISectionType = UISectionType = {}));
 var UIComponentType;
 (function (UIComponentType) {
     UIComponentType[UIComponentType["SELECT"] = 0] = "SELECT";
@@ -10,4 +15,5 @@ var UIComponentType;
     UIComponentType[UIComponentType["TEXTFIELD"] = 4] = "TEXTFIELD";
     UIComponentType[UIComponentType["BUTTON"] = 5] = "BUTTON";
     UIComponentType[UIComponentType["DATEPICKER"] = 6] = "DATEPICKER";
+    UIComponentType[UIComponentType["EXCLUDABLE_MULTISELECT"] = 7] = "EXCLUDABLE_MULTISELECT";
 })(UIComponentType || (exports.UIComponentType = UIComponentType = {}));

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

@@ -1,4 +1,4 @@
-export * from "./Form";
+export { Form, FormSection, UIListElement, UIListSection as UIListSectionDefinition, UITagSelectableElement, UITagsSection as UITagsSectionDefinition, } from "./Form";
 export * from "./UIElements";
 export * from "./UIDefinitions";
-export * from "./UIElementBuilders";
+export { UIButton, UIDatePicker, UIExcludableMultiPicker, UIListSection, UIMultiPicker, UIPicker, UIStepper, UITagsSection, UITextField, UIToggle, } from "./UIElementBuilders";

package/dist/types/UI/index.js

@@ -14,7 +14,17 @@ 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);
+exports.UIToggle = exports.UITextField = exports.UITagsSection = exports.UIStepper = exports.UIPicker = exports.UIMultiPicker = exports.UIListSection = exports.UIExcludableMultiPicker = exports.UIDatePicker = exports.UIButton = void 0;
 __exportStar(require("./UIElements"), exports);
 __exportStar(require("./UIDefinitions"), exports);
-__exportStar(require("./UIElementBuilders"), exports);
+var UIElementBuilders_1 = require("./UIElementBuilders");
+Object.defineProperty(exports, "UIButton", { enumerable: true, get: function () { return UIElementBuilders_1.UIButton; } });
+Object.defineProperty(exports, "UIDatePicker", { enumerable: true, get: function () { return UIElementBuilders_1.UIDatePicker; } });
+Object.defineProperty(exports, "UIExcludableMultiPicker", { enumerable: true, get: function () { return UIElementBuilders_1.UIExcludableMultiPicker; } });
+Object.defineProperty(exports, "UIListSection", { enumerable: true, get: function () { return UIElementBuilders_1.UIListSection; } });
+Object.defineProperty(exports, "UIMultiPicker", { enumerable: true, get: function () { return UIElementBuilders_1.UIMultiPicker; } });
+Object.defineProperty(exports, "UIPicker", { enumerable: true, get: function () { return UIElementBuilders_1.UIPicker; } });
+Object.defineProperty(exports, "UIStepper", { enumerable: true, get: function () { return UIElementBuilders_1.UIStepper; } });
+Object.defineProperty(exports, "UITagsSection", { enumerable: true, get: function () { return UIElementBuilders_1.UITagsSection; } });
+Object.defineProperty(exports, "UITextField", { enumerable: true, get: function () { return UIElementBuilders_1.UITextField; } });
+Object.defineProperty(exports, "UIToggle", { enumerable: true, get: function () { return UIElementBuilders_1.UIToggle; } });

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

@@ -1,8 +1,6 @@
 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/index.d.ts

@@ -5,8 +5,6 @@ export * from "./ChapterData";
 export * from "./Property";
 export * from "./Provider";
 export * from "./Enums";
-export * from "./ReaderContext";
-export * from "./ContextMenu";
 export * from "./DeepLinkContext";
 export * from "./BooleanState";
 export * from "./ContentProgressState";

package/dist/types/content/index.js

@@ -21,8 +21,6 @@ __exportStar(require("./ChapterData"), exports);
 __exportStar(require("./Property"), 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);

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

@@ -1,9 +1,9 @@
 import { Badge, ContextProvider, Either, Highlight } from "..";
 import { SearchRequest } from "../search";
 /**
- * This object defines what page suwatte links to
+ * This object defines what page Mana links to
  *
- * If DirectoryRequest is provided, A DirectoryView is presented, otherwise it navigates to another page
+ * If a SearchRequest is provided, a search view is presented; otherwise it navigates to another page.
  */
 export type Linkable = Either<{
     page: PageLink;
@@ -25,7 +25,7 @@ export type PageLinkLabel = {
      */
     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
+     * The actual link of the label. It should either be a PageLink pointing to a page to navigate to or a SearchRequest to display search results.
      */
     link: Linkable;
 };

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

@@ -7,7 +7,7 @@ export type PagedSearchResult = {
     /**
      * 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
+     * If this value is true or the results count is 0, Mana will stop making subsequent pagination requests
      */
     isLastPage: boolean;
     /**

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

@@ -1,53 +1,82 @@
 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`
+     * This represents the filter as a toggle switch; the value returned in the search 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`
+     * This represents the filter as a picker; the value returned in the search request will be the selected option.
      */
     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
+     * This represents the filter as a multi-picker; the value returned in the search request will be the selected options.
      */
     MULTISELECT = 2,
     /**
-     * This Represents the filter as a multi-picker,the value returned will be of type {@link ExcludableMultiSelectProp}
+     * This represents the filter as an include/exclude multi-picker; the value returned in the search request will contain included and excluded options.
      */
     EXCLUDABLE_MULTISELECT = 3,
     /**
-     * This will represent the filter as a textfield, the value returned will be a string
+     * This represents the filter as a text field; the value returned in the search request 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`
+     * This represents the filter as a numeric stepper; the value returned in the search request will be a number.
      */
-    INFO = 5
-}
-export type SearchFilter = {
+    STEPPER = 5,
     /**
-     * The ID of the filter
+     * This represents the filter as a date picker; the value returned in the search request will be an ISO-8601 string.
      */
+    DATEPICKER = 6
+}
+export type SearchFieldBase = {
     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 declare enum SearchPickerPresentation {
+    PAGE = "page",
+    PICKER = "picker"
+}
+export type SearchPickerField = SearchFieldBase & {
+    type: FilterType.SELECT;
+    options: Option[];
+    presentation?: SearchPickerPresentation;
+};
+export type SearchMultiPickerField = SearchFieldBase & {
+    type: FilterType.MULTISELECT;
+    options: Option[];
+};
+export type SearchExcludableMultiPickerField = SearchFieldBase & {
+    type: FilterType.EXCLUDABLE_MULTISELECT;
+    options: Option[];
+};
+export type SearchOptionField = SearchPickerField | SearchMultiPickerField | SearchExcludableMultiPickerField;
+export type SearchToggleField = SearchFieldBase & {
+    type: FilterType.TOGGLE;
+    options?: never;
+};
+export type SearchTextField = SearchFieldBase & {
+    type: FilterType.TEXT;
+    options?: never;
+    placeholder?: string;
+};
+export type SearchStepperField = SearchFieldBase & {
+    type: FilterType.STEPPER;
+    options?: never;
+    upperBound?: number;
+    lowerBound?: number;
+    allowDecimal?: true | "true";
+    step?: number;
+};
+export type SearchDatePickerField = SearchFieldBase & {
+    type: FilterType.DATEPICKER;
+    options?: never;
+};
+export type SearchListField = SearchOptionField | SearchToggleField | SearchTextField | SearchStepperField | SearchDatePickerField;
+export type SearchField = SearchListField;
+export type SearchFilter = SearchListField;
 export type ExcludableMultiSelectProp = {
-    included: string[];
-    excluded: string[];
+    included: Option[];
+    excluded: Option[];
 };

package/dist/types/search/SearchFilter.js

@@ -1,30 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FilterType = void 0;
+exports.SearchPickerPresentation = 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`
+     * This represents the filter as a toggle switch; the value returned in the search 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`
+     * This represents the filter as a picker; the value returned in the search request will be the selected option.
      */
     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
+     * This represents the filter as a multi-picker; the value returned in the search request will be the selected options.
      */
     FilterType[FilterType["MULTISELECT"] = 2] = "MULTISELECT";
     /**
-     * This Represents the filter as a multi-picker,the value returned will be of type {@link ExcludableMultiSelectProp}
+     * This represents the filter as an include/exclude multi-picker; the value returned in the search request will contain included and excluded options.
      */
     FilterType[FilterType["EXCLUDABLE_MULTISELECT"] = 3] = "EXCLUDABLE_MULTISELECT";
     /**
-     * This will represent the filter as a textfield, the value returned will be a string
+     * This represents the filter as a text field; the value returned in the search request 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`
+     * This represents the filter as a numeric stepper; the value returned in the search request will be a number.
      */
-    FilterType[FilterType["INFO"] = 5] = "INFO";
+    FilterType[FilterType["STEPPER"] = 5] = "STEPPER";
+    /**
+     * This represents the filter as a date picker; the value returned in the search request will be an ISO-8601 string.
+     */
+    FilterType[FilterType["DATEPICKER"] = 6] = "DATEPICKER";
 })(FilterType || (exports.FilterType = FilterType = {}));
+var SearchPickerPresentation;
+(function (SearchPickerPresentation) {
+    SearchPickerPresentation["PAGE"] = "page";
+    SearchPickerPresentation["PICKER"] = "picker";
+})(SearchPickerPresentation || (exports.SearchPickerPresentation = SearchPickerPresentation = {}));

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

@@ -0,0 +1,81 @@
+import { SortSelection, FilterPrimitives } from "./SearchRequest";
+import { SearchDatePickerField, SearchExcludableMultiPickerField, SearchFieldBase, SearchListField, SearchMultiPickerField, SearchOptionField, SearchPickerPresentation, SearchPickerField, SearchStepperField, SearchTextField as SearchTextFieldDefinition, SearchToggleField } from "./SearchFilter";
+export declare enum SearchSectionType {
+    LIST = 0,
+    TAGS = 1,
+    SORT = 2
+}
+export declare enum SearchSortStyle {
+    LIST = "list",
+    TAGS = "tags",
+    PICKER = "picker"
+}
+export type SearchListSection = {
+    type: SearchSectionType.LIST;
+    header?: string;
+    footer?: string;
+    children: SearchListField[];
+};
+export type SearchTagsSection = {
+    type: SearchSectionType.TAGS;
+    header?: string;
+    footer?: string;
+    field: SearchOptionField;
+};
+export type SearchSortSection = {
+    type: SearchSectionType.SORT;
+    header?: string;
+    footer?: string;
+    style?: SearchSortStyle;
+};
+export type SearchSection = SearchListSection | SearchTagsSection | SearchSortSection;
+export type SearchForm = {
+    sections: SearchSection[];
+};
+export type SearchFormSubmission<T extends Record<string, FilterPrimitives> = Record<string, FilterPrimitives>> = {
+    filters?: T;
+    sort?: SortSelection;
+};
+export type SearchFormValidationResult = {
+    valid: true;
+} | {
+    valid: false;
+    message: string;
+    fieldErrors?: Record<string, string>;
+};
+export declare const SearchPicker: (props: SearchFieldBase & {
+    options: SearchOptionField["options"];
+    presentation?: SearchPickerPresentation;
+}) => SearchPickerField;
+export declare const SearchMultiPicker: (props: SearchFieldBase & {
+    options: SearchOptionField["options"];
+}) => SearchMultiPickerField;
+export declare const SearchExcludableMultiPicker: (props: SearchFieldBase & {
+    options: SearchOptionField["options"];
+}) => SearchExcludableMultiPickerField;
+export declare const SearchToggle: (props: SearchFieldBase) => SearchToggleField;
+export declare const SearchTextField: (props: SearchFieldBase & {
+    placeholder?: string;
+}) => SearchTextFieldDefinition;
+export declare const SearchStepper: (props: SearchFieldBase & {
+    upperBound?: number;
+    lowerBound?: number;
+    allowDecimal?: true | "true";
+    step?: number;
+}) => SearchStepperField;
+export declare const SearchDatePicker: (props: SearchFieldBase) => SearchDatePickerField;
+export declare const SearchListSection: (props: {
+    header?: string;
+    footer?: string;
+    children: SearchListField[];
+}) => SearchListSection;
+export declare const SearchTagsSection: (props: {
+    header?: string;
+    footer?: string;
+    field: SearchOptionField;
+}) => SearchTagsSection;
+export declare const SearchSortSection: (props?: {
+    header?: string;
+    footer?: string;
+    style?: SearchSortStyle;
+}) => SearchSortSection;

package/dist/types/search/SearchForm.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SearchSortSection = exports.SearchTagsSection = exports.SearchListSection = exports.SearchDatePicker = exports.SearchStepper = exports.SearchTextField = exports.SearchToggle = exports.SearchExcludableMultiPicker = exports.SearchMultiPicker = exports.SearchPicker = exports.SearchSortStyle = exports.SearchSectionType = void 0;
+const SearchFilter_1 = require("./SearchFilter");
+var SearchSectionType;
+(function (SearchSectionType) {
+    SearchSectionType[SearchSectionType["LIST"] = 0] = "LIST";
+    SearchSectionType[SearchSectionType["TAGS"] = 1] = "TAGS";
+    SearchSectionType[SearchSectionType["SORT"] = 2] = "SORT";
+})(SearchSectionType || (exports.SearchSectionType = SearchSectionType = {}));
+var SearchSortStyle;
+(function (SearchSortStyle) {
+    SearchSortStyle["LIST"] = "list";
+    SearchSortStyle["TAGS"] = "tags";
+    SearchSortStyle["PICKER"] = "picker";
+})(SearchSortStyle || (exports.SearchSortStyle = SearchSortStyle = {}));
+const SearchPicker = (props) => (Object.assign(Object.assign({}, props), { type: SearchFilter_1.FilterType.SELECT }));
+exports.SearchPicker = SearchPicker;
+const SearchMultiPicker = (props) => (Object.assign(Object.assign({}, props), { type: SearchFilter_1.FilterType.MULTISELECT }));
+exports.SearchMultiPicker = SearchMultiPicker;
+const SearchExcludableMultiPicker = (props) => (Object.assign(Object.assign({}, props), { type: SearchFilter_1.FilterType.EXCLUDABLE_MULTISELECT }));
+exports.SearchExcludableMultiPicker = SearchExcludableMultiPicker;
+const SearchToggle = (props) => (Object.assign(Object.assign({}, props), { type: SearchFilter_1.FilterType.TOGGLE }));
+exports.SearchToggle = SearchToggle;
+const SearchTextField = (props) => (Object.assign(Object.assign({}, props), { type: SearchFilter_1.FilterType.TEXT }));
+exports.SearchTextField = SearchTextField;
+const SearchStepper = (props) => (Object.assign(Object.assign({}, props), { type: SearchFilter_1.FilterType.STEPPER }));
+exports.SearchStepper = SearchStepper;
+const SearchDatePicker = (props) => (Object.assign(Object.assign({}, props), { type: SearchFilter_1.FilterType.DATEPICKER }));
+exports.SearchDatePicker = SearchDatePicker;
+const SearchListSection = (props) => (Object.assign(Object.assign({}, props), { type: SearchSectionType.LIST }));
+exports.SearchListSection = SearchListSection;
+const SearchTagsSection = (props) => (Object.assign(Object.assign({}, props), { type: SearchSectionType.TAGS }));
+exports.SearchTagsSection = SearchTagsSection;
+const SearchSortSection = (props = {}) => (Object.assign(Object.assign({}, props), { type: SearchSectionType.SORT }));
+exports.SearchSortSection = SearchSortSection;

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

@@ -1,6 +1,6 @@
-import { ContextProvider } from "../core";
+import { ContextProvider, Option } from "../core";
 import { ExcludableMultiSelectProp } from "./SearchFilter";
-export type FilterPrimitives = string | string[] | boolean | number | ExcludableMultiSelectProp;
+export type FilterPrimitives = string | boolean | number | Option | Option[] | ExcludableMultiSelectProp;
 export type SearchRequest<T extends Record<string, FilterPrimitives> = any> = ContextProvider & {
     /**
      * The Keywords the User would like to search

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

@@ -1,3 +1,4 @@
 export * from "./SearchRequest";
-export * from "./SearchFilter";
+export { ExcludableMultiSelectProp, FilterType, SearchExcludableMultiPickerField, SearchField, SearchFieldBase, SearchFilter, SearchDatePickerField, SearchListField, SearchMultiPickerField, SearchOptionField, SearchPickerField, SearchPickerPresentation, SearchStepperField, SearchTextField as SearchTextFieldDefinition, SearchToggleField, } from "./SearchFilter";
 export * from "./SortOption";
+export { SearchDatePicker, SearchExcludableMultiPicker, SearchForm, SearchFormSubmission, SearchFormValidationResult, SearchListSection, SearchMultiPicker, SearchPicker, SearchSection, SearchSectionType, SearchSortSection, SearchSortStyle, SearchTagsSection, SearchStepper, SearchTextField, SearchToggle, } from "./SearchForm";

package/dist/types/search/index.js

@@ -14,6 +14,22 @@ 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.SearchToggle = exports.SearchTextField = exports.SearchStepper = exports.SearchTagsSection = exports.SearchSortStyle = exports.SearchSortSection = exports.SearchSectionType = exports.SearchPicker = exports.SearchMultiPicker = exports.SearchListSection = exports.SearchExcludableMultiPicker = exports.SearchDatePicker = exports.SearchPickerPresentation = exports.FilterType = void 0;
 __exportStar(require("./SearchRequest"), exports);
-__exportStar(require("./SearchFilter"), exports);
+var SearchFilter_1 = require("./SearchFilter");
+Object.defineProperty(exports, "FilterType", { enumerable: true, get: function () { return SearchFilter_1.FilterType; } });
+Object.defineProperty(exports, "SearchPickerPresentation", { enumerable: true, get: function () { return SearchFilter_1.SearchPickerPresentation; } });
 __exportStar(require("./SortOption"), exports);
+var SearchForm_1 = require("./SearchForm");
+Object.defineProperty(exports, "SearchDatePicker", { enumerable: true, get: function () { return SearchForm_1.SearchDatePicker; } });
+Object.defineProperty(exports, "SearchExcludableMultiPicker", { enumerable: true, get: function () { return SearchForm_1.SearchExcludableMultiPicker; } });
+Object.defineProperty(exports, "SearchListSection", { enumerable: true, get: function () { return SearchForm_1.SearchListSection; } });
+Object.defineProperty(exports, "SearchMultiPicker", { enumerable: true, get: function () { return SearchForm_1.SearchMultiPicker; } });
+Object.defineProperty(exports, "SearchPicker", { enumerable: true, get: function () { return SearchForm_1.SearchPicker; } });
+Object.defineProperty(exports, "SearchSectionType", { enumerable: true, get: function () { return SearchForm_1.SearchSectionType; } });
+Object.defineProperty(exports, "SearchSortSection", { enumerable: true, get: function () { return SearchForm_1.SearchSortSection; } });
+Object.defineProperty(exports, "SearchSortStyle", { enumerable: true, get: function () { return SearchForm_1.SearchSortStyle; } });
+Object.defineProperty(exports, "SearchTagsSection", { enumerable: true, get: function () { return SearchForm_1.SearchTagsSection; } });
+Object.defineProperty(exports, "SearchStepper", { enumerable: true, get: function () { return SearchForm_1.SearchStepper; } });
+Object.defineProperty(exports, "SearchTextField", { enumerable: true, get: function () { return SearchForm_1.SearchTextField; } });
+Object.defineProperty(exports, "SearchToggle", { enumerable: true, get: function () { return SearchForm_1.SearchToggle; } });

package/dist/types/tracker/index.js

@@ -1,6 +1,4 @@
 "use strict";
-/*import { Highlight, Property } from "../content";
-import { PublicationStatus } from "../content/Enums";*/
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TrackStatus = void 0;
 var TrackStatus;
@@ -12,20 +10,3 @@ 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.21",
+  "version": "0.0.22",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

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

@@ -1,14 +0,0 @@
-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

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