@rws-framework/client 2.0.14 → 2.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -14,16 +14,16 @@
14
14
  "strictNullChecks": false,
15
15
  "allowSyntheticDefaultImports": true,
16
16
  "paths": {
17
- // "rws-js-client/*": ["./node_modules/rws-js-client/src/*"],
18
- // "rws-js-client/tests": ["./node_modules/rws-js-client/dist/src/tests/index"],
19
- // "rws-js-client": ["./node_modules/rws-js-client/dist/src/index"],
17
+ // "@rws-framework/client/*": ["./node_modules/@rws-framework/client/src/*"],
18
+ // "@rws-framework/client/tests": ["./node_modules/@rws-framework/client/dist/src/tests/index"],
19
+ // "@rws-framework/client": ["./node_modules/@rws-framework/client/dist/src/index"],
20
20
  }
21
21
  },
22
22
  "include": [
23
23
  "src",
24
- "../node_modules/rws-js-client/declarations.d.ts",
24
+ "../node_modules/@rws-framework/client/declarations.d.ts",
25
25
  ],
26
26
  "exclude": [
27
- "../node_modules/rws-js-client/src/tests"
27
+ "../node_modules/@rws-framework/client/src/tests"
28
28
  ]
29
29
  }
package/README.md CHANGED
@@ -94,7 +94,7 @@ The main file (`index.ts`) is where you initialize the RWSClient. Here, you conf
94
94
  Following is example of full usage of the framework
95
95
 
96
96
  ```typescript
97
- import RWSClient, { NotifyUiType, NotifyLogType } from 'rws-js-client';
97
+ import RWSClient, { NotifyUiType, NotifyLogType } from '@rws-framework/client';
98
98
  //@ts-ignore
99
99
  import alertify from 'alertifyjs';
100
100
 
@@ -210,7 +210,7 @@ import { RWSIcon } from '../components/rws-icon/component';
210
210
  import { Loader } from '../components/loader/component';
211
211
  import { LineSplitter } from '../components/line-splitter/component';
212
212
 
213
- import { registerRWSComponents } from 'rws-js-client';
213
+ import { registerRWSComponents } from '@rws-framework/client';
214
214
 
215
215
  export default () => {
216
216
  LineSplitter;
@@ -241,7 +241,7 @@ export default () => {
241
241
  **Component needs to extend RWSViewComponent and use @RWSView decorator**:
242
242
 
243
243
  ```typescript
244
- import { RWSViewComponent, RWSView, observable, attr } from 'rws-js-client';
244
+ import { RWSViewComponent, RWSView, observable, attr } from '@rws-framework/client';
245
245
 
246
246
  const options?: RWSDecoratorOptions;
247
247
 
@@ -381,10 +381,10 @@ If you pass ```{serviceWorker: 'service_worker_class_path.ts'}``` to RWS Webpack
381
381
  example ServiceWorker class:
382
382
 
383
383
  ```typescript
384
- import SWService, { ServiceWorkerServiceInstance } from 'rws-js-client/src/services/ServiceWorkerService'
384
+ import SWService, { ServiceWorkerServiceInstance } from '@rws-framework/client/src/services/ServiceWorkerService'
385
385
  import {TimeTracker} from '../services/TimeTrackerService';
386
- import RWSServiceWorker from 'rws-js-client/src/service_worker/src/_service_worker';
387
- import { RWSWSService as WSService } from 'rws-js-client/src/services/WSService'
386
+ import RWSServiceWorker from '@rws-framework/client/src/service_worker/src/_service_worker';
387
+ import { RWSWSService as WSService } from '@rws-framework/client/src/services/WSService'
388
388
 
389
389
  declare const self: ServiceWorkerGlobalScope;
390
390
 
@@ -486,7 +486,7 @@ The WebChat component demonstrates a practical use of `APIService` in a real-wor
486
486
  ### WebChat Component Implementation
487
487
 
488
488
  ```typescript
