initiative-plugin-sdk 10.0.1 → 10.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.77.1 (commit d862d0ebd). Do not edit: regenerate.
+ * taken from Initiative 0.78.0 (commit 402991395). Do not edit: regenerate.
  */
 import type { Scope } from "./contract.js";
 /**
@@ -28,6 +28,11 @@ export interface PluginApiArgs {
 }
 /** Initiative's schemas, by name: `PluginApiSchemas["TaskRead"]`. */
 export interface PluginApiSchemas {
+    /**
+     * Who did something to a row: what its `created_by` (made it) or `deleted_by`
+     * (put it in the trash) names.
+     */
+    ActorKind: "member" | "plugin" | "system";
     /**
      * Things that can be archived.
      */
@@ -81,6 +86,9 @@ export interface PluginApiSchemas {
         tag_ids?: number[] | null;
     };
     CalendarEventRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         title: string;
         description: string | null;
         location: string | null;
@@ -96,7 +104,6 @@ export interface PluginApiSchemas {
         calendar_id: number;
         initiative_id: number | null;
         community_id: string;
-        created_by: string | null;
         properties: PluginApiSchemas["PropertySummary"][];
         tags: PluginApiSchemas["TagSummary"][];
         can: PluginApiSchemas["ContentCan"];
@@ -133,12 +140,13 @@ export interface PluginApiSchemas {
         items: PluginApiSchemas["CalendarSummary"][];
     };
     CalendarRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ToolCan"];
         id: number;
-        initiative_id: number | null;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
@@ -148,14 +156,16 @@ export interface PluginApiSchemas {
         name: string;
         description: string | null;
         color: string;
+        initiative_id: number | null;
     };
     CalendarSummary: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ToolCan"];
         id: number;
-        initiative_id: number | null;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
@@ -165,6 +175,7 @@ export interface PluginApiSchemas {
         name: string;
         description: string | null;
         color: string;
+        initiative_id: number | null;
     };
     CalendarUpdate: {
         name?: string | null;
@@ -267,12 +278,13 @@ export interface PluginApiSchemas {
      * values of the collection's metadata.
      */
     CollectionFileSummary: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ToolCan"];
         id: number;
-        initiative_id: number;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
@@ -280,6 +292,7 @@ export interface PluginApiSchemas {
         properties: PluginApiSchemas["PropertySummary"][];
         grants: PluginApiSchemas["ResourceGrantSchema"][];
         name: string;
+        initiative_id: number;
         /**
          * A stored file comes as an empty string, without its path. A URL from
          * elsewhere comes as it is.
@@ -330,6 +343,9 @@ export interface PluginApiSchemas {
      * counted, and the cover is one of those.
      */
     CollectionRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         id: number;
         initiative_id: number;
         community_id: string;
@@ -339,7 +355,6 @@ export interface PluginApiSchemas {
         cover: PluginApiSchemas["CollectionCover"] | null;
         file_count: number;
         hidden_files: PluginApiSchemas["HiddenFiles"];
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         archived_at: string | null;
@@ -373,7 +388,7 @@ export interface PluginApiSchemas {
     CollectionShapeMetadata: {
         name: string;
         type: PluginApiSchemas["MetadataType"];
-        display: "number" | "stars" | "bar" | null;
+        display: "number" | "stars" | "bar" | "clock" | null;
         currency: PluginApiSchemas["CurrencyCode"] | null;
     };
     CollectionUpdate: {
@@ -435,6 +450,9 @@ export interface PluginApiSchemas {
      * task's for a task comment (filled by the service's serializer).
      */
     CommentRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         /**
          * A person is mentioned as `@[](<reference>)`, by your reference for them,
          * with no name: read who they are from the members search (`members:read`).
@@ -454,7 +472,6 @@ export interface PluginApiSchemas {
         wiki_id: number | null;
         contact_id: number | null;
         id: number;
-        created_by: string | null;
         parent_comment_id: number | null;
         created_at: string;
         updated_at: string | null;
@@ -514,49 +531,63 @@ export interface PluginApiSchemas {
         has_prev: boolean;
         items: PluginApiSchemas["ContactSummary"][];
     };
+    /**
+     * The organization a person is `part_of`.
+     */
+    ContactOrganization: {
+        id: number;
+        name: string;
+        initiative_id?: number | null;
+    };
     ContactPhone: {
         label?: string;
         value: string;
     };
     ContactRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ToolCan"];
         id: number;
-        initiative_id: number | null;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
         tags: PluginApiSchemas["TagSummary"][];
         properties: PluginApiSchemas["PropertySummary"][];
         grants: PluginApiSchemas["ResourceGrantSchema"][];
+        initiative_id: number | null;
         name: string;
         is_organization: boolean;
         emails: PluginApiSchemas["ContactDetail"][];
         phones: PluginApiSchemas["ContactDetail"][];
         addresses: PluginApiSchemas["ContactDetail"][];
-        websites: PluginApiSchemas["ContactDetail"][];
+        websites: PluginApiSchemas["ContactWebsite"][];
+        organization: PluginApiSchemas["ContactOrganization"] | null;
     };
     ContactSummary: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ToolCan"];
         id: number;
-        initiative_id: number | null;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
         tags: PluginApiSchemas["TagSummary"][];
         properties: PluginApiSchemas["PropertySummary"][];
         grants: PluginApiSchemas["ResourceGrantSchema"][];
+        initiative_id: number | null;
         name: string;
         is_organization: boolean;
         emails: PluginApiSchemas["ContactDetail"][];
         phones: PluginApiSchemas["ContactDetail"][];
         addresses: PluginApiSchemas["ContactDetail"][];
-        websites: PluginApiSchemas["ContactDetail"][];
+        websites: PluginApiSchemas["ContactWebsite"][];
+        organization: PluginApiSchemas["ContactOrganization"] | null;
     };
     /**
      * A change to a contact. Only what is sent is written; a list sent replaces
@@ -608,12 +639,13 @@ export interface PluginApiSchemas {
         items: PluginApiSchemas["CounterGroupSummary"][];
     };
     CounterGroupRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ToolCan"];
         id: number;
-        initiative_id: number;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
@@ -622,6 +654,7 @@ export interface PluginApiSchemas {
         grants: PluginApiSchemas["ResourceGrantSchema"][];
         name: string;
         description: string | null;
+        initiative_id: number;
         preview: PluginApiSchemas["CounterPreview"][] | null;
         counters: PluginApiSchemas["CounterRead"][];
     };
@@ -630,12 +663,13 @@ export interface PluginApiSchemas {
      * the list was asked for previews, when its first few come along.
      */
     CounterGroupSummary: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ToolCan"];
         id: number;
-        initiative_id: number;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
@@ -644,6 +678,7 @@ export interface PluginApiSchemas {
         grants: PluginApiSchemas["ResourceGrantSchema"][];
         name: string;
         description: string | null;
+        initiative_id: number;
         preview: PluginApiSchemas["CounterPreview"][] | null;
     };
     CounterGroupUpdate: {
@@ -683,6 +718,26 @@ export interface PluginApiSchemas {
     CounterSetCountRequest: {
         count: number | string;
     };
+    /**
+     * How a counter field moves: by `step` a tap, never past `min` or `max`, and
+     * back to `initial` on a reset. A counter with no value holds `initial`.
+     */
+    "CounterSettings-Input": {
+        step?: number;
+        min?: number | null;
+        max?: number | null;
+        initial?: number;
+    };
+    /**
+     * How a counter field moves: by `step` a tap, never past `min` or `max`, and
+     * back to `initial` on a reset. A counter with no value holds `initial`.
+     */
+    "CounterSettings-Output": {
+        step: number;
+        min: number | null;
+        max: number | null;
+        initial: number;
+    };
     CounterSortDirection: "asc" | "desc";
     CounterSortField: "name" | "count";
     CounterSortRequest: {
@@ -738,12 +793,13 @@ export interface PluginApiSchemas {
         items: PluginApiSchemas["FileSummary"][];
     };
     FileRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ToolCan"];
         id: number;
-        initiative_id: number;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
@@ -751,6 +807,7 @@ export interface PluginApiSchemas {
         properties: PluginApiSchemas["PropertySummary"][];
         grants: PluginApiSchemas["ResourceGrantSchema"][];
         name: string;
+        initiative_id: number;
         /**
          * A stored file comes as an empty string, without its path. A URL from
          * elsewhere comes as it is.
@@ -799,12 +856,13 @@ export interface PluginApiSchemas {
         converts_to: PluginApiSchemas["FileType"] | null;
     };
     FileSummary: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ToolCan"];
         id: number;
-        initiative_id: number;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
@@ -812,6 +870,7 @@ export interface PluginApiSchemas {
         properties: PluginApiSchemas["PropertySummary"][];
         grants: PluginApiSchemas["ResourceGrantSchema"][];
         name: string;
+        initiative_id: number;
         /**
          * A stored file comes as an empty string, without its path. A URL from
          * elsewhere comes as it is.
@@ -857,12 +916,14 @@ export interface PluginApiSchemas {
      * version download endpoint by id — `file_url` is intentionally not exposed.
      */
     FileVersionRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         id: number;
         version_number: number;
         file_content_type: string | null;
         file_size: number | null;
         original_filename: string | null;
-        created_by: number | null;
         created_at: string;
         is_current: boolean;
     };
@@ -986,7 +1047,7 @@ export interface PluginApiSchemas {
     /**
      * What a metadata definition's values are.
      */
-    MetadataType: "text" | "number" | "checkbox" | "date" | "datetime" | "url" | "select" | "multi_select" | "user_reference" | "currency" | "scale" | "link" | "badge" | "json";
+    MetadataType: "text" | "number" | "checkbox" | "date" | "datetime" | "url" | "select" | "multi_select" | "user_reference" | "currency" | "scale" | "counter" | "file" | "signature" | "link" | "badge" | "json";
     OccurrenceRequest: {
         start: string;
     };
@@ -1087,12 +1148,13 @@ export interface PluginApiSchemas {
         expires_at?: string | null;
     };
     PostRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ToolCan"];
         id: number;
-        initiative_id: number;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
@@ -1100,6 +1162,7 @@ export interface PluginApiSchemas {
         properties: PluginApiSchemas["PropertySummary"][];
         grants: PluginApiSchemas["ResourceGrantSchema"][];
         name: string;
+        initiative_id: number;
         author: PluginApiSchemas["PluginPerson"] | null;
         /**
          * A person is mentioned as `@[](<reference>)`, by your reference for them,
@@ -1166,12 +1229,13 @@ export interface PluginApiSchemas {
         items: PluginApiSchemas["ProjectRead"][];
     };
     ProjectRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ProjectCan"];
         id: number;
-        initiative_id: number;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
@@ -1183,6 +1247,7 @@ export interface PluginApiSchemas {
         icon: string | null;
         start_date: string | null;
         end_date: string | null;
+        initiative_id: number;
         owner_id: string | null;
         is_template: boolean;
         pinned_at: string | null;
@@ -1220,6 +1285,7 @@ export interface PluginApiSchemas {
         color?: string | null;
         options?: PluginApiSchemas["PropertyOption"][] | null;
         currency?: PluginApiSchemas["CurrencyCode"] | null;
+        counter?: PluginApiSchemas["CounterSettings-Input"] | null;
         initiative_id: number;
         project_id?: number | null;
         collection_id?: number | null;
@@ -1257,6 +1323,7 @@ export interface PluginApiSchemas {
         color: string | null;
         options: PluginApiSchemas["PropertyOption"][] | null;
         currency: PluginApiSchemas["CurrencyCode"] | null;
+        counter: PluginApiSchemas["CounterSettings-Output"] | null;
         id: number;
         initiative_id: number;
         project_id: number | null;
@@ -1273,6 +1340,7 @@ export interface PluginApiSchemas {
         color?: string | null;
         options?: PluginApiSchemas["PropertyOption"][] | null;
         currency?: PluginApiSchemas["CurrencyCode"] | null;
+        counter?: PluginApiSchemas["CounterSettings-Input"] | null;
     };
     /**
      * Envelope for PATCH /property-definitions/{id}.
@@ -1299,6 +1367,14 @@ export interface PluginApiSchemas {
         add?: string[];
         remove?: string[];
     };
+    /**
+     * One step of a counter, up or down, from the value it holds when the step is
+     * written, so two people stepping it at once both count.
+     */
+    PropertyStep: {
+        property_id: number;
+        up: boolean;
+    };
     /**
      * Lightweight property value for embedding in entity reads.
      */
@@ -1312,12 +1388,17 @@ export interface PluginApiSchemas {
         key: string | null;
         options: PluginApiSchemas["PropertyOption"][] | null;
         currency: PluginApiSchemas["CurrencyCode"] | null;
+        counter: PluginApiSchemas["CounterSettings-Output"] | null;
         /**
          * Shaped by the definition's type. For user_reference, a person: id,
          * username, discriminator, display_name and avatar_url, or an PluginPerson
-         * when the reader is an installed plug-in. A plug-in's value is as the
-         * plug-in wrote it: a list field's an array of its elements, newest first,
-         * each with its ref, and a value with a state the state beside it.
+         * when the reader is an installed plug-in. For file, a file: id, name,
+         * file_type and smart_link_url, or its id alone where the reader cannot
+         * open it. For signature, the signer as user (a person, shaped as
+         * user_reference's), the name they typed and when they signed: user, name
+         * and signed_at. A plug-in's value is as the plug-in wrote it: a list
+         * field's an array of its elements, newest first, each with its ref, and a
+         * value with a state the state beside it.
          */
         value: unknown;
     };
@@ -1341,6 +1422,7 @@ export interface PluginApiSchemas {
         merge?: boolean;
         removed?: number[];
         options?: PluginApiSchemas["PropertyOptionsChange"][];
+        steps?: PluginApiSchemas["PropertyStep"][];
     };
     RSVPStatus: "pending" | "accepted" | "declined" | "tentative";
     /**
@@ -1460,6 +1542,9 @@ export interface PluginApiSchemas {
      * Lightweight schema for task list endpoints - excludes heavy nested data
      */
     TaskListRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         title: string;
         priority: PluginApiSchemas["TaskPriority"];
         start_date: string | null;
@@ -1480,7 +1565,6 @@ export interface PluginApiSchemas {
         completed_at: string | null;
         position: number;
         archived_at: string | null;
-        created_by: string | null;
         assignees: PluginApiSchemas["PluginPerson"][];
         recurrence_occurrence_count: number;
         recurrence_shift: number;
@@ -1532,6 +1616,9 @@ export interface PluginApiSchemas {
         is_template: boolean | null;
     };
     TaskRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         title: string;
         priority: PluginApiSchemas["TaskPriority"];
         start_date: string | null;
@@ -1551,7 +1638,6 @@ export interface PluginApiSchemas {
         completed_at: string | null;
         position: number;
         archived_at: string | null;
-        created_by: string | null;
         creator: PluginApiSchemas["PluginPerson"] | null;
         assignees: PluginApiSchemas["PluginPerson"][];
         recurrence_occurrence_count: number;
@@ -1784,6 +1870,9 @@ export interface PluginApiSchemas {
      * One page, opened.
      */
     WikiPageRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         id: number;
         wiki_id: number;
         community_id: string;
@@ -1793,7 +1882,6 @@ export interface PluginApiSchemas {
         is_draft: boolean;
         title: string;
         slug: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         headings: PluginApiSchemas["WikiPageHeading"][];
@@ -1818,6 +1906,9 @@ export interface PluginApiSchemas {
      * One page as the navigation draws it — no body.
      */
     WikiPageSummary: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         id: number;
         wiki_id: number;
         community_id: string;
@@ -1827,7 +1918,6 @@ export interface PluginApiSchemas {
         is_draft: boolean;
         title: string;
         slug: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         headings: PluginApiSchemas["WikiPageHeading"][];
@@ -1862,12 +1952,13 @@ export interface PluginApiSchemas {
      * own, because a wiki is navigated rather than read end to end.
      */
     WikiRead: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ToolCan"];
         id: number;
-        initiative_id: number;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
@@ -1876,6 +1967,7 @@ export interface PluginApiSchemas {
         grants: PluginApiSchemas["ResourceGrantSchema"][];
         name: string;
         description: string | null;
+        initiative_id: number;
         home_page_id: number | null;
         page_order: PluginApiSchemas["WikiPageOrder"];
         contents_depth: number;
@@ -1892,12 +1984,13 @@ export interface PluginApiSchemas {
      */
     WikiReadingWidth: "wide" | "comfortable";
     WikiSummary: {
+        created_by: string | null;
+        created_by_kind: PluginApiSchemas["ActorKind"];
+        created_by_install: number | null;
         archived_at: string | null;
         can: PluginApiSchemas["ToolCan"];
         id: number;
-        initiative_id: number;
         community_id: string;
-        created_by: string | null;
         created_at: string;
         updated_at: string;
         comments_enabled: boolean;
@@ -1906,6 +1999,7 @@ export interface PluginApiSchemas {
         grants: PluginApiSchemas["ResourceGrantSchema"][];
         name: string;
         description: string | null;
+        initiative_id: number;
         home_page_id: number | null;
         page_order: PluginApiSchemas["WikiPageOrder"];
         contents_depth: number;
@@ -4952,8 +5046,8 @@ export declare class PluginApi {
     }): Promise<PluginApiOperations["update_property_definition"]["answer"]>;
     /**
      * 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.
+     * write only the ones named and leave the rest, change options of
+     * multi-select values and step counters 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.77.1 (commit d862d0ebd). Do not edit: regenerate.
+ * taken from Initiative 0.78.0 (commit 402991395). Do not edit: regenerate.
  */
 /**
  * Each operation a plug-in may call: its method, its path after `/api/v1/c/0`, the
@@ -1139,8 +1139,8 @@ export class PluginApi {
     }
     /**
      * 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.
+     * write only the ones named and leave the rest, change options of
+     * multi-select values and step counters against what each holds.
      *
      * `PUT /properties/{target}/{entity_id}`, needs the scope its `target` names.
      */