confluence.js 1.4.1 → 1.5.0

package/src/api/models/attachment.ts

@@ -0,0 +1,31 @@
+import { AttachmentMetadata } from './attachmentMetadata';
+import { GenericLinks } from './genericLinks';
+
+export interface Attachment {
+  id: string;
+  type: 'attachment' | string;
+  status: 'current' | string;
+  title: string;
+  macroRenderedOutput: any;
+  metadata: AttachmentMetadata;
+  extensions: {
+    mediaType: string;
+    fileSize: number;
+    comment: string;
+    mediaTypeDescription: string;
+    fileId: string;
+  };
+  _expandable: {
+    childTypes: string;
+    operations: string;
+    schedulePublishDate: string;
+    children: string;
+    restrictions: string;
+    history: string;
+    ancestors: string;
+    body: string;
+    descendants: string;
+    space: string;
+  };
+  _links: GenericLinks;
+}

package/src/api/models/attachmentContainer.ts

@@ -0,0 +1,28 @@
+import { GenericLinks } from './genericLinks';
+
+export interface AttachmentContainer {
+  id: string;
+  type: 'page' | 'string';
+  status: 'current' | string;
+  title: string;
+  macroRenderedOutput: any;
+  extensions: {
+    position: number;
+  };
+  _expandable: {
+    container: string;
+    metadata: string;
+    restrictions: string;
+    history:string;
+    body: string;
+    version: string;
+    descendants: string;
+    space: string;
+    childTypes: string;
+    operations: string;
+    schedulePublishDate: string;
+    children: string;
+    ancestors: string;
+  };
+  _links: GenericLinks;
+}

package/src/api/models/attachmentMetadata.ts

@@ -0,0 +1,21 @@
+import { GenericLinks } from './genericLinks';
+
+export interface AttachmentMetadata {
+  comment: string;
+  mediaType: string;
+  labels: {
+    results: string[];
+    start: number;
+    limit: number;
+    size: number;
+    _links: GenericLinks;
+  };
+  _expandable: {
+    currentuser: string;
+    comments: string;
+    simple: string;
+    properties: string;
+    frontend: string;
+    likes: string;
+  };
+}

package/src/api/models/attachmentUpdate.ts

@@ -1,3 +1,4 @@
+/** @deprecated will be removed in second major version */
 export interface AttachmentUpdate {
   /**
    * The attachment version. Set this to the current version number of the attachment. Note, the version number only

package/src/api/models/contentArray.ts

@@ -1,10 +1,10 @@
 import { Content } from './content';
 import { GenericLinks } from './genericLinks';
 
-export interface ContentArray {
-  results: Content[];
-  start: number;
-  limit: number;
+export interface ContentArray<T = Content> {
+  results: T[];
+  start?: number;
+  limit?: number;
   size: number;
   _links: GenericLinks;
 }

package/src/api/models/createdAttachment.ts

@@ -0,0 +1,8 @@
+import { Attachment } from './attachment';
+import { AttachmentContainer } from './attachmentContainer';
+import { Version } from './version';
+
+export interface CreatedAttachment extends Attachment {
+  version: Version;
+  container: AttachmentContainer;
+}

package/src/api/models/genericLinks.ts

@@ -1 +1,12 @@
-export type GenericLinks = Record<string, any>;
+export type GenericLinks = {
+  [key: string]: any;
+
+  self: string;
+  next?: string;
+  tinyui?: string;
+  editui?: string;
+  webui?: string;
+  base?: string;
+  context?: string;
+  download?: string;
+};

package/src/api/models/index.ts

@@ -4,11 +4,14 @@ export * from './accountIdEmailRecordArray';
 export * from './addContentRestriction';
 export * from './addContentRestrictionUpdateArray';
 export * from './affectedObject';
+export * from './attachmentContainer';
 export * from './attachmentUpdate';
 export * from './auditRecord';
 export * from './auditRecordArray';
 export * from './auditRecordCreate';
 export * from './appDescriptor';
+export * from './attachment';
+export * from './attachmentMetadata';
 export * from './blueprintTemplate';
 export * from './blueprintTemplateArray';
 export * from './breadcrumb';
@@ -60,6 +63,7 @@ export * from './copyPageRequest';
 export * from './copyPageRequestDestination';
 export * from './cQLPersonalDataConvertedQueries';
 export * from './cQLPersonalDataMigrationRequest';
+export * from './createdAttachment';
 export * from './deletedSpace';
 export * from './dynamicModulesErrorMessage';
 export * from './embeddable';

package/src/api/parameters/createAttachments.ts

@@ -2,7 +2,17 @@ export interface CreateAttachments {
   /** The ID of the content to add the attachment to. */
   id: string;
   /** The status of the content that the attachment is being added to. */
-  status?: string;
+  status?: 'current' | 'draft' | string;
+  /** The attachments to be created. */
+  attachments: CreateAttachments.Attachment | CreateAttachments.Attachment[];
+}
 
