@appbuildersph/shared 0.0.1 → 0.0.3
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 +30 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# @appbuildersph/shared
|
|
2
|
+
|
|
3
|
+
Cross-package types and small utilities used across the App Builders PH SDK.
|
|
4
|
+
You won't normally install this directly — `@appbuildersph/core` re-exports
|
|
5
|
+
everything from it — but it's useful as a reference for the config/data
|
|
6
|
+
shapes every package agrees on.
|
|
7
|
+
|
|
8
|
+
## Key types
|
|
9
|
+
|
|
10
|
+
```ts
|
|
11
|
+
import type {
|
|
12
|
+
AppBuildersConfig, // the object passed to AppBuilders.init()
|
|
13
|
+
BadgeConfig, // packages/badge config shape
|
|
14
|
+
IdentitySnapshot, // returned by AppBuilders.identity().get()
|
|
15
|
+
HealthReport, // watcher.health() summary shape
|
|
16
|
+
SecurityReport, // reserved for @appbuildersph/security
|
|
17
|
+
LogEntry, // logger.query() result entries
|
|
18
|
+
AppBuildersPlugin, // { name, setup(ctx) } plugin shape
|
|
19
|
+
} from "@appbuildersph/shared";
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Utilities
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
import { generateUuid, nowIso, resolveEnvironment } from "@appbuildersph/shared";
|
|
26
|
+
|
|
27
|
+
generateUuid(); // crypto.randomUUID()
|
|
28
|
+
nowIso(); // new Date().toISOString()
|
|
29
|
+
resolveEnvironment(); // "development" | "staging" | "production" | "test" from NODE_ENV
|
|
30
|
+
```
|