@cap-js/cds-typer 0.2.5-beta.1

package/CHANGELOG.md

@@ -0,0 +1,43 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+The format is based on [Keep a Changelog](http://keepachangelog.com/).
+
+
+## Version 0.2.5-beta.1 - 2023-06-13
+
+### Changed
+
+- Bump version
+
+## Version 0.2.4 - 2023-06-12
+- Enable use of annotated singular/ plural names in associations/ compositions
+- Rename package from `@sap/cds-dts-generator` to `@cap-js/cds-typer`
+
+## Version 0.2.3 - 2023-05-17
+- Add missing library files
+
+## Version 0.2.2 - 2023-05-17
+- Make class hierarchy flatter
+
+## Version 0.2.1 - 2023-05-16
+- Add missing files
+
+## Version 0.2.0 - 2023-05-15
+- use native Typescript AST in unit tests
+- add `propertiesOptional` flag
+- support flat, as well as nested inline declarations
+- support `typeof` syntax
+- read rudimentary configuration from cds.env
+- export bound and unbound actions
+- allow inline type definitions within compositions
+- enable use of additional type libraries (HANA types available as first library)
+- provide proper JSDoc for all modules
+- export entity types for singular variants alongside plural types
+## Version 0.1.1 - 2023-01-26
+- add TL;DR section to README
+- allow multiple positional arguments
+
+## Version 0.1.0
+- initial code base

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,192 @@
+# CDS type generator for JavaScript
+
+## About this project
+
+Generates `.ts` files for a CDS model to receive code completion in VS Code.
+
+
+## Requirements and Setup
+
+
+### Building the Project Yourself
+Clone the repository and install the dependencies running `npm i` from the project's root directory.
+
+
+### Usage
+The type generator is currently meant as a standalone tool and can be installed and used independently of other CDS environments (sans its dependency to the cds compiler).
+
+#### Quickstart
+Assuming you have the following CDS project structure:
+
+```
+/home/
+├── mybookshop/
+│   ├── db/
+│   │   └── schema.cds
+│   ├── srv/
+│   │   └── service.js
+```
+
+a typical workflow to generate types for your CDS project could look something like this:
+
+```sh
+git clone https://this/repo cds-js-type-generator
+cd cds-js-type-generator
+npm i
+node ./index.js \
+  --rootDir /home/mybookshop/@types \
+  --jsConfigPath /home/mybookshop \
+  /home/mybookshop/srv/schema.cds
+```
+
+You would then end up with a `jsconfig.json` file in the project's root and a directory `@types`, which contains your entities and their accompanying types in a directory structure. The directory structure directly reflects the namespaces you have defined your entities in. They have to be imported in any JavaScript-based service handlers you want to have type support in and can replace calls to `cds.entities(...)`:
+
+```js
+// srv/service.js
+const { Books } = require('my.bookshop')
+
+```
+
+becomes
+
+```js
+// srv/service.js
+
+const { Books } = require('../@types/mybookshop')
+```
+
+From that point on you should receive code completion from the type system for `Books`.
+
+#### CLI
+_cds-typer_ comes with rudimentary CLI support and a few command line options:
+
+- `--help`: prints all available parameters.
+- `--rootDir`: specifies the root directory where all generated files should be put. Defaults to the CWD.
+- `--jsConfigPath`: specifies the path to the `jsconfig.json` file to generate. Usually your project's root directory. If specified, a config file is created that restricts the usage of types even further:
+
+```js
+// generated .ts file
+class Book {
+    title: string;
+}
+
+// some hook in your service
+SELECT(Books, b => {
+    b.title // 👍 no problem, property exists
+    b.numberOfPages // ❌ property does not exist
+})
+```
+With the generated config in place, the language server will display an error, telling you that `numberOfPages` does not exist in this context. Without the config it would just infer it as `any`.
+
+- `--loglevel`: minimum log level that should be printed. Defaults to `NONE`. Available log levels roughly follow [Microsoft's dotnet log levels](https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.loglevel?view=dotnet-plat-ext-6.0):
+
+```
+TRACE
+DEBUG
+INFO
+WARNING
+ERROR
+CRITICAL
+NONE
+```
+
+The utility expects (at least) one path to a `.cds` file as positional parameter which serves as entry point to the model in question, e.g.:
+
+```sh
+cds-typer ./path/to/my/model/model.cds --rootDir /tmp/
+```
+
+Note that you can also pass multiple paths or `"*"` as glob pattern (with quotes to circumvent expansion by the shell). This passes the pattern on to the compiler where the [regular resolve strategy](https://cap.cloud.sap/docs/node.js/cds-compile?q=compiler#cds-resolve) is used.
+
+#### Programmatically
+The main API for using _cds-typer_ within another project is contained in [`compile.js`](https://github.tools.sap/cap/cds-typer/blob/master/lib/compile.js), specifically:
+
+- `compileFromFile(…)` to parse a `.cds` file. This involves compiling it to CSN first.
+- `compileFromCSN(…)` to directly compile from CSN object. This is useful when you already have your CSN available as part of a tool chain. ⚠️ **WARNING**: the application of `cdstyper` may be impure, meaning that it _could_ alter the provided CSN. If you use the typer this way, you may want to apply it as last step of your tool chain.
+
+
+### Features
+#### Plural Types
+While CDS encourages the use of plural form for defined entities, their OOP equivalent classes are usually named in singular. _cds-typer_ automatically transforms entity names to singular and adds the plural form for arrays:
+
+```cds
+entity Books : cuid {
+    …
+}
+```
+
+becomes
+
+```ts
+class Book {
+	…
+}
+
+class Books extends Array<Book> {}
+```
+
+If you need to customise the singular or plural form, or if your entities are already in singular form, you can do so using annotations:
+
+```cds
+@singular: 'Mouse'
+entity Mice {}
+
+@plural: 'SomeListList'
+entity SomeList {}
+```
+
+results in
+
+```ts
+class Mouse { … }
+class Mice extends Array<Mouse> { … }
+
+class SomeList { … }
+class SomeListList extends Array<SomeList> { … }
+```
+
+### Relation to _cds2types_
+This project is inspired by the existing [_cds2types_](https://github.com/mrbandler/cds2types), but differs in a few aspects:
+
+#### Reworked Imports
+Instead of one monolithic `.d.ts` file containing all entities in nested namespaces, multiple files are generated where each namespace is represented by a directory structure. This facilicates simpler imports in a more Java-esque style:
+
+```js
+const types = require('./cds2types/compiled.d.ts')
+
+console.log(types.sap.cap.bookshop.Books) // a class
+```
+
+becomes
+
+```js
+const { Books } = require('./cds-typer/sap/cap/bookshop')
+
+console.log(Books) // the same class
+```
+
+#### Usable in Javascript Projects
+Generated code is usable from within plain Javascript projects. The code generated by _cds2types_ would represent each cds-entity as an interface, which are not visible to Javascript projects. _cds-typer_ uses classes instead.
+
+#### Faster
+_cds2types_ takes a detour to create a Typescript AST first and then print out the formatted source files. _cds-typer_ directly walks the linked CSN and creates strings on the fly. Also, file operations are `async`. These two changes speed up _cds-typer_ by around one to two orders of magnitude compared to _cds2types_.
+
+#### Small Footprint
+_cds-typer_ tries to keep its dependency footprint as small as possible. Libraries like `typescript` are only needed as dev dependencies.
+
+
+
+
+
+
+## Support, Feedback, Contributing
+
+This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/cds-dts-generator/issues). 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 2022-2022 SAP SE or an SAP affiliate company and cds-dts-generator 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/SAP/cds-dts-generator).

package/index.js

@@ -0,0 +1,5 @@
+const compile = require('./lib/compile')
+
+module.exports = {
+    compile
+}

package/lib/cli.js

@@ -0,0 +1,100 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+'use strict'
+
+const { compileFromFile } = require('./compile')
+const { parseCommandlineArgs } = require('./util')
+const { Levels } = require('./logging')
+const path = require('path')
+
+const toolName = 'cds-typer'
+
+const flags = {
+    // FIXME: remove asap
+    rootDir: {
+        desc: '[DEPRICATED] use outputDirectory instead',
+        default: './',
+    },
+    outputDirectory: {
+        desc: 'root directory to write generated files to',
+        default: './',
+    },
+    help: {
+        desc: 'this text',
+    },
+    logLevel: {
+        desc: `minimum log level`,
+        allowed: Object.keys(Levels),
+        default: Object.keys(Levels).at(-1),
+    },
+    jsConfigPath: {
+        desc: `Path to where the jsconfig.json should be written. If specified, ${toolName} will create a jsconfig.json file and set it up to restrict property usage in types entities to existing properties only.`,
+    },
+    version: {
+        desc: 'prints the version of this tool'
+    },
+    inlineDeclarations: {
+        desc: 'whether to resolve inline type declarations flat (x_a, x_b, ...) or structured (x: {a, b})',
+        allowed: ['flat', 'structured'],
+        default: 'structured'
+    },
+    propertiesOptional: {
+        desc: 'if set to true, properties in entities are always generated as optional (a?: T)',
+        allowed: ['true', 'false'],
+        default: 'true'
+    }
+}
+
+const hint = () => console.log('Missing or invalid parameter(s). Call with --help for more details.')
+
+const help = () =>
+    console.log(
+        '[SYNOPSIS]\n' +
+        'Call with at least one positional parameter pointing to the (root) CDS file you want to compile.\n' +
+            'Additionaly, you can use the following parameters:\n' +
+            Object.entries(flags)
+                .sort()
+                .map(([key, value]) => {
+                    let s = `--${key}: ${value.desc}`
+                    if (value.allowed) {
+                        s += ` [allowed: ${value.allowed.join(' | ')}]`
+                    }
+                    if (value.default) {
+                        s += ` (default: ${value.default})`
+                    }
+                    return s
+                }
+            ).join('\n\n')
+    )
+
+const version = () => console.log(require('../package.json').version)
+
+const main = async (args) => {
+    if ('help' in args.named) {
+        help()
+        process.exit(0)
+    }
+    if ('version' in args.named) {
+        version()
+        process.exit(0)
+    }
+    if (args.positional.length === 0) {
+        hint()
+        process.exit(1)
+    }
+    if (args.named.jsConfigPath && !args.named.jsConfigPath.endsWith('jsconfig.json')) {
+        args.named.jsConfigPath = path.join(args.named.jsConfigPath, 'jsconfig.json')
+    }
+    compileFromFile(args.positional, {
+        // temporary fix until rootDir is faded out
+        outputDirectory: [args.named.outputDirectory, args.named.rootDir].find(d => d !== './') ?? './',
+        logLevel: Levels[args.named.logLevel],
+        jsConfigPath: args.named.jsConfigPath,
+        inlineDeclarations: args.named.inlineDeclarations,
+        propertiesOptional: args.named.propertiesOptional === 'true'
+    })
+}
+
+if (require.main === module) {
+    main(parseCommandlineArgs(process.argv.slice(2), flags))
+}