[PM-3587] create @bitwarden/vault lib (#6083)

* add libs/vault

* update configs

* update package lock

* fix typo

.eslintrc.json

@@ -179,6 +179,12 @@
       "rules": {
         "no-restricted-imports": ["error", { "patterns": ["@bitwarden/node/*", "src/**/*"] }]
       }
+    },
+    {
+      "files": ["libs/vault/src/**/*.ts"],
+      "rules": {
+        "no-restricted-imports": ["error", { "patterns": ["@bitwarden/vault/*", "src/**/*"] }]
+      }
     }
   ]
 }

.github/CODEOWNERS

@@ -39,6 +39,7 @@ apps/desktop/src/vault @bitwarden/team-vault-dev
 apps/web/src/app/vault @bitwarden/team-vault-dev
 libs/angular/src/vault @bitwarden/team-vault-dev
 libs/common/src/vault @bitwarden/team-vault-dev
+libs/vault @bitwarden/team-vault-dev
 
 ## Admin Console team files ##
 apps/browser/src/admin-console @bitwarden/team-admin-console-dev

.github/whitelist-capital-letters.txt

@@ -25,6 +25,7 @@
 ./libs/common/src/abstractions/anonymousHub.service.ts
 ./libs/common/src/services/anonymousHub.service.ts
 ./libs/auth/README.md
+./libs/vault/README.md
 ./README.md
 ./LICENSE_BITWARDEN.txt
 ./CONTRIBUTING.md

apps/browser/tsconfig.json

@@ -14,7 +14,8 @@
       "@bitwarden/auth": ["../../libs/auth/src"],
       "@bitwarden/common/*": ["../../libs/common/src/*"],
       "@bitwarden/components": ["../../libs/components/src"],
-      "@bitwarden/exporter/*": ["../../libs/exporter/src/*"]
+      "@bitwarden/exporter/*": ["../../libs/exporter/src/*"],
+      "@bitwarden/vault": ["../../libs/auth/src"]
     },
     "useDefineForClassFields": false
   },

apps/desktop/tsconfig.json

@@ -14,7 +14,8 @@
       "@bitwarden/auth": ["../../libs/auth/src"],
       "@bitwarden/common/*": ["../../libs/common/src/*"],
       "@bitwarden/components": ["../../libs/components/src"],
-      "@bitwarden/exporter/*": ["../../libs/exporter/src/*"]
+      "@bitwarden/exporter/*": ["../../libs/exporter/src/*"],
+      "@bitwarden/vault": ["../../libs/vault/src"]
     },
     "useDefineForClassFields": false
   },

apps/web/tsconfig.json

@@ -11,6 +11,7 @@
       "@bitwarden/components": ["../../libs/components/src"],
       "@bitwarden/exporter/*": ["../../libs/exporter/src/*"],
       "@bitwarden/importer": ["../../libs/importer/src"],
+      "@bitwarden/vault": ["../../libs/vault/src"],
       "@bitwarden/web-vault/*": ["src/*"]
     }
   },

bitwarden_license/bit-web/tsconfig.json

@@ -7,6 +7,7 @@
       "@bitwarden/common/*": ["../../libs/common/src/*"],
       "@bitwarden/components": ["../../libs/components/src"],
       "@bitwarden/exporter/*": ["../../libs/exporter/src/*"],
+      "@bitwarden/vault": ["../../libs/vault/src"],
       "@bitwarden/web-vault/*": ["../../apps/web/src/*"]
     }
   },

jest.config.js

@@ -27,6 +27,7 @@ module.exports = {
     "<rootDir>/libs/exporter/jest.config.js",
     "<rootDir>/libs/importer/jest.config.js",
     "<rootDir>/libs/node/jest.config.js",
+    "<rootDir>/libs/vault/jest.config.js",
   ],
 
   // Workaround for a memory leak that crashes tests in CI:

libs/shared/tsconfig.libs.json

@@ -3,12 +3,13 @@
   "compilerOptions": {
     "paths": {
       "@bitwarden/angular/*": ["../angular/src/*"],
-      "@bitwarden/auth": ["../auth/src/*"],
+      "@bitwarden/auth": ["../auth/src"],
       "@bitwarden/common/*": ["../common/src/*"],
       "@bitwarden/components": ["../components/src"],
       "@bitwarden/exporter/*": ["../exporter/src/*"],
       "@bitwarden/importer": ["../importer/src"],
-      "@bitwarden/node/*": ["../node/src/*"]
+      "@bitwarden/node/*": ["../node/src/*"],
+      "@bitwarden/vault": ["../vault/src"]
     }
   }
 }