489
- import { RWSViewComponent, ApiService, NotifyService, RWSView, WSService } from 'rws-js-client';
489
+ import { RWSViewComponent, ApiService, NotifyService, RWSView, WSService } from '@rws-framework/client';
490
490
  import { observable, css } from '@microsoft/fast-element';
491
491
 
492
492
  import './children/convo-footer/component';
package/_rws_externals.js CHANGED
@@ -7,7 +7,7 @@ const _defaultOpts = {
7
7
  inc_list_context: [],
8
8
  inc_list: [],
9
9
  not_inc_list: [],
10
- not_inc_list_context: ['rws-js-client', 'node_modules'],
10
+ not_inc_list_context: ['@rws-framework/client', 'node_modules'],
11
11
  exceptions: [],
12
12
  exceptions_context: [],
13
13
  }
package/docs/index.html CHANGED
@@ -37,7 +37,7 @@
37
37
  <p><strong>Main File:</strong></p>
38
38
  <p>The main file (<code>index.ts</code>) is where you initialize the RWSClient. Here, you configure your routes, backend routes, and component initializations.</p>
39
39
  <p>Following is example of full usage of the framework</p>
40
- <pre><code class="language-typescript"><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-3">RWSClient</span><span class="hl-1">, { </span><span class="hl-3">NotifyUiType</span><span class="hl-1">, </span><span class="hl-3">NotifyLogType</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;rws-js-client&#39;</span><span class="hl-1">;</span><br/><span class="hl-8">//@ts-ignore</span><br/><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-3">alertify</span><span class="hl-1"> </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;alertifyjs&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-2">&#39;./styles/main.scss&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-3">routes</span><span class="hl-1"> </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;./routing/routes&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">backendRoutes</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;./backendImport&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-3">initComponents</span><span class="hl-1"> </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;./application/_initComponents&#39;</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">provideFASTDesignSystem</span><span class="hl-1">, </span><span class="hl-3">allComponents</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@microsoft/fast-components&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">async</span><span class="hl-1"> </span><span class="hl-5">function</span><span class="hl-1"> </span><span class="hl-0">initializeApp</span><span class="hl-1">() { </span><br/><span class="hl-1"> </span><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-4">theClient</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">RWSClient</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-3">theClient</span><span class="hl-1">.</span><span class="hl-0">setBackendRoutes</span><span class="hl-1">(</span><span class="hl-0">backendRoutes</span><span class="hl-1">());</span><br/><span class="hl-1"> </span><span class="hl-3">theClient</span><span class="hl-1">.</span><span class="hl-0">addRoutes</span><span class="hl-1">(</span><span class="hl-3">routes</span><span class="hl-1">); </span><br/><span class="hl-1"> </span><br/><span class="hl-1"> </span><span class="hl-3">theClient</span><span class="hl-1">.</span><span class="hl-0">onInit</span><span class="hl-1">(</span><span class="hl-5">async</span><span class="hl-1"> () </span><span class="hl-5">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">initComponents</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">provideFASTDesignSystem</span><span class="hl-1">().</span><span class="hl-0">register</span><span class="hl-1">(</span><span class="hl-3">allComponents</span><span class="hl-1">);</span><br/><span class="hl-1"> }); </span><br/><br/><br/><span class="hl-1"> </span><span class="hl-3">theClient</span><span class="hl-1">.</span><span class="hl-0">setNotifier</span><span class="hl-1">((</span><span class="hl-3">message</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">, </span><span class="hl-3">logType</span><span class="hl-1">: </span><span class="hl-7">NotifyLogType</span><span class="hl-1">, </span><span class="hl-3">uiType</span><span class="hl-1">: </span><span class="hl-7">NotifyUiType</span><span class="hl-1"> = </span><span class="hl-2">&#39;notification&#39;</span><span class="hl-1">, </span><span class="hl-0">onConfirm</span><span class="hl-1">: (</span><span class="hl-3">params</span><span class="hl-1">: </span><span class="hl-7">any</span><span class="hl-1">) </span><span class="hl-5">=&gt;</span><span class="hl-1"> </span><span class="hl-7">void</span><span class="hl-1">) </span><span class="hl-5">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">switch</span><span class="hl-1">(</span><span class="hl-3">uiType</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-6">case</span><span class="hl-1"> </span><span class="hl-2">&#39;notification&#39;</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-3">notifType</span><span class="hl-1"> = </span><span class="hl-2">&#39;success&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1">(</span><span class="hl-3">logType</span><span class="hl-1"> === </span><span class="hl-2">&#39;error&#39;</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-3">notifType</span><span class="hl-1"> = </span><span class="hl-2">&#39;error&#39;</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1">(</span><span class="hl-3">logType</span><span class="hl-1"> === </span><span class="hl-2">&#39;warning&#39;</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-3">notifType</span><span class="hl-1"> = </span><span class="hl-2">&#39;warning&#39;</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-3">alertify</span><span class="hl-1">.</span><span class="hl-0">notify</span><span class="hl-1">(</span><span class="hl-3">message</span><span class="hl-1">, </span><span class="hl-3">notifType</span><span class="hl-1">, </span><span class="hl-9">5</span><span class="hl-1">, </span><span class="hl-3">onConfirm</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-6">return</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">case</span><span class="hl-1"> </span><span class="hl-2">&#39;alert&#39;</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-3">alertify</span><span class="hl-1">.</span><span class="hl-0">alert</span><span class="hl-1">(</span><span class="hl-2">&#39;Junction AI Notification&#39;</span><span class="hl-1">, </span><span class="hl-3">message</span><span class="hl-1">, </span><span class="hl-3">onConfirm</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-6">return</span><span class="hl-1">; </span><br/><span class="hl-1"> </span><span class="hl-6">case</span><span class="hl-1"> </span><span class="hl-2">&#39;silent&#39;</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1">(</span><span class="hl-3">logType</span><span class="hl-1"> == </span><span class="hl-2">&#39;warning&#39;</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-3">console</span><span class="hl-1">.</span><span class="hl-0">warn</span><span class="hl-1">(</span><span class="hl-3">message</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><span class="hl-6">else</span><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1">(</span><span class="hl-3">logType</span><span class="hl-1"> == </span><span class="hl-2">&#39;error&#39;</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-3">console</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">(</span><span class="hl-3">message</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><span class="hl-6">else</span><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-3">message</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><br/><span class="hl-1"> </span><span class="hl-6">return</span><span class="hl-1">; </span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> });</span><br/><span class="hl-1"> (</span><span class="hl-3">window</span><span class="hl-1"> </span><span class="hl-6">as</span><span class="hl-1"> </span><span class="hl-7">any</span><span class="hl-1">).</span><span class="hl-3">RWSClient</span><span class="hl-1"> = </span><span class="hl-3">theClient</span><span class="hl-1">; </span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">initializeApp</span><span class="hl-1">().</span><span class="hl-0">catch</span><span class="hl-1">(</span><span class="hl-3">console</span><span class="hl-1">.</span><span class="hl-3">error</span><span class="hl-1">);</span><br/>
40
+ <pre><code class="language-typescript"><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-3">RWSClient</span><span class="hl-1">, { </span><span class="hl-3">NotifyUiType</span><span class="hl-1">, </span><span class="hl-3">NotifyLogType</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@rws-framework/client&#39;</span><span class="hl-1">;</span><br/><span class="hl-8">//@ts-ignore</span><br/><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-3">alertify</span><span class="hl-1"> </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;alertifyjs&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-2">&#39;./styles/main.scss&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-3">routes</span><span class="hl-1"> </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;./routing/routes&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">backendRoutes</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;./backendImport&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">import</span><span class="hl-1"> </span><span class="hl-3">initComponents</span><span class="hl-1"> </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;./application/_initComponents&#39;</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">provideFASTDesignSystem</span><span class="hl-1">, </span><span class="hl-3">allComponents</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@microsoft/fast-components&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-5">async</span><span class="hl-1"> </span><span class="hl-5">function</span><span class="hl-1"> </span><span class="hl-0">initializeApp</span><span class="hl-1">() { </span><br/><span class="hl-1"> </span><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-4">theClient</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">RWSClient</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-3">theClient</span><span class="hl-1">.</span><span class="hl-0">setBackendRoutes</span><span class="hl-1">(</span><span class="hl-0">backendRoutes</span><span class="hl-1">());</span><br/><span class="hl-1"> </span><span class="hl-3">theClient</span><span class="hl-1">.</span><span class="hl-0">addRoutes</span><span class="hl-1">(</span><span class="hl-3">routes</span><span class="hl-1">); </span><br/><span class="hl-1"> </span><br/><span class="hl-1"> </span><span class="hl-3">theClient</span><span class="hl-1">.</span><span class="hl-0">onInit</span><span class="hl-1">(</span><span class="hl-5">async</span><span class="hl-1"> () </span><span class="hl-5">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">initComponents</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">provideFASTDesignSystem</span><span class="hl-1">().</span><span class="hl-0">register</span><span class="hl-1">(</span><span class="hl-3">allComponents</span><span class="hl-1">);</span><br/><span class="hl-1"> }); </span><br/><br/><br/><span class="hl-1"> </span><span class="hl-3">theClient</span><span class="hl-1">.</span><span class="hl-0">setNotifier</span><span class="hl-1">((</span><span class="hl-3">message</span><span class="hl-1">: </span><span class="hl-7">string</span><span class="hl-1">, </span><span class="hl-3">logType</span><span class="hl-1">: </span><span class="hl-7">NotifyLogType</span><span class="hl-1">, </span><span class="hl-3">uiType</span><span class="hl-1">: </span><span class="hl-7">NotifyUiType</span><span class="hl-1"> = </span><span class="hl-2">&#39;notification&#39;</span><span class="hl-1">, </span><span class="hl-0">onConfirm</span><span class="hl-1">: (</span><span class="hl-3">params</span><span class="hl-1">: </span><span class="hl-7">any</span><span class="hl-1">) </span><span class="hl-5">=&gt;</span><span class="hl-1"> </span><span class="hl-7">void</span><span class="hl-1">) </span><span class="hl-5">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">switch</span><span class="hl-1">(</span><span class="hl-3">uiType</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-6">case</span><span class="hl-1"> </span><span class="hl-2">&#39;notification&#39;</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-5">let</span><span class="hl-1"> </span><span class="hl-3">notifType</span><span class="hl-1"> = </span><span class="hl-2">&#39;success&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1">(</span><span class="hl-3">logType</span><span class="hl-1"> === </span><span class="hl-2">&#39;error&#39;</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-3">notifType</span><span class="hl-1"> = </span><span class="hl-2">&#39;error&#39;</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1">(</span><span class="hl-3">logType</span><span class="hl-1"> === </span><span class="hl-2">&#39;warning&#39;</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-3">notifType</span><span class="hl-1"> = </span><span class="hl-2">&#39;warning&#39;</span><span class="hl-1">;</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-3">alertify</span><span class="hl-1">.</span><span class="hl-0">notify</span><span class="hl-1">(</span><span class="hl-3">message</span><span class="hl-1">, </span><span class="hl-3">notifType</span><span class="hl-1">, </span><span class="hl-9">5</span><span class="hl-1">, </span><span class="hl-3">onConfirm</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-6">return</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-6">case</span><span class="hl-1"> </span><span class="hl-2">&#39;alert&#39;</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-3">alertify</span><span class="hl-1">.</span><span class="hl-0">alert</span><span class="hl-1">(</span><span class="hl-2">&#39;Junction AI Notification&#39;</span><span class="hl-1">, </span><span class="hl-3">message</span><span class="hl-1">, </span><span class="hl-3">onConfirm</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-6">return</span><span class="hl-1">; </span><br/><span class="hl-1"> </span><span class="hl-6">case</span><span class="hl-1"> </span><span class="hl-2">&#39;silent&#39;</span><span class="hl-1">:</span><br/><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1">(</span><span class="hl-3">logType</span><span class="hl-1"> == </span><span class="hl-2">&#39;warning&#39;</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-3">console</span><span class="hl-1">.</span><span class="hl-0">warn</span><span class="hl-1">(</span><span class="hl-3">message</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><span class="hl-6">else</span><span class="hl-1"> </span><span class="hl-6">if</span><span class="hl-1">(</span><span class="hl-3">logType</span><span class="hl-1"> == </span><span class="hl-2">&#39;error&#39;</span><span class="hl-1">){</span><br/><span class="hl-1"> </span><span class="hl-3">console</span><span class="hl-1">.</span><span class="hl-0">error</span><span class="hl-1">(</span><span class="hl-3">message</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><span class="hl-6">else</span><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-3">message</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><br/><span class="hl-1"> </span><span class="hl-6">return</span><span class="hl-1">; </span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> });</span><br/><span class="hl-1"> (</span><span class="hl-3">window</span><span class="hl-1"> </span><span class="hl-6">as</span><span class="hl-1"> </span><span class="hl-7">any</span><span class="hl-1">).</span><span class="hl-3">RWSClient</span><span class="hl-1"> = </span><span class="hl-3">theClient</span><span class="hl-1">; </span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">initializeApp</span><span class="hl-1">().</span><span class="hl-0">catch</span><span class="hl-1">(</span><span class="hl-3">console</span><span class="hl-1">.</span><span class="hl-3">error</span><span class="hl-1">);</span><br/>
41
41
  </code><button>Copy</button></pre>
