Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jak2k/seamless.ts
WIP: A seamless way of creating and using APIs
https://github.com/jak2k/seamless.ts
api api-client api-framework api-server bun bun-powered collaborate communityexchange github hacktoberfest powered-by-bun runs-with-bun student-vscode websocket websocket-client websocket-server
Last synced: 9 days ago
JSON representation
WIP: A seamless way of creating and using APIs
- Host: GitHub
- URL: https://github.com/jak2k/seamless.ts
- Owner: Jak2k
- License: mit
- Created: 2023-09-15T20:06:38.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-09T15:53:27.000Z (12 months ago)
- Last Synced: 2024-10-09T03:41:36.441Z (28 days ago)
- Topics: api, api-client, api-framework, api-server, bun, bun-powered, collaborate, communityexchange, github, hacktoberfest, powered-by-bun, runs-with-bun, student-vscode, websocket, websocket-client, websocket-server
- Language: TypeScript
- Homepage:
- Size: 25.4 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# seamless.ts
To install dependencies:
```bash
bun install
```
To run:
```bash
bun run dev
```
To build:
```bash
bun run build
```
To execute after build:
```bash
./dist/server
```
## Goal
Provide a seamless way of creating APIs. The goal is to have an API that don't even notice.
## Roadmap
- [x] Create a server that can be used to create APIs
- [x] Create a client that can be used to access the API
- [ ] Support for nested objects
- [x] Support for arrays
- [x] Support for functions
- [ ] Advanced array queries
- [ ] Advanced authentication
- [ ] Advanced authorization
- [ ] DB integration
## How it works
The server, which is written with Bun, provides a WebSocket and a REST API.
The client can subscribe to remote objects and get notified when they change.
For easier use, the client outputs a proxy object that can be used to access the remote objects as if they were local.
Nested objects aren't watched, instead, you have to replace the whole object, if you want to change a nested property.
## Usage
```ts
// server
import { bundleClient } from "./bundle";
import { createServer, createModel } from "./lib";
const config = {
message: "Hello World!",
counter: 0,
isAwesome: true,
increment() {
this.counter++;
},
};
const configModel = createModel(config, (req, auth) => {
if (auth.getBearerPassword() === "123") {
return {
write: true,
read: true,
};
}
return {
write: false,
read: true,
};
});
const bundle = await bundleClient();
const clientCode = await bundle.outputs[0].text();
const server = createServer({
models: {
config: configModel,
},
bundle: clientCode,
});
server.listen(3000);
```
```ts
// client
const client = await import("http://localhost:3000/client.js");
const ws = new WebSocket("ws://localhost:3000/ws");
const manager = new client.RemoteObjectManager(ws, "123");
await new Promise((resolve) => setTimeout(resolve, 1000));
const config = await manager.subscribe("config");
config.message; // -> "Hello World!"
config.counter; // -> 0
config.counter = 1;
config.counter; // -> 1
```