@libretexts/cxone-expert-node 1.0.0 → 1.1.1

package/dist/types/requests.d.ts

@@ -0,0 +1,9 @@
+export declare type BaseQueryParams = {
+    authenticate?: boolean;
+    redirects?: number;
+};
+export declare type PaginationQueryParams = {
+    offset?: number;
+    limit?: string;
+};
+export declare type RequestModeQueryParam = 'edit' | 'view' | 'raw';

package/dist/types/security.d.ts

@@ -0,0 +1,57 @@
+export declare type ExpertUser = {
+    '@anonymous': string;
+    '@virtual': string;
+    '@id': string;
+    '@wikiid': string;
+    '@href': string;
+    '@guid': string;
+    'date.created': string;
+    'date.lastlogin': string;
+    email: string;
+    fullname: string;
+    "hash.email": string;
+    "license.seat": string;
+    nick: string;
+    password: {
+        "@exists": string;
+    } | "";
+    status: string;
+    timezone: string;
+    "uri.avatar": string;
+    "uri.gravatar": string;
+    username: string | '#RESTRICTED';
+};
+export declare type PageSecurity = {
+    '@href': string;
+    grants: {
+        grant: SecurityGrant | SecurityGrant[];
+    };
+    'permissions.effective': SecurityGrantPermissions | SecurityGrantPermissions[];
+    'permissions.page': SecurityGrantPermissions & SecurityGrantPermissionsRestriction | SecurityGrantPermissions & SecurityGrantPermissionsRestriction[];
+    'permissions.revoked': Record<string, {
+        operations: SecurityGrantPermissionsOperations | SecurityGrantPermissionsOperations[];
+    }>;
+};
+export declare type SecurityGrant = {
+    'date.modified': string;
+    permissions: SecurityGrantPermissions;
+    user: ExpertUser;
+    'user.modifiedby': ExpertUser;
+};
+export declare type SecurityGrantPermissions = {
+    operations: SecurityGrantPermissionsOperations | SecurityGrantPermissionsOperations[];
+    role: SecurityRole | SecurityRole[];
+};
+export declare type SecurityGrantPermissionsOperations = {
+    '@mask': string;
+    '#text': string;
+};
+export declare type SecurityGrantPermissionsRestriction = {
+    '@id': string;
+    '#text': string;
+};
+export declare type SecurityRole = {
+    '@id': string;
+    '@href': string;
+    '#text': string;
+};

package/dist/types/site.d.ts

