tinybase 2.0.0 → 2.1.0-beta.0

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.
Files changed (123) hide show
  1. package/lib/checkpoints.js +1 -1
  2. package/lib/checkpoints.js.gz +0 -0
  3. package/lib/common.js +1 -1
  4. package/lib/common.js.gz +0 -0
  5. package/lib/debug/checkpoints.js +7 -1
  6. package/lib/debug/common.js +1 -4
  7. package/lib/debug/indexes.d.ts +36 -10
  8. package/lib/debug/indexes.js +57 -25
  9. package/lib/debug/metrics.d.ts +1 -1
  10. package/lib/debug/metrics.js +19 -2
  11. package/lib/debug/persisters.d.ts +5 -5
  12. package/lib/debug/queries.js +18 -2
  13. package/lib/debug/relationships.d.ts +3 -3
  14. package/lib/debug/relationships.js +19 -2
  15. package/lib/debug/store.js +8 -2
  16. package/lib/debug/tinybase.js +53 -27
  17. package/lib/debug/ui-react.d.ts +17 -17
  18. package/lib/debug/ui-react.js +2 -1
  19. package/lib/es6/checkpoints.d.ts +946 -0
  20. package/lib/es6/checkpoints.js +1 -0
  21. package/lib/es6/checkpoints.js.gz +0 -0
  22. package/lib/es6/common.d.ts +115 -0
  23. package/lib/es6/common.js +1 -0
  24. package/lib/es6/common.js.gz +0 -0
  25. package/lib/es6/indexes.d.ts +967 -0
  26. package/lib/es6/indexes.js +1 -0
  27. package/lib/es6/indexes.js.gz +0 -0
  28. package/lib/es6/metrics.d.ts +829 -0
  29. package/lib/es6/metrics.js +1 -0
  30. package/lib/es6/metrics.js.gz +0 -0
  31. package/lib/es6/persisters.d.ts +717 -0
  32. package/lib/es6/persisters.js +1 -0
  33. package/lib/es6/persisters.js.gz +0 -0
  34. package/lib/es6/queries.d.ts +3026 -0
  35. package/lib/es6/queries.js +1 -0
  36. package/lib/es6/queries.js.gz +0 -0
  37. package/lib/es6/relationships.d.ts +1203 -0
  38. package/lib/es6/relationships.js +1 -0
  39. package/lib/es6/relationships.js.gz +0 -0
  40. package/lib/es6/store.d.ts +3572 -0
  41. package/lib/es6/store.js +1 -0
  42. package/lib/es6/store.js.gz +0 -0
  43. package/lib/es6/tinybase.d.ts +14 -0
  44. package/lib/es6/tinybase.js +1 -0
  45. package/lib/es6/tinybase.js.gz +0 -0
  46. package/lib/es6/ui-react.d.ts +9777 -0
  47. package/lib/es6/ui-react.js +1 -0
  48. package/lib/es6/ui-react.js.gz +0 -0
  49. package/lib/indexes.d.ts +36 -10
  50. package/lib/indexes.js +1 -1
  51. package/lib/indexes.js.gz +0 -0
  52. package/lib/metrics.d.ts +1 -1
  53. package/lib/metrics.js +1 -1
  54. package/lib/metrics.js.gz +0 -0
  55. package/lib/persisters.d.ts +5 -5
  56. package/lib/queries.js +1 -1
  57. package/lib/queries.js.gz +0 -0
  58. package/lib/relationships.d.ts +3 -3
  59. package/lib/relationships.js +1 -1
  60. package/lib/relationships.js.gz +0 -0
  61. package/lib/store.js +1 -1
  62. package/lib/store.js.gz +0 -0
  63. package/lib/tinybase.js +1 -1
  64. package/lib/tinybase.js.gz +0 -0
  65. package/lib/ui-react.d.ts +17 -17
  66. package/lib/umd/checkpoints.d.ts +946 -0
  67. package/lib/umd/checkpoints.js +1 -1
  68. package/lib/umd/checkpoints.js.gz +0 -0
  69. package/lib/umd/common.d.ts +115 -0
  70. package/lib/umd/common.js +1 -1
  71. package/lib/umd/common.js.gz +0 -0
  72. package/lib/umd/indexes.d.ts +967 -0
  73. package/lib/umd/indexes.js +1 -1
  74. package/lib/umd/indexes.js.gz +0 -0
  75. package/lib/umd/metrics.d.ts +829 -0
  76. package/lib/umd/metrics.js +1 -1
  77. package/lib/umd/metrics.js.gz +0 -0
  78. package/lib/umd/persisters.d.ts +717 -0
  79. package/lib/umd/queries.d.ts +3026 -0
  80. package/lib/umd/queries.js +1 -1
  81. package/lib/umd/queries.js.gz +0 -0
  82. package/lib/umd/relationships.d.ts +1203 -0
  83. package/lib/umd/relationships.js +1 -1
  84. package/lib/umd/relationships.js.gz +0 -0
  85. package/lib/umd/store.d.ts +3572 -0
  86. package/lib/umd/store.js +1 -1
  87. package/lib/umd/store.js.gz +0 -0
  88. package/lib/umd/tinybase.d.ts +14 -0
  89. package/lib/umd/tinybase.js +1 -1
  90. package/lib/umd/tinybase.js.gz +0 -0
  91. package/lib/umd/ui-react.d.ts +9777 -0
  92. package/lib/umd-es6/checkpoints.d.ts +946 -0
  93. package/lib/umd-es6/checkpoints.js +1 -0
  94. package/lib/umd-es6/checkpoints.js.gz +0 -0
  95. package/lib/umd-es6/common.d.ts +115 -0
  96. package/lib/umd-es6/common.js +1 -0
  97. package/lib/umd-es6/common.js.gz +0 -0
  98. package/lib/umd-es6/indexes.d.ts +967 -0
  99. package/lib/umd-es6/indexes.js +1 -0
  100. package/lib/umd-es6/indexes.js.gz +0 -0
  101. package/lib/umd-es6/metrics.d.ts +829 -0
  102. package/lib/umd-es6/metrics.js +1 -0
  103. package/lib/umd-es6/metrics.js.gz +0 -0
  104. package/lib/umd-es6/persisters.d.ts +717 -0
  105. package/lib/umd-es6/persisters.js +1 -0
  106. package/lib/umd-es6/persisters.js.gz +0 -0
  107. package/lib/umd-es6/queries.d.ts +3026 -0
  108. package/lib/umd-es6/queries.js +1 -0
  109. package/lib/umd-es6/queries.js.gz +0 -0
  110. package/lib/umd-es6/relationships.d.ts +1203 -0
  111. package/lib/umd-es6/relationships.js +1 -0
  112. package/lib/umd-es6/relationships.js.gz +0 -0
  113. package/lib/umd-es6/store.d.ts +3572 -0
  114. package/lib/umd-es6/store.js +1 -0
  115. package/lib/umd-es6/store.js.gz +0 -0
  116. package/lib/umd-es6/tinybase.d.ts +14 -0
  117. package/lib/umd-es6/tinybase.js +1 -0
  118. package/lib/umd-es6/tinybase.js.gz +0 -0
  119. package/lib/umd-es6/ui-react.d.ts +9777 -0
  120. package/lib/umd-es6/ui-react.js +1 -0
  121. package/lib/umd-es6/ui-react.js.gz +0 -0
  122. package/package.json +2 -1
  123. package/readme.md +12 -12
