@ramathibodi/nuxt-commons 0.1.73 → 0.1.74

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

@@ -1,4 +1,8 @@
 <script lang="ts" setup>
+/**
+ * ModelCombobox 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 { VCombobox } from 'vuetify/components/VCombobox'
 import { defineModel, withDefaults } from 'vue'
 import { useLookupList, type LookupProps } from '../../composables/lookupList'
@@ -6,22 +10,30 @@ import { useLocalStorageModel, type PersistSlimProps } from '../../composables/l
 
 interface Props extends /* @vue-ignore */ InstanceType<typeof VCombobox['$props']> {}
 
+/**
+ * Public props accepted by ModelCombobox.
+ * Document each prop field with intent, defaults, and side effects for clear generated docs.
+ */
 const props = withDefaults(defineProps<Props & LookupProps & PersistSlimProps>(), {
-  fuzzy: false,
-  showCode: false,
-  cache: false,
-  serverSearch: false,
-  searchSearchSort: false,
-  serverSearchText: 'Type to search…',
-  serverSearchLoadingText: 'Searching…',
-  serverSearchDebounce: 500,
+  fuzzy: false, // Enables fuzzy matching when filtering local options.
+  showCode: false, // Displays code values alongside labels in option lists.
+  cache: false, // Enables cached requests; number values represent cache TTL in milliseconds.
+  serverSearch: false, // Uses remote search requests instead of local filtering.
+  searchSearchSort: false, // Sorts server-search results based on search relevance.
+  serverSearchText: 'Type to search…', // Placeholder/help text shown before server search starts.
+  serverSearchLoadingText: 'Searching…', // Status text shown while server search request is running.
+  serverSearchDebounce: 500, // Debounce delay in milliseconds before sending server search.
 
-  statusField: 'statusCode',
-  activeValue: 'active',
-  hideInactiveInList: false,
-  preventSelectingInactive: false,
+  statusField: 'statusCode', // Field name that indicates active/inactive status in each item.
+  activeValue: 'active', // Value in statusField treated as active/selectable.
+  hideInactiveInList: false, // Hides inactive options from the displayed selection list.
+  preventSelectingInactive: false, // Blocks selecting inactive options even if present in the dataset.
 })
 
+/**
+ * Custom events emitted by ModelCombobox.
+ * Parents can listen to these events to react to user actions and internal state changes.
+ */
 const emit = defineEmits<{
   (e: 'update:selectedObject', object: any | any[]): void
 }>()

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

@@ -1,4 +1,8 @@
 <script lang="ts" setup>
+/**
+ * ModelPad 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 { computed, useTemplateRef, defineExpose } from 'vue'
 import { type GraphqlModelItemProps, useGraphqlModelItem } from '../../composables/graphqlModelItem'
 import type {FormDialogCallback} from '../../types/formDialog'
@@ -10,11 +14,15 @@ defineOptions({
 })
 
 interface Props extends /* @vue-ignore */ InstanceType<typeof EditPad['$props']> {
-  title?: string
-  saveCaption?: string
-  cancelCaption?: string
+  title?: string // Title text displayed in the component header or dialog.
+  saveCaption?: string // Label text for the save/confirm action button.
+  cancelCaption?: string // Label text for the cancel action button.
 }
 
