@steedos/odata-v4-typeorm 1.20.0 → 2.2.27

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2018 Andriy
-
-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.
+MIT License
+
+Copyright (c) 2018 Andriy
+
+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

@@ -1,126 +1,126 @@
-# OData V4 Service modules - TYPEORM Connector
-
-Service OData v4 requests from a TYPEORM.
-
-## Synopsis
-The OData V4 TYPEORM Connector provides functionality to convert the various types of OData segments
-into SQL query statements, that you can execute over a TYPEORM.
-
-## Potential usage scenarios
-
-- Create high speed, standard compliant data sharing APIs
-
-## Usage as server - TypeScript
-//example request:  GET /api/users?$filter=id eq 42&$select=id,name
-### odataQuery
-```typescript
-import express from 'express';
-import { odataQuery } from 'odata-v4-typeorm';
-import { getRepository } from 'typeorm';
-import { User } from '../entities/user';
-
-const app = express();
-const usersRepository = getRepository(User);
-
-app.get('/api/users', odataQuery(usersRepository));
-
-const port = 3001;
-app.listen(port, () => console.log(`Example app listening on port ${port}!`));
-```
-
-### executeQuery by repository
-```typescript
-import express from 'express';
-import { executeQuery } from 'odata-v4-typeorm';
-import { getRepository } from 'typeorm';
-import { User } from '../entities/user';
-
-const app = express();
-
-app.get('/api/users', async (req, res) => {
-  try {
-    const usersRepository = getRepository(User);
-    const data = await executeQuery(usersRepository, req.query);
-    return res.status(200).json(data);
-  } catch (e) {
-    return res.status(500).json({message: 'Internal server error.'});
-  }
-});
-
-const port = 3001;
-app.listen(port, () => console.log(`Example app listening on port ${port}!`));
-```
-
-### executeQuery by queryBuilder
-```typescript
-import express from 'express';
-import { executeQuery } from 'odata-v4-typeorm';
-import { getRepository } from 'typeorm';
-import { User } from '../entities/user';
-
-const app = express();
-
-app.get('/api/users', async (req, res) => {
-  try {
-    const queryBuilder = getRepository(User)
-      .createQueryBuilder("user")
-      .where("user.roleName = :roleName", { roleName: 'admin' });
-    const data = await executeQuery(queryBuilder, req.query);
-    return res.status(200).json(data);
-  } catch (e) {
-    return res.status(500).json({message: 'Internal server error.'});
-  }
-});
-
-const port = 3001;
-app.listen(port, () => console.log(`Example app listening on port ${port}!`));
-```
-
-### createFilter
-```javascript
-import { createFilter } from 'odata-v4-typeorm'
-
-//example request:  GET /api/Users?$filter=Id eq 42
-app.get("/api/Users", (req: Request, res: Response) => {
-    const filter = createFilter(req.query.$filter);
-    // connection instance from pg module
-    connection.query(`SELECT * FROM Users WHERE ${filter.where}`, filter.parameters, function(err, result){
-        res.json({
-        	'@odata.context': req.protocol + '://' + req.get('host') + '/api/$metadata#Users',
-        	value: result.rows
-        });
-    });
-});
-```
-
-Advanced TypeScript example available [here](https://raw.githubusercontent.com/jaystack/odata-v4-mysql/master/src/example/sql.ts).
-
-## Usage ES5
-```javascript
-var createFilter = require('odata-v4-typeorm').createFilter;
-
-app.get("/api/Users", function(req, res) {
-    var filter = createFilter(req.query.$filter);
-    // connection instance from pg module
-    connection.query(filter.from("Users"), filter.parameters, function(err, result){
-        res.json({
-        	'@odata.context': req.protocol + '://' + req.get('host') + '/api/$metadata#Users',
-        	value: result.rows
-        });
-    });
-})
-```
-
-## Supported OData segments
-
-* $filter
-* $select
-* $skip
-* $top
-* $orderby
-* $expand
-* $count
-
-If you have any questions, please don’t hesitate to contact me.
-* skype: andryuha49.
+# OData V4 Service modules - TYPEORM Connector
+
+Service OData v4 requests from a TYPEORM.
+
+## Synopsis
+The OData V4 TYPEORM Connector provides functionality to convert the various types of OData segments
+into SQL query statements, that you can execute over a TYPEORM.
+
+## Potential usage scenarios
+
+- Create high speed, standard compliant data sharing APIs
+
+## Usage as server - TypeScript
+//example request:  GET /api/users?$filter=id eq 42&$select=id,name
+### odataQuery
+```typescript
+import express from 'express';
+import { odataQuery } from 'odata-v4-typeorm';
+import { getRepository } from 'typeorm';
+import { User } from '../entities/user';
+
+const app = express();
+const usersRepository = getRepository(User);
+
+app.get('/api/users', odataQuery(usersRepository));
+
+const port = 3001;
+app.listen(port, () => console.log(`Example app listening on port ${port}!`));
+```
+
+### executeQuery by repository
+```typescript
+import express from 'express';
+import { executeQuery } from 'odata-v4-typeorm';
+import { getRepository } from 'typeorm';
+import { User } from '../entities/user';
+
+const app = express();
+
+app.get('/api/users', async (req, res) => {
+  try {
+    const usersRepository = getRepository(User);
+    const data = await executeQuery(usersRepository, req.query);
+    return res.status(200).json(data);
+  } catch (e) {
+    return res.status(500).json({message: 'Internal server error.'});
+  }
+});
+
+const port = 3001;
+app.listen(port, () => console.log(`Example app listening on port ${port}!`));
+```
+
+### executeQuery by queryBuilder
+```typescript
+import express from 'express';
+import { executeQuery } from 'odata-v4-typeorm';
+import { getRepository } from 'typeorm';
+import { User } from '../entities/user';
+
+const app = express();
+
+app.get('/api/users', async (req, res) => {
+  try {
+    const queryBuilder = getRepository(User)
+      .createQueryBuilder("user")
+      .where("user.roleName = :roleName", { roleName: 'admin' });
+    const data = await executeQuery(queryBuilder, req.query);
+    return res.status(200).json(data);
+  } catch (e) {
+    return res.status(500).json({message: 'Internal server error.'});
+  }
+});
+
+const port = 3001;
+app.listen(port, () => console.log(`Example app listening on port ${port}!`));
+```
+
+### createFilter
+```javascript
+import { createFilter } from 'odata-v4-typeorm'
+
+//example request:  GET /api/Users?$filter=Id eq 42
+app.get("/api/Users", (req: Request, res: Response) => {
+    const filter = createFilter(req.query.$filter);
+    // connection instance from pg module
+    connection.query(`SELECT * FROM Users WHERE ${filter.where}`, filter.parameters, function(err, result){
+        res.json({
+        	'@odata.context': req.protocol + '://' + req.get('host') + '/api/$metadata#Users',
+        	value: result.rows
+        });
+    });
+});
+```
+
+Advanced TypeScript example available [here](https://raw.githubusercontent.com/jaystack/odata-v4-mysql/master/src/example/sql.ts).
+
+## Usage ES5
+```javascript
+var createFilter = require('odata-v4-typeorm').createFilter;
+
+app.get("/api/Users", function(req, res) {
+    var filter = createFilter(req.query.$filter);
+    // connection instance from pg module
+    connection.query(filter.from("Users"), filter.parameters, function(err, result){
+        res.json({
+        	'@odata.context': req.protocol + '://' + req.get('host') + '/api/$metadata#Users',
+        	value: result.rows
+        });
+    });
+})
+```
+
+## Supported OData segments
+
+* $filter
+* $select
+* $skip
+* $top
+* $orderby
+* $expand
+* $count
+
+If you have any questions, please don’t hesitate to contact me.
+* skype: andryuha49.
 * https://www.linkedin.com/in/andriy-zherdiy/

package/config/default.json

@@ -1,7 +1,7 @@
-{
-    "sqlConfig": {
-        "user": "db",
-        "password": "***",
-        "database": "world"
-    }
+{
+    "sqlConfig": {
+        "user": "db",
+        "password": "***",
+        "database": "world"
+    }
 }

package/{build/lib → lib}/createFilter.d.ts

@@ -1,13 +1,13 @@
-import { TypeOrmVisitor as Visitor } from './visitor';
-import { Token } from 'odata-v4-parser/lib/lexer';
-import { SqlOptions } from './sqlOptions';
-/**
- * Creates an SQL WHERE clause from an OData filter expression string
- * @param {string} odataFilter - A filter expression in OData $filter format
- * @return {string}  SQL WHERE clause
- * @example
- * const filter = createFilter("Size eq 4 and Age gt 18");
- * let sqlQuery = `SELECT * FROM table WHERE ${filter}`;
- */
-export declare function createFilter(odataFilter: string, options?: SqlOptions): Visitor;
-export declare function createFilter(odataFilter: Token, options?: SqlOptions): Visitor;
+import { TypeOrmVisitor as Visitor } from './visitor';
+import { Token } from 'odata-v4-parser/lib/lexer';
+import { SqlOptions } from './sqlOptions';
+/**
+ * Creates an SQL WHERE clause from an OData filter expression string
+ * @param {string} odataFilter - A filter expression in OData $filter format
+ * @return {string}  SQL WHERE clause
+ * @example
+ * const filter = createFilter("Size eq 4 and Age gt 18");
+ * let sqlQuery = `SELECT * FROM table WHERE ${filter}`;
+ */
+export declare function createFilter(odataFilter: string, options?: SqlOptions): Visitor;
+export declare function createFilter(odataFilter: Token, options?: SqlOptions): Visitor;

package/{build/lib → lib}/createFilter.js

@@ -1,16 +1,18 @@
-"use strict";
-const visitor_1 = require("./visitor");
-const odata_v4_parser_1 = require("odata-v4-parser");
-const odata_v4_sql_1 = require("odata-v4-sql");
-function createFilter(odataFilter, options = {}) {
-    if (!options.type) {
-        options.type = odata_v4_sql_1.SQLLang.Oracle;
-    }
-    let ast = (typeof odataFilter == 'string' ? odata_v4_parser_1.filter(odataFilter) : odataFilter);
-    const visitor = new visitor_1.TypeOrmVisitor(options);
-    const visit = visitor.Visit(ast);
-    const type = visit.asType();
-    return type;
-}
-exports.createFilter = createFilter;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createFilter = void 0;
+const visitor_1 = require("./visitor");
+const odata_v4_parser_1 = require("odata-v4-parser");
+const odata_v4_sql_1 = require("odata-v4-sql");
+function createFilter(odataFilter, options = {}) {
+    if (!options.type) {
+        options.type = odata_v4_sql_1.SQLLang.Oracle;
+    }
+    let ast = (typeof odataFilter == 'string' ? (0, odata_v4_parser_1.filter)(odataFilter) : odataFilter);
+    const visitor = new visitor_1.TypeOrmVisitor(options);
+    const visit = visitor.Visit(ast);
+    const type = visit.asType();
+    return type;
+}
+exports.createFilter = createFilter;
 //# sourceMappingURL=createFilter.js.map

package/lib/createFilter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createFilter.js","sourceRoot":"","sources":["../src/createFilter.ts"],"names":[],"mappings":";;;AAAA,uCAAoD;AAGpD,qDAAuC;AACvC,+CAAqC;AAYrC,SAAgB,YAAY,CAAC,WAA2B,EAAE,UAAsB,EAAE;IAChF,IAAI,CAAC,OAAO,CAAC,IAAI,EAAC;QAChB,OAAO,CAAC,IAAI,GAAG,sBAAO,CAAC,MAAM,CAAC;KAC/B;IACD,IAAI,GAAG,GAAiB,CAAC,OAAO,WAAW,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAA,wBAAM,EAAS,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IACrG,MAAM,OAAO,GAAG,IAAI,wBAAO,CAAC,OAAO,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACjC,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;IAC5B,OAAO,IAAI,CAAC;AAEd,CAAC;AAVD,oCAUC"}

package/{build/lib → lib}/createQuery.d.ts

@@ -1,13 +1,13 @@
-import { TypeOrmVisitor as Visitor } from './visitor';
-import { Token } from 'odata-v4-parser/lib/lexer';
-import { SqlOptions } from './sqlOptions';
-/**
- * Creates an SQL query descriptor from an OData query string
- * @param {string} odataQuery - An OData query string
- * @return {string}  SQL query descriptor
- * @example
- * const filter = createQuery("$filter=Size eq 4 and Age gt 18");
- * let sqlQuery = `SELECT * FROM table WHERE ${filter.where}`;
- */
-export declare function createQuery(odataQuery: string, options?: SqlOptions): Visitor;
-export declare function createQuery(odataQuery: Token, options?: SqlOptions): Visitor;
+import { TypeOrmVisitor as Visitor } from './visitor';
+import { Token } from 'odata-v4-parser/lib/lexer';
+import { SqlOptions } from './sqlOptions';
+/**
+ * Creates an SQL query descriptor from an OData query string
+ * @param {string} odataQuery - An OData query string
+ * @return {string}  SQL query descriptor
+ * @example
+ * const filter = createQuery("$filter=Size eq 4 and Age gt 18");
+ * let sqlQuery = `SELECT * FROM table WHERE ${filter.where}`;
+ */
+export declare function createQuery(odataQuery: string, options?: SqlOptions): Visitor;
+export declare function createQuery(odataQuery: Token, options?: SqlOptions): Visitor;

package/{build/lib → lib}/createQuery.js

@@ -1,13 +1,15 @@
-"use strict";
-const visitor_1 = require("./visitor");
-const odata_v4_parser_1 = require("odata-v4-parser");
-const odata_v4_sql_1 = require("odata-v4-sql");
-function createQuery(odataQuery, options = {}) {
-    if (!options.type) {
-        options.type = odata_v4_sql_1.SQLLang.Oracle;
-    }
-    let ast = (typeof odataQuery == 'string' ? odata_v4_parser_1.query(odataQuery) : odataQuery);
-    return new visitor_1.TypeOrmVisitor(options).Visit(ast).asType();
-}
-exports.createQuery = createQuery;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createQuery = void 0;
+const visitor_1 = require("./visitor");
+const odata_v4_parser_1 = require("odata-v4-parser");
+const odata_v4_sql_1 = require("odata-v4-sql");
+function createQuery(odataQuery, options = {}) {
+    if (!options.type) {
+        options.type = odata_v4_sql_1.SQLLang.Oracle;
+    }
+    let ast = (typeof odataQuery == 'string' ? (0, odata_v4_parser_1.query)(odataQuery) : odataQuery);
+    return new visitor_1.TypeOrmVisitor(options).Visit(ast).asType();
+}
+exports.createQuery = createQuery;
 //# sourceMappingURL=createQuery.js.map

package/lib/createQuery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createQuery.js","sourceRoot":"","sources":["../src/createQuery.ts"],"names":[],"mappings":";;;AAAA,uCAAoD;AAEpD,qDAAsC;AACtC,+CAAqC;AAarC,SAAgB,WAAW,CAAC,UAA0B,EAAE,UAAsB,EAAE;IAC9E,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;QACjB,OAAO,CAAC,IAAI,GAAG,sBAAO,CAAC,MAAM,CAAC;KAC/B;IACD,IAAI,GAAG,GAAiB,CAAC,OAAO,UAAU,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAA,uBAAK,EAAS,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IACjG,OAAO,IAAI,wBAAO,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;AAClD,CAAC;AAND,kCAMC"}

package/{build/lib → lib}/executeQuery.d.ts

@@ -1,5 +1,5 @@
-import { SqlOptions } from './sqlOptions';
-declare const executeQuery: (repositoryOrQueryBuilder: any, query: any, options: SqlOptions) => Promise<any>;
-declare const executeCountQuery: (repositoryOrQueryBuilder: any, query: any, options: SqlOptions) => Promise<any>;
-declare const getExecuteQuerySQL: (repositoryOrQueryBuilder: any, query: any, options: SqlOptions) => Promise<any>;
-export { executeQuery, executeCountQuery, getExecuteQuerySQL };
+import { SqlOptions } from './sqlOptions';
+declare const executeQuery: (repositoryOrQueryBuilder: any, query: any, options: SqlOptions) => Promise<any>;
+declare const executeCountQuery: (repositoryOrQueryBuilder: any, query: any, options: SqlOptions) => Promise<any>;
+declare const getExecuteQuerySQL: (repositoryOrQueryBuilder: any, query: any, options: SqlOptions) => Promise<any>;
+export { executeQuery, executeCountQuery, getExecuteQuerySQL };