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

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,13 +1,19 @@
 {
   "name": "power-compass",
-  "version": "0.0.1-alpha.2",
+  "version": "0.0.1-alpha.4",
   "type": "module",
   "main": "./dist/power-compass.cjs.js",
   "module": "./dist/power-compass.es.js",
+  "types": "./dist/types.d.ts",
   "exports": {
     ".": {
       "import": "./dist/power-compass.es.js",
-      "require": "./dist/power-compass.cjs.js"
+      "require": "./dist/power-compass.cjs.js",
+      "types": "./dist/types.d.ts"
+    },
+    "./cjs": {
+      "require": "./dist/power-compass.cjs.js",
+      "types": "./dist/types.d.ts"
     }
   },
   "scripts": {
@@ -35,6 +41,7 @@
   "devDependencies": {
     "@powerhome/eslint-config": "0.3.0",
     "@testing-library/react-hooks": "^8.0.1",
+    "@types/lodash": "^4.17.23",
     "@types/react": "^19.2.9",
     "@typescript-eslint/eslint-plugin": "8.18.0",
     "@typescript-eslint/parser": "8.18.0",

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

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