@telia-ace/knowledge-data-client-flamingo 1.1.119 → 1.1.120-rc.1

package/create-serviceclient.d.ts

@@ -0,0 +1,2 @@
+import { Container } from '@webprovisions/platform';
+export declare const createServiceClient: (container: Container) => Promise<any>;

package/data-client.d.ts

@@ -0,0 +1,93 @@
+import { ServiceClient } from '@telia-ace/knowledge-serviceclient';
+import { Container, EventManager } from '@webprovisions/platform';
+export type Subscriber = (...args: any[]) => void;
+export declare enum DataType {
+    Guide = "guide",
+    Guides = "guides",
+    GuidesByCategory = "guides-by-category",
+    RowNotifications = "row-notices",
+    NotificationLists = "notification-lists",
+    GuideCategories = "guide-categories",
+    ContactMethodCategories = "contact-method-categories",
+    ContactMethod = "contact-method",
+    ContactMethods = "contact-methods",
+    Tags = "tags",
+    TagsOnGuides = "tagsonguides"
+}
+export type DataError = {
+    status: number;
+    message: string;
+};
+export declare enum ServiceClientQueryType {
+    Match = "match",
+    Categories = "categories",
+    Guide = "guide",
+    Contacts = "contacts",
+    ContactMethod = "contact-method",
+    MatchByCategory = "match-by-category",
+    Tags = "tags",
+    TagsOnGuides = "tagsonguides",
+    Notifications = "notifications"
+}
+export declare enum FeedbackType {
+    Positive = "Positive",
+    Negative = "Negative"
+}
+export type QueryParameters = {
+    guideId?: string | number;
+    categories?: string | number | string[] | number[];
+    tagId?: string | number;
+    connection?: string;
+    contactMethodCategoryId?: string | number;
+    contactMethodId?: string | number;
+    searchPhrase?: string | number;
+    take?: string | number;
+    [key: string]: any;
+    expandCategories?: 'none' | 'children' | 'descendants';
+    sorting?: SortingType;
+    guideIds?: string[];
+};
+export declare enum SortingType {
+    POPULARITY_DESCENDING = "popularity-descending",
+    ALPHABETIC_ASCENDING = "alphabetic-ascending",
+    ALPHABETIC_DESCENDING = "alphabetic-descending",
+    MODIFIED_ASCENDING = "modified-ascending",
+    MODIFIED_DESCENDING = "modified-descending",
+    PUBLISHED_ASCENDING = "published-ascending",
+    PUBLISHED_DESCENDING = "published-descending"
+}
+export type Query = {
+    params: QueryParameters;
+    resolved: boolean;
+    loading: boolean;
+    error?: DataError;
+    data: any;
+    resolvers: {
+        resolve: (data: any) => void;
+        reject: (data: any) => void;
+    }[];
+};
+export declare const determineServiceClientQueryType: (type: DataType) => ServiceClientQueryType;
+export default class DataClient {
+    private container;
+    private matchingClient;
+    private queries;
+    events: EventManager;
+    constructor(container: Container, matchingClient: ServiceClient);
+    static getInstance(container: Container, key?: string): Promise<DataClient>;
+    private getUnresolvedQueries;
+    fetch(type: DataType, params: QueryParameters, options?: {
+        noCache: boolean;
+    }): Promise<any>;
+    read(type: DataType, options: {
+        select?: (data: any) => any;
+    }): any[];
+    feedback(id: string, connection: string, feedback: FeedbackType): Promise<any>;
+    private setLoadingStatus;
+    private runQuery;
+    handleResponse(data: any | undefined, type: ServiceClientQueryType, params: QueryParameters, error?: DataError): void;
+    private fetchAllUnresolvedQueries;
+    private track;
+    static create(container: Container): Promise<DataClient>;
+    getClient(): ServiceClient;
+}

package/index.d.ts

@@ -0,0 +1,4 @@
+export * from './data-client';
+export { default as DataClient } from './data-client';
+export * from './legacy-conversion';
+export { KnowledgeDataClientPlugin } from './plugin';

package/legacy-conversion.d.ts

@@ -0,0 +1,71 @@
+import { DataError, ServiceClientQueryType } from './data-client';
+type Category = any;
+type DialogItem = any;
+type Guide = any;
+type Notification = any;
+type NotificationList = any;
+type Tag = any;
+type ContactMethod = any;
+export type MatchResult = {
+    guides: Guide[];
+    matches: number;
+    topNotifications: Notification[];
+    middleNotifications: Notification[];
+    bottomNotifications: Notification[];
+    notificationLists: NotificationList[];
+    tags: Tag[];
+    byCategory: {
+        id: string;
+        guides: Guide[];
+        matches: number;
+    }[];
+};
+export type TagsResult = Tag[];
+export type CategoriesResult = {
+    categories: Category[];
+    matches: number;
+};
+export type NotificationResults = Pick<MatchResult, 'topNotifications' | 'middleNotifications' | 'bottomNotifications' | 'notificationLists'>;
+export type GuideResult = {
+    guide: {
+        id: string;
+        title: string;
+        body: string;
+        modified: string;
+        modifiedBy: string | null;
+        publishedBy: string | null;
+        published: string;
+        connection: string;
+        categories: number[];
+        hasHandover: boolean;
+        allowFeedback: boolean;
+        seoMetaDescription: string | null;
+        seoAllowIndex: boolean | null;
+        perspective: string | null;
+        perspectives: {
+            [key: string]: string;
+        };
+        translations?: {
+            [key: string]: string;
+        };
+    };
+    related: Guide[];
+    dialog: DialogItem[];
+    contactMethods: ContactMethod[];
+    tags: Tag[];
+    error?: DataError;
+};
+export type ContactsResult = {
+    categories: Category[];
+    contactMethods: ContactMethod[];
+    topNotifications: Notification[];
+    middleNotifications: Notification[];
+    bottomNotifications: Notification[];
+    notificationLists: NotificationList[];
+};
+export type SubmissionResult = {
+    contactMethod?: ContactMethod;
+    valid: boolean;
+};
+export declare const formatLegacyData: (type: ServiceClientQueryType, data: any) => any;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telia-ace/knowledge-data-client-flamingo",
-  "version": "1.1.119",
+  "version": "1.1.120-rc.1",
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },

package/plugin.d.ts

@@ -0,0 +1,2 @@
+import { Container } from '@webprovisions/platform';
+export declare const KnowledgeDataClientPlugin: (container: Container) => Promise<void>;