42
42
  <a id="md:component-initialization" class="tsd-anchor"></a><h2><a href="#md:component-initialization">Component Initialization</a></h2><p>In <code>application/_initComponents.ts</code>, you initialize the custom components used in your application. If components added in here will include other components they dont need to be listed here. A component imported in this mode needs to be imported once.</p>
43
43
  <a id="md:default-component-structure" class="tsd-anchor"></a><h3><a href="#md:default-component-structure">Default component structure</a></h3><pre><code><span class="hl-3">component</span><span class="hl-1">-</span><span class="hl-3">dir</span><span class="hl-1">/</span><br/><span class="hl-1"> </span><span class="hl-3">component</span><span class="hl-1">.</span><span class="hl-3">ts</span><br/><span class="hl-1"> </span><span class="hl-3">template</span><span class="hl-1">.</span><span class="hl-3">html</span><br/><span class="hl-1"> </span><span class="hl-3">styles</span><span class="hl-1">/</span><br/><span class="hl-1"> </span><span class="hl-3">layout</span><span class="hl-1">.</span><span class="hl-3">scss</span>
@@ -45,7 +45,7 @@
45
45
  <p><strong>WARNING</strong> <em>All html templates refer to variable &quot;T&quot; as to FASTElement templating html scope. It contains all the functions FAST templates uses in html. F.e:</em> <strong>T.html</strong>, <strong>T.when</strong>, <strong>T.repeat</strong></p>
