@elek-io/core 0.12.0 → 0.14.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.
package/README.md CHANGED
@@ -6,6 +6,9 @@ Handles core functionality of elek.io Projects like file IO and version control
6
6
 
7
7
  ```
8
8
  |-- src
9
+ | |-- api
10
+ | | Exports a local API that allows reading Project data
11
+ | | mainly for development of websites or apps on the same device.
9
12
  | |-- error
10
13
  | | Different classes extending Error.
11
14
  | |-- schema
@@ -16,10 +19,6 @@ Handles core functionality of elek.io Projects like file IO and version control
16
19
  | | so their input is validated against our zod schemas.
17
20
  | |-- test
18
21
  | | Additional files and utility functions only used for testing.
19
- | |-- upgrade
20
- | | Files containing logic to upgrade each Project to support a higher Core version.
21
- | | This may include iterating over all Assets to add a new key / value
22
- | | because the new Core version uses it to store additional information.
23
22
  | |-- util
24
23
  | | Utility functions like path generation.
25
24
  | |-- index.browser.ts
@@ -27,8 +26,8 @@ Handles core functionality of elek.io Projects like file IO and version control
27
26
  | | but does not export the ElekIoCore main class,
28
27
  | | since it is not actually usable in a browser environment.
29
28
  | |-- index.node.ts
30
- | | Exports the ElekIoCore main class which makes the services endpoints accessible
31
- | | as well as schemas and utility functions.
29
+ | | Exports the ElekIoCore main class which makes the services and API
30
+ | | endpoints accessible as well as schemas and utility functions.
32
31
  ```
33
32
 
34
33
  ## The concept behind Projects, Collections, Entries, Values and Assets