feat: add isExportedAttributes to persisted stores for prevent export…

… attributes
Lomray-Software · Jul 1, 2024 · 4c7fdf2 · 4c7fdf2
1 parent 8bc0c68
commit 4c7fdf2
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 9 deletions.
diff --git a/src/make-exported.ts b/src/make-exported.ts
@@ -16,6 +16,14 @@ const makeExported = <T extends object>(
   store[exportedPropName] = { ...(shouldExtend ? store?.[exportedPropName] ?? {} : {}), ...props };
 };
 
+/**
+ * Excluded in persistStore level
+ * @see IPersistOptions
+ */
+const isPropExcludedInPersist = (store: TAnyStore): boolean => {
+  return store?.['libStorageOptions']?.isExportedAttributes || false;
+};
+
 /**
  * Check if store prop is observable exported
  */
@@ -31,7 +39,12 @@ const isPropSimpleExported = (store: TAnyStore, prop: string): boolean =>
 /**
  * Check if store prop is excluded from export
  */
-const isPropExcludedFromExport = (store: TAnyStore, prop: string): boolean =>
-  store?.[exportedPropName]?.[prop] === 'excluded';
+const isPropExcludedFromExport = (
+  store: TAnyStore,
+  prop: string,
+  withNotExported = false,
+): boolean =>
+  store?.[exportedPropName]?.[prop] === 'excluded' ||
+  (!withNotExported && isPropExcludedInPersist(store));
 
 export { makeExported, isPropObservableExported, isPropSimpleExported, isPropExcludedFromExport };
diff --git a/src/manager.ts b/src/manager.ts
@@ -571,14 +571,14 @@ class Manager {
   /**
    * Get store state
    */
-  public getStoreState(store: TAnyStore): Record<string, any> {
-    return store.toJSON?.() ?? Manager.getObservableProps(store);
+  public getStoreState(store: TAnyStore, withNotExported = false): Record<string, any> {
+    return store.toJSON?.() ?? Manager.getObservableProps(store, withNotExported);
   }
 
   /**
    * Get store's state
    */
-  public toJSON(ids?: string[]): Record<string, any> {
+  public toJSON(ids?: string[], isIncludeExported = false): Record<string, any> {
     const result = {};
     const stores = Array.isArray(ids)
       ? ids.reduce((res, id) => {
@@ -591,7 +591,7 @@ class Manager {
       : this.stores;
 
     for (const [storeId, store] of stores.entries()) {
-      result[storeId] = this.getStoreState(store);
+      result[storeId] = this.getStoreState(store, isIncludeExported);
     }
 
     return result;
@@ -606,7 +606,7 @@ class Manager {
     }
 
     try {
-      await this.storage.saveStoreData(store, this.getStoreState(store));
+      await this.storage.saveStoreData(store, this.getStoreState(store, true));
 
       return true;
     } catch (e) {
@@ -619,13 +619,14 @@ class Manager {
   /**
    * Get observable store props (fields)
    */
-  public static getObservableProps(store: TAnyStore): Record<string, any> {
+  public static getObservableProps(store: TAnyStore, withNotExported = false): Record<string, any> {
     const props = toJS(store);
 
     return Object.entries(props).reduce(
       (res, [prop, value]) => ({
         ...res,
-        ...((isObservableProp(store, prop) && !isPropExcludedFromExport(store, prop)) ||
+        ...((isObservableProp(store, prop) &&
+          !isPropExcludedFromExport(store, prop, withNotExported)) ||
         isPropSimpleExported(store, prop)
           ? { [prop]: value }
           : {}),

diff --git a/src/types.ts b/src/types.ts
@@ -156,4 +156,7 @@ export interface IPersistOptions {
     // first storage => *, by default
     [storageId: string]: string[];
   };
+  // disable export all store observable props except props marker with makeExported
+  // default: false
+  isExportedAttributes?: boolean;
 }