46
46
  <pre><code class="language-html"><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-1"> </span><span class="hl-12">class</span><span class="hl-1">=</span><span class="hl-13">&quot;convo-area-wrap&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;</span><span class="hl-11">header</span><span class="hl-10">&gt;</span><span class="hl-1"> </span><br/><span class="hl-1"> </span><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-1"> </span><span class="hl-12">class</span><span class="hl-1">=</span><span class="hl-13">&quot;header-inner&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><span class="hl-1"> </span><br/><span class="hl-1"> ${T.when(x =&gt; x.noChoose === &#39;false&#39;, (item, index) =&gt; T.html`</span><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;</span><span class="hl-11">chat-convo-models</span><span class="hl-1"> </span><span class="hl-12">:chosenModel</span><span class="hl-1">=</span><span class="hl-13">&quot;${x =&gt; x.chosenModel}&quot;</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">chat-convo-models</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><span class="hl-1">`)}</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;</span><span class="hl-11">h2</span><span class="hl-10">&gt;</span><span class="hl-1">${ x =&gt; x.chatContext ? x.chatContext.label : &#39;loading...&#39; }</span><span class="hl-10">&lt;/</span><span class="hl-11">h2</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;</span><span class="hl-11">h3</span><span class="hl-10">&gt;&lt;</span><span class="hl-11">strong</span><span class="hl-10">&gt;</span><span class="hl-1">${ x =&gt; x.messageList.length }</span><span class="hl-10">&lt;/</span><span class="hl-11">strong</span><span class="hl-10">&gt;</span><span class="hl-1"> messages in total</span><span class="hl-10">&lt;/</span><span class="hl-11">h3</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><span class="hl-1"> </span><br/><span class="hl-1"> </span><span class="hl-10">&lt;</span><span class="hl-11">fast-divider</span><span class="hl-10">&gt;&lt;/</span><span class="hl-11">fast-divider</span><span class="hl-10">&gt;</span><span class="hl-1"> </span><br/><span class="hl-1"> </span><span class="hl-10">&lt;/</span><span class="hl-11">header</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;</span><span class="hl-11">section</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-1"> </span><span class="hl-12">class</span><span class="hl-1">=</span><span class="hl-13">&quot;scroll-area&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;</span><span class="hl-11">div</span><span class="hl-1"> </span><span class="hl-12">class</span><span class="hl-1">=</span><span class="hl-13">&quot;scroll-content&quot;</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> ${T.repeat(x =&gt; x.messageList, (item, index) =&gt; T.html`</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;</span><span class="hl-11">chat-convo-message</span><span class="hl-1"> </span><span class="hl-12">:contentReturn</span><span class="hl-1">=</span><span class="hl-13">&quot;${item =&gt; item}&quot;</span><span class="hl-1"> </span><span class="hl-12">:item</span><span class="hl-1">=</span><span class="hl-13">&quot;${item =&gt; item}&quot;</span><span class="hl-10">/&gt;</span><br/><span class="hl-1"> `)} </span><br/><span class="hl-1"> </span><br/><span class="hl-1"> ${T.when(x =&gt; !x.messageList.length, (item, index) =&gt; T.html`</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;</span><span class="hl-11">p</span><span class="hl-1"> </span><span class="hl-12">class</span><span class="hl-1">=</span><span class="hl-13">&quot;no-chat&quot;</span><span class="hl-10">&gt;</span><span class="hl-1">No messages</span><span class="hl-10">&lt;/</span><span class="hl-11">p</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> `)} </span><br/><span class="hl-1"> </span><span class="hl-10">&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span><br/><span class="hl-1"> </span><span class="hl-10">&lt;/</span><span class="hl-11">section</span><span class="hl-10">&gt;</span><span class="hl-1"> </span><br/><br/><span class="hl-10">&lt;/</span><span class="hl-11">div</span><span class="hl-10">&gt;</span>
47
47
  </code><button>Copy</button></pre>
48
- <a id="md:application_initcomponentsts" class="tsd-anchor"></a><h3><a href="#md:application_initcomponentsts">application/_initComponents.ts</a></h3><pre><code class="language-typescript"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">ChatNav</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;../components/chat-nav/component&#39;</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">DefaultLayout</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;../components/default-layout/component&#39;</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">RWSIcon</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;../components/rws-icon/component&#39;</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">Loader</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;../components/loader/component&#39;</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">LineSplitter</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;../components/line-splitter/component&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">registerRWSComponents</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;rws-js-client&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">export</span><span class="hl-1"> </span><span class="hl-6">default</span><span class="hl-1"> () </span><span class="hl-5">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">LineSplitter</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-3">DefaultLayout</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-3">ChatNav</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-3">RWSIcon</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-3">Loader</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">registerRWSComponents</span><span class="hl-1">(); </span><span class="hl-8">//register rws components like &lt;rws-uploader&gt; and other comfy components</span><br/><span class="hl-1">}</span><br/>
48
+ <a id="md:application_initcomponentsts" class="tsd-anchor"></a><h3><a href="#md:application_initcomponentsts">application/_initComponents.ts</a></h3><pre><code class="language-typescript"><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">ChatNav</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;../components/chat-nav/component&#39;</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">DefaultLayout</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;../components/default-layout/component&#39;</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">RWSIcon</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;../components/rws-icon/component&#39;</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">Loader</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;../components/loader/component&#39;</span><span class="hl-1">;</span><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">LineSplitter</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;../components/line-splitter/component&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">import</span><span class="hl-1"> { </span><span class="hl-3">registerRWSComponents</span><span class="hl-1"> } </span><span class="hl-6">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@rws-framework/client&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">export</span><span class="hl-1"> </span><span class="hl-6">default</span><span class="hl-1"> () </span><span class="hl-5">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">LineSplitter</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-3">DefaultLayout</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-3">ChatNav</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-3">RWSIcon</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-3">Loader</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-0">registerRWSComponents</span><span class="hl-1">(); </span><span class="hl-8">//register rws components like &lt;rws-uploader&gt; and other comfy components</span><br/><span class="hl-1">}</span><br/>
49
49
  </code><button>Copy</button></pre>
50
50
  <pre><code class="language-typescript"><span class="hl-8">//index.ts</span><br/><br/><span class="hl-1"> </span><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-4">theClient</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">RWSClient</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><br/><span class="hl-1"> </span><span class="hl-3">theClient</span><span class="hl-1">.</span><span class="hl-0">addRoutes</span><span class="hl-1">(</span><span class="hl-3">routes</span><span class="hl-1">); </span><span class="hl-8">//routes are optional</span><br/><span class="hl-1"> </span><br/><span class="hl-1"> </span><span class="hl-3">theClient</span><span class="hl-1">.</span><span class="hl-0">onInit</span><span class="hl-1">(</span><span class="hl-5">async</span><span class="hl-1"> () </span><span class="hl-5">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">initComponents</span><span class="hl-1">(); </span><span class="hl-8">//user components from _initComponents.ts</span><br/><span class="hl-1"> </span><span class="hl-0">provideFASTDesignSystem</span><span class="hl-1">().</span><span class="hl-0">register</span><span class="hl-1">(</span><span class="hl-3">allComponents</span><span class="hl-1">); </span><span class="hl-8">// @microsoft/fast-components ready components init</span><br/><span class="hl-1"> }); </span><br/>
51
51
  </code><button>Copy</button></pre>
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@rws-framework/client",
3
3
  "private": false,
4
- "version": "2.0.14",
4
+ "version": "2.0.16",
5
5
  "main": "src/index.ts",
6
6
  "scripts": {
7
7
  "docs": "typedoc --tsconfig ./tsconfig.json"
@@ -103,7 +103,7 @@ const RWSWebpackWrapper = (config) => {
103
103
  const splitInfoJson = config.outputDir + '/rws_chunks_info.json'
104
104
  const automatedEntries = {};
105
105
 
106
- const foundRWSUserClasses = tools.findComponentFilesWithText(executionDir, '@RWSView', ['dist', 'node_modules', 'rws-js-client']);
106
+ const foundRWSUserClasses = tools.findComponentFilesWithText(executionDir, '@RWSView', ['dist', 'node_modules', '@rws-framework/client']);
107
107
  const foundRWSClientClasses = tools.findComponentFilesWithText(__dirname, '@RWSView', ['dist', 'node_modules']);
108
108
  let RWSComponents = [...foundRWSUserClasses, ...foundRWSClientClasses];
109
109
 
@@ -130,7 +130,7 @@ const RWSWebpackWrapper = (config) => {
130
130
  if (config.parted) {
131
131
  if (config.partedComponentsLocations) {
132
132
  config.partedComponentsLocations.forEach((componentDir) => {
133
- RWSComponents = [...RWSComponents, ...(tools.findComponentFilesWithText(path.resolve(componentDir), '@RWSView', ['dist', 'node_modules', 'rws-js-client']))];
133
+ RWSComponents = [...RWSComponents, ...(tools.findComponentFilesWithText(path.resolve(componentDir), '@RWSView', ['dist', 'node_modules', '@rws-framework/client']))];
134
134
  });
135
135
  }
136
136
 
@@ -237,7 +237,7 @@ const RWSWebpackWrapper = (config) => {
237
237
  loader: path.resolve(__dirname, './webpack/rws_fast_ts_loader.js'),
238
238
  }
239
239
  ],
240
- exclude: /node_modules\/(?!rws-js-client)/,
240
+ exclude: /node_modules\/(?!\@rws-framework\/client)/,
241
241
  }
242
242
  ],
243
243
  },
@@ -14,8 +14,8 @@
14
14
  "allowSyntheticDefaultImports": true,
15
15
  "lib": ["DOM", "ESNext", "WebWorker"],
16
16
  "paths": {
17
- // "rws-js-client/*": ["../*"],
18
- // "rws-js-client": ["../index"],
17
+ // "@rws-framework/client/*": ["../*"],
18
+ // "@rws-framework/client": ["../index"],
19
19
  }
20
20
  }
21
21
  }
