@feathersjs/adapter-tests 5.0.0-pre.3 → 5.0.0-pre.30

package/src/basic.ts

@@ -1,53 +1,74 @@
-import assert from 'assert';
+import assert from 'assert'
+import { AdapterBasicTest } from './declarations'
 
-export default (test: any, app: any, _errors: any, serviceName: string, idProp: string) => {
+export default (test: AdapterBasicTest, app: any, _errors: any, serviceName: string, idProp: string) => {
   describe('Basic Functionality', () => {
-    let service: any;
+    let service: any
 
     beforeEach(() => {
-      service = app.service(serviceName);
-    });
+      service = app.service(serviceName)
+    })
 
     it('.id', () => {
-      assert.strictEqual(service.id, idProp,
-        'id property is set to expected name'
-      );
-    });
+      assert.strictEqual(service.id, idProp, 'id property is set to expected name')
+    })
 
     test('.options', () => {
-      assert.ok(service.options, 'Options are available in service.options');
-    });
+      assert.ok(service.options, 'Options are available in service.options')
+    })
 
     test('.events', () => {
-      assert.ok(service.events.includes('testing'),
-        'service.events is set and includes "testing"'
-      );
-    });
+      assert.ok(service.events.includes('testing'), 'service.events is set and includes "testing"')
+    })
 
     describe('Raw Methods', () => {
       test('._get', () => {
-        assert.strictEqual(typeof service._get, 'function');
-      });
+        assert.strictEqual(typeof service._get, 'function')
+      })
 
       test('._find', () => {
-        assert.strictEqual(typeof service._find, 'function');
-      });
+        assert.strictEqual(typeof service._find, 'function')
+      })
 
       test('._create', () => {
-        assert.strictEqual(typeof service._create, 'function');
-      });
+        assert.strictEqual(typeof service._create, 'function')
+      })
 
       test('._update', () => {
-        assert.strictEqual(typeof service._update, 'function');
-      });
+        assert.strictEqual(typeof service._update, 'function')
+      })
 
       test('._patch', () => {
-        assert.strictEqual(typeof service._patch, 'function');
-      });
+        assert.strictEqual(typeof service._patch, 'function')
+      })
 
       test('._remove', () => {
-        assert.strictEqual(typeof service._remove, 'function');
-      });
-    });
-  });
-};
+        assert.strictEqual(typeof service._remove, 'function')
+      })
+
+      test('.$get', () => {
+        assert.strictEqual(typeof service.$get, 'function')
+      })
+
+      test('.$find', () => {
+        assert.strictEqual(typeof service.$find, 'function')
+      })
+
+      test('.$create', () => {
+        assert.strictEqual(typeof service.$create, 'function')
+      })
+
+      test('.$update', () => {
+        assert.strictEqual(typeof service.$update, 'function')
+      })
+
+      test('.$patch', () => {
+        assert.strictEqual(typeof service.$patch, 'function')
+      })
+
+      test('.$remove', () => {
+        assert.strictEqual(typeof service.$remove, 'function')
+      })
+    })
+  })
+}

package/src/declarations.ts

