@ofocus/sdk 0.1.0

package/docs/sdk.oftask.md

@@ -0,0 +1,226 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [OFTask](./sdk.oftask.md)
+
+## OFTask interface
+
+OmniFocus task representation.
+
+**Signature:**
+
+```typescript
+export interface OFTask 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[completed](./sdk.oftask.completed.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[completionDate](./sdk.oftask.completiondate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| null
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[deferDate](./sdk.oftask.deferdate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| null
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[dueDate](./sdk.oftask.duedate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| null
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[flagged](./sdk.oftask.flagged.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[id](./sdk.oftask.id.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[name](./sdk.oftask.name.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[note](./sdk.oftask.note.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| null
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[projectId](./sdk.oftask.projectid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| null
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[projectName](./sdk.oftask.projectname.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| null
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[tags](./sdk.oftask.tags.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/sdk.oftask.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; [OFTask](./sdk.oftask.md) &gt; [name](./sdk.oftask.name.md)
+
+## OFTask.name property
+
+**Signature:**
+
+```typescript
+name: string;
+```

package/docs/sdk.oftask.note.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; [OFTask](./sdk.oftask.md) &gt; [note](./sdk.oftask.note.md)
+
+## OFTask.note property
+
+**Signature:**
+
+```typescript
+note: string | null;
+```

package/docs/sdk.oftask.projectid.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; [OFTask](./sdk.oftask.md) &gt; [projectId](./sdk.oftask.projectid.md)
+
+## OFTask.projectId property
+
+**Signature:**
+
+```typescript
+projectId: string | null;
+```

package/docs/sdk.oftask.projectname.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; [OFTask](./sdk.oftask.md) &gt; [projectName](./sdk.oftask.projectname.md)
+
+## OFTask.projectName property
+
+**Signature:**
+
+```typescript
+projectName: string | null;
+```

package/docs/sdk.oftask.tags.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; [OFTask](./sdk.oftask.md) &gt; [tags](./sdk.oftask.tags.md)
+
+## OFTask.tags property
+
+**Signature:**
+
+```typescript
+tags: string[];
+```

package/docs/sdk.omnifocusscript.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; [omniFocusScript](./sdk.omnifocusscript.md)
+
+## omniFocusScript() function
+
+Build an AppleScript that tells OmniFocus to do something.
+
+**Signature:**
+
+```typescript
+export declare function omniFocusScript(body: string): string;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+body
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+string
+

package/docs/sdk.omnifocusscriptwithhelpers.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; [omniFocusScriptWithHelpers](./sdk.omnifocusscriptwithhelpers.md)
+
+## omniFocusScriptWithHelpers() function
+
+Build an AppleScript that tells OmniFocus to do something, with JSON helper functions defined at the top level.
+
+**Signature:**
+
+```typescript
+export declare function omniFocusScriptWithHelpers(body: string): string;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+body
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+string
+

package/docs/sdk.parseapplescripterror.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; [parseAppleScriptError](./sdk.parseapplescripterror.md)
+
+## parseAppleScriptError() function
+
+Parse an AppleScript error message into a structured CliError. Detects common error patterns and maps them to appropriate error codes.
+
+**Signature:**
+
+```typescript
+export declare function parseAppleScriptError(rawError: string): CliError;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+rawError
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[CliError](./sdk.clierror.md)
+

package/docs/sdk.projectqueryoptions.folder.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; [ProjectQueryOptions](./sdk.projectqueryoptions.md) &gt; [folder](./sdk.projectqueryoptions.folder.md)
+
+## ProjectQueryOptions.folder property
+
+**Signature:**
+
+```typescript
+folder?: string | undefined;
+```

package/docs/sdk.projectqueryoptions.md

@@ -0,0 +1,96 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [ProjectQueryOptions](./sdk.projectqueryoptions.md)
+
+## ProjectQueryOptions interface
+
+Options for querying projects.
+
+**Signature:**
+
+```typescript
+export interface ProjectQueryOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[folder?](./sdk.projectqueryoptions.folder.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[sequential?](./sdk.projectqueryoptions.sequential.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[status?](./sdk.projectqueryoptions.status.md)
+
+
+</td><td>
+
+
+</td><td>
+
+"active" \| "on-hold" \| "completed" \| "dropped" \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/sdk.projectqueryoptions.sequential.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; [ProjectQueryOptions](./sdk.projectqueryoptions.md) &gt; [sequential](./sdk.projectqueryoptions.sequential.md)
+
+## ProjectQueryOptions.sequential property
+
+**Signature:**
+
+```typescript
+sequential?: boolean | undefined;
+```

package/docs/sdk.projectqueryoptions.status.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; [ProjectQueryOptions](./sdk.projectqueryoptions.md) &gt; [status](./sdk.projectqueryoptions.status.md)
+
+## ProjectQueryOptions.status property
+
+**Signature:**
+
+```typescript
+status?: "active" | "on-hold" | "completed" | "dropped" | undefined;
+```

package/docs/sdk.queryprojects.md

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [queryProjects](./sdk.queryprojects.md)
+
+## queryProjects() function
+
+Query projects from OmniFocus with optional filters.
+
+**Signature:**
+
+```typescript
+export declare function queryProjects(options?: ProjectQueryOptions): Promise<CliOutput<OFProject[]>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[ProjectQueryOptions](./sdk.projectqueryoptions.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[CliOutput](./sdk.clioutput.md)<!-- -->&lt;[OFProject](./sdk.ofproject.md)<!-- -->\[\]&gt;&gt;
+

package/docs/sdk.querytags.md

@@ -0,0 +1,54 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [queryTags](./sdk.querytags.md)
+
+## queryTags() function
+
+Query tags from OmniFocus with optional filters.
+
+**Signature:**
+
+```typescript
+export declare function queryTags(options?: TagQueryOptions): Promise<CliOutput<OFTag[]>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+[TagQueryOptions](./sdk.tagqueryoptions.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[CliOutput](./sdk.clioutput.md)<!-- -->&lt;[OFTag](./sdk.oftag.md)<!-- -->\[\]&gt;&gt;
+