@stardeck-customer-apps/data-store-sdk 0.1.0-preview.6 → 0.1.0
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/SKILL.md +13 -1
- package/package.json +1 -1
package/SKILL.md
CHANGED
|
@@ -1,6 +1,18 @@
|
|
|
1
1
|
# Data Store SDK - AI Agent Skill Guide
|
|
2
2
|
|
|
3
|
-
This guide
|
|
3
|
+
This guide documents the **runtime SDK** that the customer's deployed app uses to read and write data store data at request time. It's for code that runs inside the customer's app — API routes, server actions, edge functions.
|
|
4
|
+
|
|
5
|
+
> **IMPORTANT — agent vs runtime distinction:**
|
|
6
|
+
>
|
|
7
|
+
> If you (the agent) need to create tables, add columns, change column types, or insert/update/delete rows during planning, use your **dedicated data store tools** instead of writing app code that calls this SDK:
|
|
8
|
+
>
|
|
9
|
+
> - `createDataStoreTable`, `addDataStoreColumn`, `renameDataStoreColumn`, `changeDataStoreColumnType`, `deleteDataStoreColumn`, `deleteDataStoreTable` — schema management
|
|
10
|
+
> - `insertDataStoreRow`, `updateDataStoreRow`, `deleteDataStoreRow` — row mutations (use these for seeding data)
|
|
11
|
+
> - `queryDataStore`, `getDataStoreSchema`, `listDataStores` — reads
|
|
12
|
+
>
|
|
13
|
+
> Those tools operate on the same branch the customer's deployed app reads/writes via `DATA_STORE_*_URL`, so they stay in sync.
|
|
14
|
+
>
|
|
15
|
+
> **Only write code that imports `@stardeck-customer-apps/data-store-sdk` when** the customer's app needs to perform data store operations at request time — for example, a CRUD UI, a multi-tenant app that creates per-customer tables on signup, or a background job. Do NOT use the SDK to seed initial data or set up schema during build/planning — use the agent tools above.
|
|
4
16
|
|
|
5
17
|
## Quick Reference
|
|
6
18
|
|
package/package.json
CHANGED