@legendapp/state 3.0.0-alpha.2 → 3.0.0-alpha.20

package/sync-plugins/_transformObjectFields.js

@@ -0,0 +1,114 @@
+'use strict';
+
+var state = require('@legendapp/state');
+
+// src/sync-plugins/_transformObjectFields.ts
+var validateMap;
+function transformObjectFields(dataIn, map) {
+  if (process.env.NODE_ENV === "development") {
+    validateMap(map);
+  }
+  let ret = dataIn;
+  if (dataIn) {
+    if (dataIn === state.symbolDelete)
+      return dataIn;
+    if (state.isString(dataIn)) {
+      return map[dataIn];
+    }
+    ret = {};
+    const dict = Object.keys(map).length === 1 && map["_dict"];
+    for (const key in dataIn) {
+      let v = dataIn[key];
+      if (dict) {
+        ret[key] = transformObjectFields(v, dict);
+      } else {
+        const mapped = map[key];
+        if (mapped === void 0) {
+          if (key !== "@") {
+            ret[key] = v;
+            if (process.env.NODE_ENV === "development" || process.env.NODE_ENV === "test") {
+              console.error("A fatal field transformation error has occurred", key, dataIn, map);
+            }
+          }
+        } else if (mapped !== null) {
+          if (v !== void 0 && v !== null) {
+            if (map[key + "_val"]) {
+              const mapChild = map[key + "_val"];
+              if (state.isArray(v)) {
+                v = v.map((vChild) => mapChild[vChild]);
+              } else {
+                v = mapChild[v];
+              }
+            } else if (map[key + "_arr"] && state.isArray(v)) {
+              const mapChild = map[key + "_arr"];
+              v = v.map((vChild) => transformObjectFields(vChild, mapChild));
+            } else if (state.isObject(v)) {
+              if (map[key + "_obj"]) {
+                v = transformObjectFields(v, map[key + "_obj"]);
+              } else if (map[key + "_dict"]) {
+                const mapChild = map[key + "_dict"];
+                const out = {};
+                for (const keyChild in v) {
+                  out[keyChild] = transformObjectFields(v[keyChild], mapChild);
+                }
+                v = out;
+              }
+            }
+          }
+          ret[mapped] = v;
+        }
+      }
+    }
+  }
+  return ret;
+}
+var invertedMaps = /* @__PURE__ */ new WeakMap();
+function invertFieldMap(obj) {
+  const existing = invertedMaps.get(obj);
+  if (existing)
+    return existing;
+  const target = {};
+  for (const key in obj) {
+    const val = obj[key];
+    if (key === "_dict") {
+      target[key] = invertFieldMap(val);
+    } else if (key.endsWith("_obj") || key.endsWith("_dict") || key.endsWith("_arr") || key.endsWith("_val")) {
+      const keyMapped = obj[key.replace(/_obj|_dict|_arr|_val$/, "")];
+      const suffix = key.match(/_obj|_dict|_arr|_val$/)[0];
+      target[keyMapped + suffix] = invertFieldMap(val);
+    } else if (typeof val === "string") {
+      target[val] = key;
+    }
+  }
+  invertedMaps.set(obj, target);
+  return target;
+}
+var fieldTransformToTransform = (fieldTransform) => ({
+  load(value) {
+    const inverted = invertFieldMap(fieldTransform);
+    return transformObjectFields(value, inverted);
+  },
+  save(value) {
+    return transformObjectFields(value, fieldTransform);
+  }
+});
+if (process.env.NODE_ENV === "development") {
+  validateMap = function(record) {
+    const values = Object.values(record).filter((value) => {
+      if (state.isObject(value)) {
+        validateMap(value);
+      } else {
+        return state.isString(value);
+      }
+    });
+    const uniques = Array.from(new Set(values));
+    if (values.length !== uniques.length) {
+      console.error("Field transform map has duplicate values", record, values.length, uniques.length);
+    }
+    return record;
+  };
+}
+
+exports.fieldTransformToTransform = fieldTransformToTransform;
+exports.invertFieldMap = invertFieldMap;
+exports.transformObjectFields = transformObjectFields;

