@orkestrel/terminal 0.0.9 → 0.0.11

package/dist/src/core/index.d.cts

@@ -204,9 +204,9 @@ export declare function createPasswordState(field: PasswordField, styler?: Style
  * @returns A {@link PromptInterface}
  *
  * @remarks
- * The caller awaits the parked form's own `answer`. Timeout or teardown destroys the form, so that
- * promise rejects with the Form package's `ABANDONED` error. Inject `options.timer` to drive
- * expiry without real time.
+ * The caller awaits the parked form's own `answer`. Timeout, `stop`, or teardown destroys the form,
+ * so that promise rejects with the Form package's `ABANDONED` error. Inject `options.timer` to
+ * drive expiry without real time.
  *
  * @example
  * ```ts
@@ -747,7 +747,7 @@ export declare interface PendingForm {
  * @remarks
  * - `pending` — parked, awaiting {@link PromptInterface.answer}.
  * - `answered` — answered and accepted, so the parked form settled.
- * - `expired` — timed out, or torn down by `destroy`, before an answer.
+ * - `expired` — timed out, released by `stop`, or torn down by `destroy`, before an answer.
  */
 export declare type PendingFormStatus = 'pending' | 'answered' | 'expired';
 
@@ -758,7 +758,8 @@ export declare type PendingFormStatus = 'pending' | 'answered' | 'expired';
  * @remarks
  * A parked record carries one call to `serializeForm`. A failed fill or submit leaves the record
  * parked for another answer. A successful submit settles the form once, emits `answer`, and removes
- * the record. Timeout and teardown abandon every unsettled form through its own `destroy` method.
+ * the record. Timeout, `stop`, and teardown abandon unsettled forms through their own `destroy`
+ * method.
  *
  * @example
  * ```ts
@@ -778,6 +779,9 @@ export declare class Prompt implements PromptInterface {
     pending(id: string): PendingForm | undefined;
     park(form: FormInterface, request?: ParkRequest): string;
     answer(id: string, values: FormValues): Result<FormValues, AnswerError>;
+    stop(ids: readonly string[]): boolean;
+    stop(id: string): boolean;
+    stop(): void;
     destroy(): void;
 }
 
@@ -929,7 +933,7 @@ export declare interface PromptClientOptions {
  * @remarks
  * - `pending` — a form was parked; a transport forwards the wire record to remote clients.
  * - `answer` — a parked form was answered and accepted, carrying its id and the settled values.
- * - `expire` — a parked form timed out or was torn down unanswered, carrying its id.
+ * - `expire` — a parked form timed out or was released unanswered, carrying its id.
  */
 export declare type PromptEventMap = {
     readonly pending: readonly [form: PendingForm];
@@ -969,6 +973,19 @@ export declare type PromptIcon = 'question' | 'pointer' | 'dot' | 'selected' | '
  * - **Timeout abandons.** An unanswered form is destroyed after `timeout` ms; `expire` fires and
  *   the caller's promise rejects on the form's own lifecycle. The timer is injectable.
  * - **Accessors.** `pending()` lists the parked records; `pending(id)` looks one up.
+ * - **Batch stop.** The array overload is declared first: `stop(ids)` releases each listed parked
+ *   form and reports whether all ids were parked; `stop(id)` releases one; `stop()` releases every
+ *   parked form without destroying the broker. Release uses the existing expiry semantics.
+ *
+ * @example
+ * ```ts
+ * const prompt = createPrompt()
+ * const first = prompt.park(createForm({ fields: [{ control: 'text', name: 'first' }] }))
+ * const second = prompt.park(createForm({ fields: [{ control: 'text', name: 'second' }] }))
+ * prompt.stop(first) // true
+ * prompt.stop([second, 'missing']) // false; `second` was still released
+ * prompt.stop() // release every remaining form; the broker stays usable
+ * ```
  */
 export declare interface PromptInterface {
     readonly emitter: EmitterInterface<PromptEventMap>;
@@ -977,6 +994,9 @@ export declare interface PromptInterface {
     pending(): readonly PendingForm[];
     pending(id: string): PendingForm | undefined;
     answer(id: string, values: FormValues): Result<FormValues, AnswerError>;
+    stop(ids: readonly string[]): boolean;
+    stop(id: string): boolean;
+    stop(): void;
     destroy(): void;
 }
 
@@ -1159,7 +1179,7 @@ export declare function selectView(state: ReturnType<typeof createSelectState>):
  */
 export declare const SEQUENCE_NAMES: Readonly<Record<string, string>>;
 
-/** Serialize a parked prompt's expiry into a {@link WireEvent} — event `'expire'`, `data` the JSON-stringified `{ id }` payload. */
+/** Serialize a parked prompt's expiry or release into a {@link WireEvent} — event `'expire'`, `data` the JSON-stringified `{ id }` payload. */
 export declare function serializeExpire(id: string): WireEvent;
 
 /** Serialize a parked {@link PendingForm} into a {@link WireEvent}. */
@@ -1185,7 +1205,7 @@ export declare const SSE_BUFFER_LIMIT = 1048576;
  *
  * @remarks
  * - `pending` — a serialized {@link import('./types.js').PendingForm} to dispatch and answer.
- * - `expire` — an `{ id }` payload: the broker expired a parked prompt (the client drops it).
+ * - `expire` — an `{ id }` payload: the broker expired or released a parked prompt (the client drops it).
  * - `shutdown` — the broker is going away; the client disconnects (no auto-reconnect) but stays reusable.
  */
 export declare const SSE_EVENTS: Readonly<{

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

@@ -204,9 +204,9 @@ export declare function createPasswordState(field: PasswordField, styler?: Style
  * @returns A {@link PromptInterface}
  *
  * @remarks
- * The caller awaits the parked form's own `answer`. Timeout or teardown destroys the form, so that
- * promise rejects with the Form package's `ABANDONED` error. Inject `options.timer` to drive
- * expiry without real time.
+ * The caller awaits the parked form's own `answer`. Timeout, `stop`, or teardown destroys the form,
+ * so that promise rejects with the Form package's `ABANDONED` error. Inject `options.timer` to
+ * drive expiry without real time.
  *
  * @example
  * ```ts
@@ -747,7 +747,7 @@ export declare interface PendingForm {
  * @remarks
  * - `pending` — parked, awaiting {@link PromptInterface.answer}.
  * - `answered` — answered and accepted, so the parked form settled.
- * - `expired` — timed out, or torn down by `destroy`, before an answer.
+ * - `expired` — timed out, released by `stop`, or torn down by `destroy`, before an answer.
  */
 export declare type PendingFormStatus = 'pending' | 'answered' | 'expired';
 
@@ -758,7 +758,8 @@ export declare type PendingFormStatus = 'pending' | 'answered' | 'expired';
  * @remarks
  * A parked record carries one call to `serializeForm`. A failed fill or submit leaves the record
  * parked for another answer. A successful submit settles the form once, emits `answer`, and removes
- * the record. Timeout and teardown abandon every unsettled form through its own `destroy` method.
+ * the record. Timeout, `stop`, and teardown abandon unsettled forms through their own `destroy`
+ * method.
  *
  * @example
  * ```ts
@@ -778,6 +779,9 @@ export declare class Prompt implements PromptInterface {
     pending(id: string): PendingForm | undefined;
     park(form: FormInterface, request?: ParkRequest): string;
     answer(id: string, values: FormValues): Result<FormValues, AnswerError>;
+    stop(ids: readonly string[]): boolean;
+    stop(id: string): boolean;
+    stop(): void;
     destroy(): void;
 }
 
@@ -929,7 +933,7 @@ export declare interface PromptClientOptions {
  * @remarks
  * - `pending` — a form was parked; a transport forwards the wire record to remote clients.
  * - `answer` — a parked form was answered and accepted, carrying its id and the settled values.
- * - `expire` — a parked form timed out or was torn down unanswered, carrying its id.
+ * - `expire` — a parked form timed out or was released unanswered, carrying its id.
  */
 export declare type PromptEventMap = {
     readonly pending: readonly [form: PendingForm];
@@ -969,6 +973,19 @@ export declare type PromptIcon = 'question' | 'pointer' | 'dot' | 'selected' | '
  * - **Timeout abandons.** An unanswered form is destroyed after `timeout` ms; `expire` fires and
  *   the caller's promise rejects on the form's own lifecycle. The timer is injectable.
  * - **Accessors.** `pending()` lists the parked records; `pending(id)` looks one up.
+ * - **Batch stop.** The array overload is declared first: `stop(ids)` releases each listed parked
+ *   form and reports whether all ids were parked; `stop(id)` releases one; `stop()` releases every
+ *   parked form without destroying the broker. Release uses the existing expiry semantics.
+ *
+ * @example
+ * ```ts
+ * const prompt = createPrompt()
+ * const first = prompt.park(createForm({ fields: [{ control: 'text', name: 'first' }] }))
+ * const second = prompt.park(createForm({ fields: [{ control: 'text', name: 'second' }] }))
+ * prompt.stop(first) // true
+ * prompt.stop([second, 'missing']) // false; `second` was still released
+ * prompt.stop() // release every remaining form; the broker stays usable
+ * ```
  */
 export declare interface PromptInterface {
     readonly emitter: EmitterInterface<PromptEventMap>;
@@ -977,6 +994,9 @@ export declare interface PromptInterface {
     pending(): readonly PendingForm[];
     pending(id: string): PendingForm | undefined;
     answer(id: string, values: FormValues): Result<FormValues, AnswerError>;
+    stop(ids: readonly string[]): boolean;
+    stop(id: string): boolean;
+    stop(): void;
     destroy(): void;
 }
 
@@ -1159,7 +1179,7 @@ export declare function selectView(state: ReturnType<typeof createSelectState>):
  */
 export declare const SEQUENCE_NAMES: Readonly<Record<string, string>>;
 
-/** Serialize a parked prompt's expiry into a {@link WireEvent} — event `'expire'`, `data` the JSON-stringified `{ id }` payload. */
+/** Serialize a parked prompt's expiry or release into a {@link WireEvent} — event `'expire'`, `data` the JSON-stringified `{ id }` payload. */
 export declare function serializeExpire(id: string): WireEvent;
 
 /** Serialize a parked {@link PendingForm} into a {@link WireEvent}. */
@@ -1185,7 +1205,7 @@ export declare const SSE_BUFFER_LIMIT = 1048576;
  *
  * @remarks
  * - `pending` — a serialized {@link import('./types.js').PendingForm} to dispatch and answer.
- * - `expire` — an `{ id }` payload: the broker expired a parked prompt (the client drops it).
+ * - `expire` — an `{ id }` payload: the broker expired or released a parked prompt (the client drops it).
  * - `shutdown` — the broker is going away; the client disconnects (no auto-reconnect) but stays reusable.
  */
 export declare const SSE_EVENTS: Readonly<{

package/dist/src/core/index.js

@@ -231,7 +231,7 @@ var DEFAULT_RECONNECT_DELAY_MS = 2e3;
 *
 * @remarks
 * - `pending` — a serialized {@link import('./types.js').PendingForm} to dispatch and answer.
-* - `expire` — an `{ id }` payload: the broker expired a parked prompt (the client drops it).
+* - `expire` — an `{ id }` payload: the broker expired or released a parked prompt (the client drops it).
 * - `shutdown` — the broker is going away; the client disconnects (no auto-reconnect) but stays reusable.
 */
 var SSE_EVENTS = Object.freeze({
@@ -561,13 +561,11 @@ function sanitizeSchema(schema) {
 					}))
 				});
 				break;
-			case "file":
-				fields.push({
-					...field,
-					...shared,
-					...field.accept !== void 0 ? { accept: field.accept.map(sanitizeDisplayText) } : {}
-				});
-				break;
+			case "file": fields.push({
+				...field,
+				...shared,
+				...field.accept !== void 0 ? { accept: field.accept.map(sanitizeDisplayText) } : {}
+			});
 		}
 	}
 	return {
@@ -1128,7 +1126,7 @@ function serializePending(form) {
 		id: form.id
 	};
 }
-/** Serialize a parked prompt's expiry into a {@link WireEvent} — event `'expire'`, `data` the JSON-stringified `{ id }` payload. */
+/** Serialize a parked prompt's expiry or release into a {@link WireEvent} — event `'expire'`, `data` the JSON-stringified `{ id }` payload. */
 function serializeExpire(id) {
 	return {
 		event: "expire",
@@ -1151,7 +1149,8 @@ function serializeShutdown() {
 * @remarks
 * A parked record carries one call to `serializeForm`. A failed fill or submit leaves the record
 * parked for another answer. A successful submit settles the form once, emits `answer`, and removes
-* the record. Timeout and teardown abandon every unsettled form through its own `destroy` method.
+* the record. Timeout, `stop`, and teardown abandon unsettled forms through their own `destroy`
+* method.
 *
 * @example
 * ```ts
@@ -1231,6 +1230,22 @@ var Prompt = class {
 			}
 		};
 	}
+	stop(ids) {
+		if (ids === void 0) {
+			for (const id of [...this.#parked.keys()]) this.#expire(id);
+			return;
+		}
+		if (isArray(ids)) {
+			let stopped = true;
+			for (const id of ids) {
+				const parked = this.#parked.get(id);
+				if (parked === void 0 || parked.pending.status !== "pending") stopped = false;
+			}
+			for (const id of ids) this.#expire(id);
+			return stopped;
+		}
+		return this.#expire(ids);
+	}
 	destroy() {
 		if (this.#destroyed) return;
 		this.#destroyed = true;
@@ -1300,7 +1315,7 @@ var Prompt = class {
 	}
 	#expire(id) {
 		const parked = this.#parked.get(id);
-		if (parked === void 0 || parked.pending.status !== "pending") return;
+		if (parked === void 0 || parked.pending.status !== "pending") return false;
 		parked.cancel();
 		const expired = {
 			...parked,
@@ -1313,6 +1328,7 @@ var Prompt = class {
 		parked.form.destroy();
 		this.#emitter.emit("expire", id);
 		this.#parked.delete(id);
+		return true;
 	}
 };
 //#endregion
@@ -1995,9 +2011,9 @@ var DatabaseTerminalStore = class {
 * @returns A {@link PromptInterface}
 *
 * @remarks
-* The caller awaits the parked form's own `answer`. Timeout or teardown destroys the form, so that
-* promise rejects with the Form package's `ABANDONED` error. Inject `options.timer` to drive
-* expiry without real time.
+* The caller awaits the parked form's own `answer`. Timeout, `stop`, or teardown destroys the form,
+* so that promise rejects with the Form package's `ABANDONED` error. Inject `options.timer` to
+* drive expiry without real time.
 *
 * @example
 * ```ts
@@ -2090,12 +2106,13 @@ function createMemoryTerminalStore() {
 * ```
 */
 function createDatabaseTerminalStore(driver = createMemoryDriver()) {
+	const columns = {
+		id: stringShape(),
+		snapshot: rawShape({})
+	};
 	return new DatabaseTerminalStore(createDatabase({
 		driver,
-		tables: { terminals: {
-			id: stringShape(),
-			snapshot: rawShape({})
-		} }
+		tables: { terminals: columns }
 	}).table("terminals"));
 }
 //#endregion