# API Reference

Spell Book works both in **CEP** and **UXP** platforms.

It consists of application and extension, which acts as a bridge between Spell Book app and your extension.\
Use npm modules, both for [CEP](https://www.npmjs.com/package/@knights-of-the-editing-table/spell-book) and [UXP](http://npmjs.com/package/@knights-of-the-editing-table/spell-book-uxp), that provide interface for commands registration and handling command event.

## Installation

{% tabs %}
{% tab title="CEP" %}
Make sure that Spell Book is installed (both app and Spell Book extension).

### Installation

```sh
npm install @knights-of-the-editing-table/spell-book
```

### Usage

```javascript
// code.js
import Spellbook from '@knights-of-the-editing-table/spell-book';

const commands = [
    {
        commandID: 'command.id',
        // name: use localised name if needed
        name: 'Command 1',
        // group: optional
        group: 'Group 1',
        // action runs when command is triggered
        action: () => { 
            console.log('command.id triggered!')
        }
    }
];

const spellbook = new Spellbook('Extension name', 'extension.id', commands);
```

{% endtab %}

{% tab title="UXP" %}
Make sure that Spell Book is installed (both app and Spell Book extension).

### Installation

```sh
npm install @knights-of-the-editing-table/spell-book-uxp
```

### Usage

Add command entrypoint and enablePluginCommunication to manifest.json, for [Inter Plugin Communication](https://developer.adobe.com/indesign/uxp/plugins/tutorials/inter-plugin-comm/):

```json
// manifest.json
{
    "entrypoints": [
        {
            "type": "command",
            "id": "spellbook.plugin",
            "label": {
                "default": "- spellbook plugin" // you can use your label
            }
        }
    ],
    "requiredPermissions": {
        "ipc": {
            "enablePluginCommunication": true
        }
    }
}
```

Add Spell Book plugin:

```javascript
// code.js
import Spellbook from '@knights-of-the-editing-table/spell-book-uxp';

const commands = [
    {
        commandID: 'command.id',
        // name: use localised name if needed
        name: 'Command 1',
        // group: optional
        group: 'Group 1',
        // action runs when command is triggered
        action: () => { 
            console.log('command.id triggered!')
        }
    }
];

const spellbook = new Spellbook('Extension name', 'extension.id', commands);

// add spellbook.plugin to entry points
const { entrypoints } = require("uxp");
entrypoints.setup({
    commands: {
        'spellbook.plugin': {
            run: (data, args) => spellbook.plugin(data, args),
        },
    },
});
```

{% endtab %}
{% endtabs %}

#### **Spellbook constructor**

```javascript
const spellbook = new Spellbook(
    pluginName: string,
    pluginID: string,
    commands?: Command[])
```

#### **Methods**

```javascript
// Add or update commands
spellbook.register(commands)
// Start listening for command events
spellbook.start()
// Stop listening for command events
spellbook.stop()
```

#### **Events**

The plugin extends EventEmitter and emits events when commands are triggered:

```javascript
spellbook.on('command.id', (commandID) => {
    console.log('command.id triggered!')
});
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://manuscript.knightsoftheeditingtable.com/extensions/spell-book/api-reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.