confluence.js 1.2.2 → 1.4.0

package/out/api/users.js

@@ -7,7 +7,7 @@ class Users {
         this.client = client;
     }
     getUser(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/user',
                 method: 'GET',
@@ -18,11 +18,11 @@ class Users {
                     expand: parameters.expand,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getUser' });
+            return this.client.sendRequest(config, callback);
         });
     }
     getAnonymousUser(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/user/anonymous',
                 method: 'GET',
@@ -30,11 +30,11 @@ class Users {
                     expand: parameters === null || parameters === void 0 ? void 0 : parameters.expand,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getAnonymousUser' });
+            return this.client.sendRequest(config, callback);
         });
     }
     getCurrentUser(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/user/current',
                 method: 'GET',
@@ -42,11 +42,11 @@ class Users {
                     expand: parameters === null || parameters === void 0 ? void 0 : parameters.expand,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getCurrentUser' });
+            return this.client.sendRequest(config, callback);
         });
     }
     getGroupMembershipsForUser(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/user/memberof',
                 method: 'GET',
@@ -58,11 +58,11 @@ class Users {
                     limit: parameters.limit,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getGroupMembershipsForUser' });
+            return this.client.sendRequest(config, callback);
         });
     }
     getBulkUserLookup(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/user/bulk',
                 method: 'GET',
@@ -72,11 +72,11 @@ class Users {
                     limit: parameters.limit,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getBulkUserLookup' });
+            return this.client.sendRequest(config, callback);
         });
     }
     getPrivacyUnsafeUserEmail(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/user/email',
                 method: 'GET',
@@ -84,11 +84,11 @@ class Users {
                     accountId: parameters.accountId,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getPrivacyUnsafeUserEmail' });
+            return this.client.sendRequest(config, callback);
         });
     }
     getPrivacyUnsafeUserEmailBulk(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/user/email/bulk',
                 method: 'GET',
@@ -96,11 +96,11 @@ class Users {
                     accountId: parameters.accountId,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getPrivacyUnsafeUserEmailBulk' });
+            return this.client.sendRequest(config, callback);
         });
     }
     getBulkUserMigration(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/api/user/bulk/migration',
                 method: 'GET',
@@ -111,7 +111,7 @@ class Users {
                     limit: parameters.limit,
                 },
             };
-            return this.client.sendRequest(config, callback, { methodName: 'getBulkUserMigration' });
+            return this.client.sendRequest(config, callback);
         });
     }
 }

package/out/clients/baseClient.d.ts

@@ -1,19 +1,16 @@
-import { Telemetry } from 'telemetry.confluence.js';
-import type { Client } from './client';
 import type { Callback } from '../callback';
+import type { Client } from './client';
 import type { Config } from '../config';
 import type { RequestConfig } from '../requestConfig';
 export declare class BaseClient implements Client {
     #private;
     protected readonly config: Config;
-    private telemetryClient;
     protected urlSuffix: string;
     constructor(config: Config);
     protected paramSerializer(parameters: Record<string, any>): string;
     protected encode(value: string): string;
     protected removeUndefinedProperties(obj: Record<string, any>): Record<string, any>;
     private get instance();
-    sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: Partial<Telemetry>): Promise<T>;
-    sendRequest<T>(requestConfig: RequestConfig, callback: Callback<T>, telemetryData?: Partial<Telemetry>): Promise<void>;
-    private get authenticationType();
+    sendRequest<T>(requestConfig: RequestConfig, callback: never, telemetryData?: any): Promise<T>;
+    sendRequest<T>(requestConfig: RequestConfig, callback: Callback<T>, telemetryData?: any): Promise<void>;
 }

package/out/clients/baseClient.js

@@ -3,9 +3,8 @@ var _BaseClient_instance;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseClient = void 0;
 const tslib_1 = require("tslib");
-const axios_1 = require("axios");
-const telemetry_confluence_js_1 = require("telemetry.confluence.js");
 const authenticationService_1 = require("../services/authenticationService");
