@adminide-stack/extension-api 0.0.2-alpha.0

package/lib/interfaces/ext-services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/ext-services/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,iDAA+B;AAC/B,qDAAmC;AACnC,iDAA+B;AAC/B,kDAAgC;AAChC,mDAAiC;AACjC,yDAAuC;AACvC,wDAAsC"}

package/lib/interfaces/ext-services/model-service.d.ts

@@ -0,0 +1,89 @@
+import { TextDocument } from 'cdeops';
+import { Subscribable, Observable } from 'rxjs';
+/**
+ * A text model is a text document and associated metadata.
+ *
+ * How does this relate to editors (in {@link ViewerService}? A model is the file, an editor is the
+ * window that the file is shown in. Things like the content and language are properties of the
+ * model; things like decorations and the selection ranges are properties of the editor.
+ */
+export interface TextModel extends Pick<TextDocument, 'uri' | 'languageId' | 'text'> {
+}
+/**
+ * A partial {@link TextModel}, containing only the fields that are
+ * guaranteed to never be updated.
+ */
+export interface PartialModel extends Pick<TextModel, 'languageId'> {
+}
+export declare type TextModelUpdate = ({
+    type: 'added';
+} & TextModel) | ({
+    type: 'updated';
+    text: string;
+} & Pick<TextModel, 'uri'>) | ({
+    type: 'deleted';
+} & Pick<TextModel, 'uri'>);
+/**
+ * The model service manages document contents and metadata.
+ *
+ * See {@link Model} for an explanation of the difference between a model and an editor.
+ */
+export interface IModelService {
+    /**
+     * A map of all known models, indexed by URI.
+     *
+     * This is mostly used for testing, most consumers should use
+     * {@link ModelService#modelUpdates}, {@link ModelService#activeLanguages} or {@link ModelService#observeModel} instead.
+     */
+    models: ReadonlyMap<string, TextModel>;
+    /**
+     * An observable of all model updates.
+     *
+     * Emits when a model is added, updated or removed.
+     */
+    modelUpdates: Subscribable<readonly TextModelUpdate[]>;
+    /**
+     * An observable of unique languageIds across all models.
+     */
+    activeLanguages: Subscribable<ReadonlySet<string>>;
+    /**
+     * Observe a model for changes.
+     *
+     * @param uri The uri of the model to observe.
+     * @returns An observable that emits when the model changes,
+     * and completes when the model is removed.
+     * If no such model exists, it emits an error.
+     */
+    observeModel(uri: string): Observable<TextModel>;
+    /**
+     * Returns the {@link PartialModel} for the given uri.
+     *
+     */
+    getPartialModel(uri: string): PartialModel;
+    /**
+     * Adds a model.
+     *
+     * @param model The model to add.
+     */
+    addModel(model: TextModel): void;
+    /**
+     * Updates a model's text content.
+     *
+     * @param uri The URI of the model whose content to update.
+     * @param text The new text content (which will overwrite the model's previous content).
+     * @throws if the model does not exist.
+     */
+    updateModel(uri: string, text: string): void;
+    /**
+     * Reports whether a model with a given URI has already been added.
+     *
+     * @param uri The model URI to check.
+     */
+    hasModel(uri: string): boolean;
+    /**
+     * Removes a model.
+     *
+     * @param uri The URI of the model to remove.
+     */
+    removeModel(uri: string): void;
+}

package/lib/interfaces/ext-services/model-service.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=model-service.js.map

package/lib/interfaces/ext-services/model-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-service.js","sourceRoot":"","sources":["../../../src/interfaces/ext-services/model-service.ts"],"names":[],"mappings":""}

package/lib/interfaces/ext-services/panel-view-registry.d.ts

@@ -0,0 +1,21 @@
+import { Observable, Subscription } from 'rxjs';
+import { ContributableViewContainer, PanelViewWithComponent } from '../../interfaces';
+/** A registry entry for a registered provider. */
+export interface Entry<O, P> {
+    registrationOptions: O;
+    provider: P;
+}
+export interface PanelViewProviderRegistrationOptions {
+    id: string;
+    container: typeof ContributableViewContainer;
+}
+export declare type ProvidePanelViewSignature = Observable<PanelViewWithComponent | null>;
+/** @sri custom change */
+export interface IPanelViewProviderRegistry {
+    readonly providers: Observable<ProvidePanelViewSignature[]>;
+    registerProvider(registrationOptions: PanelViewProviderRegistrationOptions, provider: ProvidePanelViewSignature): Subscription;
+    registerProviders(entries: Entry<PanelViewProviderRegistrationOptions, ProvidePanelViewSignature>[]): Subscription;
+    deregisterProvider(deregistrationOptions: PanelViewProviderRegistrationOptions): Subscription;
+    getPanelView(id: string): Observable<(PanelViewWithComponent & PanelViewProviderRegistrationOptions) | null>;
+    getPanelViews(container: typeof ContributableViewContainer): Observable<(PanelViewWithComponent & PanelViewProviderRegistrationOptions)[]>;
+}