-  [key: string]: any;
+export namespace CreateAttachments {
+  export interface Attachment {
+    file: Buffer | ReadableStream | string | Blob | File | any;
+    filename: string;
+    minorEdit: boolean;
+    contentType?: string;
+    comment?: string;
+  }
 }

package/src/api/parameters/createOrUpdateAttachments.ts

@@ -1,8 +1,11 @@
+import { CreateAttachments } from './createAttachments';
+
 export interface CreateOrUpdateAttachments {
   /** The ID of the content to add the attachment to. */
   id: string;
   /** The status of the content that the attachment is being added to. This should always be set to 'current'. */
-  status?: string;
+  status?: 'current' | 'draft' | string;
 
-  [key: string]: any;
+  /** The attachments to be created or updated. */
+  attachments: CreateAttachments.Attachment | CreateAttachments.Attachment[];
 }

package/src/api/parameters/getAttachments.ts

@@ -2,7 +2,77 @@ export interface GetAttachments {
   /** The ID of the content to be queried for its attachments. */
   id: string;
   /** A multi-value parameter indicating which properties of the content to expand. */
-  expand?: string | string[] | GetAttachments.Expand | GetAttachments.Expand[];
+  expand?:
+  | 'childTypes.all'
+  | 'childTypes.attachment'
+  | 'childTypes.comment'
+  | 'childTypes.page'
+  | 'container'
+  | 'metadata'
+  | 'metadata.currentuser'
+  | 'metadata.properties'
+  | 'metadata.labels'
+  | 'metadata.frontend'
+  | 'operations'
+  | 'children.page'
+  | 'children.attachment'
+  | 'children.comment'
+  | 'restrictions.read.restrictions.user'
+  | 'restrictions.read.restrictions.group'
+  | 'restrictions.update.restrictions.user'
+  | 'restrictions.update.restrictions.group'
+  | 'history'
+  | 'history.lastUpdated'
+  | 'history.previousVersion'
+  | 'history.contributors'
+  | 'history.nextVersion'
+  | 'ancestors'
+  | 'body'
+  | 'version'
+  | 'descendants.page'
+  | 'descendants.attachment'
+  | 'descendants.comment'
+  | 'space'
+  | 'extensions.inlineProperties'
+  | 'extensions.resolution'
+  | (
+    | 'childTypes.all'
+    | 'childTypes.attachment'
+    | 'childTypes.comment'
+    | 'childTypes.page'
+    | 'container'
+    | 'metadata'
+    | 'metadata.currentuser'
+    | 'metadata.properties'
+    | 'metadata.labels'
+    | 'metadata.frontend'
+    | 'operations'
+    | 'children.page'
+    | 'children.attachment'
+    | 'children.comment'
+    | 'restrictions.read.restrictions.user'
+    | 'restrictions.read.restrictions.group'
+    | 'restrictions.update.restrictions.user'
+    | 'restrictions.update.restrictions.group'
+    | 'history'
+    | 'history.lastUpdated'
+    | 'history.previousVersion'
+    | 'history.contributors'
+    | 'history.nextVersion'
+    | 'ancestors'
+    | 'body'
+    | 'version'
+    | 'descendants.page'
+    | 'descendants.attachment'
+    | 'descendants.comment'
+    | 'space'
+    | 'extensions.inlineProperties'
+    | 'extensions.resolution'
+  )[]
+  | string
+  | string[]
+  | GetAttachments.Expand
+  | GetAttachments.Expand[];
   /** The starting index of the returned attachments. */
   start?: number;
   /** The maximum number of attachments to return per page. Note, this may be restricted by fixed system limits. */

package/src/api/parameters/updateAttachmentData.ts

@@ -1,8 +1,11 @@
-import { AttachmentUpdate } from '../models';
+import { CreateAttachments } from './createAttachments';
 
-export interface UpdateAttachmentData extends AttachmentUpdate {
+export interface UpdateAttachmentData {
   /** The ID of the content that the attachment is attached to. */
   id: string;
   /** The ID of the attachment to update. */
   attachmentId: string;
+
+  /** Attachment data to update. */
+  attachment: CreateAttachments.Attachment;
 }

package/src/api/parameters/updateAttachmentProperties.ts

@@ -1,4 +1,15 @@
-import { AttachmentUpdate } from '../models';
+import {
+  AttachmentMetadata,
+  Container,
+  Content,
+  ContentChildren,
+  ContentChildType,
+  ContentHistory,
+  GenericLinks,
+  OperationCheckResult,
+  Space,
+  Version,
+} from '../models';
 
 export interface UpdateAttachmentProperties {
   /** The ID of the content that the attachment is attached to. */
@@ -6,5 +17,51 @@ export interface UpdateAttachmentProperties {
   /** The ID of the attachment to update. */
   attachmentId: string;
 
-  body: AttachmentUpdate;
+  /** @deprecated Use `update` property instead. */
+  body?: UpdateAttachmentProperties.Properties;
+
+  update?: UpdateAttachmentProperties.Properties;
+}
+
+export namespace UpdateAttachmentProperties {
+  export interface Properties {
+    [key: string]: any;
+
+    id: string;
+    type: 'page' | 'blogpost' | 'attachment' | 'content' | string;
+    status: 'current' | 'draft' | string;
+    title?: string;
+    space?: Space;
+    history?: ContentHistory;
+    version: Partial<Version>;
+    ancestors?: Content[];
+    operations?: OperationCheckResult[];
+    children?: ContentChildren;
+    childTypes?: ContentChildType;
+    descendants?: ContentChildren;
+    container?: Container;
+    body?: any;
+    restrictions?: any;
+    metadata?: Partial<AttachmentMetadata>;
+    macroRenderedOutput?: any;
+    extensions?: any;
+    _expandable?: {
+      'childTypes': string;
+      'container': string;
+      'metadata': string;
+      'operations': string;
+      'children': string;
+      'restrictions': string;
+      'history': string;
+      'ancestors': string;
+      'body': string;
+      'version': string;
+      'descendants': string;
+      'space': string;
+      'extensions': string;
+      'schedulePublishDate': string;
+      'macroRenderedOutput': string
+    };
+    _links?: GenericLinks;
+  }
 }

package/src/clients/baseClient.ts

@@ -116,6 +116,8 @@ export class BaseClient implements Client {
 
       return responseHandler(response.data);
     } catch (e: any) {
+      const err = this.config.newErrorHandling && e.isAxiosError ? e.response.data : e;
+
       const callbackErrorHandler = callback && ((error: Config.Error) => callback(error));
       const defaultErrorHandler = (error: Error) => {
         throw error;
@@ -123,9 +125,9 @@ export class BaseClient implements Client {
 
       const errorHandler = callbackErrorHandler ?? defaultErrorHandler;
 
-      this.config.middlewares?.onError?.(e);
+      this.config.middlewares?.onError?.(err);
 
-      return errorHandler(e);
+      return errorHandler(err);
     }
   }
 }

package/src/config.ts

@@ -13,6 +13,8 @@ export interface Config {
    * Adds `'X-Atlassian-Token': 'no-check'` to each request header
    */
   noCheckAtlassianToken?: boolean;
+  /** Enable new API error handling. `false` by default. */
+  newErrorHandling?: boolean;
 }
 
 export namespace Config {

package/src/paramSerializer.ts

@@ -11,5 +11,5 @@ export function paramSerializer(key: string, values?: string | string[]) {
     return '';
   }
 
-  return () => values.map((value) => `${key}=${value}`).join('&');
+  return () => values.map(value => `${key}=${value}`).join('&');
 }