Use tdslint to lint typings file, add index to export schema

The project dependencies now rely on a tdslint to lint the typings file
as well as testing against the test file. These files are found under
types.

A index.js file is provided to expose the schema itself.
Signed-off-by: Snorre Magnus Davøen <snorre.davoen@nsd.uib.no>

index.js

+const schema = require('./log-schema/log-schema.json');
+
+export default schema;
\ No newline at end of file

log-schema.d.ts

-export interface LogSchema {
-  /**
-   * The version of the log-schema. Used to separate versions into different Elasticsearch indices.
-   */
-  schemaVersion: "v3";
-  /**
-   * The time of the event. Format: RFC 3339. (E.g. 1985-04-12T23:20:50.52Z)
-   */
-  "@timestamp": string;
-  /**
-   * Log-level (DEBUG|INFO|WARN|ERROR).
-   */
-  levelName: ("DEBUG" | "INFO" | "WARN" | "ERROR");
-  /**
-   * Same as the message parameter in log libraries. Should contain a message describing log event.
-   */
-  message: string;
-  /**
-   * The process to which the log event pertains.
-   */
-  process?: string;
-  /**
-   * The thread to which the log event pertains.
-   */
-  thread?: string;
-  /**
-   * The application file to which the log event pertains.
-   */
-  file?: string;
-  /**
-   * The line number to which the log event pertains.
-   */
-  line?: number;
-  /**
-   * Identification of user to which log event pertains. Can be used to view log events for specific users.
-   */
-  userId?: string;
-  /**
-   * Name of logger generating the log event.
-   */
-  loggerName?: string;
-  /**
-   * Name of the service. E.g. user-service.
-   */
-  serviceName: string;
-  /**
-   * Version of the service. E.g. v2.0.2.
-   */
-  serviceVersion: string;
-  serviceStack?: string;
-  /**
-   * The id of a client/user request. Used to track a single request across services.
-   */
-  xRequestId?: string;
-  /**
-   * String tags to help categorize and/or filter log events
-   */
-  tags?: string[];
-  /**
-   * The current hostname for the service instance.
-   */
-  host?: string;
-  /**
-   * The current port number for the service instance.
-   */
-  port?: number;
-  /**
-   * A regular string or stringified JSON object containing data about log event.
-   */
-  data?: string;
-  /**
-   * The URL from which the log event was initiated.
-   */
-  url?: string;
-  /**
-   * The number of milliseconds spent on request/process.
-   */
-  responseTime?: number;
-  /**
-   * HTTP status code if applicable.
-   */
-  statusCode?: number;
-  /**
-   * HTTP method if applicable.
-   */
-  method?: string;
-  error?: {
-      /**
-     * A string representation of error type, e.g. NO_SUCH_VARIABLE_ERROR.
-     */
-  type?: string;
-      /**
-     * Error code uniquely identifiying error. E.g. 4324.
-     */
-  code: string;
-      /**
-     * Name of service where error originated if the error originated outside this service.
-     */
-  serviceName?: string;
-      /**
-     * Stack trace for the error. Should be santizied of sensitive information if possible.
-     */
-  stack?: string;
-      /**
-     * Any data that may be related to error in string format.
-     */
-  data?: string;
-      /**
-     * Regular string or stringified json object of original error object
-     */
-  originalErrorObject?: string;
-  };
-  request?: {
-      /**
-     * Request headers like Accept, If-Modified-Since, etc. Avoid logging sensitive headers!
-     */
-  headers?: {
-      [k: string]: string;
-    };
-      /**
-     * Query parameters contained within URL. E.g. (?myvalue=foo)
-     */
-  query?: {
-      [k: string]: string;
-    };
-      /**
-     * Path parameters contained whithin URL. E.g. /resource/<pathparam>
-     */
-  path?: {
-      [k: string]: string;
-    };
-      /**
-     * The request payload/body if applicable (POST form, json payload, etc).
-     */
-  payload?: string;
-  };
-  response?: {
-      /**
-     * Response headers like eTag, Content-Length, etc. Avoid logging sensitive headers!
-     */
-  headers?: {
-      [k: string]: string;
-    };
-      /**
-     * A string representation of the response body. Do not log large bodies!
-     */
-  body?: string;
-  };
-}

