@ramathibodi/nuxt-commons 0.1.73 → 0.1.75

package/dist/runtime/components/model/label.vue

@@ -1,50 +1,58 @@
-<script lang="ts" setup>
-import { computedAsync } from '@vueuse/core'
-import { useGraphQlOperation } from '../../composables/graphqlOperation'
-import { concat } from "lodash-es";
-import { ref } from 'vue'
-
-interface Props {
-  modelName: string
-  modelBy?: object
-  itemTitle: string | ((result:Record<string,any>)=>void)
-  fields?: Array<string | object>
-  cache?: boolean | number
-
-  notFoundText?: string
-  placeholder?: string
-}
-
-const props = withDefaults(defineProps<Props>(), {
-  cache: false,
-})
-
-const modelItem = ref<Record<string, any>>({})
-
-const modelItemValue = computedAsync<string>(async () => {
-  if (props.modelName && props.itemTitle) {
-    let fields: any[] = (typeof props.itemTitle === "string") ? [props.itemTitle] : []
-    if (props.fields) fields = concat(fields, props.fields)
-
-    const variables: Record<string, any> = Object.assign({},props.modelBy)
-    const result : Record<string, any> = await useGraphQlOperation('Query',props.modelName,fields,variables,props.cache)
-
-    try {
-      if (result) {
-        modelItem.value = result
-        if (typeof props.itemTitle === "string") return result[props.itemTitle]
-        else return props.itemTitle(result)
-      }
-    } catch (e) {
-      console.error(e)
-    }
-  }
-  return props.notFoundText
-}, props.placeholder ?? '' )
-</script>
-
-<template>
-  <slot name="default" :data="modelItem">
-    <span>{{ modelItemValue }}</span>
-  </slot>
-</template>
+<script lang="ts" setup>
+/**
+ * ModelLabel connects model metadata to reusable selection, labeling, iterator, or table UI patterns.
+ * This doc block is consumed by vue-docgen for generated API documentation.
+ */
+import { computedAsync } from '@vueuse/core'
+import { useGraphQlOperation } from '../../composables/graphqlOperation'
+import { concat } from "lodash-es";
+import { ref } from 'vue'
+
+interface Props {
+  modelName: string // GraphQL model name used to resolve lookup/query metadata.
+  modelBy?: object // Key/value filter used to fetch a specific model item.
+  itemTitle: string | ((result:Record<string,any>)=>void) // Field name or mapper function used to build display labels.
+  fields?: Array<string | object> // Field list/query selection used when fetching model or lookup data.
+  cache?: boolean | number // Enables cached requests; number values represent cache TTL in milliseconds.
+
+  notFoundText?: string // Text shown when the resolved value or label is unavailable.
+  placeholder?: string // placeholder text shown when value is empty
+}
+
+/**
+ * Public props accepted by ModelLabel.
+ * Document each prop field with intent, defaults, and side effects for clear generated docs.
+ */
+const props = withDefaults(defineProps<Props>(), {
+  cache: false,
+})
+
+const modelItem = ref<Record<string, any>>({})
+
+const modelItemValue = computedAsync<string>(async () => {
+  if (props.modelName && props.itemTitle) {
+    let fields: any[] = (typeof props.itemTitle === "string") ? [props.itemTitle] : []
+    if (props.fields) fields = concat(fields, props.fields)
+
+    const variables: Record<string, any> = Object.assign({},props.modelBy)
+    const result : Record<string, any> = await useGraphQlOperation('Query',props.modelName,fields,variables,props.cache)
+
+    try {
+      if (result) {
+        modelItem.value = result
+        if (typeof props.itemTitle === "string") return result[props.itemTitle]
+        else return props.itemTitle(result)
+      }
+    } catch (e) {
+      console.error(e)
+    }
+  }
+  return props.notFoundText
+}, props.placeholder ?? '' )
+</script>
+
+<template>
+  <slot name="default" :data="modelItem">
+    <span>{{ modelItemValue }}</span>
+  </slot>
+</template>

