@fluid-topics/public-api 1.0.84-alpha → 1.0.86-alpha1

package/dist/mjs/preferences/unauthenticated-preferences.js

@@ -1,39 +1,61 @@
 const wnd = (typeof window === "undefined" ? globalThis : window);
-// function normalizeMetadataPreferences(metadata: any): Record<string, FtMetadataPreferenceConfiguration> {
-//     let normalized = {}
-//     for (let key in metadata) {
-//         let values = metadata[key]
-//         if (typeof values !== "object" || Array.isArray(values)) {
-//             values = {prior: values}
-//         }
-//         for (let property of ["prior", "filter"]) {
-//             values[property] = Array.isArray(values[property]) ? values[property] : [values[property]]
-//             values[property] = values[property]
-//                     .map((v: string) => v != null ? "" + v : "")
-//                     .filter((v: string) => v !== "")
-//         }
-//         normalized[key] = values
-//     }
-//     return normalized
-// }
+function normalizeMetadataPreferences(metadata) {
+    let normalized = {};
+    for (let key in metadata) {
+        let values = metadata[key];
+        if (typeof values !== "object" || Array.isArray(values)) {
+            values = { prior: values };
+        }
+        for (let property of ["prior", "filter"]) {
+            values[property] = Array.isArray(values[property]) ? values[property] : [values[property]];
+            values[property] = values[property]
+                .map(v => v != null ? "" + v : "")
+                .filter(v => v !== "");
+        }
+        normalized[key] = values;
+    }
+    return normalized;
+}
 function getStorageKey(tenantBaseUrl) {
     return `${tenantBaseUrl}-FluidTopicsUnauthenticatedUserSearchPreferences`;
 }
-export {};
-// export function addUnauthenticatedUserSearchPreferencesChangeHandler(tenantBaseUrl: string,
-//                                                                      handler: (newValue: FtSearchPreferencesConfiguration) => void): HandlerRegistration {
-//     if (wnd.localStorage) {
-//         const key = getStorageKey(tenantBaseUrl)
-//         const eventListener = (event: StorageEvent) => {
-//             if (event.storageArea === wnd.localStorage && event.key === key) {
-//                 handler(JSON.parse(event.newValue ?? "{}"))
-//             }
-//         }
-//         wnd.addEventListener("storage", eventListener)
-//         return {
-//             removeHandler: () => wnd.removeEventListener("storage", eventListener)
-//         }
-//     }
-//     console.error("Cannot handle unauthenticated preferences: local storage is unavailable.")
-//     return undefined
-// }
+export function setUnauthenticatedUserSearchPreferences(tenantBaseUrl, input) {
+    if (wnd.localStorage) {
+        let preferences = {
+            ...input,
+            metadata: normalizeMetadataPreferences(input.metadata ?? {})
+        };
+        const key = getStorageKey(tenantBaseUrl);
+        const newValue = JSON.stringify(preferences);
+        wnd.localStorage.setItem(key, newValue);
+        wnd.dispatchEvent(new StorageEvent("storage", {
+            key,
+            newValue,
+            storageArea: wnd.localStorage,
+            url: wnd.location.href
+        }));
+        return preferences;
+    }
+    console.error("Cannot set unauthenticated preferences: local storage is unavailable.");
+}
+export function getUnauthenticatedUserSearchPreferences(tenantBaseUrl) {
+    if (wnd.localStorage) {
+        return JSON.parse(wnd.localStorage.getItem(getStorageKey(tenantBaseUrl)) ?? "{}");
+    }
+    console.error("Cannot get unauthenticated preferences: local storage is unavailable.");
+}
+export function addUnauthenticatedUserSearchPreferencesChangeHandler(tenantBaseUrl, handler) {
+    if (wnd.localStorage) {
+        const key = getStorageKey(tenantBaseUrl);
+        const eventListener = (event) => {
+            if (event.storageArea === wnd.localStorage && event.key === key) {
+                handler(JSON.parse(event.newValue ?? "{}"));
+            }
+        };
+        wnd.addEventListener("storage", eventListener);
+        return {
+            removeHandler: () => wnd.removeEventListener("storage", eventListener)
+        };
+    }
+    console.error("Cannot handle unauthenticated preferences: local storage is unavailable.");
+}

