@coworkee/airworks 0.0.1026 → 0.0.1028

package/dist/coworkee.js

@@ -2,6 +2,7 @@ import { apiRequest, applyTheme, createCoworkeeClient, createRealtime, realtimeE
 import { bffAuthProvider } from "./auth.js";
 import { toast } from "./dom.js";
 import { defaultMudExFrameUrl, defaultMudExUrl } from "./mudex.js";
+import { globalSearchProvider } from "./search.js";
 /** English of the MudBlazor keys the apps borrow; the API serves them only for other languages. */
 const mudTexts = {
     MudDataGridPager_InfoFormat: '{0}-{1} of {2}', MudTablePager_PreviousPage: 'Previous page', MudTablePager_NextPage: 'Next page', MudDataGrid_Loading: 'Loading...',
@@ -109,5 +110,8 @@ export async function useCoworkee(airWorks, options) {
     });
     if (user.isAuthenticated && user.userId)
         follow(coworkee, user.userId);
+    // the server's global search (users, files, reports, chats, the app's sets) in the search of the desktop
+    if (user.isAuthenticated)
+        airWorks.registerSearchProvider(globalSearchProvider(coworkee));
     return coworkee;
 }

package/dist/index.d.ts

@@ -20,6 +20,7 @@ export { reportDesignerApp, setPath } from './apps/report-designer.ts';
 export { createWidget, place, presets, resolveRange, widgetFilter } from './apps/report-model.ts';
 export { type LookupItem, type LookupSource } from './lookup.ts';
 export { aiSettingsApp, assistantApp } from './apps/assistant.ts';
+export { defaultSearchTarget, globalSearchProvider, toResults, type GlobalSearchHit, type SearchTarget } from './search.ts';
 export * from './apps/admin/index.ts';
 /** The apps of the library for every user: profile, settings, files with preview, data, chat, reports with their designer, assistant, notifications and the API documentation. */
 export declare const defaultApps: AppFactory[];

package/dist/index.js

@@ -29,6 +29,7 @@ export { reportDesignerApp, setPath } from "./apps/report-designer.js";
 export { createWidget, place, presets, resolveRange, widgetFilter } from "./apps/report-model.js";
 export {} from "./lookup.js";
 export { aiSettingsApp, assistantApp } from "./apps/assistant.js";
+export { defaultSearchTarget, globalSearchProvider, toResults } from "./search.js";
 export * from "./apps/admin/index.js";
 /** The apps of the library for every user: profile, settings, files with preview, data, chat, reports with their designer, assistant, notifications and the API documentation. */
 export const defaultApps = [profileApp, settingsApp, filesApp, filePreviewApp, dataApp, chatApp, reportsApp, reportApp, reportDesignerApp, assistantApp, notificationsApp, apiDocsApp];

package/dist/search.d.ts

@@ -0,0 +1,28 @@
+import type { Intent, SearchProvider, SearchResult } from '@fgilde/airworks';
+import type { Coworkee } from './coworkee.ts';
+/** A hit of GET /api/v1/search (GlobalSearchHit). */
+export type GlobalSearchHit = {
+    provider: string;
+    group: string;
+    title: string;
+    subtitle?: string | null;
+    url?: string | null;
+    entitySet?: string | null;
+    id?: string | null;
+    score: number;
+    thumbnail?: string | null;
+    icon?: string | null;
+};
+/** Which app opens a hit, with which intent; undefined leaves the hit out. */
+export type SearchTarget = (hit: GlobalSearchHit) => {
+    appId: string;
+    intent?: Intent;
+} | undefined;
+/** Reports, chats and files open their own app, records of OData sets the data app on their set. */
+export declare function defaultSearchTarget(hit: GlobalSearchHit): {
+    appId: string;
+    intent?: Intent;
+} | undefined;
+/** The server's global search in the AirWorks search, best hits first; register it with airWorks.registerSearchProvider. */
+export declare function globalSearchProvider(coworkee: Coworkee, target?: SearchTarget, limit?: number): SearchProvider;
+export declare const toResults: (hits: GlobalSearchHit[], target?: SearchTarget) => SearchResult[];

package/dist/search.js

@@ -0,0 +1,30 @@
+import { filePreviewAppId } from "./apps/file-preview.js";
+import { reportAppId } from "./apps/reports.js";
+/** Reports, chats and files open their own app, records of OData sets the data app on their set. */
+export function defaultSearchTarget(hit) {
+    if (hit.provider === 'reports' && hit.id)
+        return { appId: reportAppId, intent: { id: hit.id } };
+    if (hit.provider === 'chats' && hit.id)
+        return { appId: 'coworkee.chat', intent: { user: hit.id } };
+    if (hit.provider === 'files' && hit.id)
+        return { appId: filePreviewAppId, intent: { id: hit.id, name: hit.title, contentType: hit.subtitle ?? '' } };
+    if (hit.entitySet)
+        return { appId: 'coworkee.data', intent: { set: hit.entitySet } };
+    return undefined;
+}
+/** The server's global search in the AirWorks search, best hits first; register it with airWorks.registerSearchProvider. */
+export function globalSearchProvider(coworkee, target = defaultSearchTarget, limit = 5) {
+    return {
+        id: 'coworkee.global-search',
+        search: async (query, { signal }) => {
+            if (query.trim().length < 2)
+                return [];
+            const result = await coworkee.request(`/api/v1/search?${new URLSearchParams({ q: query, limit: String(limit) })}`, { signal });
+            return toResults(result.hits, target);
+        },
+    };
+}
+export const toResults = (hits, target = defaultSearchTarget) => hits.flatMap((hit) => {
+    const opens = target(hit);
+    return opens ? [{ title: hit.title, description: hit.subtitle ?? hit.group, appId: opens.appId, intent: opens.intent }] : [];
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coworkee/airworks",
-  "version": "0.0.1026",
+  "version": "0.0.1028",
   "description": "AirWorks web desktop for Coworkee apps: sign-in through the app's BFF, theme, texts, realtime and apps for settings, files, data, chat, reports, the assistant and the administration",
   "license": "MIT",
   "homepage": "https://fgilde.github.io/CoworkeeLib/web/airworks/",
@@ -39,7 +39,7 @@
     "test": "node --test \"test/**/*.test.ts\""
   },
   "dependencies": {
-    "@coworkee/client": "0.0.1026"
+    "@coworkee/client": "0.0.1028"
   },
   "peerDependencies": {
     "@fgilde/airworks": ">=0.4.0"