@paneui/core 0.0.16 → 0.0.18

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import type { TemplateRecord, TemplateSummary, TemplateType, TemplateVersion, CreateArtifactResponse, CreatePaneRequest, CreatePaneResponse, EventsPage, FeedbackPage, FeedbackSubmission, FeedbackType, KeyInfo, MintParticipantResponse, PaneEvent, ParticipantsList, SerializedRecord, PaneState, PanesPage, TasteInfo, TrashListResponse, UpgradePaneResponse } from "./types.js";
+import type { TemplateRecord, TemplateSummary, TemplateType, TemplateVersion, CreateArtifactResponse, CreatePaneRequest, CreatePaneResponse, EventsPage, FeedbackPage, FeedbackSubmission, FeedbackType, KeyInfo, MintParticipantResponse, PaneEvent, ParticipantsList, SerializedRecord, PaneState, PanesPage, TasteInfo, TrashListResponse, UpgradePaneResponse, UpdatePaneRequest, UpdatePaneResponse } from "./types.js";
 import type { ListPanesQuery } from "./schemas.js";
 export interface ClientOptions {
     /** Relay base URL, e.g. https://pane.example.com. Trailing slash is trimmed. */
@@ -52,6 +52,12 @@ export interface CreateArtifactRequest {
     type: TemplateType;
     event_schema?: unknown;
     input_schema?: Record<string, unknown>;
+    /** Optional per-pane record collections (JSON Schema 2020-12 + the
+     *  `x-pane-collections` extension). Mirrors `createArtifactSchema`. */
+    record_schema?: unknown;
+    /** Optional template-level record collections (same grammar as
+     *  `record_schema`; stored separately on the template version). */
+    template_record_schema?: unknown;
     /** Optional template icon emoji (a single emoji grapheme). Image icons are
      *  set post-create via `updateArtifact({ icon_attachment_id })`. */
     icon_emoji?: string;
@@ -65,6 +71,11 @@ export interface CreateArtifactVersionRequest {
     type: TemplateType;
     event_schema?: unknown;
     input_schema?: Record<string, unknown>;
+    /** Optional per-pane record collections for this version (JSON Schema
+     *  2020-12 + `x-pane-collections`). Mirrors `createArtifactVersionSchema`. */
+    record_schema?: unknown;
+    /** Optional template-level record collections for this version. */
+    template_record_schema?: unknown;
 }
 /**
  * Request body for PATCH /v1/templates/:id — head metadata only (never
@@ -233,6 +244,12 @@ export declare class PaneClient {
     deleteRecord(paneId: string, collection: string, recordKey: string, opts?: {
         ifMatch?: number;
     }): Promise<void>;
+    /**
+     * DELETE /v1/panes/:id/records/:collection — drop a WHOLE collection
+     * (all rows + the collection row). Privileged: the relay restricts this to
+     * the pane's owning agent (#507). Returns nothing on 204.
+     */
+    deleteRecordCollection(paneId: string, collection: string): Promise<void>;
     /**
      * GET /v1/templates/:id/template-records/:collection — owner-only list of
      * a template's curated records. Same wire shape as listRecords, separate
@@ -279,6 +296,11 @@ export declare class PaneClient {
     deleteTemplateRecord(templateIdOrSlug: string, collection: string, recordKey: string, opts?: {
         ifMatch?: number;
     }): Promise<void>;
+    /**
+     * DELETE /v1/templates/:id/template-records/:collection — drop a WHOLE
+     * template collection (all rows + the collection row). Owner-only (#507).
+     */
+    deleteTemplateRecordCollection(templateIdOrSlug: string, collection: string): Promise<void>;
     /** POST /v1/panes/:id/events — append an agent event. */
     sendEvent(paneId: string, ev: {
         type: string;
@@ -435,6 +457,20 @@ export declare class PaneClient {
         template_version?: number;
         compat?: "strict" | "force";
     }): Promise<UpgradePaneResponse>;
+    /**
+     * PATCH /v1/panes/:id — in-place edit of instance-level pane fields (#502):
+     * `ttl`/`expires_at`, `input_data`, `title`, `preamble`, `metadata`, `tags`,
+     * `icon_emoji`, `icon_attachment_id`. The pane keeps its id, URL, event log,
+     * and template pin. `input_data` is replaced wholesale and revalidated
+     * against the pane's current template version's input_schema. Pass `null`
+     * for `icon_emoji` / `icon_attachment_id` to CLEAR the override.
+     *
+     * The body must carry at least one updatable field; `ttl` and `expires_at`
+     * are mutually exclusive (both express the same intent). Both TTL forms are
+     * clamped against the relay's `MAX_TTL_SECONDS` cap and rejected (rather
+     * than silently truncated) when exceeded.
+     */
+    updatePane(paneId: string, body: UpdatePaneRequest): Promise<UpdatePaneResponse>;
     /**
      * DELETE /v1/panes/:id/participants/:participant_id — revoke a single
      * participant URL. The pane's other participants (and the agent's own

package/dist/client.js

@@ -262,6 +262,16 @@ export class PaneClient {
         if (!r.ok)
             this.fail(r);
     }
+    /**
+     * DELETE /v1/panes/:id/records/:collection — drop a WHOLE collection
+     * (all rows + the collection row). Privileged: the relay restricts this to
+     * the pane's owning agent (#507). Returns nothing on 204.
+     */
+    async deleteRecordCollection(paneId, collection) {
+        const r = await this.call("DELETE", `/v1/panes/${encodeURIComponent(paneId)}/records/${encodeURIComponent(collection)}`);
+        if (!r.ok)
+            this.fail(r);
+    }
     // ----- template-level records CRUD ------------------------------------
     /**
      * GET /v1/templates/:id/template-records/:collection — owner-only list of
@@ -327,6 +337,15 @@ export class PaneClient {
         if (!r.ok)
             this.fail(r);
     }
+    /**
+     * DELETE /v1/templates/:id/template-records/:collection — drop a WHOLE
+     * template collection (all rows + the collection row). Owner-only (#507).
+     */
+    async deleteTemplateRecordCollection(templateIdOrSlug, collection) {
+        const r = await this.call("DELETE", `/v1/templates/${encodeURIComponent(templateIdOrSlug)}/template-records/${encodeURIComponent(collection)}`);
+        if (!r.ok)
+            this.fail(r);
+    }
     /** POST /v1/panes/:id/events — append an agent event. */
     async sendEvent(paneId, ev) {
         const r = await this.call("POST", `/v1/panes/${encodeURIComponent(paneId)}/events`, {
@@ -354,6 +373,8 @@ export class PaneClient {
             type: req.type,
             event_schema: req.event_schema,
             input_schema: req.input_schema,
+            record_schema: req.record_schema,
+            template_record_schema: req.template_record_schema,
             icon_emoji: req.icon_emoji,
         });
         if (!r.ok)
@@ -371,6 +392,8 @@ export class PaneClient {
             type: req.type,
             event_schema: req.event_schema,
             input_schema: req.input_schema,
+            record_schema: req.record_schema,
+            template_record_schema: req.template_record_schema,
         });
         if (!r.ok)
             this.fail(r);
@@ -608,6 +631,25 @@ export class PaneClient {
             this.fail(r);
         return this.asObject(r);
     }
+    /**
+     * PATCH /v1/panes/:id — in-place edit of instance-level pane fields (#502):
+     * `ttl`/`expires_at`, `input_data`, `title`, `preamble`, `metadata`, `tags`,
+     * `icon_emoji`, `icon_attachment_id`. The pane keeps its id, URL, event log,
+     * and template pin. `input_data` is replaced wholesale and revalidated
+     * against the pane's current template version's input_schema. Pass `null`
+     * for `icon_emoji` / `icon_attachment_id` to CLEAR the override.
+     *
+     * The body must carry at least one updatable field; `ttl` and `expires_at`
+     * are mutually exclusive (both express the same intent). Both TTL forms are
+     * clamped against the relay's `MAX_TTL_SECONDS` cap and rejected (rather
+     * than silently truncated) when exceeded.
+     */
+    async updatePane(paneId, body) {
+        const r = await this.call("PATCH", `/v1/panes/${encodeURIComponent(paneId)}`, body);
+        if (!r.ok)
+            this.fail(r);
+        return this.asObject(r);
+    }
     /**
      * DELETE /v1/panes/:id/participants/:participant_id — revoke a single
      * participant URL. The pane's other participants (and the agent's own

package/dist/index.d.ts

@@ -4,9 +4,9 @@ export { openStream } from "./stream.js";
 export type { OpenStreamOptions, StreamHandlers, StreamHandle, } from "./stream.js";
 export { registerAgent } from "./register.js";
 export type { RegisterAgentOptions, RegisterAgentResult } from "./register.js";
-export { artifactSchema, callbackSchema, createPaneSchema, artifactTypeSchema, createArtifactSchema, createArtifactVersionSchema, patchArtifactMetadataSchema, feedbackTypeSchema, submitFeedbackSchema, listPanesStatusSchema, listPanesQuerySchema, mintParticipantSchema, upgradePaneSchema, } from "./schemas.js";
-export type { CreatePaneInput, ListPanesStatus, ListPanesQuery, MintParticipantInput, UpgradePaneInput, } from "./schemas.js";
+export { artifactSchema, callbackSchema, createPaneSchema, artifactTypeSchema, createArtifactSchema, createArtifactVersionSchema, patchArtifactMetadataSchema, feedbackTypeSchema, submitFeedbackSchema, listPanesStatusSchema, listPanesQuerySchema, mintParticipantSchema, upgradePaneSchema, updatePaneSchema, } from "./schemas.js";
+export type { CreatePaneInput, ListPanesStatus, ListPanesQuery, MintParticipantInput, UpgradePaneInput, UpdatePaneInput, } from "./schemas.js";
 export { validateIconEmoji, isValidIconEmoji, isRasterImageMime, RASTER_ICON_MIME_ALLOWLIST, MAX_ICON_EMOJI_BYTES, } from "./icons.js";
 export type { RasterIconMime } from "./icons.js";
 export { MAX_EVENT_TYPE_LENGTH, MAX_IDEMPOTENCY_KEY_LENGTH, MAX_RESPONSE_SNIPPET_LENGTH, MAX_FRAME_SNIPPET_LENGTH, } from "./limits.js";
-export type { AuthorKind, PaneEvent, SerializedRecord, DeletedRecordRef, RecordDeltaMessage, Template, TemplateType, TemplateVersion, TemplateRecord, TemplateSummary, CreateArtifactResponse, KeyInfo, TasteInfo, FeedbackType, FeedbackSubmission, FeedbackRecord, FeedbackPage, Callback, CreatePaneRequest, CreatePaneResponse, PaneState, EventsPage, ParticipantSummary, ParticipantsList, PaneSummary, PanesPage, MintParticipantResponse, UpgradeBreak, UpgradePaneResponse, TrashedPaneEntry, TrashedTemplateEntry, TrashListResponse, RelayError, } from "./types.js";
+export type { AuthorKind, PaneEvent, SerializedRecord, DeletedRecordRef, RecordDeltaMessage, Template, TemplateType, TemplateVersion, TemplateRecord, TemplateSummary, CreateArtifactResponse, KeyInfo, TasteInfo, FeedbackType, FeedbackSubmission, FeedbackRecord, FeedbackPage, Callback, CreatePaneRequest, CreatePaneResponse, PaneState, EventsPage, ParticipantSummary, ParticipantsList, PaneSummary, PanesPage, MintParticipantResponse, UpgradeBreak, UpgradePaneResponse, UpdatePaneRequest, UpdatePaneResponse, TrashedPaneEntry, TrashedTemplateEntry, TrashListResponse, RelayError, } from "./types.js";

package/dist/index.js

@@ -3,6 +3,6 @@
 export { PaneClient, PaneApiError } from "./client.js";
 export { openStream } from "./stream.js";
 export { registerAgent } from "./register.js";
-export { artifactSchema, callbackSchema, createPaneSchema, artifactTypeSchema, createArtifactSchema, createArtifactVersionSchema, patchArtifactMetadataSchema, feedbackTypeSchema, submitFeedbackSchema, listPanesStatusSchema, listPanesQuerySchema, mintParticipantSchema, upgradePaneSchema, } from "./schemas.js";
+export { artifactSchema, callbackSchema, createPaneSchema, artifactTypeSchema, createArtifactSchema, createArtifactVersionSchema, patchArtifactMetadataSchema, feedbackTypeSchema, submitFeedbackSchema, listPanesStatusSchema, listPanesQuerySchema, mintParticipantSchema, upgradePaneSchema, updatePaneSchema, } from "./schemas.js";
 export { validateIconEmoji, isValidIconEmoji, isRasterImageMime, RASTER_ICON_MIME_ALLOWLIST, MAX_ICON_EMOJI_BYTES, } from "./icons.js";
 export { MAX_EVENT_TYPE_LENGTH, MAX_IDEMPOTENCY_KEY_LENGTH, MAX_RESPONSE_SNIPPET_LENGTH, MAX_FRAME_SNIPPET_LENGTH, } from "./limits.js";

package/dist/schemas.d.ts

@@ -130,3 +130,15 @@ export declare const upgradePaneSchema: z.ZodObject<{
     }>>;
 }, z.core.$strip>;
 export type UpgradePaneInput = z.infer<typeof upgradePaneSchema>;
+export declare const updatePaneSchema: z.ZodObject<{
+    ttl: z.ZodOptional<z.ZodNumber>;
+    expires_at: z.ZodOptional<z.ZodString>;
+    input_data: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    title: z.ZodOptional<z.ZodString>;
+    preamble: z.ZodOptional<z.ZodString>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    icon_emoji: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    icon_attachment_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type UpdatePaneInput = z.infer<typeof updatePaneSchema>;

package/dist/schemas.js

@@ -199,3 +199,35 @@ export const upgradePaneSchema = z.object({
     template_version: z.number().int().positive().optional(),
     compat: z.enum(["strict", "force"]).optional(),
 });
+// PATCH /v1/panes/:id — in-place edit of instance-level pane fields (#502).
+// All fields are optional but the body must carry at least one. `ttl` and
+// `expires_at` are mutually exclusive (both are ways of saying the same thing).
+// `input_data` is replaced wholesale; the relay revalidates it against the
+// pane's current template version's input_schema. `icon_emoji` and
+// `icon_attachment_id` accept null to CLEAR the override and fall back to the
+// template's icon.
+export const updatePaneSchema = z
+    .object({
+    ttl: z.number().int().positive().optional(),
+    expires_at: z
+        .string()
+        .datetime({ offset: true })
+        .refine((s) => !Number.isNaN(new Date(s).getTime()), {
+        message: "expires_at must be a parseable ISO-8601 timestamp",
+    })
+        .optional(),
+    input_data: z.record(z.string(), z.unknown()).optional(),
+    title: z.string().optional(),
+    preamble: z.string().max(300).optional(),
+    metadata: z.record(z.string(), z.unknown()).optional(),
+    tags: z.array(z.string().min(1).max(50)).max(20).optional(),
+    icon_emoji: iconEmojiSchema.nullable().optional(),
+    icon_attachment_id: z.string().min(1).nullable().optional(),
+})
+    .refine((b) => Object.values(b).some((v) => v !== undefined), {
+    message: "request body must carry at least one updatable field (ttl, expires_at, input_data, title, preamble, metadata, tags, icon_emoji, icon_attachment_id)",
+})
+    .refine((b) => !(b.ttl !== undefined && b.expires_at !== undefined), {
+    message: "ttl and expires_at are mutually exclusive — pass one or the other",
+    path: ["expires_at"],
+});

package/dist/types.d.ts

@@ -1,5 +1,5 @@
 import type { z } from "zod";
-import type { createPaneSchema } from "./schemas.js";
+import type { createPaneSchema, updatePaneSchema } from "./schemas.js";
 export type AuthorKind = "human" | "agent" | "system";
 /** A single event envelope as emitted by the relay. */
 export interface PaneEvent {
@@ -234,6 +234,31 @@ export interface UpgradePaneResponse {
     /** The compat mode the upgrade ran under. */
     compat: "strict" | "force";
 }
+/**
+ * Request body for PATCH /v1/panes/:id (#502). Derived from `updatePaneSchema`
+ * so the runtime validator and the static type cannot drift.
+ */
+export type UpdatePaneRequest = z.infer<typeof updatePaneSchema>;
+/** Response from PATCH /v1/panes/:id — the full new pane state, matching the
+ *  shape returned by GET /v1/panes/:id so callers can hot-swap their cached
+ *  view without an extra read. */
+export interface UpdatePaneResponse {
+    pane_id: string;
+    status: "open" | "closed";
+    template_id: string;
+    template_version_id: string;
+    template_version: number;
+    title: string;
+    tags: string[];
+    metadata: Record<string, unknown> | null;
+    input_data: Record<string, unknown> | null;
+    created_at: string;
+    expires_at: string;
+    deleted_at: string | null;
+    /** The set of field names that were actually applied by this PATCH. Useful
+     *  for callers that want to confirm a no-op vs. a real change. */
+    updated_fields: string[];
+}
 /** One immutable version of an template's content. */
 export interface TemplateVersion {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paneui/core",
-  "version": "0.0.16",
+  "version": "0.0.18",
   "description": "Pane relay client: typed HTTP + WebSocket operations against a Pane relay. Framework-free.",
   "license": "MIT",
   "type": "module",
@@ -50,7 +50,7 @@
     "zod": "^4.4.3"
   },
   "devDependencies": {
-    "@types/node": "^25.9.1",
+    "@types/node": "^25.9.2",
     "@types/ws": "^8.18.1",
     "typescript": "^6.0.3",
     "vitest": "^4.1.8"