@nikitajs/network - npm Package Compare versions

Comparing version 1.0.0-alpha.1 to 1.0.0-alpha.2

CHANGELOG.md

@@ -6,2 +6,13 @@ # Change Log
 
+# [1.0.0-alpha.2](https://github.com/adaltas/node-nikita/compare/@nikitajs/network@1.0.0-alpha.1...@nikitajs/network@1.0.0-alpha.2) (2021-08-30)
+
+
+### Features
+
+* **network:** schema migration ([e7b4bce](https://github.com/adaltas/node-nikita/commit/e7b4bce5a101d09b5498a0667d2fa0aec803e626))
+
+
+
+
+
 # [1.0.0-alpha.1](https://github.com/adaltas/node-nikita/compare/@nikitajs/network@1.0.0-alpha.0...@nikitajs/network@1.0.0-alpha.1) (2021-03-10)
@@ -8,0 +19,0 @@

lib/http/index.js

@@ -40,95 +40,97 @@ // Generated by CoffeeScript 2.5.1
 
-// ## Schema
-var handler, schema, url, utils;
+// ## Schema definitions
+var definitions, handler, url, utils;
 
-schema = {
-  type: 'object',
-  properties: {
-    'cookies': {
-      type: 'array',
-      items: {
-        type: 'string'
+definitions = {
+  config: {
+    type: 'object',
+    properties: {
+      'cookies': {
+        type: 'array',
+        items: {
+          type: 'string'
+        },
+        description: `Extra cookies to include in the request when sending HTTP to a server.`
       },
-      description: `Extra cookies to include in the request when sending HTTP to a server.`
-    },
-    'data': {
-      type: ['array', 'boolean', 'null', 'number', 'object', 'string'],
-      description: `The request HTTP body associated with "POST" and "PUT" requests. The
+      'data': {
+        type: ['array', 'boolean', 'null', 'number', 'object', 'string'],
+        description: `The request HTTP body associated with "POST" and "PUT" requests. The
 \`Accept: application/json\` request header will be automatically
 inserted if not yet present and if \`data\` is not a string.`
-    },
-    'fail': {
-      type: 'boolean',
-      description: `Fail silently (no output at all) on HTTP errors.`
-    },
-    'gid': {
-      $ref: 'module://@nikitajs/core/lib/actions/fs/chown#/properties/gid',
-      description: `Group name or id who owns the target file; only apply if \`target\` is
+      },
+      'fail': {
+        type: 'boolean',
+        description: `Fail silently (no output at all) on HTTP errors.`
+      },
+      'gid': {
+        $ref: 'module://@nikitajs/core/lib/actions/fs/chown#/definitions/config/properties/gid',
+        description: `Group name or id who owns the target file; only apply if \`target\` is
 provided.`
-    },
-    'http_headers': {
-      type: 'object',
-      default: {},
-      description: `Extra header to include in the request when sending the HTTP request
+      },
+      'http_headers': {
+        type: 'object',
+        default: {},
+        description: `Extra header to include in the request when sending the HTTP request
 to a server.`
-    },
-    'insecure': {
-      type: 'boolean',
-      description: `Allow insecure server connections when using SSL; disabled if \`cacert\`
+      },
+      'insecure': {
+        type: 'boolean',
+        description: `Allow insecure server connections when using SSL; disabled if \`cacert\`
 is provided.`
-    },
-    'location': {
-      type: 'boolean',
-      description: `If the server reports that the requested page has moved to a different
+      },
+      'location': {
+        type: 'boolean',
+        description: `If the server reports that the requested page has moved to a different
 location (indicated with a Location: header and a 3XX response code),
 this option will make curl redo the request on the new place.`
-    },
-    'method': {
-      type: 'string',
-      default: 'GET',
-      description: `Specify request command (HTTP method) to use.`
-    },
-    'mode': {
-      $ref: 'module://@nikitajs/core/lib/actions/fs/chmod#/properties/mode',
-      description: `Permissions of the target. If specified, nikita will chmod after
+      },
+      'method': {
+        type: 'string',
+        default: 'GET',
+        description: `Specify request command (HTTP method) to use.`
+      },
+      'mode': {
+        $ref: 'module://@nikitajs/core/lib/actions/fs/chmod#/definitions/config/properties/mode',
+        description: `Permissions of the target. If specified, nikita will chmod after
 download.`
-    },
-    'negotiate': {
-      type: 'boolean',
-      description: `Use HTTP Negotiate (SPNEGO) authentication.`
-    },
-    'proxy': {
-      type: 'string',
-      description: `Use the specified HTTP proxy. If the port number is not specified, it
+      },
+      'negotiate': {
+        type: 'boolean',
+        description: `Use HTTP Negotiate (SPNEGO) authentication.`
+      },
+      'proxy': {
+        type: 'string',
+        description: `Use the specified HTTP proxy. If the port number is not specified, it
 is assumed at port 1080. See curl(1) man page.`
-    },
-    'password': {
-      type: 'string',
-      description: `Password associated with the Kerberos principal, required if
+      },
+      'password': {
+        type: 'string',
+        description: `Password associated with the Kerberos principal, required if
 \`principal\` is provided.`
-    },
-    'principal': {
-      type: 'string',
-      description: `Kerberos principal name if a ticket must be generated along the
+      },
+      'principal': {
+        type: 'string',
+        description: `Kerberos principal name if a ticket must be generated along the
 \`negociate\` option.`
-    },
-    'referer': {
-      type: 'string',
-      description: `An alias for connection.http_headers[\'Referer\']`
-    },
-    'target': {
-      type: 'string',
-      description: `Write to file instead of stdout; mapped to the curl \`output\` argument.`
-    },
-    'uid': {
-      $ref: 'module://@nikitajs/core/lib/actions/fs/chown#/properties/uid',
-      description: `User name or id who owns the target file; only apply if \`target\` is
+      },
+      'referer': {
+        type: 'string',
+        description: `An alias for connection.http_headers[\'Referer\']`
+      },
+      'target': {
+        type: 'string',
+        description: `Write to file instead of stdout; mapped to the curl \`output\` argument.`
+      },
+      'uid': {
+        $ref: 'module://@nikitajs/core/lib/actions/fs/chown#/definitions/config/properties/uid',
+        description: `User name or id who owns the target file; only apply if \`target\` is
 provided.`
+      },
+      'url': {
+        type: 'string',
+        description: `HTTP URL endpoint, must be a valid URL.`
+      }
     },
-    'url': {
-      type: 'string',
-      description: `HTTP URL endpoint, must be a valid URL.`
-    }
-  },
-  required: ['url']
+    required: ['url']
+  }
 };
@@ -275,7 +277,7 @@
 
-// # Export
+// ## Exports
 module.exports = {
   handler: handler,
   metadata: {
-    schema: schema
+    definitions: definitions
   }
@@ -282,0 +284,0 @@ };

lib/tcp/assert.js

@@ -7,3 +7,3 @@ // Generated by CoffeeScript 2.5.1
 // ## Hooks
-var handler, on_action, schema, utils;
+var definitions, handler, on_action, utils;
 
@@ -68,19 +68,21 @@ on_action = function({config}) {
 
-// ## Schema
-schema = {
-  type: 'object',
-  properties: {
-    'host': {
-      $ref: 'module://@nikitajs/network/lib/tcp/wait#/properties/host',
-      description: `Host of the targeted server, could be a FQDN, a hostname or an IP.`
-    },
-    'port': {
-      $ref: 'module://@nikitajs/network/lib/tcp/wait#/properties/port',
-      description: `Port of the targeted server.`
-    },
-    'server': {
-      $ref: 'module://@nikitajs/network/lib/tcp/wait#/properties/server'
-    },
-    'not': {
-      $ref: 'module://@nikitajs/core/lib/actions/assert#/properties/not'
+// ## Schema definitions
+definitions = {
+  config: {
+    type: 'object',
+    properties: {
+      'host': {
+        $ref: 'module://@nikitajs/network/lib/tcp/wait#/definitions/config/properties/host',
+        description: `Host of the targeted server, could be a FQDN, a hostname or an IP.`
+      },
+      'port': {
+        $ref: 'module://@nikitajs/network/lib/tcp/wait#/definitions/config/properties/port',
+        description: `Port of the targeted server.`
+      },
+      'server': {
+        $ref: 'module://@nikitajs/network/lib/tcp/wait#/definitions/config/properties/server'
+      },
+      'not': {
+        $ref: 'module://@nikitajs/core/lib/actions/assert#/definitions/config/properties/not'
+      }
     }
@@ -127,3 +129,3 @@ }
     shy: true,
-    schema: schema
+    definitions: definitions
   }
@@ -130,0 +132,0 @@ };

lib/tcp/wait.js

@@ -53,3 +53,3 @@ // Generated by CoffeeScript 2.5.1
 // ## Hooks
-var handler, on_action, schema, utils;
+var definitions, handler, on_action, utils;
 
@@ -114,78 +114,80 @@ on_action = function({config}) {
 
-// ## Schema
-schema = {
-  type: 'object',
-  properties: {
-    'host': {
-      type: 'array',
-      items: {
-        type: 'string'
+// ## Schema definitions
+definitions = {
+  config: {
+    type: 'object',
+    properties: {
+      'host': {
+        type: 'array',
+        items: {
+          type: 'string'
+        },
+        description: `One or multiple hosts, used to build or enrich the 'server' option.`
       },
-      description: `One or multiple hosts, used to build or enrich the 'server' option.`
-    },
-    'interval': {
-      type: 'number',
-      description: `Time in millisecond between each connection attempt.`
-    },
-    'quorum': {
-      type: ['boolean', 'integer'],
-      description: `Number of minimal successful connection, 50%+1 if "true".`
-    },
-    'port': {
-      type: 'array',
-      items: {
-        type: 'integer'
+      'interval': {
+        type: 'number',
+        description: `Time in millisecond between each connection attempt.`
       },
-      description: `One or multiple ports, used to build or enrich the 'server' option.`
-    },
-    'randdir': {
-      type: 'string',
-      description: `Directory where to write temporary file used internally to store state
+      'quorum': {
+        type: ['boolean', 'integer'],
+        description: `Number of minimal successful connection, 50%+1 if "true".`
+      },
+      'port': {
+        type: 'array',
+        items: {
+          type: 'integer'
+        },
+        description: `One or multiple ports, used to build or enrich the 'server' option.`
+      },
+      'randdir': {
+        type: 'string',
+        description: `Directory where to write temporary file used internally to store state
 information. It default to a temporary location.`
-    },
-    'server': {
-      oneOf: [
-        {
-          type: 'string'
-        },
-        {
-          type: 'object',
-          properties: {
-            host: {
-              $ref: '#/properties/host'
-            },
-            port: {
-              $ref: '#/properties/port'
+      },
+      'server': {
+        oneOf: [
+          {
+            type: 'string'
+          },
+          {
+            type: 'object',
+            properties: {
+              host: {
+                $ref: '#/definitions/config/properties/host'
+              },
+              port: {
+                $ref: '#/definitions/config/properties/port'
+              }
             }
-          }
-        },
-        {
-          type: 'array',
-          items: {
-            oneOf: [
-              {
-                type: 'string'
-              },
-              {
-                type: 'object',
-                properties: {
-                  host: {
-                    $ref: '#/properties/host'
-                  },
-                  port: {
-                    $ref: '#/properties/port'
+          },
+          {
+            type: 'array',
+            items: {
+              oneOf: [
+                {
+                  type: 'string'
+                },
+                {
+                  type: 'object',
+                  properties: {
+                    host: {
+                      $ref: '#/definitions/config/properties/host'
+                    },
+                    port: {
+                      $ref: '#/definitions/config/properties/port'
+                    }
                   }
                 }
-              }
-            ]
+              ]
+            }
           }
-        }
-      ],
-      description: `One or multiple servers, string must be in the form of
+        ],
+        description: `One or multiple servers, string must be in the form of
 "{host}:{port}", object must have the properties "host" and "port".`
-    },
-    'timeout': {
-      type: 'integer',
-      description: `Maximum time in millisecond to wait until this function is considered
+      },
+      'timeout': {
+        type: 'integer',
+        description: `Maximum time in millisecond to wait until this function is considered
 to have failed.`
+      }
     }
@@ -321,3 +323,3 @@ }
   metadata: {
-    schema: schema
+    definitions: definitions
   }
@@ -324,0 +326,0 @@ };

package.json

 {
   "name": "@nikitajs/network",
-  "description": "Nikita network actions.",
+  "description": "Provides Nikita actions for networking operations.",
   "keywords": [
@@ -14,3 +14,3 @@ "nikita",
   ],
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.2",
   "author": "David Worms <[e-mail]>",
@@ -44,7 +44,7 @@ "bugs": {
   "peerDependencies": {
-    "@nikitajs/core": "^1.0.0"
+    "@nikitajs/core": "^1.0.0-alpha.1"
   },
   "devDependencies": {
     "coffeescript": "^2.5.1",
-    "mocha": "^8.3.1",
+    "mocha": "^8.3.2",
     "mocha-they": "^0.1.2",
@@ -86,3 +86,3 @@ "should": "^13.2.3"
   },
-  "gitHead": "86d25e2158736f77e88edae3f243fcaba1b0b8b2"
+  "gitHead": "07c87a8ab6e733021d0e3722b3457e45a9ec9480"
 }

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

30409

increased by3.84%

Number of package files

10

increased by11.11%

Lines of code

908

increased by0.67%

Number of medium quality alerts

1

decreased by-50%

Number of lines in readme file

5

increased byInfinity%

No dependency changes