confluence.js 1.7.4 → 2.0.0-dev20250512104821

package/src/server/models/longTaskStatus.ts

@@ -1,40 +0,0 @@
-import { Message } from './message';
-
-/**
- * Current status of a long running task
- *
- * Status keys:
- *
- * - `ERROR_UNKNOWN` - Generic error
- * - `ERROR_LOCK_FAILED` - Could not get the lock on destination space
- * - `ERROR_RELINK` - Error when relink pages/attachments
- * - `ERROR_COPY_PAGE` - Error while copying 1 page
- * - `WARN_RENAME_PAGE` - Warning page is rename during copy
- * - `WARN_IGNORE_COPY_PERMISSION` - Warning could not copy permission
- * - `WARN_IGNORE_COPY_ATTACHMENT` - Warning could not copy attachment
- * - `WARN_IGNORE_DELETE_PAGE` - Warning ignoring delete of a non agreed on page
- * - `STATUS_COPIED_PAGES` - Message total pages are copied
- * - `STATUS_COPYING_PAGES` - Message copy pages
- * - `STATUS_RELINK_PAGES` - Message relink pages/attachments
- * - `STATUS_DELETING_PAGES` - Message delete pages
- * - `STATUS_DELETED_PAGES` - Message total pages are deleted
- * - `STATUS_MOVING_PAGES` - Message move pages
- * - `WARN_IGNORE_VIEW_RESTRICTED` - Permission changed - view restricted
- * - `WARN_IGNORE_EDIT_RESTRICTED` - Permission changed - edit restricted
- * - `INITIALIZING_TASK` - Message when initializing task
- * - `UNKNOWN_STATUS` - Message when status is unknown
- */
-export interface LongTaskStatus {
-  id: string;
-  name: {
-    key: string;
-    args: {}[];
-  };
-  elapsedTime: number;
-  percentageComplete: number;
-  successful: boolean;
-  messages: Message[];
-  status?: string;
-  errors?: Message[];
-  additionalDetails?: {};
-}

package/src/server/models/lookAndFeel.ts

@@ -1,18 +0,0 @@
-import { ContentLookAndFeel } from './contentLookAndFeel';
-import { HeaderLookAndFeel } from './headerLookAndFeel';
-import { MenusLookAndFeel } from './menusLookAndFeel';
-
-export interface LookAndFeel {
-  headings: {
-    color: string;
-  };
-  links: {
-    color: string;
-  };
-  menus: MenusLookAndFeel;
-  header: HeaderLookAndFeel;
-  content: ContentLookAndFeel;
-  bordersAndDividers: {
-    color: string;
-  };
-}

package/src/server/models/lookAndFeelSelection.ts

@@ -1,6 +0,0 @@
-/** Look and feel selection */
-export interface LookAndFeelSelection {
-  /** The key of the space for which the look and feel settings will be set. */
-  spaceKey: string;
-  lookAndFeelType: string;
-}

package/src/server/models/lookAndFeelSettings.ts

@@ -1,8 +0,0 @@
-import { LookAndFeel } from './lookAndFeel';
-
-export interface LookAndFeelSettings {
-  selected: string;
-  global: LookAndFeel;
-  theme?: LookAndFeel;
-  custom: LookAndFeel;
-}

package/src/server/models/lookAndFeelUpdated.ts

@@ -1,6 +0,0 @@
-import { LookAndFeel } from './lookAndFeel';
-
-/** Look and feel settings returned after an update. */
-export interface LookAndFeelUpdated extends LookAndFeel {
-  _links: Record<string, any>;
-}

package/src/server/models/macroInstance.ts

@@ -1 +0,0 @@
-export interface MacroInstance {}

package/src/server/models/menusLookAndFeel.ts

@@ -1,6 +0,0 @@
-export interface MenusLookAndFeel {
-  hoverOrFocus: {
-    backgroundColor: string;
-  };
-  color: string;
-}

package/src/server/models/message.ts

@@ -1,4 +0,0 @@
-export interface Message {
-  translation: string;
-  args: Record<string, any>[];
-}

package/src/server/models/navigationLookAndFeel.ts

@@ -1,7 +0,0 @@
-export interface NavigationLookAndFeel {
-  color: string;
-  hoverOrFocus: {
-    backgroundColor: string;
-    color: string;
-  };
-}

