@plotday/twister 0.52.0 → 0.54.0

package/src/tools/files.ts

@@ -0,0 +1,37 @@
+import { ITool } from "..";
+
+/**
+ * Built-in tool for reading files attached to notes in Plot.
+ *
+ * Files are uploaded by clients via POST /files which creates an
+ * ActionType.file entry on a note. Connectors call read() during outbound
+ * (e.g. onNoteCreated) to retrieve those bytes and send them to the source
+ * system.
+ *
+ * For inbound attachments, connectors emit ActionType.fileRef actions and
+ * implement Connector.downloadAttachment — no upload tool is needed because
+ * inbound bytes never enter Plot's R2 storage.
+ */
+export abstract class Files extends ITool {
+  /**
+   * Read a file uploaded by a client and attached to a note in a focus
+   * where this twist is installed.
+   *
+   * @param fileId The id from an ActionType.file action.
+   * @returns Bytes plus original metadata.
+   * @throws FileNotFoundError if the file is missing or out of scope.
+   */
+  abstract read(fileId: string): Promise<{
+    data: Uint8Array;
+    fileName: string;
+    mimeType: string;
+    fileSize: number;
+  }>;
+}
+
+export class FileNotFoundError extends Error {
+  constructor(fileId: string) {
+    super(`File not found or out of scope: ${fileId}`);
+    this.name = "FileNotFoundError";
+  }
+}

package/src/tools/index.ts

@@ -1,6 +1,7 @@
 export * from "./twists";
 export * from "./ai";
 export * from "./callbacks";
+export * from "./files";
 export * from "./integrations";
 export * from "./network";
 export * from "./plot";

package/src/tools/integrations.ts

@@ -4,9 +4,7 @@ import {
   type NewContact,
   type NewLinkWithNotes,
   ITool,
-  Serializable,
 } from "..";
-import { Tag } from "../tag";
 import type { JSONValue } from "../utils/types";
 import type { Uuid } from "../utils/uuid";
 
