@eclipse-che/plugin - npm Package Compare versions

Comparing version 0.0.1-1544617370 to 0.0.1-1545397371

package.json

 {
   "name": "@eclipse-che/plugin",
-  "version": "0.0.1-1544617370",
+  "version": "0.0.1-1545397371",
   "description": "Eclipse Che specific Theia plugin API",
@@ -5,0 +5,0 @@ "publishConfig": {

src/che-proposed.d.ts

@@ -31,3 +31,3 @@ /*********************************************************************
     export namespace factory {
-        export function getFactoryById(id: string): PromiseLike<Factory | undefined>;
+        export function getById(id: string): PromiseLike<Factory>;
     }
@@ -162,40 +162,133 @@
 
+    export interface Factory {
+        /** Identifier of this factory instance, it is mandatory and unique. */
+        id?: string;
+
+        /** Version of this factory instance, it is mandatory. */
+        v: string;
+
+        /** Name of this factory instance, the name is unique for creator. */
+        name: string;
+
+        /** Creator of this factory instance. */
+        creator: Author;
+
+        /** Workspace configuration of this factory instance, it is mandatory for every factory. */
+        workspace: WorkspaceConfig;
+
+        /** Restrictions of this factory instance. */
+        policies: Policies;
+
+        /** Factory button for this instance. */
+        button: FactoryButton;
+
+        /** IDE for this factory instance. */
+        ide: Ide;
+
+        /** Hyperlinks. */
+        links?: { [attrName: string]: string };
+    }
+
     /**
-     * Defines the contract for the factory instance.
+     * Defines the contract for the factory creator instance.
      */
-    export interface Factory {
-        getProjects(): FactoryProject[];
-        /**
-         * Actions that should be triggered when all projects have been imported.
-         */
-        getOnProjectsImportedActions(): FactoryAction[];
-        /**
-         * Actions that should be triggered when the IDE is loaded.
-         */
-        getOnAppLoadedActions(): FactoryAction[];
-        /**
-         * Actions that should be triggered when the IDE is closed.
-         */
-        getOnAppClosedActions(): FactoryAction[];
+    export interface Author {
+        /** Identifier of the user who created factory, it is mandatory */
+        userId: string;
+
+        /** Creation time of factory, set by the server (in milliseconds, from Unix epoch, no timezone) */
+        created: number;
     }
 
-    export interface FactoryProject {
-        getPath(): string;
-        getLocationURI(): string | undefined;
-        getCheckoutBranch(): string | undefined;
+    /**
+     * Defines the contract for the factory restrictions.
+     */
+    export interface Policies {
+
+        /** Restrict access if referer header doesn't match this field */
+        referer: string;
+
+        /** Restrict access for factories used earlier then author supposes */
+        since: number;
+
+        /** Restrict access for factories used later then author supposes */
+        until: number;
+
+        /** Workspace creation strategy */
+        create: string;
     }
 
-    export interface FactoryAction {
-        getId(): string;
-        getProperties(): FactoryActionProperties | undefined;
+    export type FactoryButtonType = 'logo' | 'nologo';
+
+    /**
+     * Defines factory button.
+     */
+    export interface FactoryButton {
+
+        /** Type of this button instance */
+        type: FactoryButtonType;
+
+        /** Attributes of this button instance */
+        attributes: FactoryButtonAttributes;
     }
 
-    export interface FactoryActionProperties {
-        name?: string,
-        file?: string,
-        greetingTitle?: string,
-        greetingContentUrl?: string
+    /**
+     * Defines factory button attributes.
+     */
+    export interface FactoryButtonAttributes {
+
+        /** Factory button color */
+        color: string;
+
+        /** Factory button counter */
+        counter: boolean;
+
+        /** Factory button logo */
+        logo: string;
+
+        /** Factory button style */
+        style: string;
     }
 
     /**
+     * Defines the contract for the factory IDE instance.
+     */
+    export interface Ide {
+
+        /** Returns configuration of IDE on application loaded event */
+        onAppLoaded?: {
+            actions?: FactoryAction[]
+        };
+
+        /** Returns configuration of IDE on application closed event */
+        onAppClosed?: {
+            actions?: FactoryAction[]
+        };
+
+        /** Returns configuration of IDE on projects loaded event */
+        onProjectsLoaded?: {
+            actions?: FactoryAction[]
+        };
+
+    }
+
+    /**
+     * Defines the contract for the factory action instance.
+     */
+    export interface FactoryAction {
+
+        /** IDE specific identifier of action e.g. ('openFile', 'editFile') */
+        id: string,
+
+        /** Properties of this action instance */
+        properties?: {
+            name?: string,
+            file?: string,
+            greetingTitle?: string,
+            greetingContentUrl?: string
+        }
+
+    }
+
+    /**
      * Namespace for variables substitution functionality.
@@ -246,2 +339,3 @@ */
     }
+
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11221

increased by25.16%

Lines of code

281

increased by28.9%

No dependency changes