package/lib/ui-react.d.ts CHANGED
@@ -285,7 +285,7 @@ export function useCreateStore(
285
285
  * component.
286
286
  *
287
287
  * The useStore hook lets you either get a reference to the default Store (when
288
- * called without an parameter), or one of the Store objects that are named by
288
+ * called without a parameter), or one of the Store objects that are named by
289
289
  * Id (when called with an Id parameter).
290
290
  *
291
291
  * @param id An optional Id for accessing a Store that was named with an Id in
@@ -2551,7 +2551,7 @@ export function useCreateMetrics(
2551
2551
  * through every component.
2552
2552
  *
2553
2553
  * The useMetrics hook lets you either get a reference to the default Metrics
2554
- * object (when called without an parameter), or one of the Metrics objects that
2554
+ * object (when called without a parameter), or one of the Metrics objects that
2555
2555
  * are named by Id (when called with an Id parameter).
2556
2556
  *
2557
2557
  * @param id An optional Id for accessing a Metrics object that was named with
@@ -2903,7 +2903,7 @@ export function useCreateIndexes(
2903
2903
  * through every component.
2904
2904
  *
2905
2905
  * The useIndexes hook lets you either get a reference to the default Indexes
2906
- * object (when called without an parameter), or one of the Indexes objects that
2906
+ * object (when called without a parameter), or one of the Indexes objects that
2907
2907
  * are named by Id (when called with an Id parameter).
2908
2908
  *
2909
2909
  * @param id An optional Id for accessing an Indexes object that was named with
@@ -3463,7 +3463,7 @@ export function useCreateRelationships(
3463
3463
  * props through every component.
3464
3464
  *
3465
3465
  * The useRelationships hook lets you either get a reference to the default
3466
- * Relationships object (when called without an parameter), or one of the
3466
+ * Relationships object (when called without a parameter), or one of the
3467
3467
  * Relationships objects that are named by Id (when called with an Id
3468
3468
  * parameter).
3469
3469
  *
@@ -4257,7 +4257,7 @@ export function useCreateQueries(
4257
4257
  * through every component.
4258
4258
  *
4259
4259
  * The useQueries hook lets you either get a reference to the default Queries
4260
- * object (when called without an parameter), or one of the Queries objects that
4260
+ * object (when called without a parameter), or one of the Queries objects that
4261
4261
  * are named by Id (when called with an Id parameter).
4262
4262
  *
4263
4263
  * @param id An optional Id for accessing a Queries object that was named with
@@ -5695,7 +5695,7 @@ export function useCreateCheckpoints(
5695
5695
  * props through every component.
5696
5696
  *
5697
5697
  * The useCheckpoints hook lets you either get a reference to the default
5698
- * Checkpoints object (when called without an parameter), or one of the
5698
+ * Checkpoints object (when called without a parameter), or one of the
5699
5699
  * Checkpoints objects that are named by Id (when called with an Id parameter).
5700
5700
  *
5701
5701
  * @param id An optional Id for accessing a Checkpoints object that was named
@@ -6876,7 +6876,7 @@ export type SliceProps = {
6876
6876
 
6877
6877
  /**
6878
6878
  * RemoteRowProps props are used for components that refer to a single
6879
- * Relationship in an Relationships object, and where you want to render a
6879
+ * Relationship in a Relationships object, and where you want to render a
6880
6880
  * remote Row based on a local Row, such as in the RemoteRowView component.
6881
6881
  *
6882
6882
  * @category Props
@@ -6915,7 +6915,7 @@ export type RemoteRowProps = {
6915
6915
 
6916
6916
  /**
6917
6917
  * LocalRowsProps props are used for components that refer to a single
6918
- * Relationship in an Relationships object, and where you want to render local
6918
+ * Relationship in a Relationships object, and where you want to render local
6919
6919
  * Rows based on a remote Row, such as the LocalRowsView component.
6920
6920
  *
6921
6921
  * @category Props
@@ -6958,7 +6958,7 @@ export type LocalRowsProps = {
6958
6958
 
6959
6959
  /**
6960
6960
  * LinkedRowsProps props are used for components that refer to a single
6961
- * Relationship in an Relationships object, and where you want to render a
6961
+ * Relationship in a Relationships object, and where you want to render a
6962
6962
  * linked list of Rows starting from a first Row, such as the LinkedRowsView
6963
6963
  * component.
6964
6964
  *
@@ -7177,7 +7177,7 @@ export type ResultCellProps = {
7177
7177
 
7178
7178
  /**
7179
7179
  * CheckpointProps props are used for components that refer to a single
7180
- * checkpoint in an Checkpoints object, such as the CheckpointView component.
7180
+ * checkpoint in a Checkpoints object, such as the CheckpointView component.
7181
7181
  *
7182
7182
  * @category Props
7183
7183
  */
@@ -8406,7 +8406,7 @@ export function IndexView(props: IndexProps): ComponentReturnType;
8406
8406
  * @param props The props for this component.
8407
8407
  * @returns A rendering of the remote Row, or nothing, if not present.
8408
8408
  * @example
8409
- * This example creates an Relationships object outside the application, which
8409
+ * This example creates a Relationships object outside the application, which
8410
8410
  * is used in the RemoteRowView component by reference. A change to the Row Ids
8411
8411
  * re-renders the component.
8412
8412
  *
@@ -8538,7 +8538,7 @@ export function RemoteRowView(props: RemoteRowProps): ComponentReturnType;
8538
8538
  * @param props The props for this component.
8539
8539
  * @returns A rendering of the local Row objects, or nothing, if not present.
8540
8540
  * @example
8541
- * This example creates an Relationships object outside the application, which
8541
+ * This example creates a Relationships object outside the application, which
8542
8542
  * is used in the LocalRowsView component by reference. A change to the Row Ids
8543
8543
  * re-renders the component.
8544
8544
  *
@@ -8671,7 +8671,7 @@ export function LocalRowsView(props: LocalRowsProps): ComponentReturnType;
8671
8671
  * @param props The props for this component.
8672
8672
  * @returns A rendering of the local Row objects, or nothing, if not present.
8673
8673
  * @example
8674
- * This example creates an Relationships object outside the application, which
8674
+ * This example creates a Relationships object outside the application, which
8675
8675
  * is used in the LinkedRowsView component by reference. A change to the Row Ids
8676
8676
  * re-renders the component.
8677
8677
  *
@@ -9335,7 +9335,7 @@ export function ResultTableView(props: ResultTableProps): ComponentReturnType;
9335
9335
  * @param props The props for this component.
9336
9336
  * @returns A rendering of the checkpoint: its label if present, or Id.
9337
9337
  * @example
9338
- * This example creates an Checkpoints object outside the application, which is
9338
+ * This example creates a Checkpoints object outside the application, which is
9339
9339
  * used in the CheckpointView component by reference to render a checkpoint with
9340
9340
  * a label (with its Id for readability).
9341
9341
  *
@@ -9392,7 +9392,7 @@ export function CheckpointView(props: CheckpointProps): ComponentReturnType;
9392
9392
  * @param props The props for this component.
9393
9393
  * @returns A rendering of the previous checkpoints, if present.
9394
9394
  * @example
9395
- * This example creates an Checkpoints object outside the application, which is
9395
+ * This example creates a Checkpoints object outside the application, which is
9396
9396
  * used in the BackwardCheckpointsView component by reference to render a list
9397
9397
  * of previous checkpoints.
9398
9398
  *
@@ -9526,7 +9526,7 @@ export function BackwardCheckpointsView(
9526
9526
  * @param props The props for this component.
9527
9527
  * @returns A rendering of the current checkpoint, if present.
9528
9528
  * @example
9529
- * This example creates an Checkpoints object outside the application, which is
9529
+ * This example creates a Checkpoints object outside the application, which is
9530
9530
  * used in the CurrentCheckpointView component by reference to render the
9531
9531
  * current checkpoints.
9532
9532
  *
@@ -9662,7 +9662,7 @@ export function CurrentCheckpointView(
9662
9662
  * @param props The props for this component.
9663
9663
  * @returns A rendering of the future checkpoints, if present.
9664
9664
  * @example
9665
- * This example creates an Checkpoints object outside the application, which is
9665
+ * This example creates a Checkpoints object outside the application, which is
9666
9666
  * used in the ForwardCheckpointsView component by reference to render a list
9667
9667
  * of future checkpoints.
9668
9668
  *