power-compass 0.0.1-alpha.3 → 0.0.1-alpha.4

package/dist/components/context.d.ts

@@ -0,0 +1,6 @@
+export interface CompassContext {
+    backends?: string[];
+    params?: Record<string, string>;
+    contextId: string | number;
+}
+export declare const Compass: import('react').Context<CompassContext | undefined>;

package/dist/components/hooks/useCursor.d.ts

@@ -0,0 +1,11 @@
+import { default as React } from 'react';
+import { SearchResult, ResultEntry } from '../types';
+type Cursor = {
+    cursor?: ResultEntry<unknown>;
+    previous: () => void;
+    next: () => void;
+    resetCursor: () => void;
+    updateCursor: React.Dispatch<React.SetStateAction<ResultEntry<unknown> | undefined>>;
+};
+declare function useCursor(searchResult: SearchResult<unknown>[]): Cursor;
+export default useCursor;

package/dist/components/hooks/useDebounce.d.ts

@@ -0,0 +1,2 @@
+declare const useDebounce: (value: string, delay?: number) => string;
+export default useDebounce;

package/dist/components/hooks/useShortcut.d.ts

@@ -0,0 +1,2 @@
+declare const useShortcut: (shortcut: string, ref?: HTMLInputElement) => void;
+export default useShortcut;

package/dist/http/fetch.d.ts

@@ -0,0 +1 @@
+export declare function fetchBackend<T>(backend: string, contextId: string, service: string, query: ConstructorParameters<typeof URLSearchParams>[0]): Promise<T>;

package/dist/http/index.d.ts

@@ -0,0 +1 @@
+export * from './fetch';

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from './http';
+export * from './menu';
+export * from './tasks';
+export * from './search';
+export * from './components/context';

package/dist/menu/clientMenu.d.ts

@@ -0,0 +1,13 @@
+import { MenuItem, CompassMenuResult } from './types';
+export type FutureMenuItem = () => Promise<MenuItem>;
+export type FilterValue = true | false | undefined | string;
+export type PluginFilterKey = keyof typeof PluginFilters;
+export type PluginFilter = {
+    [Property in PluginFilterKey]?: FilterValue;
+};
+declare const PluginFilters: {
+    tagged(items: MenuItem[], tag: FilterValue): MenuItem[];
+};
+export declare function fetchPlugin(filters?: PluginFilter): Promise<CompassMenuResult>;
+export declare function createMenuItem(item: MenuItem | FutureMenuItem): Promise<void>;
+export {};

package/dist/menu/fetchMenu.d.ts

@@ -0,0 +1,6 @@
+import { MenuItem, CompassMenuResult } from './types';
+export type CompassMenuFilters = {
+    tagged?: string;
+};
+export declare function fetchMenu(backend: string, contextId: string, filters?: CompassMenuFilters): Promise<CompassMenuResult>;
+export declare function fetchMenus(backends: string[], contextId: string, filters?: CompassMenuFilters): Promise<MenuItem[]>;

package/dist/menu/fetchMenu.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/menu/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useCompassMenu';
+export { createMenuItem } from './clientMenu';

package/dist/menu/transformations.d.ts

@@ -0,0 +1,15 @@
+import { MenuItem } from './types';
+export type FlatMenuItem = Omit<MenuItem, "items"> & {
+    parent?: FlatMenuItem;
+};
+export type TransformedMenuItem<Option extends TransformOptions = TransformOptions> = Option["flatten"] extends true ? FlatMenuItem : MenuItem;
+export declare const Transformations: {
+    flatten(menuItems: MenuItem[], parent?: FlatMenuItem): FlatMenuItem[];
+    trim(menuItems: MenuItem[]): MenuItem[];
+};
+export type TransformOption = true | false | undefined;
+export type TransformOptionKey = keyof typeof Transformations;
+export type TransformOptions = {
+    [Property in TransformOptionKey]?: TransformOption;
+};
+export declare function applyTransformations(items: MenuItem[], options: TransformOptions): TransformedMenuItem[];

package/dist/menu/types.d.ts

@@ -0,0 +1,19 @@
+import { ComponentType } from 'react';
+export type MenuItem = {
+    badge?: number;
+    gravity?: number;
+    icon?: string;
+    items?: MenuItem[];
+    label: string;
+    meta?: Record<string, string>;
+    tags?: string[];
+    url?: string;
+    modal?: ComponentType;
+    onSelect?: () => void;
+};
+export type CompassMenuResult = {
+    items: MenuItem[];
+    error?: {
+        message: string;
+    };
+};

package/dist/menu/useCompassMenu.d.ts

@@ -0,0 +1,12 @@
+import { CompassMenuFilters } from './fetchMenu';
+import { CompassContext } from '../components/context';
+import { TransformOptions, TransformedMenuItem } from './transformations';
+type UseCompassMenuOptions = Partial<CompassContext> & TransformOptions & {
+    filters?: CompassMenuFilters;
+};
+type UseCompassMenu = {
+    items: TransformedMenuItem[];
+    loading: boolean;
+};
+export declare function useCompassMenu({ filters, backends: backendsOverride, contextId: contextIdOverride, ...options }: UseCompassMenuOptions): UseCompassMenu;
+export {};