package.json

@@ -2,12 +2,16 @@
   "name": "log-schema-node",
   "version": "1.0.0",
   "main": "./log-schema/log-schema.json",
-  "types": "./log-schema.d.ts",
+  "types": "types",
+  "scripts": {
+    "dtslint": "dtslint types"
+  },
   "repository": "git@gitlab.nsd.uib.no:nsd-commons/log-schema-node.git",
   "author": "Snorre Magnus Davøen <snorre.davoen@nsd.uib.no>",
   "license": "See LICENSE",
   "devDependencies": {
     "jayschema": "^0.3.1",
-    "json-schema-to-typescript": "^4.2.0"
+    "json-schema-to-typescript": "^4.2.0",
+    "dtslint": "Microsoft/dtslint#production"
   }
 }

types/index.d.ts

+export interface LogSchema {
+	/**
+	 * The version of the log-schema. Used to separate versions into different Elasticsearch indices.
+	 */
+	schemaVersion: "v3";
+	/**
+	 * The time of the event. Format: RFC 3339. (E.g. 1985-04-12T23:20:50.52Z)
+	 */
+	"@timestamp": string;
+	/**
+	 * Log-level (DEBUG|INFO|WARN|ERROR).
+	 */
+	levelName: ("DEBUG" | "INFO" | "WARN" | "ERROR");
+	/**
+	 * Same as the message parameter in log libraries. Should contain a message describing log event.
+	 */
+	message: string;
+	/**
+	 * The process to which the log event pertains.
+	 */
+	process?: string;
+	/**
+	 * The thread to which the log event pertains.
+	 */
+	thread?: string;
+	/**
+	 * The application file to which the log event pertains.
+	 */
+	file?: string;
+	/**
+	 * The line number to which the log event pertains.
+	 */
+	line?: number;
+	/**
+	 * Identification of user to which log event pertains. Can be used to view log events for specific users.
+	 */
+	userId?: string;
+	/**
+	 * Name of logger generating the log event.
+	 */
+	loggerName?: string;
+	/**
+	 * Name of the service. E.g. user-service.
+	 */
+	serviceName: string;
+	/**
+	 * Version of the service. E.g. v2.0.2.
+	 */
+	serviceVersion: string;
+	serviceStack?: string;
+	/**
+	 * The id of a client/user request. Used to track a single request across services.
+	 */
+	xRequestId?: string;
+	/**
+	 * String tags to help categorize and/or filter log events
+	 */
+	tags?: string[];
+	/**
+	 * The current hostname for the service instance.
+	 */
+	host?: string;
+	/**
+	 * The current port number for the service instance.
+	 */
+	port?: number;
+	/**
+	 * A regular string or stringified JSON object containing data about log event.
+	 */
+	data?: string;
+	/**
+	 * The URL from which the log event was initiated.
+	 */
+	url?: string;
+	/**
+	 * The number of milliseconds spent on request/process.
+	 */
+	responseTime?: number;
+	/**
+	 * HTTP status code if applicable.
+	 */
+	statusCode?: number;
+	/**
+	 * HTTP method if applicable.
+	 */
+	method?: string;
+	error?: {
+		/**
+		 * A string representation of error type, e.g. NO_SUCH_VARIABLE_ERROR.
+		 */
+		type?: string;
+		/**
+		 * Error code uniquely identifiying error. E.g. 4324.
+		 */
+		code: string;
+		/**
+		 * Name of service where error originated if the error originated outside this service.
+		 */
+		serviceName?: string;
+		/**
+		 * Stack trace for the error. Should be santizied of sensitive information if possible.
+		 */
+		stack?: string;
+		/**
+		 * Any data that may be related to error in string format.
+		 */
+		data?: string;
+		/**
+		 * Regular string or stringified json object of original error object
+		 */
+		originalErrorObject?: string;
+	};
+	request?: {
+		/**
+		 * Request headers like Accept, If-Modified-Since, etc. Avoid logging sensitive headers!
+		 */
+		headers?: {
+			[k: string]: string;
+		};
+		/**
+		 * Query parameters contained within URL. E.g. (?myvalue=foo)
+		 */
+		query?: {
+			[k: string]: string | string[];
+		};
+		/**
+		 * Path parameters contained whithin URL. E.g. /resource/<pathparam>
+		 */
+		path?: {
+			[k: string]: string;
+		};
+		/**
+		 * The request payload/body if applicable (POST form, json payload, etc).
+		 */
+		payload?: string;
+	};
+	response?: {
+		/**
+		 * Response headers like eTag, Content-Length, etc. Avoid logging sensitive headers!
+		 */
+		headers?: {
+			[k: string]: string;
+		};
+		/**
+		 * A string representation of the response body. Do not log large bodies!
+		 */
+		body?: string;
+	};
+}
+
+declare module "log-schema.json" {
+    const value: LogSchema;
+    export default value;
+}
\ No newline at end of file