package/dist/runtime/components/pdf/Print.vue

@@ -1,63 +1,75 @@
-<script setup lang="ts">
-import printJS from 'print-js'
-import { ref, watch } from 'vue'
-import { useAlert } from '../../composables/alert'
-
-interface Props {
-  base64String?: string
-  fileName?: string
-  print?: boolean
-  title?: string
-  disabled?: boolean
-}
-
-const props = withDefaults(defineProps<Props>(), {
-  print: false,
-  disabled: false,
-})
-const emit = defineEmits(['update:print'])
-
-const isMobile = ref(false)
-const alert = useAlert()
-
-const openPdf = () => {
-  if (/Android|Mobi|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini|Macintosh/i.test(navigator.userAgent)) {
-    isMobile.value = true
-  }
-  else {
-    printJS({
-      printable: props.base64String,
-      type: 'pdf',
-      base64: true,
-      onPrintDialogClose: endLoadPdf,
-      onError: (error: any) => {
-        alert?.addAlert({ message: error, alertType: 'error' })
-      },
-    })
-  }
-}
-
-const endLoadPdf = () => {
-  emit('update:print', false)
-  isMobile.value = false
-}
-
-watch(() => props.print, () => {
-  if (props.print) openPdf()
-})
-</script>
-
-<template>
-  <v-dialog
-    v-model="isMobile"
-    fullscreen
-  >
-    <PdfView
-      :base64-string="props.base64String"
-      :disabled="props.disabled"
-      :title="props.title"
-      :file-name="props.fileName"
-      @close-dialog="endLoadPdf"
-    />
-  </v-dialog>
-</template>
+<script setup lang="ts">
+/**
+ * PdfPrint renders a print-oriented PDF view and handles browser print lifecycle events.
+ * This doc block is consumed by vue-docgen for generated API documentation.
+ */
+import printJS from 'print-js'
+import { ref, watch } from 'vue'
+import { useAlert } from '../../composables/alert'
+
+interface Props {
+  base64String?: string // Base64 document payload used as the PDF source.
+  fileName?: string // File name used when downloading or printing generated files.
+  print?: boolean // When true, starts printing automatically after the PDF is ready.
+  title?: string // Title text displayed in the component header or dialog.
+  disabled?: boolean // disables user interaction for this field
+}
+
+/**
+ * Public props accepted by PdfPrint.
+ * Document each prop field with intent, defaults, and side effects for clear generated docs.
+ */
+const props = withDefaults(defineProps<Props>(), {
+  print: false,
+  disabled: false,
+})
+/**
+ * Custom events emitted by PdfPrint.
+ * Parents can listen to these events to react to user actions and internal state changes.
+ */
+const emit = defineEmits(['update:print'])
+
+const isMobile = ref(false)
+const alert = useAlert()
+
+const openPdf = () => {
+  if (/Android|Mobi|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini|Macintosh/i.test(navigator.userAgent)) {
+    isMobile.value = true
+  }
+  else {
+    printJS({
+      printable: props.base64String,
+      type: 'pdf',
+      base64: true,
+      onPrintDialogClose: endLoadPdf,
+      onError: (error: any) => {
+        alert?.addAlert({ message: error, alertType: 'error' })
+      },
+    })
+  }
+}
+
+const endLoadPdf = () => {
+  emit('update:print', false)
+  isMobile.value = false
+}
+
+watch(() => props.print, () => {
+  if (props.print) openPdf()
+})
+</script>
+
+<template>
+  <v-dialog
+    v-model="isMobile"
+    fullscreen
+  >
+    <PdfView
+      :base64-string="props.base64String"
+      :disabled="props.disabled"
+      :title="props.title"
+      :file-name="props.fileName"
+      @close-dialog="endLoadPdf"
+    />
+  </v-dialog>
+</template>

