@mana-app/types 0.0.19 → 0.0.21

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

@@ -7,9 +7,9 @@ export interface SearchProvider {
     /**
      * Fetches the available search filters for the source
      */
-    getSearchFilters(): Promise<SearchFilter[]>;
+    getSearchFilters?(): Promise<SearchFilter[]>;
     /**
      * Fetches the available sort options for the source
      */
-    getSortOptions(): Promise<SortOption[]>;
+    getSortOptions?(): Promise<SortOption[]>;
 }

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

@@ -1,4 +1,4 @@
-import { ContextProvider } from "../core";
+import { ContextProvider, Pair } from "../core";
 import { Linkable } from "../page";
 import { TrackEntry } from "../tracker";
 import { BaseItem } from "./BaseItem";
@@ -12,7 +12,7 @@ export type Highlight = BaseItem & ContextProvider & {
     /**
      * Additional Info that may be displayed with this content
      */
-    info?: Record<string, string>;
+    info?: Pair[];
     /**
      * Badge to be displayed with the tile
      */

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

@@ -6,3 +6,7 @@ export type Option = {
     id: string;
     title: string;
 };
+export type Pair = {
+    key: string;
+    value: string;
+};

package/package.json

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

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

@@ -1,14 +0,0 @@
-import { DirectoryRequest, PagedResult, DirectoryConfig } from "../../../types";
-export interface DirectoryHandler {
-    /**
-     * Fetches items/results for a directory request.
-     */
-    getDirectory(request: DirectoryRequest): Promise<PagedResult>;
-    /**
-     * Fetches the required directory config for a request
-     *
-     * Mana will cache the response for each Configuration Key upon first resolution as the Configuration is not intended to be dynamic.
-     * @param configID The Configuration key defined by the pre-provided {@link DirectoryRequest}. Will be undefined or null to use the default configuration
-     */
-    getDirectoryConfig(configID?: string): Promise<DirectoryConfig>;
-}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/types/directory/index.js

@@ -1,19 +0,0 @@
-"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);