@compass-framework/plugin 1.2.5 → 1.2.7

package/@types/BasePlugin.d.ts

@@ -0,0 +1,12 @@
+import {PluginRuntime} from "./PluginRuntime";
+import {PluginIdentifier} from "./PluginIdentifier";
+
+export declare abstract class BasePlugin<Property, Arguments> {
+  public abstract onCreated(args: Arguments): PluginIdentifier;
+
+  public abstract onMounted(env: PluginRuntime<Property>): void;
+
+  public abstract onRemoved(): void;
+
+  public abstract getIdentifier(): PluginIdentifier;
+}

package/@types/BasePluginManager.d.ts

@@ -0,0 +1,11 @@
+import {BasePlugin} from "./BasePlugin";
+
+export declare abstract class BasePluginManager<Property, Arguments> {
+  protected constructor(args: Arguments);
+
+  public abstract getPluginProperty(): Property;
+
+  public installPlugin(plugin: BasePlugin<Property, Arguments>): void;
+
+  public unInstallPlugin(plugin: BasePlugin<Property, Arguments>): void;
+}

package/@types/PluginIdentifier.d.ts

@@ -0,0 +1,9 @@
+import {PluginSpecification} from "./PluginSpecification";
+
+export declare class PluginIdentifier<API = void> {
+  groupId: string;
+  name: string;
+  artifactId: string;
+
+  public constructor(spec: PluginSpecification);
+}

package/@types/PluginPlatform.d.ts

@@ -0,0 +1,4 @@
+export enum PluginPlatform {
+  Web,
+  Nodejs,
+}

package/@types/PluginRuntime.d.ts

@@ -0,0 +1,12 @@
+import {PluginIdentifier} from "./PluginIdentifier";
+import {PluginPlatform} from "./PluginPlatform";
+
+export interface PluginRuntime<Property> {
+  exportAPIs(apis: object): void;
+
+  importAPIs<T>(key: PluginIdentifier<T>): T;
+
+  getProperty(): Property;
+
+  getPlatform(): PluginPlatform;
+}

package/@types/{Specification.ts → PluginSpecification.ts}

@@ -1,4 +1,4 @@
-export interface Specification {
+export interface PluginSpecification {
   groupId: string;
   name: string;
   artifactId: string;

package/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./@types/Environment";
-export * from "./@types/Platform";
-export * from "./@types/Identifier";
-export * from "./@types/Plugin";
-export * from "./@types/PluginManager";
+export * from "./@types/PluginRuntime";
+export * from "./@types/PluginPlatform";
+export * from "./@types/PluginIdentifier";
+export * from "./@types/BasePlugin";
+export * from "./@types/BasePluginManager";

package/package.json

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

package/@types/Environment.d.ts

@@ -1,12 +0,0 @@
-import {Identifier} from "./Identifier";
-import {Platform} from "./Platform";
-
-export interface Environment<Property> {
-  exportAPIs(apis: object): void;
-
-  importAPIs<T>(key: Identifier<T>): T;
-
-  getProperty(): Property;
-
-  getPlatform(): Platform;
-}

package/@types/Identifier.d.ts

@@ -1,9 +0,0 @@
-import {Specification} from "./Specification";
-
-export declare class Identifier<API = null> {
-  groupId: string;
-  name: string;
-  artifactId: string;
-
-  public constructor(spec: Specification);
-}

package/@types/Platform.d.ts

@@ -1,4 +0,0 @@
-export enum Platform {
-  Web,
-  Nodejs,
-}

package/@types/Plugin.d.ts

@@ -1,12 +0,0 @@
-import {Environment} from "./Environment";
-import {Identifier} from "./Identifier";
-
-export declare abstract class Plugin<Property, Arguments> {
-  public abstract onCreated(args: Arguments): Identifier;
-
-  public abstract onMounted(env: Environment<Property>): void;
-
-  public abstract onRemoved(): void;
-
-  public abstract getIdentifier(): Identifier;
-}

package/@types/PluginManager.d.ts

@@ -1,9 +0,0 @@
-import {Plugin} from "./Plugin";
-
-export declare class PluginManager<Property, Arguments> {
-  public constructor(property: Property, args: Arguments);
-
-  public usePlugin(plugin: Plugin<Property, Arguments>): void;
-
-  public unUsePlugin(plugin: Plugin<Property, Arguments>): void;
-}