@ofocus/sdk 0.1.0

package/docs/sdk.createerror.md

@@ -0,0 +1,82 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [createError](./sdk.createerror.md)
+
+## createError() function
+
+Create a CliError with the given code and message.
+
+**Signature:**
+
+```typescript
+export declare function createError(code: ErrorCode, message: string, details?: string): CliError;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+code
+
+
+</td><td>
+
+[ErrorCode](./sdk.errorcode.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+message
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+details
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[CliError](./sdk.clierror.md)
+

package/docs/sdk.errorcode.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [ErrorCode](./sdk.errorcode.md)
+
+## ErrorCode variable
+
+Error codes for semantic error handling.
+
+**Signature:**
+
+```typescript
+ErrorCode: {
+    readonly TASK_NOT_FOUND: "TASK_NOT_FOUND";
+    readonly PROJECT_NOT_FOUND: "PROJECT_NOT_FOUND";
+    readonly TAG_NOT_FOUND: "TAG_NOT_FOUND";
+    readonly OMNIFOCUS_NOT_RUNNING: "OMNIFOCUS_NOT_RUNNING";
+    readonly INVALID_DATE_FORMAT: "INVALID_DATE_FORMAT";
+    readonly INVALID_ID_FORMAT: "INVALID_ID_FORMAT";
+    readonly APPLESCRIPT_ERROR: "APPLESCRIPT_ERROR";
+    readonly JSON_PARSE_ERROR: "JSON_PARSE_ERROR";
+    readonly VALIDATION_ERROR: "VALIDATION_ERROR";
+    readonly UNKNOWN_ERROR: "UNKNOWN_ERROR";
+}
+```

package/docs/sdk.escapeapplescript.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; [escapeAppleScript](./sdk.escapeapplescript.md)
+
+## escapeAppleScript() function
+
+Escape a string for safe use in AppleScript double-quoted strings. Handles backslashes and double quotes.
+
+**Signature:**
+
+```typescript
+export declare function escapeAppleScript(str: string): string;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+str
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+string
+

package/docs/sdk.failure.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; [failure](./sdk.failure.md)
+
+## failure() function
+
+Create a failed CLI output with a structured error.
+
+**Signature:**
+
+```typescript
+export declare function failure<T = null>(error: CliError): CliOutput<T>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+error
+
+
+</td><td>
+
+[CliError](./sdk.clierror.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[CliOutput](./sdk.clioutput.md)<!-- -->&lt;T&gt;
+

package/docs/sdk.failuremessage.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; [failureMessage](./sdk.failuremessage.md)
+
+## failureMessage() function
+
+Create a failed CLI output with a simple string message. This is a convenience function that wraps the message in an UNKNOWN\_ERROR.
+
+**Signature:**
+
+```typescript
+export declare function failureMessage<T = null>(message: string): CliOutput<T>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+message
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[CliOutput](./sdk.clioutput.md)<!-- -->&lt;T&gt;
+

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

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

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

package/docs/sdk.inboxoptions.md

@@ -0,0 +1,134 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [InboxOptions](./sdk.inboxoptions.md)
+
+## InboxOptions interface
+
+Options for adding a task to the inbox.
+
+**Signature:**
+
+```typescript
+export interface InboxOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[defer?](./sdk.inboxoptions.defer.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[due?](./sdk.inboxoptions.due.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[flag?](./sdk.inboxoptions.flag.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[note?](./sdk.inboxoptions.note.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[tags?](./sdk.inboxoptions.tags.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\] \| undefined
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

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

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

package/docs/sdk.jsonhelpers.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [jsonHelpers](./sdk.jsonhelpers.md)
+
+## jsonHelpers variable
+
+AppleScript helper functions for JSON serialization. These must be defined at the top level (outside tell blocks).
+
+**Signature:**
+
+```typescript
+jsonHelpers = "\non jsonString(val)\n  if val is \"\" or val is missing value or val is \"missing value\" then\n    return \"null\"\n  else\n    return \"\\\"\" & my escapeJson(val) & \"\\\"\"\n  end if\nend jsonString\n\non jsonArray(theList)\n  if (count of theList) is 0 then\n    return \"[]\"\n  end if\n  set output to \"[\"\n  repeat with i from 1 to count of theList\n    if i > 1 then set output to output & \",\"\n    set output to output & \"\\\"\" & (my escapeJson(item i of theList)) & \"\\\"\"\n  end repeat\n  return output & \"]\"\nend jsonArray\n\non escapeJson(str)\n  set output to \"\"\n  repeat with c in characters of (str as string)\n    if c is \"\\\"\" then\n      set output to output & \"\\\\\\\"\"\n    else if c is \"\\\\\" then\n      set output to output & \"\\\\\\\\\"\n    else if c is return then\n      set output to output & \"\\\\n\"\n    else if c is linefeed then\n      set output to output & \"\\\\n\"\n    else\n      set output to output & c\n    end if\n  end repeat\n  return output\nend escapeJson\n"
+```