package/lib/interfaces/ext-services/panel-view-registry.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=panel-view-registry.js.map

package/lib/interfaces/ext-services/panel-view-registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"panel-view-registry.js","sourceRoot":"","sources":["../../../src/interfaces/ext-services/panel-view-registry.ts"],"names":[],"mappings":""}

package/lib/interfaces/ext-services/settings-service.d.ts

@@ -0,0 +1,18 @@
+import { Subscribable } from 'rxjs';
+import { IGeneratedSettings as ISettings, ISettingsEdit } from '@workbench-stack/core';
+import { SettingsCascadeOrError } from '../settings';
+/**
+ * The configuration service manages the settings cascade for the viewer.
+ *
+ * @template S The settings type.
+ */
+export interface ISettingsService<S extends ISettings = ISettings> {
+    /**
+     * The configuration data
+     */
+    data: Subscribable<SettingsCascadeOrError<S>>;
+    /**
+     * Update the configuration with highest precedence.
+     */
+    update(edit: ISettingsEdit): Promise<void>;
+}

package/lib/interfaces/ext-services/settings-service.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=settings-service.js.map

package/lib/interfaces/ext-services/settings-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings-service.js","sourceRoot":"","sources":["../../../src/interfaces/ext-services/settings-service.ts"],"names":[],"mappings":""}

package/lib/interfaces/ext-services/view-service.d.ts

@@ -0,0 +1,65 @@
+import { IContributableViewContainer, ContributableViewContainer } from '../contributions';
+import * as cdeops from 'cdeops/client';
+import { Observable, Subscription } from 'rxjs';
+import * as React from 'react';
+import * as modes from '@vscode-alt/monaco-editor/esm/vs/editor/common/modes';
+import { View as ExtensionView } from 'cdeops';
+export interface ViewProviderRegistrationOptions {
+    id: string;
+    container: IContributableViewContainer;
+}
+export interface PanelViewWithComponent extends Pick<cdeops.PanelView, 'title' | 'content' | 'priority'> {
+    /**
+     * The location provider whose results to render in the panel view.
+     */
+    locationProvider?: Observable<modes.Location[] | null>;
+    /**
+     * The React element to render in the panel view.
+     */
+    reactElement?: React.ReactFragment;
+}
+export declare type ProvideViewSignature = Observable<PanelViewWithComponent | null>;
+/**
+ * A view is a page or partial page.
+ */
+export interface IView extends ExtensionView {
+}
+export interface IViewProviderEntry<W extends IContributableViewContainer> {
+    /** The ID of the view. */
+    id: string;
+    /** The view container the view was registered for. */
+    where: W;
+    /** Provides the view content. */
+    provideView: ViewProviderFunction<IViewContexts[W]>;
+}
+/**
+ * A map from type of container names to the internal type of the context parameter provided by the container.
+ */
+export interface IViewContexts {
+    [ContributableViewContainer.Panel]: never;
+    [ContributableViewContainer.Homepage]: {};
+    [ContributableViewContainer.InsightsPage]: {};
+    [ContributableViewContainer.GlobalPage]: Record<string, string>;
+    [ContributableViewContainer.Directory]: {};
+}
+export declare type ViewProviderFunction<C> = (context: C) => Observable<IView | null>;
+/**
+ * The view service manages views, which are pages or partial pages of content.
+ */
+export interface IViewService {
+    /**
+     * REgister a view provider. Throws if the `id` is already registerd.
+     */
+    register<W extends IContributableViewContainer>(id: string, where: W, provideView: ViewProviderFunction<IViewContexts[W]>): Subscription;
+    /**
+     * Get all providers for the given container.
+     *
+     * @todo return a Map by ID and make this the primary API
+     */
+    getWhere<W extends IContributableViewContainer>(where: W): Observable<IViewProviderEntry<W>[]>;
+    /**
+     * Get a view's content. The retured observable emits whenever the content changes. IF there is
+     * no view with the given {@link id}, it emits `null`.
+     */
+    get<W extends IContributableViewContainer>(id: string, context: IViewContexts[W]): Observable<IView | null>;
+}

