@cap-js/postgres 1.2.1 → 1.3.1

package/CHANGELOG.md

@@ -4,11 +4,21 @@
 - The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - This project adheres to [Semantic Versioning](http://semver.org/).
 
+### Version 1.3.1 - 2023-10-10
+
+- `cds build`-relevant files are now correctly packaged into the release. #266
+
+### Version 1.3.0 - 2023-10-06
+
+### Added
+
+- `cds build` is now natively supported in `@cap-js/postgres`. Thus, a `cds build` will automatically generate deployment artifacts for Postgres-enabled projects.
+
 ## Version 1.2.1 - 2023-09-08
 
 ### Changed
 
-- Bump minimum required version of `@cap-js/db-service` 
+- Bump minimum required version of `@cap-js/db-service`
 
 ## Version 1.2.0 - 2023-09-06
 
@@ -49,7 +59,7 @@
 
 ### Changed
 
-- Updated minimum required version of `@cap-js/db-service` 
+- Updated minimum required version of `@cap-js/db-service`
 
 ## Version 1.0.0 - 2023-06-23
 

package/README.md

@@ -1,7 +1,34 @@
 # CDS database service for Postgres
 
 Welcome to the new Postgres database service for [SAP Cloud Application Programming Model](https://cap.cloud.sap) Node.js, based on new, streamlined database architecture and [*pg* driver](https://www.npmjs.com/package/pg) .
-Find full documentation at https://cap.cloud.sap/docs/guides/databases-postgres.
+
+## Setup
+
+In general, all you need to do is to install one of the database packages, as follows:
+
+
+```sh
+npm add @cap-js/postgres
+```
+
+Learn more about setup and usage in the [respective database guide](https://cap.cloud.sap/docs/guides/databases-postgres).
+
+
+## Support
+
+This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/cds-dbs/issues).
+
+## Contribution
+
+Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
+
+## Code of Conduct
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.
+
+## Licensing
+
+Copyright 2023 SAP SE or an SAP affiliate company and cds-dbs contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/cds-dbs).
 
 ## migration guide from `cds-pg` to `@cap-js/postgres`
 

package/cds-plugin.js

@@ -3,3 +3,7 @@ const cds = require('@sap/cds/lib')
 if (!cds.env.fiori.lean_draft) {
   throw new Error('"@cap-js/postgres" only works if cds.fiori.lean_draft is enabled. Please adapt your configuration.')
 }
+
+if (cds.cli.command === 'build') {
+  module.exports = require('./lib/build')
+}

package/lib/build.js

@@ -0,0 +1,54 @@
+const cds = require('@sap/cds')
+
+let BuildPlugin
+try {
+  ({ BuildPlugin } = require('@sap/cds-dk/lib/build'))
+} catch (e) {
+  if (e.code === 'ENOTFOUND') throw `No build plugin mechanism for @sap/cds-dk found. Please install @sap/cds-dk for development using 'npm i -D @sap/cds-dk@^7.3.0'`
+  else throw e
+}
+
+const { fs, path, rimraf } = cds.utils
+
+module.exports = class PostgresBuildPlugin extends BuildPlugin {
+  static hasTask() { // REVISIT: should be unnecessary -> plugin mechanism knows what to pull
+    return cds.requires.db.kind === 'postgres'
+  }
+
+  static getTaskDefaults() {
+    return { src: cds.env.folders.db }
+  }
+
+  init() {
+    this.task.dest = cds.env.build.target === '.' ? path.join('gen','pg') : path.join('gen', 'pg')
+  }
+
+  async clean() {
+    await rimraf(this.task.dest)
+  }
+
+  async build() {
+    const model = await this.model()
+    if (!model) {
+      return
+    }
+
+    const promises = []
+    promises.push(this.write({
+        dependencies: { '@sap/cds': '^7', '@cap-js/postgres': '^1' },
+        scripts: { start: 'cds-deploy' },
+      }).to('package.json'))
+    promises.push(this.write(cds.compile.to.json(model)).to(path.join('db', 'csn.json')))
+
+    let data
+    if (fs.existsSync(path.join(this.task.src, 'data'))) {
+      data = 'data'
+    } else if (fs.existsSync(path.join(this.task.src, 'csv'))) {
+      data = 'csv'
+    }
+    if (data) {
+      promises.push(this.copy(data).to(path.join('db', 'data')))
+    }
+    return Promise.all(promises)
+  }
+}

package/lib/func.js

@@ -2,7 +2,7 @@ const session = require('./session.json')
 
 const StandardFunctions = {
   session_context: x => {
-    let sql = `current_setting('${ session[x.val] || x.val }')`
+    let sql = `current_setting('${session[x.val] || x.val}')`
     if (x.val === '$now') sql += '::timestamp'
     return sql
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/postgres",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "CDS database service for Postgres",
   "homepage": "https://github.com/cap-js/cds-dbs/tree/main/postgres#cds-database-service-for-postgres",
   "repository": {
@@ -31,11 +31,17 @@
     "start": "docker-compose -f pg-stack.yml up -d"
   },
   "dependencies": {
-    "@cap-js/db-service": "^1.2.1",
+    "@cap-js/db-service": "^1.3.1",
     "pg": "^8"
   },
   "peerDependencies": {
-    "@sap/cds": ">=7"
+    "@sap/cds": ">=7",
+    "@sap/cds-dk": ">=7"
+  },
+  "peerDependenciesMeta": {
+    "cds-dk": {
+      "optional": true
+    }
   },
   "cds": {
     "requires": {