@@ -0,0 +1,254 @@
+import { BaseQueryParams, PaginationQueryParams } from "./requests";
+export declare type GetSiteActivityParams = {
+    since?: string;
+    authenticate?: boolean;
+};
+export declare type GetSiteSubPagesTagsParams = {
+    format?: "debug" | "html" | "xml";
+    width?: number;
+    exclude?: number;
+    type?: "compact" | "expandable";
+} & BaseQueryParams;
+export declare type GetSiteFullNavTreeTagsParams = {
+    format?: "debug" | "html" | "xml";
+    width?: number;
+} & BaseQueryParams;
+export declare type GetSiteOperationsParams = {
+    authenticate?: boolean;
+};
+export declare type GetSitePropertiesParams = {
+    names?: string;
+    contentcutoff?: number;
+} & BaseQueryParams;
+export declare type GetSiteKeyPropertiesParams = BaseQueryParams;
+export declare type GetSiteKeyPropertiesInfoParams = {
+    contentcutoff?: number;
+} & BaseQueryParams;
+export declare type GetSiteQueryParams = {
+    parser?: "bestguess" | "term" | "filename" | "lucene";
+    nocache?: boolean;
+    authenticate?: boolean;
+    constraint?: string;
+    sortby?: SortBy;
+    verbose?: boolean;
+    format?: "xml" | "search";
+    q: string;
+} & PaginationQueryParams;
+export declare type GetSiteTagsParams = {
+    to?: string;
+    from?: string;
+    authenticate?: boolean;
+    type?: "text" | "date" | "user" | "define";
+    q: string;
+    pages?: boolean;
+};
+export declare type GetSiteTagParams = {
+    include?: string;
+    parentid?: number;
+    language?: string;
+    authenticate?: boolean;
+};
+declare type SortBy = "score" | "-score" | "title" | "-title" | "date" | "-date" | "size" | "-size" | "wordcount" | "-wordcount" | "rating.score" | "-rating.score" | "rating.count" | "-rating.count";
+export declare type GetSiteActivityResponse = {
+    "@type"?: string;
+    entry?: Partial<entryBody> | Partial<entryBody>[] | "";
+};
+export declare type GetSiteExportGroupsResponse = {
+    "group"?: Partial<groupBody> | Partial<groupBody>[] | "";
+};
+export declare type GetSiteExportUsersResponse = {
+    "user"?: Partial<userBody> | Partial<userBody>[] | "";
+};
+export declare type GetSiteSubPagesTagsResponse = {
+    "children": {
+        "html": string;
+        "nodes": string;
+    };
+};
+export declare type GetSitePropertiesResponse = {
+    "@count"?: string;
+    "@href"?: string;
+    property?: Partial<propertyBody> | Partial<propertyBody>[] | "";
+};
+export declare type GetSiteKeyPropertiesInfoResponse = Partial<propertyBody>;
+export declare type GetSiteQueryResponse = {
+    "@ranking"?: string;
+    "@queryid"?: string;
+    "@sessionid"?: string;
+    "@querycount"?: string;
+    "@count.recommendations"?: string;
+    "@count"?: string;
+    result?: Partial<queryBody> | Partial<queryBody>[] | "";
+};
+export declare type GetSiteStatusResponse = {
+    "@status"?: string;
+};
+export declare type GetSiteTagsResponse = {
+    "@count"?: string;
+    tag?: Partial<tagBody> | Partial<tagBody>[] | "";
+};
+export declare type GetSiteTagResponse = {
+    "@value"?: string;
+    "@id"?: string;
+    "@href"?: string;
+    pages?: {
+        "@count"?: string;
+        "@totalcount"?: string;
+        page?: Partial<PageTag> | Partial<PageTag>[] | "";
+    };
+    title?: string;
+    type?: string;
+    uri?: string;
+};
+declare type PageTag = {
+    "@id": string;
+    "@guid": string;
+    "@draft.state": string;
+    "@href": string;
+    "@deleted": string;
+    "date.created": string;
+    language: string;
+    namespace: string;
+    path: Partial<{
+        "@seo": string;
+        "@type": string;
+        "#text": string;
+    }>;
+    title: string;
+    "uri.ui": string;
+};
+export declare type tagBody = {
+    "@value": string;
+    "@id": string;
+    "@href": string;
+    title: string;
+    type: string;
+    uri: string;
+};
+export declare type queryBody = {
+    author: string;
+    authorDisplayName: string;
+    "date.modified": string;
+    id: string;
+    mime: string;
+    page: Partial<{
+        "@guid": string;
+        path: string;
+        rating: string;
+        title: string;
+        "uri.ui": string;
+    }>;
+    preview: string;
+    rank: string;
+    tag: string;
+    title: string;
+    type: string;
+    uri: string;
+    "uri.track": string;
+};
+export declare type entryBody = {
+    "@date": string;
+    "pages.created": string;
+    "pages.deleted": string;
+    "pages.edited": string;
+    "pages.total": string;
+    "users.created": string;
+    "users.total": string;
+};
+export declare type groupBody = {
+    "@guid": string;
+    "groupname": string;
+    "premissions.group": Partial<{
+        "operations": Partial<{
+            '@mask': string;
+            '#text': string;
+        }>;
+        "role": Partial<{
+            '@id': string;
+            '#text': string;
+        }>;
+    }>;
+    "service.authentication": object | "";
+};
+export declare type groupsBody = {
+    group: Partial<groupBody> | Partial<groupBody>[];
+};
+declare type userBody = {
+    "@anonymous": string;
+    "@virtual": string;
+    "date.created": string;
+    "date.lastlogin": string;
+    email: string;
+    fullname: string;
+    groups: groupsBody | "";
+    "hash.email": string;
+    language: string;
+    "license.seat": Partial<{
+        "@owner": string;
+        "#text": string;
+    }>;
+    nick: string;
+    password: object;
+    "permissions.effective": Partial<{
+        operations: Partial<{
+            '@mask': string;
+            '#text': string;
+        }>;
+    }>;
+    "permissions.revoked": object | "";
+    "permissions.user": Partial<{
+        operations: Partial<{
+            '@mask': string;
+            '#text': string;
+        }>;
+        role: Partial<{
+            '@id': string;
+            '#text': string;
+        }>;
+    }>;
+    "service.authentication": object | "";
+    status: string;
+    timezone: string;
+    "uri.avatar": string;
+    "uri.gravatar": string;
+    username: string;
+};
+export declare type propertyBody = {
+    "@revision": string;
+    "@resid": string;
+    "@name": string;
+    "@href": string;
+    "@etag": string;
+    "@resource-is-deleted": string;
+    "@resource-rev-is-deleted": string;
+    contents: Partial<{
+        "@type": string;
+        "@size": string;
+        "@href": string;
+    }>;
+    "date.modified": string;
+    "user.modified": Partial<userModifiedBody>;
+};
+export declare type userModifiedBody = {
+    "@anonymous": string;
+    "@virtual": string;
+    "@id": string;
+    "@wikiid": string;
+    "@href": string;
+    "date.created": string;
+    "date.lastlogin"?: string;
+    "email": string;
+    "fullname": string;
+    "hash.email": string;
+    "license.seat": Partial<{
+        "@owner": string;
+        "#text": string;
+    }>;
+    nick: string;
+    password: object;
+    status: string;
+    "uri.avatar": string;
+    "uri.gravatar": string;
+    username: string;
+};
+export {};