@@ -0,0 +1,90 @@
+export type AdapterTest = (name: AdapterTestName, runner: any) => void
+
+export type AdapterBasicTest = (name: AdapterBasicTestName, runner: any) => void
+export type AdapterMethodsTest = (name: AdapterMethodsTestName, runner: any) => void
+export type AdapterSyntaxTest = (name: AdapterSyntaxTestName, runner: any) => void
+
+export type AdapterTestName = AdapterBasicTestName | AdapterMethodsTestName | AdapterSyntaxTestName
+
+export type AdapterBasicTestName =
+  | '.id'
+  | '.options'
+  | '.events'
+  | '._get'
+  | '._find'
+  | '._create'
+  | '._update'
+  | '._patch'
+  | '._remove'
+  | '.$get'
+  | '.$find'
+  | '.$create'
+  | '.$update'
+  | '.$patch'
+  | '.$remove'
+
+export type AdapterMethodsTestName =
+  | '.get'
+  | '.get + $select'
+  | '.get + id + query'
+  | '.get + NotFound'
+  | '.get + id + query id'
+  | '.find'
+  | '.remove'
+  | '.remove + $select'
+  | '.remove + id + query'
+  | '.remove + multi'
+  | '.remove + multi no pagination'
+  | '.remove + id + query id'
+  | '.update'
+  | '.update + $select'
+  | '.update + id + query'
+  | '.update + NotFound'
+  | '.update + query + NotFound'
+  | '.update + id + query id'
+  | '.patch'
+  | '.patch + $select'
+  | '.patch + id + query'
+  | '.patch multiple'
+  | '.patch multiple no pagination'
+  | '.patch multi query same'
+  | '.patch multi query changed'
+  | '.patch + NotFound'
+  | '.patch + query + NotFound'
+  | '.patch + id + query id'
+  | '.create'
+  | '.create + $select'
+  | '.create multi'
+  | 'internal .find'
+  | 'internal .get'
+  | 'internal .create'
+  | 'internal .update'
+  | 'internal .patch'
+  | 'internal .remove'
+
+export type AdapterSyntaxTestName =
+  | '.find + equal'
+  | '.find + equal multiple'
+  | '.find + $sort'
+  | '.find + $sort + string'
+  | '.find + $limit'
+  | '.find + $limit 0'
+  | '.find + $skip'
+  | '.find + $select'
+  | '.find + $or'
+  | '.find + $in'
+  | '.find + $nin'
+  | '.find + $lt'
+  | '.find + $lte'
+  | '.find + $gt'
+  | '.find + $gte'
+  | '.find + $ne'
+  | '.find + $gt + $lt + $sort'
+  | '.find + $or nested + $sort'
+  | 'params.adapter + paginate'
+  | 'params.adapter + multi'
+  | '.find + paginate'
+  | '.find + paginate + query'
+  | '.find + paginate + $limit + $skip'
+  | '.find + paginate + $limit 0'
+  | '.find + paginate + params'

package/src/index.ts

@@ -1,49 +1,57 @@
 /* eslint-disable no-console */
-import basicTests from './basic';
-import methodTests from './methods';
-import syntaxTests from './syntax';
+import basicTests from './basic'
+import { AdapterTestName } from './declarations'
+import methodTests from './methods'
+import syntaxTests from './syntax'
 
-const adapterTests = (testNames: string[]) => {
+const adapterTests = (testNames: AdapterTestName[]) => {
   return (app: any, errors: any, serviceName: any, idProp = 'id') => {
     if (!serviceName) {
-      throw new Error('You must pass a service name');
+      throw new Error('You must pass a service name')
     }
 
-    const skippedTests: string[] = [];
-    const allTests: string[] = [];
+    const skippedTests: AdapterTestName[] = []
+    const allTests: AdapterTestName[] = []
 
-    const test = (name: string, runner: any) => {
-      const skip = !testNames.includes(name);
-      const its = skip ? it.skip : it;
+    const test = (name: AdapterTestName, runner: any) => {
+      const skip = !testNames.includes(name)
+      const its = skip ? it.skip : it
 
       if (skip) {
-        skippedTests.push(name);
+        skippedTests.push(name)
       }
 
-      allTests.push(name);
+      allTests.push(name)
 
-      its(name, runner);
-    };
+      its(name, runner)
+    }
 
     describe(`Adapter tests for '${serviceName}' service with '${idProp}' id property`, () => {
       after(() => {
-        console.log('\n');
-        testNames.forEach(name => {
+        testNames.forEach((name) => {
           if (!allTests.includes(name)) {
-            console.error(`WARNING: '${name}' test is not part of the test suite`);
+            console.error(`WARNING: '${name}' test is not part of the test suite`)
           }
-        });
+        })
         if (skippedTests.length) {
-          console.log(`\nSkipped the following ${skippedTests.length} Feathers adapter test(s) out of ${allTests.length} total:`);
-          console.log(JSON.stringify(skippedTests, null, '  '));
+          console.log(
+            `\nSkipped the following ${skippedTests.length} Feathers adapter test(s) out of ${allTests.length} total:`
+          )
+          console.log(JSON.stringify(skippedTests, null, '  '))
         }
-      });
+      })
+
+      basicTests(test, app, errors, serviceName, idProp)
+      methodTests(test, app, errors, serviceName, idProp)
+      syntaxTests(test, app, errors, serviceName, idProp)
+    })
+  }
+}
+
+export * from './declarations'
 
-      basicTests(test, app, errors, serviceName, idProp);
-      methodTests(test, app, errors, serviceName, idProp);
-      syntaxTests(test, app, errors, serviceName, idProp);
-    });
-  };
-};
+export default adapterTests
 
-export = adapterTests;
+if (typeof module !== 'undefined') {
+  module.exports = Object.assign(adapterTests, module.exports)
+}