package/src/server/models/operationCheckResult.ts

@@ -1,7 +0,0 @@
-/** An operation and the target entity that it applies to, e.g. create page. */
-export interface OperationCheckResult {
-  /** The operation itself. */
-  operation: string;
-  /** The space or content type that the operation applies to. */
-  targetType: string;
-}

package/src/server/models/propertyValue.ts

@@ -1 +0,0 @@
-export interface PropertyValue {}

package/src/server/models/restrictionsByOperation.ts

@@ -1,3 +0,0 @@
-export interface RestrictionsByOperation {
-  _links: Record<string, any>;
-}

package/src/server/models/retentionPeriod.ts

@@ -1,6 +0,0 @@
-export interface RetentionPeriod {
-  /** The number of units for the retention period. */
-  number: number;
-  /** The unit of time that the retention period is measured in. */
-  units: string;
-}

package/src/server/models/screenLookAndFeel.ts

@@ -1,10 +0,0 @@
-export interface ScreenLookAndFeel {
-  background: string;
-  backgroundColor: string;
-  backgroundImage: string;
-  backgroundSize: string;
-  gutterTop: string;
-  gutterRight: string;
-  gutterBottom: string;
-  gutterLeft: string;
-}

package/src/server/models/searchFieldLookAndFeel.ts

@@ -1,4 +0,0 @@
-export interface SearchFieldLookAndFeel {
-  backgroundColor: string;
-  color: string;
-}

package/src/server/models/searchResult.ts

@@ -1,17 +0,0 @@
-import { Breadcrumb } from './breadcrumb';
-import { ContainerSummary } from './containerSummary';
-import { Content } from './content';
-
-export interface SearchResult {
-  content: Content;
-  title: string;
-  excerpt: string;
-  url: string;
-  resultParentContainer: ContainerSummary;
-  resultGlobalContainer: ContainerSummary;
-  breadcrumbs: Breadcrumb[];
-  entityType: string;
-  iconCssClass: string;
-  lastModified: string;
-  friendlyLastModified: string;
-}

package/src/server/models/space.ts

@@ -1,47 +0,0 @@
-import { Content } from './content';
-import { Icon } from './icon';
-import { LabelArray } from './labelArray';
-import { LookAndFeel } from './lookAndFeel';
-import { OperationCheckResult } from './operationCheckResult';
-import { SpaceDescription } from './spaceDescription';
-import { SpacePermission } from './spacePermission';
-import { SpaceSettings } from './spaceSettings';
-import { Theme } from './theme';
-
-export interface Space {
-  id: number;
-  key: string;
-  name: string;
-  icon?: Icon;
-  description?: {
-    plain?: SpaceDescription;
-    view?: SpaceDescription;
-  };
-  homepage?: Content;
-  type: string;
-  metadata?: {
-    labels: LabelArray;
-  };
-  operations?: OperationCheckResult[];
-  permissions?: SpacePermission[];
-  status: string;
-  settings?: SpaceSettings;
-  theme?: Theme;
-  lookAndFeel?: LookAndFeel;
-  history?: {
-    createdDate: string;
-  };
-  _expandable: {
-    settings?: string;
-    metadata?: string;
-    operations?: string;
-    lookAndFeel?: string;
-    permissions?: string;
-    icon?: string;
-    description?: string;
-    theme?: string;
-    history?: string;
-    homepage?: string;
-  };
-  _links: Record<string, any>;
-}

package/src/server/models/spaceDescription.ts

@@ -1,5 +0,0 @@
-export interface SpaceDescription {
-  value: string;
-  representation: string;
-  embeddedContent: {}[];
-}

package/src/server/models/spaceDescriptionCreate.ts

@@ -1,12 +0,0 @@
-/**
- * The description of the new/updated space. Note, only the 'plain' representation* can be used for the description when
- * creating or updating a space.
- */
-export interface SpaceDescriptionCreate {
-  plain: {
-    /** The space description. */
-    value?: string;
-    /** Set to 'plain'. */
-    representation?: string;
-  };
-}

package/src/server/models/spacePermission.ts