package/dist/types/users.d.ts

@@ -0,0 +1,81 @@
+import { BaseQueryParams, PaginationQueryParams } from "./requests";
+import { ExpertUser } from "./security";
+import { Group } from "./groups";
+import { PageBase, PageProperty } from "./pages";
+export declare type GetUsersParams = {
+    verbose?: boolean;
+    sortby?: string;
+    seatfilter?: string;
+    activatedfilter?: boolean;
+    rolefilter?: string;
+    authprovider?: number;
+    usernameemailfilter?: string;
+    fullnamefilter?: string;
+    usernamefilter?: string;
+} & PaginationQueryParams & BaseQueryParams;
+export declare type GetUsersResponse = {
+    "@count"?: string;
+    "@querycount"?: string;
+    "@totalcount"?: string;
+    "@seateduserstotalcount"?: string;
+    "@href": string;
+    user: Partial<userBody> | Partial<userBody>[] | "";
+};
+export declare type GetUserParams = {
+    exclude?: string;
+} & BaseQueryParams;
+export declare type GetUserResponse = Partial<userBody> | "";
+export declare type GetUserMetricsParams = BaseQueryParams;
+export declare type GetUserMetricsResponse = {
+    "@user.id"?: string;
+    "@href"?: string;
+    "metric.comments"?: string;
+    "metric.files-added"?: string;
+    "metric.pages-created"?: string;
+    "metric.pages-edited"?: string;
+    "metric.ratings-down"?: string;
+    "metric.ratings-up"?: string;
+};
+export declare type GetUserPropertiesParams = {
+    names?: string;
+    contentcutoff?: number;
+} & BaseQueryParams;
+export declare type GetUserPropertiesResponse = {
+    "@count"?: string;
+    "@href"?: string;
+    property?: Partial<PageProperty> | Partial<PageProperty>[] | "";
+};
+export declare type GetUserPropertiesKeyParams = BaseQueryParams;
+export declare type GetUserPropertiesKeyResponse = {
+    property: {
+        "@name"?: string;
+        contents?: {
+            "@type"?: string;
+            "#text"?: string;
+        };
+    };
+};
+export declare type GetUserPropertiesKeyInfoParams = {
+    contentcutoff?: number;
+} & BaseQueryParams;
+export declare type GetUserPropertiesKeyInfoResponse = PageProperty;
+export declare type GetUserSearchParams = {
+    format?: string;
+    groupid?: number;
+    seated?: boolean;
+    active?: boolean;
+    authprovider?: number;
+    fullname?: string;
+    username?: string;
+    email?: string;
+} & BaseQueryParams & PaginationQueryParams;
+export declare type GetUserSearchResponse = {
+    "@count"?: string;
+    user?: Partial<userBody> | Partial<userBody>[] | "";
+};
+export declare type userBody = {
+    groups: {
+        group?: Partial<Group> | Partial<Group>[];
+    } | "";
+    "page.home": Partial<PageBase> | Partial<PageBase>[] | "";
+} & (Partial<ExpertUser> | Partial<ExpertUser>[]);

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+import { ExpertGlobalOptions } from "./types";
+export declare function getTld(globals: ExpertGlobalOptions, tld?: string): string | undefined;

