@ofocus/sdk 0.1.0

package/docs/sdk.taskupdateoptions.md

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

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

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

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

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

package/docs/sdk.updatetask.md

@@ -0,0 +1,66 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [updateTask](./sdk.updatetask.md)
+
+## updateTask() function
+
+Update properties of an existing task in OmniFocus.
+
+**Signature:**
+
+```typescript
+export declare function updateTask(taskId: string, options: TaskUpdateOptions): Promise<CliOutput<OFTask>>;
+```
+
+## 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>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[TaskUpdateOptions](./sdk.taskupdateoptions.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[CliOutput](./sdk.clioutput.md)<!-- -->&lt;[OFTask](./sdk.oftask.md)<!-- -->&gt;&gt;
+

package/docs/sdk.validatedatestring.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; [validateDateString](./sdk.validatedatestring.md)
+
+## validateDateString() function
+
+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.
+
+**Signature:**
+
+```typescript
+export declare function validateDateString(dateStr: string): CliError | null;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+dateStr
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[CliError](./sdk.clierror.md) \| null
+

package/docs/sdk.validateid.md

@@ -0,0 +1,66 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@ofocus/sdk](./sdk.md) &gt; [validateId](./sdk.validateid.md)
+
+## validateId() function
+
+Validate an OmniFocus ID string. IDs are alphanumeric with possible dashes/underscores. Returns null if valid, or a CliError if invalid.
+
+**Signature:**
+
+```typescript
+export declare function validateId(id: string, type: "task" | "project" | "tag"): CliError | null;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+id
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+type
+
+
+</td><td>
+
+"task" \| "project" \| "tag"
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[CliError](./sdk.clierror.md) \| null
+

package/docs/sdk.validateprojectname.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; [validateProjectName](./sdk.validateprojectname.md)
+
+## validateProjectName() function
+
+Validate a project name. Returns null if valid (or empty), or a CliError if invalid.
+
+**Signature:**
+
+```typescript
+export declare function validateProjectName(name: string | undefined): CliError | null;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+name
+
+
+</td><td>
+
+string \| undefined
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[CliError](./sdk.clierror.md) \| null
+

package/docs/sdk.validatetags.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; [validateTags](./sdk.validatetags.md)
+
+## validateTags() function
+
+Validate a list of tag names. Returns null if valid, or a CliError if any tag is invalid.
+
+**Signature:**
+
+```typescript
+export declare function validateTags(tags: string[] | undefined): CliError | null;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+tags
+
+
+</td><td>
+
+string\[\] \| undefined
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[CliError](./sdk.clierror.md) \| null
+

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@ofocus/sdk",
+  "version": "0.1.0",
+  "description": "OmniFocus SDK - Core library for interacting with OmniFocus",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/ofocus-sdk.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/ofocus-sdk.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "api-report",
+    "docs"
+  ],
+  "scripts": {
+    "build": "tsc --build && api-extractor run --local --verbose",
+    "build:tsc": "tsc --build",
+    "test": "vitest run",
+    "test:unit": "vitest run --dir tests/unit",
+    "test:watch": "vitest",
+    "api-extractor": "api-extractor run --verbose",
+    "api-extractor:local": "api-extractor run --local --verbose",
+    "docs": "api-documenter markdown -i temp -o docs"
+  },
+  "keywords": [
+    "omnifocus",
+    "sdk",
+    "applescript"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mnorth/ofocus.git",
+    "directory": "packages/sdk"
+  },
+  "homepage": "https://github.com/mnorth/ofocus/tree/main/packages/sdk#readme",
+  "bugs": {
+    "url": "https://github.com/mnorth/ofocus/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}