@@ -1,38 +0,0 @@
-import { Group } from './group';
-import { OperationCheckResult } from './operationCheckResult';
-import { User } from './user';
-
-/**
- * This object represents a permission for given space. Permissions consist of* at least one operation object with an
- * accompanying subjects object.
- *
- * The following combinations of `operation` and `targetType` values are valid for the `operation` object:
- *
- * - 'create': 'page', 'blogpost', 'comment', 'attachment'
- * - 'read': 'space'
- * - 'delete': 'page', 'blogpost', 'comment', 'attachment'
- * - 'export': 'space'
- * - 'administer': 'space'
- */
-export interface SpacePermission {
-  /** The users and/or groups that the permission applies to. */
-  subjects: {
-    user?: {
-      results: User[];
-      size: number;
-    };
-    group?: {
-      results: Group[];
-      size: number;
-    };
-    _expandable: {
-      user?: string;
-      group?: string;
-    };
-  };
-  operation: OperationCheckResult;
-  /** Grant anonymous users permission to use the operation. */
-  anonymousAccess: boolean;
-  /** Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation. */
-  unlicensedAccess: boolean;
-}

package/src/server/models/spaceProperty.ts

@@ -1,18 +0,0 @@
-import { Space } from './space';
-
-export interface SpaceProperty {
-  id: number;
-  key: string;
-  value: {};
-  version?: {
-    when: string;
-    message: string;
-    number: number;
-    minorEdit: boolean;
-  };
-  space?: Space;
-  _expandable: {
-    version?: string;
-    space?: string;
-  };
-}

package/src/server/models/spaceSettings.ts

@@ -1,10 +0,0 @@
-export interface SpaceSettings {
-  /**
-   * Defines whether an override for the space home should be used. This is used in conjunction with a space theme
-   * provided by an app. For example, if this property is set to true, a theme can display a page other than the space
-   * homepage when users visit the root URL for a space. This property allows apps to provide content-only theming
-   * without overriding the space home.
-   */
-  routeOverrideEnabled: boolean;
-  _links: Record<string, any>;
-}

package/src/server/models/superBatchWebResources.ts

@@ -1,14 +0,0 @@
-export interface SuperBatchWebResources {
-  uris?: {
-    all?: string;
-    css?: string;
-    js?: string;
-  };
-  tags?: {
-    all?: string;
-    css?: string;
-    data?: string;
-    js?: string;
-  };
-  metatags?: string;
-}

package/src/server/models/theme.ts

@@ -1,5 +0,0 @@
-import { ThemeNoLinks } from './themeNoLinks';
-
-export interface Theme extends ThemeNoLinks {
-  _links: Record<string, any>;
-}

package/src/server/models/themeNoLinks.ts

@@ -1,9 +0,0 @@
-import { Icon } from './icon';
-
-/** Theme object without links. Used in ThemeArray. */
-export interface ThemeNoLinks {
-  themeKey: string;
-  name: string;
-  description: string;
-  icon: Icon;
-}

package/src/server/models/user.ts

@@ -1,41 +0,0 @@
-import { Icon } from './icon';
-import { OperationCheckResult } from './operationCheckResult';
-import { Space } from './space';
-import { UserDetails } from './userDetails';
-
-export interface User {
-  type: string;
-  /**
-   * This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See
-   * the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
-   */
-  username?: string;
-  /**
-   * This property is no longer available and will be removed from the documentation soon. Use `accountId` instead. See
-   * the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
-   */
-  userKey?: string;
-  /**
-   * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example,
-   * `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
-   */
-  accountId: string;
-  /** The account type of the user, may return empty string if unavailable. */
-  accountType: string;
-  /** The email address of the user. Depending on the user's privacy setting, this may return an empty string. */
-  email: string;
-  /** The public name or nickname of the user. Will always contain a value. */
-  publicName: string;
-  profilePicture: Icon;
-  /** The display name of the user. Depending on the user's privacy setting, this may be the same as publicName. */
-  displayName: string;
-  operations?: OperationCheckResult[];
-  details?: UserDetails;
-  personalSpace?: Space;
-  _expandable: {
-    operations?: string;
-    details?: string;
-    personalSpace?: string;
-  };
-  _links: Record<string, any>;
-}

package/src/server/models/userAnonymous.ts

