@ofocus/sdk 0.1.0 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 mnorth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/api-report/ofocus-sdk.api.md

@@ -4,6 +4,17 @@
 
 ```ts
 
+// @public
+export function addAttachment(taskId: string, filePath: string): Promise<CliOutput<AddAttachmentResult>>;
+
+// @public
+export interface AddAttachmentResult {
+    attached: boolean;
+    fileName: string;
+    taskId: string;
+    taskName: string;
+}
+
 // @public
 export function addToInbox(title: string, options?: InboxOptions): Promise<CliOutput<OFTask>>;
 
@@ -17,6 +28,25 @@ export interface AppleScriptResult<T> {
     success: boolean;
 }
 
+// @public
+export interface ArchiveOptions {
+    completedBefore?: string | undefined;
+    droppedBefore?: string | undefined;
+    dryRun?: boolean | undefined;
+    project?: string | undefined;
+}
+
+// @public
+export interface ArchiveResult {
+    archivePath: string | null;
+    dryRun: boolean;
+    projectsArchived: number;
+    tasksArchived: number;
+}
+
+// @public
+export function archiveTasks(options?: ArchiveOptions): Promise<CliOutput<ArchiveResult>>;
+
 // @public
 export interface BatchCompleteItem {
     // (undocumented)
@@ -25,6 +55,18 @@ export interface BatchCompleteItem {
     taskName: string;
 }
 
+// @public
+export interface BatchDeferItem {
+    // (undocumented)
+    newDeferDate: string;
+    // (undocumented)
+    previousDeferDate: string | null;
+    // (undocumented)
+    taskId: string;
+    // (undocumented)
+    taskName: string;
+}
+
 // @public
 export interface BatchDeleteItem {
     // (undocumented)
@@ -82,6 +124,15 @@ export interface CommandInfo {
     usage: string;
 }
 
+// @public
+export function compactDatabase(): Promise<CliOutput<CompactResult>>;
+
+// @public
+export interface CompactResult {
+    compacted: boolean;
+    message: string;
+}
+
 // @public
 export interface CompleteResult {
     // (undocumented)
@@ -112,6 +163,24 @@ export interface CreateFolderOptions {
     parentFolderName?: string | undefined;
 }
 
+// @public
+export function createFromTemplate(options: CreateFromTemplateOptions): Promise<CliOutput<CreateFromTemplateResult>>;
+
+// @public
+export interface CreateFromTemplateOptions {
+    baseDate?: string | undefined;
+    folder?: string | undefined;
+    projectName?: string | undefined;
+    templateName: string;
+}
+
+// @public
+export interface CreateFromTemplateResult {
+    projectId: string;
+    projectName: string;
+    tasksCreated: number;
+}
+
 // @public
 export function createProject(name: string, options?: CreateProjectOptions): Promise<CliOutput<OFProject>>;
 
@@ -147,6 +216,59 @@ export interface CreateTagOptions {
     parentTagName?: string | undefined;
 }
 
+// @public
+export interface DeferOptions {
+    days?: number | undefined;
+    to?: string | undefined;
+}
+
+// @public
+export interface DeferredQueryOptions {
+    blockedOnly?: boolean | undefined;
+    deferredAfter?: string | undefined;
+    deferredBefore?: string | undefined;
+}
+
+// @public
+export interface DeferResult {
+    // (undocumented)
+    newDeferDate: string;
+    // (undocumented)
+    previousDeferDate: string | null;
+    // (undocumented)
+    taskId: string;
+    // (undocumented)
+    taskName: string;
+}
+
+// @public
+export function deferTask(taskId: string, options?: DeferOptions): Promise<CliOutput<DeferResult>>;
+
+// @public
+export function deferTasks(taskIds: string[], options?: DeferOptions): Promise<CliOutput<BatchResult<BatchDeferItem>>>;
+
+// @public
+export function deleteFolder(folderId: string): Promise<CliOutput<DeleteFolderResult>>;
+
+// @public
+export interface DeleteFolderResult {
+    // (undocumented)
+    deleted: true;
+    // (undocumented)
+    folderId: string;
+}
+
+// @public
+export function deleteProject(projectId: string): Promise<CliOutput<DeleteProjectResult>>;
+
+// @public
+export interface DeleteProjectResult {
+    // (undocumented)
+    deleted: true;
+    // (undocumented)
+    projectId: string;
+}
+
 // @public
 export interface DeleteResult {
     // (undocumented)
@@ -172,6 +294,28 @@ export function deleteTask(taskId: string): Promise<CliOutput<DeleteResult>>;
 // @public
 export function deleteTasks(taskIds: string[]): Promise<CliOutput<BatchResult<BatchDeleteItem>>>;
 
+// @public
+export function deleteTemplate(name: string): CliOutput<DeleteTemplateResult>;
+
+// @public
+export interface DeleteTemplateResult {
+    deleted: boolean;
+    name: string;
+}
+
+// @public
+export function dropProject(projectId: string): Promise<CliOutput<DropProjectResult>>;
+
+// @public
+export interface DropProjectResult {
+    // (undocumented)
+    dropped: boolean;
+    // (undocumented)
+    projectId: string;
+    // (undocumented)
+    projectName: string;
+}
+
 // @public
 export interface DropResult {
     // (undocumented)
@@ -185,6 +329,25 @@ export interface DropResult {
 // @public
 export function dropTask(taskId: string): Promise<CliOutput<DropResult>>;
 
+// @public
+export function duplicateTask(taskId: string, options?: DuplicateTaskOptions): Promise<CliOutput<DuplicateTaskResult>>;
+
+// @public
+export interface DuplicateTaskOptions {
+    // (undocumented)
+    includeSubtasks?: boolean | undefined;
+}
+
+// @public
+export interface DuplicateTaskResult {
+    // (undocumented)
+    newTaskId: string;
+    // (undocumented)
+    newTaskName: string;
+    // (undocumented)
+    originalTaskId: string;
+}
+
 // @public
 const ErrorCode: {
     readonly TASK_NOT_FOUND: "TASK_NOT_FOUND";
@@ -211,18 +374,68 @@ export { ErrorCode as ErrorCodeType }
 // @public
 export function escapeAppleScript(str: string): string;
 
+// @public
+export function exportTaskPaper(options?: TaskPaperExportOptions): Promise<CliOutput<TaskPaperExportResult>>;
+
 // @public
 export function failure<T = null>(error: CliError): CliOutput<T>;
 
 // @public
 export function failureMessage<T = null>(message: string): CliOutput<T>;
 
+// @public
+function focus_2(target: string, options?: {
+    byId?: boolean | undefined;
+}): Promise<CliOutput<FocusResult>>;
+export { focus_2 as focus }
+
+// @public
+export interface FocusResult {
+    // (undocumented)
+    focused: boolean;
+    // (undocumented)
+    targetId: string | null;
+    // (undocumented)
+    targetName: string | null;
+    // (undocumented)
+    targetType: "project" | "folder" | null;
+}
+
 // @public
 export interface FolderQueryOptions {
     // (undocumented)
     parent?: string | undefined;
 }
 
+// @public
+export interface ForecastOptions {
+    days?: number | undefined;
+    end?: string | undefined;
+    includeDeferred?: boolean | undefined;
+    start?: string | undefined;
+}
+
+// @public
+export function generateUrl(id: string): Promise<CliOutput<UrlResult>>;
+
+// @public
+export function getFocused(): Promise<CliOutput<FocusResult>>;
+
+// @public
+export function getReviewInterval(projectId: string): Promise<CliOutput<ReviewIntervalResult>>;
+
+// @public
+export function getStats(options?: StatsOptions): Promise<CliOutput<StatsResult>>;
+
+// @public
+export function getSyncStatus(): Promise<CliOutput<SyncStatus>>;
+
+// @public
+export function getTemplate(name: string): CliOutput<ProjectTemplate>;
+
+// @public
+export function importTaskPaper(content: string, options?: TaskPaperImportOptions): Promise<CliOutput<TaskPaperImportResult>>;
+
 // @public
 export interface InboxOptions {
     // (undocumented)
@@ -244,12 +457,38 @@ export interface InboxOptions {
 // @public
 export const 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";
 
+// @public
+export function listAttachments(taskId: string): Promise<CliOutput<ListAttachmentsResult>>;
+
+// @public
+export interface ListAttachmentsResult {
+    attachments: OFAttachment[];
+    taskId: string;
+    taskName: string;
+}
+
 // @public
 export function listPerspectives(): Promise<CliOutput<OFPerspective[]>>;
 
+// @public
+export function listTemplates(): CliOutput<ListTemplatesResult>;
+
+// @public
+export interface ListTemplatesResult {
+    templates: TemplateSummary[];
+}
+
 // @public
 export function moveTaskToParent(taskId: string, parentTaskId: string): Promise<CliOutput<OFTaskWithChildren>>;
 
+// @public
+export interface OFAttachment {
+    id: string;
+    name: string;
+    size: number | null;
+    type: string | null;
+}
+
 // @public
 export interface OFFolder {
     // (undocumented)
@@ -358,9 +597,49 @@ export function omniFocusScript(body: string): string;
 // @public
 export function omniFocusScriptWithHelpers(body: string): string;
 
+// @public
+export function openItem(id: string): Promise<CliOutput<OpenResult>>;
+
+// @public
+export interface OpenResult {
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    opened: true;
+    // (undocumented)
+    type: "task" | "project" | "folder" | "tag";
+}
+
 // @public
 export function parseAppleScriptError(rawError: string): CliError;
 
+// @public
+export interface ParsedQuickInput {
+    // (undocumented)
+    defer: string | null;
+    // (undocumented)
+    due: string | null;
+    // (undocumented)
+    estimatedMinutes: number | null;
+    // (undocumented)
+    flagged: boolean;
+    // (undocumented)
+    note: string | null;
+    // (undocumented)
+    project: string | null;
+    // (undocumented)
+    repeat: RepetitionRule | null;
+    // (undocumented)
+    tags: string[];
+    // (undocumented)
+    title: string;
+}
+
+// @public
+export function parseQuickInput(input: string): ParsedQuickInput;
+
 // @public
 export interface PerspectiveQueryOptions {
     // (undocumented)
@@ -377,9 +656,27 @@ export interface ProjectQueryOptions {
     status?: "active" | "on-hold" | "completed" | "dropped" | undefined;
 }
 
+// @public
+export interface ProjectTemplate {
+    createdAt: string;
+    defaultFolder: string | null;
+    description: string | null;
+    name: string;
+    note: string | null;
+    sequential: boolean;
+    sourceProject: string | null;
+    tasks: TemplateTask[];
+}
+
+// @public
+export function queryDeferred(options?: DeferredQueryOptions): Promise<CliOutput<OFTask[]>>;
+
 // @public
 export function queryFolders(options?: FolderQueryOptions): Promise<CliOutput<OFFolder[]>>;
 
+// @public
+export function queryForecast(options?: ForecastOptions): Promise<CliOutput<OFTask[]>>;
+
 // @public
 export function queryPerspective(name: string, options?: PerspectiveQueryOptions): Promise<CliOutput<OFTask[]>>;
 
@@ -398,6 +695,24 @@ export function queryTags(options?: TagQueryOptions): Promise<CliOutput<OFTag[]>
 // @public
 export function queryTasks(options?: TaskQueryOptions): Promise<CliOutput<OFTask[]>>;
 
+// @public
+export function quickCapture(input: string, options?: QuickOptions): Promise<CliOutput<OFTask>>;
+
+// @public
+export interface QuickOptions {
+    note?: string | undefined;
+}
+
+// @public
+export function removeAttachment(taskId: string, attachmentIdOrName: string): Promise<CliOutput<RemoveAttachmentResult>>;
+
+// @public
+export interface RemoveAttachmentResult {
+    attachmentName: string;
+    removed: boolean;
+    taskId: string;
+}
+
 // @public
 export interface RepetitionRule {
     // (undocumented)
@@ -412,6 +727,16 @@ export interface RepetitionRule {
     repeatMethod: "due-again" | "defer-another";
 }
 
+// @public
+export interface ReviewIntervalResult {
+    // (undocumented)
+    projectId: string;
+    // (undocumented)
+    projectName: string;
+    // (undocumented)
+    reviewIntervalDays: number;
+}
+
 // @public
 export function reviewProject(projectId: string): Promise<CliOutput<ReviewResult>>;
 
@@ -433,6 +758,23 @@ export function runAppleScript<T>(script: string): Promise<AppleScriptResult<T>>
 // @public
 export function runAppleScriptFile<T>(filePath: string, args?: string[]): Promise<AppleScriptResult<T>>;
 
+// @public
+export function saveTemplate(options: SaveTemplateOptions): Promise<CliOutput<SaveTemplateResult>>;
+
+// @public
+export interface SaveTemplateOptions {
+    description?: string | undefined;
+    name: string;
+    sourceProject: string;
+}
+
+// @public
+export interface SaveTemplateResult {
+    name: string;
+    path: string;
+    taskCount: number;
+}
+
 // @public
 export interface SearchOptions {
     // (undocumented)
@@ -446,6 +788,33 @@ export interface SearchOptions {
 // @public
 export function searchTasks(query: string, options?: SearchOptions): Promise<CliOutput<OFTask[]>>;
 
+// @public
+export function setReviewInterval(projectId: string, days: number): Promise<CliOutput<ReviewIntervalResult>>;
+
+// @public
+export interface StatsOptions {
+    period?: "day" | "week" | "month" | "year" | undefined;
+    project?: string | undefined;
+    since?: string | undefined;
+    until?: string | undefined;
+}
+
+// @public
+export interface StatsResult {
+    periodEnd: string;
+    periodStart: string;
+    projectFilter: string | null;
+    projectsActive: number;
+    projectsOnHold: number;
+    tasksAvailable: number;
+    tasksCompleted: number;
+    tasksDueThisWeek: number;
+    tasksDueToday: number;
+    tasksFlagged: number;
+    tasksOverdue: number;
+    tasksRemaining: number;
+}
+
 // @public
 export interface SubtaskQueryOptions {
     // (undocumented)
@@ -457,12 +826,59 @@ export interface SubtaskQueryOptions {
 // @public
 export function success<T>(data: T): CliOutput<T>;
 
+// @public
+export interface SyncResult {
+    message: string;
+    triggered: boolean;
+}
+
+// @public
+export interface SyncStatus {
+    accountName: string | null;
+    lastSync: string | null;
+    syncEnabled: boolean;
+    syncing: boolean;
+}
+
 // @public
 export interface TagQueryOptions {
     // (undocumented)
     parent?: string | undefined;
 }
 
+// @public
+export interface TaskPaperExportOptions {
+    includeCompleted?: boolean | undefined;
+    includeDropped?: boolean | undefined;
+    project?: string | undefined;
+}
+
+// @public
+export interface TaskPaperExportResult {
+    // (undocumented)
+    content: string;
+    // (undocumented)
+    projectCount: number;
+    // (undocumented)
+    taskCount: number;
+}
+
+// @public
+export interface TaskPaperImportOptions {
+    createProjects?: boolean | undefined;
+    defaultProject?: string | undefined;
+}
+
+// @public
+export interface TaskPaperImportResult {
+    // (undocumented)
+    errors: string[];
+    // (undocumented)
+    projectsCreated: number;
+    // (undocumented)
+    tasksCreated: number;
+}
+
 // @public
 export interface TaskQueryOptions {
     // (undocumented)
@@ -507,6 +923,73 @@ export interface TaskUpdateOptions {
     title?: string | undefined;
 }
 
+// @public
+export interface TemplateSummary {
+    // (undocumented)
+    createdAt: string;
+    // (undocumented)
+    description: string | null;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    sourceProject: string | null;
+    // (undocumented)
+    taskCount: number;
+}
+
+// @public
+export interface TemplateTask {
+    deferOffsetDays: number | null;
+    dueOffsetDays: number | null;
+    estimatedMinutes: number | null;
+    flagged: boolean;
+    note: string | null;
+    tags: string[];
+    title: string;
+}
+
+// @public
+export function triggerSync(): Promise<CliOutput<SyncResult>>;
+
+// @public
+export function unfocus(): Promise<CliOutput<FocusResult>>;
+
+// @public
+export function updateFolder(folderId: string, options: UpdateFolderOptions): Promise<CliOutput<OFFolder>>;
+
+// @public
+export interface UpdateFolderOptions {
+    // (undocumented)
+    name?: string | undefined;
+    // (undocumented)
+    parentFolderId?: string | undefined;
+    // (undocumented)
+    parentFolderName?: string | undefined;
+}
+
+// @public
+export function updateProject(projectId: string, options: UpdateProjectOptions): Promise<CliOutput<OFProject>>;
+
+// @public
+export interface UpdateProjectOptions {
+    // (undocumented)
+    deferDate?: string | undefined;
+    // (undocumented)
+    dueDate?: string | undefined;
+    // (undocumented)
+    folderId?: string | undefined;
+    // (undocumented)
+    folderName?: string | undefined;
+    // (undocumented)
+    name?: string | undefined;
+    // (undocumented)
+    note?: string | undefined;
+    // (undocumented)
+    sequential?: boolean | undefined;
+    // (undocumented)
+    status?: "active" | "on-hold" | "completed" | "dropped" | undefined;
+}
+
 // @public
 export function updateTag(tagId: string, options: UpdateTagOptions): Promise<CliOutput<OFTag>>;
 
@@ -526,6 +1009,18 @@ export function updateTask(taskId: string, options: TaskUpdateOptions): Promise<
 // @public
 export function updateTasks(taskIds: string[], options: TaskUpdateOptions): Promise<CliOutput<BatchResult<BatchCompleteItem>>>;
 
+// @public
+export interface UrlResult {
+    // (undocumented)
+    id: string;
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    type: "task" | "project" | "folder" | "tag";
+    // (undocumented)
+    url: string;
+}
+
 // @public
 export function validateDateString(dateStr: string): CliError | null;
 
@@ -536,7 +1031,7 @@ export function validateEstimatedMinutes(minutes: number | undefined): CliError
 export function validateFolderName(name: string | undefined): CliError | null;
 
 // @public
-export function validateId(id: string, type: "task" | "project" | "tag"): CliError | null;
+export function validateId(id: string, type: "task" | "project" | "tag" | "folder" | "item"): CliError | null;
 
 // @public
 export function validateProjectName(name: string | undefined): CliError | null;