initiative-plugin-sdk 7.2.0 → 8.1.0

package/dist/plugin-api.generated.d.ts

@@ -1,6 +1,6 @@
 /**
  * Generated by scripts/generate-plugin-api.mjs from schemas/plugin-api.json, the plug-in API
- * taken from Initiative 0.75.3 (commit b79920042). Do not edit: regenerate.
+ * taken from Initiative 0.76.0 (commit 4aa7e8215). Do not edit: regenerate.
  */
 import type { Scope } from "./contract.js";
 /**
@@ -104,11 +104,13 @@ export interface PluginApiSchemas {
         overridden_fields: string[];
         skipped_starts: string[];
         extra_starts: string[];
+        plugin_values: PluginApiSchemas["PluginValueSummary"][];
     };
     CalendarEventUpdate: {
         properties?: PluginApiSchemas["PropertyValueInput"][] | null;
         title?: string | null;
         description?: string | null;
+        description_base?: string | null;
         location?: string | null;
         start_at?: string | null;
         end_at?: string | null;
@@ -207,6 +209,16 @@ export interface PluginApiSchemas {
         completed: number;
         total: number;
     };
+    /**
+     * One limited column of a project's board: its limit, and how many open tasks
+     * it holds.
+     */
+    ColumnFillRead: {
+        project_id: number;
+        status_id: number;
+        limit: number;
+        count: number;
+    };
     /**
      * Who a comment is said to.
      */
