@libretexts/cxone-expert-node 1.1.0 → 1.1.1
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/modules/pages.d.ts +2 -2
- package/dist/types/pages.d.ts +10 -8
- package/package.json +5 -1
- package/src/types/pages.ts +10 -8
package/dist/modules/pages.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
-
import { BaseArgs, ExpertGlobalOptions, GetPagesParams, GetPagesResponse, GetPageParams, GetPageResponse, GetPageContentsParams, GetPageContentsResponse, GetPageContentsExplainParams, GetPageContentsExplainResponse, GetPageDiffParams, GetPageDiffResponse, GetPageExplainParams, GetPageExportTokenParams, GetPageExportTokenFilenameParams, GetPageFilesSubPagesParams, GetPageFilesSubPagesResponse, GetPageFilesParams, GetPageFilesResponse, GetPageFileParams, GetPageFileDescriptionParams, GetPageFileInfoParams, GetPageFileRevisionsParams, GetPageFileRevisionsResponse, GetPageFindParams, GetPageFindResponse, GetPageInfoParams, GetPageLinksParams, GetPageLinksResponse, GetPagePdfParams, GetPagePdfFilenameParams, GetPagePropertiesParams, GetPagePropertiesResponse, GetPagePropertiesKeyParams, GetPagePropertiesKeyInfoParams, GetPagePropertiesKeyInfoResponse, GetPageRatingsParams, GetPageRevisionsParams, GetPageRevisionsResponse, GetPageSubPagesParams, GetPageTagsParams, GetPageTreeParams, GetPageBookParams, GetPageBookFilenameParams, GetPagesCsvParams, GetPagesPopularParams, GetPagesPopularResponse, PostPageContentsParams, PostPageContentsResponse, DeletePageParams, DeletePageResponse, PostPageAllowedParams, PostPageAllowedResponse, PostCopyPageParams, PostCopyPageResponse, DeletePageFileNameParams, HeadPageFileNameParams, PutPageFileNameParams, DeletePageFileNameDescriptionParams, DeletePageFileNameDescriptionResponse, PutPageFileNameDescriptionParams, PutPageFileNameDescriptionResponse, PutPageFileNamePropertiesKeyParams, PutPageImportParams, PutPageMoveParams, PutPageMoveResponse, PutPageOrderParams, PostPagePropertiesParams, PutPagePropertiesParams, PutPagePropertiesResponse, DeletePagePropertiesKeyParams, PutPagePropertiesKeyParams, PostPageRatingsParams, PostPageRevertParams, DeletePageSecurityParams, PostPageSecurityParams, PutPageSecurityParams, PutPageTagsParams } from "../types";
|
|
2
|
+
import { BaseArgs, ExpertGlobalOptions, GetPagesParams, GetPagesResponse, GetPageParams, GetPageResponse, GetPageContentsParams, GetPageContentsResponse, GetPageContentsExplainParams, GetPageContentsExplainResponse, GetPageDiffParams, GetPageDiffResponse, GetPageExplainParams, GetPageExportTokenParams, GetPageExportTokenFilenameParams, GetPageFilesSubPagesParams, GetPageFilesSubPagesResponse, GetPageFilesParams, GetPageFilesResponse, GetPageFileParams, GetPageFileDescriptionParams, GetPageFileInfoParams, GetPageFileRevisionsParams, GetPageFileRevisionsResponse, GetPageFindParams, GetPageFindResponse, GetPageInfoParams, GetPageLinksParams, GetPageLinksResponse, GetPagePdfParams, GetPagePdfFilenameParams, GetPagePropertiesParams, GetPagePropertiesResponse, GetPagePropertiesKeyParams, GetPagePropertiesKeyInfoParams, GetPagePropertiesKeyInfoResponse, GetPageRatingsParams, GetPageRevisionsParams, GetPageRevisionsResponse, GetPageSubPagesParams, GetPageTagsParams, GetPageTreeParams, GetPageTreeResponse, GetPageBookParams, GetPageBookFilenameParams, GetPagesCsvParams, GetPagesPopularParams, GetPagesPopularResponse, PostPageContentsParams, PostPageContentsResponse, DeletePageParams, DeletePageResponse, PostPageAllowedParams, PostPageAllowedResponse, PostCopyPageParams, PostCopyPageResponse, DeletePageFileNameParams, HeadPageFileNameParams, PutPageFileNameParams, DeletePageFileNameDescriptionParams, DeletePageFileNameDescriptionResponse, PutPageFileNameDescriptionParams, PutPageFileNameDescriptionResponse, PutPageFileNamePropertiesKeyParams, PutPageImportParams, PutPageMoveParams, PutPageMoveResponse, PutPageOrderParams, PostPagePropertiesParams, PutPagePropertiesParams, PutPagePropertiesResponse, DeletePagePropertiesKeyParams, PutPagePropertiesKeyParams, PostPageRatingsParams, PostPageRevertParams, DeletePageSecurityParams, PostPageSecurityParams, PutPageSecurityParams, PutPageTagsParams } from "../types";
|
|
3
3
|
import Auth from "./auth";
|
|
4
4
|
import { Buffer } from 'buffer';
|
|
5
5
|
export default class Pages {
|
|
@@ -35,7 +35,7 @@ export default class Pages {
|
|
|
35
35
|
getPageRevisions(id: string | number, funcArgs: BaseArgs, reqArgs?: GetPageRevisionsParams): Promise<GetPageRevisionsResponse>;
|
|
36
36
|
getPageSubpages(id: string | number, funcArgs: BaseArgs, reqArgs?: GetPageSubPagesParams): Promise<Partial<import("../types").page_subpage>>;
|
|
37
37
|
getPageTags(id: string | number, funcArgs: BaseArgs, reqArgs?: GetPageTagsParams): Promise<Partial<import("../types").Tags>>;
|
|
38
|
-
getPageTree(id: string | number, funcArgs: BaseArgs, reqArgs?: GetPageTreeParams): Promise<
|
|
38
|
+
getPageTree(id: string | number, funcArgs: BaseArgs, reqArgs?: GetPageTreeParams): Promise<GetPageTreeResponse>;
|
|
39
39
|
getPageBook(id: string | number, funcArgs: BaseArgs, reqArgs?: GetPageBookParams): Promise<unknown>;
|
|
40
40
|
getPageBookFilename(id: string | number, filename: string, funcArgs: BaseArgs, reqArgs?: GetPageBookFilenameParams): Promise<unknown>;
|
|
41
41
|
getPagesCsv(funcArgs: BaseArgs, reqArgs?: GetPagesCsvParams): Promise<unknown>;
|
package/dist/types/pages.d.ts
CHANGED
|
@@ -242,7 +242,9 @@ export declare type GetPageTreeParams = {
|
|
|
242
242
|
include?: string;
|
|
243
243
|
authenticate?: boolean;
|
|
244
244
|
};
|
|
245
|
-
export declare type GetPageTreeResponse =
|
|
245
|
+
export declare type GetPageTreeResponse = {
|
|
246
|
+
page: Partial<GetPagesResponse>;
|
|
247
|
+
};
|
|
246
248
|
export declare type GetPageBookParams = {
|
|
247
249
|
format?: "html" | "pdf";
|
|
248
250
|
title?: string;
|
|
@@ -539,7 +541,7 @@ export declare type PageExtended = {
|
|
|
539
541
|
properties: {
|
|
540
542
|
"@count"?: string;
|
|
541
543
|
"@href"?: string;
|
|
542
|
-
property?:
|
|
544
|
+
property?: PageProperty[];
|
|
543
545
|
} | "";
|
|
544
546
|
rating: Partial<PageRating> | "";
|
|
545
547
|
revisions: Partial<PageRevision> | "";
|
|
@@ -629,17 +631,17 @@ export declare type Tags = {
|
|
|
629
631
|
tag?: Partial<PageTag> | Partial<PageTag>[] | "";
|
|
630
632
|
};
|
|
631
633
|
export declare type PageProperty = {
|
|
632
|
-
"@revision": string;
|
|
633
|
-
"@resid": string;
|
|
634
|
-
"@name": string;
|
|
635
|
-
"@href": string;
|
|
636
634
|
"@etag": string;
|
|
635
|
+
"@href": string;
|
|
636
|
+
"@name": string;
|
|
637
|
+
"@resid": string;
|
|
637
638
|
"@resource-is-deleted": string;
|
|
638
639
|
"@resource-rev-is-deleted": string;
|
|
640
|
+
"@revision": string;
|
|
639
641
|
"change-description": string;
|
|
640
|
-
contents:
|
|
642
|
+
contents: Pick<Contents, '@href' | '@size' | '#text' | '@type'>;
|
|
641
643
|
"date.modified": string;
|
|
642
|
-
"user.modified":
|
|
644
|
+
"user.modified": ExpertUser;
|
|
643
645
|
};
|
|
644
646
|
export declare type page_subpage = {
|
|
645
647
|
"@totalcount": string;
|
package/package.json
CHANGED
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@libretexts/cxone-expert-node",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"description": "",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/LibreTexts/cxone-expert-node"
|
|
8
|
+
},
|
|
5
9
|
"main": "dist/index.js",
|
|
6
10
|
"typings": "dist/index.d.ts",
|
|
7
11
|
"files": [
|
package/src/types/pages.ts
CHANGED
|
@@ -295,7 +295,9 @@ export type GetPageTreeParams = {
|
|
|
295
295
|
authenticate?: boolean;
|
|
296
296
|
};
|
|
297
297
|
|
|
298
|
-
export type GetPageTreeResponse =
|
|
298
|
+
export type GetPageTreeResponse = {
|
|
299
|
+
page: Partial<GetPagesResponse>;
|
|
300
|
+
};
|
|
299
301
|
|
|
300
302
|
export type GetPageBookParams = {
|
|
301
303
|
format?: "html" | "pdf";
|
|
@@ -642,7 +644,7 @@ export type PageExtended = {
|
|
|
642
644
|
properties: {
|
|
643
645
|
"@count"?: string;
|
|
644
646
|
"@href"?: string;
|
|
645
|
-
property?:
|
|
647
|
+
property?: PageProperty[];
|
|
646
648
|
} | "";
|
|
647
649
|
rating: Partial<PageRating> | "";
|
|
648
650
|
revisions: Partial<PageRevision> | "";
|
|
@@ -740,17 +742,17 @@ export type Tags = {
|
|
|
740
742
|
}
|
|
741
743
|
|
|
742
744
|
export type PageProperty = {
|
|
743
|
-
"@revision": string;
|
|
744
|
-
"@resid": string;
|
|
745
|
-
"@name": string;
|
|
746
|
-
"@href": string;
|
|
747
745
|
"@etag": string;
|
|
746
|
+
"@href": string;
|
|
747
|
+
"@name": string;
|
|
748
|
+
"@resid": string;
|
|
748
749
|
"@resource-is-deleted": string;
|
|
749
750
|
"@resource-rev-is-deleted": string;
|
|
751
|
+
"@revision": string;
|
|
750
752
|
"change-description": string;
|
|
751
|
-
contents:
|
|
753
|
+
contents: Pick<Contents, '@href' | '@size' | '#text' | '@type'>;
|
|
752
754
|
"date.modified": string;
|
|
753
|
-
"user.modified":
|
|
755
|
+
"user.modified": ExpertUser;
|
|
754
756
|
}
|
|
755
757
|
|
|
756
758
|
export type page_subpage = {
|