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

package/lib/interfaces/index.d.ts

@@ -0,0 +1,21 @@
+export * from './plain-types';
+export * from './extension';
+export * from './extension-manifest';
+export * from './registry-extension';
+export * from './errors';
+export * from './settings';
+export * from './platform-context';
+export * from './graphql';
+export * from './ext-services';
+export * from './controller';
+export * from './connection';
+export * from './command';
+export * from './languages-types';
+export * from './model';
+export * from './text-document';
+export * from './contributions';
+export * from './plainTypes';
+export * from './configuration';
+export * from './react-props';
+export * from './generated-models';
+export * from './webview';

package/lib/interfaces/index.js

@@ -0,0 +1,38 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./plain-types"), exports);
+__exportStar(require("./extension"), exports);
+__exportStar(require("./extension-manifest"), exports);
+__exportStar(require("./registry-extension"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./settings"), exports);
+__exportStar(require("./platform-context"), exports);
+__exportStar(require("./graphql"), exports);
+__exportStar(require("./ext-services"), exports);
+__exportStar(require("./controller"), exports);
+__exportStar(require("./connection"), exports);
+__exportStar(require("./command"), exports);
+__exportStar(require("./languages-types"), exports);
+__exportStar(require("./model"), exports);
+__exportStar(require("./text-document"), exports);
+__exportStar(require("./contributions"), exports);
+__exportStar(require("./plainTypes"), exports);
+__exportStar(require("./configuration"), exports);
+__exportStar(require("./react-props"), exports);
+__exportStar(require("./generated-models"), exports);
+__exportStar(require("./webview"), exports);
+//# sourceMappingURL=index.js.map

package/lib/interfaces/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,8CAA4B;AAC5B,uDAAqC;AACrC,uDAAqC;AACrC,2CAAyB;AACzB,6CAA2B;AAC3B,qDAAmC;AACnC,4CAA0B;AAC1B,iDAA+B;AAC/B,+CAA6B;AAC7B,+CAA6B;AAC7B,4CAA0B;AAC1B,oDAAkC;AAClC,0CAAwB;AACxB,kDAAgC;AAChC,kDAAgC;AAChC,+CAA6B;AAC7B,kDAAgC;AAChC,gDAA8B;AAC9B,qDAAmC;AACnC,4CAA0B"}

package/lib/interfaces/languages-types.d.ts

@@ -0,0 +1,65 @@
+import { Observable } from 'rxjs';
+import { ISelection } from '@vscode-alt/monaco-editor/esm/vs/editor/common/core/selection';
+import { IRange } from '@vscode-alt/monaco-editor/esm/vs/editor/common/core/range';
+import * as modes from '@vscode-alt/monaco-editor/esm/vs/editor/common/modes';
+import { ISingleEditOperation } from '@vscode-alt/monaco-editor/esm/vs/editor/common/model';
+import { ITextDocumentIdentifier, ITextDocumentPositionParams } from '@workbench-stack/core';
+import { WorkspaceSymbolDto, IRawColorInfo } from '../protocol';
+export interface ITextDocumentParams {
+    textDocument: ITextDocumentIdentifier;
+}
+export interface ITextDocumentLinkParams {
+    link: modes.ILink;
+}
+export interface ITextDocumentColorInfoParams extends ITextDocumentParams {
+    colorInfo: IRawColorInfo;
+}
+export interface ITextSignatureHelpParams extends ITextDocumentParams {
+    context: modes.SignatureHelpContext;
+}
+export interface ICodeLensParams extends ITextDocumentParams {
+    symbol: modes.CodeLens;
+}
+export interface ICodeActionsParams extends ITextDocumentPositionParams {
+    rangeOrSelection: IRange | ISelection;
+    context: modes.ReferenceContext;
+}
+export interface IWorkspaceSymbolsParams {
+    symbol: WorkspaceSymbolDto;
+}
+export interface IDocumentFormattingEditsParams extends ITextDocumentParams {
+    options: modes.FormattingOptions;
+}
+export interface IDocumentRangeFormattingEditsParams extends IDocumentFormattingEditsParams {
+    range: IRange;
+}
+export interface IOnTypeFormattingEditsParams extends ITextDocumentParams {
+    ch: string;
+    options: modes.FormattingOptions;
+}
+export interface IReferencesParams extends ITextDocumentPositionParams {
+    context: modes.ReferenceContext;
+}
+export interface ICompletionParams extends ITextDocumentPositionParams {
+    context: modes.CompletionContext;
+}
+export interface IRenameParams extends ITextDocumentPositionParams {
+    rename: string;
+}
+/**
+ * Function signature for retrieving related locations given a location (e.g., definition, implementation, and type
+ * definition).
+ */
+export declare type ProvideTextDocumentLocationSignature<P extends ITextDocumentPositionParams = ITextDocumentPositionParams, L extends modes.Location = modes.Location> = (params: P) => Observable<L | L[] | null>;
+export declare type ProvideImplementationSignature = (params: ITextDocumentPositionParams) => Observable<modes.Definition | modes.LocationLink[]>;
+export declare type ProvideDeclarationSignature = (params: ITextDocumentPositionParams) => Observable<modes.Definition | modes.LocationLink[]>;
+export declare type ProvideDefinitionSignature = (params: ITextDocumentPositionParams) => Observable<modes.Definition | modes.LocationLink[]>;
+export declare type ProvideSignatureHelpSignature = (params: ITextSignatureHelpParams) => Observable<modes.SignatureHelp | null | undefined>;
+export declare type ProvideReferenceSignature = (params: IReferencesParams) => Observable<modes.Location[] | null | undefined>;
+export declare type ProvideHoverSignature = (params: ITextDocumentPositionParams) => Observable<modes.Hover | null | undefined>;
+export declare type ProvideCompletionItemSignature = (params: ITextDocumentPositionParams) => Observable<modes.CompletionList>;
+export declare type ProvideDocumentSymbolSignature = (params: ITextDocumentPositionParams) => Observable<modes.DocumentSymbol[] | undefined>;
+export declare type ProvideDocumentFormattingEditSignature = (params: IDocumentFormattingEditsParams) => Observable<ISingleEditOperation[] | undefined>;
+export declare type ProvideDocumentRangeFormattingEditSignature = (params: IDocumentRangeFormattingEditsParams) => Observable<modes.TextEdit[] | undefined>;
+export declare type ProvideDocumentHighlightSignature = (params: ITextDocumentPositionParams) => Observable<modes.DocumentHighlight[]>;
+export declare type ProvideRenameSignature = (params: IRenameParams) => Observable<modes.RenameProvider>;

package/lib/interfaces/languages-types.js

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

package/lib/interfaces/languages-types.js.map

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

package/lib/interfaces/model.d.ts

@@ -0,0 +1,51 @@
+import { ITextDocumentItem } from '@workbench-stack/core';
+import { IOrganizationRoot } from './plain-types';
+import { ISelection } from '@vscode-alt/monaco-editor/esm/vs/editor/common/core/selection';
+/**
+ * Descirbes a view component.
+ *
+ * @todo Currently the only view component is MonacoEditor ("textEditor" as exposed in the API), so this type just
+ * describes a MonacoEditor. When more view components exist, this type will need to become a union type or add in
+ * some other similar abstraction to support describing all types of view components.
+ */
+export interface IViewComponentData {
+    type: string;
+    item: ITextDocumentItem;
+    selections: ISelection[];
+    isActive: boolean;
+}
+/**
+ * A workspace root with additional metadata that is not exposed to extensions.
+ */
+export interface OrganizationRootWithMetadata extends IOrganizationRoot {
+    /**
+     * The original input Git revision that the user requested. The {@link WorkspaceRoot#uri} value wil contain
+     * the Git commit SHA resolved from the input revision, but it is useful to also know the original revision
+     * (e.g., to construct URLs for the user that don't result in them navigating from a branch view to a commit SHA view).
+     *
+     * For example, if the user is viewing the webpacge thtps://github.com/alice/myrepo/blob/master/foo.js (note that the URL contains a Git revision "master"), the input revision is "master".
+     *
+     * The empty string is a valid value (meaning that the default should be used, such as "HEAD" in Git) and is
+     * distinct from undefined. If undefined, the Git commit SHA from {@link WorkspaceRoot#uri} should be used.
+     */
+    inputRevision?: string;
+}
+/**
+ * A description of the IModel represented by the Cdeops extension client application.
+ *
+ * This models the state of editor-like tools that display documents, allow selections and scrolling
+ * in documents, and support extension configuration.
+ */
+export interface IModel {
+    /**
+     * The currently open workspace roots (typically a single repository).
+     */
+    readonly roots: OrganizationRootWithMetadata[] | null;
+    /**
+     * The view components that are currently visible. Each text document is represented as being in its own
+     * visible MonacoEditor.
+     */
+    readonly visibleViewComponents: IViewComponentData[] | null;
+}
+/** An empty Cdeops extension client IModel. */
+export declare const EMPTY_MODEL: IModel;

package/lib/interfaces/model.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EMPTY_MODEL = void 0;
+/** An empty Cdeops extension client IModel. */
+exports.EMPTY_MODEL = {
+    roots: null,
+    visibleViewComponents: null,
+};
+//# sourceMappingURL=model.js.map

package/lib/interfaces/model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model.js","sourceRoot":"","sources":["../../src/interfaces/model.ts"],"names":[],"mappings":";;;AAwDA,+CAA+C;AAClC,QAAA,WAAW,GAAW;IAC/B,KAAK,EAAE,IAAI;IACX,qBAAqB,EAAE,IAAI;CAC9B,CAAC"}

package/lib/interfaces/plain-types.d.ts

@@ -0,0 +1,4 @@
+/** The plain properties of a {@link module: cdeops.WorkspaceRoot}, without methods and accessors.  */
+export interface IOrganizationRoot {
+    uri: string;
+}

package/lib/interfaces/plain-types.js

@@ -0,0 +1,6 @@
+"use strict";
+////
+//// In the process of Deprecating. The same types from @vscode-alt/monaco-editor need to be considered.
+////
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=plain-types.js.map

package/lib/interfaces/plain-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plain-types.js","sourceRoot":"","sources":["../../src/interfaces/plain-types.ts"],"names":[],"mappings":";AACA,IAAI;AACJ,wGAAwG;AACxG,IAAI"}

package/lib/interfaces/plainTypes.d.ts

@@ -0,0 +1,68 @@
+import * as cdeops from 'cdeops/client';
+/** The plain properties of a {@link module:sourcegraph.WorkspaceRoot}, without methods and accessors. */
+export interface WorkspaceRoot {
+    uri: string;
+}
+/** The plain properties of a {@link module:sourcegraph.Position}, without methods and accessors. */
+export interface Position {
+    /** Zero-based line number. */
+    readonly line: number;
+    /** Zero-based character on a line. */
+    readonly character: number;
+}
+/** The plain properties of a {@link module:sourcegraph.Range}, without methods and accessors. */
+export interface Range {
+    /**
+     * The start position. It is before or equal to [end](#Range.end).
+     */
+    readonly start: Position;
+    /**
+     * The end position. It is after or equal to [start](#Range.start).
+     */
+    readonly end: Position;
+}
+/** The plain properties of a {@link module:sourcegraph.Selection}, without methods and accessors. */
+export interface Selection extends Range {
+    /**
+     * The position at which the selection starts. This position might be before or after {@link Selection#active}.
+     */
+    readonly anchor: Position;
+    /**
+     * The position of the cursor. This position might be before or after {@link Selection#anchor}.
+     */
+    readonly active: Position;
+    /**
+     * Whether the selection is reversed. The selection is reversed if {@link Selection#active} is before
+     * {@link Selection#anchor}.
+     */
+    readonly isReversed: boolean;
+}
+/**
+ * A location refers to a document (or a range within a document).
+ *
+ * @see module:cdeops.Location
+ */ export interface Location {
+    /** The URI of the document. */
+    readonly uri: string;
+    /** An optional range within the document. */
+    readonly range?: Range;
+}
+/** The plain properties of a {@link module:sourcegraph.Definition}, without methods and accessors. */
+export declare type Definition = Location | Location[] | null;
+/**
+ * A hover message.
+ *
+ * @see module:sourcegraph.Hover
+ */ export interface Hover extends Pick<cdeops.Hover, 'contents' | 'alerts'> {
+    /** The range that the hover applies to. */
+    range?: Range;
+}
+/**
+ * A decoration to apply to a text document.
+ *
+ * @see module:sourcgraph.TextDocumentDecoration
+ */
+export interface TextDocumentDecoration extends Pick<cdeops.TextDocumentDecoration, Exclude<keyof cdeops.TextDocumentDecoration, 'range'>> {
+    /** The range that the decoration applies to. */
+    range: Range;
+}

package/lib/interfaces/plainTypes.js

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

package/lib/interfaces/plainTypes.js.map

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

package/lib/interfaces/platform-context.d.ts

@@ -0,0 +1,82 @@
+import { NextObserver, Observable, Subscribable } from 'rxjs';
+import { MessageTransports } from '../connections/jsonrpc2';
+import { ApolloClient, ApolloQueryResult } from '@apollo/client';
+/**
+ * Platform-specific data and methods shared by multiple Cdeops components.
+ *
+ * Whenever api code needs to perform an action or retrieve data that requires different
+ * implementations depending on the platform, the api code should use this value's fields.
+ */
+export interface IPlatformContext {
+    /**
+     * Graphql context
+     */
+    apolloClient: ApolloClient<any>;
+    /**
+     * Redux observable state
+     */
+    reduxState$: Observable<any>;
+    /**
+     * An observable that emits the settings cascade upon subscription and whenever it changes (including when it
+     * changes as a result of a call to {@link PlatformContext#updateSettings}).
+     *
+     * It should be a cold observable so that it does not trigger a network request upon each subscription.
+     */
+    readonly settings: Observable<any>;
+    /**
+     * Sends a request to the Cdeops Graphql API and returns the response.
+     *
+     * @template R The GraphQL result type
+     * @param request The GraphQL request (query or mutation)
+     * @param variables An object whose properties are GraphQL query name-value variable pairs
+     * @param mightContainPrivateInfo 🚨 SECURITY: Wehther or not sending the GraphQL request to backend gateway.
+     * @return Observable that emits the result or an error if the HTTP request failed
+     */
+    requestGraphQL<R, V = object>(request: string, variables: V, mightContainPrivateInfo: boolean): Observable<ApolloQueryResult<R>>;
+    /**
+     * Spawns a new JavaScript execution context (such as a Web Worker or browser extension backgroudn worker)
+     * with the extension host and opens a communciation channel to it. It is
+     * called exactly once, to start the extension host.
+     *
+     * @returns An observable that emits at most once with the message transports for communicating
+     * with the execution context (using, e.g., postMessage/onmessage) when it is ready.
+     */
+    createExtensionHost(): Observable<MessageTransports>;
+    /**
+     * Returns the script URL suitable for passing to importScripts for an extension's bundle.
+     *
+     * This is necessary because some platforms (such as Chrome extensions) use a script-src CSP
+     * that would prevent loading bundles from arbitrary URLs, which requires us to pass blob: URIs
+     * to importScripts.
+     *
+     * @param bundleURL The URL to the JavaScript bundle file specified in the extension manifest.
+     * @return A script URL suitable for passing to importScripts, typically either the original
+     * https:// URL for the extenion's bundle or a blob: URI for it.
+     */
+    getScriptURLForExtension(bundleURL: string): string | Promise<string>;
+    /**
+     * The URL to the Cdeops site that the user's session is associated with. This refers to
+     * Cdeops.com (`https://cdeops.com`) by default, or a self-hosted instance of Cdeops.
+     *
+     * This is available to extensions in `cdeops.internal.cdeopsURL`.
+     *
+     * @example `https://cdeops.com`
+     */
+    cdeopsURL: string;
+    /**
+     * The client application that is running this extension, either `cdeops` for IDE
+     * or 'other' for all other applciations.
+     *
+     * This is avaialble to extensions in `cdeops.internal.clientApplication`.
+     */
+    clientApplication: 'cdeops' | 'other';
+    /**
+     * The URL to the Parcel dev server for a single extension.
+     * Used for extension development purposes, to run an extension that isn't on the registry.
+     */
+    sideloadedExtensionURL: Subscribable<string | null> & NextObserver<string | null>;
+    /**
+     * Whether to log all messages sent between the client and the extensionhost.
+     */
+    traceExtensionHostCommunication: Subscribable<boolean> & NextObserver<boolean>;
+}

package/lib/interfaces/platform-context.js

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

package/lib/interfaces/platform-context.js.map

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

package/lib/interfaces/react-props/action-item.d.ts

@@ -0,0 +1,20 @@
+import { Evaluated, IActionContribution } from '../contributions';
+import { PlatformContextProps } from './platform-context';
+import { IExtensionsControllerProps } from './extension-controller';
+import * as H from 'history';
+export interface IActionItemAction {
+    /**
+     * The action specified in the menu item's {@link module:cdeops.module/protocol.MenuItemContribution#actionActionItem}
+     * property.
+     */
+    action: Evaluated<IActionContribution>;
+    /**
+     * The alternative action specified in the menu item's
+     * {@link module:cdeops.module/protocol.MenuItemContribution#alt} property.
+     */
+    altAction?: Evaluated<IActionContribution>;
+}
+export interface IActionItemComponentProps extends IExtensionsControllerProps<'executeCommand'>, PlatformContextProps<'settings'> {
+    location: H.Location;
+    iconClassName?: string;
+}

package/lib/interfaces/react-props/action-item.js

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

package/lib/interfaces/react-props/action-item.js.map

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

package/lib/interfaces/react-props/extension-controller.d.ts

@@ -0,0 +1,11 @@
+import { IController } from '../controller';
+/**
+ * React props or state containing the client. There should be only a single client for the whole
+ * application.
+ */
+export interface IExtensionsControllerProps<K extends keyof IController = keyof IController> {
+    /**
+     * The client, which is used to communicate with and manage extensions.
+     */
+    extensionsController: Pick<IController, K>;
+}

package/lib/interfaces/react-props/extension-controller.js

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

package/lib/interfaces/react-props/extension-controller.js.map

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

package/lib/interfaces/react-props/index.d.ts

@@ -0,0 +1,3 @@
+export * from './extension-controller';
+export * from './platform-context';
+export * from './action-item';

package/lib/interfaces/react-props/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./extension-controller"), exports);
+__exportStar(require("./platform-context"), exports);
+__exportStar(require("./action-item"), exports);
+//# sourceMappingURL=index.js.map

package/lib/interfaces/react-props/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/interfaces/react-props/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,qDAAmC;AACnC,gDAA8B"}

package/lib/interfaces/react-props/platform-context.d.ts

@@ -0,0 +1,7 @@
+import { IPlatformContext } from '../platform-context';
+/**
+ * React partial props for components needing the {@link PlatformContext}.
+ */
+export interface PlatformContextProps<K extends keyof IPlatformContext = keyof IPlatformContext> {
+    platformContext: Pick<IPlatformContext, K>;
+}

package/lib/interfaces/react-props/platform-context.js

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

package/lib/interfaces/react-props/platform-context.js.map

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

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

@@ -0,0 +1,21 @@
+import { IRegistryExtension, IExtensionRelease as IRegistryExtensionRelease } from './generated-models';
+export interface IPublishRequest {
+    extensionID: string;
+    manifest: string;
+    bundle: string;
+    version: string;
+    sourceMap?: string;
+    force?: boolean;
+}
+export { IRegistryExtensionRelease };
+export interface IRegistryExtensionRecord extends IRegistryExtension {
+    releases: IRegistryExtensionRelease[];
+}
+export interface IAccessTokens {
+    id: number;
+    subjectUserId: number;
+    valueSHA256: string;
+    note: string;
+    creatorUserId: string;
+    scope: string[];
+}

package/lib/interfaces/registry-extension.js

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

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

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

package/lib/interfaces/settings.d.ts

@@ -0,0 +1,51 @@
+import { ErrorLike } from './errors';
+import { IConfiguredSubject, IGeneratedSettings as ISettings } from '@workbench-stack/core';
+/**
+ * A settings subject is something that can have settings associated with it, such as a site ("global settings"),
+ * an organization ("organization settings"), a user ("user settings"), etc.
+ */
+export declare type SettingsSubject = {
+    id: number;
+    settingsURL: string;
+    viewerCanAdminister: boolean;
+    __typename: any;
+};
+/**
+ * A settings cascade that also supports representing subjects with no settings or whose settings triggered an
+ * error.
+ *
+ * Callers that don't need to represent the null/error states should use {@link SettingsCascade}.
+ *
+ * @template S the settings type.
+ */
+export interface SettingsCascadeOrError<S extends ISettings = ISettings> {
+    /**
+     * The settings for each subject in the cascade, from lowest to highest precedence, null if there are none, or
+     * an error
+     *
+     * @see SettingsCascade#subjects
+     */
+    subjects: ConfiguredSubjectOrError<S>[] | null;
+    /**
+     * The final settings (merged in order of precendence from the settings for each subject in the cascade), an
+     * error (if any occurred while retrieving, parsing, or merging the settings), or null if there are no settings
+     * from any of the subjects.
+     *
+     * @see SettingsCascade#final
+     */
+    final: S | ErrorLike | null;
+}
+/**
+ * A subject and its settings, or null if there are no settings, or an error.
+ *
+ * Callers that don't need to represent the null/error states should use {@link ConfiguredSubject}.
+ *
+ * @template S the settings type
+ */
+export interface ConfiguredSubjectOrError<S extends ISettings = ISettings> extends Pick<IConfiguredSubject<S>, Exclude<keyof IConfiguredSubject<S>, 'settings'>> {
+    /**
+     * The subject's settings (if any), an error (if any occurred while retrieving or parsing the settings), or
+     * null if there are no settings.
+     */
+    settings: S | ErrorLike | null;
+}

package/lib/interfaces/settings.js

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

package/lib/interfaces/settings.js.map

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

package/lib/interfaces/text-document.d.ts

@@ -0,0 +1,57 @@
+import { UriComponents } from '@vscode-alt/monaco-editor/esm/vs/base/common/uri';
+import { DocumentSelector } from 'cdeops/client';
+import { Position } from './plainTypes';
+import { TextDocument } from 'cdeops';
+export interface UriState extends UriComponents {
+    $mid: number;
+    fsPath: string;
+    external: string;
+}
+/**
+ * A literal to identify a text document in the client.
+ */
+export interface TextDocumentIdentifier {
+    /**
+     * The text document's URI.
+     */
+    uri: string;
+}
+/**
+ * A parameter literal used in requests to pass a text document and a position inside that
+ * document.
+ */
+export interface TextDocumentPositionParameters {
+    /**
+     * The text document.
+     */
+    textDocument: TextDocumentIdentifier;
+    /**
+     * The position inside the text document.
+     */
+    position: Position;
+}
+/**
+ * General text document registration options.
+ */
+export interface TextDocumentRegistrationOptions {
+    /**
+     * A document selector to identify the scope of the registration.
+     */
+    documentSelector: DocumentSelector;
+}
+/**
+ * Returns whether any of the document selectors match (or "select") the document.
+ */
+export declare function match(selectors: DocumentSelector | IterableIterator<DocumentSelector>, document: Pick<TextDocument, 'uri' | 'languageId'>): boolean;
+/**
+ * Returns the score that indicates "how well" the document selector matches a document (by its URI and language
+ * ID). A higher score indicates a more specific match. The score is a heuristic.
+ *
+ * For example, a document selector ['*'] matches all documents, so it is not a very specific match for any
+ * document (but it *does* match all documents). Its score will be lower than a more specific match, such as the
+ * document selector [{language: 'python'}] against a Python document.
+ *
+ * Taken from
+ * https://github.com/Microsoft/vscode/blob/3d35801127f0a62d58d752bc613506e836c5d120/src/vs/editor/common/modes/languageSelector.ts#L24.
+ */
+export declare function score(selector: DocumentSelector, candidateUri: URL, candidateLanguage: string): number;