types/test.ts

+import { LogSchema } from "log-schema-node";
+import * as schema from "../log-schema/log-schema.json";
+
+const minimalEvent: LogSchema = {
+	schemaVersion: "v3",
+	"@timestamp": "1985-04-12T23:20:50.52Z",
+	levelName: "INFO",
+	message: "Ørliten melding",
+	serviceName: "some-service",
+	serviceVersion: "v1.0.0"
+};
+
+const fullEvent: LogSchema = {
+	schemaVersion: "v3",
+	"@timestamp": "1985-04-12T23:20:50.52Z",
+	levelName: "INFO",
+	message: "Ørliten melding",
+	userId: "some-user-id",
+	process: "main process id",
+	thread: "main thread id",
+	file: "main.java",
+	line: 42,
+	loggerName: "some-logger",
+	serviceName: "some-service",
+	serviceVersion: "v1.0.0",
+	serviceStack: "raird-stage-1",
+	host: "somehost",
+	port: 2100,
+	tags: [
+		"performance",
+	],
+	url: "/v0/hello",
+	responseTime: 120,
+	statusCode: 200,
+	method: "GET",
+	xRequestId: "cd88dba8-c8e1-4b2e-8a19-bc6220e0be65",
+	request: {
+		headers: {
+			"User-Agent": "curl/7.47.0",
+			Accept: "*/*"
+		},
+		path: {
+			param1: "param1-value",
+			param2: "param2-value"
+		},
+		query: {
+			query1: "query1-value",
+			query2: ["query2-value1", "query2-value2"]
+		},
+		payload: "{\"command\": \"tabulate\"}"
+	},
+	response: {
+		headers: {
+			"Content-Type": "application/octet-stream",
+			"X-Request-ID": "cd88dba8-c8e1-4b2e-8a19-bc6220e0be65",
+			"Content-Disposition": "attachment; filename=\"hello.bin\""
+		},
+		body: "{\"message\": \"Hello world!\"}"
+	},
+	error: {
+		type: "some-error",
+		code: "some-error-123",
+		serviceName: "some-external-service",
+		stack: "stacktrace1\nstacktrace2\nstacktrace3",
+		data: "more details...",
+		originalErrorObject: "stringobject"
+	},
+	data: "some-extra-string-data"
+};

types/tsconfig.json

+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": ["es6"],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+
+        // If the library is an external module (uses `export`), this allows your test file to import "mylib" instead of "./index".
+        // If the library is global (cannot be imported via `import` or `require`), leave this out.
+        "baseUrl": ".",
+        "paths": { "log-schema-node": ["."] }
+    }
+}
\ No newline at end of file

types/tslint.json

+{
+    "extends": "dtslint/dtslint.json",
+    "rules": {
+        "semicolon": false,
+        "indent": [true, "tabs"]
+    }
+}
\ No newline at end of file

yarn.lock

@@ -2,11 +2,15 @@
 # yarn lockfile v1
 
 
-ansi-regex@^2.1.1:
+ansi-regex@^2.0.0, ansi-regex@^2.1.1:
   version "2.1.1"
   resolved "https://nexus.nsd.no/repository/npm-group/ansi-regex/-/ansi-regex-2.1.1.tgz#c3b33ab5ee360d86e0e628f0468ae7ef27d654df"
 
