@odata2ts/odata2ts 0.20.0 → 0.20.1

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.20.1](https://github.com/odata2ts/odata2ts/compare/@odata2ts/odata2ts@0.20.0...@odata2ts/odata2ts@0.20.1) (2023-04-08)
+
+**Note:** Version bump only for package @odata2ts/odata2ts
+
 # [0.20.0](https://github.com/odata2ts/odata2ts/compare/@odata2ts/odata2ts@0.19.2...@odata2ts/odata2ts@0.20.0) (2023-04-04)
 
 ### Features

package/README.md

@@ -2,34 +2,74 @@
 
 # odata2ts
 
-Generate TypeScript models, magical q-objects and / or complete client services
-from readily available metadata descriptions of your OData service.
+The basic idea of `odata2ts` is to leverage the readily available metadata of any OData service 
+to generate different sorts of typed artefacts which you use in your TypeScript code.
+This package `@odata2ts/odata2ts` realizes the generation process.
+
+The generator is supposed to be used with a TypeScript based configuration file. 
+Then it's able to handle the generation for multiple OData services.
+
+It comes with powerful configuration options. Some highlights:
+- generation of TypeScript files or compiled JS / DTS files
+- name or rename stuff
+  - naming of pretty much any aspect of the generated artefacts
+  - e.g. all types should be prefixed with an "I", Person => IPerson
+  - consistent casing (as in "camelCase" or "PascalCase") even for property names of entity types
+- use type converters
+
+See the [generator documentation](https://odata2ts.github.io/docs/generator/setup-and-usage) for more information.
 
 ## Installation
 
 ```
 npm install --save-dev @odata2ts/odata2ts
-
-yarn add --dev @odata2ts/odata2ts
 ```
 
-## Implicit Dependencies
-The generated artefacts depend on other libraries. `odata2ts` lists them as peer dependencies.
-Hence, you will need to add runtime dependencies matching the mentioned peer dependencies.
-See the Getting Started Guide of the documentation.
+### Implicit Dependencies
+Most of the generated artefacts depend on other libraries. `odata2ts` lists them as peer dependencies.
+
+Depending on your use case, you will need to add runtime dependencies matching the mentioned peer dependencies.
+See the [Getting Started Guide](https://odata2ts.github.io/docs/category/getting-started/) of the documentation 
+for guidance.
 
 ## Documentation
+[Generator Documentation](https://odata2ts.github.io/docs/generator/setup-and-usage)
+
 Main documentation for the odata2ts eco system:
 [https://odata2ts.github.io](https://odata2ts.github.io/)
 
+
 ## Examples
 See [example packages](https://github.com/odata2ts/odata2ts/tree/main/examples) for examples of how to integrate `odata2ts`.
 
+## Tests
+See folder [test](https://github.com/odata2ts/odata2ts/tree/main/packages/odata2ts/test)
+for unit tests.
+
+See folder [int-test](https://github.com/odata2ts/odata2ts/tree/main/packages/odata2ts/int-test) for integration
+tests of the CLI.
+
+Each example package serves as integration test of the generator.
+
+## Support, Feedback, Contributing
+This project is open to feature requests, suggestions, bug reports, usage questions etc.
+via [GitHub issues](https://github.com/odata2ts/odata2ts/issues).
+
+Contributions and feedback are encouraged and always welcome.
+
+See the [contribution guidelines](https://github.com/odata2ts/odata2ts/blob/main/CONTRIBUTING.md) for further information.
+
 ## Spirit
-* Adhere to the OData specification as much as possible
-* Test Driven Development
-* High Code Coverage: > 90%
+This project and this module have been created and are maintained in the following spirit:
+
+* adhere to the **OData specification** as much as possible
+  * support any OData service implementation which conforms to the spec
+  * allow to work around faulty implementations if possible
+* stability matters
+  * exercise Test Driven Development
+  * bomb the place with unit tests (code coverage > 95%)
+  * ensure that assumptions & understanding are correct by creating integration tests
 
 ## License
-MIT
+MIT - see [License](./LICENSE).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@odata2ts/odata2ts",
-  "version": "0.20.0",
+  "version": "0.20.1",
   "publishConfig": {
     "access": "public"
   },
@@ -46,14 +46,14 @@
     "js"
   ],
   "peerDependencies": {
-    "@odata2ts/odata-client-api": "^0.6.0",
-    "@odata2ts/odata-query-objects": "^0.17.0",
-    "@odata2ts/odata-service": "^0.13.6"
+    "@odata2ts/odata-client-api": "^0.6.3",
+    "@odata2ts/odata-query-objects": "^0.17.1",
+    "@odata2ts/odata-service": "^0.13.7"
   },
   "dependencies": {
     "@odata2ts/converter-api": "^0.1.1",
     "@odata2ts/converter-runtime": "^0.1.2",
-    "@odata2ts/odata-core": "^0.3.6",
+    "@odata2ts/odata-core": "^0.3.7",
     "camel-case": "^4.1.2",
     "commander": "^9.1.0",
     "constant-case": "^3.0.4",
@@ -72,9 +72,9 @@
   },
   "devDependencies": {
     "@odata2ts/converter-v2-to-v4": "^0.1.2",
-    "@odata2ts/odata-client-api": "^0.6.2",
-    "@odata2ts/odata-query-objects": "^0.17.0",
-    "@odata2ts/odata-service": "^0.13.6",
+    "@odata2ts/odata-client-api": "^0.6.3",
+    "@odata2ts/odata-query-objects": "^0.17.1",
+    "@odata2ts/odata-service": "^0.13.7",
     "@types/fs-extra": "^9.0.13",
     "@types/jest": "^27.4.1",
     "@types/node": "^17.0.23",
@@ -88,6 +88,6 @@
     "typescript": "^4.9.4"
   },
   "types": "./lib/index.d.ts",
-  "gitHead": "7342db39191ee043048e00496beefa3991df4a7a",
+  "gitHead": "e822bca2fc167a490cd7467167868c624fe7b9a1",
   "readme": "README.md"
 }