package/dist/runtime/components/pdf/View.vue

@@ -1,134 +1,146 @@
-<script setup lang="ts">
-import PDF from 'pdf-vue3'
-import { uid } from 'uid'
-import printJS from 'print-js'
-import { ref, computed } from 'vue'
-import { useAlert } from '../../composables/alert'
-
-interface Props extends /* @vue-ignore */ InstanceType<typeof PDF['$props']> {
-  base64String?: string
-  title?: string
-  fileName?: string
-  disabled?: boolean
-  isPrint?: boolean
-  showBackToTopBtn?: boolean
-}
-
-const props = withDefaults(defineProps<Props>(), {
-  base64String: '',
-  title: '',
-  fileName: '',
-  disabled: false,
-  isPrint: false,
-  showBackToTopBtn: false,
-})
-
-const emit = defineEmits(['closeDialog'])
-const base64 = ref(props.base64String)
-const alert = useAlert()
-
-const generateUniqueId = (): string => {
-  const uniqueId: string = uid()
-  return props.fileName ? `${props.fileName}` : uniqueId
-}
-
-const downloadPdf = (): void => {
-  try {
-    if (!props.base64String) alert?.addAlert({ message: 'No Base64 provided', alertType: 'error' })
-
-    const byteString = atob(props.base64String || '')
-    const byteArray = new Uint8Array(byteString.length)
-
-    for (let i = 0; i < byteString.length; i++) {
-      byteArray[i] = byteString.charCodeAt(i)
-    }
-
-    const blob = new Blob([byteArray], { type: 'application/pdf' })
-    const link = URL.createObjectURL(blob)
-    const anchorElement = document.createElement('a')
-    anchorElement.style.display = 'none'
-    anchorElement.href = link
-    anchorElement.download = `${generateUniqueId()}.pdf`
-
-    document.body.appendChild(anchorElement)
-    anchorElement.click()
-    URL.revokeObjectURL(link)
-    document.body.removeChild(anchorElement)
-    base64.value = ''
-
-    alert?.addAlert({ message: 'Download success', alertType: 'success' })
-  }
-  catch (error) {
-    alert?.addAlert({ message: `Download unsuccess : ${error}`, alertType: 'error' })
-  }
-}
-
-const printPdf = () => {
-  printJS({
-    printable: props.base64String,
-    type: 'pdf',
-    base64: true,
-    onPrintDialogClose: endLoadPdf,
-    onError: (error) => {
-      alert?.addAlert({ message: error, alertType: 'error' })
-    },
-  })
-  base64.value = ''
-}
-
-const endLoadPdf = () => {
-  emit('closeDialog', false)
-  base64.value = ''
-}
-
-const isMobile = () => {
-  return /Android|Mobi|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini|Macintosh/i.test(navigator.userAgent)
-}
-
-const checkMobileAndPrint = computed(() => {
-  return !isMobile() && props.isPrint
-})
-
-const setWidthPdf = computed(() => {
-  if (isMobile()) {
-    return '100%'
-  }
-  else {
-    return '100dvh'
-  }
-})
-</script>
-
-<template>
-  <v-card>
-    <v-toolbar density="compact">
-      <v-toolbar-title>{{ props.title }}</v-toolbar-title>
-      <v-spacer />
-      <v-btn
-        v-if="checkMobileAndPrint"
-        icon="mdi mdi-printer"
-        variant="plain"
-        @click="printPdf"
-      />
-      <v-btn
-        v-if="!props.disabled"
-        icon="mdi mdi-download"
-        variant="plain"
-        @click="downloadPdf"
-      />
-      <v-btn
-        icon="mdi mdi-close"
-        variant="plain"
-        @click="endLoadPdf"
-      />
-    </v-toolbar>
-    <v-card-text class="justify-center h-screen">
-      <PDF
-        v-bind="$attrs"
-        :pdf-width="setWidthPdf"
-        :src="base64"
-        :show-back-to-top-btn="props.showBackToTopBtn"
-      />
-    </v-card-text>
-  </v-card>
-</template>
+<script setup lang="ts">
+/**
+ * PdfView displays PDF documents in-app with loading and viewport state management for preview workflows.
+ * This doc block is consumed by vue-docgen for generated API documentation.
+ */
+import PDF from 'pdf-vue3'
+import { uid } from 'uid'
+import printJS from 'print-js'
+import { ref, computed } from 'vue'
+import { useAlert } from '../../composables/alert'
+
+interface Props extends /* @vue-ignore */ InstanceType<typeof PDF['$props']> {
+  base64String?: string // Base64 document payload used as the PDF source.
+  title?: string // Title text displayed in the component header or dialog.
+  fileName?: string // File name used when downloading or printing generated files.
+  disabled?: boolean // disables user interaction for this field
+  isPrint?: boolean // boolean flag controlling runtime behavior
+  showBackToTopBtn?: boolean // Shows a back-to-top button while scrolling long PDF content.
+}
+
+/**
+ * Public props accepted by PdfView.
+ * Document each prop field with intent, defaults, and side effects for clear generated docs.
+ */
+const props = withDefaults(defineProps<Props>(), {
+  base64String: '',
+  title: '',
+  fileName: '',
+  disabled: false,
+  isPrint: false,
+  showBackToTopBtn: false,
+})
+
+/**
+ * Custom events emitted by PdfView.
+ * Parents can listen to these events to react to user actions and internal state changes.
+ */
+const emit = defineEmits(['closeDialog'])
+const base64 = ref(props.base64String)
+const alert = useAlert()
+
+const generateUniqueId = (): string => {
+  const uniqueId: string = uid()
+  return props.fileName ? `${props.fileName}` : uniqueId
+}
+
+const downloadPdf = (): void => {
+  try {
+    if (!props.base64String) alert?.addAlert({ message: 'No Base64 provided', alertType: 'error' })
+
+    const byteString = atob(props.base64String || '')
+    const byteArray = new Uint8Array(byteString.length)
+
+    for (let i = 0; i < byteString.length; i++) {
+      byteArray[i] = byteString.charCodeAt(i)
+    }
+
+    const blob = new Blob([byteArray], { type: 'application/pdf' })
+    const link = URL.createObjectURL(blob)
+    const anchorElement = document.createElement('a')
+    anchorElement.style.display = 'none'
+    anchorElement.href = link
+    anchorElement.download = `${generateUniqueId()}.pdf`
+
+    document.body.appendChild(anchorElement)
+    anchorElement.click()
+    URL.revokeObjectURL(link)
+    document.body.removeChild(anchorElement)
+    base64.value = ''
+
+    alert?.addAlert({ message: 'Download success', alertType: 'success' })
+  }
+  catch (error) {
+    alert?.addAlert({ message: `Download unsuccess : ${error}`, alertType: 'error' })
+  }
+}
+
+const printPdf = () => {
+  printJS({
+    printable: props.base64String,
+    type: 'pdf',
+    base64: true,
+    onPrintDialogClose: endLoadPdf,
+    onError: (error) => {
+      alert?.addAlert({ message: error, alertType: 'error' })
+    },
+  })
+  base64.value = ''
+}
+
+const endLoadPdf = () => {
+  emit('closeDialog', false)
+  base64.value = ''
+}
+
+const isMobile = () => {
+  return /Android|Mobi|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini|Macintosh/i.test(navigator.userAgent)
+}
+
+const checkMobileAndPrint = computed(() => {
+  return !isMobile() && props.isPrint
+})
+
+const setWidthPdf = computed(() => {
+  if (isMobile()) {
+    return '100%'
+  }
+  else {
+    return '100dvh'
+  }
+})
+</script>
+
+<template>
+  <v-card>
+    <v-toolbar density="compact">
+      <v-toolbar-title>{{ props.title }}</v-toolbar-title>
+      <v-spacer />
+      <v-btn
+        v-if="checkMobileAndPrint"
+        icon="mdi mdi-printer"
+        variant="plain"
+        @click="printPdf"
+      />
+      <v-btn
+        v-if="!props.disabled"
+        icon="mdi mdi-download"
+        variant="plain"
+        @click="downloadPdf"
+      />
+      <v-btn
+        icon="mdi mdi-close"
+        variant="plain"
+        @click="endLoadPdf"
+      />
+    </v-toolbar>
+    <v-card-text class="justify-center h-screen">
+      <PDF
+        v-bind="$attrs"
+        :pdf-width="setWidthPdf"
+        :src="base64"
+        :show-back-to-top-btn="props.showBackToTopBtn"
+      />
+    </v-card-text>
+  </v-card>
+</template>

