@onetaskgraph/sdk 0.12.9 → 0.12.10

package/dist/client.d.ts

@@ -0,0 +1,249 @@
+import type { CacheCleared, Classification, CommentList, CommentWritten, CopyReport, DeletedComment, DocumentDetail, EffectiveConfig, FailureDocument, FieldsReport, 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 { runtimeSchemas } from "./generated/schemas.ts";
+export type QueryOptions = {
+    sources?: string[];
+    limit?: number;
+    page?: string;
+    allowPartial?: boolean;
+};
+export type DependencyOptions = Omit<QueryOptions, "sources"> & {
+    direction?: "depends-on" | "depended-on-by";
+};
+export declare const projectGraphDirections: readonly ["auto", "td", "lr"];
+export type ProjectGraphOptions = {
+    direction?: (typeof projectGraphDirections)[number];
+    groupBy?: string;
+    complete?: boolean;
+};
+export type FilterOptions = QueryOptions & {
+    labels?: string[];
+    excludeLabels?: string[];
+    statuses?: string[];
+    search?: string;
+    fields?: "title" | "content" | "both";
+};
+export type DocumentFilterOptions = Omit<FilterOptions, "statuses">;
+export type WriteOptions = {
+    termScope?: string[];
+};
+export type ExpectOptions = {
+    expect?: string;
+};
+/** Status ownership on copy updates. Creates always carry the source status. */
+export declare const statusPolicies: readonly ["source", "preserve-destination"];
+export type StatusPolicy = (typeof statusPolicies)[number];
+export type StatusCopyOptions = {
+    statusPolicy?: StatusPolicy;
+};
+export type CopyOptions = WriteOptions & {
+    matchBy?: string;
+    recreate?: boolean;
+    dryRun?: boolean;
+    noLink?: boolean;
+    comments?: boolean;
+};
+export type CopyQueryOptions = {
+    sources?: string[];
+    commentedSince?: string;
+    metadata?: string[];
+    statuses?: StatusCategory[];
+};
+export type TaskCopyOptions = StatusCopyOptions & CopyOptions & CopyQueryOptions & ExpectOptions & {
+    create?: boolean;
+    targetTask?: string;
+};
+export type CommentBodyOptions = ({
+    body: string;
+} | {
+    bodyFile: string;
+}) & WriteOptions & ExpectOptions;
+export type CommentAddOptions = CommentBodyOptions & {
+    author?: string;
+};
+export type TemplateOptions = {
+    searchPath?: string[];
+};
+export type TemplateRenderOptions = TemplateOptions & {
+    answers?: Record<string, JsonValue>;
+    vars?: Record<string, string>;
+    templateLoader?: string;
+};
+export type TemplateSourceOptions = TemplateOptions & {
+    template?: string;
+    templateLoader?: string;
+    answers?: Record<string, JsonValue>;
+    vars?: Record<string, string>;
+};
+export type CreateOptions = TemplateSourceOptions & WriteOptions & {
+    body?: string;
+    bodyFile?: string;
+    labels?: string[];
+    repositories?: string[];
+    metadata?: Record<string, JsonValue>;
+    classification?: Classification;
+};
+export type AssetOptions = {
+    assets?: string[];
+};
+export type TaskCreateOptions = CreateOptions & AssetOptions & {
+    status?: StatusCategory;
+    dependsOn?: string[];
+    delivers?: string[];
+};
+export type DocumentCreateOptions = CreateOptions & AssetOptions & {
+    id?: string;
+};
+export type ProjectCreateOptions = CreateOptions & {
+    status?: StatusCategory;
+};
+export type TaskUpdateOptions = WriteOptions & ExpectOptions & {
+    title?: string;
+    bodyFile?: string;
+    status?: StatusCategory;
+    statusName?: string;
+    priority?: Priority;
+    metadata?: Record<string, JsonValue>;
+    removeMetadata?: string[];
+    delivers?: string[];
+    dependsOn?: string[];
+};
+export type RenderOptions = TemplateSourceOptions & WriteOptions & {
+    unset?: string[];
+    dryRun?: boolean;
+};
+export type ItemRenderOptions = RenderOptions & AssetOptions;
+export type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+export type ClientOptions = {
+    binaryPath?: string;
+    cwd?: string;
+    env?: NodeJS.ProcessEnv;
+};
+export declare class OnetaskgraphExecutionError extends Error {
+    readonly exitCode: number | null;
+    readonly stderr: string;
+    readonly failure?: FailureDocument["failure"] | undefined;
+    constructor(exitCode: number | null, stderr?: string, failure?: FailureDocument["failure"] | undefined);
+}
+export declare class OnetaskgraphValidationError extends Error {
+    readonly command: string;
+    readonly validationErrors: unknown;
+    constructor(command: string, validationErrors: unknown);
+}
+export declare const commandResponseRoots: Readonly<Record<string, keyof typeof runtimeSchemas>>;
+export declare const commandAlternateRoots: Readonly<Record<string, readonly (keyof typeof runtimeSchemas)[]>>;
+export declare const clientCommands: readonly string[];
+export declare const taskUpdateOptionFlags: Readonly<Record<keyof TaskUpdateOptions, string>>;
+export declare function taskUpdateFlags(options: unknown): string[];
+export declare function taskCopyFlags(options: TaskCopyOptions): string[];
+export declare function projectCopyFlags(options: CopyOptions & StatusCopyOptions & {
+    noTasks?: boolean;
+    members?: string[];
+    membersOnly?: boolean;
+}): string[];
+export declare class OnetaskgraphClient {
+    readonly binaryPath: string;
+    readonly cwd: string | undefined;
+    readonly env: NodeJS.ProcessEnv;
+    constructor(options?: ClientOptions);
+    schema(): Promise<unknown>;
+    configShow(): Promise<EffectiveConfig>;
+    cacheClear(source?: string): Promise<CacheCleared>;
+    sourcesList(): Promise<SourceListings>;
+    sourcesStatusOptions(source: string, options?: {
+        apply?: boolean;
+    }): Promise<StatusOptionsReport>;
+    sourcesFields(source: string, options?: {
+        apply?: boolean;
+    }): Promise<FieldsReport | StatusNamesReport>;
+    sourcesRoute(source: string, options?: {
+        repositories?: string[];
+        classification?: Classification;
+    }): Promise<SourceRoute>;
+    taskList(options?: FilterOptions & {
+        project?: string;
+        noProject?: boolean;
+        priorities?: Priority[];
+        commentedSince?: string;
+        metadata?: string[];
+        origin?: string;
+        members?: boolean;
+    }): Promise<QueryResponseOfQualifiedTask>;
+    taskShow(id: string, options?: Pick<QueryOptions, "allowPartial"> & {
+        noComments?: boolean;
+        pin?: string;
+    }): Promise<TaskDetail>;
+    taskShowMany(ids: string[], options?: {
+        noComments?: boolean;
+        pins?: Record<string, string>;
+    }): Promise<TaskDetails>;
+    taskCommentAdd(id: string, options: CommentAddOptions): Promise<CommentWritten>;
+    taskCommentList(id: string, options?: {
+        pin?: string;
+    }): Promise<CommentList>;
+    taskCommentEdit(id: string, commentId: string, options: CommentBodyOptions): Promise<CommentWritten>;
+    taskCommentDelete(id: string, commentId: string, options?: ExpectOptions): Promise<DeletedComment>;
+    taskStatusSet(id: string, category: StatusCategory, options?: WriteOptions & ExpectOptions): Promise<TaskStatusSet>;
+    taskStatusReconcile(source: string, options?: WriteOptions & {
+        dryRun?: boolean;
+    }): Promise<StatusesReconciled>;
+    taskStatusComplete(issues: string[], options?: WriteOptions & {
+        sources?: string[];
+        dryRun?: boolean;
+    }): 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>;
+    taskDeps(id: string, options?: DependencyOptions): Promise<QueryResponseOfQualifiedEdge>;
+    taskCopy(ids: string[], to: string, options?: TaskCopyOptions): Promise<CopyReport>;
+    taskLocate(ids: string[], options: {
+        to: string;
+        noCounterpart?: boolean;
+        targetNative?: string;
+    }): Promise<LocateReport>;
+    projectList(options?: FilterOptions): Promise<QueryResponseOfQualifiedProject>;
+    projectShow(id: string, options?: Pick<QueryOptions, "allowPartial"> & {
+        pin?: string;
+    }): Promise<QueryResponseOfQualifiedProject>;
+    projectDeps(id: string, options?: DependencyOptions): Promise<QueryResponseOfQualifiedEdge>;
+    projectGraph(id: string, options?: ProjectGraphOptions): Promise<ProjectGraph>;
+    projectCopy(id: string, to: string, options?: CopyOptions & StatusCopyOptions & {
+        noTasks?: boolean;
+        members?: string[];
+        membersOnly?: boolean;
+    }): Promise<CopyReport>;
+    projectMetadataSet(id: string, key: string, value: string, options?: WriteOptions): Promise<MetadataSet>;
+    projectStatusSet(id: string, category: StatusCategory, options?: WriteOptions): Promise<ProjectStatusSet>;
+    documentList(options?: DocumentFilterOptions & {
+        project?: string;
+        noProject?: boolean;
+    }): Promise<QueryResponseOfQualifiedDocument>;
+    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>;
+    labelList(options?: QueryOptions): Promise<QueryResponseOfQualifiedLabel>;
+    search(text: string, options?: QueryOptions & {
+        fields?: "title" | "content" | "both";
+        kind?: "task" | "project" | "both";
+    }): Promise<QueryResponseOfSearchHit>;
+    templateVariables(file?: string, options?: TemplateOptions & {
+        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>;
+    taskAnswers(id: string): Promise<TemplateAnswers>;
+    taskAssets(id: string, outputDir: string): Promise<TaskAssetNames>;
+    projectCreate(source: string, id: NativeId, title: string, options?: ProjectCreateOptions): Promise<QueryResponseOfQualifiedProject>;
+    projectRender(id: string, options?: RenderOptions): Promise<Regenerated>;
+    projectAnswers(id: string): Promise<TemplateAnswers>;
+    documentCreate(source: string, project: string, title: string, options?: DocumentCreateOptions): Promise<DocumentDetail>;
+    documentRender(id: string, options?: ItemRenderOptions): Promise<Regenerated>;
+    documentAnswers(id: string): Promise<TemplateAnswers>;
+    private run;
+}
+export declare function assertCompleteCommandSurface(): void;

package/dist/generated/commands.d.ts

@@ -0,0 +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", "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"];