@baack-software/baack-ts-tasks 0.0.0-stage → 0.0.1

package/src/types.ts

@@ -0,0 +1,101 @@
+import type {
+  Pagination,
+  TaskActivity,
+  TaskLog,
+  TaskPriority,
+  TaskStatus,
+} from '@baack-software/baack-ts-client';
+
+/**
+ * A reference to another representation by URN. The API resolves references by `urn`, so this is all a request needs,
+ * unlike the client's read types (for example `Identity` requires `owner`).
+ */
+export interface Ref {
+  urn: string;
+  url?: string | null;
+}
+
+/** A URN, or anything carrying one, such as a task or identity read from the API. */
+export type RefLike = string | Ref;
+
+/**
+ * Task log activities, with both spellings of completed: earlier versions of baack-ts-client's `TaskActivity` have only
+ * `STATUS_COMPL_ETED`, later ones only `STATUS_COMPLETED`.
+ */
+export type Activity = TaskActivity | 'STATUS_COMPLETED' | 'STATUS_COMPL_ETED';
+
+/**
+ * Task fields to create or change. The API stores what an update sends, so `TaskClient.update` sends these changes on
+ * top of the whole task (see `updateBody`). Lists are sent whole: the server compares them with the current lists and
+ * logs each addition and removal.
+ */
+export interface TaskInput {
+  owner?: Ref;
+  /** `null` unsets. */
+  assignee?: Ref | null;
+  /** `null` unsets. */
+  project?: Ref | null;
+  /** `null` unsets. */
+  workflowStage?: Ref | null;
+  status?: TaskStatus;
+  priority?: TaskPriority;
+  title?: string;
+  description?: string;
+  /** ISO 8601 in UTC without a zone, see `toTimestamp`. `null` unsets. */
+  dueTimestamp?: string | null;
+  blockedBy?: Ref[];
+  blocking?: Ref[];
+  associatedTasks?: Ref[];
+  associatedEntities?: Ref[];
+  associatedIdentities?: Ref[];
+  associatedCompanies?: Ref[];
+  /** Attributes the change in the activity log without assigning the task. */
+  identityForLogs?: Ref;
+}
+
+/** A new task, with the fields the API requires on create. Build one with `draft`. */
+export interface TaskDraft extends TaskInput {
+  owner: Ref;
+  status: TaskStatus;
+  priority: TaskPriority;
+  title: string;
+  description: string;
+  blockedBy: Ref[];
+  blocking: Ref[];
+  associatedTasks: Ref[];
+  associatedEntities: Ref[];
+  associatedIdentities: Ref[];
+  associatedCompanies: Ref[];
+}
+
+/**
+ * The body of a task update: the whole task as it should be stored. The server requires `urn`, `owner`, `status`,
+ * `priority`, `title` and `description`, and clears any optional field left out. Build one with `updateBody`.
+ */
+export interface TaskUpdate extends TaskDraft {
+  urn: string;
+}
+
+/** One page of a task's activity log, newest first. */
+export interface TaskLogPage {
+  logs: TaskLog[];
+  pagination?: Pagination | null;
+}
+
+/** The fields of a task that hold lists of references. */
+export type TaskListField =
+  | 'blockedBy'
+  | 'blocking'
+  | 'associatedTasks'
+  | 'associatedEntities'
+  | 'associatedIdentities'
+  | 'associatedCompanies';
+
+export const TASK_LIST_FIELDS: readonly TaskListField[] = [
+  'blockedBy',
+  'blocking',
+  'associatedTasks',
+  'associatedEntities',
+  'associatedIdentities',
+  'associatedCompanies',
+];