@pooder/core 2.0.0 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @pooder/core
 
+## 2.2.0
+
+### Minor Changes
+
+- service
+
+## 2.1.0
+
+### Minor Changes
+
+- white ink tool and size tool
+
 ## 2.0.0
 
 ### Major Changes

package/dist/index.d.mts

@@ -1,15 +1,3 @@
-interface Service {
-    init?(): void;
-    dispose?(): void;
-}
-declare class ServiceRegistry {
-    private services;
-    register<T extends Service>(name: string, service: T): T;
-    get<T extends Service>(serviceName: string): T | undefined;
-    has(serviceName: string): boolean;
-    delete(serviceName: string): void;
-}
-
 type EventHandler = (...args: any[]) => void | boolean;
 declare class EventBus {
     private events;
@@ -20,6 +8,52 @@ declare class EventBus {
     count(event: string): number;
 }
 
+interface Service {
+    init?(context: ServiceContext): void | Promise<void>;
+    dispose?(context: ServiceContext): void | Promise<void>;
+}
+interface ServiceToken<T extends Service = Service> {
+    readonly kind: "service-token";
+    readonly key: symbol;
+    readonly name: string;
+}
+type ServiceIdentifier<T extends Service = Service> = string | ServiceToken<T>;
+interface ServiceContext {
+    readonly eventBus: EventBus;
+    get<T extends Service>(identifier: ServiceIdentifier<T>): T | undefined;
+    getOrThrow<T extends Service>(identifier: ServiceIdentifier<T>, errorMessage?: string): T;
+    has(identifier: ServiceIdentifier<Service>): boolean;
+}
+interface RegisterServiceOptions {
+    allowOverride?: boolean;
+}
+interface RegisteredService<T extends Service = Service> {
+    readonly id: string;
+    readonly token?: ServiceToken<T>;
+    readonly service: T;
+}
+declare function createServiceToken<T extends Service = Service>(name: string): ServiceToken<T>;
+declare function isServiceToken<T extends Service = Service>(identifier: unknown): identifier is ServiceToken<T>;
+declare class ServiceRegistry {
+    private readonly servicesByName;
+    private readonly servicesByToken;
+    private readonly registrationOrder;
+    register<T extends Service>(identifier: ServiceIdentifier<T>, service: T, options?: RegisterServiceOptions): T;
+    get<T extends Service>(identifier: ServiceIdentifier<T>): T | undefined;
+    get<T extends Service>(identifier: ServiceToken<T>): T | undefined;
+    get<T extends Service>(identifier: string): T | undefined;
+    getOrThrow<T extends Service>(identifier: ServiceIdentifier<T>, errorMessage?: string): T;
+    getOrThrow<T extends Service>(identifier: ServiceToken<T>, errorMessage?: string): T;
+    getOrThrow<T extends Service>(identifier: string, errorMessage?: string): T;
+    has(identifier: ServiceIdentifier<Service>): boolean;
+    delete(identifier: ServiceIdentifier<Service>): boolean;
+    list(): RegisteredService[];
+    clear(): void;
+    private findEntry;
+    private normalizeIdentifier;
+    private removeEntry;
+}
+
 interface ContributionPoint<T = any> {
     id: string;
     description?: string;
@@ -37,12 +71,33 @@ interface CommandContribution {
 /**
  * Tool Contribution Data Definition
  */
+type ToolInteraction = "instant" | "session" | "hybrid";
+type ToolSessionLeavePolicy = "block" | "commit" | "rollback";
+interface ToolCommandBindings {
+    execute?: string;
+    begin?: string;
+    validate?: string;
+    commit?: string;
+    rollback?: string;
+    reset?: string;
+}
 interface ToolContribution {
     id: string;
     name: string;
-    description: string;
+    description?: string;
+    icon?: string;
+    interaction: ToolInteraction;
     parameters?: Record<string, any>;
-    execute: (...args: any[]) => Promise<any>;
+    commands?: ToolCommandBindings;
+    view?: {
+        id?: string;
+        type?: "sidebar" | "panel" | "editor" | "dialog";
+        location?: string;
+    };
+    session?: {
+        autoBegin?: boolean;
+        leavePolicy?: ToolSessionLeavePolicy;
+    };
 }
 /**
  * View Contribution Data Definition
@@ -125,7 +180,9 @@ interface Contribution<T = any> {
 interface ExtensionContext {
     readonly eventBus: EventBus;
     readonly services: {
-        get<T extends Service>(serviceName: string): T | undefined;
+        get<T extends Service>(identifier: ServiceIdentifier<T>): T | undefined;
+        getOrThrow<T extends Service>(identifier: ServiceIdentifier<T>, errorMessage?: string): T;
+        has(identifier: ServiceIdentifier<Service>): boolean;
     };
     readonly contributions: {
         get<T>(pointId: string): Contribution<T>[];
@@ -249,29 +306,147 @@ declare class ConfigurationService implements Service {
     dispose(): void;
 }
 
+declare class ToolRegistryService implements Service {
+    private tools;
+    registerTool(tool: ToolContribution): Disposable;
+    unregisterTool(toolId: string): void;
+    getTool(toolId: string): ToolContribution | undefined;
+    listTools(): ToolContribution[];
+    hasTool(toolId: string): boolean;
+    dispose(): void;
+}
+
+type ToolSessionStatus = "idle" | "active";
+interface ToolSessionState {
+    toolId: string;
+    status: ToolSessionStatus;
+    dirty: boolean;
+    startedAt?: number;
+    lastUpdatedAt?: number;
+}
+type LeaveDecision = "allow" | "blocked";
+interface LeaveResult {
+    decision: LeaveDecision;
+    reason?: string;
+}
+interface ToolSessionServiceDependencies {
+    commandService?: CommandService;
+    toolRegistry?: ToolRegistryService;
+}
+declare class ToolSessionService implements Service {
+    private readonly sessions;
+    private commandService?;
+    private toolRegistry?;
+    constructor(dependencies?: ToolSessionServiceDependencies);
+    init(context: ServiceContext): void;
+    setCommandService(commandService: CommandService): void;
+    setToolRegistry(toolRegistry: ToolRegistryService): void;
+    registerDirtyTracker(toolId: string, callback: () => boolean): Disposable;
+    private readonly dirtyTrackers;
+    private ensureSession;
+    getState(toolId: string): ToolSessionState;
+    isDirty(toolId: string): boolean;
+    markDirty(toolId: string, dirty?: boolean): void;
+    private resolveTool;
+    private runCommand;
+    private getCommandService;
+    private getToolRegistry;
+    begin(toolId: string): Promise<void>;
+    validate(toolId: string): Promise<{
+        ok: boolean;
+        result?: any;
+    }>;
+    commit(toolId: string): Promise<{
+        ok: boolean;
+        result?: any;
+    }>;
+    rollback(toolId: string): Promise<void>;
+    deactivateSession(toolId: string): void;
+    handleBeforeLeave(toolId: string): Promise<LeaveResult>;
+    dispose(): void;
+}
+
+interface ToolSwitchContext {
+    from: string | null;
+    to: string | null;
+    reason?: string;
+}
+interface ToolSwitchResult {
+    ok: boolean;
+    from: string | null;
+    to: string | null;
+    reason?: string;
+}
+type ToolSwitchGuard = (context: ToolSwitchContext) => boolean | Promise<boolean>;
+interface WorkbenchServiceDependencies {
+    eventBus?: EventBus;
+    toolRegistry?: ToolRegistryService;
+    sessionService?: ToolSessionService;
+}
 declare class WorkbenchService implements Service {
     private _activeToolId;
     private eventBus?;
-    init(): void;
+    private toolRegistry?;
+    private sessionService?;
+    private guards;
+    constructor(dependencies?: WorkbenchServiceDependencies);
+    init(context: ServiceContext): void;
     dispose(): void;
     setEventBus(bus: EventBus): void;
+    setToolRegistry(toolRegistry: ToolRegistryService): void;
+    setToolSessionService(sessionService: ToolSessionService): void;
     get activeToolId(): string | null;
-    activate(id: string): void;
+    registerSwitchGuard(guard: ToolSwitchGuard, priority?: number): Disposable;
+    private runGuards;
+    switchTool(id: string | null, options?: {
+        reason?: string;
+    }): Promise<ToolSwitchResult>;
+    activate(id: string | null): Promise<ToolSwitchResult>;
+    deactivate(): Promise<ToolSwitchResult>;
+    private getEventBus;
+    private getToolRegistry;
+    private getSessionService;
 }
 
+declare const COMMAND_SERVICE: ServiceToken<CommandService>;
+declare const CONFIGURATION_SERVICE: ServiceToken<ConfigurationService>;
+declare const TOOL_REGISTRY_SERVICE: ServiceToken<ToolRegistryService>;
+declare const TOOL_SESSION_SERVICE: ServiceToken<ToolSessionService>;
+declare const WORKBENCH_SERVICE: ServiceToken<WorkbenchService>;
+declare const CORE_SERVICE_TOKENS: {
+    readonly COMMAND: ServiceToken<CommandService>;
+    readonly CONFIGURATION: ServiceToken<ConfigurationService>;
+    readonly TOOL_REGISTRY: ServiceToken<ToolRegistryService>;
+    readonly TOOL_SESSION: ServiceToken<ToolSessionService>;
+    readonly WORKBENCH: ServiceToken<WorkbenchService>;
+};
+
 declare class Pooder {
     readonly eventBus: EventBus;
     private readonly services;
+    private readonly serviceContext;
     private readonly contributions;
     readonly extensionManager: ExtensionManager;
     constructor();
     private initDefaultContributionPoints;
-    registerService(service: Service, id?: string): boolean;
-    unregisterService(service: Service, id?: string): boolean;
-    getService<T extends Service>(id: string): T | undefined;
+    registerService<T extends Service>(service: T, identifier?: ServiceIdentifier<T>, options?: RegisterServiceOptions): boolean;
+    registerServiceAsync<T extends Service>(service: T, identifier?: ServiceIdentifier<T>, options?: RegisterServiceOptions): Promise<boolean>;
+    unregisterService(service: Service, id?: ServiceIdentifier<Service>): boolean;
+    unregisterService(identifier: ServiceIdentifier<Service>): boolean;
+    unregisterServiceAsync(serviceOrIdentifier: Service | ServiceIdentifier<Service>, id?: ServiceIdentifier<Service>): Promise<boolean>;
+    getService<T extends Service>(identifier: ServiceIdentifier<T>): T | undefined;
+    getServiceOrThrow<T extends Service>(identifier: ServiceIdentifier<T>, errorMessage?: string): T;
+    hasService(identifier: ServiceIdentifier<Service>): boolean;
+    dispose(): Promise<void>;
     registerContributionPoint<T>(point: ContributionPoint<T>): void;
     registerContribution<T>(pointId: string, contribution: Contribution<T>): Disposable;
     getContributions<T>(pointId: string): Contribution<T>[];
+    private resolveServiceIdentifier;
+    private resolveUnregisterIdentifier;
+    private getServiceLabel;
+    private invokeServiceHook;
+    private invokeServiceHookAsync;
+    private isPromiseLike;
 }
 
-export { type CommandContribution, CommandService, type ConfigurationContribution, ConfigurationService, type Contribution, type ContributionMetadata, type ContributionPoint, ContributionPointIds, ContributionRegistry, EventBus, type Extension, type ExtensionContext, ExtensionManager, type ExtensionMetadata, ExtensionRegistry, Pooder, type Service, ServiceRegistry, type ToolContribution, type ViewContribution, WorkbenchService };
+export { COMMAND_SERVICE, CONFIGURATION_SERVICE, CORE_SERVICE_TOKENS, type CommandContribution, CommandService, type ConfigurationContribution, ConfigurationService, type Contribution, type ContributionMetadata, type ContributionPoint, ContributionPointIds, ContributionRegistry, EventBus, type Extension, type ExtensionContext, ExtensionManager, type ExtensionMetadata, ExtensionRegistry, Pooder, type RegisterServiceOptions, type RegisteredService, type Service, type ServiceContext, type ServiceIdentifier, ServiceRegistry, type ServiceToken, TOOL_REGISTRY_SERVICE, TOOL_SESSION_SERVICE, type ToolCommandBindings, type ToolContribution, type ToolInteraction, ToolRegistryService, type ToolSessionLeavePolicy, ToolSessionService, type ViewContribution, WORKBENCH_SERVICE, WorkbenchService, createServiceToken, isServiceToken };

package/dist/index.d.ts

@@ -1,15 +1,3 @@
-interface Service {
-    init?(): void;
-    dispose?(): void;
-}
-declare class ServiceRegistry {
-    private services;
-    register<T extends Service>(name: string, service: T): T;
-    get<T extends Service>(serviceName: string): T | undefined;
-    has(serviceName: string): boolean;
-    delete(serviceName: string): void;
-}
-
 type EventHandler = (...args: any[]) => void | boolean;
 declare class EventBus {
     private events;
@@ -20,6 +8,52 @@ declare class EventBus {
     count(event: string): number;
 }
 
+interface Service {
+    init?(context: ServiceContext): void | Promise<void>;
+    dispose?(context: ServiceContext): void | Promise<void>;
+}
+interface ServiceToken<T extends Service = Service> {
+    readonly kind: "service-token";
+    readonly key: symbol;
+    readonly name: string;
+}
+type ServiceIdentifier<T extends Service = Service> = string | ServiceToken<T>;
+interface ServiceContext {
+    readonly eventBus: EventBus;
+    get<T extends Service>(identifier: ServiceIdentifier<T>): T | undefined;
+    getOrThrow<T extends Service>(identifier: ServiceIdentifier<T>, errorMessage?: string): T;
+    has(identifier: ServiceIdentifier<Service>): boolean;
+}
+interface RegisterServiceOptions {
+    allowOverride?: boolean;
+}
+interface RegisteredService<T extends Service = Service> {
+    readonly id: string;
+    readonly token?: ServiceToken<T>;
+    readonly service: T;
+}
+declare function createServiceToken<T extends Service = Service>(name: string): ServiceToken<T>;
+declare function isServiceToken<T extends Service = Service>(identifier: unknown): identifier is ServiceToken<T>;
+declare class ServiceRegistry {
+    private readonly servicesByName;
+    private readonly servicesByToken;
+    private readonly registrationOrder;
+    register<T extends Service>(identifier: ServiceIdentifier<T>, service: T, options?: RegisterServiceOptions): T;
+    get<T extends Service>(identifier: ServiceIdentifier<T>): T | undefined;
+    get<T extends Service>(identifier: ServiceToken<T>): T | undefined;
+    get<T extends Service>(identifier: string): T | undefined;
+    getOrThrow<T extends Service>(identifier: ServiceIdentifier<T>, errorMessage?: string): T;
+    getOrThrow<T extends Service>(identifier: ServiceToken<T>, errorMessage?: string): T;
+    getOrThrow<T extends Service>(identifier: string, errorMessage?: string): T;
+    has(identifier: ServiceIdentifier<Service>): boolean;
+    delete(identifier: ServiceIdentifier<Service>): boolean;
+    list(): RegisteredService[];
+    clear(): void;
+    private findEntry;
+    private normalizeIdentifier;
+    private removeEntry;
+}
+
 interface ContributionPoint<T = any> {
     id: string;
     description?: string;
@@ -37,12 +71,33 @@ interface CommandContribution {
 /**
  * Tool Contribution Data Definition
  */
+type ToolInteraction = "instant" | "session" | "hybrid";
+type ToolSessionLeavePolicy = "block" | "commit" | "rollback";
+interface ToolCommandBindings {
+    execute?: string;
+    begin?: string;
+    validate?: string;
+    commit?: string;
+    rollback?: string;
+    reset?: string;
+}
 interface ToolContribution {
     id: string;
     name: string;
-    description: string;
+    description?: string;
+    icon?: string;
+    interaction: ToolInteraction;
     parameters?: Record<string, any>;
-    execute: (...args: any[]) => Promise<any>;
+    commands?: ToolCommandBindings;
+    view?: {
+        id?: string;
+        type?: "sidebar" | "panel" | "editor" | "dialog";
+        location?: string;
+    };
+    session?: {
+        autoBegin?: boolean;
+        leavePolicy?: ToolSessionLeavePolicy;
+    };
 }
 /**
  * View Contribution Data Definition
@@ -125,7 +180,9 @@ interface Contribution<T = any> {
 interface ExtensionContext {
     readonly eventBus: EventBus;
     readonly services: {
-        get<T extends Service>(serviceName: string): T | undefined;
+        get<T extends Service>(identifier: ServiceIdentifier<T>): T | undefined;
+        getOrThrow<T extends Service>(identifier: ServiceIdentifier<T>, errorMessage?: string): T;
+        has(identifier: ServiceIdentifier<Service>): boolean;
     };
     readonly contributions: {
         get<T>(pointId: string): Contribution<T>[];
@@ -249,29 +306,147 @@ declare class ConfigurationService implements Service {
     dispose(): void;
 }
 
+declare class ToolRegistryService implements Service {
+    private tools;
+    registerTool(tool: ToolContribution): Disposable;
+    unregisterTool(toolId: string): void;
+    getTool(toolId: string): ToolContribution | undefined;
+    listTools(): ToolContribution[];
+    hasTool(toolId: string): boolean;
+    dispose(): void;
+}
+
+type ToolSessionStatus = "idle" | "active";
+interface ToolSessionState {
+    toolId: string;
+    status: ToolSessionStatus;
+    dirty: boolean;
+    startedAt?: number;
+    lastUpdatedAt?: number;
+}
+type LeaveDecision = "allow" | "blocked";
+interface LeaveResult {
+    decision: LeaveDecision;
+    reason?: string;
+}
+interface ToolSessionServiceDependencies {
+    commandService?: CommandService;
+    toolRegistry?: ToolRegistryService;
+}
+declare class ToolSessionService implements Service {
+    private readonly sessions;
+    private commandService?;
+    private toolRegistry?;
+    constructor(dependencies?: ToolSessionServiceDependencies);
+    init(context: ServiceContext): void;
+    setCommandService(commandService: CommandService): void;
+    setToolRegistry(toolRegistry: ToolRegistryService): void;
+    registerDirtyTracker(toolId: string, callback: () => boolean): Disposable;
+    private readonly dirtyTrackers;
+    private ensureSession;
+    getState(toolId: string): ToolSessionState;
+    isDirty(toolId: string): boolean;
+    markDirty(toolId: string, dirty?: boolean): void;
+    private resolveTool;
+    private runCommand;
+    private getCommandService;
+    private getToolRegistry;
+    begin(toolId: string): Promise<void>;
+    validate(toolId: string): Promise<{
+        ok: boolean;
+        result?: any;
+    }>;
+    commit(toolId: string): Promise<{
+        ok: boolean;
+        result?: any;
+    }>;
+    rollback(toolId: string): Promise<void>;
+    deactivateSession(toolId: string): void;
+    handleBeforeLeave(toolId: string): Promise<LeaveResult>;
+    dispose(): void;
+}
+
+interface ToolSwitchContext {
+    from: string | null;
+    to: string | null;
+    reason?: string;
+}
+interface ToolSwitchResult {
+    ok: boolean;
+    from: string | null;
+    to: string | null;
+    reason?: string;
+}
+type ToolSwitchGuard = (context: ToolSwitchContext) => boolean | Promise<boolean>;
+interface WorkbenchServiceDependencies {
+    eventBus?: EventBus;
+    toolRegistry?: ToolRegistryService;
+    sessionService?: ToolSessionService;
+}
 declare class WorkbenchService implements Service {
     private _activeToolId;
     private eventBus?;
-    init(): void;
+    private toolRegistry?;
+    private sessionService?;
+    private guards;
+    constructor(dependencies?: WorkbenchServiceDependencies);
+    init(context: ServiceContext): void;
     dispose(): void;
     setEventBus(bus: EventBus): void;
+    setToolRegistry(toolRegistry: ToolRegistryService): void;
+    setToolSessionService(sessionService: ToolSessionService): void;
     get activeToolId(): string | null;
-    activate(id: string): void;
+    registerSwitchGuard(guard: ToolSwitchGuard, priority?: number): Disposable;
+    private runGuards;
+    switchTool(id: string | null, options?: {
+        reason?: string;
+    }): Promise<ToolSwitchResult>;
+    activate(id: string | null): Promise<ToolSwitchResult>;
+    deactivate(): Promise<ToolSwitchResult>;
+    private getEventBus;
+    private getToolRegistry;
+    private getSessionService;
 }
 
+declare const COMMAND_SERVICE: ServiceToken<CommandService>;
+declare const CONFIGURATION_SERVICE: ServiceToken<ConfigurationService>;
+declare const TOOL_REGISTRY_SERVICE: ServiceToken<ToolRegistryService>;
+declare const TOOL_SESSION_SERVICE: ServiceToken<ToolSessionService>;
+declare const WORKBENCH_SERVICE: ServiceToken<WorkbenchService>;
+declare const CORE_SERVICE_TOKENS: {
+    readonly COMMAND: ServiceToken<CommandService>;
+    readonly CONFIGURATION: ServiceToken<ConfigurationService>;
+    readonly TOOL_REGISTRY: ServiceToken<ToolRegistryService>;
+    readonly TOOL_SESSION: ServiceToken<ToolSessionService>;
+    readonly WORKBENCH: ServiceToken<WorkbenchService>;
+};
+
 declare class Pooder {
     readonly eventBus: EventBus;
     private readonly services;
+    private readonly serviceContext;
     private readonly contributions;
     readonly extensionManager: ExtensionManager;
     constructor();
     private initDefaultContributionPoints;
-    registerService(service: Service, id?: string): boolean;
-    unregisterService(service: Service, id?: string): boolean;
-    getService<T extends Service>(id: string): T | undefined;
+    registerService<T extends Service>(service: T, identifier?: ServiceIdentifier<T>, options?: RegisterServiceOptions): boolean;
+    registerServiceAsync<T extends Service>(service: T, identifier?: ServiceIdentifier<T>, options?: RegisterServiceOptions): Promise<boolean>;
+    unregisterService(service: Service, id?: ServiceIdentifier<Service>): boolean;
+    unregisterService(identifier: ServiceIdentifier<Service>): boolean;
+    unregisterServiceAsync(serviceOrIdentifier: Service | ServiceIdentifier<Service>, id?: ServiceIdentifier<Service>): Promise<boolean>;
+    getService<T extends Service>(identifier: ServiceIdentifier<T>): T | undefined;
+    getServiceOrThrow<T extends Service>(identifier: ServiceIdentifier<T>, errorMessage?: string): T;
+    hasService(identifier: ServiceIdentifier<Service>): boolean;
+    dispose(): Promise<void>;
     registerContributionPoint<T>(point: ContributionPoint<T>): void;
     registerContribution<T>(pointId: string, contribution: Contribution<T>): Disposable;
     getContributions<T>(pointId: string): Contribution<T>[];
+    private resolveServiceIdentifier;
+    private resolveUnregisterIdentifier;
+    private getServiceLabel;
+    private invokeServiceHook;
+    private invokeServiceHookAsync;
+    private isPromiseLike;
 }
 
-export { type CommandContribution, CommandService, type ConfigurationContribution, ConfigurationService, type Contribution, type ContributionMetadata, type ContributionPoint, ContributionPointIds, ContributionRegistry, EventBus, type Extension, type ExtensionContext, ExtensionManager, type ExtensionMetadata, ExtensionRegistry, Pooder, type Service, ServiceRegistry, type ToolContribution, type ViewContribution, WorkbenchService };
+export { COMMAND_SERVICE, CONFIGURATION_SERVICE, CORE_SERVICE_TOKENS, type CommandContribution, CommandService, type ConfigurationContribution, ConfigurationService, type Contribution, type ContributionMetadata, type ContributionPoint, ContributionPointIds, ContributionRegistry, EventBus, type Extension, type ExtensionContext, ExtensionManager, type ExtensionMetadata, ExtensionRegistry, Pooder, type RegisterServiceOptions, type RegisteredService, type Service, type ServiceContext, type ServiceIdentifier, ServiceRegistry, type ServiceToken, TOOL_REGISTRY_SERVICE, TOOL_SESSION_SERVICE, type ToolCommandBindings, type ToolContribution, type ToolInteraction, ToolRegistryService, type ToolSessionLeavePolicy, ToolSessionService, type ViewContribution, WORKBENCH_SERVICE, WorkbenchService, createServiceToken, isServiceToken };