AI Actions

import { SuperDoc } from 'superdoc';
import { AIActions, HttpProviderConfig } from '@superdoc-dev/ai';

const superdoc = new SuperDoc({ /* editor config */ });

const providerConfig: HttpProviderConfig = {
  type: 'http',
  url: '/api/ai/complete', // Your backend endpoint
  headers: {
    'Authorization': `Bearer ${userAuthToken}`, // Your user's session token
  },
};

const ai = new AIActions(superdoc, {
  user: { displayName: 'RedlineBot', userId: 'ai-assistant' },
  provider: providerConfig,
});

await ai.waitUntilReady();

// Use AI actions
await ai.action.find('GDPR clause');
await ai.action.replace('Rewrite as bullet points');
await ai.action.insertTrackedChange('Add legal disclaimer');

await ai.action.insertTrackedChange(
  "Replace all occurrences of 'Acme Corp' with 'Acme Corporation' throughout the document"
);

await ai.action.replace(
  'Rewrite this section to improve clarity while preserving the existing formatting'
);

const ai = new AIActions(superdoc, { user, provider });

await ai.waitUntilReady();

if (!ai.getIsReady()) {
  // surface UI state, retry later
}

try {
  await ai.action.replace('Make the GDPR clause bullet pointed');
} catch (error) {
  if (/not ready/i.test((error as Error).message)) {
    await ai.waitUntilReady();
  } else {
    console.error('[AIActions] replace failed', error);
  }
}

import { createAIProvider } from '@superdoc-dev/ai';

// Create a provider from configuration
const provider = createAIProvider({
  type: 'openai',
  apiKey: 'sk-...',
  model: 'gpt-4',
});

// Or pass an already-instantiated provider
const customProvider = createAIProvider(myCustomProvider);

import { AIActions, AIPlannerConfig } from '@superdoc-dev/ai';

const ai = new AIActions(superdoc, { user, provider });

// Use the built-in planner
const result = await ai.planner.execute('Review the document and add comments to all legal terms');

import { createToolRegistry, getToolDescriptions, isValidTool } from '@superdoc-dev/ai';

const registry = createToolRegistry(toolDefinitions);
const descriptions = getToolDescriptions(registry);

// Validate a tool definition object
const myTool = {
  name: 'myCustomTool',
  description: 'My custom tool description',
  handler: async ({ instruction }) => ({ success: true })
};
const isValid = isValidTool(myTool);