@@ -1,18 +1,18 @@
1
1
  const path = require('path');
2
2
  const webpack = require('webpack');
3
- const tools = require('rws-js-client/_tools');
3
+ const tools = require('@rws-framework/client/_tools');
4
4
  const gThis = require.resolve('globalthis')
5
- const {rwsExternals} = require('rws-js-client/_rws_externals');
5
+ const {rwsExternals} = require('@rws-framework/client/_rws_externals');
6
6
 
7
7
 
8
8
  const executionDir = process.cwd();
9
9
  const rootPackageNodeModules = path.resolve(tools.findRootWorkspacePath(process.cwd()), 'node_modules');
10
10
 
11
11
  const mergeCodeBaseOptions = {
12
- incl: ['rws-js-client/src/services'],
12
+ incl: ['@rws-framework/client/src/services'],
13
13
  not_incl: ['./services/RoutingService'],
14
14
  exceptions_context: ['socket.io-', '@socket.io'],
15
- exceptions: ['rws-js-client/src/services', './service', './ws_handlers', 'socket.io-', '@socket.io','uuid',]
15
+ exceptions: ['@rws-framework/client/src/services', './service', './ws_handlers', 'socket.io-', '@socket.io','uuid',]
16
16
  };
17
17
 
18
18
  module.exports = {
@@ -30,8 +30,8 @@ module.exports = {
30
30
  document: false,
31
31
  globalThis: gThis,
32
32
  '@cwd' : process.cwd(),
33
- // 'rws-js-client': path.resolve(__dirname, '..') + '/index.ts',
34
- // 'rws-js-client/*': path.resolve(__dirname, '..', '..')
33
+ // '@rws-framework/client': path.resolve(__dirname, '..') + '/index.ts',
34
+ // '@rws-framework/client/*': path.resolve(__dirname, '..', '..')
35
35
  }
36
36
  },
37
37
  plugins: [
@@ -1,4 +1,4 @@
1
- import RWSService from 'rws-js-client/src/services/_service';
1
+ import RWSService from '@rws-framework/client/src/services/_service';
2
2
 
3
3
 
4
4
  class ServiceWorkerService extends RWSService {