@fewangsit/wangsvue 1.5.216-alpha.0 → 1.5.217-alpha.0

package/components/textarea/Textarea.vue.d.ts

@@ -1,11 +1,12 @@
 import { TextareaHTMLAttributes } from 'vue';
+
+import { CustomValidation } from '../form/Form.vue.d';
 import {
   ClassComponent,
   GlobalComponentConstructor,
   Nullable,
   Numberish,
 } from '../ts-helpers.d';
-import { CustomValidation } from '../form/Form.vue.d';
 
 export interface TextareaLocaleConfig {
   /**

package/components/timeline/Timeline.vue.d.ts

@@ -1,6 +1,8 @@
-import { JSONContent } from '../editor/Editor.vue.d';
+import { VNode } from 'vue';
+
 import { BadgeProps } from '../badge/Badge.vue.d';
-import { ClassComponent } from '../ts-helpers';
+import { JSONContent } from '../editor/Editor.vue.d';
+import { ClassComponent } from '../ts-helpers.d';
 
 export interface AttachmentFile {
   type: 'image' | 'xls' | 'doc' | 'pdf' | 'csv' | 'video' | 'data';
@@ -70,12 +72,17 @@ export type DetailType =
   | DetailJSONContent
   | DetailBadge;
 
+export type DetailAnyRecord = Record<string, any>;
+
+export type SlotDetailType = string | DetailAnyRecord;
+
 export type KeyValue = Record<string, string | DetailType>;
 
 export type TimelineItem = {
   _id: string;
   action: string;
   createdAt: string;
+  username?: string;
   user?: {
     _id: string;
     nickName: string;
@@ -102,6 +109,18 @@ export type TimelineProps = {
   noFormatDate?: boolean;
 };
 
+export type TimelineSlots = {
+  /**
+   * Custom detail template.
+   *
+   * Use this slot if you want to configure your own detail value in each timeline
+   */
+  detail(slotProps: {
+    key: string;
+    value: SlotDetailType; // Type DetailAnyRecord only used when using slot since you can use your own object structure
+  }): VNode[];
+};
+
 /**
  * **WangsVue - Timeline**
  *
@@ -114,7 +133,7 @@ export type TimelineProps = {
  */
 declare class Timeline extends ClassComponent<
   TimelineProps,
-  unknown,
+  TimelineSlots,
   unknown
 > {}
 

package/components/toast/Toast.vue.d.ts

@@ -9,14 +9,15 @@
  *
  */
 import { TransitionProps, VNode } from 'vue';
+
 import { ComponentHooks } from '../basecomponent';
+import { WangsIcons } from '../icon/Icon.vue.d';
 import { PassThroughOptions } from '../passthrough';
 import {
   ClassComponent,
   GlobalComponentConstructor,
   PassThrough,
-} from '../ts-helpers';
-import { WangsIcons } from '../icon/Icon.vue.d';
+} from '../ts-helpers.d';
 
 export declare type ToastPassThroughOptionType =
   | ToastPassThroughAttributes

package/components/toggleswitch/ToggleSwitch.vue.d.ts

@@ -6,13 +6,14 @@
  *
  */
 import { StyleValue } from 'vue';
+
 import { ComponentHooks } from '../basecomponent';
 import { PassThroughOptions } from '../passthrough';
 import {
   ClassComponent,
   GlobalComponentConstructor,
   PassThrough,
-} from '../ts-helpers';
+} from '../ts-helpers.d';
 
 export declare type ToggleSwitchPassThroughOptionType =
   | ToggleSwitchPassThroughAttributes

package/components/tree/Tree.vue.d.ts

@@ -1,9 +1,11 @@
 import { Slot } from 'vue';
-import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
-import { TreeSelectionKeys } from 'primevue/tree';
-import { MenuItem } from 'lib/components/menuitem';
+import { MenuItem } from '../../components/menuitem';
+
 import { BaseTreeProps, TreeNode } from '../basetree/BaseTree.vue.d';
 import { QueryParams, ShortFetchResponse } from '../datatable/DataTable.vue.d';
