ldapts - npm Package Compare versions

Comparing version 1.6.0 to 1.7.0

CHANGELOG.md

@@ -0,1 +1,5 @@
+### 1.7.0
+  * Add DN class as alternate option for specifying DNs. Thanks @adrianplavka!
+  * Update npms
+
 ### 1.6.0
@@ -2,0 +6,0 @@ * Fix incorrectly escaping search filter names/values. Fix #18

dist/Client.d.ts

@@ -7,2 +7,3 @@ /// <reference types="node" />
 import { Filter } from './filters/Filter';
+import { DN } from './dn';
 import { Entry } from './messages';
@@ -98,14 +99,14 @@ export interface ClientOptions {
      * Performs a simple authentication against the server.
-     * @param {string} dn
+     * @param {string|DN} dn
      * @param {string} [password]
      * @param {Control|Control[]} [controls]
      */
-    bind(dn: string, password?: string, controls?: Control | Control[]): Promise<void>;
+    bind(dn: string | DN, password?: string, controls?: Control | Control[]): Promise<void>;
     /**
      * Used to create a new entry in the directory
-     * @param {string} dn - DN of the entry to add
+     * @param {string|DN} dn - The DN of the entry to add
      * @param {Attribute[]|Object} attributes - Array of attributes or object where keys are the name of each attribute
      * @param {Control|Control[]} [controls]
      */
-    add(dn: string, attributes: Attribute[] | {
+    add(dn: string | DN, attributes: Attribute[] | {
         [index: string]: string | string[];
@@ -115,3 +116,3 @@ }, controls?: Control | Control[]): Promise<void>;
      * Compares an attribute/value pair with an entry on the LDAP server.
-     * @param {string} dn - The DN of the entry to compare attributes with
+     * @param {string|DN} dn - The DN of the entry to compare attributes with
      * @param {string} attribute
@@ -121,9 +122,9 @@ * @param {string} value
      */
-    compare(dn: string, attribute: string, value: string, controls?: Control | Control[]): Promise<boolean>;
+    compare(dn: string | DN, attribute: string, value: string, controls?: Control | Control[]): Promise<boolean>;
     /**
      * Deletes an entry from the LDAP server.
-     * @param {string} dn - The DN of the entry to delete
+     * @param {string|DN} dn - The DN of the entry to delete
      * @param {Control|Control[]} [controls]
      */
-    del(dn: string, controls?: Control | Control[]): Promise<void>;
+    del(dn: string | DN, controls?: Control | Control[]): Promise<void>;
     /**
@@ -141,18 +142,18 @@ * Performs an extended operation on the LDAP server.
      * Performs an LDAP modify against the server.
-     * @param {string} dn - The DN of the entry to modify
+     * @param {string|DN} dn - The DN of the entry to modify
      * @param {Change|Change[]} changes
      * @param {Control|Control[]} [controls]
      */
-    modify(dn: string, changes: Change | Change[], controls?: Control | Control[]): Promise<void>;
+    modify(dn: string | DN, changes: Change | Change[], controls?: Control | Control[]): Promise<void>;
     /**
      * Performs an LDAP modifyDN against the server.
-     * @param {string} dn - The DN of the entry to modify
-     * @param {string} newDN - The new DN to move this entry to
+     * @param {string|DN} dn - The DN of the entry to modify
+     * @param {string|DN} newDN - The new DN to move this entry to
      * @param {Control|Control[]} [controls]
      */
-    modifyDN(dn: string, newDN: string, controls?: Control | Control[]): Promise<void>;
+    modifyDN(dn: string | DN, newDN: string | DN, controls?: Control | Control[]): Promise<void>;
     /**
      * Performs an LDAP search against the server.
      *
-     * @param {string} baseDN - This specifies the base of the subtree in which the search is to be constrained.
+     * @param {string|DN} baseDN - This specifies the base of the subtree in which the search is to be constrained.
      * @param {SearchOptions} [options]
@@ -177,3 +178,3 @@ * @param {string|Filter} [options.filter=(objectclass=*)] - The filter of the search request. It must conform to the LDAP filter syntax specified in RFC4515
      */
-    search(baseDN: string, options?: SearchOptions, controls?: Control | Control[]): Promise<SearchResult>;
+    search(baseDN: string | DN, options?: SearchOptions, controls?: Control | Control[]): Promise<SearchResult>;
     /**
@@ -180,0 +181,0 @@ * Unbinds this client from the LDAP server.

dist/Client.js

@@ -68,3 +68,3 @@ "use strict";
      * Performs a simple authentication against the server.
-     * @param {string} dn
+     * @param {string|DN} dn
      * @param {string} [password]
@@ -83,3 +83,3 @@ * @param {Control|Control[]} [controls]
             messageId: this._nextMessageId(),
-            dn,
+            dn: typeof dn === 'string' ? dn : dn.toString(),
             password,
@@ -95,3 +95,3 @@ controls,
      * Used to create a new entry in the directory
-     * @param {string} dn - DN of the entry to add
+     * @param {string|DN} dn - The DN of the entry to add
      * @param {Attribute[]|Object} attributes - Array of attributes or object where keys are the name of each attribute
@@ -130,3 +130,3 @@ * @param {Control|Control[]} [controls]
             messageId: this._nextMessageId(),
-            dn,
+            dn: typeof dn === 'string' ? dn : dn.toString(),
             attributes: attributesToAdd,
@@ -142,3 +142,3 @@ controls,
      * Compares an attribute/value pair with an entry on the LDAP server.
-     * @param {string} dn - The DN of the entry to compare attributes with
+     * @param {string|DN} dn - The DN of the entry to compare attributes with
      * @param {string} attribute
@@ -158,3 +158,3 @@ * @param {string} value
             messageId: this._nextMessageId(),
-            dn,
+            dn: typeof dn === 'string' ? dn : dn.toString(),
             attribute,
@@ -176,3 +176,3 @@ value,
      * Deletes an entry from the LDAP server.
-     * @param {string} dn - The DN of the entry to delete
+     * @param {string|DN} dn - The DN of the entry to delete
      * @param {Control|Control[]} [controls]
@@ -190,3 +190,3 @@ */
             messageId: this._nextMessageId(),
-            dn,
+            dn: typeof dn === 'string' ? dn : dn.toString(),
             controls,
@@ -230,3 +230,3 @@ });
      * Performs an LDAP modify against the server.
-     * @param {string} dn - The DN of the entry to modify
+     * @param {string|DN} dn - The DN of the entry to modify
      * @param {Change|Change[]} changes
@@ -249,3 +249,3 @@ * @param {Control|Control[]} [controls]
             messageId: this._nextMessageId(),
-            dn,
+            dn: typeof dn === 'string' ? dn : dn.toString(),
             changes,
@@ -261,4 +261,4 @@ controls,
      * Performs an LDAP modifyDN against the server.
-     * @param {string} dn - The DN of the entry to modify
-     * @param {string} newDN - The new DN to move this entry to
+     * @param {string|DN} dn - The DN of the entry to modify
+     * @param {string|DN} newDN - The new DN to move this entry to
      * @param {Control|Control[]} [controls]
@@ -277,5 +277,5 @@ */
             messageId: this._nextMessageId(),
-            dn,
+            dn: typeof dn === 'string' ? dn : dn.toString(),
             deleteOldRdn: true,
-            newRdn: newDN,
+            newRdn: typeof newDN === 'string' ? newDN : newDN.toString(),
             controls,
@@ -291,3 +291,3 @@ });
      *
