edmaxlabs-core 1.3.4 → 1.3.5
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 +36 -53
- package/dist/index.cjs +1506 -785
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +257 -87
- package/dist/index.d.ts +257 -87
- package/dist/index.mjs +1506 -785
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,35 +1,18 @@
|
|
|
1
|
-
|
|
1
|
+
## What is edmaxlabs-core?
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`edmaxlabs-core` is designed to be used directly inside your applications (React, vanilla JavaScript, Node.js, and more).
|
|
4
4
|
|
|
5
|
-
It
|
|
6
|
-
|
|
7
|
-
🌐 Learn more at **[https://edmaxlabs.com](https://edmaxlabs.com)**
|
|
5
|
+
It acts as the bridge between your app and EdmaxLabs infrastructure, handling communication, real-time updates, and secure data access.
|
|
8
6
|
|
|
9
7
|
---
|
|
10
8
|
|
|
11
|
-
##
|
|
12
|
-
|
|
13
|
-
`edmaxlabs-core` is designed to be used **inside your applications** (React, vanilla JavaScript, Node.js, and more).
|
|
14
|
-
It acts as the bridge between your app and EdmaxLabs infrastructure, handling communication, real-time updates, and security-aware access patterns.
|
|
15
|
-
|
|
16
|
-
This package focuses on:
|
|
9
|
+
## Features
|
|
17
10
|
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
---
|
|
24
|
-
|
|
25
|
-
## 🚀 Features
|
|
26
|
-
|
|
27
|
-
- 🔐 **Authentication** – Secure user sign-in and session handling
|
|
28
|
-
- 🗄️ **Database** – Read and write structured data with real-time capabilities
|
|
29
|
-
- 📦 **Storage** – Upload, download, and manage files
|
|
30
|
-
- ⚡ **Cloud Functions** – Call server-side logic from your app
|
|
31
|
-
- 🔄 **Realtime** – Subscribe to live data updates
|
|
32
|
-
- 🧩 **Framework-agnostic** – Works with React, plain HTML/JS, Node.js, and more
|
|
11
|
+
* Authentication
|
|
12
|
+
* Database (with realtime support)
|
|
13
|
+
* Cloud Storage
|
|
14
|
+
* Cloud Functions
|
|
15
|
+
* Framework-agnostic (React, Node.js, plain JS)
|
|
33
16
|
|
|
34
17
|
---
|
|
35
18
|
|
|
@@ -41,59 +24,59 @@ npm install edmaxlabs-core
|
|
|
41
24
|
|
|
42
25
|
---
|
|
43
26
|
|
|
44
|
-
## 🧠 Example
|
|
27
|
+
## 🧠 Quick Example
|
|
45
28
|
|
|
46
29
|
```ts
|
|
47
30
|
import { EdmaxLabs } from "edmaxlabs-core";
|
|
48
31
|
|
|
49
|
-
const
|
|
50
|
-
|
|
51
|
-
|
|
32
|
+
const app = new EdmaxLabs({
|
|
33
|
+
token: "your-token",
|
|
34
|
+
project: "your-project-id",
|
|
35
|
+
persistence: true, // optional (offline support)
|
|
52
36
|
});
|
|
53
37
|
|
|
54
|
-
const data = await
|
|
38
|
+
const data = await app.database.collection("messages").get();
|
|
39
|
+
//const data = await app.database.collection("messages").doc("docid").get();
|
|
40
|
+
//...and more
|
|
55
41
|
console.log(data);
|
|
56
42
|
```
|
|
57
43
|
|
|
58
44
|
---
|
|
59
45
|
|
|
60
|
-
##
|
|
61
|
-
|
|
62
|
-
- Frontend developers (React, Vite, Next.js, HTML)
|
|
63
|
-
- Backend developers (Node.js)
|
|
64
|
-
- Teams building SaaS, dashboards, or real-time apps
|
|
65
|
-
- Anyone using EdmaxLabs services in production apps
|
|
46
|
+
## 📚 Documentation
|
|
66
47
|
|
|
67
|
-
|
|
48
|
+
For full guides, API references, and advanced usage:
|
|
68
49
|
|
|
69
|
-
|
|
50
|
+
- [https://edmaxlabs.com/docs/get-started](https://edmaxlabs.com/docs/get-started)
|
|
51
|
+
- [https://edmaxlabs.com/docs/database](https://edmaxlabs.com/docs/database)
|
|
52
|
+
- [https://edmaxlabs.com/docs/realtime](https://edmaxlabs.com/docs/realtime)
|
|
53
|
+
- [https://edmaxlabs.com/docs/offline](https://edmaxlabs.com/docs/offline)
|
|
70
54
|
|
|
71
|
-
|
|
55
|
+
---
|
|
72
56
|
|
|
73
|
-
|
|
74
|
-
- Access is enforced by **rules and server validation**
|
|
75
|
-
- The client SDK provides **convenience**, not trust
|
|
57
|
+
## Who is this for?
|
|
76
58
|
|
|
77
|
-
|
|
59
|
+
* Frontend developers (React, Vite, Next.js, HTML)
|
|
60
|
+
* Backend developers (Node.js)
|
|
61
|
+
* Teams building real-time apps or SaaS platforms
|
|
78
62
|
|
|
79
63
|
---
|
|
80
64
|
|
|
81
|
-
##
|
|
65
|
+
## Security
|
|
82
66
|
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
67
|
+
* Client tokens are **public**
|
|
68
|
+
* Access is enforced via **rules and server validation**
|
|
69
|
+
* This SDK provides **access**, not authority
|
|
86
70
|
|
|
87
71
|
---
|
|
88
72
|
|
|
89
|
-
##
|
|
73
|
+
## Ecosystem
|
|
90
74
|
|
|
91
|
-
|
|
75
|
+
* **edmaxlabs-tools** → CLI for managing projects, hosting, and rules
|
|
76
|
+
* **edmaxlabs-core** → Runtime SDK for applications
|
|
92
77
|
|
|
93
78
|
---
|
|
94
79
|
|
|
95
80
|
## 🧠 Vision
|
|
96
81
|
|
|
97
|
-
> Build once. Scale everywhere.
|
|
98
|
-
|
|
99
|
-
`edmaxlabs-core` is built to power applications today — and grow with you tomorrow.
|
|
82
|
+
> Build once. Scale everywhere.
|