feathers-adapter-vitest 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Feathers Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,30 @@
+# Feathers Adapter Tests for vitest
+
+> Feathers shared database adapter test suite
+
+## About
+
+This is a repository that contains the test suite for the common database adapter syntax. See the [API documentation](https://docs.feathersjs.com/api/databases/common.html) for more information.
+
+## Installation
+
+```
+npm install --save-dev feathers-adapter-vitest
+```
+
+## Usage
+
+```ts
+// index.test.ts
+
+import { defineTestSuite } from "feathers-adapter-vitest";
+
+const testSuite = defineTestSuite([
+  ".events",
+  // ... and so on
+]);
+```
+
+## License
+
+Licensed under the [MIT license](./LICENSE).

package/dist/basic.d.ts

@@ -0,0 +1,3 @@
+import type { AdapterBasicTest } from './declarations.js';
+declare const _default: (test: AdapterBasicTest, app: any, _errors: any, serviceName: string, idProp: string) => void;
+export default _default;

package/dist/basic.js

@@ -0,0 +1,39 @@
+import assert from 'node:assert';
+import { describe, beforeEach, it } from 'vitest';
+export default (test, app, _errors, serviceName, idProp) => {
+    describe('Basic Functionality', () => {
+        let service;
+        beforeEach(() => {
+            service = app.service(serviceName);
+        });
+        it('.id', () => {
+            assert.strictEqual(service.id, idProp, 'id property is set to expected name');
+        });
+        test('.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"');
+        });
+        describe('Raw Methods', () => {
+            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/dist/declarations.d.ts

@@ -0,0 +1,8 @@
+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' | '.create ignores query' | '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' | '.find + $and' | '.find + $and + $or' | 'params.adapter + paginate' | 'params.adapter + multi' | '.find + paginate' | '.find + paginate + query' | '.find + paginate + $limit + $skip' | '.find + paginate + $limit 0' | '.find + paginate + params';

package/dist/declarations.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import type { AdapterTestName } from './declarations.js';
+export declare const adapterTests: (testNames: AdapterTestName[]) => (app: any, errors: any, serviceName: any, idProp?: string) => void;
+export * from './declarations.js';
+export default adapterTests;

package/dist/index.js

@@ -0,0 +1,40 @@
+import basicTests from './basic.js';
+import methodTests from './methods.js';
+import syntaxTests from './syntax.js';
+import { describe, it, afterAll } from 'vitest';
+export const adapterTests = (testNames) => {
+    return (app, errors, serviceName, idProp = 'id') => {
+        if (!serviceName) {
+            throw new Error('You must pass a service name');
+        }
+        const skippedTests = [];
+        const allTests = [];
+        const test = (name, runner) => {
+            const skip = !testNames.includes(name);
+            const its = skip ? it.skip : it;
+            if (skip) {
+                skippedTests.push(name);
+            }
+            allTests.push(name);
+            its(name, runner);
+        };
+        describe(`Adapter tests for '${serviceName}' service with '${idProp}' id property`, () => {
+            afterAll(() => {
+                testNames.forEach((name) => {
+                    if (!allTests.includes(name)) {
+                        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, '  '));
+                }
+            });
+            basicTests(test, app, errors, serviceName, idProp);
+            methodTests(test, app, errors, serviceName, idProp);
+            syntaxTests(test, app, errors, serviceName, idProp);
+        });
+    };
+};
+export * from './declarations.js';
+export default adapterTests;

package/dist/methods.d.ts

@@ -0,0 +1,3 @@
+import type { AdapterMethodsTest } from './declarations.js';
+declare const _default: (test: AdapterMethodsTest, app: any, _errors: any, serviceName: string, idProp: string) => void;
+export default _default;