@@ -1,13 +0,0 @@
-import { Icon } from './icon';
-import { OperationCheckResult } from './operationCheckResult';
-
-export interface UserAnonymous {
-  type: string;
-  profilePicture: Icon;
-  displayName: string;
-  operations?: OperationCheckResult[];
-  _expandable: {
-    operations?: string;
-  };
-  _links: Record<string, any>;
-}

package/src/server/models/userArray.ts

@@ -1,8 +0,0 @@
-import { User } from './user';
-
-export interface UserArray {
-  results: User[];
-  start: number;
-  limit: number;
-  size: number;
-}

package/src/server/models/userDetails.ts

@@ -1,49 +0,0 @@
-export interface UserDetails {
-  business?: {
-    /**
-     * @deprecated This property has been deprecated due to privacy changes. There is no replacement. See the [migration
-     *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
-     *   for details.
-     */
-    position?: string;
-    /**
-     * @deprecated This property has been deprecated due to privacy changes. There is no replacement. See the [migration
-     *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
-     *   for details.
-     */
-    department?: string;
-    /**
-     * @deprecated This property has been deprecated due to privacy changes. There is no replacement. See the [migration
-     *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
-     *   for details.
-     */
-    location?: string;
-  };
-  personal?: {
-    /**
-     * @deprecated This property has been deprecated due to privacy changes. There is no replacement. See the [migration
-     *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
-     *   for details.
-     */
-    phone?: string;
-    /**
-     * @deprecated This property has been deprecated due to privacy changes. There is no replacement. See the [migration
-     *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
-     *   for details.
-     */
-    im?: string;
-    /**
-     * @deprecated This property has been deprecated due to privacy changes. There is no replacement. See the [migration
-     *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
-     *   for details.
-     */
-    website?: string;
-    /**
-     * @deprecated This property has been deprecated due to privacy changes. Use the `User.email` property instead. See
-     *   the [migration
-     *   guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
-     *   for details.
-     */
-    email?: string;
-  };
-}

package/src/server/models/userWatch.ts

@@ -1,3 +0,0 @@
-export interface UserWatch {
-  watching: boolean;
-}

package/src/server/models/usersUserKeys.ts

@@ -1,7 +0,0 @@
-import { User } from './user';
-
-export interface UsersUserKeys {
-  users: User[];
-  userKeys: string[];
-  _links?: Record<string, any>;
-}

package/src/server/models/version.ts

@@ -1,19 +0,0 @@
-import { Content } from './content';
-import { User } from './user';
-import { UsersUserKeys } from './usersUserKeys';
-
-export interface Version {
-  by: User;
-  when: string;
-  friendlyWhen: string;
-  message: string;
-  number: number;
-  minorEdit: boolean;
-  content?: Content;
-  collaborators?: UsersUserKeys;
-  _expandable: {
-    content: string;
-    collaborators: string;
-  };
-  _links: Record<string, any>;
-}

package/src/server/models/webResourceDependencies.ts

@@ -1,18 +0,0 @@
-import { SuperBatchWebResources } from './superBatchWebResources';
-
-export interface WebResourceDependencies {
-  keys?: string[];
-  contexts?: string[];
-  uris?: {
-    all?: string;
-    css?: string;
-    js?: string;
-  };
-  tags?: {
-    all?: string;
-    css?: string;
-    data?: string;
-    js?: string;
-  };
-  superbatch?: SuperBatchWebResources;
-}

package/src/server/parameters/addContentWatcher.ts

@@ -1,7 +0,0 @@
-export interface AddContentWatcher {
-  contentId: string;
-  /** Userkey of the user to create the new watcher for */
-  key?: string;
-  /** Username of the user to create the new watcher for */
-  username?: string;
-}

package/src/server/parameters/addLabelsToContent.ts

@@ -1,8 +0,0 @@
-import { LabelCreate } from '../models';
-
-export interface AddLabelsToContent {
-  /** The ID of the content that will have labels added to it. */
-  id: string;
-
-  labels: LabelCreate[];
-}

package/src/server/parameters/addSpaceWatch.ts

@@ -1,7 +0,0 @@
-export interface AddSpaceWatch {
-  spaceKey: string;
-  /** UserKey of the user to create the new watcher for */
-  key?: string;
-  /** UserName of the user to create the new watcher for */
-  username?: string;
-}

package/src/server/parameters/convertContentBody.ts

