Capacities

Capacities is a knowledge management app for organizing notes and objects. Protocol Launcher allows you to generate Capacities x-callback-url links for the officially documented actions.

Usage

There are two ways to use this library:

• On-Demand import from subpaths enables tree-shaking and keeps bundles small.
• Full Import from the root package is convenient but includes all app modules.

Pick On-Demand for production builds; Full Import is fine for quick scripts or demos.

Select Installation Method

On-Demand

Recommended. Optimized for production.

Full Import

Convenient. Good for quick scripts.

Capacities x-callback-url links use capacities://x-callback-url/<action>. The API fields xSource, xSuccess, and xError generate the official x-source, x-success, and x-error query parameters. To receive an action result, provide both xSuccess and xError.

The official Capacities page lists title in the createNewObject parameter table and shows name in the testing and createNewObject examples. This package exposes only those documented query parameters.

Create New Object

Open Capacities and create a new object.

On-Demand

import { createNewObject } from 'protocol-launcher/capacities'

const url = createNewObject({
  name: 'My new object',
})

const objectWithOptionsUrl = createNewObject({
  spaceId: 'REPLACE_WITH_SPACE_ID',
  type: 'REPLACE_WITH_OBJECT_TYPE',
  title: 'Research note',
  content: '# Hello Capacities',
  xSource: 'SourceApp',
  xSuccess: 'sourceapp://x-callback-url/response',
  xError: 'sourceapp://x-callback-url/error',
})

Append To Daily Note

Open Capacities and append markdown content to today's daily note.

On-Demand

import { appendToDailyNote } from 'protocol-launcher/capacities'

const url = appendToDailyNote({
  content: 'My content',
})

const appendWithCallbacksUrl = appendToDailyNote({
  spaceId: 'REPLACE_WITH_SPACE_ID',
  content: '- Captured from Shortcuts',
  xSource: 'SourceApp',
  xSuccess: 'sourceapp://x-callback-url/response',
  xError: 'sourceapp://x-callback-url/error',
})

Get Current Object

Return the object that is currently opened in Capacities through the callback URLs.

On-Demand

import { getCurrentObject } from 'protocol-launcher/capacities'

const url = getCurrentObject({
  xSource: 'SourceApp',
  xSuccess: 'sourceapp://x-callback-url/response',
  xError: 'sourceapp://x-callback-url/error',
})

Official Documentation

• Capacities X-Callback-URLs