Capabilities Reference

Capabilities control what features CI HUB enables for your adapter — which buttons appear, which actions are allowed, and how the plugin UI behaves. They exist at three levels: integration-wide, per-folder, and per-asset.

Integration-level capabilities

Returned once in the info handler inside capabilities. These are static for the entire connection session.

assetSearch sub-options

When assetSearch is an object:

Per-folder capabilities

Returned on each folder object in search and getFolder responses. Control what actions are available in the folder context menu.

The SDK provides defaultFolderCapabilities with all values set to false:

import { defaultFolderCapabilities } from '@ci-hub/integration-sdk'

const folder = {
  id: item.id,
  name: item.name,
  capabilities: {
    ...defaultFolderCapabilities,
    canAddAsset: item.permissions.includes('upload'),
    canAddFolder: item.permissions.includes('create'),
  },
}

Per-asset capabilities

Returned on each asset object. Control which actions appear in the asset context menu.

The SDK provides defaultAssetCapabilities with all values set to false:

import { defaultAssetCapabilities } from '@ci-hub/integration-sdk'

const asset = {
  id: item.id,
  name: item.name,
  capabilities: {
    ...defaultAssetCapabilities,
    canUpdateAsset: true,
    canDeleteAsset: item.userCanDelete,
  },
}

Real patterns

Example - some adapters checks per-item permissions from the API:

capabilities: {
  ...defaultAssetCapabilities,
  canDeleteAsset: folderPermissions.canRemoveAsset,
}

Example - some adapters disables update/rename for non-file assets:

capabilities: {
  ...defaultAssetCapabilities,
  canUpdateAsset: !isOneNote,
  canRenameAsset: !isOneNote,
}

See Integration Info for the full info response schema.