locator-ars-lib 1.0.0 → 1.0.3

package/dist/locator-ars-lib.es.js

@@ -1,6 +1,6 @@
 var h = Object.defineProperty;
 var y = (e, s, n) => s in e ? h(e, s, { enumerable: !0, configurable: !0, writable: !0, value: n }) : e[s] = n;
-var o = (e, s, n) => (y(e, typeof s != "symbol" ? s + "" : s, n), n);
+var o = (e, s, n) => y(e, typeof s != "symbol" ? s + "" : s, n);
 import { inject as v, ref as l, computed as m, watch as _, onUnmounted as g, defineComponent as k, toRefs as w, renderSlot as u } from "vue";
 import P from "axios";
 class S {

package/dist/locator-ars-lib.umd.js

@@ -1 +1 @@
-(function(n,i){typeof exports=="object"&&typeof module<"u"?i(exports,require("vue"),require("axios")):typeof define=="function"&&define.amd?define(["exports","vue","axios"],i):(n=typeof globalThis<"u"?globalThis:n||self,i(n.LocatorArsLib={},n.Vue,n.axios))})(this,function(n,i,t){"use strict";var $=Object.defineProperty;var L=(n,i,t)=>i in n?$(n,i,{enumerable:!0,configurable:!0,writable:!0,value:t}):n[i]=t;var u=(n,i,t)=>(L(n,typeof i!="symbol"?i+"":i,t),t);class P{constructor(s){u(this,"axios");u(this,"cache",new Map);u(this,"endpoint");this.axios=t.create({baseURL:(s==null?void 0:s.baseUrl)||""}),this.endpoint=(s==null?void 0:s.endpoint)||"/api/v1/dashboard/access"}async can(s){if(this.cache.has(s))return this.cache.get(s);try{const a=(await this.axios.get(this.endpoint,{params:{action:s}})).data.allowed||!1;return this.cache.set(s,a),a}catch(r){return console.error(`Error checking permission for ${s}:`,r),!1}}clearCache(s){s?this.cache.delete(s):this.cache.clear()}}const p=Symbol("Permissions");function m(e){return new P(e)}const S={install(e,s){const r=m(s);e.provide(p,r)}};function d(){const e=i.inject(p);if(!e)throw new Error("Permissions plugin not installed!");return e}function h(e,s={}){const r=d(),a=i.ref(null),o=i.ref(!1),l=i.ref(null),_=i.computed(()=>typeof e=="string"?e:e.value),f=async()=>{if(_.value){o.value=!0,l.value=null;try{a.value=await r.can(_.value)}catch(c){l.value=c instanceof Error?c:new Error(String(c)),a.value=!1}finally{o.value=!1}}};if(s.autoCheck!==!1&&f(),typeof e!="string"){const c=i.watch(e,()=>{f()});i.onUnmounted(()=>{c()})}return{isAllowed:a,isLoading:o,error:l,check:f,can:i.computed(()=>a.value===!0)}}const g=i.defineComponent({name:"Check",props:{action:{type:String,required:!0},fallback:{type:Boolean,default:!1}},setup(e){const{action:s}=i.toRefs(e),{can:r,isLoading:a}=h(s,{autoCheck:!0});return{can:r,isLoading:a}}}),k=(e,s)=>{const r=e.__vccOpts||e;for(const[a,o]of s)r[a]=o;return r};function w(e,s,r,a,o,l){return e.can?i.renderSlot(e.$slots,"default",{key:0}):e.isLoading?i.renderSlot(e.$slots,"loading",{key:2}):i.renderSlot(e.$slots,"fallback",{key:1})}const y=k(g,[["render",w]]),v={async mounted(e,s){const r=e.style.display;e._permission_data={action:s.value,originalDisplay:r},await d().can(s.value)||(e.style.display="none")},async updated(e,s){(!e._permission_data||e._permission_data.action!==s.value)&&(e._permission_data={action:s.value,originalDisplay:e.style.display||""},await d().can(s.value)?e.style.display=e._permission_data.originalDisplay:e.style.display="none")},unmounted(e){e._permission_data&&(e.style.display=e._permission_data.originalDisplay,delete e._permission_data)}},C={install(e,s){e.use(S,s),e.component("Check",y),e.directive("can",v)}};n.Check=y,n.default=C,n.setupPermissions=m,n.usePermissions=h,n.vCan=v,Object.defineProperties(n,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});
+(function(n,i){typeof exports=="object"&&typeof module<"u"?i(exports,require("vue"),require("axios")):typeof define=="function"&&define.amd?define(["exports","vue","axios"],i):(n=typeof globalThis<"u"?globalThis:n||self,i(n.LocatorArsLib={},n.Vue,n.axios))})(this,function(n,i,o){"use strict";var $=Object.defineProperty;var L=(n,i,o)=>i in n?$(n,i,{enumerable:!0,configurable:!0,writable:!0,value:o}):n[i]=o;var u=(n,i,o)=>L(n,typeof i!="symbol"?i+"":i,o);class P{constructor(s){u(this,"axios");u(this,"cache",new Map);u(this,"endpoint");this.axios=o.create({baseURL:(s==null?void 0:s.baseUrl)||""}),this.endpoint=(s==null?void 0:s.endpoint)||"/api/v1/dashboard/access"}async can(s){if(this.cache.has(s))return this.cache.get(s);try{const a=(await this.axios.get(this.endpoint,{params:{action:s}})).data.allowed||!1;return this.cache.set(s,a),a}catch(r){return console.error(`Error checking permission for ${s}:`,r),!1}}clearCache(s){s?this.cache.delete(s):this.cache.clear()}}const p=Symbol("Permissions");function m(e){return new P(e)}const S={install(e,s){const r=m(s);e.provide(p,r)}};function d(){const e=i.inject(p);if(!e)throw new Error("Permissions plugin not installed!");return e}function h(e,s={}){const r=d(),a=i.ref(null),t=i.ref(!1),l=i.ref(null),_=i.computed(()=>typeof e=="string"?e:e.value),f=async()=>{if(_.value){t.value=!0,l.value=null;try{a.value=await r.can(_.value)}catch(c){l.value=c instanceof Error?c:new Error(String(c)),a.value=!1}finally{t.value=!1}}};if(s.autoCheck!==!1&&f(),typeof e!="string"){const c=i.watch(e,()=>{f()});i.onUnmounted(()=>{c()})}return{isAllowed:a,isLoading:t,error:l,check:f,can:i.computed(()=>a.value===!0)}}const g=i.defineComponent({name:"Check",props:{action:{type:String,required:!0},fallback:{type:Boolean,default:!1}},setup(e){const{action:s}=i.toRefs(e),{can:r,isLoading:a}=h(s,{autoCheck:!0});return{can:r,isLoading:a}}}),k=(e,s)=>{const r=e.__vccOpts||e;for(const[a,t]of s)r[a]=t;return r};function w(e,s,r,a,t,l){return e.can?i.renderSlot(e.$slots,"default",{key:0}):e.isLoading?i.renderSlot(e.$slots,"loading",{key:2}):i.renderSlot(e.$slots,"fallback",{key:1})}const y=k(g,[["render",w]]),v={async mounted(e,s){const r=e.style.display;e._permission_data={action:s.value,originalDisplay:r},await d().can(s.value)||(e.style.display="none")},async updated(e,s){(!e._permission_data||e._permission_data.action!==s.value)&&(e._permission_data={action:s.value,originalDisplay:e.style.display||""},await d().can(s.value)?e.style.display=e._permission_data.originalDisplay:e.style.display="none")},unmounted(e){e._permission_data&&(e.style.display=e._permission_data.originalDisplay,delete e._permission_data)}},C={install(e,s){e.use(S,s),e.component("Check",y),e.directive("can",v)}};n.Check=y,n.default=C,n.setupPermissions=m,n.usePermissions=h,n.vCan=v,Object.defineProperties(n,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}})});

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "locator-ars-lib",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "Permissions library for Vue 3 applications",
   "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "types": "types/index.d.ts",
   "scripts": {
     "build": "vue-tsc && vite build",
     "test": "vitest run",
@@ -18,17 +18,16 @@
   "author": "badkiko",
   "license": "MIT",
   "peerDependencies": {
-    "axios": "^0.27.0",
-    "vue": "^3.0.0"
+    "vue": "^3.0.0 || ^3.5.0",
+    "axios": "^1.7.9"
   },
   "devDependencies": {
-    "@types/node": "^18.19.100",
-    "@vitejs/plugin-vue": "^4.0.0",
-    "@vue/runtime-core": "^3.5.13",
-    "axios": "^0.27.2",
-    "typescript": "^4.9.3",
-    "vite": "^4.0.0",
-    "vue": "^3.2.45",
-    "vue-tsc": "^1.0.9"
+    "@types/node": "^22.10.5",
+    "@vitejs/plugin-vue": "^5.2.1",
+    "typescript": "~5.6.2",
+    "vite": "^6.0.5",
+    "vue-tsc": "^2.2.0",
+    "axios": "^1.7.9",
+    "vue": "^3.5.13"
   }
 }

