@iankibetsh/vue-streamline 1.0.0 → 1.0.2

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,33 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - run: npm ci
+      # - run: npm test
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/README.md

@@ -5,7 +5,7 @@ Vue library for streamlining laravel backend services with @iankibet/streamline
 ## Installation
 
 ```sh
-npm install @iankibet/vue-streamline
+npm install @iankibetsh/vue-streamline
 ```
 
 ## Usage
@@ -18,9 +18,33 @@ import {streamline} from '@iankibetsh/vue-streamline'
 
 ```js
 Vue.use(streamline, {
-    ustreamlineHeaders: {
+    streamlineHeaders: {
         // Add any headers you want to send with the request
     },
     streamlineUrl: 'http://localhost:8000/api/streamline' // The url to the streamline route
 })
-```
+```
+
+
+## usage in vue component
+
+```js
+import { useStreamline } from '@iankibet/vue-streamline'
+
+
+const {service:tasksService} = useStreamline('tasks')
+
+// call the service methods
+
+tasksServices.getTasks().then(response => {
+    console.log(response)
+})
+```
+
+
+## Getting url to an action/method in the service
+
+You can get the url to an action/method in the service by calling the getActionUrl method on the service object passing the action name and any parameters
+```js
+ tasksService.getActionUrl('getTasks', {page: 1})
+ ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iankibetsh/vue-streamline",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Vue library for streamlining laravel backend services with @iankibet/streamline composer package",
   "type": "module",
   "scripts": {

package/src/App.vue

@@ -1,9 +1,24 @@
 <script setup>
+import useStreamline from './composables/useStreamline.js'
+
+const {service:paybillService} = useStreamline('mpesa/paybill')
+
+const tryDelete = (id)=>{
+  paybillService.deletePaybill(id).then(res=>{
+    reload.value++
+    shRepo.showToast('Paybill deleted')
+  }).catch(err=>{
+    console.log(err)
+  })
+
+}
 </script>
 
 <template>
   <div>
-    <h1>Streamline Framework</h1>
+    <h1 @click="tryDelete(1)">Streamline Framework</h1>
+    {{ paybillService.getActionUrl('addPaybill',2,4) }}
+
   </div>
 </template>
 

package/src/composables/useStreamline.js

@@ -19,25 +19,28 @@ const useStreamline = stream => {
                     formData = args[0]
                     return service
                 }
-                const config = {
-                    headers: {
-                        ...streamlineHeaders
-                    }
-                }
                 const axios =  Axios.create({
                     headers: {
-                        ...config.headers
+                        ...streamlineHeaders
                     }
                 })
+
                 window.streamlineAxios = axios
-                return axios.post(streamlineUrl, {
+                const postBody = {
                     action,
                     stream,
                     ...formData,
-                    params: {
-                        ...args
-                    }
-                })
+                }
+                const getUrlMethods = ['getUrl','getFullUrl','getActionUrl']
+                if(getUrlMethods.includes(action)) {
+                   // return string url with postBody as query params
+                    // flatten params object
+                    // params are from args 1, unset the first arg
+                    postBody.params = args.slice(1)
+                     return streamlineUrl + '?' + new URLSearchParams(postBody).toString()
+                }
+                postBody.params = args
+                return axios.post(streamlineUrl, postBody)
             }
         }
     })

package/src/main.js

@@ -1,5 +1,16 @@
 import { createApp } from 'vue'
 import './style.css'
 import App from './App.vue'
+import streamline from './plugins/streamline.js'
 
-createApp(App).mount('#app')
+const streamlineHeaders = {
+    Authorization: 'Bearer '
+}
+const streamlineUrl = 'streamline'
+const app = createApp(App)
+app.use(streamline,{
+    streamlineHeaders,
+    streamlineUrl
+})
+
+app.mount('#app')