@vinctus/oql 1.1.0-scope → 1.1.0

package/README.md

@@ -8,13 +8,17 @@
     - [TypeScript/JavaScript](#typescriptjavascript)
     - [Scala.js](#scalajs)
   - [Usage](#usage)
-    - [TypeScript](#typescript)
-    - [Scala.js](#scalajs-1)
+  - [Tutorial](#tutorial)
   - [API](#api)
   - [Examples](#examples)
   - [Tests](#tests)
+    - [Requirements](#requirements)
+    - [Setup PostgreSQL](#setup-postgresql)
+    - [Clone the repository](#clone-the-repository)
+    - [Build the test database](#build-the-test-database)
+    - [Run tests](#run-tests)
   - [License](#license)
-  
+
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 OQL
@@ -64,11 +68,11 @@ Add the following lines to your `build.sbt`:
 ```sbt
 externalResolvers += "OQL" at "https://maven.pkg.github.com/vinctustech/oql"
 
-libraryDependencies += "com.vinctus" %%% "-vinctus-oql" % "1.0.0-RC.3.23"
+libraryDependencies += "com.vinctus" %%% "-vinctus-oql" % "1.1.0"
 
 Compile / npmDependencies ++= Seq(
-  "pg" -> "8.5.1",
-  "@types/pg" -> "7.14.7"
+  "pg" -> "8.10.0",
+  "@types/pg" -> "8.6.6"
 )
 ```
 
@@ -111,9 +115,75 @@ Several examples are given [here](https://vinctustech.github.io/oql/examples.htm
 Tests
 -----
 
-in progress: ticket #OQL-24
+### Requirements
+
+- Git (for cloning)
+- Java 11+
+- [sbt](https://www.scala-sbt.org/1.x/docs/Setup.html) (for building and running tests)
+
+### Setup PostgreSQL
+
+To run the unit test, you will need to get [PostgreSQL](https://hub.docker.com/_/postgres) running in a [docker container](https://www.docker.com/resources/what-container):
+
+```
+docker pull postgres
+docker run --rm --name pg-docker -e POSTGRES_PASSWORD=docker -d -p 5432:5432 postgres
+```
+
+The [PostgreSQL client](https://www.postgresql.org/docs/13.3/app-psql.html) (`psql`) should be installed. If necessary, it can be installed with the command
+
+`sudo apt-get install postgresql-client`
+
+### Clone the repository
+
+At the shell terminal go to the folder where the sources will be downloaded, referred to as `dev-path/`, and type
+
+```
+git git@github.com:vinctustech/oql.git
+```
+
+This will create folder `dev-path/oql`.
+
+### Build the test database
+
+Type
+
+```shell
+cd oql/test
+
+sh start
+
+sh tests
+
+sh build
+```
+
+The last few lines of output should be
+
+```
+CREATE TABLE
+ALTER TABLE
+INSERT 0 4
+INSERT 0 4
+```
+
+### Run tests
+
+Type
+
+```
+cd ..
+sbt test
+```
+
+You should see
+
+```
+[info] All tests passed.
+```
 
 License
 -------
 
 OQL uses the commercial friendly open source [ISC](https://raw.githubusercontent.com/vinctustech/oql/stable/LICENSE) license.
+

package/index.d.ts

@@ -1,6 +1,6 @@
-export class QueryBuilder {
+export class QueryBuilder<T = any> {
 
-  cond(v: any): QueryBuilder
+  cond(v: any): QueryBuilder<T>
 
 //   add(attribute: QueryBuilder): QueryBuilder
 //
@@ -8,19 +8,19 @@ export class QueryBuilder {
 //
 //   project(resource: string, ...attributes: string[]): QueryBuilder
 
-  query(oql: string, parameters?: any): QueryBuilder
+  query(oql: string, parameters?: any): QueryBuilder<T>
 
-  select(oql: string, parameters?: any): QueryBuilder
+  select(oql: string, parameters?: any): QueryBuilder<T>
 
-  order(attribute: string, sorting: string): QueryBuilder
+  order(attribute: string, sorting: string): QueryBuilder<T>
 
-  limit(a: number): QueryBuilder
+  limit(a: number): QueryBuilder<T>
 
-  offset(a: number): QueryBuilder
+  offset(a: number): QueryBuilder<T>
 
-  getOne(): Promise<any | undefined>
+  getOne(): Promise<T | undefined>
 
-  getMany(): Promise<any[]>
+  getMany(): Promise<T[]>
 
   getCount(): Promise<number>
 
@@ -28,13 +28,13 @@ export class QueryBuilder {
 
 export class Mutation {
 
-  insert(obj: any): Promise<any>
+  insert<T = any>(obj: any): Promise<T>
 
   link(id1: any, resource: string, id2: any): Promise<void>
 
   unlink(id1: any, resource: string, id2: any): Promise<void>
 
-  update(id: any, updates: any): Promise<void>
+  update<T = any>(id: any, updates: any): Promise<T>
 
   bulkUpdate(updates: [any, any][]): Promise<void>
 
@@ -46,18 +46,44 @@ export class OQL {
 
   constructor(dm: string, host: string, port: number, database: string, user: string, password: string, ssl: any, idleTimeoutMillis: number, max: number)
 
+  create(): Promise<void>
+
+  showQuery(): void
+
+  entity(name: string): Mutation
+
+  queryBuilder<T = any>(fixed?: string, at?: any): QueryBuilder<T>
+
+  queryOne<T = any>(oql: string, parameters?: any, fixed?: string, at?: any): Promise<T | undefined>
+
+  queryMany<T = any>(oql: string, parameters?: any, fixed?: string, at?: any): Promise<T[]>
+
+  count(oql: string, parameters?: any, fixed?: string, at?: any): Promise<number>
+
+  raw(sql: string, values?: any[]): Promise<any[][]>
+
+}
+
+export class OQL_MEM {
+
+  constructor(dm: string)
+
+  create(): Promise<void>
+
   showQuery(): void
 
   entity(name: string): Mutation
 
-  queryBuilder(): QueryBuilder
+  queryBuilder<T = any>(fixed?: string, at?: any): QueryBuilder<T>
+
+  queryOne<T = any>(oql: string, parameters?: any, fixed?: string, at?: any): Promise<T | undefined>
 
-  queryOne(oql: string, parameters?: any): Promise<any | undefined>
+  queryMany<T = any>(oql: string, parameters?: any, fixed?: string, at?: any): Promise<T[]>
 
-  queryMany(oql: string, parameters?: any): Promise<any[]>
+  count(oql: string, parameters?: any, fixed?: string, at?: any): Promise<number>
 
-  count(oql: string, parameters?: any): Promise<number>
+  raw(sql: string, values?: any[]): Promise<any[][]>
 
-  raw(sql: string, values?: any[]): Promise<any[]>
+  rawMulti(sql: string): Promise<void>
 
 }