package/dist/menu/useCompassMenu.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/search/createMenuSources.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/search/engine.d.ts

@@ -0,0 +1,14 @@
+import { SearchResult, SourceDefinition } from './types';
+/**
+ * Sorts matches by score.
+ * Sorts sources by best match's score and move them as per specified by their `insertSourceAtIndex` key.
+ *
+ * @param {*} sources all sources added to Spotnitro. See `app/javascript/packs/spotnitro.ts`
+ * @param {*} data GraphQL data
+ * @param {*} search user's input
+ * @see source-scores-spec.js
+ */
+export declare function sortSearchResults<T>(results: SearchResult<T>[]): SearchResult<T>[];
+type OnResultCallback = (result: SearchResult<unknown>) => void;
+export declare function search(value: string, sources: SourceDefinition<unknown>[], abortController?: AbortController, onResult?: OnResultCallback): Promise<SearchResult<unknown>[]>;
+export {};

package/dist/search/index.d.ts

@@ -0,0 +1 @@
+export * from './useSearch';

package/dist/search/source-scores.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/search/sources.d.ts

@@ -0,0 +1,9 @@
+import { SourceDefinition } from './types';
+export declare const sources: SourceDefinition<unknown>[];
+type SourceDefinitionCreation<T> = Omit<SourceDefinition<T>, "open" | "display"> & Partial<Pick<SourceDefinition<T>, "open" | "display">>;
+export declare function createCompassProviderSource(contextId: string | number | undefined, providerName: string, search: string, abortController?: AbortController): Promise<SourceDefinition<unknown> | null>;
+export declare function getCompassProviders(contextId: string | number, abortController?: AbortController): Promise<string[]>;
+export declare function createCompassSources(contextId: string | number | undefined, search: string, abortController?: AbortController): Promise<SourceDefinition<unknown>[]>;
+export declare function createMenuSources(backends: string[], contextId: string): SourceDefinition<unknown>[];
+export declare function createSource<T>(source: SourceDefinitionCreation<T>): void;
+export {};

package/dist/search/types.d.ts

@@ -0,0 +1,32 @@
+import { ComponentType } from 'react';
+export type SourceDefinition<T> = {
+    label?: string;
+    tag?: string;
+    searchOptions?: Record<string, unknown>;
+    newTab?: boolean;
+    insertSourceAtIndex?: number;
+    maxEntries?: number;
+    display: ComponentType<ResultEntry<T>> | DisplayProps<T>;
+    fetch: (arg0: string, options?: RequestInit) => Promise<T[]>;
+    open: (arg0: T) => string | Promise<string> | void;
+};
+export type ResultEntry<T> = {
+    item: T;
+    score: number;
+    source: SourceDefinition<T>;
+};
+export type SearchResult<T> = {
+    source: SourceDefinition<T>;
+    entries: ResultEntry<T>[];
+};
+export interface SearchItem {
+    html?: string;
+    label?: string;
+    tag?: string;
+    url?: string;
+}
+export type DisplayProps<T> = {
+    label: (arg0: T) => Promise<string> | string;
+    category: (arg0: T) => Promise<string> | string;
+    tag: (arg0: T) => Promise<string> | string;
+};

package/dist/search/useSearch.d.ts

@@ -0,0 +1,4 @@
+import { SearchResult } from './types';
+type UseSpotnitroReturn = [SearchResult<unknown>[], boolean, boolean];
+export declare function useSearch(value?: string): UseSpotnitroReturn;
+export {};

package/dist/tasks/index.d.ts

@@ -0,0 +1 @@
+export * from './useNotificationCenter';

package/dist/tasks/types.d.ts

@@ -0,0 +1,7 @@
+export type Notification = {
+    id: string;
+    createdAt: string;
+    title: string;
+    body: string;
+    url?: string;
+};

package/dist/tasks/useLocalStorage.d.ts

@@ -0,0 +1 @@
+export declare const useLocalStorage: <T>(key: string, initialValue: T) => any[];

package/dist/tasks/useNotificationCenter.d.ts

@@ -0,0 +1,11 @@
+import { Notification } from './types';
+interface Props {
+    contextId?: string | number;
+}
+interface UseNotificationCenterReturn {
+    notifications: Notification[];
+    loading: boolean;
+    error: Error | null;
+}
+export declare function useNotificationCenter({ contextId, }: Props): UseNotificationCenterReturn;
+export {};

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "power-compass",
-  "version": "0.0.1-alpha.3",
+  "version": "0.0.1-alpha.4",
   "type": "module",
   "main": "./dist/power-compass.cjs.js",
   "module": "./dist/power-compass.es.js",
-  "types": "./dist/power-compass.es.d.ts",
+  "types": "./dist/types.d.ts",
   "exports": {
     ".": {
       "import": "./dist/power-compass.es.js",
       "require": "./dist/power-compass.cjs.js",
-      "types": "./dist/power-compass.es.d.ts"
+      "types": "./dist/types.d.ts"
     },
     "./cjs": {
       "require": "./dist/power-compass.cjs.js",
-      "types": "./dist/power-compass.es.d.ts"
+      "types": "./dist/types.d.ts"
     }
   },
   "scripts": {

package/dist/power-compass.es.d.ts

@@ -1 +0,0 @@
-export {}