package/lib/interfaces/ext-services/view-service.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const contributions_1 = require("../contributions");
+//# sourceMappingURL=view-service.js.map

package/lib/interfaces/ext-services/view-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view-service.js","sourceRoot":"","sources":["../../../src/interfaces/ext-services/view-service.ts"],"names":[],"mappings":";;AAAA,oDAA2F"}

package/lib/interfaces/ext-services/viewer-service.d.ts

@@ -0,0 +1,125 @@
+import { Subscribable, Observable } from 'rxjs';
+import { PartialModel, TextModel } from './model-service';
+import { Selection } from '../plainTypes';
+export declare type Viewer = CodeEditor | DirectoryViewer;
+export declare type ViewerData = CodeEditorData | DirectoryViewerData;
+/**
+ * ViewerId exposes the unique ID of a viewer.
+ */
+export interface ViewerId {
+    /** The unique ID of the viewer. */
+    readonly viewerId: string;
+}
+export interface BaseViewerData {
+    readonly isActive: boolean;
+}
+export interface DirectoryViewerData extends BaseViewerData {
+    readonly type: 'DirectoryViewer';
+    /** The URI of the directory that this viewer is displaying. */
+    readonly resource: string;
+}
+/**
+ * Describes a code viewer to be created.
+ */
+export interface CodeEditorData extends BaseViewerData {
+    readonly type: 'CodeEditor';
+    /** The URI of the model that this viewer is displaying. */
+    readonly resource: string;
+    readonly selections: Selection[];
+}
+/**
+ * Describes a code editor that has been added to the {@link ViewerServce}.
+ */
+export interface CodeEditor extends ViewerId, CodeEditorData {
+}
+/**
+ * Describes a directory viewer that has been added to the {@link IViewerService}.
+ */
+export interface DirectoryViewer extends ViewerId, DirectoryViewerData {
+}
+export declare type ViewerWithPartialModel = CodeEditorWithPartialModel | DirectoryViewer;
+/**
+ * A code editor witha a partial model.
+ *
+ * To get the editor's full model, look up the model in the {@link ModelService}.
+ */
+export interface CodeEditorWithPartialModel extends CodeEditor {
+    model: PartialModel;
+}
+/**
+ * A code editor with its full model, including the model text.
+ */
+export interface CodeEditorWithModel extends CodeEditor {
+    /** The code editor's model. */
+    model: TextModel;
+}
+export declare type ViewerUpdate = ({
+    type: 'added';
+    viewerData: ViewerData;
+} & ViewerId) | ({
+    type: 'updated';
+    viewerData: Pick<CodeEditorData, 'selections'>;
+} & ViewerId) | ({
+    type: 'deleted';
+} & ViewerId);
+/**
+ * The viewer service manages viewers.
+ */
+export interface IViewerService {
+    /**
+     * A map of all known viewers, indexed by viewerId.
+     *
+     * This is mostly used for testing, most consumers should use
+     * {@link IViewerService#viewerUpdates} or {@link IViewerService#activeViewerUpdates}
+     */
+    readonly viewers: ReadonlyMap<string, Viewer>;
+    /**
+     * An observable of all viewer updates.
+     *
+     * Emits when a viewer is added, updated or removed.
+     */
+    readonly viewerUpdates: Subscribable<ViewerUpdate[]>;
+    /**
+     * An observable of updates to the active viewer.
+     *
+     * Emits the active viewer if there is one or `undefined` otherwise.
+     */
+    readonly activeViewerUpdates: Subscribable<Viewer | undefined>;
+    /**
+     * Add a viewer.
+     *
+     * @param viewer The description of the viewer to add.
+     * @returns The added code viewer (which must be passed as the first argument to other
+     * {@link ViwerService} methods to operate on this viewer).
+     */
+    addViewer(viewer: ViewerData): ViewerId;
+    /**
+     * Observe a viewer for changes.
+     *
+     * @param viewer The viewer to observe.
+     * @returns An observable that emits when the viewer changes
+     * and complets when the viewer is removed.
+     * If no such viewer exists, it emits an error.
+     */
+    observeViewer(viewer: ViewerId): Observable<ViewerData>;
+    /**
+     * Sets the selections for a CodeEditor.
+     *
+     * @param codeEditor The editor for which to set the selections.
+     * @param selections The new selections to apply.
+     * @throws If no editor exists with the given editor ID.
+     * @throws If the editor ID is not a CodeEditor.
+     */
+    setSelections(codeEditor: ViewerId, selections: Selection[]): void;
+    /**
+     * Remove a viewer.
+     * Also removes the corresponding model if no other viewer is referencing it.
+     *
+     * @param viewer The viewer to remove.
+     */
+    removeViewer(viewer: ViewerId): void;
+    /**
+     * Remove all viewers.
+     */
+    removeAllViewers(): void;
+}