package/dist/mjs/roles/roles.d.ts

@@ -1,2 +1,6 @@
 import { FtSession, FtUserProfile, FtUserRole, FtUserRoleKeys } from "../types/ft-common/public.js";
-export declare function userHasRole(sessionOrProfileOrRoles: FtSession | FtUserProfile | Array<FtUserRole | FtUserRoleKeys> | undefined, expectedRole: FtUserRole | FtUserRoleKeys): boolean;
+type SessionOrProfileOrRoles = FtSession | FtUserProfile | Array<FtUserRole | FtUserRoleKeys> | undefined | null;
+export declare function userHasRole(sessionOrProfileOrRoles: SessionOrProfileOrRoles, expectedRole: FtUserRole | FtUserRoleKeys): boolean;
+export declare function userHasAnyRole(sessionOrProfileOrRoles: SessionOrProfileOrRoles, ...expectedRoles: Array<FtUserRole | FtUserRoleKeys>): boolean;
+export declare function userHasAllRoles(sessionOrProfileOrRoles: SessionOrProfileOrRoles, ...expectedRoles: Array<FtUserRole | FtUserRoleKeys>): boolean;
+export {};

package/dist/mjs/roles/roles.js

@@ -6,10 +6,10 @@ const rolesInheritance = {
     [FtUserRole.KHUB_ADMIN]: [FtUserRole.CONTENT_PUBLISHER],
     [FtUserRole.ADMIN]: [FtUserRole.KHUB_ADMIN, FtUserRole.USERS_ADMIN, FtUserRole.PORTAL_ADMIN],
     [FtUserRole.DEVELOPER]: [FtUserRole.BETA_USER, FtUserRole.DEBUG_USER],
+    [FtUserRole.GENERATIVE_AI_EXPORT_USER]: [FtUserRole.GENERATIVE_AI_USER],
 };
 function roleMatches(actual, expected) {
-    return true;
-    // return actual === expected || (rolesInheritance[actual] ?? []).some((inherited: FtUserRole | FtUserRoleKeys) => roleMatches(inherited, expected))
+    return actual === expected || (rolesInheritance[actual] ?? []).some((inherited) => roleMatches(inherited, expected));
 }
 export function userHasRole(sessionOrProfileOrRoles, expectedRole) {
     if (sessionOrProfileOrRoles == null) {
@@ -24,3 +24,15 @@ export function userHasRole(sessionOrProfileOrRoles, expectedRole) {
                 : [];
     return roles.some(role => roleMatches(role, expectedRole));
 }
+export function userHasAnyRole(sessionOrProfileOrRoles, ...expectedRoles) {
+    if (sessionOrProfileOrRoles == null) {
+        return false;
+    }
+    return expectedRoles.some(role => userHasRole(sessionOrProfileOrRoles, role));
+}
+export function userHasAllRoles(sessionOrProfileOrRoles, ...expectedRoles) {
+    if (sessionOrProfileOrRoles == null) {
+        return false;
+    }
+    return expectedRoles.every(role => userHasRole(sessionOrProfileOrRoles, role));
+}

package/dist/mjs/types/ft-common/public.d.ts

@@ -24,6 +24,264 @@ export declare enum FtTopicOriginType {
 }
 export type FtTopicOriginTypeKeys = keyof typeof FtTopicOriginType;
 export declare const isFtTopicOriginType: (o: any) => o is FtTopicOriginType;
+export interface FtAnalyticsEventDisplay {
+    width: number;
+    height: number;
+}
+export declare const isFtAnalyticsEventDisplay: (o: any) => o is FtAnalyticsEventDisplay;
+export interface FtAnalyticsEventGenAIProfile {
+    customPrompt?: string;
+    name: string;
+    id: string;
+}
+export declare const isFtAnalyticsEventGenAIProfile: (o: any) => o is FtAnalyticsEventGenAIProfile;
+export interface FtAnalyticsEventLocation {
+    type: string;
+    value: string;
+}
+export declare const isFtAnalyticsEventLocation: (o: any) => o is FtAnalyticsEventLocation;
+export interface FtAnalyticsEventOrigin {
+    pageType: string;
+    type: string;
+    url: string;
+}
+export declare const isFtAnalyticsEventOrigin: (o: any) => o is FtAnalyticsEventOrigin;
+export interface FtAnalyticsEventPage {
+    name: string;
+    language?: string;
+    id: string;
+    type: string;
+    url: string;
+}
+export declare const isFtAnalyticsEventPage: (o: any) => o is FtAnalyticsEventPage;
+export interface FtAnalyticsEventPublication {
+    metadata?: Array<FtMetadata>;
+    id: string;
+    mimeType?: string;
+    title?: string;
+    type?: FtAnalyticsPublicationTypeKeys;
+    parentId?: string;
+}
+export declare const isFtAnalyticsEventPublication: (o: any) => o is FtAnalyticsEventPublication;
+export interface FtAnalyticsEventRating {
+    type: string;
+    value?: string;
+}
+export declare const isFtAnalyticsEventRating: (o: any) => o is FtAnalyticsEventRating;
+export interface FtAnalyticsEventSearchQuery {
+    terms: string;
+    searchType?: string;
+    lastUpdate?: string;
+    facets?: Array<FtAnalyticsSearchFacet>;
+}
+export declare const isFtAnalyticsEventSearchQuery: (o: any) => o is FtAnalyticsEventSearchQuery;
+export interface FtAnalyticsEventSearchResponse {
+    autocorrect?: boolean;
+    nbResults: number;
+}
+export declare const isFtAnalyticsEventSearchResponse: (o: any) => o is FtAnalyticsEventSearchResponse;
+export interface FtAnalyticsEventSearchResult {
+    document: FtAnalyticsEventPublication;
+    rank: number;
+    topic?: FtAnalyticsEventTopic;
+    type: string;
+}
+export declare const isFtAnalyticsEventSearchResult: (o: any) => o is FtAnalyticsEventSearchResult;
+export interface FtAnalyticsEventTopic {
+    mapTitle?: string;
+    metadata?: Array<FtMetadata>;
+    tocId: string;
+    mapId?: string;
+    title: string;
+}
+export declare const isFtAnalyticsEventTopic: (o: any) => o is FtAnalyticsEventTopic;
+export declare enum FtAnalyticsPublicationType {
+    STRUCTURED_DOCUMENT = "STRUCTURED_DOCUMENT",
+    UNSTRUCTURED_DOCUMENT = "UNSTRUCTURED_DOCUMENT",
+    SHARED_PERSONAL_BOOK = "SHARED_PERSONAL_BOOK",
+    PERSONAL_BOOK = "PERSONAL_BOOK",
+    MAP_ATTACHMENT = "MAP_ATTACHMENT",
+    RESOURCE = "RESOURCE"
+}
+export type FtAnalyticsPublicationTypeKeys = keyof typeof FtAnalyticsPublicationType;
+export declare const isFtAnalyticsPublicationType: (o: any) => o is FtAnalyticsPublicationType;
+export interface FtAnalyticsSearchFacet {
+    dateValue?: FtAnalyticsSearchDateFacetValueKeys;
+    values?: Array<string>;
+    from?: string;
+    to?: string;
+    type?: FtAnalyticsSearchFacetTypeKeys;
+    key: string;
+}
+export declare const isFtAnalyticsSearchFacet: (o: any) => o is FtAnalyticsSearchFacet;
+export declare enum FtAnalyticsSearchDateFacetValue {
+    LAST_WEEK = "LAST_WEEK",
+    LAST_MONTH = "LAST_MONTH",
+    LAST_QUARTER = "LAST_QUARTER",
+    LAST_YEAR = "LAST_YEAR"
+}
+export type FtAnalyticsSearchDateFacetValueKeys = keyof typeof FtAnalyticsSearchDateFacetValue;
+export declare const isFtAnalyticsSearchDateFacetValue: (o: any) => o is FtAnalyticsSearchDateFacetValue;
+export declare enum FtAnalyticsSearchFacetType {
+    VALUE = "VALUE",
+    DATE = "DATE",
+    RANGE = "RANGE"
+}
+export type FtAnalyticsSearchFacetTypeKeys = keyof typeof FtAnalyticsSearchFacetType;
+export declare const isFtAnalyticsSearchFacetType: (o: any) => o is FtAnalyticsSearchFacetType;
+export interface FtAnalyticsEvent {
+    offline: boolean;
+    appVersion: string;
+    appName: string;
+    name: FtAnalyticsEventNameKeys;
+    version: string;
+}
+export declare const isFtAnalyticsEvent: (o: any) => o is FtAnalyticsEvent;
+export declare enum FtAnalyticsEventName {
+    BOOKMARK__CREATE = "BOOKMARK__CREATE",
+    BOOKMARK__DELETE = "BOOKMARK__DELETE",
+    CASE_DEFLECTION__START = "CASE_DEFLECTION__START",
+    CASE_DEFLECTION__OPEN_TICKET = "CASE_DEFLECTION__OPEN_TICKET",
+    CASE_DEFLECTION__RATE = "CASE_DEFLECTION__RATE",
+    COLLECTION__CREATE = "COLLECTION__CREATE",
+    COLLECTION__UPDATE = "COLLECTION__UPDATE",
+    COLLECTION__DELETE = "COLLECTION__DELETE",
+    DOCUMENT__DISPLAY = "DOCUMENT__DISPLAY",
+    DOCUMENT__DOWNLOAD = "DOCUMENT__DOWNLOAD",
+    DOCUMENT__PRINT = "DOCUMENT__PRINT",
+    DOCUMENT__PROCESS = "DOCUMENT__PROCESS",
+    DOCUMENT__RATE = "DOCUMENT__RATE",
+    DOCUMENT__SEARCH = "DOCUMENT__SEARCH",
+    DOCUMENT__START_DISPLAY = "DOCUMENT__START_DISPLAY",
+    DOCUMENT__UNRATE = "DOCUMENT__UNRATE",
+    FEEDBACK__SEND = "FEEDBACK__SEND",
+    GEN_AI__COMPLETED_QUERY = "GEN_AI__COMPLETED_QUERY",
+    GEN_AI__RATE = "GEN_AI__RATE",
+    GENAI_CASE_DEFLECTION__START = "GENAI_CASE_DEFLECTION__START",
+    GENAI_CASE_DEFLECTION__OPEN_TICKET = "GENAI_CASE_DEFLECTION__OPEN_TICKET",
+    KHUB__PROCESS = "KHUB__PROCESS",
+    KHUB__SEARCH = "KHUB__SEARCH",
+    LABELS__DOWNLOAD = "LABELS__DOWNLOAD",
+    LINK__SHARE = "LINK__SHARE",
+    PAGE__DISPLAY = "PAGE__DISPLAY",
+    PERSONAL_BOOK__CREATE = "PERSONAL_BOOK__CREATE",
+    PERSONAL_BOOK__DELETE = "PERSONAL_BOOK__DELETE",
+    PERSONAL_BOOK__UPDATE = "PERSONAL_BOOK__UPDATE",
+    PERSONAL_TOPIC__CREATE = "PERSONAL_TOPIC__CREATE",
+    PERSONAL_TOPIC__UPDATE = "PERSONAL_TOPIC__UPDATE",
+    PERSONAL_TOPIC__DELETE = "PERSONAL_TOPIC__DELETE",
+    SAVED_SEARCH__CREATE = "SAVED_SEARCH__CREATE",
+    SAVED_SEARCH__DELETE = "SAVED_SEARCH__DELETE",
+    SAVED_SEARCH__UPDATE = "SAVED_SEARCH__UPDATE",
+    SEARCH_PAGE__SELECT = "SEARCH_PAGE__SELECT",
+    TOPIC__DISPLAY = "TOPIC__DISPLAY",
+    TOPIC__RATE = "TOPIC__RATE",
+    TOPIC__START_DISPLAY = "TOPIC__START_DISPLAY",
+    TOPIC__UNRATE = "TOPIC__UNRATE",
+    USER__LOGIN = "USER__LOGIN",
+    USER__LOGOUT = "USER__LOGOUT",
+    HEARTBEAT = "HEARTBEAT"
+}
+export type FtAnalyticsEventNameKeys = keyof typeof FtAnalyticsEventName;
+export declare const isFtAnalyticsEventName: (o: any) => o is FtAnalyticsEventName;
+export interface FtCaseDeflectionEvent extends FtAnalyticsEvent {
+    searchQuery?: FtAnalyticsEventSearchQuery;
+    context: string;
+    rating?: FtAnalyticsEventRating;
+    topic?: FtAnalyticsEventTopic;
+}
+export declare const isFtCaseDeflectionEvent: (o: any) => o is FtCaseDeflectionEvent;
+export interface FtDocumentDisplayEvent extends FtAnalyticsEvent {
+    publication: FtAnalyticsEventPublication;
+    viewDurationMs: number;
+    location: FtAnalyticsEventLocation;
+}
+export declare const isFtDocumentDisplayEvent: (o: any) => o is FtDocumentDisplayEvent;
+export interface FtDocumentDownloadEvent extends FtAnalyticsEvent {
+    document: FtAnalyticsEventPublication;
+    location: FtAnalyticsEventLocation;
+}
+export declare const isFtDocumentDownloadEvent: (o: any) => o is FtDocumentDownloadEvent;
+export interface FtDocumentPrintEvent extends FtAnalyticsEvent {
+    publication: FtAnalyticsEventPublication;
+}
+export declare const isFtDocumentPrintEvent: (o: any) => o is FtDocumentPrintEvent;
+export interface FtDocumentSearchEvent extends FtAnalyticsEvent {
+    searchResponse: FtAnalyticsEventSearchResponse;
+    publication: FtAnalyticsEventPublication;
+    searchQuery: FtAnalyticsEventSearchQuery;
+}
+export declare const isFtDocumentSearchEvent: (o: any) => o is FtDocumentSearchEvent;
+export interface FtDocumentStartDisplayEvent extends FtAnalyticsEvent {
+    publication: FtAnalyticsEventPublication;
+    location: FtAnalyticsEventLocation;
+}
+export declare const isFtDocumentStartDisplayEvent: (o: any) => o is FtDocumentStartDisplayEvent;
+export interface FtFeedbackSendEvent extends FtAnalyticsEvent {
+    breadcrumb: Array<FtAnalyticsEventTopic>;
+    publication: FtAnalyticsEventPublication;
+    loggedIn: boolean;
+}
+export declare const isFtFeedbackSendEvent: (o: any) => o is FtFeedbackSendEvent;
+export interface FtGenAiCaseDeflectionEvent extends FtAnalyticsEvent {
+    generationId?: string;
+    searchQuery?: FtAnalyticsEventSearchQuery;
+    context: string;
+}
+export declare const isFtGenAiCaseDeflectionEvent: (o: any) => o is FtGenAiCaseDeflectionEvent;
+export interface FtGenAiCompletedQueryEvent extends FtAnalyticsEvent {
+    result: string;
+    profile: FtAnalyticsEventGenAIProfile;
+    durationMs: number;
+    parameters?: Record<string, string>;
+    queryId: string;
+}
+export declare const isFtGenAiCompletedQueryEvent: (o: any) => o is FtGenAiCompletedQueryEvent;
+export interface FtGenAiRateEvent extends FtAnalyticsEvent {
+    rating: FtAnalyticsEventRating;
+    comment: string;
+    queryId: string;
+}
+export declare const isFtGenAiRateEvent: (o: any) => o is FtGenAiRateEvent;
+export interface FtKhubSearchEvent extends FtAnalyticsEvent {
+    searchResponse: FtAnalyticsEventSearchResponse;
+    searchQuery: FtAnalyticsEventSearchQuery;
+}
+export declare const isFtKhubSearchEvent: (o: any) => o is FtKhubSearchEvent;
+export interface FtLabelsDownloadEvent extends FtAnalyticsEvent {
+    locale: string;
+}
+export declare const isFtLabelsDownloadEvent: (o: any) => o is FtLabelsDownloadEvent;
+export interface FtLinkShareEvent extends FtAnalyticsEvent {
+    breadcrumb: Array<FtAnalyticsEventTopic>;
+    publication: FtAnalyticsEventPublication;
+}
+export declare const isFtLinkShareEvent: (o: any) => o is FtLinkShareEvent;
+export interface FtPageDisplayEvent extends FtAnalyticsEvent {
+    origin: FtAnalyticsEventOrigin;
+    display: FtAnalyticsEventDisplay;
+    page: FtAnalyticsEventPage;
+}
+export declare const isFtPageDisplayEvent: (o: any) => o is FtPageDisplayEvent;
+export interface FtSearchPageSelectEvent extends FtAnalyticsEvent {
+    searchResult: FtAnalyticsEventSearchResult;
+    externalLink?: string;
+    searchQuery: FtAnalyticsEventSearchQuery;
+}
+export declare const isFtSearchPageSelectEvent: (o: any) => o is FtSearchPageSelectEvent;
+export interface FtTopicDisplayEvent extends FtAnalyticsEvent {
+    breadcrumb: Array<FtAnalyticsEventTopic>;
+    publication: FtAnalyticsEventPublication;
+    viewDurationMs: number;
+    location: FtAnalyticsEventLocation;
+}
+export declare const isFtTopicDisplayEvent: (o: any) => o is FtTopicDisplayEvent;
+export interface FtTopicStartDisplayEvent extends FtAnalyticsEvent {
+    breadcrumb: Array<FtAnalyticsEventTopic>;
+    publication: FtAnalyticsEventPublication;
+    location: FtAnalyticsEventLocation;
+}
+export declare const isFtTopicStartDisplayEvent: (o: any) => o is FtTopicStartDisplayEvent;
 export interface FtCredentials {
     password: string;
     newPassword?: string;
@@ -85,7 +343,6 @@ export interface FtMap {
     metadata: Array<FtMetadata>;
     watermark?: FtWatermark;
     openMode: FtOpenModeKeys;
-    translatedTitle?: string;
     topicsApiEndpoint?: string;
     description?: string;
     attachmentsApiEndpoint?: string;
@@ -118,7 +375,6 @@ export interface FtTocNode {
     hasRating?: boolean;
     tocId: string;
     children: Array<FtTocNode>;
-    translatedTitle?: string;
     origin?: FtTopicOrigin;
     contentId: string;
     title: string;
@@ -288,6 +544,12 @@ export interface FtMySearchRequest {
     contentLocale?: string;
 }
 export declare const isFtMySearchRequest: (o: any) => o is FtMySearchRequest;
+export interface FtPrivacyPolicyConfiguration {
+    policyDescription: string;
+    agreementRequired: boolean;
+    userAgreementMessage: string;
+}
+export declare const isFtPrivacyPolicyConfiguration: (o: any) => o is FtPrivacyPolicyConfiguration;
 export declare enum FtRatingType {
     STARS = "STARS",
     LIKE = "LIKE",
@@ -669,6 +931,7 @@ export declare enum FtUserRole {
     RATING_USER = "RATING_USER",
     FEEDBACK_USER = "FEEDBACK_USER",
     GENERATIVE_AI_USER = "GENERATIVE_AI_USER",
+    GENERATIVE_AI_EXPORT_USER = "GENERATIVE_AI_EXPORT_USER",
     CONTENT_PUBLISHER = "CONTENT_PUBLISHER",
     KHUB_ADMIN = "KHUB_ADMIN",
     USERS_ADMIN = "USERS_ADMIN",
@@ -704,8 +967,10 @@ export declare const isFtSession: (o: any) => o is FtSession;
 export interface FtUserProfile {
     emailAddress?: string;
     displayName?: string;
+    otpValidated?: boolean;
     roles: Array<FtUserRoleKeys>;
     userId?: string;
+    privacyPolicyAgreementDate?: Date | string;
     tags: Array<string>;
 }
 export declare const isFtUserProfile: (o: any) => o is FtUserProfile;