skapi-js 1.8.3 → 2.0.0-rc.1
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/dist/skapi.browser.mjs +6 -6
- package/dist/skapi.browser.mjs.map +1 -1
- package/dist/skapi.cjs +4 -4
- package/dist/skapi.cjs.map +1 -1
- package/dist/skapi.d.mts +27 -2
- package/dist/skapi.d.ts +27 -2
- package/dist/skapi.js +6 -6
- package/dist/skapi.js.map +1 -1
- package/dist/skapi.mjs +4 -4
- package/dist/skapi.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -53,11 +53,11 @@ For vanilla HTML projects, import Skapi in the script tag, and initialize the li
|
|
|
53
53
|
<!DOCTYPE html>
|
|
54
54
|
<script src="https://cdn.jsdelivr.net/npm/skapi-js@latest/dist/skapi.js"></script>
|
|
55
55
|
<script>
|
|
56
|
-
const skapi = new Skapi(
|
|
56
|
+
const skapi = new Skapi("<Project ID>");
|
|
57
57
|
</script>
|
|
58
58
|
```
|
|
59
59
|
|
|
60
|
-
**Be sure to replace `
|
|
60
|
+
**Be sure to replace `"<Project ID>"`, angle brackets included, with your actual project ID**
|
|
61
61
|
|
|
62
62
|
For more information, check out our [documentation](https://docs.skapi.com/introduction/getting-started.html).
|
|
63
63
|
|
|
@@ -74,7 +74,7 @@ Then, import the library into your main JavaScript file.
|
|
|
74
74
|
```javascript
|
|
75
75
|
// main.js
|
|
76
76
|
import { Skapi } from 'skapi-js';
|
|
77
|
-
const skapi = new Skapi(
|
|
77
|
+
const skapi = new Skapi("<Project ID>");
|
|
78
78
|
|
|
79
79
|
// Export the skapi instance, so you can use it in other component files
|
|
80
80
|
export { skapi }
|
|
@@ -86,7 +86,7 @@ export { skapi }
|
|
|
86
86
|
import { Skapi } from 'skapi-js';
|
|
87
87
|
import type { RecordData, DatabaseResponse } from 'skapi-js';
|
|
88
88
|
|
|
89
|
-
const skapi = new Skapi(
|
|
89
|
+
const skapi = new Skapi("<Project ID>");
|
|
90
90
|
let databaseRecords: DatabaseResponse<RecordData>;
|
|
91
91
|
```
|
|
92
92
|
|
|
@@ -96,14 +96,14 @@ To use Skapi in NodeJS, import the library as shown below:
|
|
|
96
96
|
|
|
97
97
|
```javascript
|
|
98
98
|
const { Skapi } = require('skapi-js');
|
|
99
|
-
const skapi = new Skapi(
|
|
99
|
+
const skapi = new Skapi("<Project ID>");
|
|
100
100
|
```
|
|
101
101
|
|
|
102
102
|
### Node.js (ESM)
|
|
103
103
|
|
|
104
104
|
```javascript
|
|
105
105
|
import { Skapi } from 'skapi-js';
|
|
106
|
-
const skapi = new Skapi(
|
|
106
|
+
const skapi = new Skapi("<Project ID>");
|
|
107
107
|
```
|
|
108
108
|
|
|
109
109
|
> **Note:** When running Skapi in Node.js, browser-specific features such as WebSocket, WebRTC, and Notifications are not available.
|
|
@@ -121,7 +121,7 @@ Below is an example of how you can use the `mock()` method in HTML forms.
|
|
|
121
121
|
<!DOCTYPE html>
|
|
122
122
|
<script src="https://cdn.jsdelivr.net/npm/skapi-js@latest/dist/skapi.js"></script>
|
|
123
123
|
<script>
|
|
124
|
-
const skapi = new Skapi(
|
|
124
|
+
const skapi = new Skapi("<Project ID>");
|
|
125
125
|
</script>
|
|
126
126
|
|
|
127
127
|
<form onsubmit='skapi.mock(event).then(ping=>alert(ping.msg))'>
|
|
@@ -153,11 +153,11 @@ In your AI chat website or app (for example, ChatGPT at chat.openai.com or Lovab
|
|
|
153
153
|
|
|
154
154
|
```
|
|
155
155
|
Use the file "SKAPI.md" as a system prompt.
|
|
156
|
-
My Skapi
|
|
156
|
+
My Skapi project ID is: "xxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxx".
|
|
157
157
|
Build me a [describe what you want].
|
|
158
158
|
```
|
|
159
159
|
|
|
160
|
-
Replace the placeholder
|
|
160
|
+
Replace the placeholder project ID with your actual project ID, and customize the last line with what you want to build.
|
|
161
161
|
|
|
162
162
|
### For AI Code Generators (e.g., Claude Code, OpenAI Codex, Gemini CLI)
|
|
163
163
|
|
|
@@ -180,11 +180,11 @@ Examples:
|
|
|
180
180
|
When you invoke your code generator, include a prompt like:
|
|
181
181
|
|
|
182
182
|
```
|
|
183
|
-
My Skapi
|
|
183
|
+
My Skapi project ID is: "xxxxxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxx".
|
|
184
184
|
Build me a [describe what you want].
|
|
185
185
|
```
|
|
186
186
|
|
|
187
|
-
Replace the placeholder
|
|
187
|
+
Replace the placeholder project ID with your actual project ID before you run the command.
|
|
188
188
|
|
|
189
189
|
|
|
190
190
|
#### For more information, check out our [documentation](https://docs.skapi.com).
|