@compass-framework/plugin 1.3.3 → 1.3.5

package/.eslintrc.js

@@ -0,0 +1,12 @@
+const path = require('path');
+const baseConfig = require("../../.eslintrc.js")
+
+module.exports = {
+    ...baseConfig,
+    "parserOptions": {
+        "warnOnUnsupportedTypeScriptVersion": false,
+        "ecmaVersion": 12,
+        "sourceType": "module",
+        "project": path.resolve(__dirname, "tsconfig.json")
+    }
+}

package/@types/BasePlugin.d.ts

@@ -1,10 +1,10 @@
-import {PluginRuntime} from "./PluginRuntime";
-import {PluginIdentifier} from "./PluginIdentifier";
+import { Environment } from "./PluginRuntime";
+import { PluginIdentifier } from "./PluginIdentifier";
 
 export declare abstract class BasePlugin<Arguments = {}> {
   public abstract onCreated(args: Arguments): Promise<PluginIdentifier>;
 
-  public abstract onMounted(runtime: PluginRuntime): Promise<void>;
+  public abstract onMounted(env: Environment): Promise<void>;
 
   public abstract onRemoved(): void;
 

package/@types/BasePluginManager.d.ts

@@ -1,14 +1,16 @@
-import {BasePlugin} from "./BasePlugin";
-import {PluginRuntime} from "./PluginRuntime";
+import { ViewGroup } from "@compass-framework/core";
+import { PluginSetup } from "./PluginSetup";
+import { BasePlugin } from "./BasePlugin";
+import { Environment } from "./PluginRuntime";
 
-export declare abstract class BasePluginManager<Arguments = {}> {
-  protected constructor();
+export declare abstract class BasePluginManager<Setup extends PluginSetup> {
+  protected constructor(container: ViewGroup);
 
-  public abstract getArguments(): Arguments;
+  public installPlugin(plugin: BasePlugin<Setup>): Promise<void>;
 
-  public installPlugin(plugin: BasePlugin<Arguments>): Promise<void>;
+  public unInstallPlugin(plugin: BasePlugin<Setup>): void;
 
-  public unInstallPlugin(plugin: BasePlugin<Arguments>): void;
+  public abstract getPluginSetup(): Setup;
 
-  public getPluginRuntime(): PluginRuntime;
+  public getEnvironment(): Environment;
 }

package/@types/PluginIdentifier.d.ts

@@ -1,4 +1,4 @@
-import {PluginSpecification} from "./PluginSpecification";
+import { PluginSpecification } from "./PluginSpecification";
 
 export declare class PluginIdentifier<API = void> {
   public readonly groupId: string;

package/@types/PluginRuntime.d.ts

@@ -1,7 +1,7 @@
-import {PluginIdentifier} from "./PluginIdentifier";
-import {PluginPlatform} from "./PluginPlatform";
+import { PluginIdentifier } from "./PluginIdentifier";
+import { PluginPlatform } from "./PluginPlatform";
 
-export interface PluginRuntime {
+export interface Environment {
   exportAPIs<T>(key: PluginIdentifier<T>, apis: T): void;
 
   importAPIs<T>(key: PluginIdentifier<T>): T;

package/@types/PluginSetup.ts

@@ -0,0 +1,7 @@
+import { Context, ViewGroup } from "@compass-framework/core";
+
+export interface PluginSetup {
+  getContext(global?: boolean): Context;
+
+  getContainer(): ViewGroup;
+}

package/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./@types/PluginRuntime";
 export * from "./@types/PluginPlatform";
 export * from "./@types/PluginIdentifier";
+export * from "./@types/PluginSetup";
 export * from "./@types/BasePlugin";
 export * from "./@types/BasePluginManager";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-framework/plugin",
-  "version": "1.3.3",
+  "version": "1.3.5",
   "description": "@compass-framework/plugin public api",
   "types": "./index.d.ts",
   "main": "./index.js",
@@ -10,5 +10,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "dependencies": {}
+  "devDependencies": {
+    "@compass-framework/core": "1.2.48"
+  }
 }

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": [
+    "../../global.d.ts",
+    "@types/"
+  ]
+}