@libretexts/cxone-expert-node 1.1.1 → 1.2.0

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.
Files changed (83) hide show
  1. package/README.md +29 -18
  2. package/dist/index.cjs +6 -0
  3. package/dist/index.d.ts +40 -32
  4. package/dist/index.d.ts.map +1 -0
  5. package/dist/index.mjs +3079 -0
  6. package/dist/modules/archive.d.ts +19 -18
  7. package/dist/modules/archive.d.ts.map +1 -0
  8. package/dist/modules/auth.d.ts +9 -8
  9. package/dist/modules/auth.d.ts.map +1 -0
  10. package/dist/modules/contextMaps.d.ts +11 -10
  11. package/dist/modules/contextMaps.d.ts.map +1 -0
  12. package/dist/modules/events.d.ts +16 -15
  13. package/dist/modules/events.d.ts.map +1 -0
  14. package/dist/modules/files.d.ts +24 -23
  15. package/dist/modules/files.d.ts.map +1 -0
  16. package/dist/modules/groups.d.ts +12 -11
  17. package/dist/modules/groups.d.ts.map +1 -0
  18. package/dist/modules/pages.d.ts +68 -68
  19. package/dist/modules/pages.d.ts.map +1 -0
  20. package/dist/modules/requests.d.ts +15 -14
  21. package/dist/modules/requests.d.ts.map +1 -0
  22. package/dist/modules/site.d.ts +23 -22
  23. package/dist/modules/site.d.ts.map +1 -0
  24. package/dist/modules/users.d.ts +17 -16
  25. package/dist/modules/users.d.ts.map +1 -0
  26. package/dist/types/archive.d.ts +79 -78
  27. package/dist/types/archive.d.ts.map +1 -0
  28. package/dist/types/auth.d.ts +12 -11
  29. package/dist/types/auth.d.ts.map +1 -0
  30. package/dist/types/contextMaps.d.ts +35 -34
  31. package/dist/types/contextMaps.d.ts.map +1 -0
  32. package/dist/types/events.d.ts +69 -68
  33. package/dist/types/events.d.ts.map +1 -0
  34. package/dist/types/files.d.ts +62 -61
  35. package/dist/types/files.d.ts.map +1 -0
  36. package/dist/types/groups.d.ts +58 -57
  37. package/dist/types/groups.d.ts.map +1 -0
  38. package/dist/types/index.d.ts +28 -19
  39. package/dist/types/index.d.ts.map +1 -0
  40. package/dist/types/pages.d.ts +738 -737
  41. package/dist/types/pages.d.ts.map +1 -0
  42. package/dist/types/requests.d.ts +10 -9
  43. package/dist/types/requests.d.ts.map +1 -0
  44. package/dist/types/security.d.ts +58 -57
  45. package/dist/types/security.d.ts.map +1 -0
  46. package/dist/types/site.d.ts +255 -254
  47. package/dist/types/site.d.ts.map +1 -0
  48. package/dist/types/users.d.ts +82 -81
  49. package/dist/types/users.d.ts.map +1 -0
  50. package/dist/utils.d.ts +4 -2
  51. package/dist/utils.d.ts.map +1 -0
  52. package/package.json +20 -10
  53. package/dist/cxone-expert-node.cjs.development.js +0 -1511
  54. package/dist/cxone-expert-node.cjs.development.js.map +0 -1
  55. package/dist/cxone-expert-node.cjs.production.min.js +0 -2
  56. package/dist/cxone-expert-node.cjs.production.min.js.map +0 -1
  57. package/dist/cxone-expert-node.esm.js +0 -1505
  58. package/dist/cxone-expert-node.esm.js.map +0 -1
  59. package/dist/index.js +0 -8
  60. package/src/index.ts +0 -105
  61. package/src/modules/archive.ts +0 -186
  62. package/src/modules/auth.ts +0 -35
  63. package/src/modules/contextMaps.ts +0 -56
  64. package/src/modules/events.ts +0 -140
  65. package/src/modules/files.ts +0 -291
  66. package/src/modules/groups.ts +0 -79
  67. package/src/modules/pages.ts +0 -1236
  68. package/src/modules/requests.ts +0 -68
  69. package/src/modules/site.ts +0 -266
  70. package/src/modules/users.ts +0 -161
  71. package/src/types/archive.ts +0 -101
  72. package/src/types/auth.ts +0 -14
  73. package/src/types/contextMaps.ts +0 -46
  74. package/src/types/events.ts +0 -91
  75. package/src/types/files.ts +0 -87
  76. package/src/types/groups.ts +0 -74
  77. package/src/types/index.ts +0 -22
  78. package/src/types/pages.ts +0 -859
  79. package/src/types/requests.ts +0 -11
  80. package/src/types/security.ts +0 -61
  81. package/src/types/site.ts +0 -304
  82. package/src/types/users.ts +0 -101
  83. package/src/utils.ts +0 -8
