fix(presto-client): improve published package information (#7)

Author: alonsovb

README.md

@@ -1,101 +1,11 @@
-# Presto JS Client
+# presto-client
 
-This is a Presto JavaScript client that connects to Presto via Presto's REST API to run queries.
+This monorepo was generated with [Nx](https://nx.dev).
 
-## Installation
+## Presto JS Client
 
-```sh
-npm install @prestodb/presto-js-client
-```
+For information on the Presto JS Client check its [README](presto-client/README.md) file under presto-client.
 
-## Usage
+## Contributing
 
-Import the PrestoClient class from `@prestodb/presto-js-client`.
-
-Create a new instance by passing the connection parameters.
-
-### Example
-
-```typescript
-import PrestoClient from '@prestodb/presto-js-client'
-
-...
-
-const client = PrestoClient({
-  catalog: 'tpcs',
-  host: 'localhost',
-  interval: 0,
-  port: 8080,
-  schema: 'tiny',
-  timezone: 'America/Costa_Rica',
-  user: 'root'
-})
-```
-
-### Parameters
-
-The Presto client can be configured with the following parameters:
-
-- `host`: The hostname or IP address of the Presto coordinator. (Default: `http://localhost`)
-- `port`: The port number of the Presto coordinator. (Default: `8080`)
-- `user`: The username to use for authentication. (Default: `undefined`)
-- `catalog`: The default catalog to use for queries. (Default: `undefined`)
-- `schema`: The default schema to use for queries. (Default: `undefined`)
-- `source`: The name of the source you want to use for reporting purposes (Default: `presto-js-client`)
-- `timezone`: The timezone to use for queries. (Default: `undefined`)
-- `interval`: The interval in milliseconds between checks for the status of a running query. (Default: `100`)
-
-## Querying
-
-The `query` method takes a single `string` parameter, which is the SQL query to be executed. The method returns a PrestoQuery object, which contains the results of the query, including the columns, data, and query ID. If the query fails, the `query` method will throw an error.
-
-The `string` parameter to the `query` method must be a valid SQL query. The query can be any type of SQL query, including `SELECT`, `INSERT`, `UPDATE`, and `DELETE` statements.
-
-### Return data structure (or error state)
-
-The `query` method returns a PrestoQuery object, which contains the results of the query, including the columns, data, and query ID.
-
-If the query succeeds, the PrestoQuery object will have the following properties:
-
-- `columns`: An array of objects that describe the columns in the results.
-- `data`: An array of arrays that contain the actual data for the results.
-- `queryId`: The ID of the query.
-
-If the query fails, the PrestoQuery object will have the following properties:
-
-- `error`: An object that contains information about the error.
-- `queryId`: The ID of the query.
-
-You can use the `error` property to get more information about the error that occurred. You can also use the `queryId` property to cancel the query or to get more information about the status of the query.
-
-### Example usage
-
-The following example shows how to use the query() method to execute a SELECT statement:
-
-```typescript
-const client = new PrestoClient({
-  catalog: 'tpcds',
-  host: 'http://localhost',
-  port: 8080,
-  schema: 'sf10',
-  user: 'root',
-})
-
-const query = `SELECT * FROM my_table`
-
-const prestoQuery = await client.query(query)
-
-if (prestoQuery.error) {
-  // Handle the error.
-} else {
-  // Use the results of the query.
-}
-```
-
-### Additional notes
-
-Additional notes
-
-- The `query` method is asynchronous and will return a promise that resolves to a PrestoQuery object.
-- The `query` method will automatically retry the query if it fails due to a transient error.
-- The `query` method will cancel the query if the client is destroyed.
+Check the [CONTRIBUTING](CONTRIBUTING.md) file for information on how to build, test and publish the client.

apps/nest-server/README.md

@@ -21,7 +21,7 @@ To run this application, follow these steps:
 3. After starting the Nest Server, you can make a `GET` request to the following endpoint to see the response from querying the local Presto container using the `prestodb-js-client` library:
 
    ```
-   curl -i -H "Accept: application/json" -H "Content-Type: application/json" -X GET http://localhost:3000/api/call-centers | json
+   curl -i -H "Accept: application/json" -H "Content-Type: application/json" -X GET http://localhost:3000/api/query-test | json
    ```
 
    Output:

apps/nest-server/src/app/app.controller.ts

@@ -6,7 +6,7 @@ import { AppService } from './app.service'
 export class AppController {
   constructor(private readonly appService: AppService) {}
 
-  @Get('call-centers')
+  @Get('query-test')
   async getData() {
     try {
       return await this.appService.getData()

apps/nest-server/src/app/app.service.ts

@@ -5,14 +5,22 @@ import PrestoClient, { PrestoClientConfig } from '@prestodb/presto-js-client'
 export class AppService {
   async getData(): Promise<unknown> {
     const clientParams: PrestoClientConfig = {
-      catalog: 'tpcds',
+      catalog: 'tpch',
       host: 'http://localhost',
       port: 8080,
-      schema: 'sf10',
+      schema: 'sf1',
       user: 'root',
     }
     const client = new PrestoClient(clientParams)
-    const results = await client.query(`SELECT * FROM call_center`)
-    return { columns: results.columns, rows: results.data }
+    try {
+      const results = await client.query(
+        `select returnflag, linestatus, sum(quantity) as sum_qty, sum(extendedprice) as sum_base_price, sum(extendedprice * (1 - discount)) as sum_disc_price, sum(extendedprice * (1 - discount) * (1 + tax)) as sum_charge, avg(quantity) as avg_qty, avg(extendedprice) as avg_price, avg(discount) as avg_disc, count(*) as count_order from lineitem where shipdate <= date '1998-12-01' group by returnflag, linestatus order by returnflag, linestatus`,
+      )
+      return { columns: results.columns, rows: results.data }
+    } catch (error) {
+      return JSON.stringify({
+        error,
+      })
+    }
   }
 }

apps/nest-server/src/main.ts

@@ -9,7 +9,9 @@ import { NestFactory } from '@nestjs/core'
 import { AppModule } from './app/app.module'
 
 async function bootstrap() {
-  const app = await NestFactory.create(AppModule)
+  const app = await NestFactory.create(AppModule, {
+    logger: ['error', 'warn', 'log', 'debug'],
+  })
   const globalPrefix = 'api'
   app.setGlobalPrefix(globalPrefix)
   const port = process.env.PORT || 3000

apps/nextjs/app/api/route.ts

@@ -7,7 +7,7 @@ export async function GET() {
     catalog: 'tpcds',
     host: 'http://localhost',
     port: 8080,
-    schema: 'sf10',
+    schema: 'sf1',
     user: 'root',
   }
   const client = new PrestoClient(prestoClientConfig)

docker-compose/presto/presto.md

@@ -11,7 +11,7 @@ npm run presto:up
 Use the Presto-CLI to run queries:
 
 ```
-docker exec -it prestodb presto-cli --catalog tpcds --schema sf10
+docker exec -it prestodb presto-cli --catalog tpcds --schema sf1
 ```
 
 Examples:

package.json

@@ -2,13 +2,16 @@
   "name": "presto-js-client",
   "description": "JavaScript client for Presto",
   "keywords": [
-    "javascript",
+    "database",
     "presto",
     "prestodb",
-    "typescript"
+    "sql"
   ],
-  "license": "Apache-2.0",
   "repository": "https://github.com/prestodb/presto-js-client",
+  "license": "Apache-2.0",
+  "workspaces": [
+    "packages/*"
+  ],
   "scripts": {
     "build": "nx build",
     "commit": "cz",
@@ -90,11 +93,7 @@
     "verdaccio": "^5.0.4"
   },
   "engines": {
-    "npm": ">=9.6",
-    "node": ">=18.17"
-  },
-  "private": true,
-  "workspaces": [
-    "packages/*"
-  ]
+    "node": ">=18.17",
+    "npm": ">=9.6"
+  }
 }

presto-client/.swcrc

@@ -25,5 +25,5 @@
   "module": {
     "type": "commonjs"
   },
-  "sourceMaps": true
+  "sourceMaps": false
 }

presto-client/CONTRIBUTING.md

@@ -0,0 +1,138 @@
+# presto-client
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+To build the library using [SWC](https://swc.rs), run the following command:
+
+```bash
+npm run build presto-client
+```
+
+## Linting
+
+To lint the library using [ESLint](https://eslint.org), run the following command:
+
+```bash
+npm run lint presto-client
+```
+
+## Publishing
+
+### Locally
+
+To publish a new version to a private local registry, follow these steps:
+
+#### Steps
+
+1. Start by cleaning your workspace using the following command:
+
+   ```bash
+   git stash
+   ```
+
+2. Start a private local registry using [Verdaccio](https://verdaccio.org):
+
+   ```bash
+   npm run local-registry presto-js-client
+   ```
+
+3. In another terminal, publish the new version by running the following command:
+
+   ```bash
+   npm run publish:local presto-client
+   ```
+
+   If you're publishing a Pre-release version, run instead:
+
+   ```bash
+   npm run publish:local presto-client -- --releaseAs=premajor|preminor|prepatch --preid=beta
+   ```
+
+   Check the [semver options](https://github.com/jscutlery/semver#available-options) for all available options.
+
+4. If the output of the previous command is successful, check that:
+
+- A new local git tag was generated.
+- `presto-client/CHANGELOG.md` file was updated.
+- `presto-client/package.json` file was updated.
+
+5. Visit http://localhost:4873 and ensure that `@prestodb/presto-js-client` was pushed successfully to the private local registry, including the git tag, `CHANGELOG.md`, and `package.json` files reviewed above.
+
+6. Now you can run `npm i @prestodb/presto-js-client` in any other project locally to test the released version before releasing it to NPM.
+
+### NPM
+
+To publish a new version to NPM, follow these steps:
+
+#### Pre-requisites
+
+- Have a valid `NPM_TOKEN` with write permissions to [prestodb NPM organization](https://www.npmjs.com/settings/prestodb/packages).
+- Install [GitHub CLI](https://cli.github.com/) on your machine.
+
+#### Steps
+
+1. Start by cleaning your workspace using the following command:
+
+   ```bash
+   git stash
+   ```
+
+2. Publish a new version by running the following command:
+
+   ```bash
+   npm run publish presto-client
+   ```
+
+   If you're publishing a Pre-release version, run instead:
+
+   ```bash
+   npm run publish presto-client -- --releaseAs=premajor|preminor|prepatch --preid=beta
+   ```
+
+   Check the [semver options](https://github.com/jscutlery/semver#available-options) for all available options.
+
+3. As part of the previous command, a draft GitHub release is also created. Go to [GitHub Releases](https://github.com/prestodb/presto-js-client/releases), review and edit it if necessary, and then click "Publish release" to make it public.
+
+   \*If you published the package as a Pre-release version, please also mark the GitHub release as a "Pre-release."
+
+## Testing
+
+To test the library using [Jest](https://jestjs.io), run the following command:
+
+```bash
+npm run test presto-client
+```
+
+## Sample apps
+
+You can run the sample apps to check the client still works properly.
+
+### NestJS Server
+
+Run the server with
+
+```sh
+npx nx serve nest-server
+```
+
+Check the server is live and you can make queries on this URL:
+
+```
+http://localhost:3000/api/query-test
+```
+
+### NextJS Server Side Rendered app
+
+Run the application with
+
+```sh
+npx nx serve nextjs
+```
+
+Check the app is running on your browser:
+
+```
+http://localhost:4200/
+```