bt-core-app 1.4.36 → 1.4.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -527,6 +527,51 @@ export declare function isLengthyArray(val: any, greaterThan?: number): boolean;
527
527
 
528
528
  export declare function isMinDate(d?: string): boolean;
529
529
 
530
+ export declare interface ItemProps {
531
+ additionalUrl?: string;
532
+ bladeID?: string;
533
+ bladeName?: string;
534
+ canSave?: boolean;
535
+ eager?: boolean;
536
+ errorMsg?: string;
537
+ ignorePermissions?: boolean;
538
+ isSingle?: boolean;
539
+ item?: any;
540
+ itemID?: string;
541
+ loadingMsg?: string;
542
+ mode?: BladeMode;
543
+ nav?: string;
544
+ onCanDelete?: (item: any) => boolean;
545
+ onCanDeleteAsync?: OnCanDoAsync;
546
+ onCanEdit?: (item: any) => boolean;
547
+ onCanRestore?: (item: any) => boolean;
548
+ onCanRestoreAsync?: OnCanDoAsync;
549
+ onCanSave?: (item: any) => boolean;
550
+ onCanSaveAsync?: OnCanDoAsync;
551
+ onDeleteAsync?: OnDoAsync;
552
+ onDeleteSuccessAsync?: OnDoSuccessAsync;
553
+ onGetAsync?: OnGetAsync;
554
+ onGetSuccessAsync?: OnGetSuccessAsync;
555
+ onGetNew?: () => any;
556
+ onGetSaveAsync?: OnDoSuccessAsync;
557
+ onRestoreAsync?: OnDoSuccessAsync;
558
+ onRestoreSuccessAsync?: OnDoSuccessAsync;
559
+ onSaveAsync?: OnDoSuccessAsync;
560
+ onSaveSuccessAsync?: OnDoSuccessAsync;
561
+ params?: any;
562
+ proxyID?: string;
563
+ proxyQueryKey?: string;
564
+ refreshToggle?: boolean;
565
+ startEditing?: boolean;
566
+ storeMode?: StoreMode;
567
+ storageMode?: StorageMode;
568
+ trackChanges?: boolean;
569
+ trackIgnoreProps?: string[];
570
+ trackProps?: string[];
571
+ useBladeSrc?: boolean;
572
+ useRouteSrc?: boolean;
573
+ }
574
+
530
575
  export declare interface ListEvents {
531
576
  (e: 'change', item: any): void;
532
577
  (e: 'deleted', item: any): void;
@@ -589,7 +634,6 @@ export declare interface ListProps {
589
634
  useServerPagination?: boolean;
590
635
  useBladeSrc?: boolean;
591
636
  useRouteSrc?: boolean;
592
- variant?: BladeVariant;
593
637
  }
594
638
 
595
639
  declare interface LocalForage extends LocalForageDbMethods {
@@ -818,6 +862,10 @@ export declare interface QueryParams {
818
862
 
819
863
  declare interface RefreshOptions {
820
864
  deepRefresh?: boolean;
865
+ }
866
+
867
+ declare interface RefreshOptions_2 {
868
+ deepRefresh?: boolean;
821
869
  resetSearch?: boolean;
822
870
  }
823
871
 
@@ -843,6 +891,10 @@ export declare interface RestoreOptions extends PathOptions, DoActionOptions {
843
891
  */
844
892
  export declare function roundTo(val: number, dPlaces: number): number;
845
893
 
894
+ declare interface SaveItemOptions {
895
+ navBack?: boolean;
896
+ }
897
+
846
898
  export declare interface SaveOptions extends PathOptions, DoActionOptions {
847
899
  /**will seek to post if 'new' otherwise will patch */
848
900
  mode?: BladeMode;
@@ -1086,6 +1138,33 @@ export declare interface UseFiltersOptions {
1086
1138
 
1087
1139
  export declare function useId(pattern?: string): string;
1088
1140
 
1141
+ export declare function useItem(props: ItemProps, options?: UseItemOptions): {
1142
+ asyncItem: Ref<any>;
1143
+ deleteItem: (dItem: MaybeRefOrGetter<any>) => void;
1144
+ errorMsg: ComputedRef<string | undefined>;
1145
+ isChanged: Ref<boolean>;
1146
+ isDeletable: ComputedRef<boolean>;
1147
+ isEditing: ComputedRef<boolean>;
1148
+ isEditable: ComputedRef<boolean>;
1149
+ isLoading: ComputedRef<boolean>;
1150
+ isRestorable: ComputedRef<boolean>;
1151
+ isSaveable: ComputedRef<boolean>;
1152
+ loadingMsg: ComputedRef<string | undefined>;
1153
+ mode: Ref<BladeMode>;
1154
+ refresh: (options?: RefreshOptions) => Promise<void>;
1155
+ restoreItem: (dItem: MaybeRefOrGetter<any>) => void;
1156
+ saveItem: (dItem: MaybeRefOrGetter<any>, options?: SaveItemOptions) => void;
1157
+ showError: ShallowRef<boolean>;
1158
+ toggleMode: () => void;
1159
+ };
1160
+
1161
+ export declare interface UseItemOptions {
1162
+ storeMode?: StoreMode;
1163
+ storageMode?: StorageMode;
1164
+ useRouteSrc?: boolean;
1165
+ useBladeSrc?: boolean;
1166
+ }
1167
+
1089
1168
  /**
1090
1169
  * PROPS first
1091
1170
  * ROUTE second
@@ -1156,7 +1235,7 @@ export declare function useList(props: ListProps, emit?: ListEvents, options?: U
1156
1235
  isLoading: ComputedRef<boolean>;
1157
1236
  isRestorable: ComputedRef<(item: any) => boolean>;
1158
1237
  loadingMsg: ComputedRef<string | undefined>;
1159
- refresh: (options?: RefreshOptions) => Promise<void>;
1238
+ refresh: (options?: RefreshOptions_2) => Promise<void>;
1160
1239
  restoreItem: (dItem: MaybeRefOrGetter<any>) => void;
1161
1240
  searchString: Ref<string | undefined>;
1162
1241
  selectedFilters: Ref<number[]>;
@@ -1166,6 +1245,30 @@ export declare function useList(props: ListProps, emit?: ListEvents, options?: U
1166
1245
  showSearch: ShallowRef<boolean>;
1167
1246
  sortOrder: Ref<"Ascending" | "Descending" | undefined>;
1168
1247
  subtitleOptions: ComputedRef<GroupedHeaderOption[]>;
1248
+ tableHeaders: ComputedRef< {
1249
+ align?: "start" | "end" | "center" | undefined;
1250
+ bool?: number | undefined;
1251
+ csv?: boolean | undefined;
1252
+ csvArray?: boolean | undefined;
1253
+ csvFilter?: string | undefined;
1254
+ csvText?: string | undefined;
1255
+ display?: boolean | undefined;
1256
+ hide?: boolean | undefined;
1257
+ itemText?: string | undefined;
1258
+ level?: number | undefined;
1259
+ maxWidth?: string | undefined;
1260
+ minWidth?: string | undefined;
1261
+ nav?: string | undefined;
1262
+ prefix?: string | undefined;
1263
+ searchable?: boolean | undefined;
1264
+ single?: boolean | undefined;
1265
+ sublevel?: number | undefined;
1266
+ suffix?: string | undefined;
1267
+ textFilter?: string | undefined;
1268
+ textFunction?: Function | undefined;
1269
+ title?: string | undefined;
1270
+ value?: string | undefined;
1271
+ }[]>;
1169
1272
  titleOptions: ComputedRef<GroupedHeaderOption[]>;
1170
1273
  toggleSearch: () => void;
1171
1274
  totalPages: Ref<number>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bt-core-app",
3
- "version": "1.4.36",
3
+ "version": "1.4.38",
4
4
  "description": "Core app tools for some basic features like navigation, authentication, server apis, and cosmetics",
5
5
  "homepage": "https://github.com/BlitzItTech/bt-core",
6
6
  "bugs": {