tinybase 5.0.0-beta.0 → 5.0.0-beta.10

package/lib/debug/tools.js

@@ -36,9 +36,10 @@ const slice = (arrayOrString, start, end) => arrayOrString.slice(start, end);
 const size = (arrayOrString) => arrayOrString.length;
 const promiseAll = async (promises) => promise.all(promises);
 
-const getCellOrValueType = (cell) => {
-  const type = getTypeOf(cell);
-  return isTypeStringOrBoolean(type) || (type == NUMBER && isFiniteNumber(cell))
+const getCellOrValueType = (cellOrValue) => {
+  const type = getTypeOf(cellOrValue);
+  return isTypeStringOrBoolean(type) ||
+    (type == NUMBER && isFiniteNumber(cellOrValue))
     ? type
     : void 0;
 };
@@ -56,8 +57,7 @@ const arrayShift = (array) => array.shift();
 
 const object = Object;
 const getPrototypeOf = (obj) => object.getPrototypeOf(obj);
-const objIds = object.keys;
-const objFreeze = object.freeze;
+const objEntries = object.entries;
 const isObject = (obj) =>
   !isUndefined(obj) &&
   ifNotUndefined(
@@ -65,10 +65,13 @@ const isObject = (obj) =>
     (objPrototype) =>
       objPrototype == object.prototype ||
       isUndefined(getPrototypeOf(objPrototype)),
+    /* istanbul ignore next */
     () => true,
   );
-const objMap = (obj, cb) =>
-  arrayMap(object.entries(obj), ([id, value]) => cb(value, id));
+const objIds = object.keys;
+const objFreeze = object.freeze;
+const objToArray = (obj, cb) =>
+  arrayMap(objEntries(obj), ([id, value]) => cb(value, id));
 const objSize = (obj) => size(objIds(obj));
 const objIsEmpty = (obj) => isObject(obj) && objSize(obj) == 0;
 
@@ -85,9 +88,11 @@ const mapMap = (coll, cb) =>
   arrayMap([...(coll?.entries() ?? [])], ([key, value]) => cb(value, key));
 const mapSet = (map, key, value) =>
   isUndefined(value) ? (collDel(map, key), map) : map?.set(key, value);
-const mapEnsure = (map, key, getDefaultValue) => {
+const mapEnsure = (map, key, getDefaultValue, hadExistingValue) => {
   if (!collHas(map, key)) {
     mapSet(map, key, getDefaultValue());
+  } else {
+    hadExistingValue?.(mapGet(map, key));
   }
   return mapGet(map, key);
 };
@@ -99,6 +104,7 @@ const A_FUNCTION_FOR = 'A function for';
 const AND_REGISTERS =
   ', and registers a listener so that any changes to that result will cause a re-render';
 const CALLBACK = 'Callback';
+const CHANGES = 'Changes';
 const COUNT = 'Count';
 const DEL = 'Del';
 const DEPS = 'Deps';
@@ -126,7 +132,6 @@ const SORTED_ARGS = ', descending?: boolean, offset?: number, limit?: number';
 const SQUARE_BRACKETS = '[]';
 const THE_STORE = 'the Store';
 const TRANSACTION = 'Transaction';
-const TRANSACTION_CHANGES = TRANSACTION + 'Changes';
 const TRANSACTION_ = lower(TRANSACTION);
 const TRANSACTION_DOC =
   'Execute a ' + TRANSACTION_ + ' to make multiple mutations';
@@ -155,9 +160,7 @@ const getTheContentOfTheStoreDoc = (content = 0, verb, set = 0, has = 0) =>
   (set ? ' when setting it' : EMPTY_STRING);
 const getRowTypeDoc = (tableId, set = 0) =>
   REPRESENTS +
-  ` a Row when ${
-    set ? 's' : 'g'
-  }etting ${getTheContentOfDoc()} the '${tableId}' ` +
+  ` a Row when ${set ? 's' : 'g'}etting ${getTheContentOfDoc()} the '${tableId}' ` +
   TABLE;
 const getIdsDoc = (idsNoun, parentNoun, sorted = 0) =>
   `Gets ${sorted ? 'sorted, paginated' : 'the'} Ids of the ${idsNoun}s in ` +
@@ -372,9 +375,7 @@ const getCodeFunctions = () => {
   const getTypes = () =>
     mapMap(types, ([body, doc, generic, exported], name) => [
       comment(doc),
-      `${
-        exported ? EXPORT + ' ' : EMPTY_STRING
-      }type ${name}${generic} = ${body};`,
+      `${exported ? EXPORT + ' ' : EMPTY_STRING}type ${name}${generic} = ${body};`,
       EMPTY_STRING,
     ]);
   const getConstants = () =>
@@ -395,19 +396,21 @@ const getCodeFunctions = () => {
   ];
 };
 
-const getCreateFunction = (getFunction) => {
-  const getFunctionsByStore = /* @__PURE__ */ new WeakMap();
+const getCreateFunction = (getFunction, initFunction) => {
+  const thingsByStore = /* @__PURE__ */ new WeakMap();
   return (store) => {
-    if (!getFunctionsByStore.has(store)) {
-      getFunctionsByStore.set(store, getFunction(store));
+    if (!thingsByStore.has(store)) {
+      thingsByStore.set(store, getFunction(store));
     }
-    return getFunctionsByStore.get(store);
+    const thing = thingsByStore.get(store);
+    initFunction?.(thing);
+    return thing;
   };
 };
 
 const getSchemaFunctions = (tablesSchema, valuesSchema, addConstant) => {
   const mapTablesSchema = (callback) =>
-    objMap(tablesSchema, (_, tableId) => {
+    objToArray(tablesSchema, (_, tableId) => {
       return callback(
         tableId,
         camel(tableId, 1),
@@ -415,7 +418,7 @@ const getSchemaFunctions = (tablesSchema, valuesSchema, addConstant) => {
       );
     });
   const mapCellSchema = (tableId, callback) =>
-    objMap(tablesSchema[tableId], (cellSchema, cellId) =>
+    objToArray(tablesSchema[tableId], (cellSchema, cellId) =>
       callback(
         cellId,
         cellSchema[TYPE],
@@ -425,7 +428,7 @@ const getSchemaFunctions = (tablesSchema, valuesSchema, addConstant) => {
       ),
     );
   const mapValuesSchema = (callback) =>
-    objMap(valuesSchema, (valueSchema, valueId) =>
+    objToArray(valuesSchema, (valueSchema, valueId) =>
       callback(
         valueId,
         valueSchema[TYPE],
@@ -455,9 +458,7 @@ const getTypeFunctions = (
               ...mapCellSchema(
                 tableId,
                 (cellId, type, defaultValue) =>
-                  `'${cellId}'${
-                    isUndefined(defaultValue) ? '?' : EMPTY_STRING
-                  }: ${type}`,
+                  `'${cellId}'${isUndefined(defaultValue) ? '?' : EMPTY_STRING}: ${type}`,
               ),
             ) +
             '}',
@@ -792,9 +793,7 @@ const getTypeFunctions = (
       getFieldTypeList(
         ...mapValuesSchema(
           (valueId, type, defaultValue) =>
-            `'${valueId}'${
-              isUndefined(defaultValue) ? '?' : EMPTY_STRING
-            }: ${type}`,
+            `'${valueId}'${isUndefined(defaultValue) ? '?' : EMPTY_STRING}: ${type}`,
         ),
       ),
       getTheContentOfTheStoreDoc(2, 5),
@@ -894,8 +893,7 @@ const getTypeFunctions = (
   const getTransactionListenerType = (storeInstance, storeType) =>
     addType(
       TRANSACTION + LISTENER,
-      `(${storeInstance}: ${storeType}, getTransactionChanges: GetTransactionChanges, getTransactionLog: GetTransactionLog)` +
-        RETURNS_VOID,
+      `(${storeInstance}: ${storeType})` + RETURNS_VOID,
       A_FUNCTION_FOR + ' listening to the completion of a ' + TRANSACTION_,
     );
   return [getTablesTypes, getValuesTypes, getTransactionListenerType];
@@ -910,9 +908,7 @@ const storeListener = (
   beforeParameters = EMPTY_STRING,
   afterParameters = EMPTY_STRING,
 ) =>
-  `store.${method}(${
-    beforeParameters ? beforeParameters + ', ' : EMPTY_STRING
-  }proxy(listener)${afterParameters ? ', ' + afterParameters : EMPTY_STRING})`;
+  `store.${method}(${beforeParameters ? beforeParameters + ', ' : EMPTY_STRING}proxy(listener)${afterParameters ? ', ' + afterParameters : EMPTY_STRING})`;
 const getStoreCoreApi = (tablesSchema, valuesSchema, module) => {
   const [
     build,
@@ -1521,14 +1517,7 @@ const getStoreCoreApi = (tablesSchema, valuesSchema, module) => {
               `[${CELL_ID}]: {[${addConstant(
                 snake(TYPE),
                 `'${TYPE}'`,
-              )}]: ${addConstant(snake(type), `'${type}'`)}${
-                isUndefined(defaultValue)
-                  ? EMPTY_STRING
-                  : `, [${addConstant(snake(DEFAULT), `'${DEFAULT}'`)}]: ` +
-                    (isString(defaultValue)
-                      ? addConstant(snake(defaultValue), `'${defaultValue}'`)
-                      : defaultValue)
-              }},`,
+              )}]: ${addConstant(snake(type), `'${type}'`)}${isUndefined(defaultValue) ? EMPTY_STRING : `, [${addConstant(snake(DEFAULT), `'${DEFAULT}'`)}]: ` + (isString(defaultValue) ? addConstant(snake(defaultValue), `'${defaultValue}'`) : defaultValue)}},`,
           ),
           `},`,
         ]),
@@ -1690,14 +1679,7 @@ const getStoreCoreApi = (tablesSchema, valuesSchema, module) => {
         `[${VALUE_ID}]: {[${addConstant(
           snake(TYPE),
           `'${TYPE}'`,
-        )}]: ${addConstant(snake(type), `'${type}'`)}${
-          isUndefined(defaultValue)
-            ? EMPTY_STRING
-            : `, [${addConstant(snake(DEFAULT), `'${DEFAULT}'`)}]: ` +
-              (isString(defaultValue)
-                ? addConstant(snake(defaultValue), `'${defaultValue}'`)
-                : defaultValue)
-        }},`,
+        )}]: ${addConstant(snake(type), `'${type}'`)}${isUndefined(defaultValue) ? EMPTY_STRING : `, [${addConstant(snake(DEFAULT), `'${DEFAULT}'`)}]: ` + (isString(defaultValue) ? addConstant(snake(defaultValue), `'${defaultValue}'`) : defaultValue)}},`,
       ]),
       '})',
     );
@@ -1721,13 +1703,13 @@ const getStoreCoreApi = (tablesSchema, valuesSchema, module) => {
     '[tables, values]',
   );
   addProxyMethod(
-    2,
+    7,
     EMPTY_STRING,
-    TRANSACTION_CHANGES,
+    'applyChanges',
     storeType,
-    `Applies a set of ${TRANSACTION_CHANGES} to the Store`,
-    'transactionChanges: ' + TRANSACTION_CHANGES,
-    'transactionChanges',
+    `Applies a set of ${CHANGES} to the Store`,
+    'changes: ' + CHANGES,
+    'changes',
   );
   mapForEach(mapCellOrValueTypes, (type, mapCellType) =>
     addType(
@@ -1744,9 +1726,8 @@ const getStoreCoreApi = (tablesSchema, valuesSchema, module) => {
     'IdOrNull',
     JSON$1,
     'Store',
-    TRANSACTION_CHANGES,
+    CHANGES,
   );
-  addImport(0, TINYBASE, 'Get' + TRANSACTION_CHANGES, 'GetTransactionLog');
   addProxyMethod(
     0,
     EMPTY_STRING,
@@ -2016,16 +1997,12 @@ const getStoreUiReactApi = (
       const lines = location
         ? [
             EXPORT +
-              ` const ${name}: typeof ${name}Decl = ${generic}(${parameters}): ${
-                returnType == 1 ? 'any' : returnType
-              } =>`,
+              ` const ${name}: typeof ${name}Decl = ${generic}(${parameters}): ${returnType == 1 ? 'any' : returnType} =>`,
             body,
           ]
         : [
             EXPORT +
-              ` function ${name}${generic}(${parameters}): ${
-                returnType == 1 ? 'ComponentReturnType' : returnType
-              };`,
+              ` function ${name}${generic}(${parameters}): ${returnType == 1 ? 'ComponentReturnType' : returnType};`,
           ];
       if (!location) {
         arrayUnshift(lines, comment(doc));
@@ -3135,7 +3112,7 @@ const getStoreUiReactApi = (
     PROVIDER,
     `{${storeInstance}, ${storeInstance}ById, children}: ` +
       providerPropsType +
-      ' & {children: React.ReactNode}',
+      ' & {readonly children: React.ReactNode}',
     [
       '{',
       USE_CONTEXT,