@@ -1,48 +0,0 @@
-export interface ConvertContentBody {
-  /** The name of the target format for the content body. */
-  to: string;
-
-  storage?: any;
-  editor?: any;
-  view?: any;
-  exportView?: any;
-  styledView?: any;
-
-  /**
-   * A multi-value parameter indicating which properties of the content to expand. Expands are dependent on the to
-   * conversion format and may be irrelevant for certain conversions (e.g. macroRenderedOutput is redundant when
-   * converting to view format).
-   *
-   * - `webresource` returns JS and CSS resources necessary for displaying nested content in `view` format
-   * - `webresource.superbatch.uris.js` returns all common JS dependencies
-   * - `webresource.superbatch.uris.css` returns all common CSS dependencies
-   * - `webresource.uris.js` returns JS dependencies specific to conversion
-   * - `webresource.uris.css` returns CSS dependencies specific to conversion
-   * - `embeddedContent` returns metadata for nested content (e.g. page included using page include macro)
-   * - `mediaToken` returns JWT token for retrieving attachment data from Media API
-   * - `macroRenderedOutput` additionally converts body to view format
-   */
-  expand?:
-    | 'webresource'
-    | 'webresource.superbatch.uris.js'
-    | 'webresource.superbatch.uris.css'
-    | 'webresource.uris.js'
-    | 'webresource.uris.css'
-    | 'embeddedContent'
-    | 'mediaToken'
-    | 'macroRenderedOutput'
-    | (
-        | 'webresource'
-        | 'webresource.superbatch.uris.js'
-        | 'webresource.superbatch.uris.css'
-        | 'webresource.uris.js'
-        | 'webresource.uris.css'
-        | 'embeddedContent'
-        | 'mediaToken'
-        | 'macroRenderedOutput'
-      )[]
-    | string
-    | string[];
-
-  [key: string]: any;
-}

package/src/server/parameters/createAttachments.ts

@@ -1,7 +0,0 @@
-export interface CreateAttachments {
-  id: string | number;
-  /** A string containing the status of the attachments content container, supports current or draft, defaults to current */
-  status?: string;
-
-  [key: string]: any;
-}

package/src/server/parameters/createAuditRecord.ts

@@ -1,47 +0,0 @@
-import { AffectedObject, ChangedValue } from '../models';
-
-export interface CreateAuditRecord {
-  /**
-   * The user that actioned the event. If `author` is not specified, then all `author` properties will be set to
-   * null/empty, except for `type` which will be set to 'user'.
-   */
-  author?: {
-    /** Set to 'user'. */
-    type: string;
-    /** The name that is displayed on the audit log in the Confluence UI. */
-    displayName?: string;
-    /** Always defaults to null. */
-    operations?: {};
-    /** This property has been deprecated and will be removed soon. */
-    username?: string;
-    /** This property has been deprecated and will be removed soon. */
-    userKey?: string;
-  };
-  /** The IP address of the computer where the event was initiated from. */
-  remoteAddress: string;
-  /**
-   * The creation date-time of the audit record, as a timestamp. This is converted to a date-time display in the
-   * Confluence UI. If the `creationDate` is not specified, then it will be set to the timestamp for the current
-   * date-time.
-   */
-  creationDate?: number;
-  /** The summary of the event, which is displayed in the 'Change' column on the audit log in the Confluence UI. */
-  summary?: string;
-  /**
-   * A long description of the event, which is displayed in the 'Description' field on the audit log in the Confluence
-   * UI.
-   */
-  description?: string;
-  /** The category of the event, which is displayed in the 'Event type' column on the audit log in the Confluence UI. */
-  category?: string;
-  /** Indicates whether the event was actioned by a system administrator. */
-  sysAdmin?: boolean;
-  affectedObject?: AffectedObject;
-  /** The values that were changed in the event. */
-  changedValues?: ChangedValue[];
-  /**
-   * Objects that were associated with the event. For example, if the event was a space permission change then the
-   * associated object would be the space.
-   */
-  associatedObjects?: AffectedObject[];
-}

package/src/server/parameters/createContent.ts

@@ -1,6 +0,0 @@
-import { ContentCreate } from '../../api/models';
-
-export interface CreateContent extends ContentCreate {
-  status?: string;
-  expand?: string;
-}