@compass-framework/plugin 1.3.2 → 1.3.4

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,5 +1,5 @@
-import {BasePlugin} from "./BasePlugin";
-import {PluginRuntime} from "./PluginRuntime";
+import { BasePlugin } from "./BasePlugin";
+import { Environment } from "./PluginRuntime";
 
 export declare abstract class BasePluginManager<Arguments = {}> {
   protected constructor();
@@ -10,5 +10,5 @@ export declare abstract class BasePluginManager<Arguments = {}> {
 
   public unInstallPlugin(plugin: BasePlugin<Arguments>): void;
 
-  public getPluginRuntime(): PluginRuntime;
+  public getEnvironment(): Environment;
 }

package/@types/PluginIdentifier.d.ts

@@ -1,9 +1,15 @@
-import {PluginSpecification} from "./PluginSpecification";
+import { PluginSpecification } from "./PluginSpecification";
 
 export declare class PluginIdentifier<API = void> {
-  groupId: string;
-  name: string;
-  artifactId: string;
+  public readonly groupId: string;
+  public readonly name: string;
+  public readonly artifactId: string;
 
   public constructor(spec: PluginSpecification);
+
+  public for(prefix: string): string;
+
+  public hashcode(): number;
+
+  public equals(other: PluginIdentifier<API>): boolean;
 }

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-framework/plugin",
-  "version": "1.3.2",
+  "version": "1.3.4",
   "description": "@compass-framework/plugin public api",
   "types": "./index.d.ts",
   "main": "./index.js",

package/tsconfig.json

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