-any-promise@^1.0.0:
+ansi-styles@^2.2.1:
+  version "2.2.1"
+  resolved "https://nexus.nsd.no/repository/npm-group/ansi-styles/-/ansi-styles-2.2.1.tgz#b432dd3358b634cf75e1e4664368240533c1ddbe"
+
+any-promise@^1.0.0, any-promise@^1.3.0:
   version "1.3.0"
   resolved "https://nexus.nsd.no/repository/npm-group/any-promise/-/any-promise-1.3.0.tgz#abc6afeedcea52e809cdc0376aed3ce39635d17f"
 
@@ -16,10 +20,39 @@ argparse@^1.0.7:
   dependencies:
     sprintf-js "~1.0.2"
 
+babel-code-frame@^6.22.0:
+  version "6.22.0"
+  resolved "https://nexus.nsd.no/repository/npm-group/babel-code-frame/-/babel-code-frame-6.22.0.tgz#027620bee567a88c32561574e7fd0801d33118e4"
+  dependencies:
+    chalk "^1.1.0"
+    esutils "^2.0.2"
+    js-tokens "^3.0.0"
+
+balanced-match@^0.4.1:
+  version "0.4.2"
+  resolved "https://nexus.nsd.no/repository/npm-group/balanced-match/-/balanced-match-0.4.2.tgz#cb3f3e3c732dc0f01ee70b403f302e61d7709838"
+
+brace-expansion@^1.1.7:
+  version "1.1.7"
+  resolved "https://nexus.nsd.no/repository/npm-group/brace-expansion/-/brace-expansion-1.1.7.tgz#3effc3c50e000531fb720eaff80f0ae8ef23cf59"
+  dependencies:
+    balanced-match "^0.4.1"
+    concat-map "0.0.1"
+
 call-me-maybe@^1.0.1:
   version "1.0.1"
   resolved "https://nexus.nsd.no/repository/npm-group/call-me-maybe/-/call-me-maybe-1.0.1.tgz#26d208ea89e37b5cbde60250a15f031c16a4d66b"
 
+chalk@^1.1.0:
+  version "1.1.3"
+  resolved "https://nexus.nsd.no/repository/npm-group/chalk/-/chalk-1.1.3.tgz#a8115c55e4a702fe4d150abd3872822a7e09fc98"
+  dependencies:
+    ansi-styles "^2.2.1"
+    escape-string-regexp "^1.0.2"
+    has-ansi "^2.0.0"
+    strip-ansi "^3.0.0"
+    supports-color "^2.0.0"
+
 cli-color@^1.2.0:
   version "1.2.0"
   resolved "https://nexus.nsd.no/repository/npm-group/cli-color/-/cli-color-1.2.0.tgz#3a5ae74fd76b6267af666e69e2afbbd01def34d1"
@@ -31,12 +64,20 @@ cli-color@^1.2.0:
     memoizee "^0.4.3"
     timers-ext "0.1"
 
+colors@^1.1.2:
+  version "1.1.2"
+  resolved "https://nexus.nsd.no/repository/npm-group/colors/-/colors-1.1.2.tgz#168a4701756b6a7f51a12ce0c97bfa28c084ed63"
+
 commander@^2.7.1:
   version "2.9.0"
   resolved "https://nexus.nsd.no/repository/npm-group/commander/-/commander-2.9.0.tgz#9c99094176e12240cb22d6c5146098400fe0f7d4"
   dependencies:
     graceful-readlink ">= 1.0.0"
 
+concat-map@0.0.1:
+  version "0.0.1"
+  resolved "https://nexus.nsd.no/repository/npm-group/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
+
 d@1:
   version "1.0.0"
   resolved "https://nexus.nsd.no/repository/npm-group/d/-/d-1.0.0.tgz#754bb5bfe55451da69a58b94d45f4c5b0462d58f"
@@ -49,6 +90,20 @@ debug@^2.2.0:
   dependencies:
     ms "0.7.3"
 
