@rws-framework/client 2.7.2 → 2.8.1

package/src/client/config.ts

@@ -1,6 +1,8 @@
 import { IRWSConfig, IRWSUser } from "../index";
 import { RWSClientInstance } from "../client";
-import startClient from '../run';
+
+import { RWSPlugin, DefaultRWSPluginOptionsType } from "../plugins/_plugin";
+import RWSWindow, {loadRWSRichWindow } from '../interfaces/RWSWindow';
 
 type RWSInfoType = { components: string[] };
 
@@ -24,10 +26,13 @@ function setUser(this: RWSClientInstance, user: IRWSUser): RWSClientInstance {
     this.user = user;
 
     this.apiService.setToken(this.user.jwt_token);
-    this.wsService.setUser(this.user);
 
     localStorage.setItem('the_rws_user', JSON.stringify(this.user));
 
+    for(const plugin of RWSPlugin.getAllPlugins()){
+        plugin.onSetUser(user);
+    }
+
     return this;
 }
 
@@ -66,18 +71,42 @@ function get(this: RWSClientInstance, key: string): any | null
     return null;
 }
 
+type PluginConstructor<T extends DefaultRWSPluginOptionsType> = new (options: T) => RWSPlugin<T>;
+type RWSPluginEntry<T extends DefaultRWSPluginOptionsType> = PluginConstructor<T> | [PluginConstructor<T>, T];
+
+function addPlugin<T  extends DefaultRWSPluginOptionsType>(this: RWSClientInstance, pluginEntry: RWSPluginEntry<T>){
+    const rwsWindow: RWSWindow = loadRWSRichWindow();
+    const pluginClass: PluginConstructor<T> = (Array.isArray(pluginEntry) ? pluginEntry[0] : pluginEntry) as PluginConstructor<T>;
+    const pluginOptions: T = (Array.isArray(pluginEntry) ? pluginEntry[1] : { enabled: true }) as T;
+
+    if(!Object.keys(rwsWindow.RWS.plugins).includes(pluginClass.name)){       
+        const pluginInstance: RWSPlugin<T> = new pluginClass(pluginOptions);
+        this.plugins[pluginClass.name] = pluginInstance; 
+        rwsWindow.RWS.plugins[pluginClass.name] = pluginInstance;
+    }
+}
+
 async function setup(this: RWSClientInstance, config: IRWSConfig = {}): Promise<IRWSConfig> {
     if (this.isSetup) {
         return this.config;
     }
 
     this.config = { ...this.config, ...config };
-    this.appConfig.mergeConfig(this.config);
+    this.appConfig.mergeConfig(this.config);    
+
+    if(this.config.plugins){        
+        for (const pluginEntry of this.config.plugins){
+            addPlugin.bind(this)(pluginEntry);
+        }
+    }
 
     if (this.appConfig.get('parted')) {
-        await this.loadPartedComponents();            
-    }       
+        const componentParts = await this.loadPartedComponents();
 
+        for (const plugin of RWSPlugin.getAllPlugins()){
+            plugin.onPartedComponentsLoad(componentParts);
+        }
+    }               
 
     this.isSetup = true;
     return this.config;
@@ -98,10 +127,12 @@ async function start(this: RWSClientInstance, config: IRWSConfig = {}): Promise<
         this.pushUserToServiceWorker(this.user);
     }
 
-    await startClient(this.appConfig, this.wsService, this.notifyService, this.routingService);        
-
     await this.initCallback();        
 
+    for (const plugin of RWSPlugin.getAllPlugins()){
+        plugin.onClientStart();
+    }
+
     return this;
 }
 

package/src/client.ts

@@ -7,8 +7,7 @@ import UtilsService, { UtilsServiceInstance } from './services/UtilsService';
 import DOMService, { DOMServiceInstance } from './services/DOMService';
 import ApiService, { ApiServiceInstance } from './services/ApiService';
 import NotifyService, { NotifyServiceInstance } from './services/NotifyService';
-import RoutingService, { RoutingServiceInstance } from './services/RoutingService';
-import WSService, { WSServiceInstance } from './services/WSService';
+
 import ServiceWorkerService, { ServiceWorkerServiceInstance } from './services/ServiceWorkerService';
 import { IBackendRoute } from './services/ApiService';
 import IRWSUser from './interfaces/IRWSUser';
@@ -16,17 +15,14 @@ import RWSWindow, { RWSWindowComponentRegister, loadRWSRichWindow } from './inte
 
 import { DI, Container, Registration } from '@microsoft/fast-foundation';
 
