@bilig/workbook 0.62.0 → 0.66.0

package/dist/features.d.ts

@@ -1,5 +1,5 @@
-import type { CellRangeRef, CellStylePatch, CellStyleRecord, LiteralInput } from '@bilig/protocol';
-import { type WorkbookActionInput, type WorkbookActionInputDescription } from './input.js';
+import type { CellRangeRef } from '@bilig/protocol';
+import { type WorkbookActionInput } from './input.js';
 import type { EngineOp } from './ops.js';
 import type { WorkbookUndoRef } from './result.js';
 export type WorkbookFeatureId = string;
@@ -8,18 +8,11 @@ export type WorkbookCommandExecutionMode = 'preview' | 'apply' | 'applyAndVerify
 export type WorkbookCommandReceiptStatus = 'previewed' | 'applied' | 'rejected' | 'noop';
 export type WorkbookProjectionInterceptorPoint = 'cellDisplay' | 'cellStyle' | 'rangeChrome' | 'rowVisibility' | 'beforeCommand' | 'commandMetadata';
 export type WorkbookUiContributionSlot = 'toolbar' | 'sidePanel' | 'floatingOverlay' | 'status';
-export interface WorkbookFeatureLifecycleContext {
-    readonly featureId: WorkbookFeatureId;
-    readonly activeFeatures: readonly WorkbookFeatureId[];
-}
-export interface WorkbookCommandDescriptor {
-    readonly id: string;
-    readonly featureId: WorkbookFeatureId;
-    readonly category: WorkbookCommandCategory;
-    readonly label: string;
-    readonly description?: string;
-    readonly input?: WorkbookActionInputDescription;
-}
+export declare const workbookCommandCategories: readonly ["command", "operation", "mutation"];
+export declare const workbookCommandExecutionModes: readonly ["preview", "apply", "applyAndVerify"];
+export declare const workbookCommandReceiptStatuses: readonly ["previewed", "applied", "rejected", "noop"];
+export declare const workbookProjectionInterceptorPoints: readonly ["cellDisplay", "cellStyle", "rangeChrome", "rowVisibility", "beforeCommand", "commandMetadata"];
+export declare const workbookUiContributionSlots: readonly ["toolbar", "sidePanel", "floatingOverlay", "status"];
 export interface WorkbookCommandRequest {
     readonly featureId: WorkbookFeatureId;
     readonly commandId: string;
@@ -27,6 +20,20 @@ export interface WorkbookCommandRequest {
     readonly mode?: WorkbookCommandExecutionMode;
     readonly input?: WorkbookActionInput;
 }
+export type WorkbookCommandRequestIssueCode = 'invalid_command_request';
+export interface WorkbookCommandRequestIssue {
+    readonly code: WorkbookCommandRequestIssueCode;
+    readonly path: string;
+    readonly message: string;
+}
+export type WorkbookCommandRequestCheckResult = {
+    readonly status: 'valid';
+    readonly request: WorkbookCommandRequest;
+    readonly issues: readonly [];
+} | {
+    readonly status: 'invalid';
+    readonly issues: readonly WorkbookCommandRequestIssue[];
+};
 export interface WorkbookCommandReceipt {
     readonly status: WorkbookCommandReceiptStatus;
     readonly featureId: WorkbookFeatureId;
@@ -41,68 +48,30 @@ export interface WorkbookCommandReceipt {
     readonly metadata?: WorkbookActionInput;
     readonly errors?: readonly string[];
 }
-export interface WorkbookCellDisplayProjection {
-    readonly value?: LiteralInput;
-    readonly text?: string;
-    readonly metadata?: WorkbookActionInput;
-}
-export interface WorkbookCellStyleProjection {
-    readonly style?: CellStylePatch | CellStyleRecord;
-    readonly metadata?: WorkbookActionInput;
-}
-export interface WorkbookRangeChromeProjection {
-    readonly id: string;
-    readonly featureId: WorkbookFeatureId;
-    readonly source: 'workbook-metadata' | 'command-preview' | 'runtime';
-    readonly range: CellRangeRef;
-    readonly role: string;
-    readonly label?: string;
-    readonly metadata?: WorkbookActionInput;
-}
-export interface WorkbookRowVisibilityProjection {
-    readonly hidden?: boolean;
-    readonly metadata?: WorkbookActionInput;
-}
-export interface WorkbookCommandMetadataProjection {
-    readonly label?: string;
-    readonly changedRanges?: readonly CellRangeRef[];
-    readonly semanticTargets?: readonly WorkbookActionInput[];
-    readonly metadata?: WorkbookActionInput;
-}
-export interface WorkbookProjectionContext {
-    readonly featureId: WorkbookFeatureId;
-}
-export interface WorkbookProjectionInterceptorRegistration {
-    readonly id: string;
-    readonly featureId: WorkbookFeatureId;
-    readonly point: WorkbookProjectionInterceptorPoint;
-    readonly priority?: number;
-    readonly label?: string;
-}
-export interface WorkbookUiContribution {
-    readonly id: string;
-    readonly featureId: WorkbookFeatureId;
-    readonly slot: WorkbookUiContributionSlot;
-    readonly label: string;
-    readonly order?: number;
-    readonly metadata?: WorkbookActionInput;
-}
-export interface WorkbookFeatureRegistration {
-    readonly commands: readonly WorkbookCommandDescriptor[];
-    readonly projectionInterceptors: readonly WorkbookProjectionInterceptorRegistration[];
-    readonly uiContributions: readonly WorkbookUiContribution[];
-}
-export interface WorkbookFeaturePlugin extends WorkbookFeatureRegistration {
-    readonly id: WorkbookFeatureId;
-    readonly version: string;
-    readonly dependsOn?: readonly WorkbookFeatureId[];
-    readonly register?: (context: WorkbookFeatureLifecycleContext) => void;
-    readonly activate?: (context: WorkbookFeatureLifecycleContext) => void;
-    readonly dispose?: (context: WorkbookFeatureLifecycleContext) => void;
+export type WorkbookCommandReceiptIssueCode = 'invalid_command_receipt';
+export interface WorkbookCommandReceiptIssue {
+    readonly code: WorkbookCommandReceiptIssueCode;
+    readonly path: string;
+    readonly message: string;
 }
+export type WorkbookCommandReceiptCheckResult = {
+    readonly status: 'valid';
+    readonly receipt: WorkbookCommandReceipt;
+    readonly issues: readonly [];
+} | {
+    readonly status: 'invalid';
+    readonly issues: readonly WorkbookCommandReceiptIssue[];
+};
 export declare function normalizeWorkbookFeatureId(value: string, label?: string): WorkbookFeatureId;
-export declare function defineWorkbookFeaturePlugin(plugin: WorkbookFeaturePlugin): WorkbookFeaturePlugin;
-export declare function normalizeWorkbookCommandDescriptor(descriptor: WorkbookCommandDescriptor, expectedFeatureId?: WorkbookFeatureId): WorkbookCommandDescriptor;
-export declare function normalizeWorkbookCommandReceipt(receipt: WorkbookCommandReceipt): WorkbookCommandReceipt;
+export declare function isWorkbookCommandCategory(value: unknown): value is WorkbookCommandCategory;
+export declare function isWorkbookCommandExecutionMode(value: unknown): value is WorkbookCommandExecutionMode;
+export declare function isWorkbookCommandReceiptStatus(value: unknown): value is WorkbookCommandReceiptStatus;
+export declare function isWorkbookProjectionInterceptorPoint(value: unknown): value is WorkbookProjectionInterceptorPoint;
+export declare function isWorkbookUiContributionSlot(value: unknown): value is WorkbookUiContributionSlot;
+export declare function checkWorkbookCommandRequest(value: unknown): WorkbookCommandRequestCheckResult;
+export declare function normalizeWorkbookCommandRequest(value: unknown): WorkbookCommandRequest;
+export declare function isWorkbookCommandRequest(value: unknown): value is WorkbookCommandRequest;
+export declare function checkWorkbookCommandReceipt(value: unknown): WorkbookCommandReceiptCheckResult;
+export declare function normalizeWorkbookCommandReceipt(receipt: unknown): WorkbookCommandReceipt;
 export declare function isWorkbookCommandReceipt(value: unknown): value is WorkbookCommandReceipt;
 export declare function workbookCommandReceiptOpsMatch(receipt: Pick<WorkbookCommandReceipt, 'previewOps' | 'appliedOps'>): boolean | null;