libs/vault/README.md

@@ -0,0 +1,3 @@
+# Vault
+
+This lib represents the public API of the Vault team at Bitwarden. Modules are imported using `@bitwarden/vault`.

libs/vault/jest.config.js

@@ -0,0 +1,16 @@
+const { pathsToModuleNameMapper } = require("ts-jest");
+
+const { compilerOptions } = require("../shared/tsconfig.libs");
+
+const sharedConfig = require("../../libs/shared/jest.config.angular");
+
+/** @type {import('jest').Config} */
+module.exports = {
+  ...sharedConfig,
+  displayName: "libs/vault tests",
+  preset: "jest-preset-angular",
+  setupFilesAfterEnv: ["<rootDir>/test.setup.ts"],
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions?.paths || {}, {
+    prefix: "<rootDir>/",
+  }),
+};

libs/vault/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@bitwarden/vault",
+  "version": "0.0.0",
+  "description": "Common code used across Bitwarden JavaScript projects.",
+  "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"
+  }
+}

libs/vault/test.setup.ts

@@ -0,0 +1,28 @@
+import { webcrypto } from "crypto";
+import "jest-preset-angular/setup-jest";
+
+Object.defineProperty(window, "CSS", { value: null });
+Object.defineProperty(window, "getComputedStyle", {
+  value: () => {
+    return {
+      display: "none",
+      appearance: ["-webkit-appearance"],
+    };
+  },
+});
+
+Object.defineProperty(document, "doctype", {
+  value: "<!DOCTYPE html>",
+});
+Object.defineProperty(document.body.style, "transform", {
+  value: () => {
+    return {
+      enumerable: true,
+      configurable: true,
+    };
+  },
+});
+
+Object.defineProperty(window, "crypto", {
+  value: webcrypto,
+});

libs/vault/tsconfig.json

@@ -0,0 +1,5 @@
+{
+  "extends": "../shared/tsconfig.libs",
+  "include": ["src", "spec"],
+  "exclude": ["node_modules", "dist"]
+}

libs/vault/tsconfig.spec.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "files": ["./test.setup.ts"]
+}

package-lock.json

@@ -307,6 +307,10 @@
         "@bitwarden/common": "file:../common"
       }
     },
+    "libs/vault": {
+      "version": "0.0.0",
+      "license": "GPL-3.0"
+    },
     "node_modules/@aashutoshrathi/word-wrap": {
       "version": "1.2.6",
       "resolved": "https://registry.npmjs.org/@aashutoshrathi/word-wrap/-/word-wrap-1.2.6.tgz",
@@ -4592,6 +4596,10 @@
       "resolved": "libs/node",
       "link": true
     },
+    "node_modules/@bitwarden/vault": {
+      "resolved": "libs/vault",
+      "link": true
+    },
     "node_modules/@bitwarden/web-vault": {
       "resolved": "apps/web",
       "link": true

tailwind.config.js

@@ -4,6 +4,7 @@ const config = require("./libs/components/tailwind.config.base");
 config.content = [
   "./libs/components/src/**/*.{html,ts,mdx}",
   "./libs/auth/src/**/*.{html,ts,mdx}",
+  "./libs/vault/src/**/*.{html,ts,mdx}",
   "./apps/web/src/**/*.{html,ts,mdx}",
   "./bitwarden_license/bit-web/src/**/*.{html,ts,mdx}",
   "./.storybook/preview.js",

tsconfig.eslint.json

@@ -20,7 +20,8 @@
       "@bitwarden/common/*": ["./libs/common/src/*"],
       "@bitwarden/components": ["./libs/components/src"],
       "@bitwarden/exporter/*": ["./libs/exporter/src/*"],
-      "@bitwarden/node/*": ["./libs/node/src/*"]
+      "@bitwarden/node/*": ["./libs/node/src/*"],
+      "@bitwarden/vault": ["./libs/vault/src"]
     },
     "plugins": [
       {

tsconfig.json

@@ -22,7 +22,8 @@
       "@bitwarden/exporter/*": ["./libs/exporter/src/*"],
       "@bitwarden/importer": ["./libs/importer/src"],
       "@bitwarden/node/*": ["./libs/node/src/*"],
-      "@bitwarden/web-vault/*": ["./apps/web/src/*"]
+      "@bitwarden/web-vault/*": ["./apps/web/src/*"],
+      "@bitwarden/vault": ["./libs/vault/src"]
     },
     "plugins": [
       {