@lumi.new/sdk 0.0.4 → 0.0.5

package/README.md

@@ -22,10 +22,10 @@ First, initialize the Lumi client. You can get your `projectId` from your Lumi p
 ```typescript
 import { createClient } from '@lumi.new/sdk'
 
-const lumi = createClient({
+export const lumi = createClient({
   projectId: 'YOUR_PROJECT_ID',
-  apiBaseUrl: 'https://your-api.lumi.new', // Your Lumi API endpoint
-  authOrigin: 'https://your-auth.lumi.new', // Your Lumi Auth origin
+  apiBaseUrl: 'YOUR_API_BASE_URL',
+  authOrigin: 'YOUR_AUTH_ORIGIN',
 })
 ```
 
@@ -116,6 +116,16 @@ async function getPosts() {
   console.log('Posts:', list)
   console.log('Total records:', total)
 }
+
+// Example Request:
+getPosts();
+
+// Example Response:
+// Posts: [
+//   { id: 'post-id-1', title: 'First Post', content: '...', published: true, createdAt: '...' },
+//   { id: 'post-id-2', title: 'Second Post', content: '...', published: true, createdAt: '...' }
+// ]
+// Total records: 2
 ```
 
 ### Get a Single Record
@@ -127,6 +137,12 @@ async function getPost(id: string) {
   const post = await lumi.entities.Posts.get(id)
   console.log('Post:', post)
 }
+
+// Example Request:
+getPost('your-post-id');
+
+// Example Response:
+// Post: { id: 'post-id-1', title: 'My Post', content: '...', published: true, createdAt: '...' }
 ```
 
 ### Create a Record
@@ -142,6 +158,12 @@ async function createPost(title: string, content: string) {
   })
   console.log('Created post:', newPost)
 }
+
+// Example Request:
+createPost('My Awesome Post', 'This is the content of my new post.');
+
+// Example Response:
+// Created post: { id: 'new-post-id', title: 'My Awesome Post', content: 'This is the content of my new post.', published: false, creator: 'user-id-123', createdAt: '2024-01-16T10:30:00Z', updatedAt: '2024-01-16T10:30:00Z' }
 ```
 
 ### Create Multiple Records
@@ -149,10 +171,23 @@ async function createPost(title: string, content: string) {
 Create multiple records in a single request.
 
 ```typescript
-async function createMultiplePosts(newPostsData) {
+async function createMultiplePosts(newPostsData: any[]) {
   const newPosts = await lumi.entities.Posts.createMany(newPostsData)
   console.log('Created posts:', newPosts)
 }
+
+// Example Request:
+const postsToCreate = [
+  { title: 'First Awesome Post', content: 'Content for the first post.' },
+  { title: 'Second Awesome Post', content: 'Content for the second post.' }
+];
+createMultiplePosts(postsToCreate);
+
+// Example Response:
+// Created posts: [
+//   { id: 'post-1', title: 'Post 1', content: '...', published: false, creator: 'user-id-123', createdAt: '...', updatedAt: '...' },
+//   { id: 'post-2', title: 'Post 2', content: '...', published: false, creator: 'user-id-123', createdAt: '...', updatedAt: '...' }
+// ]
 ```
 
 ### Update a Record
@@ -164,6 +199,12 @@ async function updatePost(id: string, updates: Record<string, any>) {
   const updatedPost = await lumi.entities.Posts.update(id, updates)
   console.log('Updated post:', updatedPost)
 }
+
+// Example Request:
+updatePost('your-post-id', { published: true, title: 'My Updated Post' });
+
+// Example Response:
+// Updated post: { id: 'post-id-1', title: 'My Updated Post', content: '...', published: true, creator: 'user-id-123', createdAt: '...', updatedAt: '...' }
 ```
 
 ### Delete a Record
@@ -175,6 +216,12 @@ async function deletePost(id: string) {
   await lumi.entities.Posts.delete(id)
   console.log('Post deleted.')
 }
+
+// Example Request:
+deletePost('your-post-id');
+
+// The console will output:
+// Post deleted.
 ```
 
 ### Delete Multiple Records
@@ -186,4 +233,10 @@ async function deleteMultiplePosts(ids: string[]) {
   await lumi.entities.Posts.deleteMany(ids)
   console.log('Posts deleted.')
 }
+
+// Example Request:
+deleteMultiplePosts(['post-id-1', 'post-id-2']);
+
+// The console will output:
+// Posts deleted.
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lumi.new/sdk",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "SDK for Lumi.new",
   "sideEffects": false,
   "main": "dist/index.js",