@superdurable/connector-asana 0.0.0-stage → 0.1.1

package/dist/index.d.ts

@@ -0,0 +1,338 @@
+import { A as AddCommentInput, a as AddCommentOutput, C as Connection, b as CreateTaskInput, c as CreateTaskOutput, G as GetTaskInput, T as Task, L as ListTasksInput, d as ListTasksOutput, U as UpdateTaskInput, e as UpdateTaskOutput, f as Config, g as Credentials } from './connection-Bu8DfK5s.js';
+export { h as AddCommentInputSchema, i as AddCommentOutputSchema, j as ConfigSchema, k as CreateTaskInputSchema, l as CreateTaskOutputSchema, m as CredentialSource, n as CustomFieldValue, o as CustomFieldValueInput, p as CustomFieldValueInputSchema, q as CustomFieldValueSchema, E as EnumOptionReference, r as EnumOptionReferenceSchema, s as GetTaskInputSchema, t as ListTasksInputSchema, u as ListTasksOutputSchema, O as Operations, P as ProjectReference, v as ProjectReferenceSchema, S as SectionReference, w as SectionReferenceSchema, x as TaskMembership, y as TaskMembershipSchema, z as TaskReference, B as TaskReferenceSchema, D as TaskSchema, F as UpdateTaskInputSchema, H as UpdateTaskOutputSchema, I as UserReference, J as UserReferenceSchema, W as WorkspaceReference, K as WorkspaceReferenceSchema, M as decodeCredentials, N as newConnection, Q as newConnectionWithOperations } from './connection-Bu8DfK5s.js';
+import * as _superdurable_connectors_sdk from '@superdurable/connectors-sdk';
+import { MutationDefinition, QueryDefinition, MutationStepConfig, Mutation, MutationResult, QueryStepConfig, Query, QueryResult, MutationStep, QueryStep, Call, QueryAttempt, MutationAttempt, CredentialProvider, ReceiptDraft, Failure } from '@superdurable/connectors-sdk';
+import { StepTarget } from '@superdurable/dex';
+import { LoadedProject } from '@superdurable/connectors-sdk/projectconfig';
+import { ProviderRequest, ProviderResponse } from '@superdurable/connectors-sdk/providerhttp';
+import 'zod';
+
+/** Stable connector identity. */
+declare const ConnectorID = "asana";
+/** Provider identity for named connections. */
+declare const ProviderID = "asana";
+/** Branch IDs for listTasks. */
+declare const ListTasksBranch: {
+    readonly Listed: "listed";
+    readonly NotFound: "notFound";
+    readonly ProviderRejected: "providerRejected";
+    readonly InvalidResponse: "invalidResponse";
+    readonly Defect: "defect";
+};
+/** One page of the project's or section's tasks was read. */
+declare const ListTasksBranchListed: "listed";
+/** The project or section does not exist or the connection cannot see it. */
+declare const ListTasksBranchNotFound: "notFound";
+/** Asana conclusively rejected the list, such as an expired offset token, missing permission, or a result set too large to page. */
+declare const ListTasksBranchProviderRejected: "providerRejected";
+/** Asana returned an invalid or oversized task page. */
+declare const ListTasksBranchInvalidResponse: "invalidResponse";
+/** Local input, connection configuration, or connector definition is invalid. */
+declare const ListTasksBranchDefect: "defect";
+/** Manifest definition for listTasks. */
+declare const ListTasksDefinition: QueryDefinition;
+/** Manifest metadata for listTasks. */
+declare const ListTasksMetadata: {
+    readonly kind: "query";
+    readonly idempotency: "none";
+    readonly authorization: "required";
+};
+/** Branch IDs for getTask. */
+declare const GetTaskBranch: {
+    readonly Found: "found";
+    readonly NotFound: "notFound";
+    readonly ProviderRejected: "providerRejected";
+    readonly InvalidResponse: "invalidResponse";
+    readonly Defect: "defect";
+};
+/** The task was read. */
+declare const GetTaskBranchFound: "found";
+/** The task does not exist or the connection cannot see it. */
+declare const GetTaskBranchNotFound: "notFound";
+/** Asana conclusively rejected the task read. */
+declare const GetTaskBranchProviderRejected: "providerRejected";
+/** Asana returned an invalid or oversized task. */
+declare const GetTaskBranchInvalidResponse: "invalidResponse";
+/** Local input, connection configuration, or connector definition is invalid. */
+declare const GetTaskBranchDefect: "defect";
+/** Manifest definition for getTask. */
+declare const GetTaskDefinition: QueryDefinition;
+/** Manifest metadata for getTask. */
+declare const GetTaskMetadata: {
+    readonly kind: "query";
+    readonly idempotency: "none";
+    readonly authorization: "required";
+};
+/** Branch IDs for createTask. */
+declare const CreateTaskBranch: {
+    readonly Created: "created";
+    readonly ProviderRejected: "providerRejected";
+    readonly Uncertain: "uncertain";
+    readonly Defect: "defect";
+};
+/** Asana created the task and returned its ID. */
+declare const CreateTaskBranchCreated: "created";
+/** Asana conclusively rejected the task, such as an unknown project, section, assignee, or custom field value, or missing permission; nothing was created. */
+declare const CreateTaskBranchProviderRejected: "providerRejected";
+/** The request may have reached Asana but its outcome cannot be confirmed; Asana has no idempotency key, so the task may exist and must not be created again automatically. */
+declare const CreateTaskBranchUncertain: "uncertain";
+/** Local input, connection configuration, or connector definition is invalid. */
+declare const CreateTaskBranchDefect: "defect";
+/** Manifest definition for createTask. */
+declare const CreateTaskDefinition: MutationDefinition;
+/** Manifest metadata for createTask. */
+declare const CreateTaskMetadata: {
+    readonly kind: "mutation";
+    readonly idempotency: "required";
+    readonly authorization: "required";
+};
+/** Branch IDs for updateTask. */
+declare const UpdateTaskBranch: {
+    readonly Updated: "updated";
+    readonly NotFound: "notFound";
+    readonly ProviderRejected: "providerRejected";
+    readonly InvalidResponse: "invalidResponse";
+    readonly Defect: "defect";
+};
+/** Asana applied every requested change, including when the task already had those values, and the Value holds the task read back. */
+declare const UpdateTaskBranchUpdated: "updated";
+/** The task or section does not exist or the connection cannot see it. */
+declare const UpdateTaskBranchNotFound: "notFound";
+/** Asana conclusively rejected a change, such as an unknown assignee, a section of a project the task is not in, or missing permission. */
+declare const UpdateTaskBranchProviderRejected: "providerRejected";
+/** Asana returned an invalid or oversized task after the update. */
+declare const UpdateTaskBranchInvalidResponse: "invalidResponse";
+/** Local input, connection configuration, or connector definition is invalid. */
+declare const UpdateTaskBranchDefect: "defect";
+/** Manifest definition for updateTask. */
+declare const UpdateTaskDefinition: MutationDefinition;
+/** Manifest metadata for updateTask. */
+declare const UpdateTaskMetadata: {
+    readonly kind: "mutation";
+    readonly idempotency: "required";
+    readonly authorization: "required";
+};
+/** Branch IDs for addComment. */
+declare const AddCommentBranch: {
+    readonly Added: "added";
+    readonly NotFound: "notFound";
+    readonly ProviderRejected: "providerRejected";
+    readonly Uncertain: "uncertain";
+    readonly Defect: "defect";
+};
+/** Asana added the comment and returned its story ID. */
+declare const AddCommentBranchAdded: "added";
+/** The task does not exist or the connection cannot see it; nothing was added. */
+declare const AddCommentBranchNotFound: "notFound";
+/** Asana conclusively rejected the comment, such as missing permission or invalid text; nothing was added. */
+declare const AddCommentBranchProviderRejected: "providerRejected";
+/** The request may have reached Asana but its outcome cannot be confirmed; Asana has no idempotency key, so the comment may exist and must not be added again automatically. */
+declare const AddCommentBranchUncertain: "uncertain";
+/** Local input, connection configuration, or connector definition is invalid. */
+declare const AddCommentBranchDefect: "defect";
+/** Manifest definition for addComment. */
+declare const AddCommentDefinition: MutationDefinition;
+/** Manifest metadata for addComment. */
+declare const AddCommentMetadata: {
+    readonly kind: "mutation";
+    readonly idempotency: "required";
+    readonly authorization: "required";
+};
+
+/** Configuration for the listTasks connector Step. */
+interface ListTasksStepConfig<StepInput, OperationInput = ListTasksInput, OperationOutput = ListTasksOutput> extends Omit<QueryStepConfig<StepInput, OperationInput, OperationOutput>, 'operation' | 'connection' | 'branches'> {
+    /** Named connection supplying this operation. */
+    connection: Connection<{
+        listTasks(): Query<OperationInput, OperationOutput>;
+    }>;
+    /** Name matching the bound connection. */
+    connectionName: string;
+    /** One page of the project's or section's tasks was read. */
+    listed: StepTarget<QueryResult<OperationOutput>>;
+    /** The project or section does not exist or the connection cannot see it. */
+    notFound?: StepTarget<QueryResult<OperationOutput>>;
+    /** Asana conclusively rejected the list, such as an expired offset token, missing permission, or a result set too large to page. */
+    providerRejected?: StepTarget<QueryResult<OperationOutput>>;
+    /** Asana returned an invalid or oversized task page. */
+    invalidResponse?: StepTarget<QueryResult<OperationOutput>>;
+    /** Local input, connection configuration, or connector definition is invalid. */
+    defect?: StepTarget<QueryResult<OperationOutput>>;
+}
+/** Build the listTasks Step from a named connection. */
+declare function newListTasksStep<StepInput, OperationInput = ListTasksInput, OperationOutput = ListTasksOutput>(configuration: ListTasksStepConfig<StepInput, OperationInput, OperationOutput>): QueryStep<StepInput, OperationInput, OperationOutput>;
+/** Configuration for the getTask connector Step. */
+interface GetTaskStepConfig<StepInput, OperationInput = GetTaskInput, OperationOutput = Task> extends Omit<QueryStepConfig<StepInput, OperationInput, OperationOutput>, 'operation' | 'connection' | 'branches'> {
+    /** Named connection supplying this operation. */
+    connection: Connection<{
+        getTask(): Query<OperationInput, OperationOutput>;
+    }>;
+    /** Name matching the bound connection. */
+    connectionName: string;
+    /** The task was read. */
+    found: StepTarget<QueryResult<OperationOutput>>;
+    /** The task does not exist or the connection cannot see it. */
+    notFound?: StepTarget<QueryResult<OperationOutput>>;
+    /** Asana conclusively rejected the task read. */
+    providerRejected?: StepTarget<QueryResult<OperationOutput>>;
+    /** Asana returned an invalid or oversized task. */
+    invalidResponse?: StepTarget<QueryResult<OperationOutput>>;
+    /** Local input, connection configuration, or connector definition is invalid. */
+    defect?: StepTarget<QueryResult<OperationOutput>>;
+}
+/** Build the getTask Step from a named connection. */
+declare function newGetTaskStep<StepInput, OperationInput = GetTaskInput, OperationOutput = Task>(configuration: GetTaskStepConfig<StepInput, OperationInput, OperationOutput>): QueryStep<StepInput, OperationInput, OperationOutput>;
+/** Configuration for the createTask connector Step. */
+interface CreateTaskStepConfig<StepInput, OperationInput = CreateTaskInput, OperationOutput = CreateTaskOutput> extends Omit<MutationStepConfig<StepInput, OperationInput, OperationOutput>, 'operation' | 'connection' | 'branches'> {
+    /** Named connection supplying this operation. */
+    connection: Connection<{
+        createTask(): Mutation<OperationInput, OperationOutput>;
+    }>;
+    /** Name matching the bound connection. */
+    connectionName: string;
+    /** Asana created the task and returned its ID. */
+    created: StepTarget<MutationResult<OperationOutput>>;
+    /** Asana conclusively rejected the task, such as an unknown project, section, assignee, or custom field value, or missing permission; nothing was created. */
+    providerRejected?: StepTarget<MutationResult<OperationOutput>>;
+    /** The request may have reached Asana but its outcome cannot be confirmed; Asana has no idempotency key, so the task may exist and must not be created again automatically. */
+    uncertain?: StepTarget<MutationResult<OperationOutput>>;
+    /** Local input, connection configuration, or connector definition is invalid. */
+    defect?: StepTarget<MutationResult<OperationOutput>>;
+}
+/** Build the createTask Step from a named connection. */
+declare function newCreateTaskStep<StepInput, OperationInput = CreateTaskInput, OperationOutput = CreateTaskOutput>(configuration: CreateTaskStepConfig<StepInput, OperationInput, OperationOutput>): MutationStep<StepInput, OperationInput, OperationOutput>;
+/** Configuration for the updateTask connector Step. */
+interface UpdateTaskStepConfig<StepInput, OperationInput = UpdateTaskInput, OperationOutput = UpdateTaskOutput> extends Omit<MutationStepConfig<StepInput, OperationInput, OperationOutput>, 'operation' | 'connection' | 'branches'> {
+    /** Named connection supplying this operation. */
+    connection: Connection<{
+        updateTask(): Mutation<OperationInput, OperationOutput>;
+    }>;
+    /** Name matching the bound connection. */
+    connectionName: string;
+    /** Asana applied every requested change, including when the task already had those values, and the Value holds the task read back. */
+    updated: StepTarget<MutationResult<OperationOutput>>;
+    /** The task or section does not exist or the connection cannot see it. */
+    notFound?: StepTarget<MutationResult<OperationOutput>>;
+    /** Asana conclusively rejected a change, such as an unknown assignee, a section of a project the task is not in, or missing permission. */
+    providerRejected?: StepTarget<MutationResult<OperationOutput>>;
+    /** Asana returned an invalid or oversized task after the update. */
+    invalidResponse?: StepTarget<MutationResult<OperationOutput>>;
+    /** Local input, connection configuration, or connector definition is invalid. */
+    defect?: StepTarget<MutationResult<OperationOutput>>;
+}
+/** Build the updateTask Step from a named connection. */
+declare function newUpdateTaskStep<StepInput, OperationInput = UpdateTaskInput, OperationOutput = UpdateTaskOutput>(configuration: UpdateTaskStepConfig<StepInput, OperationInput, OperationOutput>): MutationStep<StepInput, OperationInput, OperationOutput>;
+/** Configuration for the addComment connector Step. */
+interface AddCommentStepConfig<StepInput, OperationInput = AddCommentInput, OperationOutput = AddCommentOutput> extends Omit<MutationStepConfig<StepInput, OperationInput, OperationOutput>, 'operation' | 'connection' | 'branches'> {
+    /** Named connection supplying this operation. */
+    connection: Connection<{
+        addComment(): Mutation<OperationInput, OperationOutput>;
+    }>;
+    /** Name matching the bound connection. */
+    connectionName: string;
+    /** Asana added the comment and returned its story ID. */
+    added: StepTarget<MutationResult<OperationOutput>>;
+    /** The task does not exist or the connection cannot see it; nothing was added. */
+    notFound?: StepTarget<MutationResult<OperationOutput>>;
+    /** Asana conclusively rejected the comment, such as missing permission or invalid text; nothing was added. */
+    providerRejected?: StepTarget<MutationResult<OperationOutput>>;
+    /** The request may have reached Asana but its outcome cannot be confirmed; Asana has no idempotency key, so the comment may exist and must not be added again automatically. */
+    uncertain?: StepTarget<MutationResult<OperationOutput>>;
+    /** Local input, connection configuration, or connector definition is invalid. */
+    defect?: StepTarget<MutationResult<OperationOutput>>;
+}
+/** Build the addComment Step from a named connection. */
+declare function newAddCommentStep<StepInput, OperationInput = AddCommentInput, OperationOutput = AddCommentOutput>(configuration: AddCommentStepConfig<StepInput, OperationInput, OperationOutput>): MutationStep<StepInput, OperationInput, OperationOutput>;
+
+/** List one bounded task page from a project or section. */
+declare class ListTasksOperation implements Query<ListTasksInput, ListTasksOutput> {
+    private readonly client;
+    /** Bind a validated Asana client. */ constructor(client: Client);
+    /** Return the stable manifest definition. */ definition(): _superdurable_connectors_sdk.QueryDefinition;
+    /** Read one page and classify one provider attempt. */
+    invoke(call: Call, input: ListTasksInput): Promise<QueryAttempt<ListTasksOutput>>;
+}
+/** Read one task with notes and custom field values. */
+declare class GetTaskOperation implements Query<GetTaskInput, Task> {
+    private readonly client;
+    /** Bind a validated Asana client. */ constructor(client: Client);
+    /** Return the stable manifest definition. */ definition(): _superdurable_connectors_sdk.QueryDefinition;
+    /** Read one task and classify one provider attempt. */
+    invoke(call: Call, input: GetTaskInput): Promise<QueryAttempt<Task>>;
+}
+/** Create one Asana task with a checkpointed, non-repeatable POST. */
+declare class CreateTaskOperation implements Mutation<CreateTaskInput, CreateTaskOutput> {
+    private readonly client;
+    /** Bind a validated Asana client. */ constructor(client: Client);
+    /** Return the stable manifest definition. */ definition(): _superdurable_connectors_sdk.QueryDefinition;
+    /** Use the Call ID in Dex receipts; Asana does not accept this key. */ idempotencyKey(callId: string): string;
+    /** Create or read back one task without repeating an ambiguous write. */
+    invoke(call: Call, input: CreateTaskInput): Promise<MutationAttempt<CreateTaskOutput>>;
+    private readBack;
+}
+/** Apply absolute task field and section changes. */
+declare class UpdateTaskOperation implements Mutation<UpdateTaskInput, UpdateTaskOutput> {
+    private readonly client;
+    /** Bind a validated Asana client. */ constructor(client: Client);
+    /** Return the stable manifest definition. */ definition(): _superdurable_connectors_sdk.QueryDefinition;
+    /** Use the stable Call ID in Dex receipts. */ idempotencyKey(callId: string): string;
+    /** Apply repeatable changes and read back the resulting task. */
+    invoke(call: Call, input: UpdateTaskInput): Promise<MutationAttempt<UpdateTaskOutput>>;
+}
+/** Add one comment with a checkpointed, non-repeatable POST. */
+declare class AddCommentOperation implements Mutation<AddCommentInput, AddCommentOutput> {
+    private readonly client;
+    /** Bind a validated Asana client. */ constructor(client: Client);
+    /** Return the stable manifest definition. */ definition(): _superdurable_connectors_sdk.QueryDefinition;
+    /** Use the Call ID in Dex receipts; Asana does not accept this key. */ idempotencyKey(callId: string): string;
+    /** Add or read back one story without repeating an ambiguous write. */
+    invoke(call: Call, input: AddCommentInput): Promise<MutationAttempt<AddCommentOutput>>;
+    private readBack;
+}
+
+/** Injectable transport and clock for deterministic provider tests. */
+interface ClientOptions {
+    /** Provider request sender; the default pins DNS and refuses redirects. */ send?: (request: ProviderRequest) => Promise<ProviderResponse>;
+    /** Receipt and Retry-After clock. */ now?: () => Date;
+}
+/** Bounded provider exchange, including failures before or after dispatch. */
+type Exchange = {
+    response: ProviderResponse;
+    isTooLarge: boolean;
+    reflectsSecret: boolean;
+} | {
+    error: 'beforeSend' | 'afterSend' | 'notBuilt' | 'interrupted';
+};
+/** Authenticated Asana API client shared by operation-specific Step factories. */
+declare class Client {
+    readonly endpoint: string;
+    readonly maxResponseBytes: number;
+    private readonly credentials;
+    private readonly send;
+    private readonly now;
+    /** Validate settings and own the credential source without resolving a secret. */
+    constructor(config: Config, credentials: CredentialProvider<Credentials>, options?: ClientOptions);
+    /** Bind the task list query. */ listTasks(): ListTasksOperation;
+    /** Bind the task detail query. */ getTask(): GetTaskOperation;
+    /** Bind the task create mutation. */ createTask(): CreateTaskOperation;
+    /** Bind the absolute task update mutation. */ updateTask(): UpdateTaskOperation;
+    /** Bind the comment create mutation. */ addComment(): AddCommentOperation;
+    /** Resolve the current personal token for exactly one operation attempt. */
+    token(call: Call): Promise<string | undefined>;
+    /** Send one Asana JSON request while bounding response bytes and elapsed time. */
+    exchange(call: Call, token: string, method: 'GET' | 'POST' | 'PUT', path: string, query: URLSearchParams, payload?: unknown, signal?: AbortSignal): Promise<Exchange>;
+    /** Build a secret-free receipt, with no Asana request ID header. */
+    receipt(call: Call, providerObjectId?: string): ReceiptDraft;
+    /** Interpret Retry-After with the same bounded SDK parser as other connectors. */
+    retryAfter(exchange: Exchange): number;
+}
+/** Secret-free Asana failure for one manifest operation. */
+declare function failure(operation: string, kind: Failure['kind'], message: string): Failure;
+/** Classify a conclusive provider status without reflecting its free-text body. */
+declare function rejection(operation: string, subject: string, status: number): Failure;
+/** Convert a successful response envelope into one untrusted JSON object. */
+declare function dataObject(exchange: Exchange): Record<string, unknown>;
+
+/** Open the static Asana connection from a Dex project. */
+declare function newProjectConnection(project: LoadedProject, connectionName: string, options?: ClientOptions): Connection;
+
+export { AddCommentBranch, AddCommentBranchAdded, AddCommentBranchDefect, AddCommentBranchNotFound, AddCommentBranchProviderRejected, AddCommentBranchUncertain, AddCommentDefinition, AddCommentInput, AddCommentMetadata, AddCommentOperation, AddCommentOutput, type AddCommentStepConfig, Client, type ClientOptions, Config, Connection, ConnectorID, CreateTaskBranch, CreateTaskBranchCreated, CreateTaskBranchDefect, CreateTaskBranchProviderRejected, CreateTaskBranchUncertain, CreateTaskDefinition, CreateTaskInput, CreateTaskMetadata, CreateTaskOperation, CreateTaskOutput, type CreateTaskStepConfig, Credentials, type Exchange, GetTaskBranch, GetTaskBranchDefect, GetTaskBranchFound, GetTaskBranchInvalidResponse, GetTaskBranchNotFound, GetTaskBranchProviderRejected, GetTaskDefinition, GetTaskInput, GetTaskMetadata, GetTaskOperation, type GetTaskStepConfig, ListTasksBranch, ListTasksBranchDefect, ListTasksBranchInvalidResponse, ListTasksBranchListed, ListTasksBranchNotFound, ListTasksBranchProviderRejected, ListTasksDefinition, ListTasksInput, ListTasksMetadata, ListTasksOperation, ListTasksOutput, type ListTasksStepConfig, ProviderID, Task, UpdateTaskBranch, UpdateTaskBranchDefect, UpdateTaskBranchInvalidResponse, UpdateTaskBranchNotFound, UpdateTaskBranchProviderRejected, UpdateTaskBranchUpdated, UpdateTaskDefinition, UpdateTaskInput, UpdateTaskMetadata, UpdateTaskOperation, UpdateTaskOutput, type UpdateTaskStepConfig, dataObject, failure, newAddCommentStep, newCreateTaskStep, newGetTaskStep, newListTasksStep, newProjectConnection, newUpdateTaskStep, rejection };