@compass-framework/plugin 1.0.1 → 1.0.3

package/@types/Environment.d.ts

@@ -0,0 +1,13 @@
+import {Context} from "@compass-framework/core";
+import {Platform} from "./Platform";
+import {Identifier} from "./Identifier";
+
+export declare interface Environment {
+  exportAPIs(apis: object): void;
+
+  importAPIs<T>(key: Identifier<T>): T;
+
+  getContext(): Context;
+
+  getPlatform(): Platform;
+}

package/@types/Identifier.d.ts

@@ -0,0 +1,11 @@
+export declare class Identifier<API = void> {
+  groupId: string;
+  name: string;
+  artifactId: string;
+
+  public constructor({groupId, name, artifactId,}: {
+    groupId: string
+    name: string
+    artifactId: string
+  });
+}

package/@types/Platform.d.ts

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

package/@types/Plugin.d.ts

@@ -0,0 +1,10 @@
+import {Environment} from "./Environment";
+import {Identifier} from "./Identifier";
+
+export declare abstract class Plugin {
+  public abstract onInstall<T>(env: Environment): void;
+
+  public abstract onUninstall(): void;
+
+  public abstract getIdentifier(): Identifier;
+}

package/@types/PluginManager.d.ts

@@ -0,0 +1,10 @@
+import {Context} from "@compass-framework/core";
+import {Plugin} from "./Plugin";
+
+export declare class PluginManager {
+  public constructor(context: Context, property: object);
+
+  public install(plugin: Plugin): void;
+
+  public uninstall(plugin: Plugin): void;
+}

package/index.d.ts

@@ -1,7 +1,5 @@
 export * from "./@types/Environment";
-export * from "./@types/EnvironmentProperty";
-export * from "./@types/Service";
-export * from "./@types/Feature";
+export * from "./@types/Platform";
+export * from "./@types/Identifier";
 export * from "./@types/Plugin";
 export * from "./@types/PluginManager";
-export * from "./@types/PluginMainfest";

package/package.json

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

package/@types/Environment.ts

@@ -1,11 +0,0 @@
-import { Context } from "@compass-framework/core";
-import { EnvironmentProperty } from "./EnvironmentProperty";
-import { Installer } from "./Installer";
-import { ServiceDependency } from "./ServiceDependency";
-
-export interface Environment<T = EnvironmentProperty> {
-  installer: Installer
-  property: T,
-  context: Context;
-  dependency: ServiceDependency;
-}

package/@types/EnvironmentProperty.ts

@@ -1,3 +0,0 @@
-export interface EnvironmentProperty {
-
-}

package/@types/Feature.ts

@@ -1,3 +0,0 @@
-export interface Feature {
-
-}

package/@types/Installer.ts

@@ -1,7 +0,0 @@
-import { Plugin } from "./Plugin";
-
-export declare class Installer {
-  public usePlugin(plugin: Plugin): void;
-
-  public unUsePlugin(plugin: Plugin): void;
-}

package/@types/Plugin.ts

@@ -1,33 +0,0 @@
-import {
-  Consumer,
-} from "@compass-framework/library";
-
-import { Environment } from "./Environment";
-import { Service } from "./Service";
-import { PluginMainfest } from "./PluginMainfest";
-
-export declare class Plugin<Feature = {}> {
-  protected constructor(mainfest: PluginMainfest);
-
-  public onInstall(environment: Environment, service: Consumer<Feature>): Promise<void>;
-
-  public isUsingGlobalContext(): boolean;
-
-  public onUninstall(): void;
-
-  public getPluginName(): string;
-
-  public getService<T>(index: number): Service<T>;
-
-  public getEnvironment<T>(): Environment<T>;
-
-  public getGroupId(): string;
-
-  public getVersion(): string;
-
-  public getArtifactId(): string;
-
-  public getDependence(): PluginMainfest.Dependence[];
-
-  public setUsingGlobalContext(using: boolean): void;
-}

package/@types/PluginMainfest.ts

@@ -1,17 +0,0 @@
-export type PluginMainfest = {
-  name: string,
-  artifactId: string,
-  version: string,
-  groupId: string,
-  dependencies?: PluginMainfest.Dependence[]
-};
-
-export namespace PluginMainfest {
-  export type Dependence = {
-    name?: string,
-    required?: boolean,
-    version: string,
-    groupId: string,
-    artifactId: string,
-  };
-}

package/@types/PluginManager.ts

@@ -1,18 +0,0 @@
-import { Context } from "@compass-framework/core";
-import { Plugin } from "./Plugin";
-import { EnvironmentProperty } from "./EnvironmentProperty";
-
-export declare class PluginManager {
-  public constructor(context: Context, options: PluginManager.Options);
-
-  public usePlugin(plugin: Plugin): Promise<void>;
-
-  public unUsePlugin(plugin: Plugin): void;
-}
-
-export declare namespace PluginManager {
-  export interface Options {
-    repository: string;
-    property: EnvironmentProperty,
-  }
-}

package/@types/Service.ts

@@ -1,11 +0,0 @@
-import { Feature } from "./Feature";
-
-export declare class Service<T = Feature> {
-  public getFeatures(): T;
-
-  public getGroupId(): string;
-
-  public getVersion(): string;
-
-  public getArtifactId(): string;
-}

package/@types/ServiceDependency.ts

@@ -1,5 +0,0 @@
-import { Service } from "./Service";
-
-export declare class ServiceDependency {
-  public getService<T>(groupId: string, artifactId: string): Service<T>;
-}