[PM-6780][PM-6781] Create vault-export-ui package / Migrate export-scope-callout.component to CL (#8318)

* PM-6780 - Create vault-export-ui package * Migrate export-scope-callout to CL - Move export-scope-callout.component to vault-export-UI - Use bit-callout instead of app-callout - Make component standalone - Remove from jslib.module - Prefix selector with team-name - Export it from vault-export-ui * Update usage of tools-export-scope-callout for desktop * Update usage of tools-export-scope-callout for web * Update usage of tools-export-scope-callout for browser * Change package description --------- Co-authored-by: Daniel James Smith <djsmith85@users.noreply.github.com>
2024-03-20 23:11:57 +01:00 · 2024-03-20 23:11:57 +01:00 · c6327d7f12
parent eedf00e215
commit c6327d7f12
24 changed files with 92 additions and 12 deletions
--- a/.eslintrc.json
+++ b/.eslintrc.json
@ -191,6 +191,15 @@
        ]
      }
    },
+    {
+      "files": ["libs/tools/export/vault-export/vault-export-ui/src/**/*.ts"],
+      "rules": {
+        "no-restricted-imports": [
+          "error",
+          { "patterns": ["@bitwarden/vault-export-ui/*", "src/**/*"] }
+        ]
+      }
+    },
    {
      "files": ["libs/importer/src/**/*.ts"],
      "rules": {
--- a/apps/browser/src/popup/app.module.ts
+++ b/apps/browser/src/popup/app.module.ts
@ -16,6 +16,7 @@ import { JslibModule } from "@bitwarden/angular/jslib.module";
 import { ColorPasswordCountPipe } from "@bitwarden/angular/pipes/color-password-count.pipe";
 import { ColorPasswordPipe } from "@bitwarden/angular/pipes/color-password.pipe";
 import { AvatarModule, ButtonModule } from "@bitwarden/components";
+import { ExportScopeCalloutComponent } from "@bitwarden/vault-export-ui";

 import { AccountSwitcherComponent } from "../auth/popup/account-switching/account-switcher.component";
 import { AccountComponent } from "../auth/popup/account-switching/account.component";
@ -107,6 +108,7 @@ import "../platform/popup/locales";
    AvatarModule,
    AccountComponent,
    ButtonModule,
+    ExportScopeCalloutComponent,
  ],
  declarations: [
    ActionButtonsComponent,
--- a/apps/browser/src/tools/popup/settings/export.component.html
+++ b/apps/browser/src/tools/popup/settings/export.component.html
@ -19,7 +19,7 @@
    <app-callout type="warning" title="{{ 'vaultExportDisabled' | i18n }}" *ngIf="disabledByPolicy">
      {{ "personalVaultExportPolicyInEffect" | i18n }}
    </app-callout>
-    <app-export-scope-callout *ngIf="!disabledByPolicy"></app-export-scope-callout>
+    <tools-export-scope-callout *ngIf="!disabledByPolicy"></tools-export-scope-callout>

    <div class="box">
      <div class="box-content">
--- a/apps/browser/tsconfig.json
+++ b/apps/browser/tsconfig.json
@ -20,6 +20,7 @@
      "@bitwarden/vault-export-core": [
        "../../libs/tools/export/vault-export/vault-export-core/src"
      ],
+      "@bitwarden/vault-export-ui": ["../../libs/tools/export/vault-export/vault-export-ui/src"],
      "@bitwarden/importer/core": ["../../libs/importer/src"],
      "@bitwarden/importer/ui": ["../../libs/importer/src/components"],
      "@bitwarden/platform": ["../../libs/platform/src"],
--- a/apps/desktop/src/app/app.module.ts
+++ b/apps/desktop/src/app/app.module.ts
@ -8,6 +8,7 @@ import { NgModule } from "@angular/core";
 import { ColorPasswordCountPipe } from "@bitwarden/angular/pipes/color-password-count.pipe";
 import { ColorPasswordPipe } from "@bitwarden/angular/pipes/color-password.pipe";
 import { DialogModule } from "@bitwarden/components";
+import { ExportScopeCalloutComponent } from "@bitwarden/vault-export-ui";

 import { AccessibilityCookieComponent } from "../auth/accessibility-cookie.component";
 import { DeleteAccountComponent } from "../auth/delete-account.component";
@ -61,6 +62,7 @@ import { SendComponent } from "./tools/send/send.component";
    DialogModule,
    DeleteAccountComponent,
    UserVerificationComponent,
+    ExportScopeCalloutComponent,
  ],
  declarations: [
    AccessibilityCookieComponent,
--- a/apps/desktop/src/app/tools/export/export.component.html
+++ b/apps/desktop/src/app/tools/export/export.component.html
@ -9,7 +9,7 @@
        >
          {{ "personalVaultExportPolicyInEffect" | i18n }}
        </app-callout>
-        <app-export-scope-callout *ngIf="!disabledByPolicy"></app-export-scope-callout>
+        <tools-export-scope-callout *ngIf="!disabledByPolicy"></tools-export-scope-callout>
        <div class="box">
          <h1 class="box-header" id="exportTitle">
            {{ "exportVault" | i18n }}
--- a/apps/desktop/tsconfig.json
+++ b/apps/desktop/tsconfig.json
@ -20,6 +20,7 @@
      "@bitwarden/vault-export-core": [
        "../../libs/tools/export/vault-export/vault-export-core/src"
      ],
+      "@bitwarden/vault-export-ui": ["../../libs/tools/export/vault-export/vault-export-ui/src"],
      "@bitwarden/importer/core": ["../../libs/importer/src"],
      "@bitwarden/importer/ui": ["../../libs/importer/src/components"],
      "@bitwarden/node/*": ["../../libs/node/src/*"],
--- a/apps/web/src/app/admin-console/organizations/tools/vault-export/org-vault-export.module.ts
+++ b/apps/web/src/app/admin-console/organizations/tools/vault-export/org-vault-export.module.ts
@ -1,12 +1,19 @@
 import { NgModule } from "@angular/core";

+import { ExportScopeCalloutComponent } from "@bitwarden/vault-export-ui";
+
 import { LooseComponentsModule, SharedModule } from "../../../../shared";

 import { OrganizationVaultExportRoutingModule } from "./org-vault-export-routing.module";
 import { OrganizationVaultExportComponent } from "./org-vault-export.component";

@NgModule({
-  imports: [SharedModule, LooseComponentsModule, OrganizationVaultExportRoutingModule],
+  imports: [
+    SharedModule,
+    LooseComponentsModule,
+    OrganizationVaultExportRoutingModule,
+    ExportScopeCalloutComponent,
+  ],
  declarations: [OrganizationVaultExportComponent],
 })
 export class OrganizationVaultExportModule {}
--- a/apps/web/src/app/tools/vault-export/export.component.html
+++ b/apps/web/src/app/tools/vault-export/export.component.html
@ -5,10 +5,10 @@
    <bit-callout type="danger" title="{{ 'vaultExportDisabled' | i18n }}" *ngIf="disabledByPolicy">
      {{ "personalVaultExportPolicyInEffect" | i18n }}
    </bit-callout>
-    <app-export-scope-callout
+    <tools-export-scope-callout
      [organizationId]="organizationId"
      *ngIf="!disabledByPolicy"
-    ></app-export-scope-callout>
+    ></tools-export-scope-callout>

    <ng-container *ngIf="organizations$ | async as organizations">
      <bit-form-field *ngIf="organizations.length > 0">
--- a/apps/web/src/app/tools/vault-export/export.module.ts
+++ b/apps/web/src/app/tools/vault-export/export.module.ts
@ -1,12 +1,14 @@
 import { NgModule } from "@angular/core";

+import { ExportScopeCalloutComponent } from "@bitwarden/vault-export-ui";
+
 import { LooseComponentsModule, SharedModule } from "../../shared";

 import { ExportRoutingModule } from "./export-routing.module";
 import { ExportComponent } from "./export.component";

@NgModule({
-  imports: [SharedModule, LooseComponentsModule, ExportRoutingModule],
+  imports: [SharedModule, LooseComponentsModule, ExportRoutingModule, ExportScopeCalloutComponent],
  declarations: [ExportComponent],
 })
 export class ExportModule {}
--- a/apps/web/tsconfig.json
+++ b/apps/web/tsconfig.json
@ -15,6 +15,7 @@
      "@bitwarden/vault-export-core": [
        "../../libs/tools/export/vault-export/vault-export-core/src"
      ],
+      "@bitwarden/vault-export-ui": ["../../libs/tools/export/vault-export/vault-export-ui/src"],
      "@bitwarden/importer/core": ["../../libs/importer/src"],
      "@bitwarden/importer/ui": ["../../libs/importer/src/components"],
      "@bitwarden/platform": ["../../libs/platform/src"],
--- a/bitwarden_license/bit-web/tsconfig.json
+++ b/bitwarden_license/bit-web/tsconfig.json
@ -11,6 +11,7 @@
      "@bitwarden/vault-export-core": [
        "../../libs/tools/export/vault-export/vault-export-core/src"
      ],
+      "@bitwarden/vault-export-ui": ["../../libs/tools/export/vault-export/vault-export-core/src"],
      "@bitwarden/platform": ["../../libs/platform/src"],
      "@bitwarden/vault": ["../../libs/vault/src"],
      "@bitwarden/web-vault/*": ["../../apps/web/src/*"]
--- a/libs/angular/src/jslib.module.ts
+++ b/libs/angular/src/jslib.module.ts
@ -29,7 +29,6 @@ import { UserTypePipe } from "./pipes/user-type.pipe";
 import { EllipsisPipe } from "./platform/pipes/ellipsis.pipe";
 import { FingerprintPipe } from "./platform/pipes/fingerprint.pipe";
 import { I18nPipe } from "./platform/pipes/i18n.pipe";
-import { ExportScopeCalloutComponent } from "./tools/export/components/export-scope-callout.component";
 import { PasswordStrengthComponent } from "./tools/password-strength/password-strength.component";
 import { IconComponent } from "./vault/components/icon.component";

@ -54,7 +53,6 @@ import { IconComponent } from "./vault/components/icon.component";
    CopyTextDirective,
    CreditCardNumberPipe,
    EllipsisPipe,
-    ExportScopeCalloutComponent,
    FallbackSrcDirective,
    I18nPipe,
    IconComponent,
@ -85,7 +83,6 @@ import { IconComponent } from "./vault/components/icon.component";
    CopyTextDirective,
    CreditCardNumberPipe,
    EllipsisPipe,
-    ExportScopeCalloutComponent,
    FallbackSrcDirective,
    I18nPipe,
    IconComponent,
--- a/libs/shared/tsconfig.libs.json
+++ b/libs/shared/tsconfig.libs.json
@ -10,6 +10,7 @@
      "@bitwarden/common/*": ["../common/src/*"],
      "@bitwarden/components": ["../components/src"],
      "@bitwarden/vault-export-core": ["../tools/export/vault-export/vault-export-core/src"],
+      "@bitwarden/vault-export-ui": ["../tools/export/vault-export/vault-export-ui/src"],
      "@bitwarden/importer/core": ["../importer/src"],
      "@bitwarden/importer/ui": ["../importer/src/components"],
      "@bitwarden/platform": ["../platform/src"],
--- a/libs/tools/export/vault-export/README.md
+++ b/libs/tools/export/vault-export/README.md
@ -13,3 +13,5 @@ Currently in use by the Bitwarden Web Vault, CLI, desktop app and browser extens
 ## vault-export-ui

 Package name: `@bitwarden/vault-export-ui`
+
+Contains all UI components used for the vault-export
--- a/libs/tools/export/vault-export/vault-export-ui/jest.config.js
+++ b/libs/tools/export/vault-export/vault-export-ui/jest.config.js
@ -0,0 +1,13 @@
+const { pathsToModuleNameMapper } = require("ts-jest");
+
+const { compilerOptions } = require("../../../../shared/tsconfig.libs");
+
+/** @type {import('jest').Config} */
+module.exports = {
+  testMatch: ["**/+(*.)+(spec).+(ts)"],
+  preset: "ts-jest",
+  testEnvironment: "jsdom",
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions?.paths || {}, {
+    prefix: "<rootDir>/../../../",
+  }),
+};
--- a/libs/tools/export/vault-export/vault-export-ui/package.json
+++ b/libs/tools/export/vault-export/vault-export-ui/package.json
@ -0,0 +1,25 @@
+{
+  "name": "@bitwarden/vault-export-ui",
+  "version": "0.0.0",
+  "description": "Angular components for the Bitwarden vault exporter",
+  "keywords": [
+    "bitwarden"
+  ],
+  "author": "Bitwarden Inc.",
+  "homepage": "https://bitwarden.com",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bitwarden/clients"
+  },
+  "license": "GPL-3.0",
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "npm run clean && tsc",
+    "build:watch": "npm run clean && tsc -watch"
+  },
+  "dependencies": {
+    "@bitwarden/common": "file:../../../../common",
+    "@bitwarden/angular": "file:../../../../angular",
+    "@bitwarden/vault-export-core": "file:../vault-export-core"
+  }
+}
--- a/libs/tools/export/vault-export/vault-export-ui/src/components/export-scope-callout.component.html
+++ b/libs/tools/export/vault-export/vault-export-ui/src/components/export-scope-callout.component.html
@ -1,5 +1,5 @@
 <ng-container *ngIf="show">
