@snaptrude/plugin-core 0.6.0 → 0.7.0

package/dist/api/core/index.d.ts

@@ -10,6 +10,7 @@ import { PluginCoreBuildingsApi } from "./buildings";
 import { PluginCoreLayersApi } from "./layers";
 import { PluginCoreTagsApi } from "./tags";
 import { PluginCoreIoApi } from "./io";
+import { PluginCoreProposalsApi } from "./proposals";
 /**
  * Core primitives and infrastructure used across the plugin API.
  *
@@ -25,6 +26,7 @@ import { PluginCoreIoApi } from "./io";
  * - {@linkcode PluginCoreApi.layers} — Read & toggle storey drawing/reference layers
  * - {@linkcode PluginCoreApi.tags} — Tag catalog + assignment
  * - {@linkcode PluginCoreApi.io} — Import files (image/pdf/cad/model/terrain), poll jobs, manage underlays
+ * - {@linkcode PluginCoreApi.proposals} — Design options: read, create, rename, switch, delete
  */
 export declare abstract class PluginCoreApi {
     /** Vector and quaternion math utilities. See {@linkcode PluginMathApi}. */
@@ -51,6 +53,8 @@ export declare abstract class PluginCoreApi {
     abstract tags: PluginCoreTagsApi;
     /** I/O — file import, import jobs, and underlay management. See {@linkcode PluginCoreIoApi}. */
     abstract io: PluginCoreIoApi;
+    /** Proposals — design options: read, create, rename, switch, delete. See {@linkcode PluginCoreProposalsApi}. */
+    abstract proposals: PluginCoreProposalsApi;
     constructor();
 }
 export * from "./math";
@@ -65,4 +69,5 @@ export * from "./buildings";
 export * from "./layers";
 export * from "./tags";
 export * from "./io";
+export * from "./proposals";
 //# sourceMappingURL=index.d.ts.map

package/dist/api/core/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAA;AAEtC;;;;;;;;;;;;;;;GAeG;AACH,8BAAsB,aAAa;IACjC,2EAA2E;IAC3E,SAAgB,IAAI,EAAE,aAAa,CAAA;IACnC,2EAA2E;IAC3E,SAAgB,IAAI,EAAE,aAAa,CAAA;IACnC,kFAAkF;IAClF,SAAgB,OAAO,EAAE,gBAAgB,CAAA;IACzC,wEAAwE;IACxE,SAAgB,KAAK,EAAE,cAAc,CAAA;IACrC,2DAA2D;IAC3D,SAAgB,IAAI,EAAE,aAAa,CAAA;IACnC,yEAAyE;IACzE,SAAgB,OAAO,EAAE,gBAAgB,CAAA;IACzC,qFAAqF;IACrF,SAAgB,OAAO,EAAE,gBAAgB,CAAA;IACzC,qFAAqF;IACrF,SAAgB,MAAM,EAAE,mBAAmB,CAAA;IAC3C,mGAAmG;IACnG,SAAgB,SAAS,EAAE,sBAAsB,CAAA;IACjD,mGAAmG;IACnG,SAAgB,MAAM,EAAE,mBAAmB,CAAA;IAC3C,0EAA0E;IAC1E,SAAgB,IAAI,EAAE,iBAAiB,CAAA;IACvC,gGAAgG;IAChG,SAAgB,EAAE,EAAE,eAAe,CAAA;;CAGpC;AAED,cAAc,QAAQ,CAAA;AACtB,cAAc,QAAQ,CAAA;AACtB,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,QAAQ,CAAA;AACtB,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,QAAQ,CAAA;AACtB,cAAc,MAAM,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/core/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAA;AACtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAA;AACtC,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AAEpD;;;;;;;;;;;;;;;;GAgBG;AACH,8BAAsB,aAAa;IACjC,2EAA2E;IAC3E,SAAgB,IAAI,EAAE,aAAa,CAAA;IACnC,2EAA2E;IAC3E,SAAgB,IAAI,EAAE,aAAa,CAAA;IACnC,kFAAkF;IAClF,SAAgB,OAAO,EAAE,gBAAgB,CAAA;IACzC,wEAAwE;IACxE,SAAgB,KAAK,EAAE,cAAc,CAAA;IACrC,2DAA2D;IAC3D,SAAgB,IAAI,EAAE,aAAa,CAAA;IACnC,yEAAyE;IACzE,SAAgB,OAAO,EAAE,gBAAgB,CAAA;IACzC,qFAAqF;IACrF,SAAgB,OAAO,EAAE,gBAAgB,CAAA;IACzC,qFAAqF;IACrF,SAAgB,MAAM,EAAE,mBAAmB,CAAA;IAC3C,mGAAmG;IACnG,SAAgB,SAAS,EAAE,sBAAsB,CAAA;IACjD,mGAAmG;IACnG,SAAgB,MAAM,EAAE,mBAAmB,CAAA;IAC3C,0EAA0E;IAC1E,SAAgB,IAAI,EAAE,iBAAiB,CAAA;IACvC,gGAAgG;IAChG,SAAgB,EAAE,EAAE,eAAe,CAAA;IACnC,gHAAgH;IAChH,SAAgB,SAAS,EAAE,sBAAsB,CAAA;;CAGlD;AAED,cAAc,QAAQ,CAAA;AACtB,cAAc,QAAQ,CAAA;AACtB,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,QAAQ,CAAA;AACtB,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,UAAU,CAAA;AACxB,cAAc,QAAQ,CAAA;AACtB,cAAc,MAAM,CAAA;AACpB,cAAc,aAAa,CAAA"}

package/dist/api/core/proposals/index.d.ts

@@ -0,0 +1,475 @@
+import * as z from "zod";
+import { PluginApiReturn } from "../../../types";
+import { ComponentHandle } from "../../../handles";
+/**
+ * Proposals — read and edit the project's design options ("proposals").
+ *
+ * A **proposal** is a design option: one of several variants of the same
+ * project. Each proposal owns a set of buckets (a bucket == a drawing layer),
+ * and switching the active proposal shows/hides the buckets it owns. Proposals
+ * are **infrastructure**, not design — they own the buckets/layers geometry
+ * lives in — so they sit under `core`, not `design` (constitution §2A).
+ *
+ * Reads return plain records and never throw for a missing proposal (`get` and
+ * `getActive` return `null`, `list` / `listForComponent` return an empty list,
+ * `isActive` returns `false`). Ids are stable public strings.
+ *
+ * On legacy / no-proposal projects the scoping predicates degrade gracefully:
+ * `getActive` returns `null` and the reads return empty.
+ *
+ * Proposal writes are **not undoable** — create / rename / setActive / delete
+ * persist directly and bypass the undo stack; a `core.history.undo` will not
+ * reverse them. Each proposal keeps its own isolated undo stack for the
+ * geometry edits made inside it.
+ *
+ * Accessed via `snaptrude.core.proposals`.
+ */
+export declare abstract class PluginCoreProposalsApi {
+    constructor();
+    /**
+     * List the design options (proposals) in the active project.
+     *
+     * @returns A {@linkcode PluginCoreProposalsListResult} with a `proposals`
+     *   array (empty on a legacy / no-proposal project).
+     *
+     * @examplePrompt List all the design options in this project
+     * @examplePrompt How many proposals does this project have?
+     * @examplePrompt Show every design variant with its name
+     *
+     * # Example
+     * ```ts
+     * const { proposals } = await snaptrude.core.proposals.list()
+     * for (const p of proposals) console.log(p.id, p.name, p.isActive)
+     * ```
+     */
+    abstract list(): PluginApiReturn<PluginCoreProposalsListResult>;
+    /**
+     * Get a single proposal by id.
+     *
+     * @param proposalId - The id of the proposal to read.
+     * @returns The matching {@linkcode PluginCoreProposalRef}, or `null` if no
+     *   proposal has that id.
+     *
+     * @examplePrompt Get the proposal with id prop_1
+     * @examplePrompt Look up a single design option by its id
+     * @examplePrompt Which buckets belong to proposal prop_2?
+     *
+     * # Example
+     * ```ts
+     * const proposal = await snaptrude.core.proposals.get("prop_1")
+     * if (proposal) console.log(proposal.name, proposal.bucketIds)
+     * ```
+     */
+    abstract get(proposalId: string): PluginApiReturn<PluginCoreProposalsGetResult>;
+    /**
+     * Get the active proposal.
+     *
+     * The active proposal is the design option currently shown and edited.
+     * Honors a present-mode capture override: while a present-mode capture is in
+     * flight this returns the captured proposal, not the redux-active one. Paired
+     * with {@linkcode PluginCoreProposalsApi.setActive}.
+     *
+     * @returns The active {@linkcode PluginCoreProposalRef}, or `null` on a legacy
+     *   / no-proposal project where nothing is active.
+     *
+     * @examplePrompt Which design option is active?
+     * @examplePrompt Get the current proposal
+     * @examplePrompt What proposal am I working in?
+     *
+     * # Example
+     * ```ts
+     * const active = await snaptrude.core.proposals.getActive()
+     * if (active) console.log(active.id, active.name)
+     * ```
+     */
+    abstract getActive(): PluginApiReturn<PluginCoreProposalsGetActiveResult>;
+    /**
+     * List the proposals a component belongs to.
+     *
+     * Returns **every** proposal whose buckets include the component — a bucket
+     * can be shared across proposals, so a component may appear in more than one.
+     *
+     * @param component - The component to look up.
+     * @returns A {@linkcode PluginCoreProposalsListForComponentResult} with a
+     *   `proposals` array (empty when the component is out of scope or the project
+     *   has no proposals).
+     *
+     * @examplePrompt Which design options is this component part of?
+     * @examplePrompt List the proposals that contain this wall
+     * @examplePrompt Is this element shared across multiple design variants?
+     *
+     * # Example
+     * ```ts
+     * const { proposals } = await snaptrude.core.proposals.listForComponent(wall)
+     * console.log(`shared across ${proposals.length} proposals`)
+     * ```
+     */
+    abstract listForComponent(component: ComponentHandle): PluginApiReturn<PluginCoreProposalsListForComponentResult>;
+    /**
+     * Test whether a proposal is the active one.
+     *
+     * @param proposalId - The id of the proposal to test.
+     * @returns `true` if it is the active proposal, otherwise `false` (including
+     *   when no proposal has that id).
+     *
+     * @examplePrompt Is proposal prop_2 the active one?
+     * @examplePrompt Check whether this design option is currently shown
+     * @examplePrompt Am I working in proposal prop_1?
+     *
+     * # Example
+     * ```ts
+     * if (await snaptrude.core.proposals.isActive("prop_1")) {
+     *   console.log("prop_1 is active")
+     * }
+     * ```
+     */
+    abstract isActive(proposalId: string): PluginApiReturn<boolean>;
+    /**
+     * Create a new design option (proposal).
+     *
+     * **Pro-gated** (creating proposals requires a Pro plan, matching the UI) and
+     * **not undoable**. Creates a bare proposal with a single empty default
+     * bucket — it does **not** carry forward the current proposal's layers, views,
+     * or targets. The name is capped at 24 characters.
+     *
+     * @param name - Display name of the new proposal (capped at 24 chars).
+     * @returns The new proposal's id (read the full record back with
+     *   {@linkcode PluginCoreProposalsApi.get}).
+     * @throws If the caller is not on a Pro plan, or the proposal could not be
+     *   created.
+     *
+     * @examplePrompt Create a design option called Scheme B
+     * @examplePrompt Add a new proposal named Option 2
+     * @examplePrompt Make a fresh design variant to explore
+     *
+     * # Example
+     * ```ts
+     * const { id } = await snaptrude.core.proposals.create("Scheme B")
+     * ```
+     */
+    abstract create(name: string): PluginApiReturn<PluginCoreProposalsCreateResult>;
+    /**
+     * Rename a proposal.
+     *
+     * **Not undoable.** The name is capped at 24 characters.
+     *
+     * @param proposalId - The id of the proposal to rename.
+     * @param name - The new display name (capped at 24 chars).
+     * @returns The updated {@linkcode PluginCoreProposalRef}.
+     * @throws If no proposal has the given id, or the name is empty / duplicates
+     *   another proposal.
+     *
+     * @examplePrompt Rename proposal prop_1 to Final Scheme
+     * @examplePrompt Change the name of this design option
+     * @examplePrompt Call proposal prop_2 "Option A"
+     *
+     * # Example
+     * ```ts
+     * const proposal = await snaptrude.core.proposals.rename("prop_1", "Final Scheme")
+     * ```
+     */
+    abstract rename(proposalId: string, name: string): PluginApiReturn<PluginCoreProposalsRenameResult>;
+    /**
+     * Switch the active proposal.
+     *
+     * A **heavy scene switch** and **not undoable**. Switching clears the current
+     * selection, resets AI / streaming state, cancels proposal-scoped operations,
+     * retoggles bucket visibility to the new proposal's owned set, restores its
+     * per-proposal site/FSI settings, and realigns the views panel. After the
+     * switch, **writes** are guarded to the new active proposal (edits targeting
+     * components outside it are rejected), but **list reads are NOT
+     * proposal-filtered** — `design.query.list*` and similar reads stay
+     * project-wide; filter their results via
+     * {@linkcode PluginCoreProposalsApi.listForComponent} if you need
+     * proposal-scoped sets.
+     *
+     * **Blocked while an in-canvas agent run is in flight** — throws
+     * `PROPOSAL_SWITCH_BLOCKED` if a canvas-agent run is active (matching the UI's
+     * hard block), because a switch would cancel the in-flight run.
+     *
+     * @param proposalId - The id of the proposal to activate.
+     * @returns The id of the now-active proposal.
+     * @throws `PROPOSAL_SWITCH_BLOCKED` while a canvas-agent run is in flight; or
+     *   if no proposal has the given id.
+     *
+     * @examplePrompt Switch to proposal prop_2
+     * @examplePrompt Make Scheme B the active design option
+     * @examplePrompt Show me the other proposal
+     *
+     * # Example
+     * ```ts
+     * await snaptrude.core.proposals.setActive("prop_2")
+     * ```
+     */
+    abstract setActive(proposalId: string): PluginApiReturn<PluginCoreProposalsSetActiveResult>;
+    /**
+     * Delete a proposal.
+     *
+     * **DANGEROUS AND IRREVERSIBLE — not undoable.** You must choose **exactly
+     * one** explicit disposition (mirroring the product's delete dialog):
+     *
+     * - `{ deleteObjects: true }` — delete the proposal AND **permanently
+     *   destroy the geometry** in its exclusive buckets. Buckets shared with
+     *   other proposals are never destroyed.
+     * - `{ targetProposalId }` — transfer **all** of this proposal's buckets to
+     *   another proposal first (keeping the geometry alive), then delete the
+     *   emptied proposal — "merge and remove". The target must be a
+     *   **different** proposal.
+     *
+     * A bare `delete(proposalId)` is **rejected**: there is no safe default —
+     * without a disposition the engine would drop the proposal's bucket records
+     * while leaving their components orphaned. Passing both dispositions at once
+     * is also rejected as ambiguous.
+     *
+     * It is **server-validated**: the backend refuses the delete (throws) if a
+     * collaborator is active in that proposal, and the check times out after
+     * ~10s. The project's **last remaining proposal cannot be deleted**. If the
+     * proposal is active, the host switches away first.
+     *
+     * @param proposalId - The id of the proposal to delete.
+     * @param options - Exactly one disposition: `{ deleteObjects: true }`
+     *   (destroy exclusive-bucket geometry) or `{ targetProposalId }` (transfer
+     *   buckets to that proposal, then delete).
+     * @returns Confirmation that the proposal was deleted.
+     * @throws If no disposition (or both) is given, `targetProposalId` equals
+     *   `proposalId`, no proposal has the given id, it is the only proposal, a
+     *   collaborator lock refuses the delete, or the server validation times out.
+     *
+     * @examplePrompt Delete proposal prop_2 and everything in it
+     * @examplePrompt Remove this design option and destroy its geometry
+     * @examplePrompt Merge prop_2's layers into prop_1 and delete prop_2
+     *
+     * # Example
+     * ```ts
+     * // destroy the proposal and its exclusive geometry
+     * await snaptrude.core.proposals.delete("prop_2", { deleteObjects: true })
+     * // …or keep the geometry by transferring its buckets to prop_1 first
+     * await snaptrude.core.proposals.delete("prop_2", { targetProposalId: "prop_1" })
+     * ```
+     */
+    abstract delete(proposalId: string, options: {
+        deleteObjects: true;
+        targetProposalId?: never;
+    } | {
+        deleteObjects?: false;
+        targetProposalId: string;
+    }): PluginApiReturn<PluginCoreProposalsDeleteResult>;
+}
+/**
+ * A design option (proposal) in the active project.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | Stable public proposal id (e.g. `"prop_1"`) |
+ * | `name` | `string` | Display name (≤ 24 chars) |
+ * | `isActive` | `boolean` | Whether this is the active proposal |
+ * | `defaultBucketId` | `string` | Id of the proposal's default bucket (cannot be unshared) |
+ * | `bucketIds` | `string[]` | Ids of every bucket (layer) the proposal owns |
+ * | `createdAt` | `string` | ISO creation timestamp |
+ * | `createdBy` | `string` | User id of the creator |
+ */
+export declare const PluginCoreProposalRef: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    isActive: z.ZodBoolean;
+    defaultBucketId: z.ZodString;
+    bucketIds: z.ZodArray<z.ZodString>;
+    createdAt: z.ZodString;
+    createdBy: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreProposalRef = z.infer<typeof PluginCoreProposalRef>;
+/**
+ * Result of {@linkcode PluginCoreProposalsApi.list}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `proposals` | {@linkcode PluginCoreProposalRef}`[]` | Every proposal in the active project |
+ */
+export declare const PluginCoreProposalsListResult: z.ZodObject<{
+    proposals: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        isActive: z.ZodBoolean;
+        defaultBucketId: z.ZodString;
+        bucketIds: z.ZodArray<z.ZodString>;
+        createdAt: z.ZodString;
+        createdBy: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginCoreProposalsListResult = z.infer<typeof PluginCoreProposalsListResult>;
+/**
+ * Arguments for {@linkcode PluginCoreProposalsApi.get} /
+ * {@linkcode PluginCoreProposalsApi.isActive}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `proposalId` | `string` | The id of the proposal |
+ */
+export declare const PluginCoreProposalsGetArgs: z.ZodObject<{
+    proposalId: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreProposalsGetArgs = z.infer<typeof PluginCoreProposalsGetArgs>;
+/**
+ * Result of {@linkcode PluginCoreProposalsApi.get} — the proposal, or `null`
+ * when no proposal has the given id.
+ */
+export declare const PluginCoreProposalsGetResult: z.ZodNullable<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    isActive: z.ZodBoolean;
+    defaultBucketId: z.ZodString;
+    bucketIds: z.ZodArray<z.ZodString>;
+    createdAt: z.ZodString;
+    createdBy: z.ZodString;
+}, z.core.$strip>>;
+export type PluginCoreProposalsGetResult = z.infer<typeof PluginCoreProposalsGetResult>;
+/**
+ * Result of {@linkcode PluginCoreProposalsApi.getActive} — the active proposal,
+ * or `null` when nothing is active (legacy / no-proposal project).
+ */
+export declare const PluginCoreProposalsGetActiveResult: z.ZodNullable<z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    isActive: z.ZodBoolean;
+    defaultBucketId: z.ZodString;
+    bucketIds: z.ZodArray<z.ZodString>;
+    createdAt: z.ZodString;
+    createdBy: z.ZodString;
+}, z.core.$strip>>;
+export type PluginCoreProposalsGetActiveResult = z.infer<typeof PluginCoreProposalsGetActiveResult>;
+/**
+ * Arguments for {@linkcode PluginCoreProposalsApi.listForComponent}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `component` | {@linkcode ComponentHandle} | The component to look up |
+ */
+export declare const PluginCoreProposalsListForComponentArgs: z.ZodObject<{
+    component: z.ZodPipe<z.ZodString, z.ZodTransform<ComponentHandle, string>>;
+}, z.core.$strip>;
+export type PluginCoreProposalsListForComponentArgs = z.infer<typeof PluginCoreProposalsListForComponentArgs>;
+/**
+ * Result of {@linkcode PluginCoreProposalsApi.listForComponent} — the proposals
+ * the component belongs to (empty when out of scope or none). Same shape as
+ * {@linkcode PluginCoreProposalsListResult}.
+ */
+export declare const PluginCoreProposalsListForComponentResult: z.ZodObject<{
+    proposals: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        isActive: z.ZodBoolean;
+        defaultBucketId: z.ZodString;
+        bucketIds: z.ZodArray<z.ZodString>;
+        createdAt: z.ZodString;
+        createdBy: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type PluginCoreProposalsListForComponentResult = z.infer<typeof PluginCoreProposalsListForComponentResult>;
+/**
+ * Arguments for {@linkcode PluginCoreProposalsApi.isActive}. Alias of
+ * {@linkcode PluginCoreProposalsGetArgs}.
+ */
+export declare const PluginCoreProposalsIsActiveArgs: z.ZodObject<{
+    proposalId: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreProposalsIsActiveArgs = z.infer<typeof PluginCoreProposalsIsActiveArgs>;
+/**
+ * Arguments for {@linkcode PluginCoreProposalsApi.create}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `name` | `string` | Display name of the new proposal (capped at 24 chars) |
+ */
+export declare const PluginCoreProposalsCreateArgs: z.ZodObject<{
+    name: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreProposalsCreateArgs = z.infer<typeof PluginCoreProposalsCreateArgs>;
+/**
+ * Result of {@linkcode PluginCoreProposalsApi.create} — the id of the new
+ * proposal.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | The id of the newly created proposal |
+ */
+export declare const PluginCoreProposalsCreateResult: z.ZodObject<{
+    id: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreProposalsCreateResult = z.infer<typeof PluginCoreProposalsCreateResult>;
+/**
+ * Arguments for {@linkcode PluginCoreProposalsApi.rename}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `proposalId` | `string` | The id of the proposal to rename |
+ * | `name` | `string` | The new display name (capped at 24 chars) |
+ */
+export declare const PluginCoreProposalsRenameArgs: z.ZodObject<{
+    proposalId: z.ZodString;
+    name: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreProposalsRenameArgs = z.infer<typeof PluginCoreProposalsRenameArgs>;
+/** Result of {@linkcode PluginCoreProposalsApi.rename} — the updated record. */
+export declare const PluginCoreProposalsRenameResult: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    isActive: z.ZodBoolean;
+    defaultBucketId: z.ZodString;
+    bucketIds: z.ZodArray<z.ZodString>;
+    createdAt: z.ZodString;
+    createdBy: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreProposalsRenameResult = z.infer<typeof PluginCoreProposalsRenameResult>;
+/**
+ * Arguments for {@linkcode PluginCoreProposalsApi.setActive}.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `proposalId` | `string` | The id of the proposal to activate |
+ */
+export declare const PluginCoreProposalsSetActiveArgs: z.ZodObject<{
+    proposalId: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreProposalsSetActiveArgs = z.infer<typeof PluginCoreProposalsSetActiveArgs>;
+/**
+ * Result of {@linkcode PluginCoreProposalsApi.setActive} — the now-active
+ * proposal's id.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `id` | `string` | The id of the now-active proposal |
+ */
+export declare const PluginCoreProposalsSetActiveResult: z.ZodObject<{
+    id: z.ZodString;
+}, z.core.$strip>;
+export type PluginCoreProposalsSetActiveResult = z.infer<typeof PluginCoreProposalsSetActiveResult>;
+/**
+ * Arguments for {@linkcode PluginCoreProposalsApi.delete}. Exactly one
+ * disposition is required: `deleteObjects: true` XOR `targetProposalId` (a
+ * **different** proposal). A bare delete with neither is rejected.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `proposalId` | `string` | The id of the proposal to delete |
+ * | `deleteObjects` | `true \| undefined` | Destroy the geometry in exclusive buckets (mutually exclusive with `targetProposalId`) |
+ * | `targetProposalId` | `string \| undefined` | Transfer this proposal's buckets here before deleting (must differ from `proposalId`) |
+ */
+export declare const PluginCoreProposalsDeleteArgs: z.ZodObject<{
+    proposalId: z.ZodString;
+    deleteObjects: z.ZodOptional<z.ZodBoolean>;
+    targetProposalId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type PluginCoreProposalsDeleteArgs = z.infer<typeof PluginCoreProposalsDeleteArgs>;
+/**
+ * Result of {@linkcode PluginCoreProposalsApi.delete} — confirmation that the
+ * proposal was deleted.
+ *
+ * | Property | Type | Description |
+ * |---|---|---|
+ * | `deleted` | `true` | Always `true` on success |
+ */
+export declare const PluginCoreProposalsDeleteResult: z.ZodObject<{
+    deleted: z.ZodLiteral<true>;
+}, z.core.$strip>;
+export type PluginCoreProposalsDeleteResult = z.infer<typeof PluginCoreProposalsDeleteResult>;
+//# sourceMappingURL=index.d.ts.map

package/dist/api/core/proposals/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/api/core/proposals/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AACxB,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAElD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,8BAAsB,sBAAsB;;IAG1C;;;;;;;;;;;;;;;OAeG;aACa,IAAI,IAAI,eAAe,CAAC,6BAA6B,CAAC;IAEtE;;;;;;;;;;;;;;;;OAgBG;aACa,GAAG,CACjB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,4BAA4B,CAAC;IAEhD;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,SAAS,IAAI,eAAe,CAAC,kCAAkC,CAAC;IAEhF;;;;;;;;;;;;;;;;;;;;OAoBG;aACa,gBAAgB,CAC9B,SAAS,EAAE,eAAe,GACzB,eAAe,CAAC,yCAAyC,CAAC;IAE7D;;;;;;;;;;;;;;;;;OAiBG;aACa,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC;IAEtE;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,MAAM,CACpB,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,+BAA+B,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;OAmBG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,GACX,eAAe,CAAC,+BAA+B,CAAC;IAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;aACa,SAAS,CACvB,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kCAAkC,CAAC;IAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;aACa,MAAM,CACpB,UAAU,EAAE,MAAM,EAClB,OAAO,EACH;QAAE,aAAa,EAAE,IAAI,CAAC;QAAC,gBAAgB,CAAC,EAAE,KAAK,CAAA;KAAE,GACjD;QAAE,aAAa,CAAC,EAAE,KAAK,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,GACtD,eAAe,CAAC,+BAA+B,CAAC;CACpD;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;iBAQhC,CAAA;AACF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B;;iBAErC,CAAA;AACF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAC9C,OAAO,0BAA0B,CAClC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,4BAA4B;;;;;;;;kBAAmC,CAAA;AAC5E,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,KAAK,CAChD,OAAO,4BAA4B,CACpC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,kCAAkC;;;;;;;;kBACb,CAAA;AAClC,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uCAAuC;;iBAElD,CAAA;AACF,MAAM,MAAM,uCAAuC,GAAG,CAAC,CAAC,KAAK,CAC3D,OAAO,uCAAuC,CAC/C,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,yCAAyC;;;;;;;;;;iBACvB,CAAA;AAC/B,MAAM,MAAM,yCAAyC,GAAG,CAAC,CAAC,KAAK,CAC7D,OAAO,yCAAyC,CACjD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,+BAA+B;;iBAA6B,CAAA;AACzE,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,6BAA6B;;iBAExC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,6BAA6B;;;iBAGxC,CAAA;AACF,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED,gFAAgF;AAChF,eAAO,MAAM,+BAA+B;;;;;;;;iBAAwB,CAAA;AACpE,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;iBAE3C,CAAA;AACF,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CACpD,OAAO,gCAAgC,CACxC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,kCAAkC;;iBAE7C,CAAA;AACF,MAAM,MAAM,kCAAkC,GAAG,CAAC,CAAC,KAAK,CACtD,OAAO,kCAAkC,CAC1C,CAAA;AAED;;;;;;;;;;GAUG;AACH,eAAO,MAAM,6BAA6B;;;;iBAevC,CAAA;AACH,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CACjD,OAAO,6BAA6B,CACrC,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;iBAE1C,CAAA;AACF,MAAM,MAAM,+BAA+B,GAAG,CAAC,CAAC,KAAK,CACnD,OAAO,+BAA+B,CACvC,CAAA"}