bt-core-app 1.4.32 → 1.4.34

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
@@ -307,15 +307,17 @@ declare interface CreateStoreBuilderOptions {
307
307
  builderQuery?: (params: any) => string;
308
308
  /**overrides the default */
309
309
  buildUrl?: (path: PathOptions) => string;
310
+ /**ideally required. For determining store mode */
311
+ navigation?: BTNavigation;
310
312
  }
311
313
 
312
314
  declare interface CreateStoreOptions {
313
315
  /**particularly what store syle to use */
314
- storeMode: StoreMode;
316
+ storeMode?: StoreMode;
315
317
  /**whether to store data locally or only for the duration of the session */
316
- storageMode: StorageMode;
317
- /**the name of this store */
318
- storeName: string;
318
+ storageMode?: StorageMode;
319
+ /**the nav item or name of this store */
320
+ nav: string;
319
321
  }
320
322
 
321
323
  export declare function createUrl(options: CreateUrlOptions): CreateUrlOptions;
@@ -712,6 +714,8 @@ export declare interface NavigationItem extends AuthItem {
712
714
  requiresAuth?: boolean;
713
715
  /**the name of the route to access individual items */
714
716
  singleName?: string;
717
+ /**what kind of store is needed for this api item */
718
+ storeMode?: StoreMode;
715
719
  /**this nav item is restricted to these subscriptions. So the user needs to have at least one of these subscription codes. */
716
720
  subscriptions?: string[];
717
721
  /**this nav item is preferred in this subscription codes. */
@@ -1206,13 +1210,13 @@ declare interface UseSessionStoreOptions {
1206
1210
  /**ideally required. For setting unique local storage keys */
1207
1211
  auth?: BTAuth;
1208
1212
  /**whether to store data locally or only for the duration of the session */
1209
- storageMode: 'session' | 'local-cache';
1213
+ storageMode?: 'session' | 'local-cache';
1210
1214
  /**build a query. Overrides the default */
1211
1215
  buildQuery?: (params: any) => string;
1212
1216
  /**overrides the default */
1213
1217
  buildUrl?: (path: PathOptions) => string;
1214
1218
  /**the name of this store */
1215
- storeName: string;
1219
+ storeName?: string;
1216
1220
  }
1217
1221
 
1218
1222
  export declare function useStore(options: CreateStoreOptions): BTStore;
@@ -1228,12 +1232,16 @@ export declare interface UseStoreOptions {
1228
1232
  builderQuery?: (params: any) => string;
1229
1233
  /**overrides the default */
1230
1234
  buildUrl?: (path: PathOptions) => string;
1235
+ /**the name of this store found in navigation */
1236
+ nav?: string;
1237
+ /**ideally required. For determining store mode */
1238
+ navigation?: BTNavigation;
1231
1239
  /**particularly what store syle to use */
1232
- storeMode: StoreMode;
1240
+ storeMode?: StoreMode;
1233
1241
  /**whether to store data locally or only for the duration of the session */
1234
- storageMode: StorageMode;
1242
+ storageMode?: StorageMode;
1235
1243
  /**the name of this store */
1236
- storeName: string;
1244
+ storeName?: string;
1237
1245
  }
1238
1246
 
1239
1247
  export declare function useTracker(data: MaybeRefOrGetter<any>, options?: UseTrackerOptions): {
@@ -1255,8 +1263,8 @@ declare interface UseWholeLastUpdateStoreOptions {
1255
1263
  api?: BTApi;
1256
1264
  /**ideally required. For setting unique local storage keys */
1257
1265
  auth?: BTAuth;
1258
- storageMode: 'session' | 'local-cache';
1259
- storeName: string;
1266
+ storageMode?: 'session' | 'local-cache';
1267
+ storeName?: string;
1260
1268
  }
1261
1269
 
1262
1270
  export declare function validEmail(email?: string): boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bt-core-app",
3
- "version": "1.4.32",
3
+ "version": "1.4.34",
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": {