@compass-framework/plugin 1.0.0

package/.eslintignore

@@ -0,0 +1,10 @@
+wasmer/output
+esbuild
+build
+wasm
+
+.eslintrc.js
+jest.*.js
+
+package.json
+tsconfig.json

package/.eslintrc.js

@@ -0,0 +1,76 @@
+const path = require('path');
+
+const resolve = (url) => path.resolve(__dirname, url);
+
+module.exports = {
+    "extends": [
+        'airbnb-base',
+        'airbnb-typescript/base'
+    ],
+    "env": {
+        "browser": true,
+        "es2021": true
+    },
+    "plugins": [
+        "unused-imports"
+    ],
+    "rules": {
+        "unused-imports/no-unused-imports": "error",
+
+        "@typescript-eslint/no-redeclare": "off",
+        "default-case-last": "off",
+        "no-return-assign": "off",
+        "operator-assignment": "off",
+        "no-fallthrough": "off",
+        "no-constant-condition": "off",
+        "function-call-argument-newline":"off",
+        "no-else-return" : "off",
+        "no-cond-assign": "off",
+        "prefer-regex-literals": "off",
+        "@typescript-eslint/no-empty-function": "off",
+        "no-restricted-globals": "off",
+        "prefer-object-spread": "off",
+        "guard-for-in":"off",
+        "no-multi-assign": "off",
+        "no-lonely-if": "off",
+        "@typescript-eslint/lines-between-class-members": "off",
+        "prefer-exponentiation-operator":"off",
+        "no-restricted-properties": "off",
+        "function-paren-newline": "off",
+        "no-labels": "off",
+        "@typescript-eslint/no-shadow": "off",
+        "no-nested-ternary": "off",
+        "no-debugger": "off",
+        "no-mixed-operators": "off",
+        "prefer-destructuring": "off",
+        "no-console": "off",
+        "import/export": "off",
+        "@typescript-eslint/quotes": "off",
+        "prefer-const": "off",
+        'linebreak-style': ["off", "windows"],
+        "prefer-rest-params": "off",
+        "max-classes-per-file": "off",
+        "max-len": "off",
+        "new-parens": "off",
+        "no-continue": "off",
+        "no-plusplus": "off",
+        "import/prefer-default-export": "off",
+        "@typescript-eslint/naming-convention": "off",
+        "@typescript-eslint/no-unused-vars": "off",
+        "@typescript-eslint/no-use-before-define": "off",
+        "import/no-cycle": "off",
+        "no-bitwise": 'off',
+        "default-case": "off",
+        "no-param-reassign": "off",
+        "class-methods-use-this": "off",
+        "consistent-return": "off",
+        "no-underscore-dangle": "off",
+        "no-restricted-syntax": "off",
+    },
+    "parserOptions": {
+        "warnOnUnsupportedTypeScriptVersion": false,
+        "ecmaVersion": 12,
+        "sourceType": "module",
+        "project": resolve("tsconfig.json")
+    }
+}

package/include/Environment.ts

@@ -0,0 +1,11 @@
+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/include/EnvironmentProperty.ts

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

package/include/Feature.ts

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

package/include/Installer.ts

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

package/include/Plugin.ts

@@ -0,0 +1,33 @@
+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/include/PluginMainfest.ts

@@ -0,0 +1,17 @@
+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/include/PluginManager.ts

@@ -0,0 +1,18 @@
+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/include/Service.ts

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

package/include/ServiceDependency.ts

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

package/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./include/DependenceManager";
+export * from "./include/Environment";
+export * from "./include/EnvironmentProperty";
+export * from "./include/Service";
+export * from "./include/Feature";
+export * from "./include/PluginManagerOptions";
+export * from "./include/Plugin";
+export * from "./include/PluginManager";
+export * from "./include/PluginMainfest";

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@compass-framework/plugin",
+  "version": "1.0.0",
+  "description": "",
+  "author": "",
+  "license": "ISC",
+  "types": "index.d.ts",
+  "scripts": {
+    "publish-plugin": "npm publish"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@compass-framework/library": "1.0.0",
+    "@compass-framework/core": "1.0.0"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,31 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "target": "ES2015",
+        "allowJs": true,
+        "lib": [
+            "ScriptHost",
+            "DOM",
+            "ES2015",
+            "ES2016",
+            "ES2017",
+            "ES2018",
+            "ES2019",
+            "ES2020",
+            "ES2021",
+            "ESNext"
+        ],
+        "types": [
+            "@types/jest",
+            "jest",
+            "node"
+        ],
+        "typeRoots" : [
+            "./src/define"
+        ],
+        "experimentalDecorators": true,
+        "sourceMap": true,
+        "esModuleInterop": true,
+        "downlevelIteration": true
+    }
+}