tinybase 5.0.0-beta.26 → 5.0.0-beta.28

package/@types/ui-react-inspector/with-schemas/index.d.ts

@@ -45,11 +45,15 @@ export type CustomCell<
   /**
    * An optional string that will be used as the label at the top of the table
    * column for this Cell.
+   * @category Prop
+   * @since v4.1.0
    */
   label?: string;
   /**
    * An optional custom component for rendering each Cell in the Table (to
    * override the default CellView component).
+   * @category Prop
+   * @since v4.1.0
    */
   component?: ComponentType<
     CellPropsForTableIdAndCellId<Schemas, TableId, CellId>
@@ -57,6 +61,8 @@ export type CustomCell<
   /**
    * An optional function for generating extra props for each custom Cell
    * component based on Row and Cell Id.
+   * @category Prop
+   * @since v4.1.0
    */
   getComponentProps?: (rowId: Id, cellId: CellId) => ExtraProps;
 };
@@ -71,16 +77,22 @@ export type CustomResultCell<Schemas extends OptionalSchemas> = {
   /**
    * An optional string that will be used as the label at the top of the table
    * column for this Cell.
+   * @category Prop
+   * @since v4.1.0
    */
   label?: string;
   /**
    * An optional custom component for rendering each Cell in the ResultTable (to
    * override the default ResultCellView component).
+   * @category Prop
+   * @since v4.1.0
    */
   component?: ComponentType<ResultCellProps<Schemas>>;
   /**
    * An optional function for generating extra props for each custom Cell
    * component based on Row and Cell Id.
+   * @category Prop
+   * @since v4.1.0
    */
   getComponentProps?: (rowId: Id, cellId: Id) => ExtraProps;
 };
