chore(release): 6.2.1 [skip ci]

## [6.2.1](https://git.datacontroller.io/dc/dc/compare/v6.2.0...v6.2.1) (2023-10-09)

### Bug Fixes

* approve, history and submit pages grouped in review module ([e056ece](e056ece223))
* closes [#39](#39) upcase issue in MPE_SECURITY ([a00d31c](a00d31caf3))
* handsontable v13 ([6f482ec](6f482ec6d9))
* latest adapter ([5e30dc0](5e30dc0f89))
* sasjs/cli and sasjs/core updated to the latest ([8571e01](8571e01e44))
* updating editors/stagedata to address issues in particular viya configurations as described in issue [#33](#33) ([94ab949](94ab949df8))
* updating logic for REPLACE loadtype ([1f2ce55](1f2ce55f24))

.gitea/workflows/build.yaml

@@ -18,4 +18,8 @@ jobs:
         env:
           NPMRC: ${{ secrets.NPMRC}}
 
-      - run: npm run lint:check
+      - run: npm run lint:check
+      - run: |
+          cd client
+          npm ci
+          npm run license-checker

.gitea/workflows/development-test.yaml

@@ -21,10 +21,11 @@ jobs:
          echo '${{ secrets.NPMRC}}' > client/.npmrc
 
       - name: Install Chrome for Angular tests
-        run: apt-get update
-        run: wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
-        run: apt install -y ./google-chrome*.deb;
-        run: export CHROME_BIN=/usr/bin/google-chrome
+        run: |
+          apt-get update
+          wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
+          apt install -y ./google-chrome*.deb;
+          export CHROME_BIN=/usr/bin/google-chrome
 
       - name: Write cypress credentials
         run: echo "$CYPRESS_CREDS" > ./client/cypress.env.json

.gitea/workflows/release.yaml

@@ -48,7 +48,7 @@ jobs:
         description: Compile SAS 9 services, remove tests & create deployment program
         run: |
           cd sas
-          npm ci
+          npm i
           sasjs c -t sas9
           rm -rf sasjsbuild/tests
           sasjs b -t sas9
@@ -97,8 +97,8 @@ jobs:
         run: |
           cd client
           npm -g install cloudron-surfer
-          npm run typedoc
-          surfer put --token ${{ secrets.TSDOC_TOKEN }} --server tsdoc.datacontroller.io ../tsdoc /
+          npm run compodoc:build
+          surfer put --token ${{ secrets.TSDOC_TOKEN }} --server webdoc.datacontroller.io documentation/* /
 
       - name: Upload assets to release
         run: |

.gitignore

@@ -10,6 +10,7 @@ client/src/environments/version.ts
 client/cypress/screenshots
 client/cypress/results
 client/cypress/videos
+client/documentation
 cypress.env.json
 sasjsbuild
 sasjsresults

.npmrc

@@ -1 +1 @@
-legacy-peer-deps=false
+legacy-peer-deps=true

CHANGELOG.md

@@ -1,14 +1,15 @@
-# [6.2.0](https://git.datacontroller.io/dc/dc/compare/v6.1.0...v6.2.0) (2023-08-24)
+## [6.2.1](https://git.datacontroller.io/dc/dc/compare/v6.2.0...v6.2.1) (2023-10-09)
 
 
 ### Bug Fixes
 
-* re-enabling full REPLACE uploads ([08e39c4](https://git.datacontroller.io/dc/dc/commit/08e39c4fca570406f9aad3d907cb04596421d074))
-
-
-### Features
-
-* support for European numeric formats ([e48e47b](https://git.datacontroller.io/dc/dc/commit/e48e47bc635452b59e107b235e597c26e748875e))
+* approve, history and submit pages grouped in review module ([e056ece](https://git.datacontroller.io/dc/dc/commit/e056ece2234ef6aab050f6a5b1f8de633b163d91))
+* closes [#39](https://git.datacontroller.io/dc/dc/issues/39) upcase issue in MPE_SECURITY ([a00d31c](https://git.datacontroller.io/dc/dc/commit/a00d31caf3c5634cd61a4700fb175e76856edbb6))
+* handsontable v13 ([6f482ec](https://git.datacontroller.io/dc/dc/commit/6f482ec6d909907a304ef9975262889e2370035f))
+* latest adapter ([5e30dc0](https://git.datacontroller.io/dc/dc/commit/5e30dc0f892fab2af41f4ea56e30f27ec3b3912e))
+* sasjs/cli and sasjs/core updated to the latest ([8571e01](https://git.datacontroller.io/dc/dc/commit/8571e01e44a8cb6df9d150d271c34bb75bffdf31))
+* updating editors/stagedata to address issues in particular viya configurations as described in issue [#33](https://git.datacontroller.io/dc/dc/issues/33) ([94ab949](https://git.datacontroller.io/dc/dc/commit/94ab949df8c75072525751a2156b7a32c2e641dc))
+* updating logic for REPLACE loadtype ([1f2ce55](https://git.datacontroller.io/dc/dc/commit/1f2ce55f249f4af56f0cacdec47e69246cd47431))
 
 # [6.2.0](https://git.datacontroller.io/dc/dc/compare/v6.1.0...v6.2.0) (2023-08-24)
 
@@ -17,7 +18,6 @@
 
 * re-enabling full REPLACE uploads ([08e39c4](https://git.datacontroller.io/dc/dc/commit/08e39c4fca570406f9aad3d907cb04596421d074))
 
-
 ### Features
 
 * support for European numeric formats ([e48e47b](https://git.datacontroller.io/dc/dc/commit/e48e47bc635452b59e107b235e597c26e748875e))

client/licenseChecker.js

@@ -10,7 +10,7 @@ const check = (cwd) => {
         onlyAllow:
           'AFLv2.1;Apache 2.0;Apache-2.0;Apache*;Artistic-2.0;0BSD;BSD*;BSD-2-Clause;BSD-3-Clause;CC0-1.0;CC-BY-3.0;CC-BY-4.0;ISC;MIT;MPL-2.0;ODC-By-1.0;Python-2.0;Unlicense;',
         excludePackages:
-          '@cds/city@1.1.0;@handsontable/angular@13.0.0;handsontable@13.0.0;hyperformula@2.5.0;jackspeak@2.2.0;path-scurry@1.7.0'
+          '@cds/city@1.1.0;@handsontable/angular@13.1.0;handsontable@13.1.0;hyperformula@2.5.0;jackspeak@2.2.0;path-scurry@1.7.0'
       },
       (error, json) => {
         if (error) {

client/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "dc-client",
-  "description": "dc-client",
+  "name": "data_controller-client",
+  "description": "DataController Client",
   "angular-cli": {},
   "scripts": {
     "start": "node --max_old_space_size=4096 node_modules/@angular/cli/bin/ng serve",
@@ -29,7 +29,9 @@
     "cy:run": "cypress run",
     "audit:prod": "npm audit --omit=dev",
     "sasdocs": "sasjs doc && ./sasjs/utils/deploydocs.sh",
-    "typedoc": "typedoc --options typedoc.json && cd ../tsdoc"
+    "compodoc:build": "compodoc -p tsconfig.doc.json --name 'Data Controller Client'",
+    "compodoc:build-and-serve": "compodoc -p tsconfig.doc.json -s --name 'Data Controller Client'",
+    "compodoc:serve": "compodoc -s --name 'Data Controller Client'"
   },
   "private": true,
   "dependencies": {
@@ -46,9 +48,9 @@
     "@clr/angular": "^13.17.0",
     "@clr/icons": "^13.0.2",
     "@clr/ui": "^13.17.0",
-    "@handsontable/angular": "^13.0.0",
-    "@sasjs/adapter": "4.3.6",
-    "@sasjs/utils": "^3.3.0",
+    "@handsontable/angular": "^13.1.0",
+    "@sasjs/adapter": "4.10.1",
+    "@sasjs/utils": "^3.4.0",
     "@sheet/crypto": "1.20211122.1",
     "@types/d3-graphviz": "^2.6.7",
     "@types/text-encoding": "0.0.35",
@@ -58,7 +60,7 @@
     "crypto-js": "^3.3.0",
     "d3-graphviz": "^5.0.2",
     "fs-extra": "^7.0.1",
-    "handsontable": "^13.0.0",
+    "handsontable": "^13.1.0",
     "https-browserify": "1.0.0",
     "hyperformula": "^2.5.0",
     "iconv-lite": "^0.5.0",
@@ -87,6 +89,8 @@
     "@angular-eslint/template-parser": "16.0.3",
     "@angular/cli": "^16.1.0",
     "@angular/compiler-cli": "^16.1.2",
+    "@babel/plugin-proposal-private-methods": "^7.18.6",
+    "@compodoc/compodoc": "^1.1.21",
     "@cypress/webpack-preprocessor": "^5.17.1",
     "@types/core-js": "^2.5.5",
     "@types/crypto-js": "^4.0.1",
@@ -119,9 +123,10 @@
     "rimraf": "3.0.2",
     "ts-loader": "^9.2.8",
     "ts-node": "^3.3.0",
-    "typedoc": "^0.23.24",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-external-module-name": "^4.0.6",
     "typescript": "~4.9.4",
     "wait-on": "^6.0.1",
     "watch": "^1.0.2"
   }
-}
+}

client/src/app/_globals.ts

@@ -1,5 +1,8 @@
 import { QueryClause } from './models/TableData'
 
+/**
+ * Filtering cache info, to be reused when filtering modal is re-open
+ */
 interface FilterCache {
   cols: any[]
   vals: any[]
@@ -10,12 +13,18 @@ interface FilterCache {
   query: QueryClause[]
 }
 
+/**
+ * Filtering cache info in the open viewboxes, to be reused when filtering modal is re-open
+ */
 interface ViewboxCache {
   [key: number]: {
     filter: FilterCache
   }
 }
 
+/**
+ * Initial values when no cached values stored
+ */
 export const initFilter: { filter: FilterCache } = {
   filter: {
     cols: <any[]>[],
@@ -28,6 +37,13 @@ export const initFilter: { filter: FilterCache } = {
   }
 }
 
+/**
+ * Cached filtering values across whole app (editor, viewer, viewboxes)
+ * Cached lineage libraries, tables
+ * Cached metadata tree
+ * Cached usernav tree
+ * Cached viyaApi collections, search and selected endpoint
+ */
 export const globals: {
   rootParam: string
   editor: any

client/src/app/actions/actions.component.html

@@ -1,40 +0,0 @@
-<div class="content-area">
-  <div class="card">
-    <div class="card-header d-flex flex-column justify-content-center">
-      <h3 class="text-center">
-        You succesfully edited table
-        <span class="color-blue font-weight-700">{{ libds }}</span>
-      </h3>
-      <p class="text-center">
-        <b>Please choose from the following actions</b>
-      </p>
-      <div class="row d-flex justify-content-center mt-20">
-        <button
-          class="btn btn-sm btn-outline text-center"
-          (click)="submittedTableScreen()"
-        >
-          Go to submitted table screen
-        </button>
-        <button
-          class="btn btn-sm btn-outline text-center"
-          (click)="viewerTableScreen()"
-        >
-          Go to base table screen
-        </button>
-        <button
-          id="approvalBtn"
-          class="btn btn-sm btn-success-outline text-center"
-          (click)="approveTableScreen()"
-        >
-          Go to approvals screen
-        </button>
-        <button
-          class="btn btn-sm btn-info-outline text-center"
-          (click)="goBack()"
-        >
-          Go back to editor
-        </button>
-      </div>
-    </div>
-  </div>
-</div>

client/src/app/actions/actions.component.ts

@@ -1,50 +0,0 @@
-import { AfterViewInit, Component, OnInit } from '@angular/core'
-import { ActivatedRoute, Router } from '@angular/router'
-
-@Component({
-  selector: 'app-actions',
-  templateUrl: './actions.component.html',
-  styleUrls: ['./actions.component.scss'],
-  host: {
-    class: 'content-container'
-  }
-})
-export class ActionsComponent implements OnInit, AfterViewInit {
-  public dsid: any
-  public libds: string | undefined
-
-  constructor(
-    private route: ActivatedRoute,
-    private router: Router
-  ) {}
-
-  public submittedTableScreen() {
-    this.router.navigateByUrl('/stage/' + this.dsid)
-  }
-
-  public approveTableScreen() {
-    this.router.navigateByUrl('/approve/approveDet/' + this.dsid)
-  }
-
-  public viewerTableScreen() {
-    this.router.navigateByUrl('/view/data/' + this.libds)
-  }
-
-  public goBack() {
-    this.router.navigateByUrl('/editor/' + this.libds)
-  }
-
-  async ngOnInit() {
-    this.dsid = this.route.snapshot.params['dsid']
-    this.libds = this.route.snapshot.params['libds']
-  }
-
-  ngAfterViewInit() {
-    setTimeout(() => {
-      let approvalBtn: any = window.document.getElementById('approvalBtn')
-      if (!!approvalBtn) {
-        approvalBtn.focus()
-      }
-    }, 700)
-  }
-}

client/src/app/app.component.html

@@ -169,7 +169,7 @@
           <clr-dropdown-menu *clrIfOpen clrPosition="bottom-left">
             <a [routerLink]="['/view']" clrDropdownItem>VIEW</a>
             <a [routerLink]="['/home']" clrDropdownItem>EDIT</a>
-            <a [routerLink]="['/submitted']" clrDropdownItem>REVIEW</a>
+            <a [routerLink]="['/review/submitted']" clrDropdownItem>REVIEW</a>
           </clr-dropdown-menu>
         </clr-dropdown>
       </div>
@@ -192,7 +192,7 @@
           >EDIT</a
         >
         <a
-          [routerLink]="['/submitted']"
+          [routerLink]="['/review/submitted']"
           [class.active]="
             router.url.includes('submitted') ||
             router.url.includes('approve') ||
@@ -224,7 +224,7 @@
     <ul class="nav">
       <li class="nav-item">
         <a
-          [routerLink]="['/submitted']"
+          [routerLink]="['/review/submitted']"
           class="nav-link nav-text"
           routerLinkActive="active"
           >SUBMIT</a
@@ -232,15 +232,16 @@
       </li>
       <li class="nav-item">
         <a
-          [routerLink]="['/approve']"
+          [routerLink]="['/review/approve']"
           class="nav-link nav-text"
+          [class.active]="router.url.includes('approve')"
           routerLinkActive="active"
           >APPROVE</a
         >
       </li>
       <li class="nav-item">
         <a
-          [routerLink]="['/history']"
+          [routerLink]="['/review/history']"
           class="nav-link nav-text"
           routerLinkActive="active"
           >HISTORY</a

client/src/app/app.component.ts

@@ -57,24 +57,15 @@ export class AppComponent {
     private elementRef: ElementRef
   ) {
     this.parseDcAdapterSettings()
+
+    /**
+     * Prints app info in the console such as:
+     * - Adapter versions
+     * - App version
+     * - Build timestamp
+     *
+     */
     ;(window as any).appinfo = () => {
-      const licenseKeyData = this.licenceService.getLicenseKeyData()
-
-      if (licenseKeyData) {
-        const expiry_date = moment(
-          licenseKeyData.valid_until,
-          'YYYY-MM-DD'
-        ).startOf('day')
-        const current_date = moment().startOf('day')
-        const daysToExpiry = expiry_date.diff(current_date, 'days')
-
-        licenseKeyData.valid_until += ` (${daysToExpiry} ${
-          daysToExpiry === 1 ? 'day' : 'days'
-        } remaining)`
-
-        if (isNaN(daysToExpiry)) licenseKeyData.valid_until = 'Unlimited'
-      }
-
       console.table({
         'Adapter version': VERSION.adapterVersion || 'n/a',
         'App version': (VERSION.tag || '').replace('v', ''),
@@ -87,7 +78,12 @@ export class AppComponent {
 
     this.subscribeToLicenseEvents()
 
+    /**
+     * Fetches git tag ang git hash from `version.ts` file
+     * It's placed in the user drop down.
+     */
     this.commitVer = (VERSION.tag || '').replace('v', '') + '.' + VERSION.hash
+
     router.events.subscribe((val) => {
       this.routeUrl = this.router.url
 
@@ -127,8 +123,10 @@ export class AppComponent {
     this.subscribeToAppActive()
     this.subscribeToDemoLimitModal()
 
-    /* In Viya streaming apps, content is served within an iframe.  This code
-      makes that iframe "full screen" so it looks like a regular window. */
+    /**
+     * In Viya streaming apps, content is served within an iframe.  This code
+     * makes that iframe "full screen" so it looks like a regular window.
+     */
     if (window.frameElement) {
       window.frameElement.setAttribute(
         'style',
@@ -143,6 +141,9 @@ export class AppComponent {
     }
   }
 
+  /**
+   * Parses adapter settings that are found in the <sasjs> tag inside index.html
+   */
   private parseDcAdapterSettings() {
     const sasjsElement = document.querySelector('sasjs')
 
@@ -180,9 +181,14 @@ export class AppComponent {
     this.appService.sasServiceInit()
   }
 
+  /**
+   * Opens licence page with the active licence problem
+   * Problem details are encoded in the url
+   */
   public licenceProblemDetails(url: string) {
     this.router.navigateByUrl(url)
   }
+
   /**
    * Based on string provided we return true, false or null
    * True -> Compute API
@@ -199,6 +205,12 @@ export class AppComponent {
     return value === 'true' || false
   }
 
+  /**
+   * Listens for an `demo limit` event that will show the `Feature locked modal`
+   * For exmaple when in editor upload feature is not enabled
+   * When user tries to upload the excel, editor component will trgger this event
+   * And stop the execution of file upload code.
+   */
   public subscribeToDemoLimitModal() {
     this.eventService.onDemoLimitModalShow.subscribe((featureName: string) => {
       this.demoLimitNotice = {
@@ -208,6 +220,10 @@ export class AppComponent {
     })
   }
 
+  /**
+   * Listens for licence events so banner can be displayed.
+   * App is free tier, licence will expire, is expired or is invalid
+   */
   public subscribeToLicenseEvents() {
     this.licenceService.isAppFreeTier.subscribe((isAppFreeTier: boolean) => {
       this.freeTierBanner = isAppFreeTier
@@ -227,6 +243,10 @@ export class AppComponent {
     )
   }
 
+  /**
+   * Listens for an event that will activate od deactivate full application.
+   * Based on licence key prcoessing result
+   */
   public subscribeToAppActive() {
     this.licenceService.isAppActivated.subscribe((value: any) => {
       this.appActive = value
@@ -248,31 +268,51 @@ export class AppComponent {
     })
   }
 
+  /**
+   * When startupservice request is finished with valid response, this event will
+   * make sure loading screen is gone.
+   */
   public subscribeToStartupData() {
     this.eventService.onStartupDataLoaded.subscribe(() => {
       this.startupDataLoaded = true
     })
   }
 
+  /**
+   * Opens requests modal when requested from event service
+   */
   public subscribeToRequestsModal() {
     this.eventService.onRequestsModalOpen.subscribe((value: boolean) => {
       this.requestsModal = true
     })
   }
 
+  /**
+   * Closes abort modal with matching ID (there could be multiple abort modals open)
+   */
   public closeAbortModal(abortId: number) {
     let abortIndex = this.sasjsAborts.findIndex((abort) => abort.id === abortId)
     this.sasjsAborts.splice(abortIndex, 1)
   }
 
+  /**
+   * Toggles sidebar when requested from event service
+   */
   public toggleSidebar() {
     this.eventService.toggleSidebar()
   }
 
+  /**
+   * Whether or not current route includes the route from param
+   * @param route route to check
+   */
   public isMainRoute(route: string): boolean {
     return this.router.url.includes(route)
   }
 
+  /**
+   * Opens a page for updating the licence.
+   */
   public openLicencingPage() {
     this.router.navigateByUrl('/licensing/update')
   }

client/src/app/app.module.ts

@@ -11,33 +11,16 @@ import { NotFoundComponent } from './not-found/not-found.component'
 
 import { SasStoreService } from './services/sas-store.service'
 import { SharedModule } from './shared/shared.module'
-// import { EditorComponent } from './editor/editor.component'
-import { ActionsComponent } from './actions/actions.component'
+
 import { AppSharedModule } from './app-shared.module'
-import { ApproveDetailsComponent } from './approve-details/approve-details.component'
-import { ApproveComponent } from './approve/approve.component'
-import { DeployComponent } from './deploy/deploy.component'
-import { AutomaticComponent } from './deploy/sections/automatic/automatic.component'
-import { ManualComponent } from './deploy/sections/manual/manual.component'
-import { SasjsConfiguratorComponent } from './deploy/sections/sasjs-configurator/sasjs-configurator.component'
-import { GroupComponent } from './group/group.component'
-import { HistoryComponent } from './history/history.component'
-import { LicensingComponent } from './licensing/licensing.component'
-import { LineageComponent } from './lineage/lineage.component'
-import { MetadataComponent } from './metadata/metadata.component'
 import { PipesModule } from './pipes/pipes.module'
-import { RoleComponent } from './role/role.component'
-import { ApproveRouteComponent } from './routes/approve-route/approve-route.component'
-import { HistoryRouteComponent } from './routes/history-route/history-route.component'
+import { ReviewRouteComponent } from './routes/review-route/review-route.component'
 import { LicensingGuard } from './routes/licensing.guard'
 import { UsernavRouteComponent } from './routes/usernav-route/usernav-route.component'
 import { AppService } from './services/app.service'
 import { InfoModalComponent } from './shared/abort-modal/info-modal.component'
 import { RequestsModalComponent } from './shared/requests-modal/requests-modal.component'
-import { SubmitterComponent } from './submitter/submitter.component'
-import { UserComponent } from './user/user.component'
 import { HomeModule } from './home/home.module'
-import { SystemComponent } from './system/system.component'
 import { DirectivesModule } from './directives/directives.module'
 import { ViyaApiExplorerComponent } from './viya-api-explorer/viya-api-explorer.component'
 import { NgxJsonViewerModule } from 'ngx-json-viewer'
@@ -46,27 +29,11 @@ import { NgxJsonViewerModule } from 'ngx-json-viewer'
   declarations: [
     AppComponent,
     NotFoundComponent,
-    ApproveComponent,
-    ApproveDetailsComponent,
-    ActionsComponent,
-    HistoryComponent,
-    LineageComponent,
-    SubmitterComponent,
-    ApproveRouteComponent,
-    HistoryRouteComponent,
-    MetadataComponent,
+    ReviewRouteComponent,
+    ReviewRouteComponent,
     UsernavRouteComponent,
-    UserComponent,
-    GroupComponent,
-    RoleComponent,
     RequestsModalComponent,
-    DeployComponent,
     InfoModalComponent,
-    LicensingComponent,
-    ManualComponent,
-    AutomaticComponent,
-    SasjsConfiguratorComponent,
-    SystemComponent,
     ViyaApiExplorerComponent
   ],
   imports: [
@@ -84,7 +51,7 @@ import { NgxJsonViewerModule } from 'ngx-json-viewer'
     DirectivesModule,
     NgxJsonViewerModule
   ],
-  providers: [AppService, SasStoreService, ApproveComponent, LicensingGuard],
+  providers: [AppService, SasStoreService, LicensingGuard],
   bootstrap: [AppComponent]
 })
 export class AppModule {}

client/src/app/app.routing.ts

@@ -7,22 +7,20 @@ import { ModuleWithProviders } from '@angular/core'
 import { Routes, RouterModule } from '@angular/router'
 
 import { HomeComponent } from './home/home.component'
-import { ApproveComponent } from './approve/approve.component'
-import { ApproveDetailsComponent } from './approve-details/approve-details.component'
-import { ActionsComponent } from './actions/actions.component'
-import { HistoryComponent } from './history/history.component'
 import { NotFoundComponent } from './not-found/not-found.component'
-import { SubmitterComponent } from './submitter/submitter.component'
 
-import { ApproveRouteComponent } from './routes/approve-route/approve-route.component'
-import { DeployComponent } from './deploy/deploy.component'
-import { LicensingComponent } from './licensing/licensing.component'
-import { LicensingGuard } from './routes/licensing.guard'
+import { ReviewRouteComponent } from './routes/review-route/review-route.component'
 import { StageModule } from './stage/stage.module'
 import { EditorModule } from './editor/editor.module'
 import { ViewerModule } from './viewer/viewer.module'
-import { SystemComponent } from './system/system.component'
+import { ReviewModule } from './review/review.module'
+import { DeployModule } from './deploy/deploy.module'
+import { LicensingModule } from './licensing/licensing.module'
+import { SystemModule } from './system/system.module'
 
+/**
+ * Defining routes
+ */
 export const ROUTES: Routes = [
   { path: '', redirectTo: 'home', pathMatch: 'full' },
   {
@@ -30,23 +28,28 @@ export const ROUTES: Routes = [
     loadChildren: () => ViewerModule
   },
   {
-    path: 'approve',
-    component: ApproveRouteComponent,
+    /**
+     * Load review module (approve, history, submitted)
+     */
+    path: 'review',
+    component: ReviewRouteComponent,
     children: [
       { path: '', pathMatch: 'full', redirectTo: 'toapprove' },
-      { path: 'toapprove', component: ApproveComponent },
-      { path: 'approveDet/:tableId', component: ApproveDetailsComponent },
-      { path: 'submitted', component: SubmitterComponent }
+      {
+        path: '',
+        loadChildren: () => ReviewModule
+      }
     ]
   },
   {
-    path: 'licensing/:action',
-    component: LicensingComponent,
-    canActivate: [LicensingGuard],
-    canDeactivate: [LicensingGuard]
+    path: 'licensing',
+    loadChildren: () => LicensingModule
   },
   { path: 'home', component: HomeComponent },
   {
+    /**
+     * Load editor module with subroutes
+     */
     path: 'editor',
     loadChildren: () => EditorModule
   },
@@ -54,16 +57,20 @@ export const ROUTES: Routes = [
     path: 'stage',
     loadChildren: () => StageModule
   },
-  { path: 'system', component: SystemComponent },
-  { path: 'actions/:libds/:dsid', component: ActionsComponent },
-  { path: 'history', component: HistoryComponent },
-  { path: 'submitted', component: SubmitterComponent },
-  { path: 'submitted/:tableId', component: SubmitterComponent },
-  { path: 'deploy', component: DeployComponent },
-  { path: 'deploy/manualdeploy', component: DeployComponent },
+  {
+    path: 'system',
+    loadChildren: () => SystemModule
+  },
+  {
+    path: 'deploy',
+    loadChildren: () => DeployModule
+  },
   { path: '**', component: NotFoundComponent }
 ]
 
+/**
+ * Exporting routes
+ */
 export const ROUTING: ModuleWithProviders<RouterModule> = RouterModule.forRoot(
   ROUTES,
   { useHash: true }

client/src/app/deploy/deploy-routing.module.ts

@@ -0,0 +1,14 @@
+import { NgModule } from '@angular/core'
+import { RouterModule, Routes } from '@angular/router'
+import { DeployComponent } from './deploy.component'
+
+const routes: Routes = [
+  { path: '', component: DeployComponent },
+  { path: 'manualdeploy', component: DeployComponent }
+]
+
+@NgModule({
+  imports: [RouterModule.forChild(routes)],
+  exports: [RouterModule]
+})
+export class DeployRoutingModule {}

client/src/app/deploy/deploy.component.ts

@@ -78,6 +78,9 @@ export class DeployComponent implements OnInit {
     this.setDeployDefaults()
   }
 
+  /**
+   * Setting default values used for deploy request
+   */
   public setDeployDefaults() {
     this.dcPath = this.dcAdapterSettings?.dcPath || ''
     this.selectedAdminGroup = this.dcAdapterSettings?.adminGroup || ''
@@ -86,6 +89,9 @@ export class DeployComponent implements OnInit {
     }
   }
 
+  /**
+   * Accepting terms of service shows next screen
+   */
   public termsAgreeChange() {
     if (!this.autodeploy) {
       this.getAdminGroups()
@@ -94,6 +100,9 @@ export class DeployComponent implements OnInit {
     this.step++
   }
 
+  /**
+   * Fetches admin groups from VIYA to be selected for a backend deploy
+   */
   public getAdminGroups() {
     fetch(
       this.sasJsConfig.serverUrl + '/identities/groups?sortBy=name&limit=5000',

client/src/app/deploy/deploy.module.ts

@@ -0,0 +1,20 @@
+import { NgModule } from '@angular/core'
+import { CommonModule } from '@angular/common'
+import { DeployComponent } from './deploy.component'
+import { AutomaticComponent } from './sections/automatic/automatic.component'
+import { ManualComponent } from './sections/manual/manual.component'
+import { SasjsConfiguratorComponent } from './sections/sasjs-configurator/sasjs-configurator.component'
+import { ClarityModule } from '@clr/angular'
+import { FormsModule } from '@angular/forms'
+import { DeployRoutingModule } from './deploy-routing.module'
+
+@NgModule({
+  declarations: [
+    DeployComponent,
+    AutomaticComponent,
+    ManualComponent,
+    SasjsConfiguratorComponent
+  ],
+  imports: [CommonModule, FormsModule, ClarityModule, DeployRoutingModule]
+})
+export class DeployModule {}

client/src/app/deploy/sections/automatic/automatic.component.ts

@@ -55,6 +55,13 @@ export class AutomaticComponent implements OnInit {
 
   ngOnInit(): void {}
 
+  /**
+   * Executes sas.json file to deploy the backend
+   * Method will first try to run the `auto deploy`
+   * If that fails the rest of the code is ignored.
+   * If request is successfull, method will continue to try
+   * to create database if checkbox is toggled on
+   */
   public async executeJson() {
     this.autodeploying = true
     this.isSubmittingJson = true
@@ -99,6 +106,9 @@ export class AutomaticComponent implements OnInit {
     }
   }
 
+  /**
+   * Runs the `makedata` request sending the ADMIN and DCPATH values
+   */
   public createDatabase() {
     let data = {
       fromjs: [

client/src/app/deploy/sections/manual/manual.component.ts

@@ -52,6 +52,9 @@ export class ManualComponent implements OnInit {
 
   ngOnInit(): void {}
 
+  /**
+   * FIXME: Remove
+   */
   public async executableContext() {
     // getExecutableContexts now need AuthConfig parameter which we don't have on web
     // this.contextsLoading = true
@@ -65,10 +68,16 @@ export class ManualComponent implements OnInit {
     // this.contextsLoading = false
   }
 
+  /**
+   * Removes sas.json file attached to the input
+   */
   public clearUploadInput(event: Event) {
     this.deployService.clearUploadInput(event)
   }
 
+  /**
+   * Reads attached SAS file to be sent to sas for execution (backend deploy)
+   */
   public onSasFileChange(event: any) {
     this.preloadedFile = false
 
@@ -93,12 +102,18 @@ export class ManualComponent implements OnInit {
     fileReader.readAsText(file)
   }
 
+  /**
+   * Reads attached JSON file to be sent to sas for execution (backend deploy)
+   */
   public async onJsonFileChange(event: any) {
     let file = event.target.files[0]
 
     this.jsonFile = await this.deployService.readFile(file)
   }
 
+  /**
+   * Appending precode lines to the attached sas or json file for backend deploy
+   */
   public addPrecodeLines() {
     let headerLines = [
       `%let context=${this.selectedContext};`,
@@ -110,6 +125,9 @@ export class ManualComponent implements OnInit {
     this.linesOfCode.unshift(...headerLines)
   }
 
+  /**
+   * Downloadng file with precode included
+   */
   public downloadSasPrecodeFile() {
     let linesAsText = this.linesOfCode.join('\n')
     let filename = this.fileName.split('.')[0]
@@ -117,6 +135,9 @@ export class ManualComponent implements OnInit {
     this.downloadFile(linesAsText, filename, 'sas')
   }
 
+  /**
+   * Used for downloading log and repsonse as a file
+   */
   public downloadFile(
     content: any,
     filename: string,
@@ -125,10 +146,17 @@ export class ManualComponent implements OnInit {
     this.deployService.downloadFile(content, filename, extension)
   }