+/**
+ * Public props accepted by ModelPad.
+ * Document each prop field with intent, defaults, and side effects for clear generated docs.
+ */
 const props = withDefaults(defineProps<Props & GraphqlModelItemProps>(), {
   fields: () => ['*'],
 
@@ -22,6 +30,10 @@ const props = withDefaults(defineProps<Props & GraphqlModelItemProps>(), {
   cancelCaption: 'ยกเลิก',
 })
 
+/**
+ * Custom events emitted by ModelPad.
+ * Parents can listen to these events to react to user actions and internal state changes.
+ */
 const emit = defineEmits(['create', 'update'])
 
 const { item,

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

@@ -1,4 +1,8 @@
 <script lang="ts" setup>
+/**
+ * ModelSelect 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 { VCombobox } from 'vuetify/components/VCombobox'
 import { defineModel, withDefaults } from 'vue'
 import { useLookupList, type StaticLookupProps } from '../../composables/lookupList'
@@ -6,17 +10,25 @@ import { useLocalStorageModel, type PersistSlimProps } from '../../composables/l
 
 interface Props extends /* @vue-ignore */ InstanceType<typeof VCombobox['$props']> {}
 
+/**
+ * Public props accepted by ModelSelect.
+ * Document each prop field with intent, defaults, and side effects for clear generated docs.
+ */
 const props = withDefaults(defineProps<Props & StaticLookupProps & PersistSlimProps>(), {
-  fuzzy: false,
-  showCode: false,
-  cache: false,
+  fuzzy: false, // Enables fuzzy matching when filtering local options.
+  showCode: false, // Displays code values alongside labels in option lists.
+  cache: false, // Enables cached requests; number values represent cache TTL in milliseconds.
 
-  statusField: 'statusCode',
-  activeValue: 'active',
-  hideInactiveInList: false,
-  preventSelectingInactive: false,
+  statusField: 'statusCode', // Field name that indicates active/inactive status in each item.
+  activeValue: 'active', // Value in statusField treated as active/selectable.
+  hideInactiveInList: false, // Hides inactive options from the displayed selection list.
+  preventSelectingInactive: false, // Blocks selecting inactive options even if present in the dataset.
 })
 
+/**
+ * Custom events emitted by ModelSelect.
+ * Parents can listen to these events to react to user actions and internal state changes.
+ */
 const emit = defineEmits<{
   (e: 'update:selectedObject', object: any | any[]): void
 }>()

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

@@ -1,4 +1,8 @@
 <script lang="ts" setup>
+/**
+ * ModelTable 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 {computed,watch, nextTick, ref, useAttrs} from 'vue'
 import {VDataTable} from 'vuetify/components/VDataTable'
 import {clone} from 'lodash-es'
@@ -14,26 +18,30 @@ defineOptions({
 })
 
 interface Props extends /* @vue-ignore */ InstanceType<typeof VDataTable['$props']> {
-  title: string
-  noDataText?: string
-  dialogWidth?: string | number
-  dialogMaxWidth?: string | number
-  dialogHeight?: string | number
-  dialogMaxHeight?: string | number
-  dialogFullscreen?: boolean
-  initialData?: Record<string, any>
-  toolbarColor?: string
-  importable?: boolean
-  exportable?: boolean
-  insertable?: boolean
-  searchable?: boolean
-  search?: string
-  saveAndStay?: boolean
-  stringFields?: Array<string>
-  onlyOwnerEdit?: boolean
-  onlyOwnerOverridePermission?: string | string[]
+  title: string // Toolbar title and default export filename for this model table.
+  noDataText?: string // Message shown when query returns no rows.
+  dialogWidth?: string | number // Width passed to create/edit model dialog.
+  dialogMaxWidth?: string | number // Max-width cap for model dialog on large displays.
+  dialogHeight?: string | number // Height passed to create/edit model dialog.
+  dialogMaxHeight?: string | number // Max-height cap for model dialog before internal scrolling.
+  dialogFullscreen?: boolean // Opens model dialog fullscreen by default.
+  initialData?: Record<string, any> // Base values merged into create payload before dialog submission.
+  toolbarColor?: string // Color used by toolbar and built-in action buttons.
+  importable?: boolean // Enables CSV/XLS import action (requires create permission).
+  exportable?: boolean // Enables export action for currently loaded model items.
+  insertable?: boolean // Shows Add button and allows create flow.
+  searchable?: boolean // Shows search input and forwards keyword into GraphQL model search state.
+  search?: string // External search keyword; watcher keeps internal model search in sync.
+  saveAndStay?: boolean // Forwards to dialog form to keep modal open after successful save.
+  stringFields?: Array<string> // Field paths that must remain plain strings during import/export transforms.
+  onlyOwnerEdit?: boolean // When true, edit/delete are allowed only for rows created by current user.
+  onlyOwnerOverridePermission?: string | string[] // Permission key(s) that bypass `onlyOwnerEdit` restriction.
 }
 
+/**
+ * Public props accepted by ModelTable.
+ * Document each prop field with intent, defaults, and side effects for clear generated docs.
+ */
 const props = withDefaults(defineProps<Props & GraphqlModelProps>(), {
   noDataText: 'ไม่พบข้อมูล',
   dialogFullscreen: false,
@@ -50,6 +58,10 @@ const props = withDefaults(defineProps<Props & GraphqlModelProps>(), {
   onlyOwnerEdit: false,
 })
 
+/**
+ * Custom events emitted by ModelTable.
+ * Parents can listen to these events to react to user actions and internal state changes.
+ */
 const emit = defineEmits(['open:dialog','close:dialog','create','update','delete'])
 const attrs = useAttrs()
 const plainAttrs = computed(() => {

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

@@ -1,4 +1,8 @@
 <script lang="ts" setup>
+/**
+ * ModelIterator 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 {computed, nextTick, ref, useAttrs, useSlots, watch} from 'vue'
 import {VDataIterator} from 'vuetify/components/VDataIterator'
 import {VDataTable} from "vuetify/components/VDataTable";
@@ -12,36 +16,40 @@ defineOptions({
 })
 
 interface Props extends /* @vue-ignore */ InstanceType<typeof VDataIterator['$props']> {
-  title: string
-  noDataText?: string
-  dialogFullscreen?: boolean
-  initialData?: Record<string, any>
-  toolbarColor?: string
-  importable?: boolean
-  exportable?: boolean
-  insertable?: boolean
-  searchable?: boolean
-  search?: string
-
-  viewSwitch?: boolean
-  viewSwitchMultiple?: boolean
-
-  cols?: string | number | boolean
-  xxl?: string | number | boolean
-  xl?: string | number | boolean
-  lg?: string | number | boolean
-  md?: string | number | boolean
-  sm?: string | number | boolean
-  itemsPerPage?: string | number
-
-  preferTable?: string | number | boolean
-  preferTableXxl?: string | number | boolean
-  preferTableXl?: string | number | boolean
-  preferTableLg?: string | number | boolean
-  preferTableMd?: string | number | boolean
-  preferTableSm?: string | number | boolean
+  title: string // Toolbar title for this model-backed iterator/table block.
+  noDataText?: string // Empty-state message shown when model query has no results.
+  dialogFullscreen?: boolean // Opens create/edit dialog fullscreen by default.
+  initialData?: Record<string, any> // Default values merged with `modelBy` before opening create dialog.
+  toolbarColor?: string // Toolbar/action color theme token.
+  importable?: boolean // Enables import action for creating many model rows at once.
+  exportable?: boolean // Enables export action for current model result set.
+  insertable?: boolean // Enables create action for new model rows.
+  searchable?: boolean // Shows search input and updates GraphQL model search state.
+  search?: string // External search value synced into internal search ref via watcher.
+
+  viewSwitch?: boolean // Displays control for switching between card iterator and table presentations.
+  viewSwitchMultiple?: boolean // Allows multiple selected view chips when switch UI supports it.
+
+  cols?: string | number | boolean // Base columns used by iterator card grid.
+  xxl?: string | number | boolean // Card grid columns at `xxl` breakpoint.
+  xl?: string | number | boolean // Card grid columns at `xl` breakpoint.
+  lg?: string | number | boolean // Card grid columns at `lg` breakpoint.
+  md?: string | number | boolean // Card grid columns at `md` breakpoint.
+  sm?: string | number | boolean // Card grid columns at `sm` breakpoint.
+  itemsPerPage?: string | number // Items per page for iterator/table pagination (`all` supported).
+
+  preferTable?: string | number | boolean // Auto view strategy: always table (`true`) or table after N items (number).
+  preferTableXxl?: string | number | boolean // `xxl` override for `preferTable`.
+  preferTableXl?: string | number | boolean // `xl` override for `preferTable`.
+  preferTableLg?: string | number | boolean // `lg` override for `preferTable`.
+  preferTableMd?: string | number | boolean // `md` override for `preferTable`.
+  preferTableSm?: string | number | boolean // `sm` override for `preferTable`.
 }
 
+/**
+ * Public props accepted by ModelIterator.
+ * Document each prop field with intent, defaults, and side effects for clear generated docs.
+ */
 const props = withDefaults(defineProps<Props & GraphqlModelProps>(), {
   noDataText: 'ไม่พบข้อมูล',
   dialogFullscreen: false,

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

@@ -1,20 +1,28 @@
 <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
-  modelBy?: object
-  itemTitle: string | ((result:Record<string,any>)=>void)
-  fields?: Array<string | object>
-  cache?: boolean | number
-
-  notFoundText?: string
-  placeholder?: string
+  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,
 })

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

@@ -1,20 +1,32 @@
 <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
-  fileName?: string
-  print?: boolean
-  title?: string
-  disabled?: boolean
+  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)

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

@@ -1,4 +1,8 @@
 <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'
@@ -6,14 +10,18 @@ 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
+  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: '',
@@ -23,6 +31,10 @@ const props = withDefaults(defineProps<Props>(), {
   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()

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/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/localStorageModel.d.ts

@@ -1,3 +1,7 @@
+/**
+ * useLocalStorageModel persists model state in local storage with optional encryption and cache invalidation controls.
+ * This doc block is consumed by vue-docgen for generated API documentation.
+ */
 import { type Ref } from 'vue';
 export interface PersistSlimProps {
     /** enable persistence */

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

@@ -1,3 +1,7 @@
+/**
+ * useLookupList loads and normalizes lookup options for fields that depend on remote or cached reference lists.
+ * This doc block is consumed by vue-docgen for generated API documentation.
+ */
 import { type Ref } from 'vue';
 export interface StaticLookupProps {
     fuzzy?: boolean;

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

@@ -1,3 +1,7 @@
+/**
+ * useMenu manages menu configuration, filtering, and visibility behavior for navigation and action surfaces.
+ * This doc block is consumed by vue-docgen for generated API documentation.
+ */
 import { type ComputedRef, type InjectionKey, type Ref } from 'vue';
 import { type RouteRecordNormalized, type RouteRecordRaw } from 'vue-router';
 import { type MenuItem } from '../types/menu.js';

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

@@ -0,0 +1,48 @@
+/**
+ * Check-digit map extracted from a parsed TD3 MRZ payload.
+ */
+export type MrzCheckDigits = {
+    passportNumber?: string;
+    birthDate?: string;
+    expirationDate?: string;
+    personalNumber?: string;
+    composite?: string;
+};
+/**
+ * Normalized MRZ parsing result after checksum/date validation.
+ */
+export interface MrzResult {
+    raw: string;
+    lines: string[];
+    fields: {
+        documentType?: string;
+        issuingState?: string;
+        surname?: string;
+        givenNames?: string;
+        passportNumber?: string;
+        nationality?: string;
+        birthDate?: string;
+        sex?: string;
+        expirationDate?: string;
+        personalNumber?: string;
+        checkDigits?: MrzCheckDigits;
+    };
+}
+export interface UseMrzReaderOptions {
+    scaleFactor?: number;
+    useOpenCv?: boolean;
+    lang?: string;
+    langPath?: string;
+}
+/**
+ * MRZ reader pipeline for camera/video/image sources.
+ * Performs OCR, candidate-region extraction, TD3 parsing, and checksum validation.
+ */
+export declare function useMrzReader(options?: UseMrzReaderOptions): {
+    ensureOpenCvReady: () => Promise<boolean>;
+    opencvReady: import("vue").Ref<boolean, boolean>;
+    ocrProgress: import("vue").Ref<number, number>;
+    ocrStatus: import("vue").Ref<string, string>;
+    decodeFromVideoElement: (video: HTMLVideoElement) => Promise<MrzResult | undefined>;
+    decodeFromImageFile: (file: File) => Promise<MrzResult | undefined>;
+};