cdeops 12.0.1-alpha.1 → 12.0.3-alpha.2

package/client.d.ts

@@ -2,50 +2,51 @@
 /// <reference path="./src/cdeops.proposed.d.ts"/>
 
 declare module 'cdeops/client' {
-
-	import {
-		OrganizationResource,
-		RelativePattern,
-		GlobPattern,
-		LogLevel,
-		Uri as URI,
-		Unsubscribable,
-		Subscribable,
-		Workspace,
-		ConfigurationTarget,
-		OrganizationConfiguration,
-		configuration,
-		organization
-	} from 'cdeops';
-
-	export {
-		OrganizationResource,
-		RelativePattern,
-		GlobPattern,
-		URI,
-		LogLevel,
-		Unsubscribable,
-		Subscribable,
-		Workspace,
-		ConfigurationTarget,
-		OrganizationConfiguration,
-		configuration,
-		organization,
-	}
-
-	export interface DocumentFilter {
-		/** A language id, such as `typescript` or `*`. */
-		language?: string;
-
-		/** A URI scheme, such as `file` or `untitled`.  */
-		scheme?: string;
-
-		/** A glob pattern, such as `*.{ts,js}`.  */
-		pattern?: string;
-
-		/** A base URI (e.g. root URI of a workspace folder) that the document must be within. */
-		baseUri?: URL | string;
-	}
+    import {
+        OrganizationResource,
+        RelativePattern,
+        GlobPattern,
+        LogLevel,
+        Uri as URI,
+        Unsubscribable,
+        Subscribable,
+        Workspace,
+        ConfigurationTarget,
+        OrganizationConfiguration,
+        configuration,
+        organization,
+        commands,
+    } from 'cdeops';
+
+    export {
+        OrganizationResource,
+        RelativePattern,
+        GlobPattern,
+        URI,
+        LogLevel,
+        Unsubscribable,
+        Subscribable,
+        Workspace,
+        ConfigurationTarget,
+        OrganizationConfiguration,
+        configuration,
+        organization,
+        commands,
+    };
+
+    export interface DocumentFilter {
+        /** A language id, such as `typescript` or `*`. */
+        language?: string;
+
+        /** A URI scheme, such as `file` or `untitled`.  */
+        scheme?: string;
+
+        /** A glob pattern, such as `*.{ts,js}`.  */
+        pattern?: string;
+
+        /** A base URI (e.g. root URI of a workspace folder) that the document must be within. */
+        baseUri?: URL | string;
+    }
 
     /**
      * A document selector is the combination of one or many document filters.
@@ -54,7 +55,7 @@ declare module 'cdeops/client' {
      *
      * @example let sel: DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }];
      */
-	export type DocumentSelector = (string | DocumentFilter)[]
+    export type DocumentSelector = (string | DocumentFilter)[];
 
     /**
      * A document selector is the combination of one or many document filters.
@@ -63,27 +64,27 @@ declare module 'cdeops/client' {
      *
      * @example let sel: DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }];
      */
-	export type DocumentSelector = (string | DocumentFilter)[]
+    export type DocumentSelector = (string | DocumentFilter)[];
 
-	/**
-	* A panel view created by {@link sourcegraph.app.createPanelView}.
-	*/
-	export interface PanelView extends Unsubscribable {
+    /**
+     * A panel view created by {@link sourcegraph.app.createPanelView}.
+     */
+    export interface PanelView extends Unsubscribable {
         /**
          * The title of the panel view.
          */
-		title: string
+        title: string;
 
         /**
          * The content to show in the panel view. Markdown is supported.
          */
-		content: string
+        content: string;
 
         /**
          * The priority of this panel view. A higher value means that the item is shown near the beginning (usually
          * the left side).
          */
-		priority: number
+        priority: number;
 
         /**
          * Display the results of the location provider (with the given ID) in this panel below the
@@ -93,26 +94,26 @@ declare module 'cdeops/client' {
          *
          * @internal
          */
-		component: { locationProvider: string } | null
-	}
+        component: { locationProvider: string } | null;
+    }
 
-	/**
+    /**
      * A style for a {@link TextDocumentDecoration}.
      */
     export interface ThemableDecorationStyle {
         /** The CSS background-color property value for the line. */
-        backgroundColor?: string
+        backgroundColor?: string;
 
         /** The CSS border property value for the line. */
-        border?: string
+        border?: string;
 
         /** The CSS border-color property value for the line. */
-        borderColor?: string
+        borderColor?: string;
 
         /** The CSS border-width property value for the line. */
-        borderWidth?: string
+        borderWidth?: string;
     }
-	/**
+    /**
      * A text document decoration changes the appearance of a range in the document and/or adds other content to
      * it.
      */
@@ -122,200 +123,290 @@ declare module 'cdeops/client' {
          * only applied only on the start line, and the entire line. Multiline
          * and intra-line ranges are not supported.
          */
-        range: Range
+        range: Range;
 
         /**
          * If true, the decoration applies to all lines in the range (inclusive), even if not all characters on the
          * line are included.
          */
-        isWholeLine?: boolean
+        isWholeLine?: boolean;
 
         /** Content to display after the range. */
-        after?: DecorationAttachmentRenderOptions
+        after?: DecorationAttachmentRenderOptions;
 
         /** Overwrite style for light themes. */
-        light?: ThemableDecorationStyle
+        light?: ThemableDecorationStyle;
 
         /** Overwrite style for dark themes. */
-        dark?: ThemableDecorationStyle
+        dark?: ThemableDecorationStyle;
     }
 
-
-	/**
-	 * A style for {@link BadgeAttachmentRenderOptions}.
-	 */
-	export interface ThemableBadgeAttachmentStyle {
+    /**
+     * A style for {@link BadgeAttachmentRenderOptions}.
+     */
+    export interface ThemableBadgeAttachmentStyle {
         /**
          * The icon (a base64-encoded image icon) to display next to the wrapped value.
          *
          * @deprecated Use {@link BadgeAttachmentRenderOptions#kind} to pick a predefined icon
          */
-		icon?: string
+        icon?: string;
 
         /**
          * The CSS background-color property value for the attachment.
          *
          * @deprecated Use {@link BadgeAttachmentRenderOptions#kind} to pick a predefined icon
          */
-		backgroundColor?: string
+        backgroundColor?: string;
 
         /**
          * The CSS color property value for the attachment.
          *
          * @deprecated Use {@link BadgeAttachmentRenderOptions#kind} to pick a predefined icon
          */
-		color?: string
-	}
+        color?: string;
+    }
 
-	/** An attachment adds content to a hover tooltip or result in a locations panel. */
-	export interface BadgeAttachmentRenderOptions extends ThemableBadgeAttachmentStyle {
-		/** Predefined icons for badge attachments */
-		kind: 'info' | 'error' | 'warning'
+    /** An attachment adds content to a hover tooltip or result in a locations panel. */
+    export interface BadgeAttachmentRenderOptions extends ThemableBadgeAttachmentStyle {
+        /** Predefined icons for badge attachments */
+        kind: 'info' | 'error' | 'warning';
 
-		/** Tooltip text to display when hovering over the attachment. */
-		hoverMessage?: string
+        /** Tooltip text to display when hovering over the attachment. */
+        hoverMessage?: string;
 
-		/** If set, the attachment becomes a link with this destination URL. */
-		linkURL?: string
+        /** If set, the attachment becomes a link with this destination URL. */
+        linkURL?: string;
 
         /**
          * Overwrite style for light themes.
          *
          * @deprecated Use {@link BadgeAttachmentRenderOptions#kind} to pick a predefined icon
          */
-		light?: ThemableBadgeAttachmentStyle
+        light?: ThemableBadgeAttachmentStyle;
 
         /**
          * Overwrite style for dark themes.
          *
          * @deprecated Use {@link BadgeAttachmentRenderOptions#kind} to pick a predefined icon
          */
-		dark?: ThemableBadgeAttachmentStyle
-	}
-
-	/**
-	 * A wrapper around a providable type (currently hover and locations) with additional
-	 * context to enable displaying badges next to the wrapped result value in the UI.
-	 */
-	export type Badged<T extends object> = T & {
-		badge?: BadgeAttachmentRenderOptions
-	}
+        dark?: ThemableBadgeAttachmentStyle;
+    }
 
+    /**
+     * A wrapper around a providable type (currently hover and locations) with additional
+     * context to enable displaying badges next to the wrapped result value in the UI.
+     */
+    export type Badged<T extends object> = T & {
+        badge?: BadgeAttachmentRenderOptions;
+    };
 
     /**
      * A hover represents additional information for a symbol or word. Hovers are rendered in a tooltip-like
      * widget.
      */
-	export interface Hover {
+    export interface Hover {
         /**
          * The contents of this hover.
          */
-		contents: MarkupContent
+        contents: MarkupContent;
 
         /**
          * The range to which this hover applies. When missing, the editor will use the range at the current
          * position or the current position itself.
          */
-		range?: Range
+        range?: Range;
 
         /**
          * Alerts that should be shown in this hover.
          */
-		alerts?: Badged<HoverAlert>[]
-	}
+        alerts?: Badged<HoverAlert>[];
+    }
 
-	export interface HoverAlert {
+    export interface HoverAlert {
         /**
          * Text content to be shown on hovers. Since the alert is displayed inline,
          * multiparagraph content will be rendered on one line. It's recommended to
          * provide a brief message here, and place futher details in the badge or
          * provide a link.
          */
-		summary: MarkupContent
+        summary: MarkupContent;
 
         /**
          * When an alert has a dismissal type, dismissing it will prevent all alerts
          * of that type from being shown. If no type is provided, the alert is not
          * dismissible.
          */
-		type?: string
-	}
-
-	export interface ContextValues {
-		[key: string]: string | number | boolean | null
-	}
-
-	/**
-	 * Internal API for Cdeops extensions. ost of those wil be removed for the beta release of Cdeops
-	 * extensions. They are necessary now due to limitations in the extension API and its implementation tha will
-	 * be addressed in the beta release.
-	 * 
-	 * @internal
-	 * @hidden
-	 */
-	export namespace internal {
-		/**
-		 * Returns a promise that resolve when all pending messages have been sent to the client.
-		 * It helps enforce serialization of messages.
-		 * 
-		 * @internal
-		 */
-		export function sync(): Promise<void>;
-
-
-		/**
-		 * Updates context values for use in context expressions and contribution labels.
-		 * 
-		 * @param updates The updates to apply to the context. If a context property's value is null, it is deleted from the
-		 * context.
-		 */
-		export function updateContext(updates: ContextValues): void;
-
-
-		export const cdeopsURL: URI
-
-
-
-		export const clientApplication: 'cdeops' | 'other'
-
-		/**
-		 * Server api
-		 */
-		export const serverApi: any
-
-
-		/**
-		 * gql
-		 */
-		export const gql: any
-	}
-
-	/**
-	 * The extension context is passed to the extension's activate function and contains utilities for
-	 * extension lifecycle.
-	 */
-	export interface ExtensionContext {
-		/**
-		 * An object that maintains subscriptions to resources that should be freed when the extension is
-		 * deactivated.
-		 * 
-		 * When an extension is deactivated, first its exported `deactivate` function is called (if one exists).
-		 * The `deactivate` function may be async, in which case deactivation blocks on it finishing. Next,
-		 * regardless of whether the `deactivate` function finished successfully or rejected with an error, all
-		 * unsubscribables passed to {@link ExtensionContext#subscriptions#add} are unsubscribed from.
-		 * 
-		 * (An extension is deactivated when the user disables it, or after an arbitary time period if
-		 * activationEvents no longer evaluated to true.)
-		 */
-		subscriptions: {
-			/**
-			 * Mark a resource's teardown function to be called when the extension is deactivated.
-			 * 
-			 * @param unsubscribable An {@link Unsubscribable} that frees (unsubscribes from) a resource, or a
-			 * plan function that deos the same. Async functions are not supported. (If deactivation requires
-			 * async operations, make the `deactivate` function async; that is supported.)
-			 */
-			add: (unsubscribe: Unsubscribable | (() => void)) => void;
-		}
-	}
-}
+        type?: string;
+    }
+
+    export interface ContextValues {
+        [key: string]: string | number | boolean | null;
+    }
+
+    /**
+     * Internal API for Cdeops extensions. ost of those wil be removed for the beta release of Cdeops
+     * extensions. They are necessary now due to limitations in the extension API and its implementation tha will
+     * be addressed in the beta release.
+     *
+     * @internal
+     * @hidden
+     */
+    export namespace internal {
+        /**
+         * Returns a promise that resolve when all pending messages have been sent to the client.
+         * It helps enforce serialization of messages.
+         *
+         * @internal
+         */
+        export function sync(): Promise<void>;
+
+        /**
+         * Updates context values for use in context expressions and contribution labels.
+         *
+         * @param updates The updates to apply to the context. If a context property's value is null, it is deleted from the
+         * context.
+         */
+        export function updateContext(updates: ContextValues): void;
+
+        export const cdeopsURL: URI;
+
+        export const clientApplication: 'cdeops' | 'other';
+
+        /**
+         * Server api
+         */
+        export const serverApi: any;
+
+        /**
+         * gql
+         */
+        export const gql: any;
+    }
+
+    /**
+     * The extension context is passed to the extension's activate function and contains utilities for
+     * extension lifecycle.
+     */
+    export interface ExtensionContext {
+        /**
+         * An object that maintains subscriptions to resources that should be freed when the extension is
+         * deactivated.
+         *
+         * When an extension is deactivated, first its exported `deactivate` function is called (if one exists).
+         * The `deactivate` function may be async, in which case deactivation blocks on it finishing. Next,
+         * regardless of whether the `deactivate` function finished successfully or rejected with an error, all
+         * unsubscribables passed to {@link ExtensionContext#subscriptions#add} are unsubscribed from.
+         *
+         * (An extension is deactivated when the user disables it, or after an arbitary time period if
+         * activationEvents no longer evaluated to true.)
+         */
+        subscriptions: {
+            /**
+             * Mark a resource's teardown function to be called when the extension is deactivated.
+             *
+             * @param unsubscribable An {@link Unsubscribable} that frees (unsubscribes from) a resource, or a
+             * plan function that deos the same. Async functions are not supported. (If deactivation requires
+             * async operations, make the `deactivate` function async; that is supported.)
+             */
+            add: (unsubscribe: Unsubscribable | (() => void)) => void;
+        };
+    }
+
+    /**
+     * Namespace for dealing with commands. In short, a command is a function with a
+     * unique identifier. The function is sometimes also called _command handler_.
+     *
+     * Commands can be added to the editor using the [registerCommand](#commands.registerCommand)
+     * and [registerTextEditorCommand](#commands.registerTextEditorCommand) functions. Commands
+     * can be executed [manually](#commands.executeCommand) or from a UI gesture. Those are:
+     *
+     * * palette - Use the `commands`-section in `package.json` to make a command show in
+     * the [command palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette).
+     * * keybinding - Use the `keybindings`-section in `package.json` to enable
+     * [keybindings](https://code.visualstudio.com/docs/getstarted/keybindings#_customizing-shortcuts)
+     * for your extension.
+     *
+     * Commands from other extensions and from the editor itself are accessible to an extension. However,
+     * when invoking an editor command not all argument types are supported.
+     *
+     * This is a sample that registers a command handler and adds an entry for that command to the palette. First
+     * register a command handler with the identifier `extension.sayHello`.
+     * ```javascript
+     * commands.registerCommand('extension.sayHello', () => {
+     * 	window.showInformationMessage('Hello World!');
+     * });
+     * ```
+     * Second, bind the command identifier to a title under which it will show in the palette (`package.json`).
+     * ```json
+     * {
+     * 	"contributes": {
+     * 		"commands": [{
+     * 			"command": "extension.sayHello",
+     * 			"title": "Hello World"
+     * 		}]
+     * 	}
+     * }
+     * ```
+     */
+    export namespace commands {
+        /**
+         * Registers a command that can be invoked via a keyboard shortcut,
+         * a menu item, an action, or directly.
+         *
+         * Registering a command with an existing command identifier twice
+         * will cause an error.
+         *
+         * @param command A unique identifier for the command.
+         * @param callback A command handler function.
+         * @param thisArg The `this` context used when invoking the handler function.
+         * @return Disposable which unregisters this command on disposal.
+         */
+        export function registerCommand(command: string, callback: (...args: any[]) => any, thisArg?: any): Disposable;
+
+        /**
+         * Registers a text editor command that can be invoked via a keyboard shortcut,
+         * a menu item, an action, or directly.
+         *
+         * Text editor commands are different from ordinary [commands](#commands.registerCommand) as
+         * they only execute when there is an active editor when the command is called. Also, the
+         * command handler of an editor command has access to the active editor and to an
+         * [edit](#TextEditorEdit)-builder.
+         *
+         * @param command A unique identifier for the command.
+         * @param callback A command handler function with access to an [editor](#TextEditor) and an [edit](#TextEditorEdit).
+         * @param thisArg The `this` context used when invoking the handler function.
+         * @return Disposable which unregisters this command on disposal.
+         */
+        export function registerTextEditorCommand(
+            command: string,
+            callback: (textEditor: TextEditor, edit: TextEditorEdit, ...args: any[]) => void,
+            thisArg?: any,
+        ): Disposable;
+
+        /**
+         * Executes the command denoted by the given command identifier.
+         *
+         * * *Note 1:* When executing an editor command not all types are allowed to
+         * be passed as arguments. Allowed are the primitive types `string`, `boolean`,
+         * `number`, `undefined`, and `null`, as well as [`Position`](#Position), [`Range`](#Range), [`Uri`](#Uri) and [`Location`](#Location).
+         * * *Note 2:* There are no restrictions when executing commands that have been contributed
+         * by extensions.
+         *
+         * @param command Identifier of the command to execute.
+         * @param rest Parameters passed to the command function.
+         * @return A promise that resolves to the returned value of the given command. `undefined` when
+         * the command handler function doesn't return anything.
+         */
+        export function executeCommand<T>(command: string, ...rest: any[]): Promise<T | undefined>;
+
+        /**
+         * Retrieve the list of all available commands. Commands starting an underscore are
+         * treated as internal commands.
+         *
+         * @param filterInternal Set `true` to not see internal commands (starting with an underscore)
+         * @return Promise that resolves to a list of command ids.
+         */
+        export function getCommands(filterInternal?: boolean): Promise<string[]>;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "cdeops",
-    "version": "12.0.1-alpha.1",
+    "version": "12.0.3-alpha.2",
     "description": "Cdecode - Extension API: build extensions that enhance coding experience in your cdeops editor",
     "license": "Apache-2.0",
     "author": "CDMBase LLC",
@@ -29,5 +29,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "70866b054ad2857a72d4c4057a5be5f77b21ffea"
+    "gitHead": "f936332230e8f3ac10462881efe0f6a477501425"
 }