-     * @param {string} baseDN - This specifies the base of the subtree in which the search is to be constrained.
+     * @param {string|DN} baseDN - This specifies the base of the subtree in which the search is to be constrained.
      * @param {SearchOptions} [options]
@@ -358,3 +358,3 @@ * @param {string|Filter} [options.filter=(objectclass=*)] - The filter of the search request. It must conform to the LDAP filter syntax specified in RFC4515
             messageId: -1,
-            baseDN,
+            baseDN: typeof baseDN === 'string' ? baseDN : baseDN.toString(),
             scope: options.scope,
@@ -361,0 +361,0 @@ filter: options.filter,

dist/index.d.ts

 export * from './Client';
+export * from './dn';

dist/index.js

@@ -7,2 +7,3 @@ "use strict";
 __export(require("./Client"));
+__export(require("./dn"));
 //# sourceMappingURL=index.js.map

package.json

 {
   "name": "ldapts",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "LDAP client",
@@ -47,6 +47,6 @@ "main": "dist/index.js",
     "@types/mocha": "~5.2.6",
-    "@types/node": "~11.13.7",
+    "@types/node": "~8.10.48",
     "chai": "~4.2.0",
     "chai-as-promised": "~7.1.1",
-    "husky": "~2.0.0",
+    "husky": "~2.3.0",
     "mocha": "~6.1.4",
@@ -53,0 +53,0 @@ "ts-mockito": "~2.3.1",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

293515

increased by6.86%

Number of package files

289

increased by3.21%

Lines of code

4751

increased by9.55%

No dependency changes