package/dist/runtime/composables/alert.d.ts

@@ -1,3 +1,7 @@
+/**
+ * useAlert manages reactive alert state, creation helpers, and queue lifecycle used by notification components.
+ * This doc block is consumed by vue-docgen for generated API documentation.
+ */
 import { type InjectionKey, type Ref } from 'vue';
 import type { AlertItem } from '../types/alert.js';
 interface AlertProvide {

package/dist/runtime/composables/api.d.ts

@@ -1,3 +1,7 @@
+/**
+ * useApi wraps authenticated HTTP calls, URL resolution, and optional response caching for runtime services.
+ * This doc block is consumed by vue-docgen for generated API documentation.
+ */
 import type { UseFetchOptions } from 'nuxt/app';
 import type { SearchParameters } from 'ofetch';
 export declare function useApi(): {

package/dist/runtime/composables/dialog.d.ts

@@ -1 +1 @@
-export declare const useDialog: () => import("../types/dialogManager").DialogPlugin;
+export declare const useDialog: () => any;

package/dist/runtime/composables/document/templateFormHidden.d.ts

@@ -1,2 +1,6 @@
+/**
+ * Hidden-field template helpers build non-visual document form bindings while preserving data mapping.
+ * This doc block is consumed by vue-docgen for generated API documentation.
+ */
 import { type DocumentTemplateItem } from './template.js';
 export declare function processTemplateFormHidden(item: DocumentTemplateItem, parentTemplates: string | string[], dataVariable?: string): string;

package/dist/runtime/composables/graphql.d.ts

@@ -10,7 +10,7 @@ declare type VariableOptions = {
     [k: string]: any;
 };
 export declare function useGraphQl(): {
-    query: <T>(operation: string, fields: Array<string | Object> | ClassConstructor<any>, variables?: VariableOptions, cache?: boolean) => import("#app").AsyncData<(T extends any[] ? T : T extends Record<string, any> ? keyof T extends (T extends T ? keyof T extends string ? string & keyof T : never : never) ? T : (T extends T ? keyof T extends string ? string & keyof T : never : never) extends never ? T : Pick<T, T extends T ? keyof T extends string ? string & keyof T : never : never> : T) | null, import("#app").NuxtError<unknown> | null>;
+    query: <T>(operation: string, fields: Array<string | Object> | ClassConstructor<any>, variables?: VariableOptions, cache?: boolean) => any;
     queryPromise: <T>(operation: string, fields: Array<string | Object> | ClassConstructor<any>, variables?: VariableOptions, cache?: boolean | number) => Promise<T>;
     mutation: <T>(operation: string, fields: Array<string | Object> | ClassConstructor<any>, variables?: VariableOptions) => UseMutationReturn<any, any>;
     mutationPromise: <T>(operation: string, fields: Array<string | Object> | ClassConstructor<any>, variables?: VariableOptions) => Promise<T>;

package/dist/runtime/composables/graphqlModel.d.ts

@@ -13,22 +13,22 @@ export declare function useGraphqlModel<T extends GraphqlModelProps>(props: T):
     search: import("vue").Ref<string | undefined, string | undefined>;
     setSearch: (keyword: string) => void;
     currentOptions: import("vue").Ref<any, any>;
-    operationCreate: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any>>;
-    operationUpdate: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any>>;
-    operationDelete: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any>>;
-    operationRead: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any>>;
-    operationReadPageable: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any>>;
-    operationSearch: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any>>;
+    operationCreate: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any> | undefined>;
+    operationUpdate: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any> | undefined>;
+    operationDelete: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any> | undefined>;
+    operationRead: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any> | undefined>;
+    operationReadPageable: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any> | undefined>;
+    operationSearch: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any> | undefined>;
     fields: import("vue").ComputedRef<(string | object)[]>;
     canServerPageable: import("vue").ComputedRef<boolean>;
     canServerSearch: import("vue").ComputedRef<boolean>;
     canCreate: import("vue").ComputedRef<boolean>;
     canUpdate: import("vue").ComputedRef<boolean>;
     canDelete: import("vue").ComputedRef<boolean>;
-    createItem: (item: Record<string, any>, callback?: FormDialogCallback, importing?: boolean) => Promise<void>;
+    createItem: (item: Record<string, any>, callback?: FormDialogCallback, importing?: boolean) => Promise<void> | undefined;
     importItems: (importItems: Record<string, any>[], callback?: FormDialogCallback) => void;
-    updateItem: (item: Record<string, any>, callback?: FormDialogCallback) => Promise<void>;
-    deleteItem: (item: Record<string, any>, callback?: FormDialogCallback) => Promise<any>;
+    updateItem: (item: Record<string, any>, callback?: FormDialogCallback) => Promise<void> | undefined;
+    deleteItem: (item: Record<string, any>, callback?: FormDialogCallback) => Promise<any> | undefined;
     loadItems: (options: any) => void;
     reload: () => void;
     isLoading: import("vue").Ref<boolean, boolean>;

package/dist/runtime/composables/graphqlModelItem.d.ts

@@ -4,17 +4,17 @@ export type GraphqlModelItemProps = Omit<GraphqlModelConfigProps, 'operationSear
 export declare function useGraphqlModelItem<T extends GraphqlModelItemProps>(props: T): {
     modelBy: import("vue").Ref<object | undefined, object | undefined>;
     item: import("vue").Ref<Record<string, any> | undefined, Record<string, any> | undefined>;
-    operationCreate: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any>>;
-    operationUpdate: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any>>;
-    operationDelete: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any>>;
-    operationRead: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any>>;
+    operationCreate: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any> | undefined>;
+    operationUpdate: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any> | undefined>;
+    operationDelete: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any> | undefined>;
+    operationRead: import("vue").ComputedRef<import("~/.nuxt/types/graphqlOperation").graphqlOperationObject<any, any> | undefined>;
     fields: import("vue").ComputedRef<(string | object)[]>;
     canCreate: import("vue").ComputedRef<boolean>;
     canUpdate: import("vue").ComputedRef<boolean>;
     canDelete: import("vue").ComputedRef<boolean>;
-    createItem: (createItem: Record<string, any>, callback?: FormDialogCallback) => Promise<void>;
-    updateItem: (updateItem: Record<string, any>, callback?: FormDialogCallback) => Promise<void>;
-    deleteItem: (item: Record<string, any>, callback?: FormDialogCallback) => Promise<any>;
+    createItem: (createItem: Record<string, any>, callback?: FormDialogCallback) => Promise<void> | undefined;
+    updateItem: (updateItem: Record<string, any>, callback?: FormDialogCallback) => Promise<void> | undefined;
+    deleteItem: (item: Record<string, any>, callback?: FormDialogCallback) => Promise<any> | undefined;
     reload: () => void;
     isLoading: import("vue").Ref<boolean, boolean>;
 };