package/sync-plugins/_transformObjectFields.mjs

@@ -0,0 +1,110 @@
+import { symbolDelete, isString, isArray, isObject } from '@legendapp/state';
+
+// src/sync-plugins/_transformObjectFields.ts
+var validateMap;
+function transformObjectFields(dataIn, map) {
+  if (process.env.NODE_ENV === "development") {
+    validateMap(map);
+  }
+  let ret = dataIn;
+  if (dataIn) {
+    if (dataIn === symbolDelete)
+      return dataIn;
+    if (isString(dataIn)) {
+      return map[dataIn];
+    }
+    ret = {};
+    const dict = Object.keys(map).length === 1 && map["_dict"];
+    for (const key in dataIn) {
+      let v = dataIn[key];
+      if (dict) {
+        ret[key] = transformObjectFields(v, dict);
+      } else {
+        const mapped = map[key];
+        if (mapped === void 0) {
+          if (key !== "@") {
+            ret[key] = v;
+            if (process.env.NODE_ENV === "development" || process.env.NODE_ENV === "test") {
+              console.error("A fatal field transformation error has occurred", key, dataIn, map);
+            }
+          }
+        } else if (mapped !== null) {
+          if (v !== void 0 && v !== null) {
+            if (map[key + "_val"]) {
+              const mapChild = map[key + "_val"];
+              if (isArray(v)) {
+                v = v.map((vChild) => mapChild[vChild]);
+              } else {
+                v = mapChild[v];
+              }
+            } else if (map[key + "_arr"] && isArray(v)) {
+              const mapChild = map[key + "_arr"];
+              v = v.map((vChild) => transformObjectFields(vChild, mapChild));
+            } else if (isObject(v)) {
+              if (map[key + "_obj"]) {
+                v = transformObjectFields(v, map[key + "_obj"]);
+              } else if (map[key + "_dict"]) {
+                const mapChild = map[key + "_dict"];
+                const out = {};
+                for (const keyChild in v) {
+                  out[keyChild] = transformObjectFields(v[keyChild], mapChild);
+                }
+                v = out;
+              }
+            }
+          }
+          ret[mapped] = v;
+        }
+      }
+    }
+  }
+  return ret;
+}
+var invertedMaps = /* @__PURE__ */ new WeakMap();
+function invertFieldMap(obj) {
+  const existing = invertedMaps.get(obj);
+  if (existing)
+    return existing;
+  const target = {};
+  for (const key in obj) {
+    const val = obj[key];
+    if (key === "_dict") {
+      target[key] = invertFieldMap(val);
+    } else if (key.endsWith("_obj") || key.endsWith("_dict") || key.endsWith("_arr") || key.endsWith("_val")) {
+      const keyMapped = obj[key.replace(/_obj|_dict|_arr|_val$/, "")];
+      const suffix = key.match(/_obj|_dict|_arr|_val$/)[0];
+      target[keyMapped + suffix] = invertFieldMap(val);
+    } else if (typeof val === "string") {
+      target[val] = key;
+    }
+  }
+  invertedMaps.set(obj, target);
+  return target;
+}
+var fieldTransformToTransform = (fieldTransform) => ({
+  load(value) {
+    const inverted = invertFieldMap(fieldTransform);
+    return transformObjectFields(value, inverted);
+  },
+  save(value) {
+    return transformObjectFields(value, fieldTransform);
+  }
+});
+if (process.env.NODE_ENV === "development") {
+  validateMap = function(record) {
+    const values = Object.values(record).filter((value) => {
+      if (isObject(value)) {
+        validateMap(value);
+      } else {
+        return isString(value);
+      }
+    });
+    const uniques = Array.from(new Set(values));
+    if (values.length !== uniques.length) {
+      console.error("Field transform map has duplicate values", record, values.length, uniques.length);
+    }
+    return record;
+  };
+}
+
+export { fieldTransformToTransform, invertFieldMap, transformObjectFields };

