@ocelescope/api-base 0.0.0 → 0.1.0

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 (5) hide show
  1. package/LICENSE +661 -0
  2. package/README.md +14 -18
  3. package/dist/index.d.ts +1174 -786
  4. package/dist/index.js +972 -996
  5. package/package.json +10 -9
package/README.md CHANGED
@@ -1,29 +1,25 @@
1
- # react-components-starter
1
+ # @ocelescope/api-base
2
2
 
3
- A starter for creating a React component library.
3
+ Generated, type-safe client and React Query hooks for the Ocelescope **base**
4
+ backend API.
5
+ [Orval](https://orval.dev/).
4
6
 
5
- ## Development
6
-
7
- - Install dependencies:
7
+ ## Installation
8
8
 
9
9
  ```bash
10
- npm install
10
+ pnpm add @ocelescope/api-base
11
11
  ```
12
12
 
13
- - Run the playground:
13
+ ## Usage
14
14
 
15
- ```bash
16
- npm run play
15
+ ```ts
16
+ import { /* hooks and client */ } from "@ocelescope/api-base";
17
17
  ```
18
18
 
19
- - Run the unit tests:
19
+ ## About
20
20
 
21
- ```bash
22
- npm run test
23
- ```
21
+ Part of [Ocelescope](https://github.com/promi4s/ocelescope), a framework for
22
+ working with Object-Centric Event Logs (OCEL) developed at the Chair of Process
23
+ and Data Science (PADS), RWTH Aachen University.
24
24
 
25
- - Build the library:
26
-
27
- ```bash
28
- npm run build
29
- ```
25
+ 📖 Documentation: <https://www.ocelescope.org>