improve ldap types (#199)

Author: dagda1

.changes/ldap-types.md

@@ -0,0 +1,4 @@
+---
+"@simulacrum/ldap-simulator": minor
+---
+improve ldap types

package-lock.json

@@ -31,7 +31,7 @@
     "@simulacrum/server": "^0.4.0"
   },
   "devDependencies": {
-    "@types/ldapjs": "^2.2.1",
+    "@types/ldapjs": "^2.2.2",
     "@types/seedrandom": "^3.0.1",
     "typescript": "^4.4.3"
   }

packages/ldap/package.json

@@ -1,7 +1,7 @@
-import type { Server } from 'ldapjs';
+import type { SearchRequest, Server, SearchResponse, CompareRequest, CompareResponse, BindResponse, BindRequest } from 'ldapjs';
 import type { Operation } from 'effection';
 import { createServer, InvalidCredentialsError, NoSuchObjectError, OperationsError } from 'ldapjs';
-import type { LDAPOptions } from './types';
+import type { LDAPOptions, LDAPStoreOptions, Port, UserData } from './types';
 import type { SimulationState, Simulator } from '@simulacrum/server';
 import type { ResourceServiceCreator } from '@simulacrum/server';
 import dedent from 'dedent';
@@ -14,18 +14,8 @@ const DefaultOptions: Partial<LDAPOptions> = {
   port: 389
 };
 
-interface UserData {
-  uuid: string;
-  cn: string;
-  password: string;
-}
-
-export interface LDAPStoreOptions<T extends UserData> {
-  users: Iterable<T>;
-}
-
-export interface Port {
-  port: number;
+export interface NextFunction {
+  <E>(err?: E): void;
 }
 
 export function createLDAPServer<T extends UserData>(options: LDAPOptions & LDAPStoreOptions<T>): Operation<Server & Port> {
@@ -54,23 +44,21 @@ export function createLDAPServer<T extends UserData>(options: LDAPOptions & LDAP
 
       let server = createServer({ log: silence });
 
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      server.search("", function (req: any, res: any, next: any) {
+      server.search("", function (req: SearchRequest, res: SearchResponse, next: NextFunction) {
         logger.log(dedent`--- Root DSE ---
-scope:  ${req.scope}
-`);
+        scope:  ${req.scope}
+        `);
         res.send({
-          "dn":"",
-          "attributes":{
+          dn: "",
+          attributes: {
             "vendorName": "Frontside, Inc."
           },
         });
         res.end();
         return next();
       });
 
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      server.search(baseDN, function (req: any, res: any, next: any) {
+      server.search(baseDN, function (req: SearchRequest, res: SearchResponse, next: NextFunction) {
         logger.log(dedent`--- User Search ---
 dn:     ${req.dn.toString()}
 scope:  ${req.scope}
@@ -106,18 +94,16 @@ filter: ${req.filter.toString()}
         return next();
       });
 
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      server.compare(groupDN, (req: any, res: any) => {
+      server.compare(groupDN, (req: CompareRequest, res: CompareResponse) => {
         logger.log('--- Compare ---');
         logger.log(`DN: ${req.dn.toString()}`);
         logger.log(`attribute name: ${req.attribute}`);
         logger.log(`attribute value: ${req.value}`);
 
-        res.end(true);
+        res.end(0);
       });
 
-      // eslint-disable-next-line @typescript-eslint/no-explicit-any
-      server.bind(baseDN, function (req: any, res: any, next: any) {
+      server.bind(baseDN, function (req: BindRequest, res: BindResponse, next: NextFunction) {
         logger.log('--- Bind ---');
         logger.log(`bind DN: ${req.dn.toString()}`);
         logger.log(`bind PW: ${req.credentials}`);

packages/ldap/src/index.ts

@@ -1,3 +1,42 @@
+declare module 'ldapjs' {
+  interface RDNS {
+    attrs: {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      [key: string]: any;
+    }
+  }
+  interface DN {
+    rdns: RDNS[];
+  }
+  export interface SearchRequest {
+    dn: DN;
+  }
+
+  export interface LDAPResult {
+    // 0 is success
+    end(status?: number): void;
+  }
+
+  export interface SearchResponse extends LDAPResult {
+    send(entry: SearchEntry | SearchReference, noFiltering?: boolean): void;
+  }
+
+  export interface CompareRequest {
+    entry: SearchEntry;
+    attribute: Attribute;
+    value: string | Buffer;
+    dn: DN;
+  }
+
+  export type CompareResponse = LDAPResult;
+  export type BindResponse = LDAPResult;
+
+  export interface BindRequest {
+    credentials: string;
+    dn: DN
+  }
+}
+
 export interface LDAPOptions {
   log?: boolean;
   port?: number;
@@ -6,3 +45,17 @@ export interface LDAPOptions {
   groupDN: string
   bindPassword: string;
 }
+
+export interface UserData {
+  uuid: string;
+  cn: string;
+  password: string;
+}
+
+export interface LDAPStoreOptions<T extends UserData> {
+  users: Iterable<T>;
+}
+
+export interface Port {
+  port: number;
+}