package/sync-plugins/crud.d.mts

@@ -1,42 +1,37 @@
-import { SyncedGetParams, SyncedOptions, SyncedSetParams } from '@legendapp/state/sync';
+import { SyncedGetParams, SyncedOptions, SyncedSetParams, SyncedSubscribeParams } from '@legendapp/state/sync';
 
 type CrudAsOption = 'Map' | 'object' | 'value' | 'array';
 type CrudResult<T> = T;
-interface SyncedCrudPropsSingle<TRemote, TLocal> {
-    get?: (params: SyncedGetParams) => Promise<CrudResult<TRemote | null>> | CrudResult<TRemote | null>;
+interface SyncedCrudPropsSingle<TRemote extends object, TLocal> {
+    get?: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote | null>> | CrudResult<TRemote | null>;
     initial?: InitialValue<TLocal, 'value'>;
     as?: never | 'value';
 }
-interface SyncedCrudPropsMany<TRemote, TLocal, TAsOption extends CrudAsOption> {
-    list?: (params: SyncedGetParams) => Promise<CrudResult<TRemote[] | null>> | CrudResult<TRemote[] | null>;
+interface SyncedCrudPropsMany<TRemote extends object, TLocal, TAsOption extends CrudAsOption> {
+    list?: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote[] | null>> | CrudResult<TRemote[] | null>;
     as?: TAsOption;
     initial?: InitialValue<TLocal, TAsOption>;
 }
-interface SyncedCrudOnSavedParams<TRemote extends {
-    id: string | number;
-}, TLocal> {
+interface SyncedCrudOnSavedParams<TRemote extends object, TLocal> {
     saved: TLocal;
     input: TRemote;
     currentValue: TLocal;
     isCreate: boolean;
     props: SyncedCrudPropsBase<TRemote, TLocal>;
 }
-interface SyncedCrudPropsBase<TRemote extends {
-    id: string | number;
-}, TLocal = TRemote> extends Omit<SyncedOptions<TRemote, TLocal>, 'get' | 'set' | 'initial'> {
-    create?(input: TRemote, params: SyncedSetParams<TRemote>): Promise<CrudResult<TRemote> | null | undefined>;
-    update?(input: Partial<TRemote>, params: SyncedSetParams<TRemote>): Promise<CrudResult<Partial<TRemote> | null | undefined>>;
-    delete?(input: {
-        id: TRemote['id'];
-    }, params: SyncedSetParams<TRemote>): Promise<CrudResult<any>>;
+interface SyncedCrudPropsBase<TRemote extends object, TLocal = TRemote> extends Omit<SyncedOptions<TRemote, TLocal>, 'get' | 'set' | 'initial' | 'subscribe'> {
+    create?(input: TRemote, params: SyncedSetParams<TRemote>): Promise<CrudResult<TRemote> | null | undefined | void>;
+    update?(input: Partial<TRemote>, params: SyncedSetParams<TRemote>): Promise<CrudResult<Partial<TRemote> | null | undefined | void>>;
+    delete?(input: TRemote, params: SyncedSetParams<TRemote>): Promise<CrudResult<any>>;
     onSaved?(params: SyncedCrudOnSavedParams<TRemote, TLocal>): Partial<TLocal> | void;
-    onSavedUpdate?: 'createdUpdatedAt';
+    fieldId?: string;
     fieldUpdatedAt?: string;
     fieldCreatedAt?: string;
     fieldDeleted?: string;
     updatePartial?: boolean;
     changesSince?: 'all' | 'last-sync';
     generateId?: () => string | number;
+    subscribe?: (params: SyncedSubscribeParams<TRemote[]>) => (() => void) | void;
 }
 type InitialValue<TLocal, TAsOption extends CrudAsOption> = TAsOption extends 'Map' ? Map<string | number, TLocal> : TAsOption extends 'object' ? Record<string | number, TLocal> : TAsOption extends 'value' ? TLocal : TLocal[];
 type SyncedCrudReturnType<TLocal, TAsOption extends CrudAsOption> = TAsOption extends 'Map' ? Map<TLocal extends {
@@ -44,11 +39,7 @@ type SyncedCrudReturnType<TLocal, TAsOption extends CrudAsOption> = TAsOption ex
 } ? number : string, TLocal> : TAsOption extends 'object' ? Record<TLocal extends {
     id: number;
 } ? number : string, TLocal> : TAsOption extends 'value' ? TLocal : TLocal[];
-declare function syncedCrud<TRemote extends {
-    id: string | number;
-}, TLocal = TRemote>(props: SyncedCrudPropsBase<TRemote, TLocal> & SyncedCrudPropsSingle<TRemote, TLocal>): SyncedCrudReturnType<TLocal, 'value'>;
-declare function syncedCrud<TRemote extends {
-    id: string | number;
-}, TLocal = TRemote, TAsOption extends CrudAsOption = 'object'>(props: SyncedCrudPropsBase<TRemote, TLocal> & SyncedCrudPropsMany<TRemote, TLocal, TAsOption>): SyncedCrudReturnType<TLocal, Exclude<TAsOption, 'value'>>;
+declare function syncedCrud<TRemote extends object, TLocal = TRemote>(props: SyncedCrudPropsBase<TRemote, TLocal> & SyncedCrudPropsSingle<TRemote, TLocal>): SyncedCrudReturnType<TLocal, 'value'>;
+declare function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption extends CrudAsOption = 'object'>(props: SyncedCrudPropsBase<TRemote, TLocal> & SyncedCrudPropsMany<TRemote, TLocal, TAsOption>): SyncedCrudReturnType<TLocal, Exclude<TAsOption, 'value'>>;
 
 export { type CrudAsOption, type CrudResult, type SyncedCrudOnSavedParams, type SyncedCrudPropsBase, type SyncedCrudPropsMany, type SyncedCrudPropsSingle, type SyncedCrudReturnType, syncedCrud };

package/sync-plugins/crud.d.ts

@@ -1,42 +1,37 @@
-import { SyncedGetParams, SyncedOptions, SyncedSetParams } from '@legendapp/state/sync';
+import { SyncedGetParams, SyncedOptions, SyncedSetParams, SyncedSubscribeParams } from '@legendapp/state/sync';
 
 type CrudAsOption = 'Map' | 'object' | 'value' | 'array';
 type CrudResult<T> = T;
-interface SyncedCrudPropsSingle<TRemote, TLocal> {
-    get?: (params: SyncedGetParams) => Promise<CrudResult<TRemote | null>> | CrudResult<TRemote | null>;
+interface SyncedCrudPropsSingle<TRemote extends object, TLocal> {
+    get?: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote | null>> | CrudResult<TRemote | null>;
     initial?: InitialValue<TLocal, 'value'>;
     as?: never | 'value';
 }
-interface SyncedCrudPropsMany<TRemote, TLocal, TAsOption extends CrudAsOption> {
-    list?: (params: SyncedGetParams) => Promise<CrudResult<TRemote[] | null>> | CrudResult<TRemote[] | null>;
+interface SyncedCrudPropsMany<TRemote extends object, TLocal, TAsOption extends CrudAsOption> {
+    list?: (params: SyncedGetParams<TRemote>) => Promise<CrudResult<TRemote[] | null>> | CrudResult<TRemote[] | null>;
     as?: TAsOption;
     initial?: InitialValue<TLocal, TAsOption>;
 }
-interface SyncedCrudOnSavedParams<TRemote extends {
-    id: string | number;
-}, TLocal> {
+interface SyncedCrudOnSavedParams<TRemote extends object, TLocal> {
     saved: TLocal;
     input: TRemote;
     currentValue: TLocal;
     isCreate: boolean;
     props: SyncedCrudPropsBase<TRemote, TLocal>;
 }
-interface SyncedCrudPropsBase<TRemote extends {
-    id: string | number;
-}, TLocal = TRemote> extends Omit<SyncedOptions<TRemote, TLocal>, 'get' | 'set' | 'initial'> {
-    create?(input: TRemote, params: SyncedSetParams<TRemote>): Promise<CrudResult<TRemote> | null | undefined>;
-    update?(input: Partial<TRemote>, params: SyncedSetParams<TRemote>): Promise<CrudResult<Partial<TRemote> | null | undefined>>;
-    delete?(input: {
-        id: TRemote['id'];
-    }, params: SyncedSetParams<TRemote>): Promise<CrudResult<any>>;
+interface SyncedCrudPropsBase<TRemote extends object, TLocal = TRemote> extends Omit<SyncedOptions<TRemote, TLocal>, 'get' | 'set' | 'initial' | 'subscribe'> {
+    create?(input: TRemote, params: SyncedSetParams<TRemote>): Promise<CrudResult<TRemote> | null | undefined | void>;
+    update?(input: Partial<TRemote>, params: SyncedSetParams<TRemote>): Promise<CrudResult<Partial<TRemote> | null | undefined | void>>;
+    delete?(input: TRemote, params: SyncedSetParams<TRemote>): Promise<CrudResult<any>>;
     onSaved?(params: SyncedCrudOnSavedParams<TRemote, TLocal>): Partial<TLocal> | void;
-    onSavedUpdate?: 'createdUpdatedAt';
+    fieldId?: string;
     fieldUpdatedAt?: string;
     fieldCreatedAt?: string;
     fieldDeleted?: string;
     updatePartial?: boolean;
     changesSince?: 'all' | 'last-sync';
     generateId?: () => string | number;
+    subscribe?: (params: SyncedSubscribeParams<TRemote[]>) => (() => void) | void;
 }
 type InitialValue<TLocal, TAsOption extends CrudAsOption> = TAsOption extends 'Map' ? Map<string | number, TLocal> : TAsOption extends 'object' ? Record<string | number, TLocal> : TAsOption extends 'value' ? TLocal : TLocal[];
 type SyncedCrudReturnType<TLocal, TAsOption extends CrudAsOption> = TAsOption extends 'Map' ? Map<TLocal extends {
@@ -44,11 +39,7 @@ type SyncedCrudReturnType<TLocal, TAsOption extends CrudAsOption> = TAsOption ex
 } ? number : string, TLocal> : TAsOption extends 'object' ? Record<TLocal extends {
     id: number;
 } ? number : string, TLocal> : TAsOption extends 'value' ? TLocal : TLocal[];
-declare function syncedCrud<TRemote extends {
-    id: string | number;
-}, TLocal = TRemote>(props: SyncedCrudPropsBase<TRemote, TLocal> & SyncedCrudPropsSingle<TRemote, TLocal>): SyncedCrudReturnType<TLocal, 'value'>;
-declare function syncedCrud<TRemote extends {
-    id: string | number;
-}, TLocal = TRemote, TAsOption extends CrudAsOption = 'object'>(props: SyncedCrudPropsBase<TRemote, TLocal> & SyncedCrudPropsMany<TRemote, TLocal, TAsOption>): SyncedCrudReturnType<TLocal, Exclude<TAsOption, 'value'>>;
+declare function syncedCrud<TRemote extends object, TLocal = TRemote>(props: SyncedCrudPropsBase<TRemote, TLocal> & SyncedCrudPropsSingle<TRemote, TLocal>): SyncedCrudReturnType<TLocal, 'value'>;
+declare function syncedCrud<TRemote extends object, TLocal = TRemote, TAsOption extends CrudAsOption = 'object'>(props: SyncedCrudPropsBase<TRemote, TLocal> & SyncedCrudPropsMany<TRemote, TLocal, TAsOption>): SyncedCrudReturnType<TLocal, Exclude<TAsOption, 'value'>>;
 
 export { type CrudAsOption, type CrudResult, type SyncedCrudOnSavedParams, type SyncedCrudPropsBase, type SyncedCrudPropsMany, type SyncedCrudPropsSingle, type SyncedCrudReturnType, syncedCrud };