@@ -240,6 +252,8 @@ export interface PluginApiSchemas {
     CommentListResponse: {
         comments: PluginApiSchemas["CommentRead"][];
         next_cursor: string | null;
+        locked: boolean;
+        can_moderate: boolean;
     };
     /**
      * One comment. `project_id` is its own for a comment on a project and the
@@ -273,9 +287,18 @@ export interface PluginApiSchemas {
         imported_author_name: string | null;
         reactions: PluginApiSchemas["ReactionGroup"][];
         can_remove: boolean;
+        removed: PluginApiSchemas["CommentRemoval"] | null;
         audience: PluginApiSchemas["CommentAudience"];
         system_kind: string | null;
     };
+    /**
+     * What a tombstone says in place of a comment: who took it out, and, for a
+     * moderator, why. Never what it said, or who wrote it.
+     */
+    CommentRemoval: {
+        by: PluginApiSchemas["RemovedBy"];
+        reason: PluginApiSchemas["RemovalReason"] | null;
+    };
     /**
      * What the caller may do to a piece of content, as the server answers it.
      */
@@ -379,6 +402,7 @@ export interface PluginApiSchemas {
         view_mode: PluginApiSchemas["CounterViewMode"];
         position: string;
         properties: PluginApiSchemas["PropertySummary"][];
+        plugin_values: PluginApiSchemas["PluginValueSummary"][];
         created_at: string;
         updated_at: string;
     };
@@ -411,6 +435,11 @@ export interface PluginApiSchemas {
         position?: number | string | null;
     };
     CounterViewMode: "number" | "progress_bar" | "segmented_clock";
+    /**
+     * What a date is grouped by: the calendar's day, week, month, quarter or year
+     * it falls in. A week starts on Monday, as Postgres counts one.
+     */
+    DateBucket: "day" | "week" | "month" | "quarter" | "year";
     FileCreate: {
         properties?: PluginApiSchemas["PropertyValueInput"][];
         name: string;
@@ -602,12 +631,14 @@ export interface PluginApiSchemas {
         version_count: number;
         tags: PluginApiSchemas["TagSummary"][];
         properties: PluginApiSchemas["PropertySummary"][];
+        plugin_values: PluginApiSchemas["PluginValueSummary"][];
     };
     GalleryImageUpdate: {
         properties?: PluginApiSchemas["PropertyValueInput"][] | null;
         title?: string | null;
         caption?: string | null;
         tag_ids?: number[] | null;
+        caption_base?: string | null;
     };
     /**
      * One stored rendition of a picture.
@@ -691,6 +722,20 @@ export interface PluginApiSchemas {
         description?: string | null;
         cover_image_id?: number | null;
     };
+    /**
+     * One group of a grouped list.
+     */
+    GroupRead: {
+        key: string;
+        label?: string | null;
+    };
+    /**
+     * A list's groups by one field, and the groups each row is in.
+     */
+    GroupsResponse: {
+        groups: PluginApiSchemas["GroupRead"][];
+        rows: Record<string, string[]>;
+    };
     HTTPValidationError: {
         detail?: PluginApiSchemas["ValidationError"][];
     };
@@ -700,6 +745,7 @@ export interface PluginApiSchemas {
     InitiativeCan: {
         manage: boolean;
         moderate: boolean;
+        roster: boolean;
         view: PluginApiSchemas["Tool"][];
         create: PluginApiSchemas["Tool"][];
     };
@@ -787,6 +833,16 @@ export interface PluginApiSchemas {
          */
         avatar_url?: string | null;
     };
+    /**
+     * One value an installed plug-in shows on an item: a key its pinned version
+     * declares as a field there. A list field's value is an array of its
+     * elements, newest first, each with its `ref`.
+     */
+    PluginValueSummary: {
+        plugin_id: number;
+        key: string;
+        value: unknown;
+    };
     PollOptionRead: {
         id: number;
         text: string;
@@ -891,6 +947,7 @@ export interface PluginApiSchemas {
         is_read: boolean;
         read_count: number;
         reactions_enabled: boolean;
+        comments_locked_at: string | null;
         comment_count: number;
         reactions: PluginApiSchemas["ReactionGroup"][];
         /**
@@ -902,6 +959,7 @@ export interface PluginApiSchemas {
          */
         body: Record<string, unknown>;
         poll: PluginApiSchemas["PollRead"] | null;
+        plugin_values: PluginApiSchemas["PluginValueSummary"][];
     };
     PostUpdate: {
         name?: string | null;
@@ -961,10 +1019,9 @@ export interface PluginApiSchemas {
         owner: PluginApiSchemas["PluginPerson"] | null;
         owner_plugin: PluginApiSchemas["OwnerPluginSummary"] | null;
         initiative: PluginApiSchemas["InitiativeSummary"] | null;
-        is_favorited: boolean;
-        last_viewed_at: string | null;
         task_summary: PluginApiSchemas["ProjectTaskSummary"];
         task_statuses: PluginApiSchemas["TaskStatusRead"][];
+        task_types: PluginApiSchemas["TaskTypeRead"][];
     };
     ProjectTaskSummary: {
         total: number;
@@ -1022,6 +1079,16 @@ export interface PluginApiSchemas {
         label: string;
         color?: string | null;
     };
+    /**
+     * Options put on and taken off one multi-select value, against the value as
+     * it stands when the change is written rather than a list that replaces it,
+     * so two people changing different options of it both stand.
+     */
+    PropertyOptionsChange: {
+        property_id: number;
+        add?: string[];
+        remove?: string[];
+    };
     /**
      * Lightweight property value for embedding in entity reads.
      */
@@ -1053,10 +1120,14 @@ export interface PluginApiSchemas {
         value?: unknown;
     };
     /**
-     * Replace-all payload for `PUT /properties/{target}/{entity_id}`.
+     * Payload for `PUT /properties/{target}/{entity_id}`: replace-all, or with
+     * `merge` only the properties it names.
      */
     PropertyValuesSetRequest: {
         values?: PluginApiSchemas["PropertyValueInput"][];
+        merge?: boolean;
+        removed?: number[];
+        options?: PluginApiSchemas["PropertyOptionsChange"][];
     };
     QueueCreate: {
         properties?: PluginApiSchemas["PropertyValueInput"][];
@@ -1090,7 +1161,9 @@ export interface PluginApiSchemas {
         properties: PluginApiSchemas["PropertySummary"][];
         attachment_count: number;
         held_at_round: number | null;
+        created_by: string | null;
         created_at: string;
+        plugin_values: PluginApiSchemas["PluginValueSummary"][];
     };
     QueueItemUpdate: {
         properties?: PluginApiSchemas["PropertyValueInput"][] | null;
@@ -1101,6 +1174,7 @@ export interface PluginApiSchemas {
         notes?: string | null;
         is_visible?: boolean | null;
         tag_ids?: number[] | null;
+        notes_base?: string | null;
     };
     QueueListResponse: {
         total_count: number;
@@ -1180,6 +1254,19 @@ export interface PluginApiSchemas {
         reacted: boolean;
         users: PluginApiSchemas["PluginPerson"][];
     };
+    /**
+     * How a repeating task's next date is counted.
+     */
+    RecurrenceStrategy: "fixed" | "rolling";
+    /**
+     * Why a moderator took something down. Every reason a report can give, and
+     * two that only a community's own rules give.
+     */
+    RemovalReason: "spam" | "harassment" | "hate" | "violence" | "sexual_content" | "self_harm" | "illegal" | "misinformation" | "other" | "off_topic" | "community_rule";
+    /**
+     * Who took a comment out of the conversation.
+     */
+    RemovedBy: "moderator" | "author";
     ResourceAccessLevel: "owner" | "write" | "read";
     /**
      * One `resource_grants` row — exactly the columns that define a grant: a
@@ -1259,12 +1346,14 @@ export interface PluginApiSchemas {
         start_date?: string | null;
         due_date?: string | null;
         recurrence?: string | null;
-        recurrence_strategy?: "fixed" | "rolling";
+        recurrence_strategy?: PluginApiSchemas["RecurrenceStrategy"];
+        recurrence_limit?: number | null;
         description?: string | null;
         project_id: number;
         tz?: string | null;
         assignee_ids?: string[];
         task_status_id?: number | null;
+        task_type_id?: number | null;
         tag_ids?: number[];
         checklist?: PluginApiSchemas["ChecklistItemInput"][];
     };
@@ -1277,13 +1366,16 @@ export interface PluginApiSchemas {
         start_date: string | null;
         due_date: string | null;
         recurrence: string | null;
-        recurrence_strategy: "fixed" | "rolling";
+        recurrence_strategy: PluginApiSchemas["RecurrenceStrategy"];
+        recurrence_limit: number | null;
         description_excerpt: string | null;
         has_description: boolean;
         id: number;
         project_id: number;
         task_status_id: number;
         task_status: PluginApiSchemas["TaskStatusRead"];
+        task_type_id: number;
+        task_type: PluginApiSchemas["TaskTypeRead"];
         created_at: string;
         updated_at: string;
         completed_at: string | null;
@@ -1293,6 +1385,8 @@ export interface PluginApiSchemas {
         assignees: PluginApiSchemas["PluginPerson"][];
         recurrence_occurrence_count: number;
         recurrence_shift: number;
+        recurrence_anchor: string | null;
+        recurrence_anchor_count: number;
         recurrence_until: string | null;
         comment_count: number;
         blocked_by_open_count: number;
@@ -1305,6 +1399,7 @@ export interface PluginApiSchemas {
         checklist_progress: PluginApiSchemas["ChecklistProgress"] | null;
         tags: PluginApiSchemas["TagSummary"][];
         properties: PluginApiSchemas["PropertySummary"][];
+        plugin_values: PluginApiSchemas["PluginValueSummary"][];
     };
     TaskListResponse: {
         total_count: number;
@@ -1334,12 +1429,15 @@ export interface PluginApiSchemas {
         start_date: string | null;
         due_date: string | null;
         recurrence: string | null;
-        recurrence_strategy: "fixed" | "rolling";
+        recurrence_strategy: PluginApiSchemas["RecurrenceStrategy"];
+        recurrence_limit: number | null;
         description: string | null;
         id: number;
         project_id: number;
         task_status_id: number;
         task_status: PluginApiSchemas["TaskStatusRead"];
+        task_type_id: number;
+        task_type: PluginApiSchemas["TaskTypeRead"];
         created_at: string;
         updated_at: string;
         completed_at: string | null;
@@ -1350,6 +1448,8 @@ export interface PluginApiSchemas {
         assignees: PluginApiSchemas["PluginPerson"][];
         recurrence_occurrence_count: number;
         recurrence_shift: number;
+        recurrence_anchor: string | null;
+        recurrence_anchor_count: number;
         recurrence_until: string | null;
         series_id: number | null;
         series_size: number;
@@ -1360,6 +1460,7 @@ export interface PluginApiSchemas {
         checklist_progress: PluginApiSchemas["ChecklistProgress"] | null;
         tags: PluginApiSchemas["TagSummary"][];
         properties: PluginApiSchemas["PropertySummary"][];
+        plugin_values: PluginApiSchemas["PluginValueSummary"][];
     };
     TaskStatusCategory: "backlog" | "todo" | "in_progress" | "done";
     TaskStatusRead: {
@@ -1372,18 +1473,73 @@ export interface PluginApiSchemas {
         id: number;
         project_id: number;
     };
+    /**
+     * One ready-made type, in the reader's language.
+     */
+    TaskTypeGalleryEntry: {
+        key: string;
+        name: string;
+        hint: string;
+        icon: string;
+        color: string;
+        layout_preset: string;
+        fields: PluginApiSchemas["TaskTypeGalleryField"][];
+        starting_values?: PluginApiSchemas["TaskTypeStartingValues"] | null;
+    };
+    TaskTypeGalleryField: {
+        name: string;
+        type: string;
+    };
+    TaskTypeGalleryGroup: {
+        key: string;
+        name: string;
+        entries: PluginApiSchemas["TaskTypeGalleryEntry"][];
+    };
+    /**
+     * One kind of task in a project, and the shape its page is drawn as until the
+     * page is changed.
+     */
+    TaskTypeRead: {
+        id: number;
+        project_id: number;
+        name: string;
+        position: number;
+        is_default: boolean;
+        color: string;
+        icon: string;
+        layout_preset: string;
+        starting_values: PluginApiSchemas["TaskTypeStartingValues"] | null;
+    };
+    /**
+     * What a new task of a type starts with, field by field, where whoever makes
+     * it leaves that field empty. A repeat starts only on a task with a date to
+     * count from.
+     */
+    TaskTypeStartingValues: {
+        description?: string | null;
+        checklist?: string[];
+        priority?: PluginApiSchemas["TaskPriority"] | null;
+        recurrence?: string | null;
+        recurrence_strategy?: PluginApiSchemas["RecurrenceStrategy"] | null;
+    };
     TaskUpdate: {
         properties?: PluginApiSchemas["PropertyValueInput"][] | null;
         title?: string | null;
         description?: string | null;
+        description_base?: string | null;
         task_status_id?: number | null;
+        task_type_id?: number | null;
+        status_category?: PluginApiSchemas["TaskStatusCategory"] | null;
         priority?: PluginApiSchemas["TaskPriority"] | null;
         assignee_ids?: string[] | null;
+        add_assignee_ids?: string[] | null;
+        remove_assignee_ids?: string[] | null;
         start_date?: string | null;
         due_date?: string | null;
         recurrence?: string | null;
         tz?: string | null;
-        recurrence_strategy?: "fixed" | "rolling" | null;
+        recurrence_strategy?: PluginApiSchemas["RecurrenceStrategy"] | null;
+        recurrence_limit?: number | null;
         tag_ids?: number[] | null;
         checklist?: PluginApiSchemas["ChecklistItemInput"][] | null;
         scope?: "this" | "following" | "all" | null;
@@ -1545,6 +1701,7 @@ export interface PluginApiSchemas {
          */
         content: Record<string, unknown>;
         content_version: string | null;
+        comments_locked_at: string | null;
     };
     /**
      * One page as the navigation draws it — no body.
@@ -2092,6 +2249,18 @@ export interface PluginApiOperations {
         };
         answer: PluginApiSchemas["InitiativeTaskStatusRead"][];
     };
+    list_task_types: {
+        path: {
+            project_id: number;
+        };
+        answer: PluginApiSchemas["TaskTypeRead"][];
+    };
+    list_task_type_gallery: {
+        path: {
+            project_id: number;
+        };
+        answer: PluginApiSchemas["TaskTypeGalleryGroup"][];
+    };
     list_tasks: {
         query: {
             /**
@@ -2124,6 +2293,29 @@ export interface PluginApiOperations {
         body: PluginApiSchemas["TaskCreate"];
         answer: PluginApiSchemas["TaskRead"];
     };
+    list_task_groups: {
+        query: {
+            /**
+             * The field the list is grouped by, as the field catalog's `groupings`
+             * name it, or `property:<id>`
+             */
+            group_by: string;
+            /**
+             * For a date: the bucket of the calendar it groups by
+             */
+            bucket?: PluginApiSchemas["DateBucket"] | null;
+            conditions?: Array<PluginApiSchemas["FilterCondition"] | PluginApiSchemas["FilterGroup"]>;
+            include_archived?: boolean;
+            tz?: string | null;
+        };
+        answer: PluginApiSchemas["GroupsResponse"];
+    };
+    list_column_limits: {
+        query: {
+            project_id: number[];
+        };
+        answer: PluginApiSchemas["ColumnFillRead"][];
+    };
     read_task: {
         path: {
             task_id: number;
@@ -3094,6 +3286,16 @@ export declare const pluginApiOperations: {
         readonly path: "/initiatives/{initiative_id}/task-statuses/";
         readonly scope: "projects:read";
     };
+    readonly list_task_types: {
+        readonly method: "GET";
+        readonly path: "/projects/{project_id}/task-types/";
+        readonly scope: "projects:read";
+    };
+    readonly list_task_type_gallery: {
+        readonly method: "GET";
+        readonly path: "/projects/{project_id}/task-types/gallery";
+        readonly scope: "projects:read";
+    };
     readonly list_tasks: {
         readonly method: "GET";
         readonly path: "/tasks/";
@@ -3105,6 +3307,17 @@ export declare const pluginApiOperations: {
         readonly path: "/tasks/";
         readonly scope: "projects:write";
     };
+    readonly list_task_groups: {
+        readonly method: "GET";
+        readonly path: "/tasks/groups";
+        readonly scope: "projects:read";
+        readonly json: readonly ["conditions"];
+    };
+    readonly list_column_limits: {
+        readonly method: "GET";
+        readonly path: "/tasks/column-limits";
+        readonly scope: "projects:read";
+    };
     readonly read_task: {
         readonly method: "GET";
         readonly path: "/tasks/{task_id}";
@@ -3819,6 +4032,23 @@ export declare class PluginApi {
     listInitiativeTaskStatuses(args: {
         path: PluginApiOperations["list_initiative_task_statuses"]["path"];
     }): Promise<PluginApiOperations["list_initiative_task_statuses"]["answer"]>;
+    /**
+     * List Task Types
+     *
+     * `GET /projects/{project_id}/task-types/`, needs `projects:read`.
+     */
+    listTaskTypes(args: {
+        path: PluginApiOperations["list_task_types"]["path"];
+    }): Promise<PluginApiOperations["list_task_types"]["answer"]>;
+    /**
+     * The ready-made types the project can add, grouped by what they are for, in
+     * the reader's language.
+     *
+     * `GET /projects/{project_id}/task-types/gallery`, needs `projects:read`.
+     */
+    listTaskTypeGallery(args: {
+        path: PluginApiOperations["list_task_type_gallery"]["path"];
+    }): Promise<PluginApiOperations["list_task_type_gallery"]["answer"]>;
     /**
      * List Tasks
      *
@@ -3835,6 +4065,25 @@ export declare class PluginApi {
     createTask(args: {
         body: PluginApiOperations["create_task"]["body"];
     }): Promise<PluginApiOperations["create_task"]["answer"]>;
+    /**
+     * The groups of the task list these filters answer with, in the order the
+     * list shows them, and the groups each task is in.
+     *
+     * `GET /tasks/groups`, needs `projects:read`.
+     */
+    listTaskGroups(args: {
+        query: PluginApiOperations["list_task_groups"]["query"];
+    }): Promise<PluginApiOperations["list_task_groups"]["answer"]>;
+    /**
+     * Each limited board column of the named projects the reader can open: its
+     * limit, and how many open tasks it holds. A project with no limits, or one
+     * the reader can't open, has none.
+     *
+     * `GET /tasks/column-limits`, needs `projects:read`.
+     */
+    listColumnLimits(args: {
+        query: PluginApiOperations["list_column_limits"]["query"];
+    }): Promise<PluginApiOperations["list_column_limits"]["answer"]>;
     /**
      * Read Task
      *
@@ -4717,7 +4966,9 @@ export declare class PluginApi {
         body: PluginApiOperations["update_property_definition"]["body"];
     }): Promise<PluginApiOperations["update_property_definition"]["answer"]>;
     /**
-     * Replace the custom property values on one tool or sub-tool.
+     * Replace the custom property values on one tool or sub-tool, or with `merge`
+     * write only the ones named and leave the rest, and change options of
+     * multi-select values against what each holds.
      *
      * `PUT /properties/{target}/{entity_id}`, needs the scope its `target` names.
      */

package/dist/plugin-api.generated.js

@@ -1,6 +1,6 @@
 /**
  * Generated by scripts/generate-plugin-api.mjs from schemas/plugin-api.json, the plug-in API
- * taken from Initiative 0.75.3 (commit b79920042). Do not edit: regenerate.
+ * taken from Initiative 0.76.0 (commit 4aa7e8215). Do not edit: regenerate.
  */
 /**
  * Each operation a plug-in may call: its method, its path after `/api/v1/c/0`, the
@@ -29,8 +29,12 @@ export const pluginApiOperations = {
     update_project: { method: "PATCH", path: "/projects/{project_id}", scope: "projects:write" },
     list_task_statuses: { method: "GET", path: "/projects/{project_id}/task-statuses/", scope: "projects:read" },
     list_initiative_task_statuses: { method: "GET", path: "/initiatives/{initiative_id}/task-statuses/", scope: "projects:read" },
+    list_task_types: { method: "GET", path: "/projects/{project_id}/task-types/", scope: "projects:read" },
+    list_task_type_gallery: { method: "GET", path: "/projects/{project_id}/task-types/gallery", scope: "projects:read" },
     list_tasks: { method: "GET", path: "/tasks/", scope: "projects:read", json: ["conditions", "sorting"] },
     create_task: { method: "POST", path: "/tasks/", scope: "projects:write" },
+    list_task_groups: { method: "GET", path: "/tasks/groups", scope: "projects:read", json: ["conditions"] },
+    list_column_limits: { method: "GET", path: "/tasks/column-limits", scope: "projects:read" },
     read_task: { method: "GET", path: "/tasks/{task_id}", scope: "projects:read" },
     update_task: { method: "PATCH", path: "/tasks/{task_id}", scope: "projects:write" },
     move_task: { method: "POST", path: "/tasks/{task_id}/move", scope: "projects:write" },
@@ -317,6 +321,23 @@ export class PluginApi {
     listInitiativeTaskStatuses(args) {
         return this.call("list_initiative_task_statuses", args);
     }
+    /**
+     * List Task Types
+     *
+     * `GET /projects/{project_id}/task-types/`, needs `projects:read`.
+     */
+    listTaskTypes(args) {
+        return this.call("list_task_types", args);
+    }
+    /**
+     * The ready-made types the project can add, grouped by what they are for, in
+     * the reader's language.
+     *
+     * `GET /projects/{project_id}/task-types/gallery`, needs `projects:read`.
+     */
+    listTaskTypeGallery(args) {
+        return this.call("list_task_type_gallery", args);
+    }
     /**
      * List Tasks
      *
@@ -333,6 +354,25 @@ export class PluginApi {
     createTask(args) {
         return this.call("create_task", args);
     }
+    /**
+     * The groups of the task list these filters answer with, in the order the
+     * list shows them, and the groups each task is in.
+     *
+     * `GET /tasks/groups`, needs `projects:read`.
+     */
+    listTaskGroups(args) {
+        return this.call("list_task_groups", args);
+    }
+    /**
+     * Each limited board column of the named projects the reader can open: its
+     * limit, and how many open tasks it holds. A project with no limits, or one
+     * the reader can't open, has none.
+     *
+     * `GET /tasks/column-limits`, needs `projects:read`.
+     */
+    listColumnLimits(args) {
+        return this.call("list_column_limits", args);
+    }
     /**
      * Read Task
      *
@@ -1153,7 +1193,9 @@ export class PluginApi {
         return this.call("update_property_definition", args);
     }
     /**
-     * Replace the custom property values on one tool or sub-tool.
+     * Replace the custom property values on one tool or sub-tool, or with `merge`
+     * write only the ones named and leave the rest, and change options of
+     * multi-select values against what each holds.
      *
      * `PUT /properties/{target}/{entity_id}`, needs the scope its `target` names.
      */