cdeops 0.0.2-alpha.0

package/LICENSE

@@ -0,0 +1,39 @@
+The CDEBase Enterprise license (the “Enterprise License”)
+Copyright (c) 2018 cdebase LLC.
+
+With regard to the CDEBase Software:
+
+This software and associated documentation files (the "Software") may only be
+used in production, if you (and any entity that you represent) have agreed to,
+and are in compliance with, the CDEBase Terms of Service, available
+at https://about.cdebase.com/terms (the “Enterprise Terms”), or other
+agreement governing the use of the Software, as agreed by you and CDEBase,
+and otherwise have a valid CDEBase Enterprise subscription for the
+correct number of user seats. Subject to the foregoing sentence, you are free to
+modify this Software and publish patches to the Software. You agree that CDEBase
+and/or its licensors (as applicable) retain all right, title and interest in and
+to all such modifications and/or patches, and all such modifications and/or
+patches may only be used, copied, modified, displayed, distributed, or otherwise
+exploited with a valid CDEBase Enterprise subscription for the correct
+number of user seats. Notwithstanding the foregoing, you may copy and modify
+the Software for development and testing purposes, without requiring a
+subscription. You agree that CDEBase and/or its licensors (as applicable) retain
+all right, title and interest in and to all such modifications. You are not
+granted any other rights beyond what is expressly stated herein. Subject to the
+foregoing, it is forbidden to copy, merge, publish, distribute, sublicense,
+and/or sell the Software.
+
+The full text of this Enterprise License shall be included in all copies or
+substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+For all third party components incorporated into the CDEBase Software, those
+components are licensed under the original license provided by the owner of the
+applicable component.

package/README.md

@@ -0,0 +1,9 @@
+
+
+## To run tests
+
+    `npm link`
+    `npm link @xtermstack/xterm-core`
+    `npm install`
+    `tsc`
+    `npm run test`

package/client.d.ts

