@fluid-topics/public-api 1.0.21 → 1.0.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/mjs/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import "cross-fetch/polyfill";
|
|
2
|
-
import { FtCollectionDocument, FtMap, FtMapResource, FtSearchLocales, FtSearchRequest, FtSearchResults, FtSuggestRequest, FtSuggestResults, FtTocNode, FtTopic, FtTopicContentTarget, FtUnstructuredDocument } from "./types/ft-common/public";
|
|
2
|
+
import { FtCollectionDocument, FtMap, FtMapResource, FtSearchLocales, FtSearchRequest, FtSearchResults, FtSuggestRequest, FtSuggestResults, FtTocNode, FtTopic, FtTopicContentTarget, FtTopicContentTargetKeys, FtUnstructuredDocument } from "./types/ft-common/public";
|
|
3
3
|
import { FtAuthenticatedSession, FtMapAttachment, FtSession } from "./types/ft-server/public";
|
|
4
4
|
export * from "./types/ft-common/public";
|
|
5
5
|
export * from "./types/ft-server/public";
|
|
@@ -25,7 +25,7 @@ export declare class FluidTopicsApi {
|
|
|
25
25
|
getMap(mapId: string): Promise<FtMap>;
|
|
26
26
|
getTableOfContent(mapId: string): Promise<Array<FtTocNode>>;
|
|
27
27
|
getTopic(mapId: string, topicContentId: string): Promise<FtTopic>;
|
|
28
|
-
getTopicHTMLContent(mapId: string, topicContentId: string, target?: FtTopicContentTarget): Promise<string>;
|
|
28
|
+
getTopicHTMLContent(mapId: string, topicContentId: string, target?: FtTopicContentTarget | FtTopicContentTargetKeys): Promise<string>;
|
|
29
29
|
getMapAttachments(mapId: string): Promise<Array<FtMapAttachment>>;
|
|
30
30
|
getMapAttachmentContent(mapId: string, attachmentId: string): Promise<ArrayBuffer>;
|
|
31
31
|
getMapResources(mapId: string): Promise<Array<FtMapResource>>;
|
|
@@ -88,6 +88,7 @@ export declare enum FtTopicContentTarget {
|
|
|
88
88
|
PAGES = "PAGES",
|
|
89
89
|
DESIGNED_READER = "DESIGNED_READER"
|
|
90
90
|
}
|
|
91
|
+
export declare type FtTopicContentTargetKeys = keyof typeof FtTopicContentTarget;
|
|
91
92
|
export declare const isFtTopicContentTarget: (o: any) => o is FtTopicContentTarget;
|
|
92
93
|
export interface FtSearchLocale {
|
|
93
94
|
count: number;
|
|
@@ -144,11 +145,13 @@ export declare enum FtEditorialType {
|
|
|
144
145
|
ARTICLE = "ARTICLE",
|
|
145
146
|
BOOK = "BOOK"
|
|
146
147
|
}
|
|
148
|
+
export declare type FtEditorialTypeKeys = keyof typeof FtEditorialType;
|
|
147
149
|
export declare const isFtEditorialType: (o: any) => o is FtEditorialType;
|
|
148
150
|
export declare enum FtOpenMode {
|
|
149
151
|
FLUIDTOPICS = "FLUIDTOPICS",
|
|
150
152
|
EXTERNAL = "EXTERNAL"
|
|
151
153
|
}
|
|
154
|
+
export declare type FtOpenModeKeys = keyof typeof FtOpenMode;
|
|
152
155
|
export declare const isFtOpenMode: (o: any) => o is FtOpenMode;
|
|
153
156
|
export interface FtPageRequest {
|
|
154
157
|
perPage?: number;
|
|
@@ -162,6 +165,7 @@ export declare enum FtCollectionDocumentType {
|
|
|
162
165
|
PERSONAL_BOOK = "PERSONAL_BOOK",
|
|
163
166
|
SHARED_BOOK = "SHARED_BOOK"
|
|
164
167
|
}
|
|
168
|
+
export declare type FtCollectionDocumentTypeKeys = keyof typeof FtCollectionDocumentType;
|
|
165
169
|
export declare const isFtCollectionDocumentType: (o: any) => o is FtCollectionDocumentType;
|
|
166
170
|
export interface FtSearchResults {
|
|
167
171
|
spellcheck?: FtSpellcheck;
|
|
@@ -259,6 +263,7 @@ export declare enum FtSearchResultType {
|
|
|
259
263
|
DOCUMENT = "DOCUMENT",
|
|
260
264
|
TOPIC = "TOPIC"
|
|
261
265
|
}
|
|
266
|
+
export declare type FtSearchResultTypeKeys = keyof typeof FtSearchResultType;
|
|
262
267
|
export declare const isFtSearchResultType: (o: any) => o is FtSearchResultType;
|
|
263
268
|
export interface FtSearchFacet {
|
|
264
269
|
hierarchical: boolean;
|