@magentrix-corp/magentrix-sdk 1.0.9 → 1.1.0

package/README.md

@@ -24,11 +24,11 @@ npm install @magentrix-corp/magentrix-sdk
 ### JavaScript/TypeScript
 
 ```typescript
-import { MagentrixClient } from '@magentrix-corp/magentrix-sdk'
+import { MagentrixClient, type MagentrixConfig } from '@magentrix-corp/magentrix-sdk'
 
-const client = new MagentrixClient({
-  baseUrl: 'https://your-instance.magentrix.com',
-  refreshToken: 'your-refresh-token',
+const config: MagentrixConfig = {
+  baseUrl: 'https://dev.magentrix.com',
+  refreshToken: '<your-refresh-token>',
   isDevMode: true, // Use token-based auth
   onSessionExpired: async () => {
     console.log('Session expired!')
@@ -36,7 +36,9 @@ const client = new MagentrixClient({
   onError: (error) => {
     console.error('API Error:', error)
   }
-})
+}
+
+const client = new MagentrixClient(config)
 
 // Create a session
 const session = await client.createSession()
@@ -54,31 +56,34 @@ console.log(record)
 ### Vue 3
 
 ```vue
-<script setup>
+<script setup lang="ts">
 import { ref, onMounted } from 'vue'
+import { type MagentrixConfig } from '@magentrix-corp/magentrix-sdk'
 import { useMagentrixSdk } from '@magentrix-corp/magentrix-sdk/vue'
 
-const client = useMagentrixSdk({
-  baseUrl: 'https://your-instance.magentrix.com',
-  refreshToken: 'your-refresh-token',
+const config: MagentrixConfig = {
+  baseUrl: 'https://dev.magentrix.com',
+  refreshToken: '<your-refresh-token>',
   isDevMode: true,
-  onError: (error) => {
+  onError: (error: any) => {
     console.error('API Error:', error)
   }
-})
+}
 
-const account = ref(null)
+const client = useMagentrixSdk().getInstance(config)
+const account = ref<any>(null)
 
 onMounted(async () => {
   await client.createSession()
-  account.value = await client.retrieve('account-id-123')
+  account.value = (await client.retrieve('006000000LJIxF70000')).record
+  console.log(account.value)
 })
 </script>
 
 <template>
   <div v-if="account">
     <h1>{{ account.Name }}</h1>
-    <p>ID: {{ account.Id }}</p>
+    <p>{{ account.Email }}</p>
   </div>
 </template>
 ```
@@ -110,11 +115,15 @@ The SDK supports two authentication modes controlled by the `isDevMode` flag:
 - Requires `refreshToken` in configuration
 
 ```typescript
-const client = new MagentrixClient({
-  baseUrl: 'https://your-instance.magentrix.com',
-  refreshToken: 'your-refresh-token',
+import { MagentrixClient, type MagentrixConfig } from '@magentrix-corp/magentrix-sdk'
+
+const config: MagentrixConfig = {
+  baseUrl: 'https://dev.magentrix.com',
+  refreshToken: '<your-refresh-token>',
   isDevMode: true
-})
+}
+
+const client = new MagentrixClient(config)
 ```
 
 ### Production Mode (`isDevMode: false` or not set)
@@ -129,10 +138,14 @@ const client = new MagentrixClient({
 - No `refreshToken` required
 
 ```typescript
-const client = new MagentrixClient({
+import { MagentrixClient, type MagentrixConfig } from '@magentrix-corp/magentrix-sdk'
+
+const config: MagentrixConfig = {
   baseUrl: 'https://your-instance.magentrix.com',
   isDevMode: false // or omit this property
-})
+}
+
+const client = new MagentrixClient(config)
 ```
 
 ## API Reference
@@ -491,19 +504,21 @@ const recentRecords = await client.query(
 The SDK provides a dedicated Vue 3 composable:
 
 ```vue
-<script setup>
+<script setup lang="ts">
 import { ref, onMounted } from 'vue'
+import { type MagentrixConfig } from '@magentrix-corp/magentrix-sdk'
 import { useMagentrixSdk } from '@magentrix-corp/magentrix-sdk/vue'
 
-const client = useMagentrixSdk({
-  baseUrl: 'https://your-instance.magentrix.com',
-  refreshToken: 'your-refresh-token',
+const config: MagentrixConfig = {
+  baseUrl: 'https://dev.magentrix.com',
+  refreshToken: '<your-refresh-token>',
   isDevMode: true
-})
+}
 
-const accounts = ref([])
+const client = useMagentrixSdk().getInstance(config)
+const accounts = ref<any[]>([])
 const loading = ref(false)
-const error = ref(null)
+const error = ref<string | null>(null)
 
 const loadAccounts = async () => {
   loading.value = true
@@ -513,7 +528,7 @@ const loadAccounts = async () => {
     await client.createSession()
     const results = await client.query('SELECT Id, Name FROM Account')
     accounts.value = results
-  } catch (err) {
+  } catch (err: any) {
     error.value = err.message
   } finally {
     loading.value = false
@@ -541,18 +556,22 @@ onMounted(() => {
 ### Reactive CRUD Operations
 
 ```vue
-<script setup>
+<script setup lang="ts">
 import { ref } from 'vue'
+import { type MagentrixConfig } from '@magentrix-corp/magentrix-sdk'
 import { useMagentrixSdk } from '@magentrix-corp/magentrix-sdk/vue'
 
-const client = useMagentrixSdk({
-  baseUrl: 'https://your-instance.magentrix.com',
+const config: MagentrixConfig = {
+  baseUrl: 'https://dev.magentrix.com',
+  refreshToken: '<your-refresh-token>',
   isDevMode: true
-})
+}
+
+const client = useMagentrixSdk().getInstance(config)
 
 const formData = ref({
-  Name: '',
-  Email: '',
+  Name: 'Company Name',
+  Type: 'Customer',
   Status: 'Active'
 })
 
@@ -562,13 +581,13 @@ const createAccount = async () => {
     console.log('Created:', created)
 
     // Reset form
-    formData.value = { Name: '', Email: '', Status: 'Active' }
+    formData.value = { Name: '', Type: '', Status: 'Active' }
   } catch (error) {
     console.error('Failed to create account:', error)
   }
 }
 
-const updateAccount = async (id) => {
+const updateAccount = async (id: string) => {
   try {
     await client.edit('Account', {
       Id: id,
@@ -580,7 +599,7 @@ const updateAccount = async (id) => {
   }
 }
 
-const deleteAccount = async (id) => {
+const deleteAccount = async (id: string) => {
   try {
     await client.delete('Account', id)
     console.log('Deleted successfully')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magentrix-corp/magentrix-sdk",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "description": "TypeScript SDK for Magentrix APIs with dual authentication modes, automatic session management, CRUD operations, and Vue 3 integration",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",