package/lib/interfaces/ext-services/viewer-service.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+;
+;
+//# sourceMappingURL=viewer-service.js.map

package/lib/interfaces/ext-services/viewer-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewer-service.js","sourceRoot":"","sources":["../../../src/interfaces/ext-services/viewer-service.ts"],"names":[],"mappings":";;AAyCgE,CAAC;AAKS,CAAC"}

package/lib/interfaces/extension-manifest.d.ts

@@ -0,0 +1,8 @@
+import { IExtensionManifest as IExtensionManifestSchema } from './generated-models';
+/**
+ * Represents an input object that is validated against a subset of properties of the {@link IExtensionManifest}
+ * JSON Schema. For simplicity, only necessary fields are validated and included here.
+ */
+export interface IPartialExtensionManifest extends Pick<IExtensionManifestSchema, 'name' | 'url' | 'bundleURL' | 'description' | 'displayName' | 'activationEvents' | 'contributes' | 'repository' | 'publisher' | 'categories' | 'icon' | 'tags'> {
+    contributes: any;
+}

package/lib/interfaces/extension-manifest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=extension-manifest.js.map

package/lib/interfaces/extension-manifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extension-manifest.js","sourceRoot":"","sources":["../../src/interfaces/extension-manifest.ts"],"names":[],"mappings":""}

package/lib/interfaces/extension.d.ts

@@ -0,0 +1,72 @@
+import { ErrorLike } from './errors';
+import { IPartialExtensionManifest as IExtensionManifest } from './extension-manifest';
+import { IRegistryExtension } from './generated-models';
+import { Unsubscribable } from 'rxjs';
+/**
+ * The information about an IExtension necessary to execute and activate it.
+ */
+export interface IExecutableExtension extends Pick<IConfiguredExtension, 'id' | 'manifest'> {
+    /** The URL to the JavaScript bundle fo the extension */
+    scriptURL: string;
+}
+/**
+ * The manifest of an extension sideloaded during local development.
+ *
+ * Doesn't include {@link ExtensionManifest#url}, as this is added when
+ * publishing an extension to the registry.
+ * Instead, the bundle URL is computed from the manifest's `main` field.
+ */
+export interface ISideloadedExtensionManifest extends Omit<IExtensionManifest, 'url'> {
+    name: string;
+    main: string;
+}
+/**
+ * Describes a configured IExtension.
+ */
+export interface IConfiguredExtension {
+    /**
+     * The IExtension's IExtension ID.
+     *
+     * @example "alcie/myextension"
+     */
+    readonly id: string;
+    /** The parsed IExtension mainfest, null if there is none, or a parse error. */
+    readonly manifest: IExtensionManifest | null | ErrorLike;
+    /** The raw IExtension mainfest (JSON), or null if there is none. */
+    readonly rawManifest: string | null;
+}
+/**
+ * Describes a configured IExtension with an optional associated registry IExtension. Prefer using
+ * {@link IConfiguredExtension} when it is not necessary to access the registry IExtension's metadata.
+ *
+ * @template X the registry IExtension type.
+ */
+export interface IConfiguredRegistryExtension<X extends Pick<IRegistryExtension, 'id' | 'url' | 'viewerCanAdminister'> = Pick<IRegistryExtension, 'id' | 'url' | 'viewerCanAdminister'>> extends IConfiguredExtension {
+    /** The IExtension's metadata on the registry, if this is a registry IExtension. */
+    readonly registryExtension?: X;
+}
+/** An IExtension's identifier. */
+export interface IExtension {
+    /** The IExtension ID. */
+    readonly id: string;
+}
+export interface IExtensionHostClient extends Unsubscribable {
+    /**
+     * Closes the connection to the IExtension host and stops the controller from reestablishing new
+     * connections.
+     */
+    unsubscribe(): void;
+}
+/**
+ * An activated extension.
+ */
+export interface IActivatedExtension {
+    /**
+     * The extension's extension ID (which uniquely identifies it among all activated extensions).
+     */
+    id: string;
+    /**
+     * Deactivate the extension (by calling its "deactivate" function, if any).
+     */
+    deactivate(): void | Promise<void>;
+}

package/lib/interfaces/extension.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=extension.js.map

package/lib/interfaces/extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extension.js","sourceRoot":"","sources":["../../src/interfaces/extension.ts"],"names":[],"mappings":""}