+const axios_1 = require("axios");
 const ATLASSIAN_TOKEN_CHECK_FLAG = 'X-Atlassian-Token';
 const ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE = 'no-check';
 class BaseClient {
@@ -13,13 +12,12 @@ class BaseClient {
         this.config = config;
         _BaseClient_instance.set(this, void 0);
         this.urlSuffix = '/wiki/rest/';
-        this.telemetryClient = new telemetry_confluence_js_1.TelemetryClient(config.telemetry);
     }
     paramSerializer(parameters) {
         const parts = [];
         Object.entries(parameters).forEach(([key, value]) => {
             if (value === null || typeof value === 'undefined') {
-                return undefined;
+                return;
             }
             if (Array.isArray(value)) {
                 // eslint-disable-next-line no-param-reassign
@@ -33,8 +31,12 @@ class BaseClient {
                 // eslint-disable-next-line no-param-reassign
                 value = JSON.stringify(value);
             }
+            else if (value instanceof Function) {
+                const part = value();
+                return part && parts.push(part);
+            }
             parts.push(`${this.encode(key)}=${this.encode(value)}`);
-            return undefined;
+            return;
         });
         return parts.join('&');
     }
@@ -54,17 +56,15 @@ class BaseClient {
     }
     get instance() {
         var _a;
-        if ((0, tslib_1.__classPrivateFieldGet)(this, _BaseClient_instance, "f")) {
-            return (0, tslib_1.__classPrivateFieldGet)(this, _BaseClient_instance, "f");
+        if (tslib_1.__classPrivateFieldGet(this, _BaseClient_instance, "f")) {
+            return tslib_1.__classPrivateFieldGet(this, _BaseClient_instance, "f");
         }
-        (0, tslib_1.__classPrivateFieldSet)(this, _BaseClient_instance, axios_1.default.create(Object.assign(Object.assign({ paramsSerializer: this.paramSerializer.bind(this) }, this.config.baseRequestConfig), { baseURL: `${this.config.host}${this.urlSuffix}`, headers: this.removeUndefinedProperties(Object.assign({ [ATLASSIAN_TOKEN_CHECK_FLAG]: this.config.noCheckAtlassianToken ? ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE : undefined }, (_a = this.config.baseRequestConfig) === null || _a === void 0 ? void 0 : _a.headers)) })), "f");
-        return (0, tslib_1.__classPrivateFieldGet)(this, _BaseClient_instance, "f");
+        tslib_1.__classPrivateFieldSet(this, _BaseClient_instance, axios_1.default.create(Object.assign(Object.assign({ paramsSerializer: this.paramSerializer.bind(this) }, this.config.baseRequestConfig), { baseURL: `${this.config.host}${this.urlSuffix}`, headers: this.removeUndefinedProperties(Object.assign({ [ATLASSIAN_TOKEN_CHECK_FLAG]: this.config.noCheckAtlassianToken ? ATLASSIAN_TOKEN_CHECK_NOCHECK_VALUE : undefined }, (_a = this.config.baseRequestConfig) === null || _a === void 0 ? void 0 : _a.headers)) })), "f");
+        return tslib_1.__classPrivateFieldGet(this, _BaseClient_instance, "f");
     }
-    sendRequest(requestConfig, callback, telemetryData) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
-            const startDateTime = new Date();
-            const telemetry = Object.assign({ authentication: this.authenticationType, baseRequestConfigUsed: !!this.config.baseRequestConfig, bodyExists: !!requestConfig.data, callbackUsed: !!callback, headersExists: !!requestConfig.headers, libVersion: '1.2.2', libVersionHash: 'bda9643ac6601722a28f238714274da4', methodName: (telemetryData === null || telemetryData === void 0 ? void 0 : telemetryData.methodName) || 'sendRequest', onErrorMiddlewareUsed: !!((_a = this.config.middlewares) === null || _a === void 0 ? void 0 : _a.onError), onResponseMiddlewareUsed: !!((_b = this.config.middlewares) === null || _b === void 0 ? void 0 : _b.onResponse), queryExists: !!requestConfig.params, requestEndTime: new Date(), requestStartTime: startDateTime, requestStatusCode: 0, noCheckAtlassianToken: !!this.config.noCheckAtlassianToken }, telemetryData);
+    sendRequest(requestConfig, callback) {
+        var _a, _b, _c, _d;
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             try {
                 const modifiedRequestConfig = Object.assign(Object.assign({}, requestConfig), { headers: this.removeUndefinedProperties(Object.assign({ Authorization: yield authenticationService_1.AuthenticationService.getAuthenticationToken(this.config.authentication, {
                             baseURL: this.config.host,
@@ -75,8 +75,7 @@ class BaseClient {
                 const callbackResponseHandler = callback && ((data) => callback(null, data));
                 const defaultResponseHandler = (data) => data;
                 const responseHandler = callbackResponseHandler !== null && callbackResponseHandler !== void 0 ? callbackResponseHandler : defaultResponseHandler;
-                (_d = (_c = this.config.middlewares) === null || _c === void 0 ? void 0 : _c.onResponse) === null || _d === void 0 ? void 0 : _d.call(_c, response.data);
-                telemetry.requestStatusCode = response.status;
+                (_b = (_a = this.config.middlewares) === null || _a === void 0 ? void 0 : _a.onResponse) === null || _b === void 0 ? void 0 : _b.call(_a, response.data);
                 return responseHandler(response.data);
             }
             catch (e) {
@@ -85,32 +84,11 @@ class BaseClient {
                     throw error;
                 };
                 const errorHandler = callbackErrorHandler !== null && callbackErrorHandler !== void 0 ? callbackErrorHandler : defaultErrorHandler;
-                (_f = (_e = this.config.middlewares) === null || _e === void 0 ? void 0 : _e.onError) === null || _f === void 0 ? void 0 : _f.call(_e, e);
-                telemetry.requestStatusCode = e.isAxiosError ? (_h = (_g = e.response) === null || _g === void 0 ? void 0 : _g.status) !== null && _h !== void 0 ? _h : 0 : 418;
+                (_d = (_c = this.config.middlewares) === null || _c === void 0 ? void 0 : _c.onError) === null || _d === void 0 ? void 0 : _d.call(_c, e);
                 return errorHandler(e);
             }
-            finally {
-                telemetry.requestEndTime = new Date();
-                this.telemetryClient.sendTelemetry(telemetry);
-            }
         });
     }
-    get authenticationType() {
-        const { authentication } = this.config;
-        if (!authentication) {
-            return telemetry_confluence_js_1.Authentication.None;
-        }
-        if (authentication.basic) {
-            return telemetry_confluence_js_1.Authentication.Basic;
-        }
-        if (authentication.oauth2) {
-            return telemetry_confluence_js_1.Authentication.OAuth2;
-        }
-        if (authentication.jwt) {
-            return telemetry_confluence_js_1.Authentication.JWT;
-        }
-        return telemetry_confluence_js_1.Authentication.NA;
-    }
 }
 exports.BaseClient = BaseClient;
 _BaseClient_instance = new WeakMap();

package/out/clients/client.d.ts

@@ -1,7 +1,6 @@
-import type { Telemetry } from 'telemetry.confluence.js';
 import type { Callback } from '../callback';
 import type { RequestConfig } from '../requestConfig';
 export interface Client {
-    sendRequest<T>(requestConfig: RequestConfig, callback?: never, telemetryData?: Partial<Telemetry>): Promise<T>;
-    sendRequest<T>(requestConfig: RequestConfig, callback?: Callback<T>, telemetryData?: Partial<Telemetry>): Promise<void>;
+    sendRequest<T>(requestConfig: RequestConfig, callback?: never, telemetryData?: any): Promise<T>;
+    sendRequest<T>(requestConfig: RequestConfig, callback?: Callback<T>, telemetryData?: any): Promise<void>;
 }

package/out/clients/confluenceClient.d.ts

@@ -1,12 +1,14 @@
 import { BaseClient } from './baseClient';
-import { Audit, Content, ContentAttachments, ContentBody, ContentChildrenAndDescendants, ContentComments, ContentLabels, ContentMacroBody, ContentPermissions, ContentProperties, ContentRestrictions, ContentVersions, ContentWatches, DynamicModules, Experimental, Group, InlineTasks, LabelInfo, LongRunningTask, Relation, Search, Settings, Space, SpacePermissions, SpaceProperties, SpaceSettings, Template, Themes, Users } from '../api';
+import { Analytics, Audit, Content, ContentAttachments, ContentBody, ContentChildrenAndDescendants, ContentComments, ContentContentState, ContentLabels, ContentMacroBody, ContentPermissions, ContentProperties, ContentRestrictions, ContentVersions, ContentWatches, DynamicModules, Experimental, Group, InlineTasks, LabelInfo, LongRunningTask, Relation, Search, Settings, Space, SpacePermissions, SpaceProperties, SpaceSettings, Template, Themes, Users } from '../api';
 export declare class ConfluenceClient extends BaseClient {
+    analytics: Analytics;
     audit: Audit;
     content: Content;
     contentAttachments: ContentAttachments;
     contentBody: ContentBody;
     contentChildrenAndDescendants: ContentChildrenAndDescendants;
     contentComments: ContentComments;
+    contentContentState: ContentContentState;
     contentLabels: ContentLabels;
     contentMacroBody: ContentMacroBody;
     contentPermissions: ContentPermissions;

package/out/clients/confluenceClient.js

@@ -6,12 +6,14 @@ const api_1 = require("../api");
 class ConfluenceClient extends baseClient_1.BaseClient {
     constructor() {
         super(...arguments);
+        this.analytics = new api_1.Analytics(this);
         this.audit = new api_1.Audit(this);
         this.content = new api_1.Content(this);
         this.contentAttachments = new api_1.ContentAttachments(this);
         this.contentBody = new api_1.ContentBody(this);
         this.contentChildrenAndDescendants = new api_1.ContentChildrenAndDescendants(this);
         this.contentComments = new api_1.ContentComments(this);
+        this.contentContentState = new api_1.ContentContentState(this);
         this.contentLabels = new api_1.ContentLabels(this);
         this.contentMacroBody = new api_1.ContentMacroBody(this);
         this.contentPermissions = new api_1.ContentPermissions(this);

package/out/clients/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./baseClient"), exports);
-(0, tslib_1.__exportStar)(require("./client"), exports);
-(0, tslib_1.__exportStar)(require("./confluenceClient"), exports);
-(0, tslib_1.__exportStar)(require("./serverClient"), exports);
+tslib_1.__exportStar(require("./baseClient"), exports);
+tslib_1.__exportStar(require("./client"), exports);
+tslib_1.__exportStar(require("./confluenceClient"), exports);
+tslib_1.__exportStar(require("./serverClient"), exports);

package/out/config.d.ts

@@ -1,5 +1,4 @@
 import { AxiosError } from 'axios';
-import type { TelemetryConfig } from 'telemetry.confluence.js';
 import type { RequestConfig } from './requestConfig';
 import type { UtilityTypes } from './utilityTypes';
 export interface Config {
@@ -7,6 +6,7 @@ export interface Config {
     baseRequestConfig?: Config.BaseRequestConfig;
     authentication?: Config.Authentication;
     middlewares?: Config.Middlewares;
+    /** @deprecated Disabled. Will be removed in the next major version. */
     telemetry?: Config.Telemetry;
     /**
      * Adds `'X-Atlassian-Token': 'no-check'` to each request header
@@ -16,14 +16,17 @@ export interface Config {
 export declare namespace Config {
     type BaseRequestConfig = RequestConfig;
     type Error = AxiosError;
-    type Telemetry = boolean | TelemetryConfig;
+    /** @deprecated Disabled. Will be removed in the next major version. */
+    type Telemetry = boolean | any;
     type Authentication = UtilityTypes.XOR<{
         jwt: Authentication.JWT;
+    }, UtilityTypes.XOR<{
+        personalAccessToken: Authentication.PersonalAccessToken;
     }, UtilityTypes.XOR<{
         basic: Authentication.Basic;
     }, {
         oauth2: Authentication.OAuth2;
-    }>>;
+    }>>>;
     interface Middlewares {
         onError?: Config.Middlewares.OnErrorHandler;
         onResponse?: Config.Middlewares.OnResponseHandler;
@@ -33,10 +36,11 @@ export declare namespace Config {
         type OnResponseHandler = (data: any) => void;
     }
     namespace Authentication {
+        type PersonalAccessToken = string;
         type JWT = {
             /** The key from the app descriptor. */
             issuer: string;
-            /** The sharedsecret key received during the app installation handshake */
+            /** The shared secret key received during the app installation handshake */
             secret: string;
             /** Token expiry time (default 3 minutes after issuing) */
             expiryTimeSeconds?: number;

package/out/index.js

@@ -2,10 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Parameters = exports.Models = exports.Server = exports.Api = void 0;
 const tslib_1 = require("tslib");
-(0, tslib_1.__exportStar)(require("./clients"), exports);
-(0, tslib_1.__exportStar)(require("./config"), exports);
-(0, tslib_1.__exportStar)(require("./requestConfig"), exports);
-(0, tslib_1.__exportStar)(require("./callback"), exports);
+tslib_1.__exportStar(require("./clients"), exports);
+tslib_1.__exportStar(require("./config"), exports);
+tslib_1.__exportStar(require("./requestConfig"), exports);
+tslib_1.__exportStar(require("./callback"), exports);
 exports.Api = require("./api");
 exports.Server = require("./server");
 exports.Models = require("./api/models");

package/out/paramSerializer.d.ts

@@ -0,0 +1 @@
+export declare function paramSerializer(key: string, values?: string | string[]): "" | (() => string) | undefined;

package/out/paramSerializer.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paramSerializer = void 0;
+function paramSerializer(key, values) {
+    if (typeof values === 'string') {
+        return () => `${key}=${values}`;
+    }
+    if (!values) {
+        return undefined;
+    }
+    if (!values.length) {
+        return '';
+    }
+    return () => values.map((value) => `${key}=${value}`).join('&');
+}
+exports.paramSerializer = paramSerializer;

package/out/server/audit.d.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
 export declare class Audit {
     private client;

package/out/server/audit.js

@@ -7,7 +7,7 @@ class Audit {
         this.client = client;
     }
     getAuditRecords(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/rest/api/audit',
                 method: 'GET',
@@ -23,7 +23,7 @@ class Audit {
         });
     }
     createAuditRecord(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/rest/api/audit',
                 method: 'POST',
@@ -44,7 +44,7 @@ class Audit {
         });
     }
     exportAuditRecords(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/rest/api/audit/export',
                 method: 'GET',
@@ -59,7 +59,7 @@ class Audit {
         });
     }
     getRetentionPeriod(callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/rest/api/audit/retention',
                 method: 'GET',
@@ -68,7 +68,7 @@ class Audit {
         });
     }
     setRetentionPeriod(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/rest/api/audit/retention',
                 method: 'PUT',
@@ -81,7 +81,7 @@ class Audit {
         });
     }
     getAuditRecordsForTimePeriod(parameters, callback) {
-        return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const config = {
                 url: '/rest/api/audit/since',
                 method: 'GET',

package/out/server/content.d.ts

@@ -1,7 +1,7 @@
 import * as Models from './models';
 import * as Parameters from './parameters';
-import { Client } from '../clients';
 import { Callback } from '../callback';
+import { Client } from '../clients';
 import { Pagination } from '../pagination';
 export declare class Content {
     private client;