@metal-stack/api 0.4.3 → 0.5.1

package/{js/metalstack → metalstack}/infra/v2/event_pb.ts

@@ -22,7 +22,7 @@ export const file_metalstack_infra_v2_event: GenFile = /*@__PURE__*/
  */
 export type EventServiceSendRequest = Message<"metalstack.infra.v2.EventServiceSendRequest"> & {
   /**
-   * Events grouped by machine IDs
+   * Events grouped by machine IDs.
    *
    * @generated from field: map<string, metalstack.api.v2.MachineProvisioningEvent> events = 1;
    */
@@ -43,14 +43,14 @@ export const EventServiceSendRequestSchema: GenMessage<EventServiceSendRequest>
  */
 export type EventServiceSendResponse = Message<"metalstack.infra.v2.EventServiceSendResponse"> & {
   /**
-   * Events counts the number of events successfully stored in the database
+   * Events counts the number of events successfully stored in the database.
    *
    * @generated from field: uint64 events = 1;
    */
   events: bigint;
 
   /**
-   * Failed contains IDs of all machines whose events could not be stored in the database
+   * Failed contains IDs of all machines whose events could not be stored in the database.
    *
    * @generated from field: repeated string failed = 2;
    */

package/{js/metalstack → metalstack}/infra/v2/switch_pb.d.ts

@@ -13,7 +13,7 @@ export declare const file_metalstack_infra_v2_switch: GenFile;
  */
 export type SwitchServiceGetRequest = Message<"metalstack.infra.v2.SwitchServiceGetRequest"> & {
     /**
-     * Id of the switch
+     * Id of the switch.
      *
      * @generated from field: string id = 1;
      */
@@ -31,7 +31,7 @@ export declare const SwitchServiceGetRequestSchema: GenMessage<SwitchServiceGetR
  */
 export type SwitchServiceGetResponse = Message<"metalstack.infra.v2.SwitchServiceGetResponse"> & {
     /**
-     * Switch contains the requested switch
+     * Switch contains the requested switch.
      *
      * @generated from field: metalstack.api.v2.Switch switch = 1;
      */
@@ -49,7 +49,7 @@ export declare const SwitchServiceGetResponseSchema: GenMessage<SwitchServiceGet
  */
 export type SwitchServiceRegisterRequest = Message<"metalstack.infra.v2.SwitchServiceRegisterRequest"> & {
     /**
-     * Switch to register
+     * Switch to register.
      *
      * @generated from field: metalstack.api.v2.Switch switch = 1;
      */
@@ -67,7 +67,7 @@ export declare const SwitchServiceRegisterRequestSchema: GenMessage<SwitchServic
  */
 export type SwitchServiceRegisterResponse = Message<"metalstack.infra.v2.SwitchServiceRegisterResponse"> & {
     /**
-     * Switch contains the registered switch
+     * Switch contains the registered switch.
      *
      * @generated from field: metalstack.api.v2.Switch switch = 1;
      */
@@ -85,25 +85,25 @@ export declare const SwitchServiceRegisterResponseSchema: GenMessage<SwitchServi
  */
 export type SwitchServiceHeartbeatRequest = Message<"metalstack.infra.v2.SwitchServiceHeartbeatRequest"> & {
     /**
-     * Id of the switch
+     * Id of the switch.
      *
      * @generated from field: string id = 1;
      */
     id: string;
     /**
-     * Duration of the sync
+     * Duration of the sync.
      *
      * @generated from field: google.protobuf.Duration duration = 2;
      */
     duration?: Duration | undefined;
     /**
-     * Error if any occurred during the sync
+     * Error if any occurred during the sync.
      *
      * @generated from field: optional string error = 3;
      */
     error?: string | undefined;
     /**
-     * PortStates maps port identifiers to the respective port's operational state
+     * PortStates maps port identifiers to the respective port's operational state.
      *
      * @generated from field: map<string, metalstack.api.v2.SwitchPortStatus> port_states = 4;
      */
@@ -111,7 +111,7 @@ export type SwitchServiceHeartbeatRequest = Message<"metalstack.infra.v2.SwitchS
         [key: string]: SwitchPortStatus;
     };
     /**
-     * BgpPortStates maps port identifiers to the respective port's BGP state
+     * BgpPortStates maps port identifiers to the respective port's BGP state.
      *
      * @generated from field: map<string, metalstack.api.v2.SwitchBGPPortState> bgp_port_states = 5;
      */
@@ -131,19 +131,19 @@ export declare const SwitchServiceHeartbeatRequestSchema: GenMessage<SwitchServi
  */
 export type SwitchServiceHeartbeatResponse = Message<"metalstack.infra.v2.SwitchServiceHeartbeatResponse"> & {
     /**
-     * Id of the switch
+     * Id of the switch.
      *
      * @generated from field: string id = 1;
      */
     id: string;
     /**
-     * LastSync holds information about the last sync
+     * LastSync holds information about the last sync.
      *
      * @generated from field: metalstack.api.v2.SwitchSync last_sync = 2;
      */
     lastSync?: SwitchSync | undefined;
     /**
-     * LastSyncError holds information about the last erroneous sync
+     * LastSyncError holds information about the last erroneous sync.
      *
      * @generated from field: metalstack.api.v2.SwitchSync last_sync_error = 3;
      */

package/{js/metalstack → metalstack}/infra/v2/switch_pb.ts

@@ -26,7 +26,7 @@ export const file_metalstack_infra_v2_switch: GenFile = /*@__PURE__*/
  */
 export type SwitchServiceGetRequest = Message<"metalstack.infra.v2.SwitchServiceGetRequest"> & {
   /**
-   * Id of the switch
+   * Id of the switch.
    *
    * @generated from field: string id = 1;
    */
@@ -47,7 +47,7 @@ export const SwitchServiceGetRequestSchema: GenMessage<SwitchServiceGetRequest>
  */
 export type SwitchServiceGetResponse = Message<"metalstack.infra.v2.SwitchServiceGetResponse"> & {
   /**
-   * Switch contains the requested switch
+   * Switch contains the requested switch.
    *
    * @generated from field: metalstack.api.v2.Switch switch = 1;
    */
@@ -68,7 +68,7 @@ export const SwitchServiceGetResponseSchema: GenMessage<SwitchServiceGetResponse
  */
 export type SwitchServiceRegisterRequest = Message<"metalstack.infra.v2.SwitchServiceRegisterRequest"> & {
   /**
-   * Switch to register
+   * Switch to register.
    *
    * @generated from field: metalstack.api.v2.Switch switch = 1;
    */
@@ -89,7 +89,7 @@ export const SwitchServiceRegisterRequestSchema: GenMessage<SwitchServiceRegiste
  */
 export type SwitchServiceRegisterResponse = Message<"metalstack.infra.v2.SwitchServiceRegisterResponse"> & {
   /**
-   * Switch contains the registered switch
+   * Switch contains the registered switch.
    *
    * @generated from field: metalstack.api.v2.Switch switch = 1;
    */
@@ -110,35 +110,35 @@ export const SwitchServiceRegisterResponseSchema: GenMessage<SwitchServiceRegist
  */
 export type SwitchServiceHeartbeatRequest = Message<"metalstack.infra.v2.SwitchServiceHeartbeatRequest"> & {
   /**
-   * Id of the switch
+   * Id of the switch.
    *
    * @generated from field: string id = 1;
    */
   id: string;
 
   /**
-   * Duration of the sync
+   * Duration of the sync.
    *
    * @generated from field: google.protobuf.Duration duration = 2;
    */
   duration?: Duration | undefined;
 
   /**
-   * Error if any occurred during the sync
+   * Error if any occurred during the sync.
    *
    * @generated from field: optional string error = 3;
    */
   error?: string | undefined;
 
   /**
-   * PortStates maps port identifiers to the respective port's operational state
+   * PortStates maps port identifiers to the respective port's operational state.
    *
    * @generated from field: map<string, metalstack.api.v2.SwitchPortStatus> port_states = 4;
    */
   portStates: { [key: string]: SwitchPortStatus };
 
   /**
-   * BgpPortStates maps port identifiers to the respective port's BGP state
+   * BgpPortStates maps port identifiers to the respective port's BGP state.
    *
    * @generated from field: map<string, metalstack.api.v2.SwitchBGPPortState> bgp_port_states = 5;
    */
@@ -159,21 +159,21 @@ export const SwitchServiceHeartbeatRequestSchema: GenMessage<SwitchServiceHeartb
  */
 export type SwitchServiceHeartbeatResponse = Message<"metalstack.infra.v2.SwitchServiceHeartbeatResponse"> & {
   /**
-   * Id of the switch
+   * Id of the switch.
    *
    * @generated from field: string id = 1;
    */
   id: string;
 
   /**
-   * LastSync holds information about the last sync
+   * LastSync holds information about the last sync.
    *
    * @generated from field: metalstack.api.v2.SwitchSync last_sync = 2;
    */
   lastSync?: SwitchSync | undefined;
 
   /**
-   * LastSyncError holds information about the last erroneous sync
+   * LastSyncError holds information about the last erroneous sync.
    *
    * @generated from field: metalstack.api.v2.SwitchSync last_sync_error = 3;
    */

package/package.json

@@ -3,7 +3,7 @@
   "description": "metal-stack api typescript client",
   "repository": "https://github.com/metal-stack/api.git",
   "scripts": {
-    "build": "tsc --project js/tsconfig.json",
+    "build": "tsc --project tsconfig.json",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "metal-stack.io",
@@ -14,10 +14,11 @@
     "@connectrpc/connect-web": "^2.1.2"
   },
   "devDependencies": {
+    "@types/bun": "^1.3.14",
     "typescript": "^7.0.2"
   },
   "files": [
-    "js/*"
+    "./*"
   ],
-  "version": "0.4.3"
+  "version": "0.5.1"
 }

package/test-interceptor.d.ts

@@ -0,0 +1,9 @@
+import type { Interceptor, UnaryResponse } from "@connectrpc/connect";
+import type { DescMessage, MessageShape } from "@bufbuild/protobuf";
+export type ClientCall<Req extends DescMessage = DescMessage, Res extends DescMessage = DescMessage> = {
+    wantRequest: MessageShape<Req>;
+    wantRequestSchema: Req;
+    wantResponse?: () => UnaryResponse<Req, Res>;
+    wantError?: Error;
+};
+export declare function newTestInterceptor(calls: ClientCall[]): Interceptor;

package/test-interceptor.js

@@ -0,0 +1,33 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { equals } from "@bufbuild/protobuf";
+export function newTestInterceptor(calls) {
+    let count = 0;
+    return (next) => (req) => __awaiter(this, void 0, void 0, function* () {
+        var _a, _b;
+        var _c;
+        const reqAny = req;
+        const expected = calls[count];
+        if (!expected) {
+            throw new Error(`received an unexpected client call of type ${(_c = (_b = (_a = reqAny.method) === null || _a === void 0 ? void 0 : _a.input) === null || _b === void 0 ? void 0 : _b.typeName) !== null && _c !== void 0 ? _c : "unknown"}`);
+        }
+        count++;
+        if (!equals(expected.wantRequestSchema, reqAny.message, expected.wantRequest)) {
+            throw new Error(`request mismatch for call #${count - 1}: got ${JSON.stringify(reqAny.message)}`);
+        }
+        if (expected.wantError) {
+            throw expected.wantError;
+        }
+        if (expected.wantResponse) {
+            return expected.wantResponse();
+        }
+        throw new Error(`no wantResponse or wantError configured for call #${count - 1}`);
+    });
+}

package/test-interceptor.ts

@@ -0,0 +1,49 @@
+import type { Interceptor, UnaryRequest, UnaryResponse } from "@connectrpc/connect";
+import { equals } from "@bufbuild/protobuf";
+import type { DescMessage, MessageShape } from "@bufbuild/protobuf";
+
+export type ClientCall<Req extends DescMessage = DescMessage, Res extends DescMessage = DescMessage> = {
+  wantRequest: MessageShape<Req>;
+  wantRequestSchema: Req;
+  wantResponse?: () => UnaryResponse<Req, Res>;
+  wantError?: Error;
+};
+
+export function newTestInterceptor(calls: ClientCall[]): Interceptor {
+  let count = 0;
+
+  return (next) => async (req) => {
+    const reqAny = req as UnaryRequest;
+
+    const expected = calls[count];
+    if (!expected) {
+      throw new Error(
+        `received an unexpected client call of type ${reqAny.method?.input?.typeName ?? "unknown"}`,
+      );
+    }
+
+    count++;
+
+    if (
+      !equals(
+        expected.wantRequestSchema,
+        reqAny.message,
+        expected.wantRequest as MessageShape<typeof expected.wantRequestSchema>,
+      )
+    ) {
+      throw new Error(
+        `request mismatch for call #${count - 1}: got ${JSON.stringify(reqAny.message)}`,
+      );
+    }
+
+    if (expected.wantError) {
+      throw expected.wantError;
+    }
+
+    if (expected.wantResponse) {
+      return expected.wantResponse();
+    }
+
+    throw new Error(`no wantResponse or wantError configured for call #${count - 1}`);
+  };
+}

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "module": "esnext",
+    "declaration": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "types": [
+      "bun"
+    ]
+  }
+}

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2020 The metal-stack Authors.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/README.md

@@ -1,117 +0,0 @@
-# metal-stack.io api
-
-[![Release](https://github.com/metal-stack/api/actions/workflows/main.yml/badge.svg)](https://github.com/metal-stack/api/actions/workflows/main.yml) [![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/metal-stack/api) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/metal-stack/api) ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/metal-stack/api) [![Go Report Card](https://goreportcard.com/badge/github.com/metal-stack/api)](https://goreportcard.com/report/github.com/metal-stack/api)
-
-> [!IMPORTANT]
-> Clients from the metal-stack infrastructure have not fully migrated to the new API yet and might still communicate with the old [metal-api](https://github.com/metal-stack/metal-api). It could be that the information you look for is not contained in this repo.
-
-This is the V2 API of [metal-stack.io](https://metal-stack.io) to implement [MEP-4](https://metal-stack.io/docs/MEP-4-multi-tenancy-for-the-metal-api).
-
-## Usage examples
-
-Can be found in the [examples](examples/) folder.
-
-## Conventions
-
-Method options provide an intuitve and declarative way of providing annotations to service methods.
-These are used for scoping api-methods, which are getting utilized for authentication, authorization and auditing (mainly in interceptors).
-
-### Motivational Example
-
-```proto
-service IPService {
-  // Get an ip
-  rpc Get(IPServiceGetRequest) returns (IPServiceGetResponse) {
-    option (project_roles) = PROJECT_ROLE_OWNER;
-    option (project_roles) = PROJECT_ROLE_EDITOR;
-    option (project_roles) = PROJECT_ROLE_VIEWER;
-    option (auditing) = AUDITING_EXCLUDED;
-  }
-  // Create an ip
-  rpc Create(IPServiceCreateRequest) returns (IPServiceCreateResponse) {
-    option (project_roles) = PROJECT_ROLE_OWNER;
-    option (project_roles) = PROJECT_ROLE_EDITOR;
-  }
-}
-
-// IPServiceCreateRequest is the request payload for a ip create request
-message IPServiceCreateRequest {
-  // Network from which the IP should be created
-  string network = 1 [(buf.validate.field).string = {
-    min_len: 2
-    max_len: 128
-  }];
-  // Project of the ip
-  string project = 2 [(buf.validate.field).string.uuid = true];
-  // Name of the ip
-  optional string name = 3 [(buf.validate.field).string.(metalstack.api.v2.is_name) = true];
-  // Description of the ip
-  optional string description = 4 [(buf.validate.field).string.(metalstack.api.v2.is_description) = true];
-  // IP if given try to create this ip if still available
-  optional string ip = 5 [(buf.validate.field).string.ip = true];
-  // Machine for which this ip should get created
-  optional string machine = 6 [(buf.validate.field).string.uuid = true];
-  // Labels to put onto the ip
-  optional Labels labels = 7;
-  // Type of the IP, ether ephemeral (default), or static
-  optional IPType type = 8 [(buf.validate.field).enum.defined_only = true];
-  // Addressfamily of the IP to create, defaults to ipv4
-  optional IPAddressFamily address_family = 9 [(buf.validate.field).enum.defined_only = true];
-}
-```
-
-In this example we can see the motivation behind the method options.
-
-1. Get: can be issued by project owner, editor, viewer and is excluded from auditing
-2. Allocate: can be used by project owner, editor
-3. Both methods are project-scoped, since they are annotated by a project role -> Request object needs to have the **project** field in order to specify the target project of the service method
-
-Further explanations are explained in the following.
-
-### Auth
-
-These options specify the RBAC of the api-endpoint.
-
-| Option         | Description                                  | Values      | Explanation                                            |
-| -------------- | -------------------------------------------- | ----------- | ------------------------------------------------------ |
-| TENANT_ROLE\_  | Specifies the required tenant role           | UNSPECIFIED |                                                        |
-|                |                                              | OWNER       | tenant owner                                           |
-|                |                                              | EDITOR      | tenant editor                                          |
-|                |                                              | VIEWER      | tenant viewer                                          |
-|                |                                              | GUEST       | tenant guest                                           |
-| PROJECT_ROLE\_ | Specifies the required project role          | UNSPECIFIED |                                                        |
-|                |                                              | OWNER       | project owner                                          |
-|                |                                              | EDITOR      | project editor                                         |
-|                |                                              | VIEWER      | project viewer                                         |
-| ADMIN_ROLE\_   | Specifies the required admin role            | UNSPECIFIED |                                                        |
-|                |                                              | EDITOR      | admin editor                                           |
-|                |                                              | VIEWER      | admin viewer                                           |
-| MACHINE_ROLE\_ | Specifies the required machine role          | UNSPECIFIED |                                                        |
-|                |                                              | EDITOR      | machine editor                                         |
-|                |                                              | VIEWER      | machine viewer                                         |
-| INFRA_ROLE\_   | Specifies the required infra role            | UNSPECIFIED |                                                        |
-|                |                                              | EDITOR      | infra editor                                           |
-|                |                                              | VIEWER      | infra viewer                                           |
-| VISIBILITY\_   | Specifies the visibility of the api-endpoint | UNSPECIFIED |                                                        |
-|                |                                              | PUBLIC      | api-method is visible to public, a token is not needed |
-|                |                                              | SELF        | api-method is scoped to owner resources                |
-
-> [!IMPORTANT]
->
-> Every operation needs to specify exactly one of the presented options. The option defines the request scope, which is later used for implementing request authorization in the server.
-
-> [!CAUTION]
->
-> If we use a Tenant or Project role, the request will be respectively scoped as Tenant or Project request.
-> Tenant-Requests must have the field **login**, which is the tenant id and specifies the tenant on which the service-method is scoped.
-> Project-Requests must have the field **project**, which is the project id and specifies the project on which the service-method is scoped.
-
-### Auditing
-
-For traceability we require to store audit-logs.
-
-| Option     | Description                              | Values      | Explanation              |
-| ---------- | ---------------------------------------- | ----------- | ------------------------ |
-| AUDITING\_ | Specifies if the api-endpoint is audited | UNSPECIFIED | DEFAULT: included        |
-|            |                                          | INCLUDED    | operation is audited     |
-|            |                                          | EXCLUDED    | operation is not audited |

package/js/tsconfig.json

@@ -1,70 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
-    /* Basic Options */
-    // "incremental": true,                   /* Enable incremental compilation */
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
-    "module": "esnext",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    // "lib": [],                             /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                       /* Allow javascript files to be compiled. */
-    // "checkJs": true,                       /* Report errors in .js files. */
-    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    // "outDir": "./",                        /* Redirect output structure to the directory. */
-    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                     /* Enable project compilation */
-    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,              /* Enable strict null checks. */
-    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                /* Report errors on unused locals. */
-    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-    // "noUncheckedIndexedAccess": true,      /* Include 'undefined' in index signature results */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
-
-    /* Source Map Options */
-    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-
-    /* Advanced Options */
-    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
-    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
-  }
-}