@magentrix-corp/magentrix-sdk 1.0.0 → 1.0.1

package/README.md

@@ -1,50 +1,236 @@
-Magentrix SDK for Javascript.
+# Magentrix SDK for JavaScript
 
-Javascript:
+A standalone, framework-agnostic TypeScript library that provides a clean interface for interacting with the Magentrix REST API v3.
 
+[![npm version](https://img.shields.io/npm/v/magentrix-sdk.svg)](https://www.npmjs.com/package/magentrix-sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Features
+
+### Core Functionality
+
+- ✅ **Full REST API v3 support** - Complete coverage of Magentrix REST API endpoints
+- ✅ **CRUD operations** - Create, Read, Update, Delete operations made simple
+- ✅ **Query execution** - Execute queries using IRIS query language
+- ✅ **Custom MVC actions** - Execute custom MVC actions seamlessly
+- ✅ **Session management** - Built-in authentication and session handling
+- ✅ **Automatic token refresh** - Handles token refresh automatically
+- ✅ **IRIS data extensions** - Support for metadata and permissions
+
+### Developer Experience
+
+- ✅ **TypeScript-first** - Full type definitions for enhanced IDE support
+- ✅ **Promise-based API** - Modern async/await syntax
+- ✅ **Vue.js 3 plugin** - Seamless integration with Vue.js applications
+- ✅ **Composable pattern** - Vue composables for reactive data management
+- ✅ **Comprehensive error handling** - Robust error handling with custom callbacks
+- ✅ **Zero external dependencies** - Only uses native Fetch API
+
+### Package Quality
+
+- ✅ **Modern build system** - Built with Rollup for optimal bundling
+- ✅ **Multiple module formats** - CommonJS and ES Module outputs
+- ✅ **Tree-shakeable** - Import only what you need
+- ✅ **Source maps included** - Easy debugging in development
+- ✅ **Full documentation** - Complete examples and API reference
+
+## Installation
+
+```bash
+npm install magentrix-sdk
+```
+
+or
+
+```bash
+yarn add magentrix-sdk
+```
+
+or
+
+```bash
+pnpm add magentrix-sdk
+```
+
+## Quick Start
+
+### Vanilla JavaScript/TypeScript
+
+```javascript
 import { MagentrixClient } from 'magentrix-sdk'
 
 const client = new MagentrixClient({
-  baseUrl: 'https://xyz.com',
+  baseUrl: '{your-portal-domain}',
   token: '',
-  refreshToken: 'xyz',
+  refreshToken: '{refresh-token}',
   antiForgeryToken: '',
-  onSessionExpired: () => Promise<void> | void
-  onError?: (error: any) => void
+  onSessionExpired: () => {
+    // Handle session expiration
+    console.log('Session expired, redirecting to login...')
+  },
+  onError: (error) => {
+    // Handle errors globally
+    console.error('API Error:', error)
+  }
 })
 
-client.createSession().then(si => {
-  console.log(si.token)
-  client.retrieve('xyz').then(r => console.log(r))
-})
+// Create a session and retrieve data
+async function fetchData() {
+  const sessionInfo = await client.createSession()
+  console.log('Session Token:', sessionInfo.token)
+
+  const data = await client.retrieve('xyz')
+  console.log('Retrieved Data:', data)
+}
 
+fetchData()
+```
 
-VUE JS:
+### Vue.js 3
 
+```vue
 <script setup>
-import { onMounted } from 'vue'
-import { MagentrixClient } from 'magentrix-sdk/vue'
+import { ref, onMounted } from 'vue'
+import { useMagentrixSdk } from 'magentrix-sdk/vue'
 
 const client = useMagentrixSdk({
-  baseUrl: 'https://xyz.com',
+  baseUrl: 'https://your-portal.magentrix.com',
   token: '',
-  refreshToken: 'xyz',
+  refreshToken: 'your-refresh-token',
   antiForgeryToken: '',
-  onSessionExpired: () => Promise<void> | void
-  onError?: (error: any) => void
+  onSessionExpired: () => {
+    // Handle session expiration
+    console.log('Session expired')
+  },
+  onError: (error) => {
+    // Handle errors
+    console.error('Error:', error)
+  }
 })
 
 const model = ref()
 
 onMounted(async () => {
-  const si = await client.createSession()
-  console.log(si.token)
-  const r = await client.retrieve('xyz')
-  console.log(r)
-  model.value = r
+  const sessionInfo = await client.createSession()
+  console.log('Session Token:', sessionInfo.token)
+
+  const data = await client.retrieve('xyz')
+  console.log('Retrieved Data:', data)
+  model.value = data
 })
 </script>
 
 <template>
-  <p>{{ model.Id }}</p>
-</template>
+  <div>
+    <p v-if="model">{{ model.Id }}</p>
+  </div>
+</template>
+```
+
+## API Reference
+
+### Configuration Options
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `baseUrl` | `string` | Yes | Your Magentrix portal domain |
+| `token` | `string` | No | Initial authentication token |
+| `refreshToken` | `string` | No | Token used for refreshing sessions |
+| `antiForgeryToken` | `string` | No | Anti-forgery token for security |
+| `onSessionExpired` | `() => Promise<void> \| void` | No | Callback when session expires |
+| `onError` | `(error: any) => void` | No | Global error handler |
+
+### Core Methods
+
+#### `createSession()`
+Creates a new session and returns session information.
+
+```javascript
+const sessionInfo = await client.createSession()
+console.log(sessionInfo.token)
+```
+
+#### `retrieve(id: string)`
+Retrieves a record by ID.
+
+```javascript
+const record = await client.retrieve('record-id')
+```
+
+#### `execute(action: string, params?: object)`
+Executes a custom MVC action.
+
+```javascript
+const result = await client.execute('customAction', { param1: 'value' })
+```
+
+## Examples
+
+### CRUD Operations
+
+```javascript
+// Create
+const newRecord = await client.create({
+  Name: 'New Record',
+  Description: 'Record description'
+})
+
+// Read
+const record = await client.retrieve('record-id')
+
+// Update
+const updated = await client.update('record-id', {
+  Name: 'Updated Name'
+})
+
+// Delete
+await client.delete('record-id')
+```
+
+### Query Execution
+
+```javascript
+const results = await client.query({
+  entity: 'Account',
+  filter: 'Status eq "Active"',
+  select: ['Id', 'Name', 'Email']
+})
+```
+
+## TypeScript Support
+
+The SDK is written in TypeScript and provides full type definitions out of the box:
+
+```typescript
+import { MagentrixClient, SessionInfo } from 'magentrix-sdk'
+
+const client: MagentrixClient = new MagentrixClient({
+  baseUrl: 'https://your-portal.magentrix.com',
+  refreshToken: 'your-token'
+})
+
+const sessionInfo: SessionInfo = await client.createSession()
+```
+
+## Browser Support
+
+The SDK uses the native Fetch API and supports all modern browsers:
+
+- Chrome (latest)
+- Firefox (latest)
+- Safari (latest)
+- Edge (latest)
+
+For older browsers, you may need to include a fetch polyfill.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT
+
+## Support
+
+For issues, questions, or contributions, please visit the [GitHub repository](https://github.com/your-org/magentrix-sdk).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magentrix-corp/magentrix-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",