-  <app-callout type="info" title="{{ scopeConfig.title | i18n }}">
+  <bit-callout type="info" title="{{ scopeConfig.title | i18n }}">
    {{ scopeConfig.description | i18n: scopeConfig.scopeIdentifier }}
-  </app-callout>
+  </bit-callout>
 </ng-container>
--- a/libs/tools/export/vault-export/vault-export-ui/src/components/export-scope-callout.component.ts
+++ b/libs/tools/export/vault-export/vault-export-ui/src/components/export-scope-callout.component.ts
@ -1,11 +1,16 @@
+import { CommonModule } from "@angular/common";
 import { Component, Input, OnInit } from "@angular/core";

+import { JslibModule } from "@bitwarden/angular/jslib.module";
 import { OrganizationService } from "@bitwarden/common/admin-console/abstractions/organization/organization.service.abstraction";
 import { StateService } from "@bitwarden/common/platform/abstractions/state.service";
+import { CalloutModule } from "@bitwarden/components";

@Component({
-  selector: "app-export-scope-callout",
+  selector: "tools-export-scope-callout",
  templateUrl: "export-scope-callout.component.html",
+  standalone: true,
+  imports: [CommonModule, JslibModule, CalloutModule],
 })
 export class ExportScopeCalloutComponent implements OnInit {
  show = false;
--- a/libs/tools/export/vault-export/vault-export-ui/src/index.ts
+++ b/libs/tools/export/vault-export/vault-export-ui/src/index.ts
@ -0,0 +1 @@
+export { ExportScopeCalloutComponent } from "./components/export-scope-callout.component";
--- a/libs/tools/export/vault-export/vault-export-ui/tsconfig.json
+++ b/libs/tools/export/vault-export/vault-export-ui/tsconfig.json
@ -0,0 +1,5 @@
+{
+  "extends": "../../../../shared/tsconfig.libs",
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"]
+}
--- a/libs/tools/export/vault-export/vault-export-ui/tsconfig.spec.json
+++ b/libs/tools/export/vault-export/vault-export-ui/tsconfig.spec.json
@ -0,0 +1,3 @@
+{
+  "extends": "./tsconfig.json"
+}
--- a/tsconfig.eslint.json
+++ b/tsconfig.eslint.json
@ -22,6 +22,7 @@
      "@bitwarden/common/*": ["./libs/common/src/*"],
      "@bitwarden/components": ["./libs/components/src"],
      "@bitwarden/vault-export-core": [".libs/tools/export/vault-export/vault-export-core/src"],
+      "@bitwarden/vault-export-ui": [".libs/tools/export/vault-export/vault-export-ui/src"],
      "@bitwarden/importer/core": ["./libs/importer/src"],
      "@bitwarden/importer/ui": ["./libs/importer/src/components"],
      "@bitwarden/platform": ["./libs/platform/src"],
--- a/tsconfig.json
+++ b/tsconfig.json
@ -23,6 +23,7 @@
      "@bitwarden/common/*": ["./libs/common/src/*"],
      "@bitwarden/components": ["./libs/components/src"],
      "@bitwarden/vault-export-core": ["./libs/tools/export/vault-export/vault-export-core/src"],
+      "@bitwarden/vault-export-ui": ["./libs/tools/export/vault-export/vault-export-ui/src"],
      "@bitwarden/importer/core": ["./libs/importer/src"],
      "@bitwarden/importer/ui": ["./libs/importer/src/components"],
      "@bitwarden/platform": ["./libs/platform/src"],
				`@ -0,0 +1 @@`
				`export { ExportScopeCalloutComponent } from "./components/export-scope-callout.component";`