refactor: introduce @bitwarden/state and other common libs (#15772)

* refactor: introduce @bitwarden/serialization

* refactor: introduce @bitwarden/guid

* refactor: introduce @bitwaren/client-type

* refactor: introduce @bitwarden/core-test-utils

* refactor: introduce @bitwarden/state and @bitwarden/state-test-utils

Creates initial project structure for centralized application state management. Part of modularization effort to extract state code from common.

* Added state provider documentation to README.

* Changed callouts to Github format.

* Fixed linting on file name.

* Forced git to accept rename

---------

Co-authored-by: Todd Martin <tmartin@bitwarden.com>

libs/serialization/README.md

@@ -0,0 +1,5 @@
+# serialization
+
+Owned by: platform
+
+Core serialization utilities

libs/serialization/eslint.config.mjs

@@ -0,0 +1,3 @@
+import baseConfig from "../../eslint.config.mjs";
+
+export default [...baseConfig];

libs/serialization/jest.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+  displayName: "serialization",
+  preset: "../../jest.preset.js",
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.[tj]s$": ["ts-jest", { tsconfig: "<rootDir>/tsconfig.spec.json" }],
+  },
+  moduleFileExtensions: ["ts", "js", "html"],
+  coverageDirectory: "../../coverage/libs/serialization",
+};

libs/serialization/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@bitwarden/serialization",
+  "version": "0.0.1",
+  "description": "Core serialization utilities",
+  "private": true,
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "license": "GPL-3.0",
+  "author": "platform"
+}

libs/serialization/project.json

@@ -0,0 +1,33 @@
+{
+  "name": "serialization",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/serialization/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "build": {
+      "executor": "@nx/js:tsc",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/libs/serialization",
+        "main": "libs/serialization/src/index.ts",
+        "tsConfig": "libs/serialization/tsconfig.lib.json",
+        "assets": ["libs/serialization/*.md"]
+      }
+    },
+    "lint": {
+      "executor": "@nx/eslint:lint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["libs/serialization/**/*.ts"]
+      }
+    },
+    "test": {
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "jestConfig": "libs/serialization/jest.config.js"
+      }
+    }
+  }
+}

libs/serialization/src/deserialization-helpers.spec.ts

@@ -0,0 +1,25 @@
+import { record } from "@bitwarden/serialization/deserialization-helpers";
+
+describe("deserialization helpers", () => {
+  describe("record", () => {
+    it("deserializes a record when keys are strings", () => {
+      const deserializer = record((value: number) => value);
+      const input = {
+        a: 1,
+        b: 2,
+      };
+      const output = deserializer(input);
+      expect(output).toEqual(input);
+    });
+
+    it("deserializes a record when keys are numbers", () => {
+      const deserializer = record((value: number) => value);
+      const input = {
+        1: 1,
+        2: 2,
+      };
+      const output = deserializer(input);
+      expect(output).toEqual(input);
+    });
+  });
+});

libs/serialization/src/deserialization-helpers.ts

@@ -0,0 +1,40 @@
+// FIXME: Update this file to be type safe and remove this and next line
+// @ts-strict-ignore
+import { Jsonify } from "type-fest";
+
+/**
+ *
+ * @param elementDeserializer
+ * @returns
+ */
+export function array<T>(
+  elementDeserializer: (element: Jsonify<T>) => T,
+): (array: Jsonify<T[]>) => T[] {
+  return (array) => {
+    if (array == null) {
+      return null;
+    }
+
+    return array.map((element) => elementDeserializer(element));
+  };
+}
+
+/**
+ *
+ * @param valueDeserializer
+ */
+export function record<T, TKey extends string | number = string>(
+  valueDeserializer: (value: Jsonify<T>) => T,
+): (record: Jsonify<Record<TKey, T>>) => Record<TKey, T> {
+  return (jsonValue: Jsonify<Record<TKey, T> | null>) => {
+    if (jsonValue == null) {
+      return null;
+    }
+
+    const output: Record<TKey, T> = {} as any;
+    Object.entries(jsonValue).forEach(([key, value]) => {
+      output[key as TKey] = valueDeserializer(value);
+    });
+    return output;
+  };
+}

libs/serialization/src/index.ts

@@ -0,0 +1 @@
+export * from "./deserialization-helpers";

libs/serialization/src/serialization.spec.ts

@@ -0,0 +1,8 @@
+import * as lib from "./index";
+
+describe("serialization", () => {
+  // This test will fail until something is exported from index.ts
+  it("should work", () => {
+    expect(lib).toBeDefined();
+  });
+});

libs/serialization/tsconfig.eslint.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": ["src/**/*.ts", "src/**/*.js"],
+  "exclude": ["**/build", "**/dist"]
+}

libs/serialization/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

libs/serialization/tsconfig.lib.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "declaration": true,
+    "types": ["node"]
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["jest.config.js", "src/**/*.spec.ts"]
+}

libs/serialization/tsconfig.spec.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "module": "commonjs",
+    "moduleResolution": "node10",
+    "types": ["jest", "node"]
+  },
+  "include": ["jest.config.ts", "src/**/*.test.ts", "src/**/*.spec.ts", "src/**/*.d.ts"]
+}