@@ -34,6 +32,13 @@ export type LinkTypeConfig = {
   type: string;
   /** Human-readable label (e.g., "Issue", "Pull Request") */
   label: string;
+  /**
+   * Connector's word for a note on a linked item of this type — used by the
+   * Flutter app to adapt note/composer copy ("Add a comment" on Linear,
+   * "Add a message" on Slack, "Add a reply" on Gmail). Defaults to "note"
+   * when omitted. Use the singular noun in title case (e.g. "Comment").
+   */
+  noteLabel?: string;
   /** URL to an icon for this link type (light mode). Prefer Iconify `logos/*` URLs. */
   logo?: string;
   /** URL to an icon for dark mode. Use when the default logo is invisible on dark backgrounds (e.g., Iconify `simple-icons/*` with `?color=`). */
@@ -46,8 +51,6 @@ export type LinkTypeConfig = {
     status: string;
     /** Human-readable label (e.g., "Open", "Done") */
     label: string;
-    /** Tag to propagate to thread when this status is active (e.g., Tag.Done) */
-    tag?: Tag;
     /** Whether this status represents completion (done, closed, merged, cancelled, etc.) */
     done?: boolean;
     /**
@@ -59,41 +62,128 @@ export type LinkTypeConfig = {
      */
     active?: boolean;
     /**
-     * Mark the thread `task=true` in Plot when a link enters this status.
-     * Use for project-tracker assignments — Linear / Todoist / Jira / etc.
-     * `task` puts the thread on the user's task list without flooding their
-     * inbox under `active`: the user explicitly flips it to `active` when
-     * they decide to start.
-     */
-    task?: boolean;
-    /**
-     * Mark the thread `to_read=true` in Plot when a link enters this status.
-     * Use for connectors that explicitly track read-later state (Pocket
-     * archives, Slack "remind me", etc).
-     */
-    toRead?: boolean;
-    /**
-     * @deprecated Use `active` (messaging) or `task` (project tracker) instead.
-     * Treated as `task: true` for backward compatibility.
-     *
-     * Original meaning: whether this status represents the connector's
-     * "to-do" / active state. When a user adds a thread to Plot's agenda,
-     * done-status links flip to the status marked `todo: true` (e.g.,
-     * Gmail's "starred", Linear's "todo").
+     * Marks this status as the connector's "to-do" / active state. When a
+     * user brings a done thread back into Plot's agenda, done-status links
+     * are flipped to the status marked `todo: true` (e.g. Gmail's "starred",
+     * Linear's "unstarted"); connectors that don't mark one fall back to the
+     * first non-done status.
      */
     todo?: boolean;
-    /**
-     * Default status applied when Plot asks the connector to create a new
-     * item of this type via `Connector.onCreateLink`. Declaring at least one
-     * status with `createDefault: true` is how a link type opts in to
-     * Plot-initiated creation. At most one status per type should set this.
-     */
-    createDefault?: boolean;
   }>;
   /** Whether this link type supports displaying and changing the assignee */
   supportsAssignee?: boolean;
   /** Default thread creation mode for this link type: 'all' | 'actionable' | 'manual' */
   defaultCreateThreads?: string;
+  /**
+   * Opt-in: declares this link type is composable from Plot via
+   * `Connector.onCreateLink`. Omit to make the link type sync-only (no
+   * "Create new …" picker entry).
+   *
+   * Connectors that need multiple compose modes for what users perceive as
+   * the same kind of thing (e.g. Slack channel post vs DM) should declare
+   * **separate linkTypes**, one per user-facing thread type. That keeps
+   * each linkType isomorphic to one filter chip.
+   */
+  compose?: ComposeConfig;
+  /**
+   * Per-connector contact roles. Examples:
+   *   email   → [{id:"to",label:"To",default:true},{id:"cc",label:"CC"},{id:"bcc",label:"BCC",hidden:true}]
+   *   calendar → [{id:"required",label:"Required",default:true},{id:"optional",label:"Optional"}]
+   *
+   * Plot uses this list to render a role picker on each contact chip in the
+   * composer and to label non-default roles on existing threads. Exactly one
+   * role should be marked `default: true`. Connectors that don't distinguish
+   * roles (Slack, Linear) omit this field entirely.
+   */
+  contactRoles?: ContactRoleConfig[];
+  /**
+   * Whether contacts on an existing thread can be added, removed, or have
+   * their role changed (email-style mid-thread recipient changes). When
+   * false, the thread's contact list is fixed after creation. Defaults to
+   * false when omitted.
+   */
+  supportsContactChanges?: boolean;
+  /**
+   * Declares how sharing on threads of this link type is scoped:
+   *
+   * - `"thread"` (default): one roster shared across all notes in the
+   *   thread. Native Plot threads, Slack DMs, calendar events.
+   * - `"channel"`: visibility is the external channel's membership;
+   *   the per-thread `contacts` array is ignored for sharing UI.
+   *   Slack channels, Linear projects.
+   * - `"message"`: each note carries its own recipient set via
+   *   `note.access_contacts`; the thread roster is the union across
+   *   all messages. Email.
+   *
+   * Omit to default to `"thread"`. When set to `"message"`, every
+   * note this connector ingests must populate `access_contacts`
+   * explicitly (never NULL).
+   */
+  sharingModel?: "thread" | "channel" | "message";
+};
+
+/**
+ * Declares how a link type is composable from Plot via
+ * `Connector.onCreateLink`. Attached to {@link LinkTypeConfig.compose}.
+ */
+export type ComposeConfig = {
+  /**
+   * Selects the destination model for the "Create new …" picker.
+   *
+   * - `"channels"` (default): one chip per enabled channel (e.g. a Linear
+   *   team, a Slack channel). Existing behaviour for task-tracker / calendar
+   *   connectors.
+   * - `"contacts"`: one chip per connection (account); the user picks
+   *   recipients from their contacts. The runtime pre-resolves the chosen
+   *   Plot contacts to platform account IDs via the per-connection
+   *   `contact_external_account` rows and delivers them as
+   *   `CreateLinkDraft.recipients`. Contacts without a row for this specific
+   *   connection are filtered out of the picker — used by closed-roster
+   *   messaging platforms (Slack DM, Teams DM, Google Chat DM, LinkedIn DM).
+   * - `"addresses"`: one chip per connection; the picker accepts any
+   *   contact with an addressable identifier (e.g. an email) or a free-form
+   *   typed address. The runtime fills `recipients` for contacts with a
+   *   connection-scoped row and falls back to the contact's primary address
+   *   (e.g. `contact.email`) when no row exists. Free-form addresses arrive
+   *   via the thread's `inviteEmails`. Used by open address spaces like
+   *   Gmail.
+   */
+  targets?: "channels" | "contacts" | "addresses";
+  /**
+   * Status to assign newly-created links. Should match an entry in the
+   * parent linkType's `statuses[]`, OR a symbolic id that the connector's
+   * `onCreateLink` resolves itself (e.g. Linear's `"unstarted"` category is
+   * resolved per-team to a state UUID inside the connector — see
+   * `connectors/linear/src/linear.ts`).
+   */
+  status: string;
+  /**
+   * Optional override for the picker chip / "Create new …" copy. Defaults
+   * to the parent linkType's `label`. Use to disambiguate compose entries
+   * when the parent label alone isn't specific enough (e.g. "Direct
+   * messages" for a DM-mode compose on a chat connector).
+   */
+  label?: string;
+};
+
+/**
+ * Declares one contact role for a connector's link type. See
+ * `LinkTypeConfig.contactRoles`.
+ */
+export type ContactRoleConfig = {
+  /** Stable machine id, e.g. "to" / "cc" / "bcc" / "required" / "optional". */
+  id: string;
+  /** Display label shown next to a contact chip, e.g. "To", "CC", "Required". */
+  label: string;
+  /** Exactly one role per linkType should be marked default. */
+  default?: boolean;
+  /**
+   * Hidden roles are visible only to (a) the contact themselves and
+   * (b) the user who added them. The API filters them out of every other
+   * viewer's `thread.contacts` and `thread.contactMeta`. Use for BCC-style
+   * semantics where other recipients must not see the hidden contact.
+   */
+  hidden?: boolean;
 };
 
 /**
@@ -210,32 +300,7 @@ export abstract class Integrations extends ITool {
   abstract get(provider: AuthProvider, channelId: string): Promise<AuthToken | null>;
 
   /**
-   * Execute a callback as a specific actor, requesting auth if needed.
-   *
-   * If the actor has a valid token, calls the callback immediately with it.
-   * If the actor has no token, creates a private auth note in the specified
-   * activity prompting them to connect. Once they authorize, this callback fires.
-   *
-   * @param provider - The OAuth provider
-   * @param actorId - The actor to act as
-   * @param activityId - The activity to create an auth note in (if needed)
-   * @param callback - Function to call with the token
-   * @param extraArgs - Additional arguments to pass to the callback
-   */
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  abstract actAs<
-    TArgs extends Serializable[],
-    TCallback extends (token: AuthToken, ...args: TArgs) => any
-  >(
-    provider: AuthProvider,
-    actorId: ActorId,
-    activityId: Uuid,
-    callback: TCallback,
-    ...extraArgs: TArgs
-  ): Promise<void>;
-
-  /**
-   * Saves a link with notes to the connector's priority.
+   * Saves a link with notes to the connector's focus.
    *
    * Creates a thread+link pair. The thread is a lightweight container;
    * the link holds the external entity data (source, meta, type, status, etc.).
@@ -274,10 +339,15 @@ export abstract class Integrations extends ITool {
   abstract saveLinks(links: NewLinkWithNotes[]): Promise<(Uuid | null)[]>;
 
   /**
-   * Saves contacts to the connector's priority.
+   * Upserts contacts into the connector's focus without requiring a Link.
+   *
+   * Use this for messaging connectors to bulk-sync workspace members so the
+   * recipient picker can filter contacts by reachable platform account. Populate
+   * `NewContact.source` to persist `contact_external_account` rows (the platform
+   * identity used to address the contact). Returns one `Actor` per input, in order.
    *
-   * @param contacts - Array of contacts to save
-   * @returns Promise resolving to the saved actors
+   * @param contacts - Contacts to upsert, keyed by `source`/`key`
+   * @returns Promise resolving to the saved actors, 1:1 with input order
    */
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   abstract saveContacts(contacts: NewContact[]): Promise<Actor[]>;

