@ldapjs/messages - npm Package Compare versions

Comparing version 1.0.0-rc.3 to 1.0.0

lib/ldap-result.js

@@ -19,3 +19,3 @@ 'use strict'
   /**
-   * @typedef {object} LdapResultOptions
+   * @typedef {LdapMessageOptions} LdapResultOptions
    * @property {number} [status=0] An LDAP status code.
@@ -22,0 +22,0 @@ * @param {string} [matchedDN=''] The DN that matched the request.

lib/messages/abandon-request.js

@@ -15,6 +15,9 @@ 'use strict'
   /**
-   * @param {object} [options]
-   * @param {number} [options.abandonId=0] The message id of the request to
-   * abandon.
+   * @typedef {LdapMessageOptions} AbandonRequestOptions
+   * @property {number} [abandonId=0] The message id of the request to abandon.
    */
+
+  /**
+   * @param {AbandonRequestOptions} [options]
+   */
   constructor (options = {}) {
@@ -55,3 +58,5 @@ options.protocolOp = Protocol.operations.LDAP_REQ_ABANDON
    */
-  get type () { return 'AbandonRequest' }
+  get type () {
+    return 'AbandonRequest'
+  }
 
@@ -58,0 +63,0 @@ /**

lib/messages/abandon-response.js

@@ -9,2 +9,5 @@ 'use strict'
 class AbandonResponse extends LdapResult {
+  /**
+   * @param {LdapResultOptions} options
+   */
   constructor (options = {}) {
@@ -11,0 +14,0 @@ options.protocolOp = 0x00

lib/messages/add-request.js

@@ -28,6 +28,10 @@ 'use strict'
   /**
-   * @param {object} [options]
-   * @param {string} [options.entry=null] The path to the LDAP object.
-   * @param {import('@ldapjs/attribute')[]} [options.attributes=[]] A
-   * set of attributes to store at the `entry` path.
+   * @typedef {LdapMessageOptions} AddRequestOptions
+   * @property {string} [entry=null] The path to the LDAP object.
+   * @property {import('@ldapjs/attribute')[]} [attributes=[]] A set of
+   * attributes to store at the `entry` path.
+   */
+
+  /**
+   * @param {AddRequestOptions} [options]
    *
@@ -34,0 +38,0 @@ * @throws When the provided attributes list is invalid.

lib/messages/add-response.js

@@ -11,2 +11,5 @@ 'use strict'
 class AddResponse extends LdapResult {
+  /**
+   * @param {LdapResultOptions} options
+   */
   constructor (options = {}) {
@@ -13,0 +16,0 @@ options.protocolOp = operations.LDAP_RES_ADD

lib/messages/bind-request.js

@@ -24,9 +24,13 @@ 'use strict'
   /**
-   * @param {object} [options]
-   * @param {number} [options.version=3] Version of the protocol being used.
-   * @param {string} [options.name=null] The "username" (dn) to connect with.
-   * @param {string} [options.authentication='simple'] The authentication
+   * @typedef {LdapMessageOptions} BindRequestOptions
+   * @property {number} [version=3] Version of the protocol being used.
+   * @property {string} [name=null] The "username" (dn) to connect with.
+   * @property {string} [authentication='simple'] The authentication
    * mechanism to use. Currently, only `simple` is supported.
-   * @param {string} [options.credentials=''] The password to use.
+   * @property {string} [credentials=''] The password to use.
    */
+
+  /**
+   * @param {BindRequestOptions} [options]
+   */
   constructor (options = {}) {
@@ -33,0 +37,0 @@ options.protocolOp = Protocol.operations.LDAP_REQ_BIND

lib/messages/bind-response.js

@@ -11,2 +11,5 @@ 'use strict'
 class BindResponse extends LdapResult {
+  /**
+   * @param {LdapResultOptions} options
+   */
   constructor (options = {}) {
@@ -13,0 +16,0 @@ options.protocolOp = operations.LDAP_RES_BIND

lib/messages/compare-request.js

@@ -17,9 +17,13 @@ 'use strict'
   /**
-   * @param {object} [options]
-   * @param {string|null} [options.attribute] The attribute name to compare
+   * @typedef {LdapMessageOptions} CompareRequestOptions
+   * @property {string|null} [attribute] The attribute name to compare
    * against.
-   * @param {string} [options.entry] The target LDAP entity whose attribute
+   * @property {string} [entry] The target LDAP entity whose attribute
    * will be compared.
-   * @param {string} [options.value] The value of the attribute to compare.
+   * @property {string} [value] The value of the attribute to compare.
    */
+
+  /**
+   * @param {CompareRequestOptions} [options]
+   */
   constructor (options = {}) {
@@ -26,0 +30,0 @@ options.protocolOp = operations.LDAP_REQ_COMPARE

lib/messages/compare-response.js

@@ -11,2 +11,5 @@ 'use strict'
 class CompareResponse extends LdapResult {
+  /**
+   * @param {LdapResultOptions} options
+   */
   constructor (options = {}) {
@@ -13,0 +16,0 @@ options.protocolOp = operations.LDAP_RES_COMPARE

lib/messages/delete-request.js

@@ -15,5 +15,9 @@ 'use strict'
   /**
-   * @param {object} [options]
-   * @param {string} [options.entry=null] The LDAP entry path to remove.
+   * @typedef {LdapMessageOptions} DeleteRequestOptions
+   * @property {string} [entry=null] The LDAP entry path to remove.
    */
+
+  /**
+   * @param {DeleteRequestOptions} [options]
+   */
   constructor (options = {}) {
@@ -20,0 +24,0 @@ options.protocolOp = Protocol.operations.LDAP_REQ_DELETE

lib/messages/delete-response.js

@@ -11,2 +11,5 @@ 'use strict'
 class DeleteResponse extends LdapResult {
+  /**
+   * @param {LdapResultOptions} options
+   */
   constructor (options = {}) {
@@ -13,0 +16,0 @@ options.protocolOp = operations.LDAP_RES_DELETE

lib/messages/extension-request.js

@@ -20,6 +20,6 @@ 'use strict'
   /**
-   * @param {object} [options]
-   * @param {string} [options.requestName=''] The name of the extension, i.e.
+   * @typedef {LdapMessageOptions} ExtensionRequestOptions
+   * @property {string} [requestName=''] The name of the extension, i.e.
    * OID for the request.
-   * @param {string|object} [options.requestValue] The value for the request.
+   * @property {string|object} [requestValue] The value for the request.
    * If `undefined`, no value will be sent. If the request requires a simple
@@ -31,2 +31,6 @@ * string value, provide such a string. For complex valued requests, e.g.
    */
+
+  /**
+   * @param {ExtensionRequestOptions} [options]
+   */
   constructor (options = {}) {
@@ -33,0 +37,0 @@ options.protocolOp = operations.LDAP_REQ_EXTENSION

lib/messages/extension-response.js

@@ -26,6 +26,6 @@ 'use strict'
   /**
-   * @param {object} options
-   * @param {string|undefined} [responseName] The name of the extension, i.e.
+   * @typedef {LdapResultOptions} ExtensionResponseOptions
+   * @property {string|undefined} [responseName] The name of the extension, i.e.
    * OID for the response.
-   * @param {string|undefined} [responseValue] The value for the
+   * @property {string|undefined} [responseValue] The value for the
    * response. It may be a buffer string; such a string is a series of
@@ -36,2 +36,6 @@ * hexadecimal pairs preceded by the token `<buffer>`. Buffer strings
    */
+
+  /**
+   * @param {ExtensionResponseOptions} [options]
+   */
   constructor (options = {}) {
@@ -38,0 +42,0 @@ options.protocolOp = operations.LDAP_RES_EXTENSION

lib/messages/modify-request.js

@@ -29,7 +29,11 @@ 'use strict'
   /**
-   * @param {object} [options]
-   * @param {string|null} [options.object] The LDAP object (DN) to modify.
-   * @param {import('@ldapjs/change')[]} [options.changes] The set of
-   * changes to apply.
+   * @typedef {LdapMessageOptions} ModifyRequestOptions
+   * @property {string|null} [object] The LDAP object (DN) to modify.
+   * @property {import('@ldapjs/change')[]} [changes] The set of changes to
+   * apply.
    */
+
+  /**
+   * @param {ModifyRequestOptions} [options]
+   */
   constructor (options = {}) {
@@ -36,0 +40,0 @@ options.protocolOp = operations.LDAP_REQ_MODIFY

lib/messages/modify-response.js

@@ -11,2 +11,5 @@ 'use strict'
 class ModifyResponse extends LdapResult {
+  /**
+   * @param {LdapResultOptions} options
+   */
   constructor (options = {}) {
@@ -13,0 +16,0 @@ options.protocolOp = operations.LDAP_RES_MODIFY

lib/messages/modifydn-request.js

@@ -18,11 +18,15 @@ 'use strict'
   /**
-   * @param {object} [options]
-   * @param {string|null} [options.entry=null] The path to the LDAP object.
-   * @param {string|null} [options.newRdn=null] Path to the new object for the
+   * @typedef {LdapMessageOptions} ModifyDnRequestOptions
+   * @property {string|null} [entry=null] The path to the LDAP object.
+   * @property {string|null} [newRdn=null] Path to the new object for the
    * entry.
-   * @param {boolean} [options.deleteOldRdn=false] Indicates if attributes
+   * @property {boolean} [deleteOldRdn=false] Indicates if attributes
    * should be removed in the new RDN that were in the old RDN but not the
    * new one.
-   * @param {string} [options.newSuperior] Path for the new parent for
+   * @property {string} [newSuperior] Path for the new parent for
    * the RDN.
+   */
+
+  /**
+   * @param {ModifyDnRequestOptions} [options]
    *
@@ -29,0 +33,0 @@ * @throws When an option is invalid (e.g. `deleteOldRdn` is not a boolean

lib/messages/modifydn-response.js

@@ -11,2 +11,5 @@ 'use strict'
 class ModifyDnResponse extends LdapResult {
+  /**
+   * @param {LdapResultOptions} options
+   */
   constructor (options = {}) {
@@ -13,0 +16,0 @@ options.protocolOp = operations.LDAP_RES_MODRDN

lib/messages/unbind-request.js

@@ -12,3 +12,3 @@ 'use strict'
   /**
-   * @param {object} [options]
+   * @param {LdapMessageOptions} options
    */
@@ -15,0 +15,0 @@ constructor (options = {}) {

package.json

@@ -5,3 +5,3 @@ {
   "description": "API for creating and parsing LDAP messages",
-  "version": "1.0.0-rc.3",
+  "version": "1.0.0",
   "license": "MIT",
@@ -14,20 +14,20 @@ "repository": {
   "dependencies": {
-    "@ldapjs/asn1": "2.0.0-rc.4",
-    "@ldapjs/attribute": "1.0.0-rc.5",
-    "@ldapjs/change": "1.0.0-rc.3",
-    "@ldapjs/controls": "2.0.0-rc.1",
-    "@ldapjs/dn": "1.0.0-rc.1",
-    "@ldapjs/filter": "2.0.0-rc.5",
+    "@ldapjs/asn1": "2.0.0",
+    "@ldapjs/attribute": "1.0.0",
+    "@ldapjs/change": "1.0.0",
+    "@ldapjs/controls": "2.0.0",
+    "@ldapjs/dn": "1.0.0",
+    "@ldapjs/filter": "2.0.0",
     "@ldapjs/protocol": "1.2.1",
-    "process-warning": "^2.0.0"
+    "process-warning": "^2.1.0"
   },
   "devDependencies": {
     "@fastify/pre-commit": "^2.0.2",
-    "eslint": "^8.17.0",
+    "eslint": "^8.34.0",
     "eslint-config-standard": "^17.0.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-n": "^15.2.2",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-n": "^15.6.1",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^6.0.0",
-    "tap": "^16.2.0"
+    "eslint-plugin-promise": "^6.1.1",
+    "tap": "^16.3.4"
   },
@@ -34,0 +34,0 @@ "scripts": {

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

233690

increased by0.44%

Lines of code

7712

increased by0.64%

Number of low quality alerts

0

decreased by-100%

Dependency changes

• + Added@ldapjs/asn1@2.0.0(transitive)

• + Added@ldapjs/attribute@1.0.0(transitive)

• + Added@ldapjs/change@1.0.0(transitive)

• + Added@ldapjs/controls@2.0.0(transitive)

• + Added@ldapjs/dn@1.0.0(transitive)

• + Added@ldapjs/filter@2.0.0(transitive)

• - Removed@ldapjs/asn1@2.0.0-rc.4(transitive)

• - Removed@ldapjs/attribute@1.0.0-rc.5(transitive)

• - Removed@ldapjs/change@1.0.0-rc.3(transitive)

• - Removed@ldapjs/codes@1.0.0(transitive)

• - Removed@ldapjs/controls@2.0.0-rc.1(transitive)

• - Removed@ldapjs/dn@1.0.0-rc.1(transitive)

• - Removed@ldapjs/filter@2.0.0-rc.5(transitive)

• Updated@ldapjs/asn1@2.0.0

• Updated@ldapjs/attribute@1.0.0

• Updated@ldapjs/change@1.0.0

• Updated@ldapjs/controls@2.0.0

• Updated@ldapjs/dn@1.0.0

• Updated@ldapjs/filter@2.0.0

• Updatedprocess-warning@^2.1.0