bt-core-app 1.4.37 → 1.4.39

package/dist/index.d.ts

@@ -69,13 +69,29 @@ export declare type BladeDensity = 'default' | 'comfortable' | 'compact';
 
 export declare type BladeMode = 'new' | 'view' | 'edit';
 
+export declare interface BladeProps {
+    bladeID?: string;
+    bladeName?: string;
+    density?: BladeDensity;
+    mobileBreakpoint?: number;
+    variant?: BladeVariant;
+}
+
 /**
  Inline: merges toolbars | much more compact | hides navigation
  Page: shows navigation and page settings
  Blade: shows blade minimize, maximize, close, and pins as a column
  Free-moving: show blade as draggable and resizable with minimize, maximize, and close and pinning
  */
-export declare type BladeVariant = 'page' | 'blade' | 'freestyle' | 'inline' | 'pane';
+export declare type BladeVariant = 'page' | 'blade' | 'freestyle' | 'inline';
+
+/**
+ Inline: merges toolbars | much more compact | hides navigation
+ Page: shows navigation and page settings
+ Blade: shows blade minimize, maximize, close, and pins as a column
+ Free-moving: show blade as draggable and resizable with minimize, maximize, and close and pinning
+ */
+declare type BladeVariant_2 = 'page' | 'blade' | 'freestyle' | 'inline' | 'pane';
 
 export declare interface BTActions {
     actionLoadingMsg: ShallowRef<string | undefined>;
@@ -527,6 +543,50 @@ export declare function isLengthyArray(val: any, greaterThan?: number): boolean;
 
 export declare function isMinDate(d?: string): boolean;
 
+export declare interface ItemProps {
+    additionalUrl?: string;
+    bladeID?: string;
+    bladeName?: string;
+    canSave?: boolean;
+    eager?: boolean;
+    errorMsg?: string;
+    ignorePermissions?: boolean;
+    isSingle?: boolean;
+    item?: any;
+    itemID?: string;
+    loadingMsg?: string;
+    nav?: string;
+    onCanDelete?: (item: any) => boolean;
+    onCanDeleteAsync?: OnCanDoAsync;
+    onCanEdit?: (item: any) => boolean;
+    onCanRestore?: (item: any) => boolean;
+    onCanRestoreAsync?: OnCanDoAsync;
+    onCanSave?: (item: any) => boolean;
+    onCanSaveAsync?: OnCanDoAsync;
+    onDeleteAsync?: OnDoAsync;
+    onDeleteSuccessAsync?: OnDoSuccessAsync;
+    onGetAsync?: OnGetAsync;
+    onGetSuccessAsync?: OnGetSuccessAsync;
+    onGetNew?: () => any;
+    onGetSaveAsync?: OnDoSuccessAsync;
+    onRestoreAsync?: OnDoSuccessAsync;
+    onRestoreSuccessAsync?: OnDoSuccessAsync;
+    onSaveAsync?: OnDoSuccessAsync;
+    onSaveSuccessAsync?: OnDoSuccessAsync;
+    params?: any;
+    proxyID?: string;
+    proxyQueryKey?: string;
+    refreshToggle?: boolean;
+    startEditing?: boolean;
+    storeMode?: StoreMode;
+    storageMode?: StorageMode;
+    trackChanges?: boolean;
+    trackIgnoreProps?: string[];
+    trackProps?: string[];
+    useBladeSrc?: boolean;
+    useRouteSrc?: boolean;
+}
+
 export declare interface ListEvents {
     (e: 'change', item: any): void;
     (e: 'deleted', item: any): void;
@@ -817,6 +877,10 @@ export declare interface QueryParams {
 
 declare interface RefreshOptions {
     deepRefresh?: boolean;
+}
+
+declare interface RefreshOptions_2 {
+    deepRefresh?: boolean;
     resetSearch?: boolean;
 }
 
@@ -842,6 +906,10 @@ export declare interface RestoreOptions extends PathOptions, DoActionOptions {
  */
 export declare function roundTo(val: number, dPlaces: number): number;
 
+declare interface SaveItemOptions {
+    navBack?: boolean;
+}
+
 export declare interface SaveOptions extends PathOptions, DoActionOptions {
     /**will seek to post if 'new' otherwise will patch */
     mode?: BladeMode;
@@ -985,6 +1053,11 @@ export declare function useAuth(): BTAuth;
 
 export declare function useAuthUrl(): string;
 
+export declare function useBladeUI(bladeProps: BladeProps, blade: Ref<ComponentPublicInstance | null>, handle: Ref<ComponentPublicInstance | null>): {
+    isMobile: Ref<boolean>;
+    variant: Ref<BladeVariant | undefined>;
+};
+
 export declare function useCosmetics(): BTCosmetics;
 
 export declare interface UseCosmeticsOptions<T extends BaseCosmeticTheme> {
@@ -1085,6 +1158,33 @@ export declare interface UseFiltersOptions {
 
 export declare function useId(pattern?: string): string;
 
+export declare function useItem(props: ItemProps, options?: UseItemOptions): {
+    asyncItem: Ref<any>;
+    deleteItem: (dItem: MaybeRefOrGetter<any>) => void;
+    errorMsg: ComputedRef<string | undefined>;
+    isChanged: Ref<boolean>;
+    isDeletable: ComputedRef<boolean>;
+    isEditing: ComputedRef<boolean>;
+    isEditable: ComputedRef<boolean>;
+    isLoading: ComputedRef<boolean>;
+    isRestorable: ComputedRef<boolean>;
+    isSaveable: ComputedRef<boolean>;
+    loadingMsg: ComputedRef<string | undefined>;
+    mode: Ref<BladeMode>;
+    refresh: (options?: RefreshOptions) => Promise<void>;
+    restoreItem: (dItem: MaybeRefOrGetter<any>) => void;
+    saveItem: (dItem: MaybeRefOrGetter<any>, options?: SaveItemOptions) => void;
+    showError: ShallowRef<boolean>;
+    toggleMode: () => void;
+};
+
+export declare interface UseItemOptions {
+    storeMode?: StoreMode;
+    storageMode?: StorageMode;
+    useRouteSrc?: boolean;
+    useBladeSrc?: boolean;
+}
+
 /**
  * PROPS first
  * ROUTE second
@@ -1094,7 +1194,7 @@ export declare function useId(pattern?: string): string;
  * @param options
  */
 export declare function useList(props: ListProps, emit?: ListEvents, options?: UseListOptions): {
-    add: (variant: BladeVariant) => void;
+    add: (variant: BladeVariant_2) => void;
     asyncItems: Ref<any[]>;
     currentPage: Ref<number>;
     deleteItem: (dItem: MaybeRefOrGetter<any>) => void;
@@ -1155,11 +1255,11 @@ export declare function useList(props: ListProps, emit?: ListEvents, options?: U
     isLoading: ComputedRef<boolean>;
     isRestorable: ComputedRef<(item: any) => boolean>;
     loadingMsg: ComputedRef<string | undefined>;
-    refresh: (options?: RefreshOptions) => Promise<void>;
+    refresh: (options?: RefreshOptions_2) => Promise<void>;
     restoreItem: (dItem: MaybeRefOrGetter<any>) => void;
     searchString: Ref<string | undefined>;
     selectedFilters: Ref<number[]>;
-    selectItem: (rItem: any, variant: BladeVariant) => void;
+    selectItem: (rItem: any, variant: BladeVariant_2) => void;
     showError: ShallowRef<boolean>;
     showInactive: Ref<boolean>;
     showSearch: ShallowRef<boolean>;
@@ -1233,8 +1333,8 @@ export declare function usePWA(): BTPWA;
 
 export declare function useResizable(target: MaybeRefOrGetter_2<ComponentPublicInstance | null>, options?: UseResizeOptions): {
     resizingIsOn: Ref<boolean>;
-    turnResizingOn: (handles?: ResizeHandle[], variant?: BladeVariant) => void;
-    turnResizingOff: (variant?: BladeVariant | undefined) => void;
+    turnResizingOn: (handles?: ResizeHandle[], variant?: BladeVariant_2) => void;
+    turnResizingOff: (variant?: BladeVariant_2 | undefined) => void;
 };
 
 export declare interface UseResizeOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bt-core-app",
-  "version": "1.4.37",
+  "version": "1.4.39",
   "description": "Core app tools for some basic features like navigation, authentication, server apis, and cosmetics",
   "homepage": "https://github.com/BlitzItTech/bt-core",
   "bugs": {