package/src/tools/plot.ts

@@ -10,12 +10,12 @@ import {
   type NewThread,
   type NewThreadWithNotes,
   type NewNote,
-  type NewPriority,
+  type NewFocus,
   type Note,
   type NoteUpdate,
   type PlanOperation,
-  type Priority,
-  type PriorityUpdate,
+  type Focus,
+  type FocusUpdate,
   Uuid,
 } from "..";
 import {
@@ -38,23 +38,23 @@ export enum ThreadAccess {
   Create,
   /**
    * List/query all Threads owned by the twist's user.
-   * Update any Thread (title, tags, archived, type, priority) regardless of creator.
+   * Update any Thread (title, tags, archived, type, focus) regardless of creator.
    * Create Notes on any Thread (not just own or mentioned).
    * All Create permissions.
    */
   Full,
 }
 
-export enum PriorityAccess {
+export enum FocusAccess {
   /**
-   * Create new Priorities under the twist owner's priority tree.
-   * Update Priorities created by the twist.
+   * Create new Focuses for the twist owner.
+   * Update Focuses created by the twist.
    */
   Create,
   /**
-   * Read all Priorities owned by the twist's user.
-   * Create new Priorities under the twist owner's priority tree.
-   * Update and archive any Priority owned by the twist's user.
+   * Read all Focuses owned by the twist's user.
+   * Create new Focuses for the twist owner.
+   * Update and archive any Focus owned by the twist's user.
    */
   Full,
 }
@@ -100,7 +100,7 @@ export type LinkFilter = {
 
 type SearchResultBase = {
   thread: { id: string; title: string | null };
-  priority: { id: string; title: string | null };
+  focus: { id: string; title: string | null };
   similarity: number;
 };
 
@@ -131,18 +131,17 @@ export type SearchOptions = {
   /** Minimum similarity score 0-1 (default: 0.3) */
   threshold?: number;
   /**
-   * Scope search to this priority + descendants. Must be owned by the twist
-   * owner. When omitted, the server scopes the search to the owner's entire
-   * priority tree.
+   * Scope search to this focus. Must be owned by the twist owner. When
+   * omitted, the server scopes the search across all of the owner's focuses.
    */
-  priorityId?: string;
+  focusId?: string;
 };
 
 /**
  * Built-in tool for interacting with the core Plot data layer.
  *
  * The Plot tool provides twists with the ability to create and manage threads,
- * priorities, and contacts within the Plot system. This is the primary interface
+ * focuses, and contacts within the Plot system. This is the primary interface
  * for twists to persist data and interact with the Plot database.
  *
  * @example
@@ -203,8 +202,8 @@ export abstract class Plot extends ITool {
    *         }],
    *       },
    *       link: true,
-   *       priority: {
-   *         access: PriorityAccess.Full
+   *       focus: {
+   *         access: FocusAccess.Full
    *       },
    *       contact: {
    *         access: ContactAccess.Read
@@ -247,14 +246,35 @@ export abstract class Plot extends ITool {
        * ```
        */
       intents?: NoteIntentHandler[];
+      /**
+       * Single conversational handler for mentions.
+       *
+       * When set, EVERY mention of this twist is routed directly to this
+       * handler — intent matching (and the built-in "What can you do?" /
+       * "Remove yourself" intents) is skipped. Use this to build a
+       * general-purpose conversational assistant that responds to any
+       * request, rather than classifying into a fixed set of `intents`.
+       *
+       * `handler` and `intents` are mutually exclusive; when both are
+       * present, `handler` takes precedence and `intents` is ignored.
+       *
+       * @example
+       * ```typescript
+       * note: {
+       *   defaultMention: true,
+       *   handler: this.respond, // (note: Note) => Promise<void>
+       * }
+       * ```
+       */
+      handler?: (note: Note) => Promise<void>;
     };
     /** Enable link processing from connected source channels. */
     link?: true | {
       /** Access level for links. When omitted with `link: true`, only source channel links are accessible. */
       access?: LinkAccess;
     };
-    priority?: {
-      access?: PriorityAccess;
+    focus?: {
+      access?: FocusAccess;
     };
     contact?: {
       access?: ContactAccess;
@@ -262,7 +282,7 @@ export abstract class Plot extends ITool {
     /** Enable semantic search across notes and links owned by the twist's user. */
     search?: true;
     /**
-     * When true, admin write operations (on threads/notes/links/priorities not created by this twist)
+     * When true, admin write operations (on threads/notes/links/focuses not created by this twist)
      * require user approval via plan actions instead of executing immediately.
      * Read operations and operations on the twist's own content still work directly.
      */
@@ -313,8 +333,7 @@ export abstract class Plot extends ITool {
    * For tags, provide a Record<number, boolean> where true adds a tag and false removes it.
    * Tags not included in the update remain unchanged.
    *
-   * When updating the parent, the thread's path will be automatically recalculated to
-   * maintain the correct hierarchical structure.
+   * Set `focus` to move the thread to a different focus.
    *
    * Scheduling is handled separately via `createSchedule()` / `updateSchedule()`.
    *
@@ -481,41 +500,41 @@ export abstract class Plot extends ITool {
   abstract getNote(note: { id: Uuid } | { key: string }): Promise<Note | null>;
 
   /**
-   * Creates a new priority in the Plot system.
+   * Creates a new focus in the Plot system.
    *
-   * Priorities serve as organizational containers for threads and twists.
-   * The created priority will be automatically assigned a unique ID.
+   * Focuses serve as organizational containers for threads and twists.
+   * The created focus will be automatically assigned a unique ID.
    *
-   * @param priority - The priority data to create
-   * @returns Promise resolving to the complete created priority
+   * @param focus - The focus data to create
+   * @returns Promise resolving to the complete created focus
    */
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  abstract createPriority(priority: NewPriority): Promise<Priority & { created: boolean }>;
+  abstract createFocus(focus: NewFocus): Promise<Focus & { created: boolean }>;
 
   /**
-   * Retrieves a priority by ID or key.
+   * Retrieves a focus by ID or key.
    *
-   * Archived priorities are included in the results.
+   * Archived focuses are included in the results.
    *
-   * @param priority - Priority lookup by ID or key
-   * @returns Promise resolving to the matching priority or null if not found
+   * @param focus - Focus lookup by ID or key
+   * @returns Promise resolving to the matching focus or null if not found
    */
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  abstract getPriority(
-    priority: { id: Uuid } | { key: string }
-  ): Promise<Priority | null>;
+  abstract getFocus(
+    focus: { id: Uuid } | { key: string }
+  ): Promise<Focus | null>;
 
   /**
-   * Updates an existing priority in the Plot system.
+   * Updates an existing focus in the Plot system.
    *
-   * The priority is identified by either its ID or key.
+   * The focus is identified by either its ID or key.
    * Only the fields specified in the update will be changed.
    *
-   * @param update - Priority update containing ID/key and fields to change
+   * @param update - Focus update containing ID/key and fields to change
    * @returns Promise that resolves when the update is complete
    */
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  abstract updatePriority(update: PriorityUpdate): Promise<void>;
+  abstract updateFocus(update: FocusUpdate): Promise<void>;
 
   /**
    * Retrieves actors by their IDs.
@@ -611,12 +630,10 @@ export abstract class Plot extends ITool {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   abstract getThreads(options?: {
     /**
-     * Priority to list threads from. Must be owned by the twist owner.
-     * When omitted, defaults to the owner's root priority.
+     * Focus to list threads from. Must be owned by the twist owner.
+     * When omitted, defaults to the owner's Inbox.
      */
-    priorityId?: Uuid;
-    /** Include threads from descendant priorities. Default: true. */
-    includeDescendants?: boolean;
+    focusId?: Uuid;
     /** Include archived threads. Default: false. */
     includeArchived?: boolean;
     /** Maximum number of threads to return. Default: 50, max: 200. */
@@ -626,25 +643,18 @@ export abstract class Plot extends ITool {
   }): Promise<Thread[]>;
 
   /**
-   * Lists priorities owned by the twist's user.
+   * Lists focuses owned by the twist's user.
    *
-   * Requires `PriorityAccess.Full`.
+   * Requires `FocusAccess.Full`.
    *
-   * @param options - Query options for filtering priorities
-   * @returns Promise resolving to array of priorities
+   * @param options - Query options for filtering focuses
+   * @returns Promise resolving to array of focuses
    */
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  abstract getPriorities(options?: {
-    /**
-     * Parent priority to list children of. Must be owned by the twist
-     * owner. When omitted, defaults to the owner's root priority.
-     */
-    parentId?: Uuid;
-    /** Include all descendants, not just direct children. Default: false. */
-    includeDescendants?: boolean;
-    /** Include archived priorities. Default: false. */
+  abstract getFocuses(options?: {
+    /** Include archived focuses. Default: false. */
     includeArchived?: boolean;
-  }): Promise<Priority[]>;
+  }): Promise<Focus[]>;
 
   /**
    * Updates a link.

package/src/tools/twists.ts

@@ -46,7 +46,7 @@ export type Log = {
  *   },
  *   "plot": {
  *     "thread:mentioned": ["read", "write", "update"],
- *     "priority": ["read", "write", "update"]
+ *     "focus": ["read", "write", "update"]
  *   }
  * }
  * ```
@@ -77,7 +77,7 @@ export type TwistPermissions = Record<string, Record<string, string[]>>;
  */
 export abstract class Twists extends ITool {
   /**
-   * Creates a new twist ID and grants access to people in the current priority.
+   * Creates a new twist ID and grants access to people in the current focus.
    *
    * @returns Promise resolving to the generated twist ID
    * @throws When twist creation fails

package/src/twist.ts

@@ -10,9 +10,9 @@ import type { InferTools, ToolBuilder, ToolShed } from "./utils/types";
  * Base class for all twists.
  *
  * A twist is installed at the workspace level and is owned by a single user
- * (see `this.userId`). It has no inherent priority scope: threads, notes, and
- * links it creates are filed against the owner's priorities, with automatic
- * priority matching when no explicit target is provided.
+ * (see `this.userId`). It has no inherent focus scope: threads, notes, and
+ * links it creates are filed against the owner's focuses, with automatic
+ * focus matching when no explicit target is provided.
  *
  * Override `build()` to declare tool dependencies and lifecycle methods to
  * handle events.

package/dist/docs/types/plot.NewPriority.html

@@ -1,15 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>NewPriority | Creating Plot Twists</title><link rel="icon" href="../assets/favicon.svg" type="image/svg+xml"/><meta name="description" content="Documentation for Creating Plot Twists"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="/" class="title">Creating Plot Twists</a><div id="tsd-toolbar-links"><a href="https://plot.day">Plot</a><a href="https://github.com/plotday/plot">GitHub</a><a href="https://www.npmjs.com/package/@plotday/twister">NPM</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/plot.html">plot</a></li><li><a href="" aria-current="page">NewPriority</a></li></ul><h1>Type Alias NewPriority</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">NewPriority</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pick</span><span class="tsd-signature-symbol">&lt;</span><a href="plot.Priority.html" class="tsd-signature-type tsd-kind-type-alias">Priority</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;title&quot;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="plot.Priority.html" class="tsd-signature-type tsd-kind-type-alias">Priority</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;id&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;title&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">&amp;</span> (<br/>    <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <a href="index.Uuid.html" class="tsd-signature-type tsd-kind-type-alias">Uuid</a> <span class="tsd-signature-symbol">}</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{}</span><br/>) <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">parent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <a href="index.Uuid.html" class="tsd-signature-type tsd-kind-type-alias">Uuid</a> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Type for creating new priorities.</p>
-<p>Supports multiple creation patterns:</p>
-<ul>
-<li>Provide a specific UUID for the priority</li>
-<li>Provide a key for upsert within the user's priorities</li>
-<li>Omit both to auto-generate a new UUID</li>
-</ul>
-<p>Optionally specify a parent priority by ID or key for hierarchical structures.</p>
-</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul><li><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <a href="index.Uuid.html" class="tsd-signature-type tsd-kind-type-alias">Uuid</a> <span class="tsd-signature-symbol">}</span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">: </span><a href="index.Uuid.html" class="tsd-signature-type tsd-kind-type-alias">Uuid</a></h5><div class="tsd-comment tsd-typography"><p>Unique identifier for the priority, generated by Uuid.Generate().
-Specifying an ID allows tools to track and upsert priorities.</p>
-</div></li></ul></li><li><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Unique key for the priority within the user's priorities.
-Can be used to upsert without knowing the UUID.
-For example, &quot;@plot&quot; identifies the Plot priority.</p>
-</div></li></ul></li><li><span class="tsd-signature-symbol">{}</span></li></ul><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">parent</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <a href="index.Uuid.html" class="tsd-signature-type tsd-kind-type-alias">Uuid</a> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>Add the new priority as the child of another priority</p>
-</div></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/plotday/plot/blob/main/twist/twister/src/plot.ts#L133">plot.ts:133</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://plot.day" class="tsd-nav-link">Plot</a><a href="https://github.com/plotday/plot" class="tsd-nav-link">GitHub</a><a href="https://www.npmjs.com/package/@plotday/twister" class="tsd-nav-link">NPM</a></nav><nav class="tsd-navigation"><a href="../modules.html">Creating Plot Twists</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>