Initial REST API skeleton

Signed-off-by: James Taylor <jamest@uk.ibm.com>

README.md

@@ -1,2 +1,3 @@
 # fabric-rest-sample
+
 Prototype sample REST server to demonstrate good Fabric Node SDK practices

asset-transfer-basic/rest-api-typescript/.env.sample

@@ -0,0 +1,2 @@
+LOG_LEVEL=info
+NODE_ENV=production

asset-transfer-basic/rest-api-typescript/.eslintrc.json

@@ -0,0 +1,27 @@
+{
+    "env": {
+        "node": true,
+        "es2021": true
+    },
+    "extends": [
+        "plugin:@typescript-eslint/recommended",
+        "plugin:prettier/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 12,
+        "sourceType": "module",
+        "project": "./tsconfig.json"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/no-unused-vars": [
+            "error",
+            {
+                "argsIgnorePattern": "^_"
+            }
+        ]
+    }
+}

asset-transfer-basic/rest-api-typescript/.gitignore

@@ -0,0 +1,15 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+.env
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Compiled TypeScript files
+dist

asset-transfer-basic/rest-api-typescript/.prettierrc.json

@@ -0,0 +1,3 @@
+{
+    "singleQuote": true
+}

asset-transfer-basic/rest-api-typescript/README.md

@@ -0,0 +1,3 @@
+# Asset Transfer REST API Sample
+
+Prototype sample REST server to demonstrate good Fabric Node SDK practices

asset-transfer-basic/rest-api-typescript/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "asset-transfer-basic",
+  "version": "1.0.0",
+  "description": "Asset Transfer Basic REST API implemented in TypeScript",
+  "main": "dist/index.js",
+  "dependencies": {
+    "dotenv": "^10.0.0",
+    "express": "^4.17.1",
+    "helmet": "^4.6.0",
+    "http-status-codes": "^2.1.4",
+    "pino": "^6.11.3",
+    "pino-http": "^5.5.0",
+    "source-map-support": "^0.5.19"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.12",
+    "@types/node": "^15.12.4",
+    "@types/pino": "^6.3.8",
+    "@types/pino-http": "^5.4.1",
+    "@typescript-eslint/eslint-plugin": "^4.28.0",
+    "@typescript-eslint/parser": "^4.28.0",
+    "eslint": "^7.29.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "pino-pretty": "^5.0.2",
+    "prettier": "^2.3.1",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.3.4"
+  },
+  "scripts": {
+    "prebuild": "npm run lint",
+    "build": "tsc",
+    "clean": "rimraf ./dist",
+    "format": "prettier --write \"{src,test}/**/*.ts\"",
+    "lint": "eslint . --ext .ts",
+    "start": "node --require source-map-support/register ./dist",
+    "start:dev": "node --require source-map-support/register --require dotenv/config ./dist | pino-pretty",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Hyperledger",
+  "license": "Apache-2.0",
+  "private": true
+}

asset-transfer-basic/rest-api-typescript/src/index.ts

@@ -0,0 +1,19 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import pino from 'pino';
+
+import app from './server';
+
+// TODO check any required env vars
+
+const logger = pino({
+  level: process.env.LOG_LEVEL || 'info',
+});
+
+// Start the server
+const port = Number(process.env.PORT || 3000);
+app.listen(port, () => {
+  logger.info('Express server started on port: %d', port);
+});

asset-transfer-basic/rest-api-typescript/src/server.ts

@@ -0,0 +1,89 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import helmet from 'helmet';
+import { StatusCodes, getReasonPhrase } from 'http-status-codes';
+import express, { NextFunction, Request, Response } from 'express';
+import pino from 'pino';
+import pinoMiddleware from 'pino-http';
+
+const logger = pino({
+  level: process.env.LOG_LEVEL || 'info',
+});
+
+const app = express();
+const { BAD_REQUEST, INTERNAL_SERVER_ERROR, NOT_FOUND, OK } = StatusCodes;
+
+app.use(
+  pinoMiddleware({
+    logger,
+    customLogLevel: function customLogLevel(res, err) {
+      if (
+        res.statusCode >= BAD_REQUEST &&
+        res.statusCode < INTERNAL_SERVER_ERROR
+      ) {
+        return 'warn';
+      }
+
+      if (res.statusCode >= INTERNAL_SERVER_ERROR || err) {
+        return 'error';
+      }
+
+      return 'debug';
+    },
+  })
+);
+
+app.use(express.json());
+app.use(express.urlencoded({ extended: true }));
+
+if (process.env.NODE_ENV === 'development') {
+  // TBC
+}
+
+if (process.env.NODE_ENV === 'production') {
+  app.use(helmet());
+}
+
+// Health routes
+app.get('/ready', (_req, res) =>
+  res.status(OK).json({
+    status: getReasonPhrase(OK),
+    timestamp: new Date().toISOString(),
+  })
+);
+app.get('/live', (_req, res) =>
+  res.status(OK).json({
+    status: getReasonPhrase(OK),
+    timestamp: new Date().toISOString(),
+  })
+);
+
+// TODO delete me
+app.get('/error', (_req, _res) => {
+  throw new Error('Example error');
+});
+
+// TODO add asset APIs
+// app.use("/api/assets", assetsRouter);
+
+// For everything else
+app.use((_req, res) =>
+  res.status(NOT_FOUND).json({
+    status: getReasonPhrase(NOT_FOUND),
+    timestamp: new Date().toISOString(),
+  })
+);
+
+// Print API errors
+// TBC in addition to pinoMiddleware errors?
+app.use((err: Error, _req: Request, res: Response, _next: NextFunction) => {
+  logger.error(err);
+  return res.status(INTERNAL_SERVER_ERROR).json({
+    status: getReasonPhrase(INTERNAL_SERVER_ERROR),
+    timestamp: new Date().toISOString(),
+  });
+});
+
+export default app;

asset-transfer-basic/rest-api-typescript/tsconfig.json

@@ -0,0 +1,72 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* Basic Options */
+    // "incremental": true,                         /* Enable incremental compilation */
+    "target": "es5",                                /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */
+    "module": "commonjs",                           /* 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', 'react', 'react-jsx' or 'react-jsxdev'. */
+    // "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": "./dist",                             /* 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 */
+    // "noImplicitOverride": true,                  /* Ensure overriding members in derived classes are marked with an 'override' modifier. */
+    // "noPropertyAccessFromIndexSignature": true,  /* Require undeclared properties from index signatures to use element accesses. */
+
+    /* 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. */
+  }
+}