+diff@^3.2.0:
+  version "3.2.0"
+  resolved "https://nexus.nsd.no/repository/npm-group/diff/-/diff-3.2.0.tgz#c9ce393a4b7cbd0b058a725c93df299027868ff9"
+
+dtslint@Microsoft/dtslint#production:
+  version "0.1.2"
+  resolved "https://codeload.github.com/Microsoft/dtslint/tar.gz/c5519dc98939241684ba68e6400a1dad1c7a6358"
+  dependencies:
+    fs-promise "^2.0.0"
+    parsimmon "^1.2.0"
+    strip-json-comments "^2.0.1"
+    tslint "^5.1.0"
+    tsutils "^1.1.0"
+
 es5-ext@^0.10.12, es5-ext@^0.10.13, es5-ext@^0.10.14, es5-ext@^0.10.9, es5-ext@~0.10.14, es5-ext@~0.10.2:
   version "0.10.15"
   resolved "https://nexus.nsd.no/repository/npm-group/es5-ext/-/es5-ext-0.10.15.tgz#c330a5934c1ee21284a7c081a86e5fd937c91ea6"
@@ -84,10 +139,18 @@ es6-weak-map@^2.0.1:
     es6-iterator "^2.0.1"
     es6-symbol "^3.1.1"
 
+escape-string-regexp@^1.0.2:
+  version "1.0.5"
+  resolved "https://nexus.nsd.no/repository/npm-group/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4"
+
 esprima@^3.1.1:
   version "3.1.3"
   resolved "https://nexus.nsd.no/repository/npm-group/esprima/-/esprima-3.1.3.tgz#fdca51cee6133895e3c88d535ce49dbff62a4633"
 
+esutils@^2.0.2:
+  version "2.0.2"
+  resolved "https://nexus.nsd.no/repository/npm-group/esutils/-/esutils-2.0.2.tgz#0abf4f1caa5bcb1f7a9d8acc6dea4faaa04bac9b"
+
 event-emitter@^0.3.4:
   version "0.3.5"
   resolved "https://nexus.nsd.no/repository/npm-group/event-emitter/-/event-emitter-0.3.5.tgz#df8c69eef1647923c7157b9ce83840610b02cc39"
@@ -95,10 +158,78 @@ event-emitter@^0.3.4:
     d "1"
     es5-ext "~0.10.14"
 
+findup-sync@~0.3.0:
+  version "0.3.0"
+  resolved "https://nexus.nsd.no/repository/npm-group/findup-sync/-/findup-sync-0.3.0.tgz#37930aa5d816b777c03445e1966cc6790a4c0b16"
+  dependencies:
+    glob "~5.0.0"
+
+fs-extra@^2.0.0:
+  version "2.1.2"
+  resolved "https://nexus.nsd.no/repository/npm-group/fs-extra/-/fs-extra-2.1.2.tgz#046c70163cef9aad46b0e4a7fa467fb22d71de35"
+  dependencies:
+    graceful-fs "^4.1.2"
+    jsonfile "^2.1.0"
+
+fs-promise@^2.0.0:
+  version "2.0.3"
+  resolved "https://nexus.nsd.no/repository/npm-group/fs-promise/-/fs-promise-2.0.3.tgz#f64e4f854bcf689aa8bddcba268916db3db46854"
+  dependencies:
+    any-promise "^1.3.0"
+    fs-extra "^2.0.0"
+    mz "^2.6.0"
+    thenify-all "^1.6.0"
+
+fs.realpath@^1.0.0:
+  version "1.0.0"
+  resolved "https://nexus.nsd.no/repository/npm-group/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f"
+
+glob@^7.1.1:
+  version "7.1.1"
+  resolved "https://nexus.nsd.no/repository/npm-group/glob/-/glob-7.1.1.tgz#805211df04faaf1c63a3600306cdf5ade50b2ec8"
+  dependencies:
+    fs.realpath "^1.0.0"
+    inflight "^1.0.4"
+    inherits "2"
+    minimatch "^3.0.2"
+    once "^1.3.0"
+    path-is-absolute "^1.0.0"
+
+glob@~5.0.0:
+  version "5.0.15"
+  resolved "https://nexus.nsd.no/repository/npm-group/glob/-/glob-5.0.15.tgz#1bc936b9e02f4a603fcc222ecf7633d30b8b93b1"
+  dependencies:
+    inflight "^1.0.4"
+    inherits "2"
+    minimatch "2 || 3"
+    once "^1.3.0"
+    path-is-absolute "^1.0.0"
+
+graceful-fs@^4.1.2, graceful-fs@^4.1.6:
+  version "4.1.11"
+  resolved "https://nexus.nsd.no/repository/npm-group/graceful-fs/-/graceful-fs-4.1.11.tgz#0e8bdfe4d1ddb8854d64e04ea7c00e2a026e5658"
+
 "graceful-readlink@>= 1.0.0":
   version "1.0.1"
   resolved "https://nexus.nsd.no/repository/npm-group/graceful-readlink/-/graceful-readlink-1.0.1.tgz#4cafad76bc62f02fa039b2f94e9a3dd3a391a725"
 