+import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers.d';
+
+import { TreeSelectionKeys } from 'primevue/tree';
 
 export interface TreeProps extends BaseTreeProps {
   /**
@@ -15,6 +17,10 @@ export interface TreeProps extends BaseTreeProps {
     type: 'group' | 'category',
     params?: QueryParams,
   ) => Promise<ShortFetchResponse<TreeNode> | undefined>;
+
+  /**
+   * For query: roleType, transactionAttribute, systemRole is already stringified in components default props, but for the rest of query params need to be stringified outside
+   */
   params?: QueryParams;
   selectedKeys?: TreeSelectionKeys | number[] | undefined;
   selectedTreeNodes?: TreeNode[] | undefined;

package/components/ts-helpers.d.ts

@@ -81,3 +81,11 @@ export declare type PresetMethodOptions = {
 export declare type PresetOptionMethodType<Opt = PresetMethodOptions> = (
   options: Partial<Opt>,
 ) => PresetAttributes;
+
+export type StringKeyOf<T> = Extract<keyof T, string>;
+
+declare const TypeException: unique symbol;
+
+export type TypeError<T extends string> = {
+  [TypeException]: T;
+};

package/components/usergroup/UserGroup.vue.d.ts

@@ -1,4 +1,4 @@
-import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers';
+import { ClassComponent, GlobalComponentConstructor } from '../ts-helpers.d';
 import { GeneralUser } from '../username/UserName.vue.d';
 
 /**

package/components/username/UserName.vue.d.ts

@@ -3,7 +3,7 @@ import {
   GlobalComponentConstructor,
   PresetAttributes,
   PresetOptionMethodType,
-} from '../ts-helpers';
+} from '../ts-helpers.d';
 
 export interface UserNamePresetOptions {
   root: PresetAttributes;
@@ -30,7 +30,7 @@ export interface UserNameComponentConfigs {
   /**
    * @example `/tim-member/member/{userId}/detail-member`
    */
-  detailUserPath: string;
+  detailUserPath?: string;
 
   /**
    * @default 'picture' - Show user profile picture instead of user icon
@@ -42,6 +42,11 @@ export interface UserNameComponentConfigs {
    * @default true
    */
   showUserName?: boolean;
+  /**
+   * Whether to shorten the user's name..
+   * @default true
+   */
+  formatUserName?: boolean;
   /**
    * Specify the field of user to be used as display name
    *
@@ -60,7 +65,7 @@ export interface UserNameComponentConfigs {
    * @param userId The user id
    * @returns Full user detail object
    */
-  getUserDetail: (
+  getUserDetail?: (
     userId: string,
   ) => UserNameProps['user'] | Promise<UserNameProps['user']>;
 }
@@ -85,7 +90,7 @@ export interface UserNameProps extends Partial<UserNameComponentConfigs> {
   /**
    * The full user Object
    */
-  user?: GeneralUser;
+  user?: Partial<GeneralUser>;
 
   /**
    * When it sets to false, the props.user will be used

package/components/workcalendar/WorkCalendar.vue.d.ts

@@ -1,6 +1,5 @@
 import { DefineComponent } from 'vue';
 
-
 export type WorkCalendarState = 'view' | 'edit';
 
 /**

package/config/defaultProps.d.ts

@@ -1,3 +1,3 @@
-import { ComponentDefaultPropsConfig } from '.././plugins/WangsVue';
+import { ComponentDefaultPropsConfig } from '../plugins/WangsVue';
 declare const defaultProps: ComponentDefaultPropsConfig;
 export default defaultProps;

package/config/index.d.ts

@@ -1,3 +1,3 @@
-import { WangsVueOptions } from '.././plugins/WangsVue';
+import { WangsVueOptions } from '../plugins/WangsVue';
 declare const _default: import('vue').Plugin<Partial<WangsVueOptions>>;
 export default _default;

package/config/locale.d.ts

@@ -1,3 +1,3 @@
-import { LocaleConfig } from '.././plugins/WangsVue';
+import { LocaleConfig } from '../plugins/WangsVue';
 declare const locale: LocaleConfig;
 export default locale;

package/directives/focus.d.ts

@@ -2,6 +2,6 @@
  * This directive is used to focus the html input on a component.
  */
 declare const Focus: {
-    mounted: (el: HTMLElement) => Promise<void>;
+  mounted: (el: HTMLElement) => Promise<void>;
 };
 export default Focus;

package/dto/member.dto.d.ts

@@ -1,65 +1,65 @@
-import { FetchResponse } from '.././components/datatable/DataTable.vue.d';
+import { FetchResponse } from '../components/datatable/DataTable.vue.d';
 export interface MemberListResponse extends FetchResponse {
-    status: number;
-    message: string;
-    data: MemberData;
+  status: number;
+  message: string;
+  data: MemberData;
 }
 interface MemberData {
-    totalRecords: number;
-    data: Member[];
+  totalRecords: number;
+  data: Member[];
 }
 export interface Member extends Record<string, unknown> {
-    _id: string;
-    isActive: boolean;
-    key: number;
-    profilePictureBig: string;
-    profilePictureMedium: string;
-    profilePictureSmall: string;
-    fullName: string;
-    nickName: string;
-    finishedDate: string;
-    employeeType: string;
-    division: string;
-    position: string;
-    teams: string[];
-    email: string;
-    phoneNumber: string;
-    initial: string;
-    groupMember: GroupMember;
-    needLeaderReview: boolean;
-    needTestingAccount: boolean;
-    lastLogin: string;
-    lastLoginIp: string;
-    groupMemberAssignedBy: AssignedBy;
-    groupMemberAssignedAt: string;
-    permission: Permission;
-    hasAdminRoles: boolean;
-    projectCount: number;
-    isTeamLeader: boolean;
-    isSubModuleLeader: boolean;
-    isAssignedToTask: boolean;
-    isProjectManager: boolean;
-    isActivate: boolean;
-    progress: string;
+  _id: string;
+  isActive: boolean;
+  key: number;
+  profilePictureBig: string;
+  profilePictureMedium: string;
+  profilePictureSmall: string;
+  fullName: string;
+  nickName: string;
+  finishedDate: string;
+  employeeType: string;
+  division: string;
+  position: string;
+  teams: string[];
+  email: string;
+  phoneNumber: string;
+  initial: string;
+  groupMember: GroupMember;
+  needLeaderReview: boolean;
+  needTestingAccount: boolean;
+  lastLogin: string;
+  lastLoginIp: string;
+  groupMemberAssignedBy: AssignedBy;
+  groupMemberAssignedAt: string;
+  permission: Permission;
+  hasAdminRoles: boolean;
+  projectCount: number;
+  isTeamLeader: boolean;
+  isSubModuleLeader: boolean;
+  isAssignedToTask: boolean;
+  isProjectManager: boolean;
+  isActivate: boolean;
+  progress: string;
 }
 interface GroupMember {
-    name: string;
-    targetType: string;
-    _id: string;
+  name: string;
+  targetType: string;
+  _id: string;
 }
 interface AssignedBy {
-    fullName: string;
-    nickName: string;
-    key: number;
-    profilePictureBig: string;
-    profilePictureMedium: string;
-    profilePictureSmall: string;
-    _id: string;
+  fullName: string;
+  nickName: string;
+  key: number;
+  profilePictureBig: string;
+  profilePictureMedium: string;
+  profilePictureSmall: string;
+  _id: string;
 }
 interface Permission {
-    create: boolean;
-    read: boolean;
-    update: boolean;
-    delete: boolean;
+  create: boolean;
+  read: boolean;
+  update: boolean;
+  delete: boolean;
 }
 export {};

package/dto/task.dto.d.ts

@@ -1,86 +1,86 @@
 import { TaskLinkType, TaskLinkURLType } from '../types/task.type';
 export interface CreateTaskDTO {
-    project: string;
-    process: string;
-    module: string;
-    subModule?: string;
-    productBacklogItem?: string;
-    repository?: string;
-    name: string;
-    team?: string[];
-    assignedTo?: string[];
+  project: string;
+  process: string;
+  module: string;
+  subModule?: string;
+  productBacklogItem?: string;
+  repository?: string;
+  name: string;
+  team?: string[];
+  assignedTo?: string[];
 }
 export interface EditTaskDTO {
-    /**
-     * Project _id
-     */
-    project?: string;
-    /**
-     * Process _id
-     */
-    process?: string;
-    /**
-     * Module _id
-     */
-    module?: string;
-    /**
-     * Sub Module _id
-     */
-    subModule?: string;
-    /**
-     * Task's name
-     */
-    name?: string;
-    /**
-     * Members assigned to the task (Member _id)
-     */
-    repository?: string;
-    assignedTo?: string[];
-    /**
-     * Team initials.
-     */
-    team?: string[];
-    duration?: number;
-    startDate?: string | Date;
-    priority?: number;
+  /**
+   * Project _id
+   */
+  project?: string;
+  /**
+   * Process _id
+   */
+  process?: string;
+  /**
+   * Module _id
+   */
+  module?: string;
+  /**
+   * Sub Module _id
+   */
+  subModule?: string;
+  /**
+   * Task's name
+   */
+  name?: string;
+  /**
+   * Members assigned to the task (Member _id)
+   */
+  repository?: string;
+  assignedTo?: string[];
+  /**
+   * Team initials.
+   */
+  team?: string[];
+  duration?: number;
+  startDate?: string | Date;
+  priority?: number;
 }
 export interface UpdateTaskMemberDTO {
-    data: UpdateTaskMemberItem[];
+  data: UpdateTaskMemberItem[];
 }
 export interface UpdateTaskMemberItem {
-    task: string;
-    member: string;
+  task: string;
+  member: string;
 }
 export interface EditDescriptionTaskDTO {
-    /**
-     * Stringified version of JSONContent from Editor
-     */
-    description: string;
+  /**
+   * Stringified version of JSONContent from Editor
+   */
+  description: string;
 }
 export interface EditTaskLinkDTO {
-    /**
-     * The link, also the field to be used for embed.
-     */
-    link: string;
-    linkType: TaskLinkURLType;
-    type: TaskLinkType;
+  /**
+   * The link, also the field to be used for embed.
+   */
+  link: string;
+  linkType: TaskLinkURLType;
+  type: TaskLinkType;
 }
 export interface ReviewTaskDTO {
-    data: ReviewTaskData[];
-    checklists: ReviewTaskChecklist[];
+  data: ReviewTaskData[];
+  checklists: ReviewTaskChecklist[];
 }
 export interface ReviewTaskData {
-    checklistId: string;
-    checklistName: string;
-    checklistItemName: string;
-    result: 'Ok' | 'Bug';
-    content?: string;
+  checklistId: string;
+  checklistName: string;
+  checklistItemName: string;
+  result: 'Ok' | 'Bug';
+  content?: string;
 }
 export interface ReviewTaskChecklist {
-    checklistName: string;
-    checklistItems: ChecklistItem[];
+  checklistName: string;
+  checklistItems: ChecklistItem[];
 }
 export interface ChecklistItem {
-    checklistItemName: string;
-    content?: string;
+  checklistItemName: string;
+  content?: string;
 }

package/dto/taskApi.dto.d.ts

@@ -1,21 +1,21 @@
 export interface UpdateTaskApiDTO {
-    name: string;
-    method?: string;
-    url?: string;
-    header?: string;
-    contentType?: string;
-    query?: string[];
-    caption?: string[];
-    jsonBody?: string;
-    formDataBody?: FormDataBody[];
-    response?: string;
+  name: string;
+  method?: string;
+  url?: string;
+  header?: string;
+  contentType?: string;
+  query?: string[];
+  caption?: string[];
+  jsonBody?: string;
+  formDataBody?: FormDataBody[];
+  response?: string;
 }
 export interface AddTaskApiDTO {
-    name: string;
-    task: string;
+  name: string;
+  task: string;
 }
 export interface FormDataBody {
-    key: string;
-    type: 'text' | 'file';
-    isMandatory: boolean;
+  key: string;
+  type: 'text' | 'file';
+  isMandatory: boolean;
 }

package/dto/taskAttachment.dto.d.ts

@@ -1,11 +1,11 @@
 export interface AddTaskAttachmentFileDTO {
-    file: any;
-    type: string;
+  file: any;
+  type: string;
 }
 export interface AddTaskAttachmentUrlDTO {
-    url: string;
-    displayName?: string;
+  url: string;
+  displayName?: string;
 }
 export interface UpdateTaskAttachmentCaptionDTO {
-    caption?: string;
+  caption?: string;
 }

package/dto/taskChecklist.dto.d.ts

@@ -1,39 +1,39 @@
 export interface AddTaskChecklistDTO {
-    name: string;
-    task: string;
-    template?: string;
+  name: string;
+  task: string;
+  template?: string;
 }
 export interface UpdateTaskChecklistDTO {
-    name?: string;
-    caption?: string;
+  name?: string;
+  caption?: string;
 }
 export interface AddTaskChecklistItemDTO {
-    checklist: string;
-    name: string;
+  checklist: string;
+  name: string;
 }
 export interface UpdateTaskChecklistItemDTO extends UpdateTaskChecklistDTO {
-    template?: string;
+  template?: string;
 }
 export interface ToggleTaskChecklistItemDTO {
-    checked: boolean;
-    reason: string;
+  checked: boolean;
+  reason: string;
 }
 export interface AddTaskChecklistTemplateDTO {
-    project: string;
-    checklist: string;
-    name: string;
-    module: string;
-    subModule: string;
-    task: string;
-    templateReplaced?: string;
+  project: string;
+  checklist: string;
+  name: string;
+  module: string;
+  subModule: string;
+  task: string;
+  templateReplaced?: string;
 }
 export interface AddTaskChecklistAttachmentFileDTO {
-    checklistItem: string;
-    file: any;
-    type: string;
+  checklistItem: string;
+  file: any;
+  type: string;
 }
 export interface AddTaskChecklistAttachmentUrlDTO {
-    checklistItem: string;
-    url: any;
-    displayName?: string;
+  checklistItem: string;
+  url: any;
+  displayName?: string;
 }

package/dto/taskDependency.dto.d.ts

@@ -1,9 +1,9 @@
 export interface UpdateTaskDependencyDTO {
-    data: Item[];
+  data: Item[];
 }
 interface Item {
-    task: string;
-    custom: boolean;
-    caption?: string;
+  task: string;
+  custom: boolean;
+  caption?: string;
 }
 export {};