@cedarjs/api 2.5.0 → 2.5.1-rc.29
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 +11 -11
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## Purpose and Vision
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Cedar believes the future is serverless and multi-client. And `@cedarjs/api` makes Cedar serverless and multi-client ready. Cedar has one API to rule them all. Your API is abstracted away from any one side of your application, so you can have as many sides as you need, and when you need them.
|
|
6
6
|
|
|
7
|
-
Right now, the `@
|
|
7
|
+
Right now, the `@cedarjs/api` package exposes functions that help with logging, services, data fetching via Prisma, webhooks and authentication.
|
|
8
8
|
|
|
9
9
|
We also plan to make Functions platform-agnostic. At the moment, we're targeting AWS Lambda, but we aim to provide a single interface for other providers and build-time support when you've targeted them.
|
|
10
10
|
|
|
@@ -15,11 +15,11 @@ We also plan to make Functions platform-agnostic. At the moment, we're targeting
|
|
|
15
15
|
|
|
16
16
|
### Logging
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
CedarJS provides an opinionated logger with sensible, practical defaults that grants you visibility into the JAMStack applications you're developing and have deployed -- with ease.
|
|
19
19
|
|
|
20
20
|
Logging in the serverless ecosystem is not trivial and neither is its configuration.
|
|
21
21
|
|
|
22
|
-
When choosing a Node.js logger to add to the framework,
|
|
22
|
+
When choosing a Node.js logger to add to the framework, CedarJS required that it:
|
|
23
23
|
|
|
24
24
|
- Have a low-overhead, and be fast
|
|
25
25
|
- Output helpful, readable information in development
|
|
@@ -31,21 +31,21 @@ When choosing a Node.js logger to add to the framework, RedwoodJS required that
|
|
|
31
31
|
- Have a solid Developer experience (DX) to get logging out-of-the-gate quickly
|
|
32
32
|
- Use a compact configuration to set how to log (its `options`) and where to log -- file, stdout, or remote transport stream -- (its `destination`)
|
|
33
33
|
|
|
34
|
-
With those criteria in mind,
|
|
34
|
+
With those criteria in mind, Cedar includes [pino](https://github.com/pinojs/pino) with its rich [features](https://github.com/pinojs/pino/blob/master/docs/api.md), [ecosystem](https://github.com/pinojs/pino/blob/master/docs/ecosystem.md) and [community](https://github.com/pinojs/pino/blob/master/docs/ecosystem.md#community).
|
|
35
35
|
|
|
36
|
-
Plus ... pino means 🌲 pine tree! How perfect is that for
|
|
36
|
+
Plus ... pino means 🌲 pine tree! How perfect is that for CedarJS?
|
|
37
37
|
|
|
38
|
-
Note:
|
|
38
|
+
Note: CedarJS logging is setup for its api side only. For browser and web side error reporting or exception handling, these features will be addressed in a future release.
|
|
39
39
|
|
|
40
|
-
For detailed logger configuration, see the
|
|
40
|
+
For detailed logger configuration, see the CedarJS logger package [README](./src/logger/README.md).
|
|
41
41
|
|
|
42
42
|
## Contributing
|
|
43
43
|
|
|
44
|
-
`@
|
|
44
|
+
`@cedarjs/api` uses a few things you should be familiar with:
|
|
45
45
|
|
|
46
46
|
- [Prisma](https://www.prisma.io)
|
|
47
47
|
- [Pino](https://getpino.io)
|
|
48
48
|
|
|
49
|
-
Although this package depends, in the code-dependency sense, only on `@
|
|
49
|
+
Although this package depends, in the code-dependency sense, only on `@cedarjs/internal`, it still hangs together with the others—notably, `@cedarjs/web` and `@cedarjs/api-server`. So, if you’re asking yourself “but when does my server run?” head over to `@cedarjs/api-server`.
|
|
50
50
|
|
|
51
|
-
If you’re asking yourself “but where is my GraphQL Server” head over to `@
|
|
51
|
+
If you’re asking yourself “but where is my GraphQL Server” head over to `@cedarjs/graphql-server`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cedarjs/api",
|
|
3
|
-
"version": "2.5.
|
|
3
|
+
"version": "2.5.1-rc.29",
|
|
4
4
|
"repository": {
|
|
5
5
|
"type": "git",
|
|
6
6
|
"url": "git+https://github.com/cedarjs/cedar.git",
|
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
"title-case": "3.0.3"
|
|
98
98
|
},
|
|
99
99
|
"devDependencies": {
|
|
100
|
-
"@cedarjs/framework-tools": "
|
|
100
|
+
"@cedarjs/framework-tools": "2.5.1-rc.29",
|
|
101
101
|
"@types/aws-lambda": "8.10.160",
|
|
102
102
|
"@types/jsonwebtoken": "9.0.10",
|
|
103
103
|
"@types/memjs": "1",
|
|
@@ -128,5 +128,5 @@
|
|
|
128
128
|
"publishConfig": {
|
|
129
129
|
"access": "public"
|
|
130
130
|
},
|
|
131
|
-
"gitHead": "
|
|
131
|
+
"gitHead": "6df495874d3c8388e6340a1ce7cd5fe53a46a1db"
|
|
132
132
|
}
|