@ofocus/sdk 0.1.0

package/docs/sdk.applescriptresult.md

@@ -0,0 +1,92 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [AppleScriptResult](./sdk.applescriptresult.md)
+
+## AppleScriptResult interface
+
+**Signature:**
+
+```typescript
+export interface AppleScriptResult<T> 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[data?](./sdk.applescriptresult.data.md)
+
+
+</td><td>
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[error?](./sdk.applescriptresult.error.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[CliError](./sdk.clierror.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[success](./sdk.applescriptresult.success.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/sdk.applescriptresult.success.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [AppleScriptResult](./sdk.applescriptresult.md) &gt; [success](./sdk.applescriptresult.success.md)
+
+## AppleScriptResult.success property
+
+**Signature:**
+
+```typescript
+success: boolean;
+```

package/docs/sdk.clierror.code.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CliError](./sdk.clierror.md) &gt; [code](./sdk.clierror.code.md)
+
+## CliError.code property
+
+**Signature:**
+
+```typescript
+code: ErrorCode;
+```

package/docs/sdk.clierror.details.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CliError](./sdk.clierror.md) &gt; [details](./sdk.clierror.details.md)
+
+## CliError.details property
+
+**Signature:**
+
+```typescript
+details?: string;
+```

package/docs/sdk.clierror.md

@@ -0,0 +1,92 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CliError](./sdk.clierror.md)
+
+## CliError interface
+
+Structured error representation for CLI output.
+
+**Signature:**
+
+```typescript
+export interface CliError 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[code](./sdk.clierror.code.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ErrorCode](./sdk.errorcode.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[details?](./sdk.clierror.details.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[message](./sdk.clierror.message.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/sdk.clierror.message.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CliError](./sdk.clierror.md) &gt; [message](./sdk.clierror.message.md)
+
+## CliError.message property
+
+**Signature:**
+
+```typescript
+message: string;
+```

package/docs/sdk.clioutput.data.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CliOutput](./sdk.clioutput.md) &gt; [data](./sdk.clioutput.data.md)
+
+## CliOutput.data property
+
+**Signature:**
+
+```typescript
+data: T | null;
+```

package/docs/sdk.clioutput.error.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CliOutput](./sdk.clioutput.md) &gt; [error](./sdk.clioutput.error.md)
+
+## CliOutput.error property
+
+**Signature:**
+
+```typescript
+error: CliError | null;
+```

package/docs/sdk.clioutput.md

@@ -0,0 +1,90 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CliOutput](./sdk.clioutput.md)
+
+## CliOutput interface
+
+Standard CLI output format for all commands.
+
+**Signature:**
+
+```typescript
+export interface CliOutput<T> 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[data](./sdk.clioutput.data.md)
+
+
+</td><td>
+
+
+</td><td>
+
+T \| null
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[error](./sdk.clioutput.error.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[CliError](./sdk.clierror.md) \| null
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[success](./sdk.clioutput.success.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/sdk.clioutput.success.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CliOutput](./sdk.clioutput.md) &gt; [success](./sdk.clioutput.success.md)
+
+## CliOutput.success property
+
+**Signature:**
+
+```typescript
+success: boolean;
+```

package/docs/sdk.commandinfo.description.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CommandInfo](./sdk.commandinfo.md) &gt; [description](./sdk.commandinfo.description.md)
+
+## CommandInfo.description property
+
+**Signature:**
+
+```typescript
+description: string;
+```

package/docs/sdk.commandinfo.md

@@ -0,0 +1,90 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CommandInfo](./sdk.commandinfo.md)
+
+## CommandInfo interface
+
+Metadata about a CLI command for semantic activation by AI agents.
+
+**Signature:**
+
+```typescript
+export interface CommandInfo 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[description](./sdk.commandinfo.description.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[name](./sdk.commandinfo.name.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[usage](./sdk.commandinfo.usage.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/sdk.commandinfo.name.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CommandInfo](./sdk.commandinfo.md) &gt; [name](./sdk.commandinfo.name.md)
+
+## CommandInfo.name property
+
+**Signature:**
+
+```typescript
+name: string;
+```

package/docs/sdk.commandinfo.usage.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CommandInfo](./sdk.commandinfo.md) &gt; [usage](./sdk.commandinfo.usage.md)
+
+## CommandInfo.usage property
+
+**Signature:**
+
+```typescript
+usage: string;
+```

package/docs/sdk.completeresult.completed.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CompleteResult](./sdk.completeresult.md) &gt; [completed](./sdk.completeresult.completed.md)
+
+## CompleteResult.completed property
+
+**Signature:**
+
+```typescript
+completed: boolean;
+```

package/docs/sdk.completeresult.md

@@ -0,0 +1,90 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CompleteResult](./sdk.completeresult.md)
+
+## CompleteResult interface
+
+Result from completing a task.
+
+**Signature:**
+
+```typescript
+export interface CompleteResult 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[completed](./sdk.completeresult.completed.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[taskId](./sdk.completeresult.taskid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[taskName](./sdk.completeresult.taskname.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/sdk.completeresult.taskid.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CompleteResult](./sdk.completeresult.md) &gt; [taskId](./sdk.completeresult.taskid.md)
+
+## CompleteResult.taskId property
+
+**Signature:**
+
+```typescript
+taskId: string;
+```

package/docs/sdk.completeresult.taskname.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [CompleteResult](./sdk.completeresult.md) &gt; [taskName](./sdk.completeresult.taskname.md)
+
+## CompleteResult.taskName property
+
+**Signature:**
+
+```typescript
+taskName: string;
+```

package/docs/sdk.completetask.md

@@ -0,0 +1,52 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [completeTask](./sdk.completetask.md)
+
+## completeTask() function
+
+Mark a task as complete in OmniFocus.
+
+**Signature:**
+
+```typescript
+export declare function completeTask(taskId: string): Promise<CliOutput<CompleteResult>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+taskId
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[CliOutput](./sdk.clioutput.md)<!-- -->&lt;[CompleteResult](./sdk.completeresult.md)<!-- -->&gt;&gt;
+