@@ -0,0 +1,321 @@
+/// <reference path="./src/cdeops.d.ts"/>
+/// <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;
+	}
+
+    /**
+     * A document selector is the combination of one or many document filters.
+     * A document matches the selector if any of the given filters matches.
+     * If the filter is a string and not a {@link DocumentFilter}, it will be treated as a language id.
+     *
+     * @example let sel: DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }];
+     */
+	export type DocumentSelector = (string | DocumentFilter)[]
+
+    /**
+     * A document selector is the combination of one or many document filters.
+     * A document matches the selector if any of the given filters matches.
+     * If the filter is a string and not a {@link DocumentFilter}, it will be treated as a language id.
+     *
+     * @example let sel: DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }];
+     */
+	export type DocumentSelector = (string | DocumentFilter)[]
+
+	/**
+	* A panel view created by {@link sourcegraph.app.createPanelView}.
+	*/
+	export interface PanelView extends Unsubscribable {
+        /**
+         * The title of the panel view.
+         */
+		title: string
+
+        /**
+         * The content to show in the panel view. Markdown is supported.
+         */
+		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
+
+        /**
+         * Display the results of the location provider (with the given ID) in this panel below the
+         * {@link PanelView#contents}.
+         *
+         * Experimental. Subject to change or removal without notice.
+         *
+         * @internal
+         */
+		component: { locationProvider: string } | null
+	}
+
+	/**
+     * A style for a {@link TextDocumentDecoration}.
+     */
+    export interface ThemableDecorationStyle {
+        /** The CSS background-color property value for the line. */
+        backgroundColor?: string
+
+        /** The CSS border property value for the line. */
+        border?: string
+
+        /** The CSS border-color property value for the line. */
+        borderColor?: string
+
+        /** The CSS border-width property value for the line. */
+        borderWidth?: string
+    }
+	/**
+     * A text document decoration changes the appearance of a range in the document and/or adds other content to
+     * it.
+     */
+    export interface TextDocumentDecoration extends ThemableDecorationStyle {
+        /**
+         * The range that the decoration applies to. Currently, decorations are
+         * only applied only on the start line, and the entire line. Multiline
+         * and intra-line ranges are not supported.
+         */
+        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
+
+        /** Content to display after the range. */
+        after?: DecorationAttachmentRenderOptions
+
+        /** Overwrite style for light themes. */
+        light?: ThemableDecorationStyle
+
+        /** Overwrite style for dark themes. */
+        dark?: ThemableDecorationStyle
+    }
+
+
+	/**
+	 * 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
+
+        /**
+         * The CSS background-color property value for the attachment.
+         *
+         * @deprecated Use {@link BadgeAttachmentRenderOptions#kind} to pick a predefined icon
+         */
+		backgroundColor?: string
+
+        /**
+         * The CSS color property value for the attachment.
+         *
+         * @deprecated Use {@link BadgeAttachmentRenderOptions#kind} to pick a predefined icon
+         */
+		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'
+
+		/** Tooltip text to display when hovering over the attachment. */
+		hoverMessage?: 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
+
+        /**
+         * 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
+	}
+
+
+    /**
+     * A hover represents additional information for a symbol or word. Hovers are rendered in a tooltip-like
+     * widget.
+     */
+	export interface Hover {
+        /**
+         * The contents of this hover.
+         */
+		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
+
+        /**
+         * Alerts that should be shown in this hover.
+         */
+		alerts?: Badged<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
+
+        /**
+         * 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;
+		}
+	}
+}

package/client.js

@@ -0,0 +1,9 @@
+// This is the module that is bundled with extensions when they use `import ... from 'cdeops/client'` or
+// `require('cdeops/client')`. It delegates to the extension host's runtime implementation of this module by calling
+// `global.require` (which ensures that the extension host's `require` is called at runtime).
+//
+// This dummy file is used when extension is bundled with a JavaScript bundler that lacks support for externals
+// (or when `cdeops/client` is not configured as an external module). Parcel does not support extenals
+// (https://github.com/parcel-bundler/parcel/issues/144). Webpack, Rollup, and Microbundle support externals.
+
+module.exports = global.require('cdeops/client')

package/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "cdeops",
+    "version": "0.0.2-alpha.0",
+    "description": "Cdecode - Extension API: build extensions that enhance coding experience in your cdeops editor",
+    "license": "Apache-2.0",
+    "author": "CDMBase LLC",
+    "sideEffects": false,
+    "main": "src/index.js",
+    "module": "src/index.js",
+    "types": "./src/cdeops.d.ts",
+    "files": [
+        "server.d.ts",
+        "server.js",
+        "client.d.ts",
+        "client.js",
+        "src",
+        "dist/docs"
+    ],
+    "scripts": {
+        "build": "npm run build:clean && npm run build:lib",
+        "build:clean": "rimraf lib",
+        "build:lib": "webpack",
+        "build:lib:watch": "npm run build:lib -- --watch",
+        "docs": "typedoc",
+        "prepublishOnly": "npm run tslint && npm run docs",
+        "tslint": "tslint -c tslint.json -p tsconfig.json './src/**/*.{ts,js}'",
+        "watch": "npm run build:lib:watch"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "gitHead": "adc8a3c248d8d214e66489f332f758759fcdb7a5"
+}

package/server.d.ts

@@ -0,0 +1,5 @@
+/// <reference path="./src/cdeops.d.ts"/>
+/// <reference path="./src/cdeops.proposed.d.ts"/>
+
+import * as cdeops from 'cdeops';
+export = cdeops;

package/server.js

@@ -0,0 +1,9 @@
+// This is the module that is bundled with extensions when they use `import ... from 'cdeops/server'` or
+// `require('cdeops/server')`. It delegates to the extension host's runtime implementation of this module by calling
+// `global.require` (which ensures that the extension host's `require` is called at runtime).
+//
+// This dummy file is used when extension is bundled with a JavaScript bundler that lacks support for externals
+// (or when `cdeops/server` is not configured as an external module). Parcel does not support extenals
+// (https://github.com/parcel-bundler/parcel/issues/144). Webpack, Rollup, and Microbundle support externals.
+
+module.exports = require('cdeops/server')