@opra/sqb 1.26.3 → 1.27.0

package/README.md

@@ -1,3 +1,26 @@
 # @opra/sqb
 
-OPRA SQB package.
+[![NPM Version][npm-image]][npm-url]
+[![NPM Downloads][downloads-image]][downloads-url]
+[![CI Tests][ci-test-image]][ci-test-url]
+[![Test Coverage][coveralls-image]][coveralls-url]
+
+
+## Support
+You can report bugs and discuss features on the [GitHub issues](https://github.com/panates/opra/issues) page.
+
+## Node Compatibility
+- node >= 20.x
+
+
+## License
+Available under [MIT](LICENSE) license.
+
+[npm-image]: https://img.shields.io/npm/v/@opra/sqb
+[npm-url]: https://npmjs.org/package/@opra/sqb
+[downloads-image]: https://img.shields.io/npm/dm/@opra/sqb.svg
+[downloads-url]: https://npmjs.org/package/@opra/sqb
+[ci-test-image]: https://github.com/panates/opra/actions/workflows/test.yml/badge.svg
+[ci-test-url]: https://github.com/panates/opra/actions/workflows/test.yml
+[coveralls-image]: https://coveralls.io/repos/github/panates/opra/badge.svg?branch=main
+[coveralls-url]: https://coveralls.io/github/panates/opra?branch=main

package/adapter-utils/prepare-filter.d.ts

@@ -1,10 +1,9 @@
 import '@opra/core';
 import type { SQBAdapter } from '../sqb-adapter.js';
 /**
- * Prepare the SQB filter based on the provided filters and options.
+ * Prepares the SQB filter based on the provided filters and options.
  *
- * @param {SQBAdapter.FilterInput|SQBAdapter.FilterInput[]} filters - The filter(s) to be applied.
- *
- * @returns {Expression} - The prepared SQB Expression.
+ * @param filters - The filter(s) to be applied. Can be a single filter or an array of filters.
+ * @returns The prepared SQB Expression, or `undefined` if no filters are provided.
  */
 export default function prepareFilter(filters: SQBAdapter.FilterInput | SQBAdapter.FilterInput[]): any;

package/adapter-utils/prepare-filter.js

@@ -1,13 +1,12 @@
 import '@opra/core';
 import { OpraFilter } from '@opra/common';
-import * as sqb from '@sqb/builder';
+import { Operators, sql } from '@sqb/builder';
 import { vg } from 'valgen';
 /**
- * Prepare the SQB filter based on the provided filters and options.
+ * Prepares the SQB filter based on the provided filters and options.
  *
- * @param {SQBAdapter.FilterInput|SQBAdapter.FilterInput[]} filters - The filter(s) to be applied.
- *
- * @returns {Expression} - The prepared SQB Expression.
+ * @param filters - The filter(s) to be applied. Can be a single filter or an array of filters.
+ * @returns The prepared SQB Expression, or `undefined` if no filters are provided.
  */
 export default function prepareFilter(filters) {
     const filtersArray = Array.isArray(filters) ? filters : [filters];
@@ -27,7 +26,7 @@ export default function prepareFilter(filters) {
         if (ast)
             arr.push(ast);
     }
-    return arr.length > 1 ? sqb.And(...arr) : arr[0];
+    return arr.length > 1 ? sql.And(...arr) : arr[0];
 }
 const _isDate = vg.isDate({ trim: 'day' });
 const _isDateTime = vg.isDate();
@@ -44,12 +43,12 @@ function prepareFilterAst(ast) {
         return ast.items.map(prepareFilterAst);
     }
     if (ast instanceof OpraFilter.NegativeExpression) {
-        return sqb.Not(prepareFilterAst(ast.expression));
+        return sql.Not(prepareFilterAst(ast.expression));
     }
     if (ast instanceof OpraFilter.LogicalExpression) {
         if (ast.op === 'or')
-            return sqb.Or(...ast.items.map(prepareFilterAst));
-        return sqb.And(...ast.items.map(prepareFilterAst));
+            return sql.Or(...ast.items.map(prepareFilterAst));
+        return sql.And(...ast.items.map(prepareFilterAst));
     }
     if (ast instanceof OpraFilter.ParenthesizedExpression) {
         return prepareFilterAst(ast.expression);
@@ -68,33 +67,19 @@ function prepareFilterAst(ast) {
                 return x;
         }
         switch (ast.op) {
-            case '=':
-                return sqb.Eq(left, right);
-            case '!=':
-                return sqb.Ne(left, right);
-            case '>':
-                return sqb.Gt(left, right);
-            case '>=':
-                return sqb.Gte(left, right);
-            case '<':
-                return sqb.Lt(left, right);
-            case '<=':
-                return sqb.Lte(left, right);
-            case 'in':
-                return sqb.In(left, right);
-            case '!in':
-                return sqb.Nin(left, right);
             case 'like':
-                return sqb.Like(left, String(right).replace(/\*/g, '%'));
+                return sql.Like(left, String(right).replace(/\*/g, '%'));
             case 'ilike':
-                return sqb.Ilike(left, String(right).replace(/\*/g, '%'));
+                return sql.ILike(left, String(right).replace(/\*/g, '%'));
             case '!like':
-                return sqb.NotLike(left, String(right).replace(/\*/g, '%'));
+                return sql.NotLike(left, String(right).replace(/\*/g, '%'));
             case '!ilike':
-                return sqb.NotILike(left, String(right).replace(/\*/g, '%'));
-            default:
-                throw new Error(`ComparisonExpression operator (${ast.op}) not implemented yet`);
+                return sql.NotILike(left, String(right).replace(/\*/g, '%'));
         }
+        const fn = Operators[ast.op];
+        if (fn)
+            return fn(left, right);
+        throw new Error(`ComparisonExpression operator (${ast.op}) not implemented yet`);
     }
     if (ast instanceof OpraFilter.QualifiedIdentifier ||
         ast instanceof OpraFilter.Literal) {

package/augmentation/datatype-factory.augmentation.js

@@ -13,7 +13,7 @@ DataTypeFactory._prepareComplexTypeArgs = async function (context, owner, initAr
             const sqbField = sqbMeta && EntityMetadata.getField(sqbMeta, fieldName);
             if (!sqbField)
                 continue;
-            /** Copy type information from sqb metadata to opra */
+            /* Copy type information from sqb metadata to opra */
             if (!fieldSchema.type || fieldSchema.type === Object) {
                 if (isAssociationField(sqbField)) {
                     if (!fieldSchema.type) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opra/sqb",
-  "version": "1.26.3",
+  "version": "1.27.0",
   "description": "Opra SQB adapter package",
   "author": "Panates",
   "license": "MIT",
@@ -10,8 +10,8 @@
     "valgen": "^6.0.3"
   },
   "peerDependencies": {
-    "@opra/core": "^1.26.3",
-    "@opra/http": "^1.26.3",
+    "@opra/core": "^1.27.0",
+    "@opra/http": "^1.27.0",
     "@sqb/builder": ">4.0.0 <5",
     "@sqb/connect": ">4.0.0 <5"
   },

package/sqb-adapter.d.ts

@@ -2,20 +2,60 @@ import type { OpraFilter } from '@opra/common';
 import type { ExecutionContext } from '@opra/core';
 import { type Repository } from '@sqb/connect';
 import _prepareFilter from './adapter-utils/prepare-filter.js';
+/**
+ * SQBAdapter namespace provides types and utility functions for integrating SQB with Opra.
+ */
 export declare namespace SQBAdapter {
+    /**
+     * Represents a single identifier type.
+     */
     type Id = string | number | boolean | Date;
+    /**
+     * Represents a single identifier or a composite key.
+     */
     type IdOrIds = Id | Record<string, Id>;
+    /**
+     * Represents the input for a filter, which can be an Opra filter expression,
+     * a SQB filter object, a string, or undefined.
+     */
     type FilterInput = OpraFilter.Expression | Repository.FindManyOptions['filter'] | string | undefined;
     /**
-     * @deprecated Use prepareFilter instead
+     * Parses the given filter input into a SQB filter expression.
+     * @deprecated Use {@link prepareFilter} instead.
      */
     const parseFilter: typeof _prepareFilter;
+    /**
+     * Prepares the given filter input into a SQB filter expression.
+     */
     const prepareFilter: typeof _prepareFilter;
+    /**
+     * Represents a request that has been transformed for SQB operations.
+     */
     interface TransformedRequest {
+        /**
+         * The operation method name.
+         */
         method: 'create' | 'delete' | 'deleteMany' | 'get' | 'replace' | 'findMany' | 'update' | 'updateMany';
+        /**
+         * The primary key for the operation, if applicable.
+         */
         key?: any;
+        /**
+         * The data object for create or update operations.
+         */
         data?: any;
+        /**
+         * Additional options for the SQB operation.
+         */
         options: any;
     }
+    /**
+     * Parses an execution context and transforms it into a SQB-compatible request.
+     *
+     * @param context - The execution context to parse.
+     * @returns A promise that resolves to the transformed request.
+     * @throws {TypeError} If the context transport is not 'http'.
+     * @throws {Error} If the operation is not compatible with SQB Adapter.
+     */
     function parseRequest(context: ExecutionContext): Promise<TransformedRequest>;
 }

package/sqb-adapter.js

@@ -1,12 +1,27 @@
 import { EntityMetadata } from '@sqb/connect';
 import _prepareFilter from './adapter-utils/prepare-filter.js';
+/**
+ * SQBAdapter namespace provides types and utility functions for integrating SQB with Opra.
+ */
 export var SQBAdapter;
 (function (SQBAdapter) {
     /**
-     * @deprecated Use prepareFilter instead
+     * Parses the given filter input into a SQB filter expression.
+     * @deprecated Use {@link prepareFilter} instead.
      */
     SQBAdapter.parseFilter = _prepareFilter;
+    /**
+     * Prepares the given filter input into a SQB filter expression.
+     */
     SQBAdapter.prepareFilter = _prepareFilter;
+    /**
+     * Parses an execution context and transforms it into a SQB-compatible request.
+     *
+     * @param context - The execution context to parse.
+     * @returns A promise that resolves to the transformed request.
+     * @throws {TypeError} If the context transport is not 'http'.
+     * @throws {Error} If the operation is not compatible with SQB Adapter.
+     */
     async function parseRequest(context) {
         if (context.transport !== 'http') {
             throw new TypeError('SQBAdapter can parse only HttpContext');
@@ -37,7 +52,7 @@ export var SQBAdapter;
                         controller.parameters.find(p => p.keyParam);
                     const key = keyParam && ctx.pathParams[String(keyParam.name)];
                     const options = {
-                        filter: SQBAdapter.parseFilter(ctx.queryParams.filter),
+                        filter: SQBAdapter.prepareFilter(ctx.queryParams.filter),
                     };
                     return {
                         method: 'delete',
@@ -47,14 +62,14 @@ export var SQBAdapter;
                 }
                 case 'Entity.DeleteMany': {
                     const options = {
-                        filter: SQBAdapter.parseFilter(ctx.queryParams.filter),
+                        filter: SQBAdapter.prepareFilter(ctx.queryParams.filter),
                     };
                     return { method: 'deleteMany', options };
                 }
                 case 'Entity.FindMany': {
                     const options = {
                         count: ctx.queryParams.count,
-                        filter: SQBAdapter.parseFilter(ctx.queryParams.filter),
+                        filter: SQBAdapter.prepareFilter(ctx.queryParams.filter),
                         projection: ctx.queryParams.projection ||
                             __oprDef.compositionOptions.defaultProjection,
                         limit: ctx.queryParams.limit || __oprDef.compositionOptions.defaultLimit,
@@ -96,7 +111,7 @@ export var SQBAdapter;
                     const key = keyParam && ctx.pathParams[String(keyParam.name)];
                     const options = {
                         projection: ctx.queryParams.projection,
-                        filter: SQBAdapter.parseFilter(ctx.queryParams.filter),
+                        filter: SQBAdapter.prepareFilter(ctx.queryParams.filter),
                     };
                     return {
                         method: 'update',
@@ -108,7 +123,7 @@ export var SQBAdapter;
                 case 'Entity.UpdateMany': {
                     const data = await ctx.getBody();
                     const options = {
-                        filter: SQBAdapter.parseFilter(ctx.queryParams.filter),
+                        filter: SQBAdapter.prepareFilter(ctx.queryParams.filter),
                     };
                     return {
                         method: 'updateMany',