@salesforcedevs/docs-components 1.3.205 → 1.3.209-alpha1

package/src/modules/doc/xmlContent/types.ts

@@ -77,6 +77,17 @@ export type ApiNavItem = {
     id: string;
 };
 
+export type ZoominApiNavItem = {
+    bundle_id: string;
+    childEntries: Array<ZoominApiNavItem>;
+    id: string;
+    nav_path: string;
+    outputclasses: Array<string>;
+    title: string;
+    url: string;
+};
+
+
 export type ApiDocData = {
     available_languages: Array<ApiDocLanguage>;
     available_versions: Array<ApiDocVersion>;
@@ -115,3 +126,102 @@ export type ContentApiOptions = {
 };
 
 export type TocMap = { [key: string]: TreeNode };
+
+
+
+
+// ZOOMIN TYPES - START
+
+export type ZoominTocNode = {
+    id: string;
+    bundle_id: string;
+    childEntries?: Array<ZoominTocNode> | [];
+    nav_path: string;
+    outputclasses: Array<string>,
+    title: string;
+    url: string;
+    parent?: ZoominTocNode;
+    isExpanded?: boolean;
+};
+interface Attachment {
+    all_attachments: null;
+    topic_attachments: any[];
+}
+
+interface Dates {
+    "Added on": string;
+    "Created on": string;
+    "Initial upload": string;
+    "Updated on": string;
+}
+
+interface Label {
+    aliases: any[];
+    hidden: boolean;
+    isSubjectHead: boolean;
+    key: string;
+    navtitle: string;
+    outputclasses: any[];
+    subjectHeadId: string;
+    subjectheadNavtitle: string;
+    visibility: string;
+}
+
+interface Metadata {
+    description: string;
+    "mini-toc": string;
+    outputclasses: string;
+}
+
+interface ReadTimeData {
+    char_count: number;
+    img_count: number;
+    read_time: number;
+    video_links: string[];
+    word_count: number;
+}
+
+interface TopicCluster {
+    clustered_by: { enabled: boolean; type: string };
+    clustered_labels: any[];
+    clustered_topics: any[];
+    clustering_title: string;
+}
+
+export type ZoominDocContent = {
+    attachments: Attachment;
+    available_languages: string[];
+    breadcrumbs: any[];
+    breadcrumbs_html: string;
+    bundle_id: string;
+    bundle_landing_page: string;
+    bundle_subtitle: null;
+    bundle_title: string;
+    dates: Dates;
+    dislike_url: string;
+    dislikes: number;
+    es_archived_content: boolean;
+    is_in_fav: boolean;
+    is_liked: null;
+    is_watched: boolean;
+    keywords: string[];
+    labels: Label[];
+    labels_text: string;
+    like_url: string;
+    likes: number;
+    metadata: Metadata;
+    page_id: string;
+    page_key: number;
+    preprocessed_PDF: null;
+    rating: null;
+    read_time_data: ReadTimeData;
+    related_links: any[];
+    title: string;
+    topic_cluster: TopicCluster;
+    topic_html: string;
+    topic_language: string;
+    views: number;
+    your_rating: null;
+}
+
+// ZOOMIN TYPES - End

package/src/modules/doc/xmlContent/utils.ts

@@ -75,7 +75,7 @@ export class FetchContent {
             `${this.apiDomain}/docs/get_document_content/${deliverable}/${contentId}/${options.language}/${options.version}`
         );
     }
-
+    
     private async fetchResource<T>(url: string): Promise<T> {
         const response = await fetch(url);
         if (!response.ok) {