package/tsconfig.json

@@ -5,6 +5,7 @@
     "module": "ESNext",
     "lib": ["ES2020", "DOM", "DOM.Iterable"],
     "skipLibCheck": true,
+    "typeRoots": ["./node_modules/@types", "./types"],
 
     /* Bundler mode */
     "moduleResolution": "node",

package/types/index.d.ts

@@ -0,0 +1,42 @@
+import { App, Component, Ref, ComputedRef, ObjectDirective } from 'vue'
+
+export interface PermissionsOptions {
+    baseUrl?: string
+    endpoint?: string
+}
+
+export interface UsePermissionsOptions {
+    autoCheck?: boolean
+}
+
+export interface UsePermissionsResult {
+    isAllowed: Ref<boolean | null>
+    isLoading: Ref<boolean>
+    error: Ref<Error | null>
+    check: () => Promise<void>
+    can: ComputedRef<boolean>
+}
+
+export class PermissionsService {
+    constructor(options?: PermissionsOptions)
+    can(action: string): Promise<boolean>
+    clearCache(action?: string): void
+}
+
+export const Check: Component
+export const vCan: ObjectDirective
+
+export function usePermissions(
+    action: string | Ref<string>,
+    options?: UsePermissionsOptions
+): UsePermissionsResult
+
+export function setupPermissions(
+    options?: PermissionsOptions
+): PermissionsService
+
+declare const _default: {
+    install(app: App, options?: PermissionsOptions): void
+}
+
+export default _default 

package/types/locator-ars-lib.d.ts

@@ -0,0 +1,44 @@
+declare module 'locator-ars-lib' {
+    import { App, Component, Ref, ComputedRef, ObjectDirective } from 'vue'
+
+    export interface PermissionsOptions {
+        baseUrl?: string
+        endpoint?: string
+    }
+
+    export interface UsePermissionsOptions {
+        autoCheck?: boolean
+    }
+
+    export interface UsePermissionsResult {
+        isAllowed: Ref<boolean | null>
+        isLoading: Ref<boolean>
+        error: Ref<Error | null>
+        check: () => Promise<void>
+        can: ComputedRef<boolean>
+    }
+
+    export class PermissionsService {
+        constructor(options?: PermissionsOptions)
+        can(action: string): Promise<boolean>
+        clearCache(action?: string): void
+    }
+
+    export const Check: Component
+    export const vCan: ObjectDirective
+
+    export function usePermissions(
+        action: string | Ref<string>,
+        options?: UsePermissionsOptions
+    ): UsePermissionsResult
+
+    export function setupPermissions(
+        options?: PermissionsOptions
+    ): PermissionsService
+
+    const plugin: {
+        install(app: App, options?: PermissionsOptions): void
+    }
+
+    export default plugin
+}