@lvce-editor/api 9.33.2 → 9.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -59,7 +59,7 @@ export type { QuickPickItem } from './parts/QuickPickItem/QuickPickItem.ts';
59
59
  export type { CreateNodeRpcOptions, CreateRpcOptions } from './parts/Rpc/Rpc.ts';
60
60
  export type { RegisteredSourceControlProvider, SourceControlProvider, SourceControlProviderRegistrySnapshot, } from './parts/SourceControl/SourceControl.ts';
61
61
  export type { ShowQuickPickOptions } from './parts/ShowQuickPickOptions/ShowQuickPickOptions.ts';
62
- export type { StatusBarItem, StatusBarItemProvider, StatusBarItemProviderHandle, StatusBarItemProviderRegistrySnapshot, } from './parts/StatusBar/StatusBar.ts';
62
+ export type { StatusBarItem, StatusBarItemContextMenuItem, StatusBarItemProvider, StatusBarItemProviderHandle, StatusBarItemProviderRegistrySnapshot, } from './parts/StatusBar/StatusBar.ts';
63
63
  export { setRemoteDescription, startWebRtcAudioStream, stopWebRtcAudioStream, readMicLevels } from './parts/WebRtc/WebRtc.ts';
64
64
  export type { MicLevelsResult, ReadMicLevelOptions, SetRemoteDescriptionOptions, StartWebRpcAudioStreamOptions, WebRtcAudioConstraints, } from './parts/WebRtc/WebRtc.ts';
65
65
  export { registerPortProvider } from './parts/PortProviderRegistry/PortProviderRegistry.ts';