-import {
-    IFrontRoutes
-} from './services/RoutingService';
-
 import RWSViewComponent, { IWithCompose } from './components/_component';
 import RWSContainer from './components/_container';
 import TheRWSService from './services/_service';
 
-import ComponentHelper, { ComponentHelperStatic } from './client/components';
+import ComponentHelper, { ComponentHelperStatic, RWSInfoType } from './client/components';
 import ServicesHelper from './client/services';
 import ConfigHelper from './client/config';
+import { DefaultRWSPluginOptionsType, RWSPlugin } from './plugins/_plugin';
 
 interface IHotModule extends NodeModule {
     hot?: {
@@ -37,7 +33,6 @@ interface IHotModule extends NodeModule {
     }
 }
 
-type RWSInfoType = { components: string[] };
 type RWSEventListener = (event: CustomEvent) => void;
 
 class RWSClient {
@@ -45,6 +40,7 @@ class RWSClient {
     protected user: IRWSUser = null;
     
     protected config: IRWSConfig = {};
+    protected plugins: {[key: string]: RWSPlugin<DefaultRWSPluginOptionsType>} = {}
     protected isSetup = false;
     protected devStorage: { [key: string]: any } = {};    
     protected customServices: { [serviceName: string]: TheRWSService} = {};
@@ -57,12 +53,10 @@ class RWSClient {
     protected initCallback: () => Promise<void> = async () => { };    
 
     constructor(
-        @ConfigService public appConfig: ConfigServiceInstance,
-        @RoutingService public routingService: RoutingServiceInstance,
+        @ConfigService public appConfig: ConfigServiceInstance,        
         @DOMService public domService: DOMServiceInstance,
         @UtilsService public utilsService: UtilsServiceInstance,
         @ApiService public apiService: ApiServiceInstance,
-        @WSService public wsService: WSServiceInstance,
         @ServiceWorkerService public swService: ServiceWorkerServiceInstance,
         @NotifyService public notifyService: NotifyServiceInstance
     ) {
@@ -93,11 +87,7 @@ class RWSClient {
     get(key: string): any | null
     {
         return this.configHelper.get(key);
-    }
-
-    addRoutes(routes: IFrontRoutes) {
-        this.config.routes = routes;
-    }
+    }    
 
     setNotifier(notifier: RWSNotify): RWSClient {
         this.notifyService.setNotifier(notifier);
@@ -118,6 +108,11 @@ class RWSClient {
 
     async onInit(callback: () => Promise<void>): Promise<RWSClient> {
         this.initCallback = callback;
+
+        for (const plugin of RWSPlugin.getAllPlugins()){
+            plugin.onComponentsDeclare();
+        }
+
         return this;
     }
 
@@ -161,7 +156,7 @@ class RWSClient {
 
     }
 
-    async loadPartedComponents(): Promise<void> {
+    async loadPartedComponents(): Promise<RWSInfoType> {
         return this.componentHelper.loadPartedComponents();
     }   
     

package/src/components/_component.ts

@@ -5,7 +5,6 @@ import UtilsService, { UtilsServiceInstance } from '../services/UtilsService';
 import DOMService, { DOMServiceInstance, DOMOutputType } from '../services/DOMService';
 import ApiService, { ApiServiceInstance } from '../services/ApiService';
 import NotifyService, { NotifyServiceInstance } from '../services/NotifyService';
-import WSService, { WSServiceInstance } from '../services/WSService';
 import { IRWSViewComponent, IAssetShowOptions } from '../interfaces/IRWSViewComponent';
 import RWSWindow, { RWSWindowComponentInterface, loadRWSRichWindow } from '../interfaces/RWSWindow';
 import { applyConstructor, RWSInject } from './_decorator';
@@ -52,8 +51,7 @@ abstract class RWSViewComponent extends FoundationElement implements IRWSViewCom
     @RWSInject(ConfigService, true) protected config: ConfigServiceInstance;    
     @RWSInject(DOMService, true) protected domService: DOMServiceInstance;
     @RWSInject(UtilsService, true) protected utilsService: UtilsServiceInstance;
-    @RWSInject(ApiService, true) protected apiService: ApiServiceInstance;
-    @RWSInject(WSService, true) protected wsService: WSServiceInstance;
+    @RWSInject(ApiService, true) protected apiService: ApiServiceInstance;    
     @RWSInject(NotifyService, true) protected notifyService: NotifyServiceInstance;
 
     @observable trashIterator: number = 0;

package/src/components/_decorator.ts

@@ -1,6 +1,6 @@
 import RWSViewComponent, { IWithCompose } from './_component';
 import { RWSInject } from './_decorators/RWSInject';
-
+import { ElementStyles, ViewTemplate } from '@microsoft/fast-element'; 
 import 'reflect-metadata';
 
 interface RWSDecoratorOptions {
@@ -8,16 +8,34 @@ interface RWSDecoratorOptions {
     styles?: string,
     fastElementOptions?: any,
     ignorePackaging?: boolean,
+    debugPackaging?: boolean
     oreoMode?: boolean
 }
 
 //const _PARAMTYPES_METADATA_KEY = 'design:paramtypes';
 
-function RWSView<T extends RWSViewComponent>(name: string, data?: RWSDecoratorOptions): (type: any) => void {
-    return (constructor: T) => {
+function RWSView<Component extends RWSViewComponent>(name: string, data?: RWSDecoratorOptions | null, override?: { styles?: ElementStyles, template?: ViewTemplate, options?: any }): (type: any, args?: any) => void {
+    return (theComponent: IWithCompose<Component>, args?: any) => {
+        theComponent.definition = { name, template: null }
+
+        if(override){
+            if(override.styles){
+                theComponent.definition.styles = override.styles;
+            }
+
+            if(override.template){
+                theComponent.definition.template = override.template;
+            }
+
+            
+            if(override.options){
+                (theComponent.definition as any).options = override.options;
+            }
+        }
     };
 }
 
+
 function RWSIgnore(params: { mergeToApp?: boolean } | null = null): () => void {
     return () => { };
 }

package/src/components/index.ts

@@ -1,5 +1,4 @@
 import { RWSUploader } from './uploader/component';
-import { RouterComponent } from './router/component';
 import { RWSProgress } from './progress/component';
 import { RWSLoader } from './loader/component';
 
@@ -7,8 +6,7 @@ import { RWSLoader } from './loader/component';
 function declareRWSComponents(parted: boolean = false): void
 {
     if(!parted){
-        RWSUploader;
-        RouterComponent;
+        RWSUploader;        
         RWSProgress;
         RWSLoader;
     }

package/src/components/loader/component.ts

@@ -1,4 +1,4 @@
-import { RWSView, RWSViewComponent } from '@rws-framework/client';
+import { RWSView, RWSViewComponent } from '../../index';
 
 @RWSView('the-loader')
 class RWSLoader extends RWSViewComponent {

package/src/index.ts

@@ -5,27 +5,21 @@ import RWSNotify, { NotifyUiType, NotifyLogType } from './types/RWSNotify';
 import { provideRWSDesignSystem } from './components/_design_system';
 import RWSService from './services/_service';
 import ConfigService, { ConfigServiceInstance } from './services/ConfigService';
-import RoutingService, { RoutingServiceInstance } from './services/RoutingService';
 import NotifyService, {NotifyServiceInstance} from './services/NotifyService';
 import DOMService, { DOMServiceInstance, DOMOutputType, TagsProcessorType }  from './services/DOMService';
 import ApiService,  { IBackendRoute, ApiServiceInstance, IHTTProute, IPrefixedHTTProutes } from './services/ApiService';
 import UtilsService, {UtilsServiceInstance} from './services/UtilsService';
 import ServiceWorkerService, { ServiceWorkerServiceInstance } from './services/ServiceWorkerService';
-import { sanitizedAttr } from './components/_attrs/sanitize-html';import WSService, {WSServiceInstance, WSStatus} from './services/WSService';
+import { sanitizedAttr } from './components/_attrs/sanitize-html';
 import { ngAttr } from './components/_attrs/angular-attr';
-import RWSClient from './client';
-
+import { RWSPlugin, DefaultRWSPluginOptionsType } from './plugins/_plugin';
+import RWSClient, { RWSClientInstance } from './client';
+import { RWSPluginEntry } from './interfaces/IRWSConfig';
 import IRWSUser from './interfaces/IRWSUser';
 import RWSViewComponent, { IAssetShowOptions } from './components/_component';
 
 import RWSContainer from './components/_container';
 
-import { 
-    IFrontRoutes, renderRouteComponent, RouteReturn, 
-    _ROUTING_EVENT_NAME, IRoutingEvent,
-    RWSRouter, IRWSRouteResult
-} from './services/RoutingService';
-
 
 import { RWSDecoratorOptions, RWSIgnore, RWSInject, RWSView } from './components/_decorator';
 
@@ -33,19 +27,18 @@ import { declareRWSComponents } from './components';
 
 export default RWSClient;
 export { 
+    RWSClient,
+    RWSClientInstance,
+
+    RWSPlugin,
+    RWSPluginEntry,
+    DefaultRWSPluginOptionsType,
+    
     NotifyUiType,
     NotifyLogType,
 
-    RouteReturn,
-    _ROUTING_EVENT_NAME,
-    IRoutingEvent,
-    
-    RoutingServiceInstance,
-    RoutingService,
     ApiServiceInstance,
     ApiService,    
-    WSServiceInstance,
-    WSService,
     UtilsServiceInstance,    
     UtilsService,    
     DOMServiceInstance,
@@ -59,14 +52,10 @@ export {
     ServiceWorkerService,
 
     RWSNotify,
-    RWSRouter,
-    IFrontRoutes as IRWSFrontRoutes,
     IBackendRoute as IRWSBackendRoute,
     RWSDecoratorOptions as IRWSDecoratorOptions,
-    IRWSRouteResult,
     IHTTProute as IRWSHttpRoute,
-    IPrefixedHTTProutes as IRWSPrefixedHTTProutes,
-    WSStatus as IRWSWebsocketStatus,
+    IPrefixedHTTProutes as IRWSPrefixedHTTProutes,    
     IAssetShowOptions as IRWSAssetShowOptions,
     IRWSConfig,
     IRWSUser,
@@ -80,9 +69,6 @@ export {
     RWSIgnore,
     RWSInject,
     ngAttr,    
-
-    renderRouteComponent,
-
     observable,
     attr,
     

package/src/interfaces/IRWSConfig.ts

@@ -1,5 +1,9 @@
-import { IFrontRoutes } from '../services/RoutingService';
 import RWSViewComponent from '../components/_component';
+import { RWSPlugin, DefaultRWSPluginOptionsType } from '../plugins/_plugin';
+
+export type IFrontRoutes = Record<string, unknown>; 
+export type PluginConstructor<T extends DefaultRWSPluginOptionsType> = new (options: T) => RWSPlugin<T>;
+export type RWSPluginEntry<T extends DefaultRWSPluginOptionsType> = PluginConstructor<T> | [PluginConstructor<T>, T];
 
 export default interface IRWSConfig {
     dev?: boolean
@@ -19,6 +23,7 @@ export default interface IRWSConfig {
     parted?: boolean
     partedFileDir?: string
     partedPrefix?: string
+    plugins?: RWSPluginEntry<DefaultRWSPluginOptionsType>[]
     routing_enabled?: boolean
     _noLoad?: boolean    
 }

package/src/interfaces/RWSWindow.ts

@@ -1,5 +1,6 @@
 import { RWSClientInstance } from '../client';
 import { Container, InterfaceSymbol } from '@microsoft/fast-foundation';
+import { RWSPlugin, DefaultRWSPluginOptionsType } from '../plugins/_plugin';
 import { v1 as uuid} from 'uuid';
 export type RWSWindowComponentInterface = (params?: any) => void;
 export type RWSWindowComponentEntry = { interface: RWSWindowComponentInterface, component: any };
@@ -12,12 +13,13 @@ export function loadRWSRichWindow(): RWSWindow
     if(!richWindow.RWS){
         const newNode = document.createElement('main');
         newNode.id = 'rws-cntr-id-' + uuid();
-
-        console.log('Created container on node: ', newNode.id);
+        
+        console.log('\x1b[1m[RWS]\x1b[0m Created new container node: ', newNode.id);
 
         richWindow.RWS = {
             client: null,
             components: {},
+            plugins: {},
             container: null,
             container_node: newNode,
             _registered: {}
@@ -31,6 +33,7 @@ export default interface RWSWindow extends Window {
     RWS?: {
         client?: RWSClientInstance
         components: RWSWindowComponentRegister
+        plugins: {[key: string]: RWSPlugin<DefaultRWSPluginOptionsType>}
         container: Container | null
         container_node: Element | null
         _registered: {[key: string]: InterfaceSymbol<any>};

package/src/plugins/_builder.js

@@ -0,0 +1,32 @@
+const fs = require('fs');
+const chalk = require('chalk');
+
+class RWSPluginBuilder {
+    pluginInfo = {name: null};
+
+    constructor(pluginPath, buildConfigurator, baseBuildConfig){
+        this.pluginPath = pluginPath;
+        this.buildConfigurator = buildConfigurator;
+        this.baseBuildConfig = baseBuildConfig;
+
+        this.pluginInfo = JSON.parse(fs.readFileSync(this.pluginPath + '/plugin-info.json', 'utf-8'));
+    }
+
+    async onComponentsLocated(partedComponentsLocations = []){
+        return partedComponentsLocations;
+    }
+
+    async onServicesLocated(servicesLocations){        
+        return servicesLocations;
+    }
+
+    async onBuild(webpackOptions){
+        return webpackOptions;
+    }
+
+    log(msg){
+        console.log(chalk.blue('RWS Plugin'), chalk.green(this.pluginInfo.name) + ':', msg);
+    }
+}
+
+module.exports = { RWSPluginBuilder };

package/src/plugins/_plugin.ts

@@ -0,0 +1,63 @@
+import RWSContainer from "../components/_container";
+import { Container } from "@microsoft/fast-foundation";
+import RWSWindow, {loadRWSRichWindow } from '../interfaces/RWSWindow';
+import IRWSUser from "../interfaces/IRWSUser";
+import { RWSInfoType } from "../client/components";
+
+type DefaultRWSPluginOptionsType = { enabled: boolean };
+type PluginInfoType = { name: string }
+type PluginConstructor<T extends DefaultRWSPluginOptionsType> = new (options: T) => RWSPlugin<T>;
+abstract class RWSPlugin<PluginOptions extends DefaultRWSPluginOptionsType> {
+    protected isLoaded: boolean = false;
+    protected options: PluginOptions;
+    protected container: Container;    
+    protected window: RWSWindow;
+
+    static container: Container;    
+    static window: RWSWindow;
+
+    constructor(options: PluginOptions = { enabled: false } as PluginOptions){
+        this.isLoaded = true;
+        this.container = RWSPlugin.container;
+        this.window = RWSPlugin.window;
+        this.options = options;
+    }
+
+    async onClientStart(): Promise<void>
+    {
+        
+    }
+
+    async onPartedComponentsLoad(componentParts: RWSInfoType): Promise<void>
+    {
+        
+    }
+
+    async onComponentsDeclare(): Promise<void>
+    {
+        
+    }
+
+    async onSetUser(user: IRWSUser): Promise<void>{
+
+    }
+
+    
+    
+    static getPlugin<Plugin extends RWSPlugin<T>, T extends DefaultRWSPluginOptionsType = DefaultRWSPluginOptionsType>(pluginClass: PluginConstructor<T>): Plugin | null 
+    {
+        const plugin = this.window.RWS.plugins[pluginClass.name];
+        return plugin ? plugin as Plugin : null;
+    }
+
+
+    static getAllPlugins(): RWSPlugin<DefaultRWSPluginOptionsType>[]
+    {
+        return Object.keys(this.window.RWS.plugins).map((key) => this.window.RWS.plugins[key]);
+    }
+}
+
+RWSPlugin.window = loadRWSRichWindow();
+RWSPlugin.container = RWSContainer();
+
+export { RWSPlugin, DefaultRWSPluginOptionsType }

package/src/services/ConfigService.ts

@@ -63,6 +63,10 @@ class ConfigService extends TheService {
 
         return this.data[key as keyof IRWSConfig];
     }
+
+    public set<V extends keyof IRWSConfig>(key: V, value: IRWSConfig[V]){
+        this.data[key] = value;
+    }
   
     public async reloadConfig(cfgString: string): Promise<ConfigService> 
     {
@@ -111,8 +115,12 @@ class ConfigService extends TheService {
     }
 
     mergeConfig(config: IRWSConfig) {
-        const unloaded = ConfigService.isLoaded;        
+        const unloaded = ConfigService.isLoaded;     
 
+        if(!Object.keys(this.data).includes('plugins')){
+            this.data.plugins = [];
+        }
+        
         this.data = Object.assign(this.data, config);
 
         if(unloaded){

package/src/services/ServiceWorkerService.ts

@@ -1,4 +1,4 @@
-import RWSService from '@rws-framework/client/src/services/_service';
+import RWSService from './_service';
 
 
 class ServiceWorkerService extends RWSService {   

package/tsconfig.json

@@ -17,6 +17,9 @@
       "declaration": true,     
       "lib": ["DOM", "ESNext"],
     },
+    "paths": {
+      "@rws-framework/client": ["src"]
+    },   
     "include": [
       "src",             
       "types/docs-typings.d.ts"