type definitions (#39)

* SchemaObject

* 0.0.16

* lock

* update

.gitignore

@@ -11,3 +11,4 @@ typings/
 .tern-project
 .DS_Store
 jsconfig.json
+.vs

index.d.ts

@@ -1,3 +1,5 @@
+import { MutableStringMap } from "@ts-common/string-map";
+
 interface SwaggerObject {
   "x-ms-paths"?: PathsObject
   paths?: PathsObject
@@ -10,13 +12,9 @@ interface SwaggerObject {
   readonly documents?: any
 }
 
-interface PathsObject {
-  [name: string]: PathItemObject
-}
+type PathsObject = MutableStringMap<PathItemObject>
 
-interface DefinitionsObject {
-  [name: string]: SchemaObject
-}
+type DefinitionsObject = MutableStringMap<SchemaObject>
 
 interface ParameterObject {
   name: string
@@ -27,13 +25,9 @@ interface ParameterObject {
   type?: DataType
 }
 
-interface ParametersDefinitionsObject {
-  [name: string]: ParameterObject
-}
+type ParametersDefinitionsObject = MutableStringMap<ParameterObject>
 
-interface ResponsesDefinitionsObject {
-  [name: string]: ResponseObject
-}
+type ResponsesDefinitionsObject = MutableStringMap<ResponseObject>
 
 interface PathItemObject extends PathItemObjectMethods {
   parameters?: ParameterObject[]
@@ -80,7 +74,7 @@ type PathItemObjectMethods = { [m in Methods]?: OperationObject }
  * JSON Schema "properties"
  */
 interface JsonSchemaProperties {
-  [name: string]: SchemaObject
+  [name: string]: SchemaObject|undefined
 }
 
 type Methods = "get" | "put" | "post" | "delete" | "options" | "head" | "patch"
@@ -95,7 +89,7 @@ interface OperationObject {
 
 interface ResponsesObject {
   default?: ResponseObject
-  [name: string]: ResponseObject | undefined
+  [name: string]: ResponseObject|undefined
 }
 
 declare interface Options {

package-lock.json

@@ -1,9 +1,31 @@
 {
   "name": "yasway",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
+    "@ts-common/iterator": {
+      "version": "0.0.32",
+      "resolved": "https://registry.npmjs.org/@ts-common/iterator/-/iterator-0.0.32.tgz",
+      "integrity": "sha512-8gIzoIOOb7IQoHV5Hgc3vFFTDxgdZIr02hpHCXGKSwxmCwU/SuoamI5Sk/FcDSGgIFtDX7wPVsIYYaBOM78pjg==",
+      "requires": {
+        "@ts-common/tuple": "0.0.0"
+      }
+    },
+    "@ts-common/string-map": {
+      "version": "0.0.16",
+      "resolved": "https://registry.npmjs.org/@ts-common/string-map/-/string-map-0.0.16.tgz",
+      "integrity": "sha512-IaOkBBJ7VcSWRStqVizumgVHuQ7YkB5s7JfY/+57XGQZ9SWnMZsUeflLHrTmfSWB6xv1WXIYvjZEYpeDxx9PnQ==",
+      "requires": {
+        "@ts-common/iterator": "0.0.32",
+        "@ts-common/tuple": "0.0.0"
+      }
+    },
+    "@ts-common/tuple": {
+      "version": "0.0.0",
+      "resolved": "https://registry.npmjs.org/@ts-common/tuple/-/tuple-0.0.0.tgz",
+      "integrity": "sha512-4ETK16scspsJamVLbsBNTU/hnZUhY0gpTiIK2F7A/3Pr6kNg5FrPNu9x+aAx2OvfyGN+U8NiGROyaZXN4v1FHg=="
+    },
     "JSONStream": {
       "version": "1.3.3",
       "resolved": "https://registry.npmjs.org/JSONStream/-/JSONStream-1.3.3.tgz",
@@ -4610,14 +4632,12 @@
         "balanced-match": {
           "version": "1.0.0",
           "bundled": true,
-          "dev": true,
-          "optional": true
+          "dev": true
         },
         "brace-expansion": {
           "version": "1.1.11",
           "bundled": true,
           "dev": true,
-          "optional": true,
           "requires": {
             "balanced-match": "^1.0.0",
             "concat-map": "0.0.1"
@@ -4632,20 +4652,17 @@
         "code-point-at": {
           "version": "1.1.0",
           "bundled": true,
-          "dev": true,
-          "optional": true
+          "dev": true
         },
         "concat-map": {
           "version": "0.0.1",
           "bundled": true,
-          "dev": true,
-          "optional": true
+          "dev": true
         },
         "console-control-strings": {
           "version": "1.1.0",
           "bundled": true,
-          "dev": true,
-          "optional": true
+          "dev": true
         },
         "core-util-is": {
           "version": "1.0.2",
@@ -4762,8 +4779,7 @@
         "inherits": {
           "version": "2.0.3",
           "bundled": true,
-          "dev": true,
-          "optional": true
+          "dev": true
         },
         "ini": {
           "version": "1.3.5",
@@ -4775,7 +4791,6 @@
           "version": "1.0.0",
           "bundled": true,
           "dev": true,
-          "optional": true,
           "requires": {
             "number-is-nan": "^1.0.0"
           }
@@ -4790,7 +4805,6 @@
           "version": "3.0.4",
           "bundled": true,
           "dev": true,
-          "optional": true,
           "requires": {
             "brace-expansion": "^1.1.7"
           }
@@ -4798,14 +4812,12 @@
         "minimist": {
           "version": "0.0.8",
           "bundled": true,
-          "dev": true,
-          "optional": true
+          "dev": true
         },
         "minipass": {
           "version": "2.2.4",
           "bundled": true,
           "dev": true,
-          "optional": true,
           "requires": {
             "safe-buffer": "^5.1.1",
             "yallist": "^3.0.0"
@@ -4824,7 +4836,6 @@
           "version": "0.5.1",
           "bundled": true,
           "dev": true,
-          "optional": true,
           "requires": {
             "minimist": "0.0.8"
           }
@@ -4905,8 +4916,7 @@
         "number-is-nan": {
           "version": "1.0.1",
           "bundled": true,
-          "dev": true,
-          "optional": true
+          "dev": true
         },
         "object-assign": {
           "version": "4.1.1",
@@ -4918,7 +4928,6 @@
           "version": "1.4.0",
           "bundled": true,
           "dev": true,
-          "optional": true,
           "requires": {
             "wrappy": "1"
           }
@@ -5040,7 +5049,6 @@
           "version": "1.0.2",
           "bundled": true,
           "dev": true,
-          "optional": true,
           "requires": {
             "code-point-at": "^1.0.0",
             "is-fullwidth-code-point": "^1.0.0",
@@ -13546,8 +13554,9 @@
       "dev": true
     },
     "z-schema": {
-      "version": "github:vladbarosan/z-schema#1cb38cd7bc98e8a9f2632998dc921162cfec03f9",
-      "from": "github:vladbarosan/z-schema",
+      "version": "3.23.0",
+      "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-3.23.0.tgz",
+      "integrity": "sha512-D8XV0BiHuQbWNEgu68RpjFZJ0C7jt+WYoszXKOohe54TdoTTauUvBQx+lsYCdalGIjGTFdQs5dxKvCUonUERzQ==",
       "requires": {
         "commander": "^2.7.1",
         "lodash.get": "^4.0.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "yasway",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "A library that simplifies Swagger integrations.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -65,6 +65,7 @@
     "vinyl-source-stream": "^2.0.0"
   },
   "dependencies": {
+    "@ts-common/string-map": "0.0.16",
     "debug": "^3.1.0",
     "faker": "^4.1.0",
     "js-base64": "^2.4.3",
@@ -77,6 +78,6 @@
     "rewire": "^4.0.0",
     "swagger-methods": "^1.0.0",
     "swagger-schema-official": "2.0.0-bab6bed",
-    "z-schema": "vladbarosan/z-schema"
+    "z-schema": "^3.23.0"
   }
 }