@gisatcz/ptr-be-core 0.0.1-dev.1 → 0.0.1-dev.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/Readme.md +18 -26
  2. package/dist/index.cjs +153 -26285
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.ts +11 -11
  5. package/dist/index.mjs +151 -26286
  6. package/dist/index.mjs.map +1 -1
  7. package/dist/src/api/errors.api.d.ts +18 -0
  8. package/dist/src/api/models.api.d.ts +9 -0
  9. package/dist/src/coding/code.formating.d.ts +0 -1
  10. package/dist/src/coding/code.types.d.ts +1 -2
  11. package/dist/src/logging/logger.d.ts +0 -1
  12. package/dist/src/panther/enums.panther.d.ts +3 -3
  13. package/dist/src/panther/models.edges.d.ts +0 -1
  14. package/dist/src/panther/models.nodes.d.ts +18 -7
  15. package/dist/src/panther/models.nodes.properties.d.ts +41 -3
  16. package/package.json +17 -7
  17. package/.github/workflows/release-dev.yml +0 -34
  18. package/.github/workflows/release.yml +0 -28
  19. package/.github/workflows/version-bump.yml +0 -68
  20. package/barrelsby.json +0 -9
  21. package/dist/index.d.ts.map +0 -1
  22. package/dist/src/coding/code.formating.d.ts.map +0 -1
  23. package/dist/src/coding/code.types.d.ts.map +0 -1
  24. package/dist/src/logging/logger.d.ts.map +0 -1
  25. package/dist/src/panther/enums.panther.d.ts.map +0 -1
  26. package/dist/src/panther/models.edges.d.ts.map +0 -1
  27. package/dist/src/panther/models.nodes.d.ts.map +0 -1
  28. package/dist/src/panther/models.nodes.properties.d.ts.map +0 -1
  29. package/doc/npm-refresh.md +0 -4
  30. package/rollup.config.js +0 -30
  31. package/src/coding/code.formating.ts +0 -104
  32. package/src/coding/code.types.ts +0 -11
  33. package/src/logging/logger.ts +0 -58
  34. package/src/panther/SharedFeature.md +0 -43
  35. package/src/panther/enums.panther.ts +0 -41
  36. package/src/panther/models.edges.ts +0 -20
  37. package/src/panther/models.nodes.properties.ts +0 -31
  38. package/src/panther/models.nodes.ts +0 -55
  39. package/tsconfig.json +0 -51
package/Readme.md CHANGED
@@ -1,26 +1,18 @@
1
- # Bepack NPM
2
- Shared backend functionality like logging, general database methods, parsing, code helpers etc.
3
-
4
- Main output is NPM package `bepack`, which can be imported into other backend projects.
5
-
6
- Rest of the project works as sandbox and backend demo field.
7
-
8
- ## Structure of the NPM part
9
-
10
- Here is the main structure of the project:
11
-
12
- - src (code content)
13
- - `index.ts` (generated automaticly by `barrelsby`)
14
- - doc (NPM documentation)
15
- - config files
16
-
17
-
18
- ## Build of the NPM
19
- - Open terminal in the `/bepack`
20
- - Run `npm run build`
21
-
22
- Check `package.json` for build steps.
23
-
24
- ## Technologies
25
- - Typescript (https://www.typescriptlang.org/docs/)
26
- - Barrelsby for indexing (https://github.com/bencoveney/barrelsby)
1
+ # Shared Library for Panther Backend
2
+ This repository contains source of shared functionalities across Panther backend services.
3
+
4
+ ## Installation (DEV)
5
+ - Install Node and NPM
6
+ - Install YALC by `npm install -g yalc`
7
+ - Clone the package repository.
8
+ - Open terminal in package root.
9
+ - Run `npm i` and `npm run build` to install dependencies and make a build of the NPM package.
10
+ - Run `npm run yalc:publish` for local publishing the package into yalc repository.
11
+ - Now you can add this package for local development by opening the target application repository and run `yalc add @gisatcz/ptr-be-core`
12
+ - Run `npm run dev` for development mode with Rollup build watcher and auto yalc publishing.
13
+
14
+ ## Resources
15
+ - YALC (local NPM): https://github.com/wclr/yalc
16
+ - Vitest (testing): https://vitest.dev
17
+ - Barrelsby (TS Imports into one `index.ts`): https://github.com/bencoveney/barrelsby
18
+ - Rollup (NPM package build): https://rollupjs.org