@onetaskgraph/sdk 0.13.4 → 0.14.0

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { CacheCleared, Classification, CommentList, CommentWritten, CopyReport, DeletedComment, DocumentDetail, EffectiveConfig, FailureDocument, FieldsReport, HumanTaskProjected, IssuesCompleted, LocateReport, MetadataSet, NativeId, Priority, ProjectGraph, ProjectStatusSet, QueryResponseOfQualifiedDocument, QueryResponseOfQualifiedEdge, QueryResponseOfQualifiedLabel, QueryResponseOfQualifiedProject, QueryResponseOfQualifiedTask, QueryResponseOfSearchHit, Regenerated, RenderedTemplate, SourceListings, SourceRoute, StatusCategory, StatusesReconciled, StatusNamesReport, StatusOptionsReport, TaskAssetNames, TaskContentSet, TaskDetail, TaskDetails, TaskPrioritySet, TaskStatusSet, TaskUpdated, TemplateAnswers, TemplateVariables } from "./generated/models.ts";
+import type { CacheCleared, Classification, CommentList, CommentWritten, CopyReport, DeletedComment, DocumentDetail, EffectiveConfig, FailureDocument, FieldsReport, HumanTaskProjected, IssuesCompleted, LocateReport, MetadataSet, NativeId, Priority, ProjectGraph, ProjectStatusSet, QueryResponseOfQualifiedDocument, QueryResponseOfQualifiedEdge, QueryResponseOfQualifiedLabel, QueryResponseOfQualifiedProject, QueryResponseOfQualifiedTask, QueryResponseOfSearchHit, Regenerated, RenderedTemplate, SanitizeDryRun, SourceListings, SourceRoute, StatusCategory, StatusesReconciled, StatusNamesReport, StatusOptionsReport, SweepReport, TaskAssetNames, TaskContentSet, TaskDetail, TaskDetails, TaskPrioritySet, TaskStatusSet, TaskUpdated, TemplateAnswers, TemplateVariables } from "./generated/models.ts";
 import { runtimeSchemas } from "./generated/schemas.ts";
 export type QueryOptions = {
     sources?: string[];
@@ -25,6 +25,9 @@ export type FilterOptions = QueryOptions & {
 export type DocumentFilterOptions = Omit<FilterOptions, "statuses">;
 export type WriteOptions = {
     termScope?: string[];
+    replace?: string[];
+    reject?: string[];
+    sanitizeDryRun?: boolean;
 };
 export type ExpectOptions = {
     expect?: string;
@@ -169,6 +172,10 @@ export declare class OnetaskgraphClient {
         repositories?: string[];
         classification?: Classification;
     }): Promise<SourceRoute>;
+    sourcesSanitize(source: string, options?: Omit<WriteOptions, "sanitizeDryRun" | "termScope"> & {
+        dryRun?: boolean;
+        complete?: boolean;
+    }): Promise<SweepReport>;
     taskList(options?: FilterOptions & {
         project?: string;
         noProject?: boolean;
@@ -186,26 +193,61 @@ export declare class OnetaskgraphClient {
         noComments?: boolean;
         pins?: Record<string, string>;
     }): Promise<TaskDetails>;
-    taskCommentAdd(id: string, options: CommentAddOptions): Promise<CommentWritten>;
+    taskCommentAdd(id: string, options: CommentAddOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<CommentWritten>;
+    taskCommentAdd(id: string, options: CommentAddOptions): Promise<CommentWritten | SanitizeDryRun>;
     taskCommentList(id: string, options?: {
         pin?: string;
     }): Promise<CommentList>;
-    taskCommentEdit(id: string, commentId: string, options: CommentBodyOptions): Promise<CommentWritten>;
+    taskCommentEdit(id: string, commentId: string, options: CommentBodyOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<CommentWritten>;
+    taskCommentEdit(id: string, commentId: string, options: CommentBodyOptions): Promise<CommentWritten | SanitizeDryRun>;
     taskCommentDelete(id: string, commentId: string, options?: ExpectOptions): Promise<DeletedComment>;
-    taskStatusSet(id: string, category: StatusCategory, options?: WriteOptions & ExpectOptions): Promise<TaskStatusSet>;
-    taskStatusReconcile(source: string, options?: WriteOptions & {
+    taskStatusSet(id: string, category: StatusCategory, options?: (WriteOptions & ExpectOptions) & {
+        sanitizeDryRun?: false;
+    }): Promise<TaskStatusSet>;
+    taskStatusSet(id: string, category: StatusCategory, options?: WriteOptions & ExpectOptions): Promise<TaskStatusSet | SanitizeDryRun>;
+    taskStatusReconcile(source: string, options?: (WriteOptions & {
         dryRun?: boolean;
+    }) & {
+        sanitizeDryRun?: false;
     }): Promise<StatusesReconciled>;
-    taskStatusComplete(issues: string[], options?: WriteOptions & {
+    taskStatusReconcile(source: string, options?: WriteOptions & {
+        dryRun?: boolean;
+    }): Promise<StatusesReconciled | SanitizeDryRun>;
+    taskStatusComplete(issues: string[], options?: (WriteOptions & {
         sources?: string[];
         dryRun?: boolean;
+    }) & {
+        sanitizeDryRun?: false;
     }): Promise<IssuesCompleted>;
-    taskPrioritySet(id: string, priority: Priority, options?: WriteOptions & ExpectOptions): Promise<TaskPrioritySet>;
-    taskContentSet(id: string, file: string, options?: WriteOptions & ExpectOptions): Promise<TaskContentSet>;
-    taskMetadataSet(id: string, key: string, value: string, options?: WriteOptions & ExpectOptions): Promise<MetadataSet>;
-    taskUpdate(id: string, options: TaskUpdateOptions): Promise<TaskUpdated>;
+    taskStatusComplete(issues: string[], options?: WriteOptions & {
+        sources?: string[];
+        dryRun?: boolean;
+    }): Promise<IssuesCompleted | SanitizeDryRun>;
+    taskPrioritySet(id: string, priority: Priority, options?: (WriteOptions & ExpectOptions) & {
+        sanitizeDryRun?: false;
+    }): Promise<TaskPrioritySet>;
+    taskPrioritySet(id: string, priority: Priority, options?: WriteOptions & ExpectOptions): Promise<TaskPrioritySet | SanitizeDryRun>;
+    taskContentSet(id: string, file: string, options?: (WriteOptions & ExpectOptions) & {
+        sanitizeDryRun?: false;
+    }): Promise<TaskContentSet>;
+    taskContentSet(id: string, file: string, options?: WriteOptions & ExpectOptions): Promise<TaskContentSet | SanitizeDryRun>;
+    taskMetadataSet(id: string, key: string, value: string, options?: (WriteOptions & ExpectOptions) & {
+        sanitizeDryRun?: false;
+    }): Promise<MetadataSet>;
+    taskMetadataSet(id: string, key: string, value: string, options?: WriteOptions & ExpectOptions): Promise<MetadataSet | SanitizeDryRun>;
+    taskUpdate(id: string, options: TaskUpdateOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<TaskUpdated>;
+    taskUpdate(id: string, options: TaskUpdateOptions): Promise<TaskUpdated | SanitizeDryRun>;
     taskDeps(id: string, options?: DependencyOptions): Promise<QueryResponseOfQualifiedEdge>;
-    taskCopy(ids: string[], to: string, options?: TaskCopyOptions): Promise<CopyReport>;
+    taskCopy(ids: string[], to: string, options?: TaskCopyOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<CopyReport>;
+    taskCopy(ids: string[], to: string, options?: TaskCopyOptions): Promise<CopyReport | SanitizeDryRun>;
     taskLocate(ids: string[], options: {
         to: string;
         noCounterpart?: boolean;
@@ -217,13 +259,26 @@ export declare class OnetaskgraphClient {
     }): Promise<QueryResponseOfQualifiedProject>;
     projectDeps(id: string, options?: DependencyOptions): Promise<QueryResponseOfQualifiedEdge>;
     projectGraph(id: string, options?: ProjectGraphOptions): Promise<ProjectGraph>;
-    projectCopy(id: string, to: string, options?: CopyOptions & StatusCopyOptions & {
+    projectCopy(id: string, to: string, options?: (CopyOptions & StatusCopyOptions & {
         noTasks?: boolean;
         members?: string[];
         membersOnly?: boolean;
+    }) & {
+        sanitizeDryRun?: false;
     }): Promise<CopyReport>;
-    projectMetadataSet(id: string, key: string, value: string, options?: WriteOptions): Promise<MetadataSet>;
-    projectStatusSet(id: string, category: StatusCategory, options?: WriteOptions): Promise<ProjectStatusSet>;
+    projectCopy(id: string, to: string, options?: CopyOptions & StatusCopyOptions & {
+        noTasks?: boolean;
+        members?: string[];
+        membersOnly?: boolean;
+    }): Promise<CopyReport | SanitizeDryRun>;
+    projectMetadataSet(id: string, key: string, value: string, options?: WriteOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<MetadataSet>;
+    projectMetadataSet(id: string, key: string, value: string, options?: WriteOptions): Promise<MetadataSet | SanitizeDryRun>;
+    projectStatusSet(id: string, category: StatusCategory, options?: WriteOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<ProjectStatusSet>;
+    projectStatusSet(id: string, category: StatusCategory, options?: WriteOptions): Promise<ProjectStatusSet | SanitizeDryRun>;
     documentList(options?: DocumentFilterOptions & {
         project?: string;
         noProject?: boolean;
@@ -231,8 +286,14 @@ export declare class OnetaskgraphClient {
     documentShow(id: string, options?: Pick<QueryOptions, "allowPartial"> & {
         pin?: string;
     }): Promise<DocumentDetail>;
-    documentCopy(ids: string[], to: string, options?: Omit<CopyOptions, "comments">): Promise<CopyReport>;
-    documentMetadataSet(id: string, key: string, value: string, options?: WriteOptions): Promise<MetadataSet>;
+    documentCopy(ids: string[], to: string, options?: Omit<CopyOptions, "comments"> & {
+        sanitizeDryRun?: false;
+    }): Promise<CopyReport>;
+    documentCopy(ids: string[], to: string, options?: Omit<CopyOptions, "comments">): Promise<CopyReport | SanitizeDryRun>;
+    documentMetadataSet(id: string, key: string, value: string, options?: WriteOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<MetadataSet>;
+    documentMetadataSet(id: string, key: string, value: string, options?: WriteOptions): Promise<MetadataSet | SanitizeDryRun>;
     labelList(options?: QueryOptions): Promise<QueryResponseOfQualifiedLabel>;
     search(text: string, options?: QueryOptions & {
         fields?: "title" | "content" | "both";
@@ -242,16 +303,34 @@ export declare class OnetaskgraphClient {
         templateLoader?: string;
     }): Promise<TemplateVariables>;
     templateRender(file?: string, options?: TemplateRenderOptions): Promise<RenderedTemplate>;
-    taskCreate(source: string, project: string, title: string, options?: TaskCreateOptions): Promise<TaskDetail>;
-    taskRender(id: string, options?: ItemRenderOptions): Promise<Regenerated>;
+    taskCreate(source: string, project: string, title: string, options?: TaskCreateOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<TaskDetail>;
+    taskCreate(source: string, project: string, title: string, options?: TaskCreateOptions): Promise<TaskDetail | SanitizeDryRun>;
+    taskRender(id: string, options?: ItemRenderOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<Regenerated>;
+    taskRender(id: string, options?: ItemRenderOptions): Promise<Regenerated | SanitizeDryRun>;
     taskAnswers(id: string): Promise<TemplateAnswers>;
     taskAssets(id: string, outputDir: string): Promise<TaskAssetNames>;
     taskProjectHuman(input: string): Promise<HumanTaskProjected>;
-    projectCreate(source: string, id: NativeId, title: string, options?: ProjectCreateOptions): Promise<QueryResponseOfQualifiedProject>;
-    projectRender(id: string, options?: RenderOptions): Promise<Regenerated>;
+    projectCreate(source: string, id: NativeId, title: string, options?: ProjectCreateOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<QueryResponseOfQualifiedProject>;
+    projectCreate(source: string, id: NativeId, title: string, options?: ProjectCreateOptions): Promise<QueryResponseOfQualifiedProject | SanitizeDryRun>;
+    projectRender(id: string, options?: RenderOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<Regenerated>;
+    projectRender(id: string, options?: RenderOptions): Promise<Regenerated | SanitizeDryRun>;
     projectAnswers(id: string): Promise<TemplateAnswers>;
-    documentCreate(source: string, project: string, title: string, options?: DocumentCreateOptions): Promise<DocumentDetail>;
-    documentRender(id: string, options?: ItemRenderOptions): Promise<Regenerated>;
+    documentCreate(source: string, project: string, title: string, options?: DocumentCreateOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<DocumentDetail>;
+    documentCreate(source: string, project: string, title: string, options?: DocumentCreateOptions): Promise<DocumentDetail | SanitizeDryRun>;
+    documentRender(id: string, options?: ItemRenderOptions & {
+        sanitizeDryRun?: false;
+    }): Promise<Regenerated>;
+    documentRender(id: string, options?: ItemRenderOptions): Promise<Regenerated | SanitizeDryRun>;
     documentAnswers(id: string): Promise<TemplateAnswers>;
     private run;
 }

package/dist/generated/commands.d.ts

@@ -1 +1 @@
-export declare const binaryCommands: readonly ["schema", "config show", "sources list", "sources status-options", "sources fields", "sources route", "task list", "task show", "task show-many", "task deps", "task copy", "task locate", "task comment add", "task comment list", "task comment edit", "task comment delete", "task status set", "task status reconcile", "task status complete", "task priority set", "task content set", "task metadata set", "task update", "task create", "task render", "task answers", "task assets", "task project-human", "project list", "project show", "project deps", "project graph", "project copy", "project metadata set", "project status set", "project create", "project render", "project answers", "document list", "document show", "document copy", "document metadata set", "document create", "document render", "document answers", "label list", "search", "cache clear", "template variables", "template render"];
+export declare const binaryCommands: readonly ["schema", "config show", "sources list", "sources status-options", "sources fields", "sources route", "sources sanitize", "task list", "task show", "task show-many", "task deps", "task copy", "task locate", "task comment add", "task comment list", "task comment edit", "task comment delete", "task status set", "task status reconcile", "task status complete", "task priority set", "task content set", "task metadata set", "task update", "task create", "task render", "task answers", "task assets", "task project-human", "project list", "project show", "project deps", "project graph", "project copy", "project metadata set", "project status set", "project create", "project render", "project answers", "document list", "document show", "document copy", "document metadata set", "document create", "document render", "document answers", "label list", "search", "cache clear", "template variables", "template render"];