package/license.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 LibreTexts
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+MIT License
+
+Copyright (c) 2023 LibreTexts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.

package/package.json

@@ -1,18 +1,29 @@
 {
   "name": "@libretexts/cxone-expert-node",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "",
-  "main": "index.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/LibreTexts/cxone-expert-node"
+  },
+  "main": "dist/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "src",
+    "dist"
+  ],
   "scripts": {
-    "dev": "tsx test.ts",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsdx build --target node",
+    "prepare": "tsdx build --target node"
   },
   "keywords": [],
   "author": "LibreTexts, Inc.",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^22.2.0",
+    "@types/node": "^22.15.3",
     "dotenv": "^16.4.5",
+    "tsdx": "^0.14.1",
     "tsx": "^4.17.0",
     "typescript": "^5.5.4"
   },

package/src/index.ts

@@ -1,35 +1,105 @@
-import pages from './modules/pages';
-import auth from './modules/auth';
-import requests from './modules/requests';
-import { AuthObject, BaseArgs, BrowserTokenParams, ExpertGlobalOptions, ServerTokenParams } from './types';
-import Pages from './modules/pages';
-
-
-export default class Expert {
-    private globals: ExpertGlobalOptions = {};
-    private _pages?: Pages;
-    private _auth?: auth;
-
-    constructor(tld?: string) {
-        if (tld) {
-            this.globals.tld = tld;
-        }
-    }
-
-    public get pages(): Pages {
-        if (!this._pages) {
-            this._pages = new pages(this.globals);
-        }
-
-        return this._pages;
-    }
-
-    public get auth(): auth {
-        if (!this._auth) {
-            this._auth = new auth();
-        }
-
-        return this._auth;
-    }
-
-}
+import pages from './modules/pages';
+import auth from './modules/auth';
+import requests from './modules/requests';
+import { AuthObject, BaseArgs, BrowserTokenParams, ExpertGlobalOptions, ServerTokenParams } from './types';
+import Pages from './modules/pages';
+import Groups from './modules/groups';
+import Events from './modules/events';
+import Archive from './modules/archive';
+import Site from './modules/site';
+import contextMaps from './modules/contextMaps';
+import Users from './modules/users';
+import Files from './modules/files';
+
+export * from './types/index';
+
+export default class Expert {
+    private globals: ExpertGlobalOptions = {};
+    private _pages?: Pages;
+    private _groups?: Groups;
+    private _site?: Site;
+    private _auth?: auth;
+    private _archive?: Archive;
+    private _events?: Events;
+    private _contextMaps?: contextMaps;
+    private _users?: Users;
+    private _files?: Files;
+
+    constructor(tld?: string) {
+        if (tld) {
+            this.globals.tld = tld;
+        }
+    }
+
+    public get pages(): Pages {
+        if (!this._pages) {
+            this._pages = new pages(this.globals);
+        }
+
+        return this._pages;
+    }
+
+    public get auth(): auth {
+        if (!this._auth) {
+            this._auth = new auth();
+        }
+
+        return this._auth;
+    }
+
+    public get site(): Site {
+        if (!this._site) {
+            this._site = new Site(this.globals);
+        }
+
+        return this._site;
+    }
+
+    public get archive(): Archive {
+        if (!this._archive) {
+            this._archive = new Archive(this.globals);
+        }
+
+        return this._archive;
+    }
+
+    public get groups(): Groups {
+        if (!this._groups) {
+            this._groups = new Groups(this.globals);
+        }
+
+        return this._groups;
+    }
+
+    public get events(): Events {
+        if (!this._events) {
+            this._events = new Events(this.globals);
+        }
+
+        return this._events;
+    }
+
+    public get contextMaps(): contextMaps {
+        if (!this._contextMaps) {
+            this._contextMaps = new contextMaps(this.globals);
+        }
+        return this._contextMaps;
+    }
+
+    public get users(): Users {
+        if (!this._users) {
+            this._users = new Users(this.globals);
+        }
+
+        return this._users;
+    }
+
+    public get files(): Files {
+        if (!this._files) {
+            this._files = new Files(this.globals);
+        }
+
+        return this._files;
+    }
+
+}