@edgespark/server-types 0.0.1-alpha.5 → 0.0.1-alpha.7
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 +21 -79
- package/dist/index.d.ts +4 -4
- package/dist/index.d.ts.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,90 +1,32 @@
|
|
|
1
1
|
# @edgespark/server-types
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
TypeScript type definitions for EdgeSpark server SDK.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## What's Included
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- `Client<TSchema>` - Main SDK client interface
|
|
8
|
+
- `AuthClient` - Authentication with path-based conventions
|
|
9
|
+
- `User` - Authenticated user identity
|
|
10
|
+
- `StorageClient` / `BucketClient` - File storage operations
|
|
11
|
+
- `SecretClient` - Environment secrets access
|
|
8
12
|
|
|
9
|
-
|
|
10
|
-
sdk/server-types/src/index.ts ← Types (this package)
|
|
11
|
-
↓
|
|
12
|
-
workspace:*
|
|
13
|
-
↓
|
|
14
|
-
sdk-server/ ← Implementation (imports types from here)
|
|
15
|
-
↓
|
|
16
|
-
deployed
|
|
17
|
-
↓
|
|
18
|
-
user-worker ← Runtime (serves SDK to user code)
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Development Flow
|
|
22
|
-
|
|
23
|
-
### Adding a New Feature
|
|
24
|
-
|
|
25
|
-
1. **Add types** in `sdk/server-types/src/index.ts`
|
|
26
|
-
```typescript
|
|
27
|
-
export interface QueueClient {
|
|
28
|
-
send(message: string): Promise<void>;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
export interface Client<TSchema> {
|
|
32
|
-
// ... existing
|
|
33
|
-
queue: QueueClient; // new
|
|
34
|
-
}
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
2. **Implement** in `edge/workers/user-worker/src/sdk-server/`
|
|
38
|
-
```typescript
|
|
39
|
-
import type { QueueClient } from "@edgespark/server-types";
|
|
40
|
-
// ... implementation
|
|
41
|
-
```
|
|
13
|
+
## Usage
|
|
42
14
|
|
|
43
|
-
|
|
44
|
-
```bash
|
|
45
|
-
cd edge/workers/user-worker
|
|
46
|
-
wrangler deploy
|
|
47
|
-
```
|
|
15
|
+
This package is pre-installed in EdgeSpark projects. Types are used for autocompletion and type checking:
|
|
48
16
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
pnpm version minor # 0.0.1 → 0.1.0
|
|
53
|
-
pnpm publish
|
|
54
|
-
```
|
|
17
|
+
```typescript
|
|
18
|
+
import type { Client } from "@edgespark/server-types";
|
|
19
|
+
import { tables } from "@generated";
|
|
55
20
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
21
|
+
export async function createApp(edgespark: Client<typeof tables>) {
|
|
22
|
+
// Full IntelliSense for:
|
|
23
|
+
// - edgespark.db (Drizzle ORM)
|
|
24
|
+
// - edgespark.auth
|
|
25
|
+
// - edgespark.storage
|
|
26
|
+
// - edgespark.secret
|
|
27
|
+
}
|
|
63
28
|
```
|
|
64
29
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
## Rules
|
|
68
|
-
|
|
69
|
-
| Rule | Why |
|
|
70
|
-
|------|-----|
|
|
71
|
-
| Deploy impl BEFORE publishing types | New types + old impl = runtime errors |
|
|
72
|
-
| Types can publish WITHOUT deploy | JSDoc/comment changes are safe |
|
|
73
|
-
| Use `workspace:*` locally | Instant feedback during dev |
|
|
74
|
-
| Bump version on every publish | npm requires unique versions |
|
|
75
|
-
|
|
76
|
-
## Local Development
|
|
30
|
+
## Learn More
|
|
77
31
|
|
|
78
|
-
|
|
79
|
-
- Changes to `sdk/server-types/src/index.ts` are immediately available
|
|
80
|
-
- Run `pnpm build` in `sdk/server-types/` to update `dist/`
|
|
81
|
-
- No need to publish during development
|
|
82
|
-
|
|
83
|
-
## Publishing
|
|
84
|
-
|
|
85
|
-
```bash
|
|
86
|
-
cd sdk/server-types
|
|
87
|
-
pnpm build # Compile TypeScript
|
|
88
|
-
pnpm version <patch|minor|major>
|
|
89
|
-
pnpm publish --access public
|
|
90
|
-
```
|
|
32
|
+
Visit [edgespark.dev](https://edgespark.dev) to get started.
|
package/dist/index.d.ts
CHANGED
|
@@ -51,9 +51,9 @@ export interface User {
|
|
|
51
51
|
* Authentication client - framework enforces auth based on path conventions
|
|
52
52
|
*
|
|
53
53
|
* Path conventions:
|
|
54
|
-
* - /api/* →
|
|
55
|
-
* - /api/public/* →
|
|
56
|
-
* - /api/webhooks/* → No auth,
|
|
54
|
+
* - /api/* → Login required, auth.user guaranteed
|
|
55
|
+
* - /api/public/* → Login optional, auth.user if logged in (else null)
|
|
56
|
+
* - /api/webhooks/* → No auth check, handle verification yourself
|
|
57
57
|
*
|
|
58
58
|
* @example
|
|
59
59
|
* // On /api/* routes, user is guaranteed
|
|
@@ -70,7 +70,7 @@ export interface User {
|
|
|
70
70
|
* });
|
|
71
71
|
*/
|
|
72
72
|
export interface AuthClient {
|
|
73
|
-
/** Current user (immutable for request). Guaranteed on /api/*,
|
|
73
|
+
/** Current user (immutable for request). Guaranteed on /api/*, available if logged in on /api/public/*, null on /api/webhooks/* */
|
|
74
74
|
readonly user: User | null;
|
|
75
75
|
/** Returns true if user is authenticated */
|
|
76
76
|
isAuthenticated(): boolean;
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAMxD;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,MAAM,CACrB,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;IAE/D,iCAAiC;IACjC,EAAE,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAE/B,4BAA4B;IAC5B,IAAI,EAAE,UAAU,CAAC;IAEjB,0BAA0B;IAC1B,OAAO,EAAE,aAAa,CAAC;IAEvB,iCAAiC;IACjC,MAAM,EAAE,YAAY,CAAC;CACtB;AAMD;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,wCAAwC;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,8DAA8D;IAC9D,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,sDAAsD;IACtD,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,iBAAiB;IACjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,gCAAgC;IAChC,aAAa,EAAE,OAAO,CAAC;IACvB,wDAAwD;IACxD,WAAW,EAAE,OAAO,CAAC;IACrB,iCAAiC;IACjC,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,UAAU;IACzB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAMxD;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,MAAM,CACrB,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC;IAE/D,iCAAiC;IACjC,EAAE,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAE/B,4BAA4B;IAC5B,IAAI,EAAE,UAAU,CAAC;IAEjB,0BAA0B;IAC1B,OAAO,EAAE,aAAa,CAAC;IAEvB,iCAAiC;IACjC,MAAM,EAAE,YAAY,CAAC;CACtB;AAMD;;;GAGG;AACH,MAAM,WAAW,IAAI;IACnB,wCAAwC;IACxC,EAAE,EAAE,MAAM,CAAC;IACX,8DAA8D;IAC9D,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,sDAAsD;IACtD,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,iBAAiB;IACjB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,gCAAgC;IAChC,aAAa,EAAE,OAAO,CAAC;IACvB,wDAAwD;IACxD,WAAW,EAAE,OAAO,CAAC;IACrB,iCAAiC;IACjC,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,WAAW,UAAU;IACzB,mIAAmI;IACnI,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAC3B,4CAA4C;IAC5C,eAAe,IAAI,OAAO,CAAC;CAC5B;AAMD,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;CAClC;AAMD,wCAAwC;AACxC,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAAC;IAE/C;;;OAGG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG;QAAE,MAAM,EAAE,SAAS,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAE1D;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,SAAS,GAAG,YAAY,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,WAAW,kBAAkB;IACjC,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2FAA2F;IAC3F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,oFAAoF;IACpF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,YAAY;IAC3B;;;;;;OAMG;IACH,GAAG,CACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,WAAW,EACjB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAEjC;;;;;;;;;OASG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC;IAEjD;;;;;;;;;OASG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAC;IAE1D;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE/D;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAEhE;;;;;;;OAOG;IACH,qBAAqB,CACnB,IAAI,EAAE,MAAM,EACZ,aAAa,CAAC,EAAE,MAAM,EACtB,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;IAEjE;;;;;;;OAOG;IACH,qBAAqB,CACnB,IAAI,EAAE,MAAM,EACZ,aAAa,CAAC,EAAE,MAAM,GACrB,OAAO,CAAC;QAAE,WAAW,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;CACpE;AAMD,MAAM,WAAW,mBAAmB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,mBAAmB,CAAC;CACnC;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,QAAQ,EAAE,qBAAqB,CAAC;CACjC;AAED,sDAAsD;AACtD,MAAM,WAAW,eAAe;IAC9B,gEAAgE;IAChE,GAAG,EAAE,MAAM,CAAC;IACZ,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,uBAAuB;IACvB,QAAQ,EAAE,IAAI,CAAC;CAChB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,iBAAiB;IAChC,+CAA+C;IAC/C,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,oEAAoE;IACpE,OAAO,EAAE,OAAO,CAAC;IACjB,wGAAwG;IACxG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,wGAAwG;IACxG,iBAAiB,EAAE,MAAM,EAAE,CAAC;CAC7B"}
|