@visma-swno/vsn-navigation 1.1.0-beta.2 → 1.1.0-beta.21

package/dist/assets/vsn-navigation.d.ts

@@ -1,43 +1,122 @@
-import { AppModules } from '../shared/types/index.ts';
 import { CSSResult } from 'lit';
-import { FeedbackConfig } from '../shared/types/index.ts';
-import { isTreeLeaf } from '../shared/types/index.ts';
-import { isTreeParent } from '../shared/types/index.ts';
-import { LanguageCode } from '../shared/types/index.ts';
 import { LitElement } from 'lit';
-import { ModuleItem } from '../shared/types/index.ts';
-import { NavigationMenu } from '../shared/types/index.ts';
-import { SearchConfig } from '../shared/types/index.ts';
 import { TemplateResult } from 'lit-html';
-import { TreeItem } from '../shared/types/index.ts';
-import { TreeLeaf } from '../shared/types/index.ts';
-import { TreeParent } from '../shared/types/index.ts';
-import { VsnAuth } from '../shared/types/index.ts';
-import { VsnNavigation } from '../shared/types/index.ts';
 
-export { AppModules }
+export declare type AppModules = {
+    /** Current module id (to be ignored from the list of modules) */
+    activeModuleId: string;
+    /** Current module label — shown before the modules list is asynchronously loaded */
+    activeModuleLabel: string;
+    /** Modules, or a loader for the modules */
+    modules: ModuleItem[] | (() => Promise<ModuleItem[]>);
+};
 
-export { FeedbackConfig }
+declare type BaseTreeItem = {
+    /** id of the item, unique */
+    id: string;
+    /** The label to show for that item, in the relevant language */
+    label: string;
+    /** Optional QA identifier rendered as a data-qa-id attribute on the nav item element */
+    'data-qa-id'?: string;
+};
 
-export { isTreeLeaf }
+export declare type ButtonClickedEvent = {
+    /** The clicked HTMLButtonElement. Can be used as an anchor to position popups. */
+    target: HTMLButtonElement;
+};
 
-export { isTreeParent }
+export declare type FeedbackConfig = {
+    workspaceId: string;
+    surveyId: string;
+};
 
-export { LanguageCode }
+export declare function isTreeLeaf(item: TreeItem): item is TreeLeaf;
 
-export { ModuleItem }
+export declare function isTreeParent(item: TreeItem): item is TreeParent;
 
-export { NavigationMenu }
+/** Supported languages. Note: 'nb' and 'nn' are automatically mapped to 'no'. Non-supported languages will default to 'en' */
+export declare type LanguageCode = 'en' | 'no' | 'nb' | 'nn' | 'sv' | 'nl' | 'fi' | 'da';
 
-export { SearchConfig }
+export declare type ModuleItem = {
+    id: string;
+    label: string;
+    url: string;
+};
 
-export { TreeItem }
+/** Configuration for the navigation menu (pages in current module) */
+export declare type NavigationMenu = {
+    /** The list of items to show in the side menu and the breadcrumbs. Applications can
+     update it at any time, e.g. when the context changes, when the language changes */
+    items: TreeItem[];
+    /** the item id corresponding to the current page. When it's found in items,
+     the breadcrumbs will update to reflect the path to the item and side menu will
+     expand and select that item. When it's not found in items, breadcrumbs will show
+     nothing and the side menu will have no element selected */
+    currentItem: string;
+    /** Sidebar search config; default disabled when undefined */
+    search?: SearchConfig;
+};
 
-export { TreeLeaf }
+declare type NonEmptyArray<T> = [T, ...T[]];
 
-export { TreeParent }
+export declare type SearchConfig = {
+    enabled: boolean;
+    shortcut?: string;
+    extraDataSets?: SearchDataSetConfig[];
+};
 
-export { VsnAuth }
+export declare type SearchDataSetConfig = {
+    /** Stable unique identifier for the dataset, used for selection and lookup */
+    id: string;
+    /** User-facing label for display purposes */
+    label: string;
+    searchFunction: (query: SearchQuery) => Promise<SearchResult>;
+};
+
+export declare class SearchError extends Error {
+    constructor(message: string);
+}
+
+export declare type SearchQuery = {
+    abortController: AbortController;
+    query: string;
+    cursor?: string;
+};
+
+export declare type SearchResult = {
+    nextCursor?: string;
+    results: SearchResultItem[];
+};
+
+export declare type SearchResultItem = {
+    id: string;
+    label: string;
+    url: string;
+    lines?: [string] | [string, string];
+};
+
+export declare type TreeItem = TreeParent | TreeLeaf;
+
+export declare type TreeLeaf = BaseTreeItem & {
+    url: string;
+};
+
+export declare type TreeParent = BaseTreeItem & {
+    items: NonEmptyArray<TreeItem>;
+};
+
+declare type User = {
+    userId: string;
+    clientId?: string;
+    userName: string;
+    userEmail: string;
+};
+
+export declare type VsnAuth = {
+    user: User;
+    profilePictureBaseUrl: string;
+    myProfileUrl: string;
+};
 
 export declare class VSNNavigation extends LitElement {
     /** Language to use for the component's labels (Search, Log out, etc) */
@@ -78,6 +157,27 @@ export declare class VSNNavigation extends LitElement {
     render(): TemplateResult<1>;
 }
 
-export { VsnNavigation }
+export declare type VsnNavigation = {
+    /** Language to use for the component's labels (Search, Log out, etc) */
+    lang?: LanguageCode;
+    /** Link to landing page */
+    landingPageUrl?: string;
+    /** Configuration for the navigation menu (pages in current module) */
+    tree?: NavigationMenu;
+    /** Configuration for the module switcher */
+    modules?: AppModules;
+    /** Show help icon */
+    showHelp?: boolean;
+    /** Use a fixed url for link to help */
+    helpUrl?: string;
+    /** Show notification icon */
+    showNotification?: boolean;
+    /** Notification icon shows active state */
+    notificationActive?: boolean;
+    /** Configuration related to authenticated user */
+    auth?: VsnAuth;
+    /** Configuration for the feedback component */
+    feedback?: FeedbackConfig | null;
+};
 
 export { }