+has-ansi@^2.0.0:
+  version "2.0.0"
+  resolved "https://nexus.nsd.no/repository/npm-group/has-ansi/-/has-ansi-2.0.0.tgz#34f5049ce1ecdf2b0649af3ef24e45ed35416d91"
+  dependencies:
+    ansi-regex "^2.0.0"
+
+inflight@^1.0.4:
+  version "1.0.6"
+  resolved "https://nexus.nsd.no/repository/npm-group/inflight/-/inflight-1.0.6.tgz#49bd6331d7d02d0c09bc910a1075ba8165b56df9"
+  dependencies:
+    once "^1.3.0"
+    wrappy "1"
+
+inherits@2:
+  version "2.0.3"
+  resolved "https://nexus.nsd.no/repository/npm-group/inherits/-/inherits-2.0.3.tgz#633c2c83e3da42a502f52466022480f4208261de"
+
 is-promise@^2.1:
   version "2.1.0"
   resolved "https://nexus.nsd.no/repository/npm-group/is-promise/-/is-promise-2.1.0.tgz#79a2a9ece7f096e80f36d2b2f3bc16c1ff4bf3fa"
@@ -109,6 +240,10 @@ jayschema@^0.3.1:
   dependencies:
     when "~3.4.6"
 
+js-tokens@^3.0.0:
+  version "3.0.1"
+  resolved "https://nexus.nsd.no/repository/npm-group/js-tokens/-/js-tokens-3.0.1.tgz#08e9f132484a2c45a30907e9dc4d5567b7f114d7"
+
 js-yaml@^3.6.0:
   version "3.8.4"
   resolved "https://nexus.nsd.no/repository/npm-group/js-yaml/-/js-yaml-3.8.4.tgz#520b4564f86573ba96662af85a8cafa7b4b5a6f6"
@@ -143,6 +278,12 @@ json-stringify-safe@^5.0.1:
   version "5.0.1"
   resolved "https://nexus.nsd.no/repository/npm-group/json-stringify-safe/-/json-stringify-safe-5.0.1.tgz#1296a2d58fd45f19a0f6ce01d65701e2c735b6eb"
 
+jsonfile@^2.1.0:
+  version "2.4.0"
+  resolved "https://nexus.nsd.no/repository/npm-group/jsonfile/-/jsonfile-2.4.0.tgz#3736a2b428b87bbda0cc83b53fa3d633a35c2ae8"
+  optionalDependencies:
+    graceful-fs "^4.1.6"
+
 lodash.get@^4.1.2:
   version "4.4.2"
   resolved "https://nexus.nsd.no/repository/npm-group/lodash.get/-/lodash.get-4.4.2.tgz#2d177f652fa31e939b4438d5341499dfa3825e99"
@@ -174,10 +315,20 @@ memoizee@^0.4.3:
     next-tick "1"
     timers-ext "0.1"
 
+"minimatch@2 || 3", minimatch@^3.0.2:
+  version "3.0.4"
+  resolved "https://nexus.nsd.no/repository/npm-group/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083"