@ofocus/sdk 0.1.0

package/docs/sdk.md

@@ -0,0 +1,471 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md)
+
+## sdk package
+
+## Functions
+
+<table><thead><tr><th>
+
+Function
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[addToInbox(title, options)](./sdk.addtoinbox.md)
+
+
+</td><td>
+
+Add a task to the OmniFocus inbox.
+
+
+</td></tr>
+<tr><td>
+
+[completeTask(taskId)](./sdk.completetask.md)
+
+
+</td><td>
+
+Mark a task as complete in OmniFocus.
+
+
+</td></tr>
+<tr><td>
+
+[createError(code, message, details)](./sdk.createerror.md)
+
+
+</td><td>
+
+Create a CliError with the given code and message.
+
+
+</td></tr>
+<tr><td>
+
+[escapeAppleScript(str)](./sdk.escapeapplescript.md)
+
+
+</td><td>
+
+Escape a string for safe use in AppleScript double-quoted strings. Handles backslashes and double quotes.
+
+
+</td></tr>
+<tr><td>
+
+[failure(error)](./sdk.failure.md)
+
+
+</td><td>
+
+Create a failed CLI output with a structured error.
+
+
+</td></tr>
+<tr><td>
+
+[failureMessage(message)](./sdk.failuremessage.md)
+
+
+</td><td>
+
+Create a failed CLI output with a simple string message. This is a convenience function that wraps the message in an UNKNOWN\_ERROR.
+
+
+</td></tr>
+<tr><td>
+
+[omniFocusScript(body)](./sdk.omnifocusscript.md)
+
+
+</td><td>
+
+Build an AppleScript that tells OmniFocus to do something.
+
+
+</td></tr>
+<tr><td>
+
+[omniFocusScriptWithHelpers(body)](./sdk.omnifocusscriptwithhelpers.md)
+
+
+</td><td>
+
+Build an AppleScript that tells OmniFocus to do something, with JSON helper functions defined at the top level.
+
+
+</td></tr>
+<tr><td>
+
+[parseAppleScriptError(rawError)](./sdk.parseapplescripterror.md)
+
+
+</td><td>
+
+Parse an AppleScript error message into a structured CliError. Detects common error patterns and maps them to appropriate error codes.
+
+
+</td></tr>
+<tr><td>
+
+[queryProjects(options)](./sdk.queryprojects.md)
+
+
+</td><td>
+
+Query projects from OmniFocus with optional filters.
+
+
+</td></tr>
+<tr><td>
+
+[queryTags(options)](./sdk.querytags.md)
+
+
+</td><td>
+
+Query tags from OmniFocus with optional filters.
+
+
+</td></tr>
+<tr><td>
+
+[queryTasks(options)](./sdk.querytasks.md)
+
+
+</td><td>
+
+Query tasks from OmniFocus with optional filters.
+
+
+</td></tr>
+<tr><td>
+
+[runAppleScript(script)](./sdk.runapplescript.md)
+
+
+</td><td>
+
+Execute an AppleScript and return the result. The script should return a value that can be parsed as JSON for structured data.
+
+
+</td></tr>
+<tr><td>
+
+[runAppleScriptFile(filePath, args)](./sdk.runapplescriptfile.md)
+
+
+</td><td>
+
+Execute an AppleScript file.
+
+
+</td></tr>
+<tr><td>
+
+[success(data)](./sdk.success.md)
+
+
+</td><td>
+
+Create a successful CLI output.
+
+
+</td></tr>
+<tr><td>
+
+[updateTask(taskId, options)](./sdk.updatetask.md)
+
+
+</td><td>
+
+Update properties of an existing task in OmniFocus.
+
+
+</td></tr>
+<tr><td>
+
+[validateDateString(dateStr)](./sdk.validatedatestring.md)
+
+
+</td><td>
+
+Validate a date string for use with AppleScript. Returns null if valid (or empty), or a CliError if invalid.
+
+Note: We do basic validation here; the actual date parsing is done by AppleScript and more detailed errors come from there.
+
+
+</td></tr>
+<tr><td>
+
+[validateId(id, type)](./sdk.validateid.md)
+
+
+</td><td>
+
+Validate an OmniFocus ID string. IDs are alphanumeric with possible dashes/underscores. Returns null if valid, or a CliError if invalid.
+
+
+</td></tr>
+<tr><td>
+
+[validateProjectName(name)](./sdk.validateprojectname.md)
+
+
+</td><td>
+
+Validate a project name. Returns null if valid (or empty), or a CliError if invalid.
+
+
+</td></tr>
+<tr><td>
+
+[validateTags(tags)](./sdk.validatetags.md)
+
+
+</td><td>
+
+Validate a list of tag names. Returns null if valid, or a CliError if any tag is invalid.
+
+
+</td></tr>
+</tbody></table>
+
+## Interfaces
+
+<table><thead><tr><th>
+
+Interface
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[AppleScriptResult](./sdk.applescriptresult.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[CliError](./sdk.clierror.md)
+
+
+</td><td>
+
+Structured error representation for CLI output.
+
+
+</td></tr>
+<tr><td>
+
+[CliOutput](./sdk.clioutput.md)
+
+
+</td><td>
+
+Standard CLI output format for all commands.
+
+
+</td></tr>
+<tr><td>
+
+[CommandInfo](./sdk.commandinfo.md)
+
+
+</td><td>
+
+Metadata about a CLI command for semantic activation by AI agents.
+
+
+</td></tr>
+<tr><td>
+
+[CompleteResult](./sdk.completeresult.md)
+
+
+</td><td>
+
+Result from completing a task.
+
+
+</td></tr>
+<tr><td>
+
+[InboxOptions](./sdk.inboxoptions.md)
+
+
+</td><td>
+
+Options for adding a task to the inbox.
+
+
+</td></tr>
+<tr><td>
+
+[OFPerspective](./sdk.ofperspective.md)
+
+
+</td><td>
+
+OmniFocus perspective representation.
+
+
+</td></tr>
+<tr><td>
+
+[OFProject](./sdk.ofproject.md)
+
+
+</td><td>
+
+OmniFocus project representation.
+
+
+</td></tr>
+<tr><td>
+
+[OFTag](./sdk.oftag.md)
+
+
+</td><td>
+
+OmniFocus tag representation.
+
+
+</td></tr>
+<tr><td>
+
+[OFTask](./sdk.oftask.md)
+
+
+</td><td>
+
+OmniFocus task representation.
+
+
+</td></tr>
+<tr><td>
+
+[ProjectQueryOptions](./sdk.projectqueryoptions.md)
+
+
+</td><td>
+
+Options for querying projects.
+
+
+</td></tr>
+<tr><td>
+
+[TagQueryOptions](./sdk.tagqueryoptions.md)
+
+
+</td><td>
+
+Options for querying tags.
+
+
+</td></tr>
+<tr><td>
+
+[TaskQueryOptions](./sdk.taskqueryoptions.md)
+
+
+</td><td>
+
+Options for querying tasks.
+
+
+</td></tr>
+<tr><td>
+
+[TaskUpdateOptions](./sdk.taskupdateoptions.md)
+
+
+</td><td>
+
+Options for updating a task.
+
+
+</td></tr>
+</tbody></table>
+
+## Variables
+
+<table><thead><tr><th>
+
+Variable
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[ErrorCode](./sdk.errorcode.md)
+
+
+</td><td>
+
+Error codes for semantic error handling.
+
+
+</td></tr>
+<tr><td>
+
+[jsonHelpers](./sdk.jsonhelpers.md)
+
+
+</td><td>
+
+AppleScript helper functions for JSON serialization. These must be defined at the top level (outside tell blocks).
+
+
+</td></tr>
+</tbody></table>
+
+## Type Aliases
+
+<table><thead><tr><th>
+
+Type Alias
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[ErrorCode](./sdk.errorcode.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

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

package/docs/sdk.ofperspective.md

@@ -0,0 +1,73 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [OFPerspective](./sdk.ofperspective.md)
+
+## OFPerspective interface
+
+OmniFocus perspective representation.
+
+**Signature:**
+
+```typescript
+export interface OFPerspective 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[id](./sdk.ofperspective.id.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[name](./sdk.ofperspective.name.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

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

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

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

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