@@ -6,6 +6,7 @@ export interface RegisteredSourceControlProvider {
6
6
  readonly getBadgeCount?: () => number | Promise<number>;
7
7
  readonly getChangedFiles: () => readonly unknown[] | Promise<readonly unknown[]>;
8
8
  readonly getCurrentBranch?: (cwd: string) => string | Promise<string>;
9
+ readonly getDefaultCommitMessage?: (cwd: string) => string | Promise<string>;
9
10
  readonly getFeatures?: () => unknown | Promise<unknown>;
10
11
  readonly getFileBefore?: (uri: string) => unknown | Promise<unknown>;
11
12
  readonly getFileBeforeUri?: (uri: string) => string | Promise<string>;
@@ -1,5 +1,7 @@
1
1
  import type { StatusBarItem } from '../StatusBarItem/StatusBarItem.ts';
2
+ import type { StatusBarItemContextMenuItem } from '../StatusBarItemProvider/StatusBarItemProvider.ts';
2
3
  export interface RegisteredStatusBarItemProvider {
4
+ readonly getContextMenuItems?: () => readonly StatusBarItemContextMenuItem[];
3
5
  readonly getStatusBarItem: () => StatusBarItem | undefined;
4
6
  readonly id: string;
5
7
  }
@@ -1,4 +1,4 @@
1
- export { executeSourceControlAcceptInput, executeSourceControlAdd, executeSourceControlDiscard, executeSourceControlGenerateCommitMessage, executeSourceControlGetBadgeCount, executeSourceControlGetChangedFiles, executeSourceControlGetCurrentBranch, executeSourceControlGetFeatures, executeSourceControlGetFileBefore, executeSourceControlGetFileBeforeUri, executeSourceControlGetFileDecorations, executeSourceControlGetGroups, executeSourceControlGetProgress, executeSourceControlIsActive, getSourceControlProviderRegistrySnapshot, registerSourceControlProvider, resetSourceControlProviderRegistry, } from '../SourceControlProviderRegistry/SourceControlProviderRegistry.ts';
1
+ export { executeSourceControlAcceptInput, executeSourceControlAdd, executeSourceControlDiscard, executeSourceControlGenerateCommitMessage, executeSourceControlGetDefaultCommitMessage, executeSourceControlGetBadgeCount, executeSourceControlGetChangedFiles, executeSourceControlGetCurrentBranch, executeSourceControlGetFeatures, executeSourceControlGetFileBefore, executeSourceControlGetFileBeforeUri, executeSourceControlGetFileDecorations, executeSourceControlGetGroups, executeSourceControlGetProgress, executeSourceControlIsActive, getSourceControlProviderRegistrySnapshot, registerSourceControlProvider, resetSourceControlProviderRegistry, } from '../SourceControlProviderRegistry/SourceControlProviderRegistry.ts';
2
2
  export type { RegisteredSourceControlProvider } from '../RegisteredSourceControlProvider/RegisteredSourceControlProvider.ts';
3
3
  export type { SourceControlProvider } from '../SourceControlProvider/SourceControlProvider.ts';
4
4
  export type { SourceControlProviderRegistrySnapshot } from '../SourceControlProviderRegistrySnapshot/SourceControlProviderRegistrySnapshot.ts';
@@ -1 +1 @@
1
- export { executeSourceControlAcceptInput, executeSourceControlAdd, executeSourceControlDiscard, executeSourceControlGenerateCommitMessage, executeSourceControlGetBadgeCount, executeSourceControlGetChangedFiles, executeSourceControlGetCurrentBranch, executeSourceControlGetFeatures, executeSourceControlGetFileBefore, executeSourceControlGetFileBeforeUri, executeSourceControlGetFileDecorations, executeSourceControlGetGroups, executeSourceControlGetProgress, executeSourceControlIsActive, getSourceControlProviderRegistrySnapshot, registerSourceControlProvider, resetSourceControlProviderRegistry, } from "../SourceControlProviderRegistry/SourceControlProviderRegistry.js";
1
+ export { executeSourceControlAcceptInput, executeSourceControlAdd, executeSourceControlDiscard, executeSourceControlGenerateCommitMessage, executeSourceControlGetDefaultCommitMessage, executeSourceControlGetBadgeCount, executeSourceControlGetChangedFiles, executeSourceControlGetCurrentBranch, executeSourceControlGetFeatures, executeSourceControlGetFileBefore, executeSourceControlGetFileBeforeUri, executeSourceControlGetFileDecorations, executeSourceControlGetGroups, executeSourceControlGetProgress, executeSourceControlIsActive, getSourceControlProviderRegistrySnapshot, registerSourceControlProvider, resetSourceControlProviderRegistry, } from "../SourceControlProviderRegistry/SourceControlProviderRegistry.js";
@@ -6,6 +6,7 @@ export interface SourceControlProvider {
6
6
  readonly getBadgeCount?: () => number | Promise<number>;
7
7
  readonly getChangedFiles: () => readonly unknown[] | Promise<readonly unknown[]>;
8
8
  readonly getCurrentBranch?: (cwd: string) => string | Promise<string>;
9
+ readonly getDefaultCommitMessage?: (cwd: string) => string | Promise<string>;
9
10
  readonly getFeatures?: () => unknown | Promise<unknown>;
10
11
  readonly getFileBefore?: (uri: string) => unknown | Promise<unknown>;
11
12
  readonly getFileBeforeUri?: (uri: string) => string | Promise<string>;
@@ -6,6 +6,7 @@ export declare const executeSourceControlAcceptInput: (id: string, value: string
6
6
  export declare const executeSourceControlAdd: (id: string, path: string) => Promise<unknown>;
7
7
  export declare const executeSourceControlDiscard: (id: string, path: string) => Promise<unknown>;
8
8
  export declare const executeSourceControlGenerateCommitMessage: (id: string) => Promise<unknown>;
9
+ export declare const executeSourceControlGetDefaultCommitMessage: (id: string, cwd: string) => Promise<string | undefined>;
9
10
  export declare const executeSourceControlGetChangedFiles: (id: string) => Promise<readonly unknown[]>;
10
11
  export declare const executeSourceControlGetCurrentBranch: (id: string, cwd: string) => Promise<string | undefined>;
11
12
  export declare const executeSourceControlGetBadgeCount: (id: string) => Promise<number>;
@@ -6,6 +6,7 @@ const optionalMethods = [
6
6
  'add',
7
7
  'discard',
8
8
  'generateCommitMessage',
9
+ 'getDefaultCommitMessage',
9
10
  'getBadgeCount',
10
11
  'getCurrentBranch',
11
12
  'getFeatures',
@@ -64,6 +65,9 @@ const mapSourceControlProvider = (provider) => {
64
65
  if (provider.generateCommitMessage) {
65
66
  registeredProvider.generateCommitMessage = () => provider.generateCommitMessage();
66
67
  }
68
+ if (provider.getDefaultCommitMessage) {
69
+ registeredProvider.getDefaultCommitMessage = (cwd) => provider.getDefaultCommitMessage(cwd);
70
+ }
67
71
  if (provider.getBadgeCount) {
68
72
  registeredProvider.getBadgeCount = () => provider.getBadgeCount();
69
73
  }
@@ -115,6 +119,9 @@ export const executeSourceControlDiscard = async (id, path) => {
115
119
  export const executeSourceControlGenerateCommitMessage = async (id) => {
116
120
  return getProvider(id).generateCommitMessage?.();
117
121
  };
122
+ export const executeSourceControlGetDefaultCommitMessage = async (id, cwd) => {
123
+ return getProvider(id).getDefaultCommitMessage?.(cwd);
124
+ };
118
125
  export const executeSourceControlGetChangedFiles = async (id) => {
119
126
  return getProvider(id).getChangedFiles();
120
127
  };
@@ -186,6 +193,7 @@ const commandMap = {
186
193
  'ExtensionApi.executeSourceControlGetBadgeCount': executeSourceControlGetBadgeCount,
187
194
  'ExtensionApi.executeSourceControlGetChangedFiles': executeSourceControlGetChangedFiles,
188
195
  'ExtensionApi.executeSourceControlGetCurrentBranch': executeSourceControlGetCurrentBranch,
196
+ 'ExtensionApi.executeSourceControlGetDefaultCommitMessage': executeSourceControlGetDefaultCommitMessage,
189
197
  'ExtensionApi.executeSourceControlGetFeatures': executeSourceControlGetFeatures,
190
198
  'ExtensionApi.executeSourceControlGetFileBefore': executeSourceControlGetFileBefore,
191
199
  'ExtensionApi.executeSourceControlGetFileBeforeUri': executeSourceControlGetFileBeforeUri,
@@ -3,6 +3,6 @@ export { registerStatusBarItemProvider } from '../RegisterStatusBarItemProvider/
3
3
  export { resetStatusBarItemProviderRegistry } from '../ResetStatusBarItemProviderRegistry/ResetStatusBarItemProviderRegistry.ts';
4
4
  export type { RegisteredStatusBarItemProvider } from '../RegisteredStatusBarItemProvider/RegisteredStatusBarItemProvider.ts';
5
5
  export type { StatusBarItem } from '../StatusBarItem/StatusBarItem.ts';
6
- export type { StatusBarItemProvider } from '../StatusBarItemProvider/StatusBarItemProvider.ts';
6
+ export type { StatusBarItemContextMenuItem, StatusBarItemProvider } from '../StatusBarItemProvider/StatusBarItemProvider.ts';
7
7
  export type { StatusBarItemProviderHandle } from '../StatusBarItemProviderHandle/StatusBarItemProviderHandle.ts';
8
8
  export type { StatusBarItemProviderRegistrySnapshot } from '../StatusBarItemProviderRegistrySnapshot/StatusBarItemProviderRegistrySnapshot.ts';
@@ -1,5 +1,12 @@
1
1
  import type { StatusBarItem } from '../StatusBarItem/StatusBarItem.ts';
2
+ export interface StatusBarItemContextMenuItem {
3
+ readonly args?: readonly unknown[];
4
+ readonly command: string;
5
+ readonly id: string;
6
+ readonly label: string;
7
+ }
2
8
  export interface StatusBarItemProvider {
9
+ readonly getContextMenuItems?: () => readonly StatusBarItemContextMenuItem[];
3
10
  readonly getStatusBarItem: () => StatusBarItem | undefined;
4
11
  readonly id: string;
5
12
  }
@@ -1,11 +1,16 @@
1
1
  import type { RegisteredStatusBarItemProvider } from '../RegisteredStatusBarItemProvider/RegisteredStatusBarItemProvider.ts';
2
2
  import type { StatusBarItem } from '../StatusBarItem/StatusBarItem.ts';
3
- import type { StatusBarItemProvider } from '../StatusBarItemProvider/StatusBarItemProvider.ts';
3
+ import type { StatusBarItemContextMenuItem, StatusBarItemProvider } from '../StatusBarItemProvider/StatusBarItemProvider.ts';
4
4
  import type { StatusBarItemProviderHandle } from '../StatusBarItemProviderHandle/StatusBarItemProviderHandle.ts';
5
5
  import type { StatusBarItemProviderRegistrySnapshot } from '../StatusBarItemProviderRegistrySnapshot/StatusBarItemProviderRegistrySnapshot.ts';
6
+ type StatusBarItemWithProviderId = StatusBarItem & {
7
+ readonly providerId?: string;
8
+ };
9
+ export declare const getStatusBarItemContextMenuItems: (providerId: string) => readonly StatusBarItemContextMenuItem[];
6
10
  export declare const hasStatusBarItemProvider: (id: string) => boolean;
7
11
  export declare const registerStatusBarItemProvider: (provider: StatusBarItemProvider) => StatusBarItemProviderHandle;
8
12
  export declare const getStatusBarItemProviders: () => RegisteredStatusBarItemProvider[];
9
- export declare const getStatusBarItems: () => readonly StatusBarItem[];
13
+ export declare const getStatusBarItems: () => readonly StatusBarItemWithProviderId[];
10
14
  export declare const getStatusBarItemProviderRegistrySnapshot: () => StatusBarItemProviderRegistrySnapshot;
11
15
  export declare const resetStatusBarItemProviderRegistry: () => void;
16
+ export {};
@@ -4,6 +4,7 @@ import { createProviderRegistry } from "../ProviderRegistry/ProviderRegistry.js"
4
4
  const registry = createProviderRegistry({
5
5
  mapProvider(provider) {
6
6
  return {
7
+ ...(provider.getContextMenuItems && { getContextMenuItems: provider.getContextMenuItems }),
7
8
  getStatusBarItem() {
8
9
  return provider.getStatusBarItem();
9
10
  },
@@ -14,7 +15,16 @@ const registry = createProviderRegistry({
14
15
  requiredMethods: ['getStatusBarItem'],
15
16
  });
16
17
  const getStatusBarItem = (provider) => {
17
- return provider.getStatusBarItem();
18
+ const item = provider.getStatusBarItem();
19
+ if (!item || !provider.getContextMenuItems) {
20
+ return item;
21
+ }
22
+ return { ...item, providerId: provider.id };
23
+ };
24
+ export const getStatusBarItemContextMenuItems = (providerId) => {
25
+ const provider = registry.getProviders().find((candidate) => candidate.id === providerId);
26
+ const items = provider?.getContextMenuItems?.();
27
+ return Array.isArray(items) ? items : [];
18
28
  };
19
29
  const isStatusBarItem = (item) => {
20
30
  return item !== undefined;
@@ -46,6 +56,7 @@ export const getStatusBarItemProviderRegistrySnapshot = () => {
46
56
  };
47
57
  };
48
58
  const commandMap = {
59
+ 'ExtensionApi.getStatusBarItemContextMenuItems': getStatusBarItemContextMenuItems,
49
60
  'ExtensionApi.getStatusBarItems': getStatusBarItems,
50
61
  };
51
62
  export const resetStatusBarItemProviderRegistry = registry.reset;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lvce-editor/api",
3
- "version": "9.33.2",
3
+ "version": "9.35.0",
4
4
  "description": "Tree-shakeable extension API for Lvce Editor extensions.",
5
5
  "keywords": [
6
6
  "lvce-editor",