[PM-8448] Create BItwarden Send UI library package (#9402)

* Create the send-ui library package Create folder Create package.json Create jest config Create tsconfig and tsconfig.spec.json Create README Add empty barrel file for exporting future members * Register @bitwarden/send-ui with all clients and libs * Register with eslint * Fix linting issue with README --------- Co-authored-by: Daniel James Smith <djsmith85@users.noreply.github.com>
2024-11-21 11:35:34 +01:00 · 2024-05-29 12:26:40 +02:00 · 2024-05-29 12:26:40 +02:00 · 86d6be3187
commit 86d6be3187
parent 42784b39f1
16 changed files with 76 additions and 0 deletions
--- a/.eslintrc.json
+++ b/.eslintrc.json
@ -218,6 +218,12 @@
        "no-restricted-imports": ["error", { "patterns": ["@bitwarden/platform/*", "src/**/*"] }]
      }
    },
+    {
+      "files": ["libs/tools/send/send-ui/src/**/*.ts"],
+      "rules": {
+        "no-restricted-imports": ["error", { "patterns": ["@bitwarden/send-ui/*", "src/**/*"] }]
+      }
+    },
    {
      "files": ["libs/vault/src/**/*.ts"],
      "rules": {
--- a/.github/whitelist-capital-letters.txt
+++ b/.github/whitelist-capital-letters.txt
@ -21,6 +21,7 @@
 ./libs/platform/README.md
 ./libs/tools/README.md
 ./libs/tools/export/vault-export/README.md
+./libs/tools/send/README.md
 ./libs/vault/README.md
 ./README.md
 ./LICENSE_BITWARDEN.txt
--- a/apps/browser/tsconfig.json
+++ b/apps/browser/tsconfig.json
@ -26,6 +26,7 @@
      "@bitwarden/importer/core": ["../../libs/importer/src"],
      "@bitwarden/importer/ui": ["../../libs/importer/src/components"],
      "@bitwarden/platform": ["../../libs/platform/src"],
+      "@bitwarden/send-ui": ["../../libs/tools/send/send-ui/src"],
      "@bitwarden/vault": ["../../libs/vault/src"]
    },
    "useDefineForClassFields": false
--- a/apps/desktop/tsconfig.json
+++ b/apps/desktop/tsconfig.json
@ -25,6 +25,7 @@
      "@bitwarden/importer/ui": ["../../libs/importer/src/components"],
      "@bitwarden/node/*": ["../../libs/node/src/*"],
      "@bitwarden/platform": ["../../libs/platform/src"],
+      "@bitwarden/send-ui": ["../../libs/tools/send/send-ui/src"],
      "@bitwarden/vault": ["../../libs/vault/src"]
    },
    "useDefineForClassFields": false
--- a/apps/web/tsconfig.json
+++ b/apps/web/tsconfig.json
@ -19,6 +19,7 @@
      "@bitwarden/importer/core": ["../../libs/importer/src"],
      "@bitwarden/importer/ui": ["../../libs/importer/src/components"],
      "@bitwarden/platform": ["../../libs/platform/src"],
+      "@bitwarden/send-ui": ["../../libs/tools/send/send-ui/src"],
      "@bitwarden/vault": ["../../libs/vault/src"],
      "@bitwarden/web-vault/*": ["src/*"]
    }
--- a/bitwarden_license/bit-common/tsconfig.json
+++ b/bitwarden_license/bit-common/tsconfig.json
@ -15,6 +15,7 @@
        "../../libs/tools/export/vault-export/vault-export-core/src"
      ],
      "@bitwarden/vault-export-ui": ["../../libs/tools/export/vault-export/vault-export-core/src"],
+      "@bitwarden/send-ui": ["../../libs/tools/send/send-ui/src"],
      "@bitwarden/platform": ["../../libs/platform/src"],
      "@bitwarden/vault": ["../../libs/vault/src"],
      "@bitwarden/web-vault/*": ["../../apps/web/src/*"],
--- a/bitwarden_license/bit-web/tsconfig.json
+++ b/bitwarden_license/bit-web/tsconfig.json
@ -19,6 +19,7 @@
      "@bitwarden/importer/core": ["../../libs/importer/src"],
      "@bitwarden/importer/ui": ["../../libs/importer/src/components"],
      "@bitwarden/platform": ["../../libs/platform/src"],
+      "@bitwarden/send-ui": ["../../libs/tools/send/send-ui/src"],
      "@bitwarden/vault": ["../../libs/vault/src"],
      "@bitwarden/web-vault/*": ["../../apps/web/src/*"],

--- a/libs/shared/tsconfig.libs.json
+++ b/libs/shared/tsconfig.libs.json
@ -15,6 +15,7 @@
      "@bitwarden/importer/core": ["../importer/src"],
      "@bitwarden/importer/ui": ["../importer/src/components"],
      "@bitwarden/platform": ["../platform/src"],
+      "@bitwarden/send-ui": ["../tools/send/send-ui/src"],
      "@bitwarden/node/*": ["../node/src/*"],
      "@bitwarden/vault": ["../vault/src"]
    }
--- a/libs/tools/send/README.md
+++ b/libs/tools/send/README.md
@ -0,0 +1,17 @@
+# Bitwarden Send
+
+This folder contains 2 packages that can be used to create and modify Sends.
+
+## semd-core
+
+Package name: `@bitwarden/send-core`
+
+Contains all types, models, and services for Bitwarden Send
+
+Currently in use by the Bitwarden Web Vault, CLI, desktop app and browser extension
+
+## send-ui
+
+Package name: `@bitwarden/send-ui`
+
+Contains all UI components used for Bitwarden Send
--- a/libs/tools/send/send-ui/jest.config.js
+++ b/libs/tools/send/send-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/send/send-ui/package.json
+++ b/libs/tools/send/send-ui/package.json
@ -0,0 +1,23 @@
+{
+  "name": "@bitwarden/send-ui",
+  "version": "0.0.0",
+  "description": "Angular components for Bitwarden Send",
+  "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"
+  }
+}
--- a/libs/tools/send/send-ui/src/index.ts
+++ b/libs/tools/send/send-ui/src/index.ts
--- a/libs/tools/send/send-ui/tsconfig.json
+++ b/libs/tools/send/send-ui/tsconfig.json
@ -0,0 +1,5 @@
+{
+  "extends": "../../../shared/tsconfig.libs",
+  "include": ["src"],
+  "exclude": ["node_modules", "dist"]
+}
--- a/libs/tools/send/send-ui/tsconfig.spec.json
+++ b/libs/tools/send/send-ui/tsconfig.spec.json
@ -0,0 +1,3 @@
+{
+  "extends": "./tsconfig.json"
+}
--- a/tsconfig.eslint.json
+++ b/tsconfig.eslint.json
@ -25,6 +25,7 @@
      "@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/send-ui": [".libs/tools/send/send-ui/src"],
      "@bitwarden/platform": ["./libs/platform/src"],
      "@bitwarden/node/*": ["./libs/node/src/*"],
      "@bitwarden/vault": ["./libs/vault/src"],
--- a/tsconfig.json
+++ b/tsconfig.json
@ -27,6 +27,7 @@
      "@bitwarden/importer/core": ["./libs/importer/src"],
      "@bitwarden/importer/ui": ["./libs/importer/src/components"],
      "@bitwarden/platform": ["./libs/platform/src"],
+      "@bitwarden/send-ui": ["./libs/tools/send/send-ui/src"],
      "@bitwarden/node/*": ["./libs/node/src/*"],
      "@bitwarden/web-vault/*": ["./apps/web/src/*"],
      "@bitwarden/vault": ["./libs/vault/src"],