@@ -1,91 +0,0 @@
1
- import {
2
- BaseQueryParams,
3
- PaginationQueryParams,
4
- RequestModeQueryParam,
5
- } from "./requests";
6
- import { ExpertUser, PageSecurity } from "./security";
7
-
8
- export type GetPageHierarchyByIdParams = {
9
- limit?: number;
10
- include?: string;
11
- upto?: string;
12
- };
13
-
14
- export type GetPageHierarchyDetailByIdParams = {
15
- include?: string;
16
- }
17
-
18
- export type GetEventPageParams = GetPageHierarchyByIdParams;
19
-
20
- export type GetEventPageDetailParams = GetPageHierarchyByIdParams;
21
-
22
- export type GetEventUserPageParams = GetPageHierarchyByIdParams;
23
-
24
- export type GetEventUserPageDetailParams = GetPageHierarchyDetailByIdParams;
25
-
26
- export type GetPageHierarchyByIdResponse = {
27
- "@count": string;
28
- "@upto": string;
29
- "@since": string;
30
- summary: EventSummary | EventSummary[];
31
- };
32
-
33
- export type GetPageHierarchyDetailByIdResponse = {
34
- "@count": string;
35
- summary: EventDetailSummary | EventDetailSummary[];
36
- }
37
-
38
- export type GetEventPageResponse = {
39
- "@count": string;
40
- "@upto": string;
41
- "@since": string;
42
- summary: EventDetailSummary | EventDetailSummary[];
43
- };
44
-
45
- export type GetEventPageDetailResponse = {
46
- "@count": string;
47
- event: EventDetail;
48
- };
49
-
50
- export type GetEventUserPageResponse = GetPageHierarchyByIdResponse;
51
-
52
- export type GetEventUserPageDetailResponse = GetPageHierarchyDetailByIdResponse;
53
-
54
- export type EventSummary = {
55
- "@id": string;
56
- "@datetime": string;
57
- "@count": string;
58
- "@detailid": string;
59
- "@uri.detail": string;
60
- "@uri.hierarchy"?: string;
61
- event: EventDetail;
62
- page: object;
63
- user?: UserDetail;
64
- }
65
-
66
- export type EventDetailSummary = {
67
- "@id": string;
68
- "@datetime": string;
69
- "@count": string;
70
- "@uri.detail": string;
71
- event: EventDetail;
72
- }
73
-
74
- export type EventDetail = {
75
- "@id": string;
76
- "@datetime": string;
77
- "@mt-epoch": string;
78
- "@type": string;
79
- "@language": string;
80
- "@version": string;
81
- diff?: object;
82
- page: object;
83
- request: object;
84
- }
85
-
86
- export type UserDetail = {
87
- "user": {
88
- "@id": string;
89
- }
90
- }
91
-
@@ -1,87 +0,0 @@
1
- import {
2
- BaseQueryParams,
3
- PaginationQueryParams,
4
- RequestModeQueryParam,
5
- } from "./requests";
6
- import { ExpertUser, PageSecurity } from "./security";
7
- import { PageFile, DeletePageFileNameDescriptionResponse } from "./pages";
8
-
9
- export type GetFileParams = {
10
- includeDeleted?: boolean;
11
- revision?: string;
12
- size?: "original" | "thumb" | "webview" | "bestfit" | "custom";
13
- format?: "jpg" | "png" | "bmp" | "gif";
14
- ratio?: "fixed"| "var";
15
- width?: number;
16
- height: number;
17
- } & BaseQueryParams;
18
-
19
- export type GetFileNameParams = GetFileParams;
20
-
21
- export type GetFileDescriptionParams = {
22
- revision?: string;
23
- } & BaseQueryParams;
24
-
25
- export type GetFileInfoParams = {
26
- includeDeleted?: boolean;
27
- revision?: string;
28
- } & BaseQueryParams;
29
-
30
- export type GetFileInfoResponse = PageFile;
31
-
32
- export type GetFilePropertiesParams = {
33
- names?: string;
34
- contentcutoff?: number;
35
- } & BaseQueryParams;
36
-
37
- export type GetFilePropertiesKeyParams = BaseQueryParams;
38
-
39
- export type GetFilePropertiesKeyInfoParams = {
40
- contentcutoff?: number;
41
- } & BaseQueryParams;
42
-
43
- export type GetFileRevisionsParams = {
44
- changefilter?: "CONTENT" | "NAME" | "LANGUAGE" | "META" | "DELETEFLAG" | "PARENT";
45
- } & BaseQueryParams;
46
-
47
- export type GetFileRevisionsResponse = {
48
- "@count": string;
49
- "@totalcount": string;
50
- "@href": string;
51
- file: Partial<PageFile> | Partial<PageFile>[] | "";
52
- }
53
-
54
- export type DeleteFileParams = BaseQueryParams;
55
-
56
- export type HeadFileParams = {
57
- includeDeleted?: boolean;
58
- revision?: string;
59
- size?: "original" | "thumb" | "webview" | "bestfit" | "custom";
60
- format?: "jpg" | "png" | "bmp" | "gif";
61
- ratio?: "fixed"| "var";
62
- width?: number;
63
- height: number;
64
- } & BaseQueryParams;
65
-
66
- export type PutFileParams = {
67
- description?: string;
68
- } & BaseQueryParams;
69
-
70
- export type PutFileResponse = DeletePageFileNameDescriptionResponse;
71
-
72
- export type DeleteFileNameParams = BaseQueryParams;
73
-
74
- export type HeadFileNameParams = HeadFileParams;
75
-
76
- export type PutFileNameParams = PutFileParams;
77
-
78
- export type PostFileCopyParams = {
79
- name?: string;
80
- to?: string;
81
- } & BaseQueryParams;
82
-
83
- export type PostFileCopyResponse = PageFile;
84
-
85
- export type DelDescriptionFileParams = BaseQueryParams;
86
-
87
- export type DelDescriptionFileResponse = DeletePageFileNameDescriptionResponse;
@@ -1,74 +0,0 @@
1
- import {
2
- BaseQueryParams,
3
- PaginationQueryParams,
4
- RequestModeQueryParam,
5
- } from "./requests";
6
- import { ExpertUser, PageSecurity } from "./security";
7
-
8
- export type GetGroupsParams = {
9
- authProvider?: number;
10
- groupnamefilter?: string;
11
- sortby?: "id" | "name" | "role" | "service";
12
- authenticate?: boolean;
13
- } & PaginationQueryParams;
14
-
15
- export type GetGroupParams = {
16
- authenticate?: boolean;
17
- }
18
-
19
- export type GetGroupUserParams = {
20
- sortby?: "id" | "username" | "nick" | "email" | "fullname" | "date.lastlogin" | "status" | "role" | "service";
21
- authenticate?: boolean;
22
- activatedfilter?: boolean;
23
- rolefilter?: string;
24
- usernamefilter?: string;
25
- } & PaginationQueryParams;
26
-
27
-
28
-
29
-
30
-
31
-
32
- export type GetGroupsResponse = {
33
- "@count": string;
34
- "@querycount": string;
35
- "@href": string;
36
- "group": Partial<Group> | Partial<Group>[];
37
- };
38
-
39
- export type GetGroupResponse = Group;
40
-
41
- export type GetGroupUserResponse = {
42
- "@count": string;
43
- "@querycount": string;
44
- "@href": string;
45
- "user": Partial<ExpertUser> | Partial<ExpertUser>[] | "";
46
- };
47
-
48
- export type Group = {
49
- "@id": string;
50
- "@href": string;
51
- "@guid": string;
52
- "groupname": string;
53
- "permissions.group": GroupPermissions;
54
- "service.authentication": {
55
- "@id": string;
56
- "@href": string;
57
- };
58
- "users": {
59
- "@count": string;
60
- "@href": string;
61
- }
62
- };
63
-
64
- export type GroupPermissions = {
65
- "operations": {
66
- "@mask": string;
67
- "#text": string;
68
- };
69
- "role": {
70
- "@id": string;
71
- "@href": string;
72
- "#text": string;
73
- };
74
- };
@@ -1,22 +0,0 @@
1
- import { AuthObject } from './auth';
2
-
3
- export * from './auth';
4
- export * from './pages';
5
- export * from './requests';
6
- export * from './security';
7
- export * from './groups';
8
- export * from './archive';
9
- export * from './events';
10
- export * from './site';
11
- export * from './contextMaps';
12
- export * from './users';
13
- export * from './files';
14
-
15
- export type BaseArgs = {
16
- auth: AuthObject;
17
- tld?: string
18
- }
19
-
20
- export type ExpertGlobalOptions = {
21
- tld?: string;
22
- }