@@ -95,16 +107,22 @@ export type CustomResultCell<Schemas extends OptionalSchemas> = {
 export type HtmlTableProps = {
   /**
    * A string className to use on the root of the resulting element.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly className?: string;
   /**
    * Whether a header row should be rendered at the top of the table, defaulting
    * to `true`.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly headerRow?: boolean;
   /**
    * Whether an Id column should be rendered on the left of the table,
    * defaulting to `true`.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly idColumn?: boolean;
 };
@@ -125,17 +143,23 @@ export type TableInHtmlTableProps<
     ? {
         /**
    * The Id of the Table in the Store to be rendered.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly tableId: TableId;
         /**
    * The Store to be accessed: omit for the default context Store, provide an Id
    * for a named context Store, or provide an explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly store?: StoreOrStoreId<Schemas>;
         /**
    * Whether the Cells should be editable. This affects the default CellView
    * component (to use the EditableCellView component instead) but of course
    * will not affect custom Cell components if you have set them.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly editable?: boolean;
         /**
@@ -144,6 +168,8 @@ export type TableInHtmlTableProps<
    * Cell Ids as keys, and with a value that can either be a string label to
    * show in the column header, or a CustomCell object to further configure the
    * column.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly customCells?:
           | CellIdFromSchema<Schemas[0], TableId>[]
@@ -172,34 +198,48 @@ export type SortedTableInHtmlTableProps<
     ? {
         /**
    * The Id of the Table in the Store to be rendered.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly tableId: TableId;
         /**
    * The Id of the Cell whose values are used for the sorting. If omitted, the
    * view will sort the Row Id itself.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly cellId?: CellIdFromSchema<Schemas[0], TableId>;
         /**
    * Whether the sorting should be in descending order.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly descending?: boolean;
         /**
    * The number of Row Ids to skip for pagination purposes.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly offset?: number;
         /**
    * The maximum number of Row Ids to return.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly limit?: number;
         /**
    * The Store to be accessed: omit for the default context Store, provide an Id
    * for a named context Store, or provide an explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly store?: StoreOrStoreId<Schemas>;
         /**
    * Whether the Cells should be editable. This affects the default CellView
    * component (to use the EditableCellView component instead) but of course
    * will not affect custom Cell components if you have set them.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly editable?: boolean;
         /**
@@ -208,6 +248,8 @@ export type SortedTableInHtmlTableProps<
    * Cell Ids as keys, and with a value that can either be a string label to
    * show in the column header, or a CustomCell object to further configure the
    * column.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly customCells?:
           | CellIdFromSchema<Schemas[0], TableId>[]
@@ -219,17 +261,23 @@ export type SortedTableInHtmlTableProps<
         /**
    * Whether the table should be interactive such that clicking a header changes
    * the sorting and/or direction.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly sortOnClick?: boolean;
         /**
    * Either `true` to show the default SortedTablePaginator for the Table, or
    * provide your own paginator component that takes SortedTablePaginatorProps.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly paginator?: boolean | ComponentType<SortedTablePaginatorProps>;
         /**
    * A function that is called whenever the sorting or pagination of the Table
    * is changed by the user, invoked with the sorted Cell Id, whether descending
    * or not, and the offset of the pagination.
+   * @category Prop
+   * @since v4.1.0
    */
         readonly onChange?: (
           sortAndOffset: [
@@ -252,22 +300,30 @@ export type ValuesInHtmlTableProps<Schemas extends OptionalSchemas> = {
   /**
    * The Store to be accessed: omit for the default context Store, provide an Id
    * for a named context Store, or provide an explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly store?: StoreOrStoreId<Schemas>;
   /**
    * Whether the Values should be editable. This affects the default ValueView
    * component (to use the EditableValueView component instead) but of course
    * will not affect a custom valueComponent if you have set one.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly editable?: boolean;
   /**
    * A custom component for rendering each Value in the Store (to override the
    * default ValueView component).
+   * @category Prop
+   * @since v4.1.0
    */
   readonly valueComponent?: ComponentType<ValueProps<Schemas>>;
   /**
    * A function for generating extra props for each custom Value component based
    * on its Id.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly getValueComponentProps?: (valueId: Id) => ExtraProps;
 };
@@ -281,22 +337,30 @@ export type ValuesInHtmlTableProps<Schemas extends OptionalSchemas> = {
 export type SliceInHtmlTableProps<Schemas extends OptionalSchemas> = {
   /**
    * The Id of the Index in the Indexes object.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly indexId: Id;
   /**
    * The Id of the Slice in the Index to be rendered.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly sliceId: Id;
   /**
    * The Indexes object to be accessed: omit for the default context Indexes
    * object, provide an Id for a named context Indexes object, or provide an
    * explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly indexes?: IndexesOrIndexesId<Schemas>;
   /**
    * Whether the Cells should be editable. This affects the default CellView
    * component (to use the EditableCellView component instead) but of course
    * will not affect custom Cell components if you have set them.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly editable?: boolean;
   /**
@@ -305,6 +369,8 @@ export type SliceInHtmlTableProps<Schemas extends OptionalSchemas> = {
    * Cell Ids as keys, and with a value that can either be a string label to
    * show in the column header, or a CustomCell object to further configure the
    * column.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly customCells?:
     | Ids
@@ -327,18 +393,24 @@ export type RelationshipInHtmlTableProps<Schemas extends OptionalSchemas> = {
   /**
    * The Id of the relationship in the Relationships object for which the
    * relationship Table Rows will be rendered.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly relationshipId: Id;
   /**
    * The Relationships object to be accessed: omit for the default context
    * Relationships object, provide an Id for a named context Relationships
    * object, or provide an explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly relationships?: RelationshipsOrRelationshipsId<Schemas>;
   /**
    * Whether the Cells should be editable. This affects the default CellView
    * component (to use the EditableCellView component instead) but of course
    * will not affect custom Cell components if you have set them.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly editable?: boolean;
   /**
@@ -348,6 +420,8 @@ export type RelationshipInHtmlTableProps<Schemas extends OptionalSchemas> = {
    * pairs as keys, and with a value that can either be a string label to show
    * in the column header, or a CustomCell object to further configure the
    * column.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly customCells?:
     | Ids
@@ -364,12 +438,16 @@ export type ResultTableInHtmlTableProps<Schemas extends OptionalSchemas> = {
   /**
    * The Id of the query in the Queries object for which the ResultTable will be
    * rendered.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly queryId: Id;
   /**
    * The Queries object to be accessed: omit for the default context Queries
    * object, provide an Id for a named context Queries object, or provide an
    * explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly queries?: QueriesOrQueriesId<Schemas>;
   /**
@@ -378,6 +456,8 @@ export type ResultTableInHtmlTableProps<Schemas extends OptionalSchemas> = {
    * desired Cell Ids as keys, and with a value that can either be a string
    * label to show in the column header, or a ResultCustomCell object to further
    * configure the column.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly customCells?:
     | Ids
@@ -396,29 +476,41 @@ export type ResultSortedTableInHtmlTableProps<Schemas extends OptionalSchemas> =
     /**
    * The Id of the query in the Queries object for which the ResultTable will be
    * rendered.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly queryId: Id;
     /**
    * The Id of the Cell whose values are used for the sorting. If omitted, the
    * view will sort the Row Id itself.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly cellId?: Id;
     /**
    * Whether the sorting should be in descending order.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly descending?: boolean;
     /**
    * The number of Row Ids to skip for pagination purposes.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly offset?: number;
     /**
    * The maximum number of Row Ids to return.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly limit?: number;
     /**
    * The Queries object to be accessed: omit for the default context Queries
    * object, provide an Id for a named context Queries object, or provide an
    * explicit reference.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly queries?: QueriesOrQueriesId<Schemas>;
     /**
@@ -427,6 +519,8 @@ export type ResultSortedTableInHtmlTableProps<Schemas extends OptionalSchemas> =
    * desired Cell Ids as keys, and with a value that can either be a string
    * label to show in the column header, or a ResultCustomCell object to further
    * configure the column.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly customCells?:
       | Ids
@@ -434,18 +528,24 @@ export type ResultSortedTableInHtmlTableProps<Schemas extends OptionalSchemas> =
     /**
    * Whether the table should be interactive such that clicking a header changes
    * the sorting and/or direction.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly sortOnClick?: boolean;
     /**
    * Either `true` to show the default SortedTablePaginator for the ResultTable,
    * or provide your own paginator component that takes
    * SortedTablePaginatorProps.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly paginator?: boolean | ComponentType<SortedTablePaginatorProps>;
     /**
    * A function that is called whenever the sorting or pagination of the
    * ResultTable is changed by the user, invoked with the sorted Cell Id,
    * whether descending or not, and the offset of the pagination.
+   * @category Prop
+   * @since v4.1.0
    */
     readonly onChange?: (
       sortAndOffset: [
@@ -466,28 +566,40 @@ export type SortedTablePaginatorProps = {
   /**
    * An event that will fire when the offset is updated, called with the new
    * offset.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly onChange: (offset: number) => void;
   /**
    * The number of Row Ids to skip for pagination.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly offset?: number;
   /**
    * The maximum number of Row Ids being returned.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly limit?: number;
   /**
    * The total number of Row Ids in the paginated table.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly total: number;
   /**
    * A noun to use in the pagination label for a single row, defaulting to
    * 'row'.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly singular?: string;
   /**
    * A noun to use in the pagination label for multiple rows, defaulting to the
    * value of the singular noun suffixed with the letter 's'.
+   * @category Prop
+   * @since v4.1.0
    */
   readonly plural?: string;
 };
@@ -495,17 +607,21 @@ export type SortedTablePaginatorProps = {
 /**
  * InspectorProps props are used to configure the Inspector component.
  * @category Props
- * @since v4.1.0
+ * @since v5.0.0
  */
 export type InspectorProps = {
   /**
    * An optional string to indicate where you want the inspector to first
    * appear.
+   * @category Prop
+   * @since v5.0.0
    */
   readonly position?: 'top' | 'right' | 'bottom' | 'left' | 'full';
   /**
    * An optional boolean to indicate whether the inspector should start in the
    * opened state.
+   * @category Prop
+   * @since v5.0.0
    */
   readonly open?: boolean;
 };
@@ -1864,7 +1980,7 @@ export type WithSchemas<Schemas extends OptionalSchemas> = {
  * // -> '<aside id="tinybaseInspector">'
  * ```
  * @category Development components
- * @since v4.1.0
+ * @since v5.0.0
  */
   Inspector: (props: InspectorProps) => ComponentReturnType;
 };

package/@types/with-schemas/index.d.cts

@@ -1,6 +1,7 @@
 /**
  * This is everything.
  * @packageDocumentation
+ * @since v1.0.0
  */
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment

package/@types/with-schemas/index.d.ts

@@ -1,6 +1,7 @@
 /**
  * This is everything.
  * @packageDocumentation
+ * @since v1.0.0
  */
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment

package/cjs/es6/index.cjs

@@ -1268,8 +1268,8 @@ const Persists = {
 };
 const scheduleRunning = mapNew();
 const scheduleActions = mapNew();
-const getStoreFunctions = (persistable = Persists.StoreOnly, store) =>
-  persistable != Persists.StoreOnly && store.isMergeable()
+const getStoreFunctions = (persist = Persists.StoreOnly, store) =>
+  persist != Persists.StoreOnly && store.isMergeable()
     ? [
         1,
         store.getMergeableContent,
@@ -1278,7 +1278,7 @@ const getStoreFunctions = (persistable = Persists.StoreOnly, store) =>
           !objIsEmpty(changedTables) || !objIsEmpty(changedValues),
         store.setDefaultContent,
       ]
-    : persistable != Persists.MergeableStoreOnly
+    : persist != Persists.MergeableStoreOnly
       ? [
           0,
           store.getContent,
@@ -1295,7 +1295,7 @@ const createCustomPersister = (
   addPersisterListener,
   delPersisterListener,
   onIgnoredError,
-  persistable,
+  persist,
   extra = {},
   scheduleId = [],
 ) => {
@@ -1313,7 +1313,7 @@ const createCustomPersister = (
     getChanges,
     hasChanges,
     setDefaultContent,
-  ] = getStoreFunctions(persistable, store);
+  ] = getStoreFunctions(persist, store);
   const run = () =>
     __async$1(void 0, null, function* () {
       /* istanbul ignore else */
@@ -1556,18 +1556,20 @@ var __async = (__this, __arguments, generator) => {
     step((generator = generator.apply(__this, __arguments)).next());
   });
 };
-const RESPONSE = 0;
-const GET_CONTENT_HASHES = 1;
-const CONTENT_HASHES = 2;
-const CONTENT_DIFF = 3;
-const GET_TABLE_DIFF = 4;
-const GET_ROW_DIFF = 5;
-const GET_CELL_DIFF = 6;
-const GET_VALUE_DIFF = 7;
+const Message = {
+  Response: 0,
+  GetContentHashes: 1,
+  ContentHashes: 2,
+  ContentDiff: 3,
+  GetTableDiff: 4,
+  GetRowDiff: 5,
+  GetCellDiff: 6,
+  GetValueDiff: 7,
+};
 const createCustomSynchronizer = (
   store,
   send,
-  onReceive,
+  registerReceive,
   destroyImpl,
   requestTimeoutSeconds,
   onIgnoredError,
@@ -1577,41 +1579,39 @@ const createCustomSynchronizer = (
   let sends = 0;
   let receives = 0;
   const pendingRequests = mapNew();
-  onReceive((fromClientId, requestId, messageType, messageBody) => {
+  registerReceive((fromClientId, requestId, message, body) => {
     receives++;
-    if (messageType == RESPONSE) {
+    if (message == Message.Response) {
       ifNotUndefined(
         mapGet(pendingRequests, requestId),
         ([toClientId, handleResponse]) =>
           isUndefined(toClientId) || toClientId == fromClientId
-            ? handleResponse(messageBody, fromClientId)
+            ? handleResponse(body, fromClientId)
             : /* istanbul ignore next */
               0,
       );
-    } else if (messageType == CONTENT_HASHES && persister.isAutoLoading()) {
-      getChangesFromOtherStore(fromClientId, messageBody).then((changes) => {
+    } else if (message == Message.ContentHashes && persister.isAutoLoading()) {
+      getChangesFromOtherStore(fromClientId, body).then((changes) => {
         persisterListener == null ? void 0 : persisterListener(void 0, changes);
       });
-    } else if (messageType == CONTENT_DIFF && persister.isAutoLoading()) {
-      persisterListener == null
-        ? void 0
-        : persisterListener(void 0, messageBody);
+    } else if (message == Message.ContentDiff && persister.isAutoLoading()) {
+      persisterListener == null ? void 0 : persisterListener(void 0, body);
     } else {
       ifNotUndefined(
-        messageType == GET_CONTENT_HASHES && persister.isAutoSaving()
+        message == Message.GetContentHashes && persister.isAutoSaving()
           ? store.getMergeableContentHashes()
-          : messageType == GET_TABLE_DIFF
-            ? store.getMergeableTableDiff(messageBody)
-            : messageType == GET_ROW_DIFF
-              ? store.getMergeableRowDiff(messageBody)
-              : messageType == GET_CELL_DIFF
-                ? store.getMergeableCellDiff(messageBody)
-                : messageType == GET_VALUE_DIFF
-                  ? store.getMergeableValueDiff(messageBody)
+          : message == Message.GetTableDiff
+            ? store.getMergeableTableDiff(body)
+            : message == Message.GetRowDiff
+              ? store.getMergeableRowDiff(body)
+              : message == Message.GetCellDiff
+                ? store.getMergeableCellDiff(body)
+                : message == Message.GetValueDiff
+                  ? store.getMergeableValueDiff(body)
                   : void 0,
         (response) => {
           sends++;
-          send(fromClientId, requestId, RESPONSE, response);
+          send(fromClientId, requestId, Message.Response, response);
         },
       );
     }
@@ -1620,13 +1620,13 @@ const createCustomSynchronizer = (
     __async(
       void 0,
       [_0, _1, ..._2],
-      function* (toClientId, messageType, messageBody = EMPTY_STRING) {
+      function* (toClientId, message, body = EMPTY_STRING) {
         return promiseNew((resolve, reject) => {
           const requestId = getUniqueId();
           const timeout = setTimeout(() => {
             collDel(pendingRequests, requestId);
             reject(
-              `No response from ${toClientId != null ? toClientId : 'anyone'} to '${messageType}'`,
+              `No response from ${toClientId != null ? toClientId : 'anyone'} to '${message}'`,
             );
           }, requestTimeoutSeconds * 1e3);
           mapSet(pendingRequests, requestId, [
@@ -1638,7 +1638,7 @@ const createCustomSynchronizer = (
             },
           ]);
           sends++;
-          send(toClientId, requestId, messageType, messageBody);
+          send(toClientId, requestId, message, body);
         });
       },
     );
@@ -1663,7 +1663,7 @@ const createCustomSynchronizer = (
       if (isUndefined(otherContentHashes)) {
         [otherContentHashes, otherClientId] = yield request(
           otherClientId,
-          GET_CONTENT_HASHES,
+          Message.GetContentHashes,
         );
       }
       const [otherTablesHash, otherValuesHash] = otherContentHashes;
@@ -1672,21 +1672,21 @@ const createCustomSynchronizer = (
       if (tablesHash != otherTablesHash) {
         const [newTables, differentTableHashes] = (yield request(
           otherClientId,
-          GET_TABLE_DIFF,
+          Message.GetTableDiff,
           store.getMergeableTableHashes(),
         ))[0];
         tablesChanges = newTables;
         if (!objIsEmpty(differentTableHashes)) {
           const [newRows, differentRowHashes] = (yield request(
             otherClientId,
-            GET_ROW_DIFF,
+            Message.GetRowDiff,
             store.getMergeableRowHashes(differentTableHashes),
           ))[0];
           mergeTablesStamps(tablesChanges, newRows);
           if (!objIsEmpty(differentRowHashes)) {
             const newCells = (yield request(
               otherClientId,
-              GET_CELL_DIFF,
+              Message.GetCellDiff,
               store.getMergeableCellHashes(differentRowHashes),
             ))[0];
             mergeTablesStamps(tablesChanges, newCells);
@@ -1699,7 +1699,7 @@ const createCustomSynchronizer = (
           ? stampNewObj()
           : (yield request(
               otherClientId,
-              GET_VALUE_DIFF,
+              Message.GetValueDiff,
               store.getMergeableValueHashes(),
             ))[0],
         1,
@@ -1716,9 +1716,14 @@ const createCustomSynchronizer = (
     __async(void 0, null, function* () {
       sends++;
       if (changes) {
-        send(null, null, CONTENT_DIFF, changes);
+        send(null, null, Message.ContentDiff, changes);
       } else {
-        send(null, null, CONTENT_HASHES, store.getMergeableContentHashes());
+        send(
+          null,
+          null,
+          Message.ContentHashes,
+          store.getMergeableContentHashes(),
+        );
       }
     });
   const addPersisterListener = (listener) => (persisterListener = listener);
@@ -4345,6 +4350,7 @@ const createMergeableStore = (uniqueId) => {
   return objFreeze(mergeableStore);
 };
 
+exports.Message = Message;
 exports.Persists = Persists;
 exports.createCheckpoints = createCheckpoints;
 exports.createCustomPersister = createCustomPersister;