shelving 1.310.0 → 1.312.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 (1994) hide show
  1. package/README.md +20 -0
  2. package/db/collection/Collection.d.ts +9 -1
  3. package/db/collection/Collection.js +10 -1
  4. package/db/collection/CollectionQueryItemsSchema.d.ts +1 -1
  5. package/db/collection/CollectionQueryItemsSchema.js +1 -1
  6. package/db/collection/CollectionQuerySchema.d.ts +3 -6
  7. package/db/collection/CollectionQuerySchema.js +4 -11
  8. package/db/provider/ValidationDBProvider.d.ts +11 -6
  9. package/db/provider/ValidationDBProvider.js +33 -28
  10. package/docs/api/APICache/call.md +15 -0
  11. package/docs/api/APICache/get.md +13 -0
  12. package/docs/api/APICache/invalidate.md +12 -0
  13. package/docs/api/APICache/invalidateAll.md +12 -0
  14. package/docs/api/APICache/refresh.md +12 -0
  15. package/docs/api/APICache/refreshAll.md +12 -0
  16. package/docs/api/APICache.md +49 -0
  17. package/docs/api/APIProvider/call.md +13 -0
  18. package/docs/api/APIProvider/createRequest.md +12 -0
  19. package/docs/api/APIProvider/fetch.md +12 -0
  20. package/docs/api/APIProvider/parseResponse.md +14 -0
  21. package/docs/api/APIProvider/renderURL.md +13 -0
  22. package/docs/api/APIProvider.md +52 -0
  23. package/docs/api/AnyEndpoint.md +16 -0
  24. package/docs/api/AnyEndpointHandler.md +16 -0
  25. package/docs/api/CachedAPIProvider/invalidate.md +12 -0
  26. package/docs/api/CachedAPIProvider/invalidateAll.md +12 -0
  27. package/docs/api/CachedAPIProvider/refresh.md +12 -0
  28. package/docs/api/CachedAPIProvider/refreshAll.md +12 -0
  29. package/docs/api/CachedAPIProvider.md +65 -0
  30. package/docs/api/ClientAPIProvider.md +60 -0
  31. package/docs/api/ClientAPIProviderOptions.md +24 -0
  32. package/docs/api/DELETE.md +43 -0
  33. package/docs/api/DebugAPIProvider.md +37 -0
  34. package/docs/api/Endpoint/handler.md +12 -0
  35. package/docs/api/Endpoint/match.md +12 -0
  36. package/docs/api/Endpoint/renderPath.md +13 -0
  37. package/docs/api/Endpoint/toString.md +12 -0
  38. package/docs/api/Endpoint.md +52 -0
  39. package/docs/api/EndpointCache/call.md +15 -0
  40. package/docs/api/EndpointCache/get.md +13 -0
  41. package/docs/api/EndpointCache/invalidate.md +12 -0
  42. package/docs/api/EndpointCache/invalidateAll.md +12 -0
  43. package/docs/api/EndpointCache/refresh.md +12 -0
  44. package/docs/api/EndpointCache/refreshAll.md +12 -0
  45. package/docs/api/EndpointCache.md +51 -0
  46. package/docs/api/EndpointCallback.md +25 -0
  47. package/docs/api/EndpointHandler.md +23 -0
  48. package/docs/api/EndpointHandlers.md +17 -0
  49. package/docs/api/EndpointStore.md +41 -0
  50. package/docs/api/EndpointType.md +17 -0
  51. package/docs/api/Endpoints.md +17 -0
  52. package/docs/api/GET.md +43 -0
  53. package/docs/api/HEAD.md +43 -0
  54. package/docs/api/HydratingAPIProvider.md +97 -0
  55. package/docs/api/JSONAPIProvider.md +37 -0
  56. package/docs/api/LoggingAPIProvider.md +53 -0
  57. package/docs/api/MockAPIFetchCall.md +27 -0
  58. package/docs/api/MockAPIProvider.md +57 -0
  59. package/docs/api/MockAPIRequestCall.md +32 -0
  60. package/docs/api/MockAPIResponseCall.md +29 -0
  61. package/docs/api/MockEndpointAPIProvider.md +50 -0
  62. package/docs/api/PATCH.md +43 -0
  63. package/docs/api/POST.md +43 -0
  64. package/docs/api/PUT.md +43 -0
  65. package/docs/api/PayloadType.md +17 -0
  66. package/docs/api/ThroughAPIProvider.md +59 -0
  67. package/docs/api/ValidationAPIProvider.md +39 -0
  68. package/docs/api/XMLAPIProvider.md +36 -0
  69. package/docs/api/handleEndpoints.md +50 -0
  70. package/docs/api.md +169 -0
  71. package/docs/bun/BunPostgresProvider.md +30 -0
  72. package/docs/bun.md +78 -0
  73. package/docs/cloudflare/CloudflareD1Provider.md +30 -0
  74. package/docs/cloudflare/CloudflareKVProvider.md +44 -0
  75. package/docs/cloudflare/D1Database/batch.md +10 -0
  76. package/docs/cloudflare/D1Database/exec.md +10 -0
  77. package/docs/cloudflare/D1Database/prepare.md +10 -0
  78. package/docs/cloudflare/D1Database.md +26 -0
  79. package/docs/cloudflare/D1ExecResult.md +22 -0
  80. package/docs/cloudflare/D1Meta.md +28 -0
  81. package/docs/cloudflare/D1PreparedStatement/bind.md +10 -0
  82. package/docs/cloudflare/D1PreparedStatement/first.md +10 -0
  83. package/docs/cloudflare/D1PreparedStatement/raw.md +10 -0
  84. package/docs/cloudflare/D1PreparedStatement/run.md +10 -0
  85. package/docs/cloudflare/D1PreparedStatement.md +26 -0
  86. package/docs/cloudflare/D1Result.md +24 -0
  87. package/docs/cloudflare/D1Value.md +12 -0
  88. package/docs/cloudflare/KVNamespace/delete.md +10 -0
  89. package/docs/cloudflare/KVNamespace/get.md +10 -0
  90. package/docs/cloudflare/KVNamespace/put.md +10 -0
  91. package/docs/cloudflare/KVNamespace.md +24 -0
  92. package/docs/cloudflare.md +96 -0
  93. package/docs/db/COLLECTION.md +34 -0
  94. package/docs/db/Collection.md +51 -0
  95. package/docs/db/CollectionCache/getItem.md +12 -0
  96. package/docs/db/CollectionCache/getQuery.md +12 -0
  97. package/docs/db/CollectionCache/refreshAll.md +12 -0
  98. package/docs/db/CollectionCache/refreshItem.md +12 -0
  99. package/docs/db/CollectionCache/refreshItems.md +12 -0
  100. package/docs/db/CollectionCache/refreshQueries.md +12 -0
  101. package/docs/db/CollectionCache/refreshQuery.md +12 -0
  102. package/docs/db/CollectionCache.md +52 -0
  103. package/docs/db/CollectionData.md +17 -0
  104. package/docs/db/CollectionIdentifier.md +17 -0
  105. package/docs/db/CollectionItem.md +18 -0
  106. package/docs/db/CollectionItemSchema.md +42 -0
  107. package/docs/db/CollectionItems.md +18 -0
  108. package/docs/db/CollectionItemsSchema.md +43 -0
  109. package/docs/db/CollectionName.md +17 -0
  110. package/docs/db/CollectionNames.md +12 -0
  111. package/docs/db/CollectionQueryItemsSchema.md +44 -0
  112. package/docs/db/CollectionQuerySchema.md +36 -0
  113. package/docs/db/Collections.md +17 -0
  114. package/docs/db/CollectionsDatabase.md +25 -0
  115. package/docs/db/DBCache/get.md +13 -0
  116. package/docs/db/DBCache/getItem.md +12 -0
  117. package/docs/db/DBCache/getQuery.md +12 -0
  118. package/docs/db/DBCache/refreshAll.md +12 -0
  119. package/docs/db/DBCache/refreshItem.md +12 -0
  120. package/docs/db/DBCache/refreshItems.md +12 -0
  121. package/docs/db/DBCache/refreshQueries.md +12 -0
  122. package/docs/db/DBCache/refreshQuery.md +12 -0
  123. package/docs/db/DBCache.md +52 -0
  124. package/docs/db/DBMigrator/migrate.md +12 -0
  125. package/docs/db/DBMigrator.md +36 -0
  126. package/docs/db/DBOperation.md +35 -0
  127. package/docs/db/DBOperations.md +17 -0
  128. package/docs/db/DBProvider/addItem.md +12 -0
  129. package/docs/db/DBProvider/countQuery.md +12 -0
  130. package/docs/db/DBProvider/deleteItem.md +12 -0
  131. package/docs/db/DBProvider/deleteQuery.md +14 -0
  132. package/docs/db/DBProvider/getFirst.md +12 -0
  133. package/docs/db/DBProvider/getItem.md +12 -0
  134. package/docs/db/DBProvider/getItemSequence.md +12 -0
  135. package/docs/db/DBProvider/getQuery.md +12 -0
  136. package/docs/db/DBProvider/getQuerySequence.md +12 -0
  137. package/docs/db/DBProvider/requireFirst.md +12 -0
  138. package/docs/db/DBProvider/requireItem.md +12 -0
  139. package/docs/db/DBProvider/setItem.md +12 -0
  140. package/docs/db/DBProvider/setQuery.md +14 -0
  141. package/docs/db/DBProvider/transact.md +19 -0
  142. package/docs/db/DBProvider/updateItem.md +12 -0
  143. package/docs/db/DBProvider/updateQuery.md +14 -0
  144. package/docs/db/DBProvider.md +95 -0
  145. package/docs/db/DebugDBProvider.md +29 -0
  146. package/docs/db/ID.md +6 -0
  147. package/docs/db/ItemStore.md +47 -0
  148. package/docs/db/MemoryDBProvider/clone.md +15 -0
  149. package/docs/db/MemoryDBProvider/createTable.md +13 -0
  150. package/docs/db/MemoryDBProvider/getTable.md +12 -0
  151. package/docs/db/MemoryDBProvider/setItems.md +12 -0
  152. package/docs/db/MemoryDBProvider.md +83 -0
  153. package/docs/db/MemoryTable/addItem.md +12 -0
  154. package/docs/db/MemoryTable/clone.md +15 -0
  155. package/docs/db/MemoryTable/countQuery.md +12 -0
  156. package/docs/db/MemoryTable/deleteItem.md +14 -0
  157. package/docs/db/MemoryTable/deleteQuery.md +10 -0
  158. package/docs/db/MemoryTable/generateUniqueID.md +13 -0
  159. package/docs/db/MemoryTable/getItem.md +12 -0
  160. package/docs/db/MemoryTable/getItemSequence.md +14 -0
  161. package/docs/db/MemoryTable/getItemTime.md +13 -0
  162. package/docs/db/MemoryTable/getQuery.md +12 -0
  163. package/docs/db/MemoryTable/getQuerySequence.md +14 -0
  164. package/docs/db/MemoryTable/getQueryTime.md +14 -0
  165. package/docs/db/MemoryTable/setItem.md +14 -0
  166. package/docs/db/MemoryTable/setItemSequence.md +13 -0
  167. package/docs/db/MemoryTable/setItems.md +10 -0
  168. package/docs/db/MemoryTable/setItemsSequence.md +10 -0
  169. package/docs/db/MemoryTable/setQuery.md +12 -0
  170. package/docs/db/MemoryTable/setQueryTime.md +14 -0
  171. package/docs/db/MemoryTable/updateItem.md +13 -0
  172. package/docs/db/MemoryTable/updateQuery.md +12 -0
  173. package/docs/db/MemoryTable.md +65 -0
  174. package/docs/db/MockDBCall.md +49 -0
  175. package/docs/db/MockDBProvider.md +36 -0
  176. package/docs/db/OptionalCollectionItem.md +18 -0
  177. package/docs/db/PostgresMigrator.md +19 -0
  178. package/docs/db/PostgresProvider.md +39 -0
  179. package/docs/db/QueryStore.md +52 -0
  180. package/docs/db/RecordingDBProvider/replay.md +14 -0
  181. package/docs/db/RecordingDBProvider/replayReads.md +13 -0
  182. package/docs/db/RecordingDBProvider/replayWrites.md +13 -0
  183. package/docs/db/RecordingDBProvider.md +72 -0
  184. package/docs/db/SQLColumn.md +24 -0
  185. package/docs/db/SQLFragment.md +35 -0
  186. package/docs/db/SQLMigrator/getCreateTableColumns.md +12 -0
  187. package/docs/db/SQLMigrator/getCreateTableQuery.md +12 -0
  188. package/docs/db/SQLMigrator/getGeneratedTableColumns.md +12 -0
  189. package/docs/db/SQLMigrator/getMigrations.md +12 -0
  190. package/docs/db/SQLMigrator/migrate.md +12 -0
  191. package/docs/db/SQLMigrator.md +29 -0
  192. package/docs/db/SQLProvider/exec.md +12 -0
  193. package/docs/db/SQLProvider/sql.md +12 -0
  194. package/docs/db/SQLProvider/sqlClauses.md +12 -0
  195. package/docs/db/SQLProvider/sqlConcat.md +12 -0
  196. package/docs/db/SQLProvider/sqlExtract.md +13 -0
  197. package/docs/db/SQLProvider/sqlFilter.md +12 -0
  198. package/docs/db/SQLProvider/sqlIdentifier.md +12 -0
  199. package/docs/db/SQLProvider/sqlLimit.md +13 -0
  200. package/docs/db/SQLProvider/sqlOrder.md +14 -0
  201. package/docs/db/SQLProvider/sqlSetters.md +12 -0
  202. package/docs/db/SQLProvider/sqlSort.md +12 -0
  203. package/docs/db/SQLProvider/sqlUpdate.md +15 -0
  204. package/docs/db/SQLProvider/sqlUpdates.md +12 -0
  205. package/docs/db/SQLProvider/sqlValues.md +12 -0
  206. package/docs/db/SQLProvider/sqlWhere.md +14 -0
  207. package/docs/db/SQLProvider.md +61 -0
  208. package/docs/db/SQLTable.md +30 -0
  209. package/docs/db/SQLTableColumn.md +22 -0
  210. package/docs/db/SQLiteMigrator.md +19 -0
  211. package/docs/db/SQLiteProvider.md +43 -0
  212. package/docs/db/StorageDBProvider.md +98 -0
  213. package/docs/db/StorageTable.md +31 -0
  214. package/docs/db/ThroughDBProvider/cloneWith.md +12 -0
  215. package/docs/db/ThroughDBProvider.md +81 -0
  216. package/docs/db/UndoDBProvider/undo.md +16 -0
  217. package/docs/db/UndoDBProvider.md +64 -0
  218. package/docs/db/ValidationDBProvider.md +44 -0
  219. package/docs/db/replayOperations.md +35 -0
  220. package/docs/db.md +191 -0
  221. package/docs/error/BaseError.md +17 -0
  222. package/docs/error/BaseErrorOptions.md +23 -0
  223. package/docs/error/Errors.md +36 -0
  224. package/docs/error/ForbiddenError.md +33 -0
  225. package/docs/error/MethodNotAllowedError.md +33 -0
  226. package/docs/error/NetworkError.md +47 -0
  227. package/docs/error/NotFoundError.md +33 -0
  228. package/docs/error/RequestError.md +55 -0
  229. package/docs/error/RequiredError.md +45 -0
  230. package/docs/error/ResponseError.md +49 -0
  231. package/docs/error/UnauthorizedError.md +33 -0
  232. package/docs/error/UnexpectedError.md +44 -0
  233. package/docs/error/UnprocessableError.md +33 -0
  234. package/docs/error/UnsupportedError.md +45 -0
  235. package/docs/error/ValueError.md +45 -0
  236. package/docs/error/setBaseErrorOptions.md +30 -0
  237. package/docs/error.md +101 -0
  238. package/docs/extract/DirectoryExtractor.md +40 -0
  239. package/docs/extract/DirectoryExtractorOptions.md +24 -0
  240. package/docs/extract/Extractor/extract.md +12 -0
  241. package/docs/extract/Extractor.md +32 -0
  242. package/docs/extract/FileExtractor/extract.md +12 -0
  243. package/docs/extract/FileExtractor/extractProps.md +15 -0
  244. package/docs/extract/FileExtractor.md +37 -0
  245. package/docs/extract/IndexExtractor.md +37 -0
  246. package/docs/extract/IndexExtractorOptions.md +20 -0
  247. package/docs/extract/MarkupExtractor.md +31 -0
  248. package/docs/extract/MergingExtractor.md +39 -0
  249. package/docs/extract/MergingExtractorOptions.md +20 -0
  250. package/docs/extract/ModuleExtractor.md +29 -0
  251. package/docs/extract/ModuleExtractorInput.md +22 -0
  252. package/docs/extract/PackageExtractor.md +42 -0
  253. package/docs/extract/PackageExtractorOptions.md +26 -0
  254. package/docs/extract/ThroughExtractor/extract.md +13 -0
  255. package/docs/extract/ThroughExtractor.md +43 -0
  256. package/docs/extract/TypescriptExtractor.md +41 -0
  257. package/docs/extract/extractMarkdownProps.md +33 -0
  258. package/docs/extract/mergeTreeElements.md +37 -0
  259. package/docs/extract.md +139 -0
  260. package/docs/firebase/FirestoreFields.md +18 -0
  261. package/docs/firebase/FirestoreProvider.md +42 -0
  262. package/docs/firebase/FirestoreProviderOptions.md +28 -0
  263. package/docs/firebase/FirestoreValue.md +46 -0
  264. package/docs/firebase/toData.md +37 -0
  265. package/docs/firebase/toDataValue.md +51 -0
  266. package/docs/firebase/toFirestoreFields.md +39 -0
  267. package/docs/firebase/toFirestoreValue.md +40 -0
  268. package/docs/firebase.md +86 -0
  269. package/docs/guides/building-with-shelving.md +707 -0
  270. package/docs/guides/styleguide.md +287 -0
  271. package/docs/guides.md +9 -0
  272. package/docs/index.md +128 -0
  273. package/docs/llms-full.txt +65380 -0
  274. package/docs/llms.txt +103 -0
  275. package/docs/markup/AUTOLINK_RULE.md +16 -0
  276. package/docs/markup/BLOCKQUOTE_RULE.md +16 -0
  277. package/docs/markup/BLOCK_CONTENT_REGEXP.md +6 -0
  278. package/docs/markup/BLOCK_END_REGEXP.md +6 -0
  279. package/docs/markup/BLOCK_SPACE_REGEXP.md +6 -0
  280. package/docs/markup/BLOCK_START_REGEXP.md +6 -0
  281. package/docs/markup/CODE_RULE.md +17 -0
  282. package/docs/markup/FENCED_RULE.md +18 -0
  283. package/docs/markup/HEADING_RULE.md +16 -0
  284. package/docs/markup/INLINE_RULE.md +22 -0
  285. package/docs/markup/LINEBREAK_RULE.md +19 -0
  286. package/docs/markup/LINE_CONTENT_REGEXP.md +6 -0
  287. package/docs/markup/LINE_END_REGEXP.md +6 -0
  288. package/docs/markup/LINE_SPACE_REGEXP.md +6 -0
  289. package/docs/markup/LINE_START_REGEXP.md +6 -0
  290. package/docs/markup/LINK_RULE.md +17 -0
  291. package/docs/markup/MARKUP_PARSER.md +13 -0
  292. package/docs/markup/MARKUP_RULES.md +23 -0
  293. package/docs/markup/MARKUP_RULES_BLOCK.md +18 -0
  294. package/docs/markup/MARKUP_RULES_INLINE.md +18 -0
  295. package/docs/markup/MarkupContexts.md +12 -0
  296. package/docs/markup/MarkupOptions.md +40 -0
  297. package/docs/markup/MarkupParser/getLink.md +12 -0
  298. package/docs/markup/MarkupParser/getRules.md +12 -0
  299. package/docs/markup/MarkupParser/nested.md +14 -0
  300. package/docs/markup/MarkupParser/parse.md +17 -0
  301. package/docs/markup/MarkupParser.md +55 -0
  302. package/docs/markup/MarkupRule/render.md +12 -0
  303. package/docs/markup/MarkupRule.md +31 -0
  304. package/docs/markup/MarkupRules.md +16 -0
  305. package/docs/markup/ORDERED_RULE.md +18 -0
  306. package/docs/markup/PARAGRAPH_RULE.md +15 -0
  307. package/docs/markup/Parser/parse.md +12 -0
  308. package/docs/markup/Parser.md +32 -0
  309. package/docs/markup/SEPARATOR_RULE.md +16 -0
  310. package/docs/markup/TABLE_RULE.md +17 -0
  311. package/docs/markup/UNORDERED_RULE.md +19 -0
  312. package/docs/markup/WORD_CONTENT_REGEXP.md +6 -0
  313. package/docs/markup/WORD_END_REGEXP.md +6 -0
  314. package/docs/markup/WORD_START_REGEXP.md +6 -0
  315. package/docs/markup/createBlockRegExp.md +39 -0
  316. package/docs/markup/createLineRegExp.md +39 -0
  317. package/docs/markup/createMarkupRule.md +44 -0
  318. package/docs/markup/createWordRegExp.md +39 -0
  319. package/docs/markup.md +187 -0
  320. package/docs/react/APIContext/requireAPICache.md +12 -0
  321. package/docs/react/APIContext/useAPI.md +13 -0
  322. package/docs/react/APIContext.md +28 -0
  323. package/docs/react/DBContext/requireDBCache.md +12 -0
  324. package/docs/react/DBContext/useItem.md +13 -0
  325. package/docs/react/DBContext/useQuery.md +13 -0
  326. package/docs/react/DBContext.md +43 -0
  327. package/docs/react/createAPIContext.md +66 -0
  328. package/docs/react/createDBContext.md +66 -0
  329. package/docs/react/useInstance.md +46 -0
  330. package/docs/react/useLazy.md +48 -0
  331. package/docs/react/useMap.md +39 -0
  332. package/docs/react/useReduce.md +54 -0
  333. package/docs/react/useSequence.md +49 -0
  334. package/docs/react/useStore.md +61 -0
  335. package/docs/react.md +89 -0
  336. package/docs/schema/ADDRESS.md +12 -0
  337. package/docs/schema/ARRAY.md +32 -0
  338. package/docs/schema/AddressSchema.md +35 -0
  339. package/docs/schema/AddressSchemaOptions.md +23 -0
  340. package/docs/schema/ArraySchema.md +77 -0
  341. package/docs/schema/ArraySchemaOptions.md +31 -0
  342. package/docs/schema/BOOLEAN.md +12 -0
  343. package/docs/schema/BooleanSchema/validate.md +12 -0
  344. package/docs/schema/BooleanSchema.md +55 -0
  345. package/docs/schema/BooleanSchemaOptions.md +23 -0
  346. package/docs/schema/CHOICE.md +32 -0
  347. package/docs/schema/COLOR.md +12 -0
  348. package/docs/schema/COUNTRY.md +12 -0
  349. package/docs/schema/CURRENCY_AMOUNT.md +38 -0
  350. package/docs/schema/CURRENCY_CODE.md +12 -0
  351. package/docs/schema/ChoiceInputType.md +12 -0
  352. package/docs/schema/ChoiceOptions.md +12 -0
  353. package/docs/schema/ChoiceSchema/get.md +15 -0
  354. package/docs/schema/ChoiceSchema/validate.md +12 -0
  355. package/docs/schema/ChoiceSchema.md +75 -0
  356. package/docs/schema/ChoiceSchemaOptions.md +29 -0
  357. package/docs/schema/ColorSchema.md +38 -0
  358. package/docs/schema/ColorSchemaOptions.md +29 -0
  359. package/docs/schema/CountrySchema.md +36 -0
  360. package/docs/schema/CountrySchemaOptions.md +21 -0
  361. package/docs/schema/CurrencyAmountSchema.md +52 -0
  362. package/docs/schema/CurrencyAmountSchemaOptions.md +23 -0
  363. package/docs/schema/CurrencyCodeSchema.md +45 -0
  364. package/docs/schema/CurrencyCodeSchemaOptions.md +31 -0
  365. package/docs/schema/DATA.md +32 -0
  366. package/docs/schema/DATE.md +12 -0
  367. package/docs/schema/DATETIME.md +12 -0
  368. package/docs/schema/DICTIONARY.md +32 -0
  369. package/docs/schema/DataSchema/omit.md +12 -0
  370. package/docs/schema/DataSchema/pick.md +12 -0
  371. package/docs/schema/DataSchema.md +97 -0
  372. package/docs/schema/DataSchemaOptions.md +23 -0
  373. package/docs/schema/DateInputType.md +12 -0
  374. package/docs/schema/DateSchema/stringify.md +12 -0
  375. package/docs/schema/DateSchema.md +53 -0
  376. package/docs/schema/DateSchemaOptions.md +29 -0
  377. package/docs/schema/DateTimeSchema.md +41 -0
  378. package/docs/schema/DictionarySchema.md +57 -0
  379. package/docs/schema/DictionarySchemaOptions.md +27 -0
  380. package/docs/schema/EMAIL.md +12 -0
  381. package/docs/schema/ENTITY.md +12 -0
  382. package/docs/schema/EUR_AMOUNT.md +12 -0
  383. package/docs/schema/EmailSchema.md +49 -0
  384. package/docs/schema/EmailSchemaOptions.md +29 -0
  385. package/docs/schema/EntitySchema.md +42 -0
  386. package/docs/schema/EntitySchemaOptions.md +21 -0
  387. package/docs/schema/FILE.md +12 -0
  388. package/docs/schema/FileSchema.md +41 -0
  389. package/docs/schema/FileSchemaOptions.md +21 -0
  390. package/docs/schema/GBP_AMOUNT.md +12 -0
  391. package/docs/schema/IMAGE.md +12 -0
  392. package/docs/schema/INTEGER.md +12 -0
  393. package/docs/schema/ITEM.md +33 -0
  394. package/docs/schema/ImageSchema.md +28 -0
  395. package/docs/schema/KEY.md +12 -0
  396. package/docs/schema/KeySchema.md +45 -0
  397. package/docs/schema/MEDIA.md +12 -0
  398. package/docs/schema/MediaSchema.md +35 -0
  399. package/docs/schema/MediaSchemaOptions.md +21 -0
  400. package/docs/schema/NAME.md +12 -0
  401. package/docs/schema/NEGATIVE_INTEGER.md +12 -0
  402. package/docs/schema/NON_NEGATIVE_INTEGER.md +12 -0
  403. package/docs/schema/NON_POSITIVE_INTEGER.md +12 -0
  404. package/docs/schema/NULL.md +18 -0
  405. package/docs/schema/NULLABLE.md +32 -0
  406. package/docs/schema/NULLABLE_ADDRESS.md +12 -0
  407. package/docs/schema/NULLABLE_COLOR.md +12 -0
  408. package/docs/schema/NULLABLE_COUNTRY.md +12 -0
  409. package/docs/schema/NULLABLE_CURRENCY_AMOUNT.md +38 -0
  410. package/docs/schema/NULLABLE_CURRENCY_CODE.md +12 -0
  411. package/docs/schema/NULLABLE_DATA.md +32 -0
  412. package/docs/schema/NULLABLE_DATE.md +12 -0
  413. package/docs/schema/NULLABLE_DATETIME.md +12 -0
  414. package/docs/schema/NULLABLE_EMAIL.md +12 -0
  415. package/docs/schema/NULLABLE_ENTITY.md +12 -0
  416. package/docs/schema/NULLABLE_EUR_AMOUNT.md +12 -0
  417. package/docs/schema/NULLABLE_FILE.md +12 -0
  418. package/docs/schema/NULLABLE_GBP_AMOUNT.md +12 -0
  419. package/docs/schema/NULLABLE_IMAGE.md +12 -0
  420. package/docs/schema/NULLABLE_INTEGER.md +12 -0
  421. package/docs/schema/NULLABLE_KEY.md +12 -0
  422. package/docs/schema/NULLABLE_MEDIA.md +12 -0
  423. package/docs/schema/NULLABLE_NAME.md +12 -0
  424. package/docs/schema/NULLABLE_NUMBER.md +12 -0
  425. package/docs/schema/NULLABLE_PHONE.md +12 -0
  426. package/docs/schema/NULLABLE_SLUG.md +12 -0
  427. package/docs/schema/NULLABLE_TIME.md +12 -0
  428. package/docs/schema/NULLABLE_TIMESTAMP.md +12 -0
  429. package/docs/schema/NULLABLE_TITLE.md +12 -0
  430. package/docs/schema/NULLABLE_URI_SCHEMA.md +12 -0
  431. package/docs/schema/NULLABLE_URL_SCHEMA.md +12 -0
  432. package/docs/schema/NULLABLE_USD_AMOUNT.md +12 -0
  433. package/docs/schema/NULLABLE_UUID.md +12 -0
  434. package/docs/schema/NULLABLE_VIDEO.md +12 -0
  435. package/docs/schema/NUMBER.md +12 -0
  436. package/docs/schema/NullableSchema.md +46 -0
  437. package/docs/schema/NullableSchemaOptions.md +21 -0
  438. package/docs/schema/NumberSchema.md +78 -0
  439. package/docs/schema/NumberSchemaOptions.md +27 -0
  440. package/docs/schema/OPTIONAL.md +32 -0
  441. package/docs/schema/OptionalSchema.md +45 -0
  442. package/docs/schema/OptionalSchemaOptions.md +21 -0
  443. package/docs/schema/PARTIAL.md +32 -0
  444. package/docs/schema/PASSWORD.md +12 -0
  445. package/docs/schema/PHONE.md +12 -0
  446. package/docs/schema/POSITIVE_INTEGER.md +12 -0
  447. package/docs/schema/PasswordSchema.md +42 -0
  448. package/docs/schema/PhoneSchema.md +38 -0
  449. package/docs/schema/PhoneSchemaOptions.md +29 -0
  450. package/docs/schema/PossibleChoiceOptions.md +20 -0
  451. package/docs/schema/QUERY.md +32 -0
  452. package/docs/schema/QuerySchema.md +46 -0
  453. package/docs/schema/QuerySchemaOptions.md +21 -0
  454. package/docs/schema/REQUIRED.md +32 -0
  455. package/docs/schema/REQUIRED_STRING.md +12 -0
  456. package/docs/schema/RequiredSchema.md +29 -0
  457. package/docs/schema/SLUG.md +12 -0
  458. package/docs/schema/STRING.md +12 -0
  459. package/docs/schema/Schema/format.md +12 -0
  460. package/docs/schema/Schema/validate.md +12 -0
  461. package/docs/schema/Schema.md +60 -0
  462. package/docs/schema/SchemaOptions.md +30 -0
  463. package/docs/schema/SchemaType.md +23 -0
  464. package/docs/schema/Schemas.md +17 -0
  465. package/docs/schema/SlugSchema.md +41 -0
  466. package/docs/schema/SlugSchemaOptions.md +31 -0
  467. package/docs/schema/StringInputType.md +12 -0
  468. package/docs/schema/StringSchema/sanitize.md +15 -0
  469. package/docs/schema/StringSchema.md +96 -0
  470. package/docs/schema/StringSchemaOptions.md +35 -0
  471. package/docs/schema/TIME.md +12 -0
  472. package/docs/schema/TIMESTAMP.md +12 -0
  473. package/docs/schema/TITLE.md +12 -0
  474. package/docs/schema/ThroughSchema/validate.md +12 -0
  475. package/docs/schema/ThroughSchema.md +43 -0
  476. package/docs/schema/ThroughSchemaOptions.md +21 -0
  477. package/docs/schema/TimeSchema.md +39 -0
  478. package/docs/schema/UNDEFINED.md +18 -0
  479. package/docs/schema/UNKNOWN.md +18 -0
  480. package/docs/schema/UPDATES.md +32 -0
  481. package/docs/schema/URISchema.md +47 -0
  482. package/docs/schema/URISchemaOptions.md +33 -0
  483. package/docs/schema/URI_SCHEMA.md +12 -0
  484. package/docs/schema/URLSchema.md +49 -0
  485. package/docs/schema/URLSchemaOptions.md +35 -0
  486. package/docs/schema/URL_SCHEMA.md +12 -0
  487. package/docs/schema/USD_AMOUNT.md +12 -0
  488. package/docs/schema/UUID.md +12 -0
  489. package/docs/schema/UUIDSchema.md +39 -0
  490. package/docs/schema/UUIDSchemaOptions.md +29 -0
  491. package/docs/schema/UpdatesSchema.md +45 -0
  492. package/docs/schema/UpdatesSchemaOptions.md +21 -0
  493. package/docs/schema/VIDEO.md +12 -0
  494. package/docs/schema/VideoSchema.md +28 -0
  495. package/docs/schema/getDataSchemaProp.md +39 -0
  496. package/docs/schema/getSourceSchema.md +32 -0
  497. package/docs/schema.md +266 -0
  498. package/docs/sequence/DeferredErrorResult.md +20 -0
  499. package/docs/sequence/DeferredResult.md +17 -0
  500. package/docs/sequence/DeferredSequence/cancel.md +13 -0
  501. package/docs/sequence/DeferredSequence/catch.md +10 -0
  502. package/docs/sequence/DeferredSequence/done.md +13 -0
  503. package/docs/sequence/DeferredSequence/finally.md +10 -0
  504. package/docs/sequence/DeferredSequence/next.md +10 -0
  505. package/docs/sequence/DeferredSequence/reject.md +13 -0
  506. package/docs/sequence/DeferredSequence/resolve.md +13 -0
  507. package/docs/sequence/DeferredSequence/then.md +10 -0
  508. package/docs/sequence/DeferredSequence/through.md +13 -0
  509. package/docs/sequence/DeferredSequence.md +75 -0
  510. package/docs/sequence/InspectSequence.md +57 -0
  511. package/docs/sequence/LazySequence/start.md +14 -0
  512. package/docs/sequence/LazySequence/stop.md +14 -0
  513. package/docs/sequence/LazySequence.md +61 -0
  514. package/docs/sequence/Sequence/next.md +12 -0
  515. package/docs/sequence/Sequence/return.md +14 -0
  516. package/docs/sequence/Sequence/throw.md +14 -0
  517. package/docs/sequence/Sequence.md +53 -0
  518. package/docs/sequence/ThroughSequence/next.md +10 -0
  519. package/docs/sequence/ThroughSequence.md +57 -0
  520. package/docs/sequence.md +54 -0
  521. package/docs/store/ALWAYS_REFRESH.md +6 -0
  522. package/docs/store/AVOID_REFRESH.md +6 -0
  523. package/docs/store/AnyStore.md +16 -0
  524. package/docs/store/ArrayStore/add.md +13 -0
  525. package/docs/store/ArrayStore/delete.md +12 -0
  526. package/docs/store/ArrayStore/toggle.md +12 -0
  527. package/docs/store/ArrayStore.md +69 -0
  528. package/docs/store/AsyncStoreInput.md +18 -0
  529. package/docs/store/BooleanStore/toggle.md +12 -0
  530. package/docs/store/BooleanStore.md +46 -0
  531. package/docs/store/BusyStore.md +48 -0
  532. package/docs/store/DataStore/get.md +12 -0
  533. package/docs/store/DataStore/set.md +12 -0
  534. package/docs/store/DataStore/update.md +12 -0
  535. package/docs/store/DataStore.md +65 -0
  536. package/docs/store/DictionaryStore/delete.md +12 -0
  537. package/docs/store/DictionaryStore/deleteItems.md +12 -0
  538. package/docs/store/DictionaryStore/get.md +12 -0
  539. package/docs/store/DictionaryStore/set.md +12 -0
  540. package/docs/store/DictionaryStore/update.md +12 -0
  541. package/docs/store/DictionaryStore.md +63 -0
  542. package/docs/store/FetchCallback.md +20 -0
  543. package/docs/store/FetchStore/invalidate.md +13 -0
  544. package/docs/store/FetchStore/refresh.md +15 -0
  545. package/docs/store/FetchStore.md +67 -0
  546. package/docs/store/OptionalDataStore/delete.md +12 -0
  547. package/docs/store/OptionalDataStore/get.md +12 -0
  548. package/docs/store/OptionalDataStore/require.md +12 -0
  549. package/docs/store/OptionalDataStore/set.md +12 -0
  550. package/docs/store/OptionalDataStore/update.md +12 -0
  551. package/docs/store/OptionalDataStore.md +36 -0
  552. package/docs/store/PathStore/getPath.md +12 -0
  553. package/docs/store/PathStore/isActive.md +12 -0
  554. package/docs/store/PathStore/isProud.md +12 -0
  555. package/docs/store/PathStore.md +59 -0
  556. package/docs/store/PayloadFetchCallback.md +19 -0
  557. package/docs/store/PayloadFetchStore.md +62 -0
  558. package/docs/store/Store/abort.md +13 -0
  559. package/docs/store/Store/await.md +17 -0
  560. package/docs/store/Store/call.md +13 -0
  561. package/docs/store/Store/read.md +14 -0
  562. package/docs/store/Store/reduce.md +13 -0
  563. package/docs/store/Store/run.md +13 -0
  564. package/docs/store/Store/send.md +13 -0
  565. package/docs/store/Store/stale.md +12 -0
  566. package/docs/store/Store/subscribe.md +13 -0
  567. package/docs/store/Store/through.md +12 -0
  568. package/docs/store/Store/write.md +14 -0
  569. package/docs/store/Store.md +119 -0
  570. package/docs/store/StoreCallback.md +16 -0
  571. package/docs/store/StoreInput.md +13 -0
  572. package/docs/store/StoreInternal.md +13 -0
  573. package/docs/store/StoreReducer.md +16 -0
  574. package/docs/store/URLStore/clearParams.md +12 -0
  575. package/docs/store/URLStore/deleteParam.md +12 -0
  576. package/docs/store/URLStore/deleteParams.md +12 -0
  577. package/docs/store/URLStore/getParam.md +12 -0
  578. package/docs/store/URLStore/isActive.md +13 -0
  579. package/docs/store/URLStore/isProud.md +14 -0
  580. package/docs/store/URLStore/omitParam.md +12 -0
  581. package/docs/store/URLStore/omitParams.md +12 -0
  582. package/docs/store/URLStore/requireParam.md +12 -0
  583. package/docs/store/URLStore/setParam.md +12 -0
  584. package/docs/store/URLStore/setParams.md +12 -0
  585. package/docs/store/URLStore/updateParams.md +12 -0
  586. package/docs/store/URLStore/withParam.md +12 -0
  587. package/docs/store/URLStore/withParams.md +12 -0
  588. package/docs/store/URLStore.md +84 -0
  589. package/docs/store.md +84 -0
  590. package/docs/test/BASICS_COLLECTION.md +6 -0
  591. package/docs/test/BASIC_SCHEMA.md +6 -0
  592. package/docs/test/BasicData.md +16 -0
  593. package/docs/test/BasicItem.md +17 -0
  594. package/docs/test/EXPECT_PROMISELIKE.md +12 -0
  595. package/docs/test/PEOPLE_COLLECTION.md +6 -0
  596. package/docs/test/PERSON_SCHEMA.md +6 -0
  597. package/docs/test/PersonData.md +16 -0
  598. package/docs/test/PersonItem.md +17 -0
  599. package/docs/test/TestDBProviderOptions.md +24 -0
  600. package/docs/test/TransactionTestDBProvider.md +22 -0
  601. package/docs/test/basic1.md +12 -0
  602. package/docs/test/basic2.md +12 -0
  603. package/docs/test/basic3.md +12 -0
  604. package/docs/test/basic4.md +12 -0
  605. package/docs/test/basic5.md +12 -0
  606. package/docs/test/basic6.md +12 -0
  607. package/docs/test/basic7.md +12 -0
  608. package/docs/test/basic8.md +12 -0
  609. package/docs/test/basic9.md +12 -0
  610. package/docs/test/basic999.md +12 -0
  611. package/docs/test/basics.md +12 -0
  612. package/docs/test/expectOrderedItems.md +28 -0
  613. package/docs/test/expectUnorderedItems.md +28 -0
  614. package/docs/test/people.md +12 -0
  615. package/docs/test/person1.md +12 -0
  616. package/docs/test/person2.md +12 -0
  617. package/docs/test/person3.md +12 -0
  618. package/docs/test/person4.md +12 -0
  619. package/docs/test/person5.md +12 -0
  620. package/docs/test/testDBProvider.md +32 -0
  621. package/docs/test.md +107 -0
  622. package/docs/ui/Address.md +24 -0
  623. package/docs/ui/AddressProps.md +13 -0
  624. package/docs/ui/Ago.md +36 -0
  625. package/docs/ui/AgoProps.md +13 -0
  626. package/docs/ui/App.md +79 -0
  627. package/docs/ui/AppProps.md +13 -0
  628. package/docs/ui/ArrayCheckboxInputs.md +43 -0
  629. package/docs/ui/ArrayCheckboxInputsProps.md +23 -0
  630. package/docs/ui/ArrayInput.md +37 -0
  631. package/docs/ui/ArrayInputProps.md +29 -0
  632. package/docs/ui/ArrayRadioInputs.md +42 -0
  633. package/docs/ui/ArrayRadioInputsProps.md +23 -0
  634. package/docs/ui/ArraySchemaInput.md +30 -0
  635. package/docs/ui/ArraySchemaInputProps.md +13 -0
  636. package/docs/ui/Article.md +26 -0
  637. package/docs/ui/Block.md +32 -0
  638. package/docs/ui/BlockElement.md +12 -0
  639. package/docs/ui/BlockProps.md +21 -0
  640. package/docs/ui/BlockVariants.md +13 -0
  641. package/docs/ui/Blockquote.md +30 -0
  642. package/docs/ui/BlockquoteProps.md +13 -0
  643. package/docs/ui/BooleanSchemaInput.md +30 -0
  644. package/docs/ui/BooleanSchemaInputProps.md +13 -0
  645. package/docs/ui/Button.md +204 -0
  646. package/docs/ui/ButtonClickable.md +39 -0
  647. package/docs/ui/ButtonInput.md +31 -0
  648. package/docs/ui/ButtonInputProps.md +13 -0
  649. package/docs/ui/ButtonProps.md +13 -0
  650. package/docs/ui/ButtonVariants.md +31 -0
  651. package/docs/ui/CSSModule.md +16 -0
  652. package/docs/ui/Caption.md +30 -0
  653. package/docs/ui/CaptionProps.md +13 -0
  654. package/docs/ui/Card.md +118 -0
  655. package/docs/ui/CardProps.md +21 -0
  656. package/docs/ui/CaseVariant.md +12 -0
  657. package/docs/ui/Catcher/getDerivedStateFromError.md +10 -0
  658. package/docs/ui/Catcher.md +68 -0
  659. package/docs/ui/CatcherProps.md +21 -0
  660. package/docs/ui/Cell.md +29 -0
  661. package/docs/ui/CellProps.md +21 -0
  662. package/docs/ui/CenteredLayout.md +66 -0
  663. package/docs/ui/CenteredLayoutProps.md +14 -0
  664. package/docs/ui/CheckboxInput.md +43 -0
  665. package/docs/ui/CheckboxProps.md +13 -0
  666. package/docs/ui/ChildProps.md +20 -0
  667. package/docs/ui/ChoiceRadioInputs.md +35 -0
  668. package/docs/ui/ChoiceRadioInputsProps.md +25 -0
  669. package/docs/ui/ChoiceSchemaInput.md +33 -0
  670. package/docs/ui/ChoiceSchemaInputProps.md +13 -0
  671. package/docs/ui/ClassProps.md +79 -0
  672. package/docs/ui/Classes.md +21 -0
  673. package/docs/ui/Clickable.md +35 -0
  674. package/docs/ui/ClickableCallback.md +27 -0
  675. package/docs/ui/ClickableProps.md +35 -0
  676. package/docs/ui/Code.md +79 -0
  677. package/docs/ui/CodeProps.md +21 -0
  678. package/docs/ui/CollapseTransition.md +53 -0
  679. package/docs/ui/CollapseTransitionProps.md +13 -0
  680. package/docs/ui/ColorVariant.md +24 -0
  681. package/docs/ui/ColorVariants.md +20 -0
  682. package/docs/ui/Column.md +31 -0
  683. package/docs/ui/ColumnProps.md +21 -0
  684. package/docs/ui/ColumnsVariant.md +12 -0
  685. package/docs/ui/DataInput.md +32 -0
  686. package/docs/ui/DataInputProps.md +21 -0
  687. package/docs/ui/DataSchemaInput.md +30 -0
  688. package/docs/ui/DataSchemaInputProps.md +13 -0
  689. package/docs/ui/DateInput.md +50 -0
  690. package/docs/ui/DateInputProps.md +27 -0
  691. package/docs/ui/DateSchemaInput.md +30 -0
  692. package/docs/ui/DateSchemaInputProps.md +13 -0
  693. package/docs/ui/Definitions.md +32 -0
  694. package/docs/ui/DefinitionsProps.md +13 -0
  695. package/docs/ui/Deleted.md +63 -0
  696. package/docs/ui/DeletedProps.md +13 -0
  697. package/docs/ui/Details.md +93 -0
  698. package/docs/ui/DetailsProps.md +27 -0
  699. package/docs/ui/Dialog.md +96 -0
  700. package/docs/ui/DialogCloseButton.md +31 -0
  701. package/docs/ui/DialogCloseButtonProps.md +13 -0
  702. package/docs/ui/DialogProps.md +21 -0
  703. package/docs/ui/Dialogs.md +18 -0
  704. package/docs/ui/DialogsContext.md +24 -0
  705. package/docs/ui/DialogsContextProps.md +13 -0
  706. package/docs/ui/DialogsProps.md +14 -0
  707. package/docs/ui/DialogsStore/show.md +12 -0
  708. package/docs/ui/DialogsStore.md +26 -0
  709. package/docs/ui/DictionaryInput.md +37 -0
  710. package/docs/ui/DictionaryInputProps.md +29 -0
  711. package/docs/ui/DictionarySchemaInput.md +30 -0
  712. package/docs/ui/DictionarySchemaInputProps.md +13 -0
  713. package/docs/ui/Divider.md +24 -0
  714. package/docs/ui/DividerProps.md +13 -0
  715. package/docs/ui/DocumentationApp.md +29 -0
  716. package/docs/ui/DocumentationButtons.md +69 -0
  717. package/docs/ui/DocumentationButtonsProps.md +25 -0
  718. package/docs/ui/DocumentationCard.md +74 -0
  719. package/docs/ui/DocumentationDescription.md +38 -0
  720. package/docs/ui/DocumentationDescriptionProps.md +26 -0
  721. package/docs/ui/DocumentationKind.md +32 -0
  722. package/docs/ui/DocumentationKindProps.md +21 -0
  723. package/docs/ui/DocumentationPage.md +92 -0
  724. package/docs/ui/DocumentationParams.md +36 -0
  725. package/docs/ui/DocumentationParamsProps.md +20 -0
  726. package/docs/ui/DocumentationProperties.md +36 -0
  727. package/docs/ui/DocumentationPropertiesProps.md +20 -0
  728. package/docs/ui/DocumentationReferences.md +33 -0
  729. package/docs/ui/DocumentationReferencesProps.md +20 -0
  730. package/docs/ui/DocumentationReturns.md +34 -0
  731. package/docs/ui/DocumentationReturnsProps.md +20 -0
  732. package/docs/ui/DocumentationSearchPage.md +29 -0
  733. package/docs/ui/DocumentationSignatures.md +34 -0
  734. package/docs/ui/DocumentationSignaturesProps.md +20 -0
  735. package/docs/ui/DocumentationThrows.md +34 -0
  736. package/docs/ui/DocumentationThrowsProps.md +20 -0
  737. package/docs/ui/DocumentationType.md +32 -0
  738. package/docs/ui/DocumentationTypeProps.md +20 -0
  739. package/docs/ui/DurationValue.md +12 -0
  740. package/docs/ui/DurationVariants.md +20 -0
  741. package/docs/ui/EMPTY_LOADING.md +6 -0
  742. package/docs/ui/EmailAddress.md +33 -0
  743. package/docs/ui/EmailAddressProps.md +23 -0
  744. package/docs/ui/Emphasis.md +59 -0
  745. package/docs/ui/EmphasisProps.md +13 -0
  746. package/docs/ui/Empty.md +61 -0
  747. package/docs/ui/EmptyProps.md +13 -0
  748. package/docs/ui/ErrorNotice.md +27 -0
  749. package/docs/ui/ErrorPage.md +25 -0
  750. package/docs/ui/ErrorProps.md +20 -0
  751. package/docs/ui/FadeTransition.md +55 -0
  752. package/docs/ui/FadeTransitionProps.md +13 -0
  753. package/docs/ui/Field.md +81 -0
  754. package/docs/ui/FieldProps.md +27 -0
  755. package/docs/ui/Figure.md +26 -0
  756. package/docs/ui/FileInput.md +47 -0
  757. package/docs/ui/FileInputProps.md +23 -0
  758. package/docs/ui/FlexVariants.md +47 -0
  759. package/docs/ui/FontVariant.md +12 -0
  760. package/docs/ui/Footer.md +25 -0
  761. package/docs/ui/Form.md +133 -0
  762. package/docs/ui/FormCallback.md +24 -0
  763. package/docs/ui/FormContext.md +6 -0
  764. package/docs/ui/FormField.md +36 -0
  765. package/docs/ui/FormFields.md +24 -0
  766. package/docs/ui/FormFooter.md +33 -0
  767. package/docs/ui/FormFooterProps.md +21 -0
  768. package/docs/ui/FormInput.md +31 -0
  769. package/docs/ui/FormInputProps.md +13 -0
  770. package/docs/ui/FormInputs.md +24 -0
  771. package/docs/ui/FormMessage.md +30 -0
  772. package/docs/ui/FormNotice.md +30 -0
  773. package/docs/ui/FormNotify.md +25 -0
  774. package/docs/ui/FormProps.md +29 -0
  775. package/docs/ui/FormStore/publish.md +14 -0
  776. package/docs/ui/FormStore/requireSchema.md +12 -0
  777. package/docs/ui/FormStore/submit.md +13 -0
  778. package/docs/ui/FormStore.md +85 -0
  779. package/docs/ui/FullscreenButton.md +36 -0
  780. package/docs/ui/FullscreenButtonProps.md +21 -0
  781. package/docs/ui/GapVariants.md +20 -0
  782. package/docs/ui/Grid.md +74 -0
  783. package/docs/ui/GridProps.md +21 -0
  784. package/docs/ui/GridVariants.md +21 -0
  785. package/docs/ui/HTML.md +55 -0
  786. package/docs/ui/HTMLProps.md +13 -0
  787. package/docs/ui/Head.md +42 -0
  788. package/docs/ui/Header.md +25 -0
  789. package/docs/ui/Heading.md +89 -0
  790. package/docs/ui/HeadingProps.md +21 -0
  791. package/docs/ui/HorizontalTransition.md +67 -0
  792. package/docs/ui/HorizontalTransitionProps.md +13 -0
  793. package/docs/ui/Icon.md +57 -0
  794. package/docs/ui/IconProps.md +25 -0
  795. package/docs/ui/Image.md +32 -0
  796. package/docs/ui/ImageInput.md +92 -0
  797. package/docs/ui/ImageInputProps.md +23 -0
  798. package/docs/ui/ImageProps.md +23 -0
  799. package/docs/ui/IndentVariant.md +29 -0
  800. package/docs/ui/IndentVariants.md +20 -0
  801. package/docs/ui/InputProps.md +31 -0
  802. package/docs/ui/InputVariants.md +15 -0
  803. package/docs/ui/InputWrapper.md +25 -0
  804. package/docs/ui/InputWrapperProps.md +13 -0
  805. package/docs/ui/Inserted.md +63 -0
  806. package/docs/ui/InsertedProps.md +13 -0
  807. package/docs/ui/LOADING.md +8 -0
  808. package/docs/ui/LOADING_INPUT.md +6 -0
  809. package/docs/ui/LOADING_NOTICE.md +6 -0
  810. package/docs/ui/Label.md +32 -0
  811. package/docs/ui/LabelProps.md +13 -0
  812. package/docs/ui/Link.md +80 -0
  813. package/docs/ui/LinkClickable.md +42 -0
  814. package/docs/ui/LinkProps.md +21 -0
  815. package/docs/ui/List.md +70 -0
  816. package/docs/ui/ListProps.md +23 -0
  817. package/docs/ui/Loader.md +28 -0
  818. package/docs/ui/LoaderProps.md +21 -0
  819. package/docs/ui/Loading.md +71 -0
  820. package/docs/ui/MapperProps.md +21 -0
  821. package/docs/ui/Mapping.md +22 -0
  822. package/docs/ui/MappingProps.md +21 -0
  823. package/docs/ui/Mark.md +58 -0
  824. package/docs/ui/MarkProps.md +13 -0
  825. package/docs/ui/Markup.md +58 -0
  826. package/docs/ui/MarkupProps.md +21 -0
  827. package/docs/ui/Menu.md +76 -0
  828. package/docs/ui/MenuItem.md +102 -0
  829. package/docs/ui/MenuItemProps.md +23 -0
  830. package/docs/ui/MenuProps.md +21 -0
  831. package/docs/ui/Message.md +26 -0
  832. package/docs/ui/MessageProps.md +13 -0
  833. package/docs/ui/Meta.md +44 -0
  834. package/docs/ui/MetaAssets.md +17 -0
  835. package/docs/ui/MetaCSP.md +14 -0
  836. package/docs/ui/MetaContext.md +12 -0
  837. package/docs/ui/MetaLinks.md +17 -0
  838. package/docs/ui/MetaTags.md +16 -0
  839. package/docs/ui/MetaURL.md +27 -0
  840. package/docs/ui/Modal.md +144 -0
  841. package/docs/ui/ModalProps.md +13 -0
  842. package/docs/ui/ModalVariants.md +29 -0
  843. package/docs/ui/NOTICES.md +12 -0
  844. package/docs/ui/Navigation.md +90 -0
  845. package/docs/ui/NavigationContext.md +12 -0
  846. package/docs/ui/NavigationProps.md +13 -0
  847. package/docs/ui/NavigationStore/back.md +14 -0
  848. package/docs/ui/NavigationStore/forward.md +12 -0
  849. package/docs/ui/NavigationStore/redirect.md +12 -0
  850. package/docs/ui/NavigationStore.md +72 -0
  851. package/docs/ui/Notice.md +74 -0
  852. package/docs/ui/NoticeCallback.md +17 -0
  853. package/docs/ui/NoticeProps.md +21 -0
  854. package/docs/ui/NoticeStore/close.md +12 -0
  855. package/docs/ui/NoticeStore/show.md +12 -0
  856. package/docs/ui/NoticeStore.md +47 -0
  857. package/docs/ui/Notices.md +105 -0
  858. package/docs/ui/NoticesPosition.md +12 -0
  859. package/docs/ui/NoticesProps.md +21 -0
  860. package/docs/ui/NoticesStore/show.md +12 -0
  861. package/docs/ui/NoticesStore.md +31 -0
  862. package/docs/ui/NumberInput.md +48 -0
  863. package/docs/ui/NumberInputProps.md +25 -0
  864. package/docs/ui/NumberSchemaInput.md +30 -0
  865. package/docs/ui/NumberSchemaInputProps.md +13 -0
  866. package/docs/ui/OptionalChildProps.md +20 -0
  867. package/docs/ui/OutputInput.md +30 -0
  868. package/docs/ui/OutputInputProps.md +13 -0
  869. package/docs/ui/PaddingVariants.md +20 -0
  870. package/docs/ui/Page.md +61 -0
  871. package/docs/ui/PageCatcher.md +25 -0
  872. package/docs/ui/PageLoader.md +28 -0
  873. package/docs/ui/PageProps.md +13 -0
  874. package/docs/ui/Panel.md +74 -0
  875. package/docs/ui/PanelProps.md +21 -0
  876. package/docs/ui/Paragraph.md +64 -0
  877. package/docs/ui/ParagraphProps.md +13 -0
  878. package/docs/ui/PhysicalAddress.md +33 -0
  879. package/docs/ui/PhysicalAddressProps.md +23 -0
  880. package/docs/ui/Popover.md +43 -0
  881. package/docs/ui/PopoverButton.md +39 -0
  882. package/docs/ui/PopoverButtonInput.md +39 -0
  883. package/docs/ui/PopoverButtonInputProps.md +21 -0
  884. package/docs/ui/PopoverButtonProps.md +21 -0
  885. package/docs/ui/PopoverChildren.md +26 -0
  886. package/docs/ui/PopoverProps.md +25 -0
  887. package/docs/ui/PossibleMeta.md +33 -0
  888. package/docs/ui/PossibleMetaAssets.md +18 -0
  889. package/docs/ui/PossibleMetaLinks.md +18 -0
  890. package/docs/ui/Preformatted.md +33 -0
  891. package/docs/ui/PreformattedProps.md +21 -0
  892. package/docs/ui/Progress.md +120 -0
  893. package/docs/ui/ProgressProps.md +25 -0
  894. package/docs/ui/Prose.md +61 -0
  895. package/docs/ui/ProseProps.md +13 -0
  896. package/docs/ui/QueryCheckboxesInput.md +72 -0
  897. package/docs/ui/QueryCheckboxesInputProps.md +13 -0
  898. package/docs/ui/QueryInputBase.md +36 -0
  899. package/docs/ui/QueryInputBaseProps.md +29 -0
  900. package/docs/ui/QueryRadiosInput.md +76 -0
  901. package/docs/ui/QueryRadiosInputProps.md +13 -0
  902. package/docs/ui/RadioInput.md +43 -0
  903. package/docs/ui/RadioInputProps.md +13 -0
  904. package/docs/ui/RadiusVariant.md +12 -0
  905. package/docs/ui/RadiusVariants.md +20 -0
  906. package/docs/ui/RetryButton.md +27 -0
  907. package/docs/ui/RetryButtonProps.md +15 -0
  908. package/docs/ui/RetryContext.md +8 -0
  909. package/docs/ui/Route.md +21 -0
  910. package/docs/ui/RouteCache.md +66 -0
  911. package/docs/ui/RouteCacheProps.md +22 -0
  912. package/docs/ui/RouteComponent.md +18 -0
  913. package/docs/ui/RouteContext.md +6 -0
  914. package/docs/ui/RoutePath.md +56 -0
  915. package/docs/ui/RoutePathProps.md +22 -0
  916. package/docs/ui/RouteProps.md +18 -0
  917. package/docs/ui/RouteState.md +27 -0
  918. package/docs/ui/Router.md +179 -0
  919. package/docs/ui/RouterProps.md +23 -0
  920. package/docs/ui/Routes.md +23 -0
  921. package/docs/ui/Row.md +31 -0
  922. package/docs/ui/RowProps.md +21 -0
  923. package/docs/ui/STATUSES.md +12 -0
  924. package/docs/ui/SchemaField.md +25 -0
  925. package/docs/ui/SchemaFieldProps.md +13 -0
  926. package/docs/ui/SchemaInput.md +90 -0
  927. package/docs/ui/SchemaInputProps.md +21 -0
  928. package/docs/ui/Scroll.md +30 -0
  929. package/docs/ui/ScrollComponentProps.md +13 -0
  930. package/docs/ui/ScrollVariants.md +22 -0
  931. package/docs/ui/Section.md +74 -0
  932. package/docs/ui/SectionProps.md +21 -0
  933. package/docs/ui/SelectInput.md +32 -0
  934. package/docs/ui/SelectProps.md +21 -0
  935. package/docs/ui/ShadowVariant.md +12 -0
  936. package/docs/ui/ShadowVariants.md +20 -0
  937. package/docs/ui/SidebarLayout.md +82 -0
  938. package/docs/ui/SidebarLayoutProps.md +23 -0
  939. package/docs/ui/SizeVariant.md +29 -0
  940. package/docs/ui/Small.md +60 -0
  941. package/docs/ui/SmallProps.md +13 -0
  942. package/docs/ui/SpaceValue.md +31 -0
  943. package/docs/ui/SpaceVariants.md +20 -0
  944. package/docs/ui/Span.md +64 -0
  945. package/docs/ui/SpanClickable.md +34 -0
  946. package/docs/ui/SpanProps.md +13 -0
  947. package/docs/ui/Status.md +13 -0
  948. package/docs/ui/StatusVariants.md +20 -0
  949. package/docs/ui/StringSchemaInput.md +32 -0
  950. package/docs/ui/StringSchemaInputProps.md +13 -0
  951. package/docs/ui/StrokeVariant.md +12 -0
  952. package/docs/ui/StrokeVariants.md +20 -0
  953. package/docs/ui/Strong.md +55 -0
  954. package/docs/ui/StrongProps.md +13 -0
  955. package/docs/ui/StylableClickableProps.md +13 -0
  956. package/docs/ui/Subheading.md +75 -0
  957. package/docs/ui/SubheadingProps.md +16 -0
  958. package/docs/ui/SubmitButton.md +38 -0
  959. package/docs/ui/SubmitButtonProps.md +19 -0
  960. package/docs/ui/Subscript.md +30 -0
  961. package/docs/ui/SubscriptProps.md +13 -0
  962. package/docs/ui/Superscript.md +30 -0
  963. package/docs/ui/SuperscriptProps.md +13 -0
  964. package/docs/ui/TINT_CLASS.md +77 -0
  965. package/docs/ui/TREE_CODE_RULE.md +14 -0
  966. package/docs/ui/TREE_MARKUP_RULES.md +13 -0
  967. package/docs/ui/Table.md +133 -0
  968. package/docs/ui/TableProps.md +14 -0
  969. package/docs/ui/Tag.md +67 -0
  970. package/docs/ui/TagProps.md +13 -0
  971. package/docs/ui/TagVariants.md +13 -0
  972. package/docs/ui/TextFormatter.md +12 -0
  973. package/docs/ui/TextInput.md +50 -0
  974. package/docs/ui/TextInputProps.md +27 -0
  975. package/docs/ui/TextareaInput.md +50 -0
  976. package/docs/ui/TextareaInputProps.md +27 -0
  977. package/docs/ui/TintVariant.md +35 -0
  978. package/docs/ui/Title.md +74 -0
  979. package/docs/ui/TitleProps.md +16 -0
  980. package/docs/ui/Transition.md +112 -0
  981. package/docs/ui/TransitionClasses.md +27 -0
  982. package/docs/ui/TransitionProps.md +25 -0
  983. package/docs/ui/TransitionType.md +16 -0
  984. package/docs/ui/TransitionVariants.md +20 -0
  985. package/docs/ui/TreeApp.md +85 -0
  986. package/docs/ui/TreeAppProps.md +25 -0
  987. package/docs/ui/TreeBreadcrumbs.md +36 -0
  988. package/docs/ui/TreeBreadcrumbsProps.md +13 -0
  989. package/docs/ui/TreeButton.md +36 -0
  990. package/docs/ui/TreeButtonProps.md +23 -0
  991. package/docs/ui/TreeCard.md +37 -0
  992. package/docs/ui/TreeCards.md +34 -0
  993. package/docs/ui/TreeCardsProps.md +20 -0
  994. package/docs/ui/TreeContext.md +8 -0
  995. package/docs/ui/TreeLink.md +35 -0
  996. package/docs/ui/TreeLinkProps.md +21 -0
  997. package/docs/ui/TreeMarkup.md +52 -0
  998. package/docs/ui/TreeMenu.md +60 -0
  999. package/docs/ui/TreeMenuItem.md +40 -0
  1000. package/docs/ui/TreeMenuProps.md +20 -0
  1001. package/docs/ui/TreePage.md +40 -0
  1002. package/docs/ui/TreeProvider.md +33 -0
  1003. package/docs/ui/TreeRouter.md +42 -0
  1004. package/docs/ui/TreeRouterProps.md +21 -0
  1005. package/docs/ui/TreeSidebar.md +51 -0
  1006. package/docs/ui/TreeSidebarProps.md +13 -0
  1007. package/docs/ui/TypographyVariants.md +43 -0
  1008. package/docs/ui/Until.md +36 -0
  1009. package/docs/ui/UntilProps.md +13 -0
  1010. package/docs/ui/ValueInputProps/onValue.md +12 -0
  1011. package/docs/ui/ValueInputProps.md +26 -0
  1012. package/docs/ui/Variants.md +20 -0
  1013. package/docs/ui/VerticalTransition.md +64 -0
  1014. package/docs/ui/VerticalTransitionProps.md +13 -0
  1015. package/docs/ui/Video.md +32 -0
  1016. package/docs/ui/VideoProps.md +13 -0
  1017. package/docs/ui/WeightVariant.md +12 -0
  1018. package/docs/ui/When.md +39 -0
  1019. package/docs/ui/WhenProps.md +26 -0
  1020. package/docs/ui/WidthVariant.md +35 -0
  1021. package/docs/ui/WidthVariants.md +22 -0
  1022. package/docs/ui/awaitNotified.md +26 -0
  1023. package/docs/ui/awaitNotifiedElement.md +33 -0
  1024. package/docs/ui/awaitNotifiedForm.md +32 -0
  1025. package/docs/ui/callNotified.md +28 -0
  1026. package/docs/ui/callNotifiedElement.md +35 -0
  1027. package/docs/ui/callNotifiedForm.md +36 -0
  1028. package/docs/ui/createMapper.md +29 -0
  1029. package/docs/ui/createMeta.md +40 -0
  1030. package/docs/ui/eventLoopFocus.md +26 -0
  1031. package/docs/ui/eventPreventDefault.md +26 -0
  1032. package/docs/ui/focusFirstFocusable.md +26 -0
  1033. package/docs/ui/getBlockClass.md +32 -0
  1034. package/docs/ui/getButtonClass.md +30 -0
  1035. package/docs/ui/getClass.md +75 -0
  1036. package/docs/ui/getColorClass.md +77 -0
  1037. package/docs/ui/getDocumentationKindColor.md +31 -0
  1038. package/docs/ui/getDurationClass.md +44 -0
  1039. package/docs/ui/getFlexClass.md +44 -0
  1040. package/docs/ui/getGapClass.md +31 -0
  1041. package/docs/ui/getGridClass.md +55 -0
  1042. package/docs/ui/getIndentClass.md +31 -0
  1043. package/docs/ui/getInputClass.md +30 -0
  1044. package/docs/ui/getModuleClass.md +26 -0
  1045. package/docs/ui/getMostVisibleObserverEntry.md +32 -0
  1046. package/docs/ui/getPaddingClass.md +31 -0
  1047. package/docs/ui/getRadiusClass.md +48 -0
  1048. package/docs/ui/getScrollClass.md +32 -0
  1049. package/docs/ui/getShadowClass.md +49 -0
  1050. package/docs/ui/getSpaceClass.md +61 -0
  1051. package/docs/ui/getStatusClass.md +34 -0
  1052. package/docs/ui/getStrokeClass.md +45 -0
  1053. package/docs/ui/getTagClass.md +30 -0
  1054. package/docs/ui/getTreeElement.md +36 -0
  1055. package/docs/ui/getTypographyClass.md +113 -0
  1056. package/docs/ui/getWidthClass.md +60 -0
  1057. package/docs/ui/isSchemaRequired.md +30 -0
  1058. package/docs/ui/joinMetaCSP.md +30 -0
  1059. package/docs/ui/joinTitles.md +30 -0
  1060. package/docs/ui/loopFocus.md +27 -0
  1061. package/docs/ui/matchMenuElement.md +37 -0
  1062. package/docs/ui/mergeMeta.md +57 -0
  1063. package/docs/ui/mergeMetaAssets.md +36 -0
  1064. package/docs/ui/mergeMetaLinks.md +36 -0
  1065. package/docs/ui/mergeMetaTags.md +25 -0
  1066. package/docs/ui/mergeMetaURL.md +36 -0
  1067. package/docs/ui/notify.md +67 -0
  1068. package/docs/ui/notifyError.md +19 -0
  1069. package/docs/ui/notifySuccess.md +19 -0
  1070. package/docs/ui/notifyThrown.md +22 -0
  1071. package/docs/ui/notifyThrownForm.md +33 -0
  1072. package/docs/ui/requireContext.md +59 -0
  1073. package/docs/ui/requireDialogs.md +18 -0
  1074. package/docs/ui/requireForm.md +36 -0
  1075. package/docs/ui/requireMeta.md +39 -0
  1076. package/docs/ui/requireMetaURL.md +45 -0
  1077. package/docs/ui/requireNavigation.md +24 -0
  1078. package/docs/ui/setTransitionType.md +24 -0
  1079. package/docs/ui/splitType.md +26 -0
  1080. package/docs/ui/subscribeNotices.md +27 -0
  1081. package/docs/ui/useDebouncedCallback.md +34 -0
  1082. package/docs/ui/useDebouncedState.md +33 -0
  1083. package/docs/ui/useField.md +32 -0
  1084. package/docs/ui/useRefresh.md +27 -0
  1085. package/docs/ui/useScrollIntersect.md +34 -0
  1086. package/docs/ui/useTransitionValue.md +28 -0
  1087. package/docs/ui/useTreeMap.md +26 -0
  1088. package/docs/ui.md +542 -0
  1089. package/docs/util/ansi/ANSI_BLACK.md +6 -0
  1090. package/docs/util/ansi/ANSI_BLUE.md +6 -0
  1091. package/docs/util/ansi/ANSI_BOLD.md +6 -0
  1092. package/docs/util/ansi/ANSI_CYAN.md +6 -0
  1093. package/docs/util/ansi/ANSI_DEFAULT.md +6 -0
  1094. package/docs/util/ansi/ANSI_DOWN.md +6 -0
  1095. package/docs/util/ansi/ANSI_FAILURE.md +6 -0
  1096. package/docs/util/ansi/ANSI_GREEN.md +6 -0
  1097. package/docs/util/ansi/ANSI_INVERSE.md +6 -0
  1098. package/docs/util/ansi/ANSI_ITALIC.md +6 -0
  1099. package/docs/util/ansi/ANSI_LEFT.md +6 -0
  1100. package/docs/util/ansi/ANSI_MAGENTA.md +6 -0
  1101. package/docs/util/ansi/ANSI_RED.md +6 -0
  1102. package/docs/util/ansi/ANSI_RESET.md +6 -0
  1103. package/docs/util/ansi/ANSI_RIGHT.md +6 -0
  1104. package/docs/util/ansi/ANSI_STRIKE.md +6 -0
  1105. package/docs/util/ansi/ANSI_SUCCESS.md +6 -0
  1106. package/docs/util/ansi/ANSI_UNDERLINE.md +6 -0
  1107. package/docs/util/ansi/ANSI_UP.md +6 -0
  1108. package/docs/util/ansi/ANSI_WAITING.md +6 -0
  1109. package/docs/util/ansi/ANSI_WHITE.md +6 -0
  1110. package/docs/util/ansi/ANSI_YELLOW.md +6 -0
  1111. package/docs/util/ansi/ansiWrap.md +28 -0
  1112. package/docs/util/ansi.md +73 -0
  1113. package/docs/util/array/ArrayItem.md +12 -0
  1114. package/docs/util/array/ImmutableArray.md +13 -0
  1115. package/docs/util/array/MutableArray.md +13 -0
  1116. package/docs/util/array/PossibleArray.md +17 -0
  1117. package/docs/util/array/addArrayItem.md +26 -0
  1118. package/docs/util/array/addArrayItems.md +20 -0
  1119. package/docs/util/array/assertArray.md +71 -0
  1120. package/docs/util/array/assertArrayItem.md +32 -0
  1121. package/docs/util/array/countArray.md +30 -0
  1122. package/docs/util/array/deleteArrayItem.md +12 -0
  1123. package/docs/util/array/deleteArrayItems.md +19 -0
  1124. package/docs/util/array/getArray.md +24 -0
  1125. package/docs/util/array/getFirst.md +24 -0
  1126. package/docs/util/array/getLast.md +24 -0
  1127. package/docs/util/array/getNext.md +25 -0
  1128. package/docs/util/array/getPrev.md +25 -0
  1129. package/docs/util/array/getUniqueArray.md +24 -0
  1130. package/docs/util/array/interleaveArray.md +29 -0
  1131. package/docs/util/array/isArray.md +63 -0
  1132. package/docs/util/array/isArrayItem.md +25 -0
  1133. package/docs/util/array/limitArray.md +31 -0
  1134. package/docs/util/array/omitArrayIndex.md +25 -0
  1135. package/docs/util/array/omitArrayItem.md +18 -0
  1136. package/docs/util/array/omitArrayItems.md +25 -0
  1137. package/docs/util/array/pickArrayItem.md +18 -0
  1138. package/docs/util/array/pickArrayItems.md +25 -0
  1139. package/docs/util/array/requireArray.md +71 -0
  1140. package/docs/util/array/requireFirst.md +31 -0
  1141. package/docs/util/array/requireLast.md +31 -0
  1142. package/docs/util/array/requireNext.md +32 -0
  1143. package/docs/util/array/requirePrev.md +32 -0
  1144. package/docs/util/array/shuffleArray.md +24 -0
  1145. package/docs/util/array/toggleArrayItem.md +18 -0
  1146. package/docs/util/array/toggleArrayItems.md +25 -0
  1147. package/docs/util/array/withArrayIndex.md +26 -0
  1148. package/docs/util/array/withArrayItem.md +18 -0
  1149. package/docs/util/array/withArrayItems.md +25 -0
  1150. package/docs/util/array.md +132 -0
  1151. package/docs/util/async/BasePromise.md +27 -0
  1152. package/docs/util/async/Deferred.md +30 -0
  1153. package/docs/util/async/assertAsync.md +36 -0
  1154. package/docs/util/async/assertNotAsync.md +36 -0
  1155. package/docs/util/async/assertPromise.md +36 -0
  1156. package/docs/util/async/awaitAbort.md +32 -0
  1157. package/docs/util/async/awaitErrors.md +24 -0
  1158. package/docs/util/async/awaitRace.md +33 -0
  1159. package/docs/util/async/awaitValues.md +35 -0
  1160. package/docs/util/async/createDeferred.md +19 -0
  1161. package/docs/util/async/getDelay.md +24 -0
  1162. package/docs/util/async/isAsync.md +24 -0
  1163. package/docs/util/async/notAsync.md +24 -0
  1164. package/docs/util/async/runMicrotasks.md +18 -0
  1165. package/docs/util/async/throwAsync.md +30 -0
  1166. package/docs/util/async.md +90 -0
  1167. package/docs/util/base64/decodeBase64Bytes.md +30 -0
  1168. package/docs/util/base64/decodeBase64String.md +30 -0
  1169. package/docs/util/base64/decodeBase64URLBytes.md +30 -0
  1170. package/docs/util/base64/decodeBase64URLString.md +30 -0
  1171. package/docs/util/base64/encodeBase64.md +31 -0
  1172. package/docs/util/base64/encodeBase64URL.md +31 -0
  1173. package/docs/util/base64.md +57 -0
  1174. package/docs/util/boolean/assertBoolean.md +31 -0
  1175. package/docs/util/boolean/assertFalse.md +31 -0
  1176. package/docs/util/boolean/assertFalsy.md +31 -0
  1177. package/docs/util/boolean/assertTrue.md +31 -0
  1178. package/docs/util/boolean/assertTruthy.md +31 -0
  1179. package/docs/util/boolean/isBoolean.md +24 -0
  1180. package/docs/util/boolean/isFalse.md +24 -0
  1181. package/docs/util/boolean/isFalsey.md +24 -0
  1182. package/docs/util/boolean/isTrue.md +24 -0
  1183. package/docs/util/boolean/isTruthy.md +24 -0
  1184. package/docs/util/boolean.md +47 -0
  1185. package/docs/util/buffer/TypedArray.md +30 -0
  1186. package/docs/util/buffer/isBuffer.md +24 -0
  1187. package/docs/util/buffer/isBufferView.md +24 -0
  1188. package/docs/util/buffer/isTypedArray.md +24 -0
  1189. package/docs/util/buffer.md +35 -0
  1190. package/docs/util/bytes/Bytes.md +17 -0
  1191. package/docs/util/bytes/PossibleBytes.md +17 -0
  1192. package/docs/util/bytes/assertBytes.md +33 -0
  1193. package/docs/util/bytes/getBytes.md +29 -0
  1194. package/docs/util/bytes/isBytes.md +24 -0
  1195. package/docs/util/bytes/requireBytes.md +33 -0
  1196. package/docs/util/bytes.md +50 -0
  1197. package/docs/util/class/AnyConstructor.md +12 -0
  1198. package/docs/util/class/Class.md +12 -0
  1199. package/docs/util/class/Constructor.md +12 -0
  1200. package/docs/util/class/assertInstance.md +31 -0
  1201. package/docs/util/class/getGetter.md +25 -0
  1202. package/docs/util/class/getSetter.md +25 -0
  1203. package/docs/util/class/isConstructor.md +24 -0
  1204. package/docs/util/class/isInstance.md +25 -0
  1205. package/docs/util/class.md +52 -0
  1206. package/docs/util/color/Color/from.md +12 -0
  1207. package/docs/util/color/Color/toString.md +12 -0
  1208. package/docs/util/color/Color.md +50 -0
  1209. package/docs/util/color/HEX3_REGEXP.md +6 -0
  1210. package/docs/util/color/HEX6_REGEXP.md +6 -0
  1211. package/docs/util/color/PossibleColor.md +16 -0
  1212. package/docs/util/color/assertColor.md +31 -0
  1213. package/docs/util/color/getColor.md +24 -0
  1214. package/docs/util/color/isColor.md +24 -0
  1215. package/docs/util/color/requireColor.md +31 -0
  1216. package/docs/util/color.md +78 -0
  1217. package/docs/util/constants/ABORT.md +12 -0
  1218. package/docs/util/constants/BILLION.md +6 -0
  1219. package/docs/util/constants/DAY.md +6 -0
  1220. package/docs/util/constants/DOWN.md +6 -0
  1221. package/docs/util/constants/FAILURE.md +6 -0
  1222. package/docs/util/constants/HOUR.md +6 -0
  1223. package/docs/util/constants/HUNDRED_THOUSAND.md +6 -0
  1224. package/docs/util/constants/LEFT.md +6 -0
  1225. package/docs/util/constants/MILLION.md +6 -0
  1226. package/docs/util/constants/MINUTE.md +6 -0
  1227. package/docs/util/constants/MONTH.md +7 -0
  1228. package/docs/util/constants/NBSP.md +6 -0
  1229. package/docs/util/constants/NNBSP.md +6 -0
  1230. package/docs/util/constants/NONE.md +12 -0
  1231. package/docs/util/constants/RIGHT.md +6 -0
  1232. package/docs/util/constants/SECOND.md +6 -0
  1233. package/docs/util/constants/SKIP.md +12 -0
  1234. package/docs/util/constants/SUCCESS.md +6 -0
  1235. package/docs/util/constants/TEN_THOUSAND.md +6 -0
  1236. package/docs/util/constants/THINSP.md +6 -0
  1237. package/docs/util/constants/THOUSAND.md +6 -0
  1238. package/docs/util/constants/TRILLION.md +6 -0
  1239. package/docs/util/constants/UP.md +6 -0
  1240. package/docs/util/constants/WAITING.md +6 -0
  1241. package/docs/util/constants/WEEK.md +6 -0
  1242. package/docs/util/constants/YEAR.md +7 -0
  1243. package/docs/util/constants.md +93 -0
  1244. package/docs/util/crypto/getRandomBytes.md +24 -0
  1245. package/docs/util/crypto/hashPassword.md +31 -0
  1246. package/docs/util/crypto/verifyPassword.md +25 -0
  1247. package/docs/util/crypto.md +42 -0
  1248. package/docs/util/currency/CURRENCY_CODES.md +12 -0
  1249. package/docs/util/currency/CurrencyCode.md +12 -0
  1250. package/docs/util/currency/getCurrencyCode.md +25 -0
  1251. package/docs/util/currency/getCurrencyStep.md +32 -0
  1252. package/docs/util/currency/getCurrencySymbol.md +31 -0
  1253. package/docs/util/currency/requireCurrencyCode.md +31 -0
  1254. package/docs/util/currency.md +54 -0
  1255. package/docs/util/data/BranchData.md +18 -0
  1256. package/docs/util/data/BranchDataPath.md +16 -0
  1257. package/docs/util/data/BranchDataProp.md +32 -0
  1258. package/docs/util/data/BranchDataSegments.md +22 -0
  1259. package/docs/util/data/BranchDataValue.md +16 -0
  1260. package/docs/util/data/Data.md +12 -0
  1261. package/docs/util/data/DataKey.md +12 -0
  1262. package/docs/util/data/DataProp.md +20 -0
  1263. package/docs/util/data/DataValue.md +16 -0
  1264. package/docs/util/data/FlatData.md +15 -0
  1265. package/docs/util/data/LeafData.md +18 -0
  1266. package/docs/util/data/LeafDataPath.md +16 -0
  1267. package/docs/util/data/LeafDataProp.md +32 -0
  1268. package/docs/util/data/LeafDataSegments.md +22 -0
  1269. package/docs/util/data/LeafDataValue.md +16 -0
  1270. package/docs/util/data/NestedData.md +19 -0
  1271. package/docs/util/data/PartialData.md +16 -0
  1272. package/docs/util/data/assertData.md +31 -0
  1273. package/docs/util/data/assertDataProp.md +32 -0
  1274. package/docs/util/data/getDataKeys.md +27 -0
  1275. package/docs/util/data/getDataProp.md +33 -0
  1276. package/docs/util/data/getDataProps.md +27 -0
  1277. package/docs/util/data/isData.md +24 -0
  1278. package/docs/util/data/isDataProp.md +25 -0
  1279. package/docs/util/data/joinDataPath.md +31 -0
  1280. package/docs/util/data/splitDataPath.md +31 -0
  1281. package/docs/util/data.md +109 -0
  1282. package/docs/util/date/DAYS.md +6 -0
  1283. package/docs/util/date/Day.md +12 -0
  1284. package/docs/util/date/PossibleDate.md +16 -0
  1285. package/docs/util/date/addDays.md +26 -0
  1286. package/docs/util/date/addHours.md +26 -0
  1287. package/docs/util/date/addMilliseconds.md +32 -0
  1288. package/docs/util/date/addMinutes.md +26 -0
  1289. package/docs/util/date/addMonths.md +28 -0
  1290. package/docs/util/date/addSeconds.md +32 -0
  1291. package/docs/util/date/addWeeks.md +26 -0
  1292. package/docs/util/date/addYears.md +27 -0
  1293. package/docs/util/date/assertDate.md +31 -0
  1294. package/docs/util/date/getDate.md +25 -0
  1295. package/docs/util/date/getDateString.md +24 -0
  1296. package/docs/util/date/getDateTimeString.md +24 -0
  1297. package/docs/util/date/getDay.md +24 -0
  1298. package/docs/util/date/getMidnight.md +31 -0
  1299. package/docs/util/date/getMonday.md +31 -0
  1300. package/docs/util/date/getMonthStart.md +31 -0
  1301. package/docs/util/date/getNow.md +18 -0
  1302. package/docs/util/date/getTimeString.md +24 -0
  1303. package/docs/util/date/getTimestamp.md +24 -0
  1304. package/docs/util/date/getToday.md +18 -0
  1305. package/docs/util/date/getTomorrow.md +18 -0
  1306. package/docs/util/date/getYesterday.md +18 -0
  1307. package/docs/util/date/isDate.md +25 -0
  1308. package/docs/util/date/requireDate.md +31 -0
  1309. package/docs/util/date/requireDateString.md +25 -0
  1310. package/docs/util/date/requireDateTimeString.md +31 -0
  1311. package/docs/util/date/requireTimeString.md +25 -0
  1312. package/docs/util/date/requireTimestamp.md +30 -0
  1313. package/docs/util/date.md +126 -0
  1314. package/docs/util/debug/debug.md +82 -0
  1315. package/docs/util/debug/debugArray.md +27 -0
  1316. package/docs/util/debug/debugFullRequest.md +26 -0
  1317. package/docs/util/debug/debugFullResponse.md +27 -0
  1318. package/docs/util/debug/debugHeaders.md +25 -0
  1319. package/docs/util/debug/debugMap.md +27 -0
  1320. package/docs/util/debug/debugObject.md +27 -0
  1321. package/docs/util/debug/debugRequest.md +25 -0
  1322. package/docs/util/debug/debugResponse.md +25 -0
  1323. package/docs/util/debug/debugSet.md +27 -0
  1324. package/docs/util/debug/debugString.md +25 -0
  1325. package/docs/util/debug/indent.md +26 -0
  1326. package/docs/util/debug.md +19 -0
  1327. package/docs/util/dictionary/DictionaryItem.md +13 -0
  1328. package/docs/util/dictionary/DictionaryValue.md +12 -0
  1329. package/docs/util/dictionary/EMPTY_DICTIONARY.md +12 -0
  1330. package/docs/util/dictionary/EmptyDictionary.md +12 -0
  1331. package/docs/util/dictionary/ImmutableDictionary.md +13 -0
  1332. package/docs/util/dictionary/MutableDictionary.md +13 -0
  1333. package/docs/util/dictionary/PossibleDictionary.md +19 -0
  1334. package/docs/util/dictionary/assertDictionary.md +31 -0
  1335. package/docs/util/dictionary/assertDictionaryItem.md +32 -0
  1336. package/docs/util/dictionary/deleteDictionaryItem.md +12 -0
  1337. package/docs/util/dictionary/deleteDictionaryItems.md +12 -0
  1338. package/docs/util/dictionary/getDictionaryItem.md +25 -0
  1339. package/docs/util/dictionary/getDictionaryItems.md +27 -0
  1340. package/docs/util/dictionary/isDictionary.md +24 -0
  1341. package/docs/util/dictionary/isDictionaryItem.md +25 -0
  1342. package/docs/util/dictionary/omitDictionaryItem.md +19 -0
  1343. package/docs/util/dictionary/omitDictionaryItems.md +19 -0
  1344. package/docs/util/dictionary/pickDictionaryItems.md +18 -0
  1345. package/docs/util/dictionary/requireDictionary.md +25 -0
  1346. package/docs/util/dictionary/requireDictionaryItem.md +32 -0
  1347. package/docs/util/dictionary/setDictionaryItem.md +19 -0
  1348. package/docs/util/dictionary/setDictionaryItems.md +13 -0
  1349. package/docs/util/dictionary/withDictionaryItem.md +19 -0
  1350. package/docs/util/dictionary/withDictionaryItems.md +19 -0
  1351. package/docs/util/dictionary.md +103 -0
  1352. package/docs/util/diff/SAME.md +13 -0
  1353. package/docs/util/diff/deepDiff.md +29 -0
  1354. package/docs/util/diff/deepDiffArray.md +26 -0
  1355. package/docs/util/diff/deepDiffObject.md +28 -0
  1356. package/docs/util/diff.md +68 -0
  1357. package/docs/util/dispose/DisposableMap.md +24 -0
  1358. package/docs/util/dispose/DisposableSet.md +23 -0
  1359. package/docs/util/dispose/awaitDispose.md +38 -0
  1360. package/docs/util/dispose/dispose.md +97 -0
  1361. package/docs/util/dispose/isAsyncDisposable.md +24 -0
  1362. package/docs/util/dispose/isDisposable.md +24 -0
  1363. package/docs/util/dispose.md +16 -0
  1364. package/docs/util/duration/DURATION_UNITS.md +6 -0
  1365. package/docs/util/duration/DurationData.md +16 -0
  1366. package/docs/util/duration/DurationUnitKey.md +16 -0
  1367. package/docs/util/duration/formatAgo.md +38 -0
  1368. package/docs/util/duration/formatDuration.md +25 -0
  1369. package/docs/util/duration/formatUntil.md +37 -0
  1370. package/docs/util/duration/formatWhen.md +38 -0
  1371. package/docs/util/duration/getAgo.md +32 -0
  1372. package/docs/util/duration/getBestDurationUnit.md +32 -0
  1373. package/docs/util/duration/getDaysAgo.md +33 -0
  1374. package/docs/util/duration/getDaysUntil.md +33 -0
  1375. package/docs/util/duration/getDuration.md +32 -0
  1376. package/docs/util/duration/getHoursAgo.md +33 -0
  1377. package/docs/util/duration/getHoursUntil.md +33 -0
  1378. package/docs/util/duration/getMilliseconds.md +32 -0
  1379. package/docs/util/duration/getMillisecondsAgo.md +32 -0
  1380. package/docs/util/duration/getMillisecondsUntil.md +32 -0
  1381. package/docs/util/duration/getMinutesAgo.md +33 -0
  1382. package/docs/util/duration/getMinutesUntil.md +33 -0
  1383. package/docs/util/duration/getMonthsAgo.md +33 -0
  1384. package/docs/util/duration/getMonthsUntil.md +33 -0
  1385. package/docs/util/duration/getSecondsAgo.md +33 -0
  1386. package/docs/util/duration/getSecondsUntil.md +33 -0
  1387. package/docs/util/duration/getUntil.md +32 -0
  1388. package/docs/util/duration/getWeeksAgo.md +33 -0
  1389. package/docs/util/duration/getWeeksUntil.md +33 -0
  1390. package/docs/util/duration/getYearsAgo.md +34 -0
  1391. package/docs/util/duration/getYearsUntil.md +33 -0
  1392. package/docs/util/duration/isFuture.md +32 -0
  1393. package/docs/util/duration/isPast.md +32 -0
  1394. package/docs/util/duration/isToday.md +32 -0
  1395. package/docs/util/duration.md +106 -0
  1396. package/docs/util/element/Element.md +31 -0
  1397. package/docs/util/element/ElementProps.md +24 -0
  1398. package/docs/util/element/Elements.md +17 -0
  1399. package/docs/util/element/filterElements.md +25 -0
  1400. package/docs/util/element/getElementText.md +25 -0
  1401. package/docs/util/element/isElement.md +24 -0
  1402. package/docs/util/element/isElements.md +24 -0
  1403. package/docs/util/element/mergeElements.md +30 -0
  1404. package/docs/util/element/queryElements.md +26 -0
  1405. package/docs/util/element/walkElements.md +31 -0
  1406. package/docs/util/element.md +59 -0
  1407. package/docs/util/entity/EMPTY_ENTITY.md +12 -0
  1408. package/docs/util/entity/EmptyEntity.md +12 -0
  1409. package/docs/util/entity/Entity.md +12 -0
  1410. package/docs/util/entity/EntityType.md +17 -0
  1411. package/docs/util/entity/getEntity.md +30 -0
  1412. package/docs/util/entity/requireEntity.md +35 -0
  1413. package/docs/util/entity.md +50 -0
  1414. package/docs/util/entry/Entry.md +14 -0
  1415. package/docs/util/entry/EntryKey.md +17 -0
  1416. package/docs/util/entry/EntryObject.md +17 -0
  1417. package/docs/util/entry/EntryValue.md +17 -0
  1418. package/docs/util/entry/getEntries.md +29 -0
  1419. package/docs/util/entry/getEntryKey.md +24 -0
  1420. package/docs/util/entry/getEntryKeys.md +24 -0
  1421. package/docs/util/entry/getEntryValue.md +24 -0
  1422. package/docs/util/entry/getEntryValues.md +24 -0
  1423. package/docs/util/entry.md +62 -0
  1424. package/docs/util/env/getEnv.md +24 -0
  1425. package/docs/util/env/getEnvBoolean.md +26 -0
  1426. package/docs/util/env/requireEnv.md +31 -0
  1427. package/docs/util/env/requireEnvBoolean.md +31 -0
  1428. package/docs/util/env.md +37 -0
  1429. package/docs/util/equal/assertEqual.md +32 -0
  1430. package/docs/util/equal/assertNot.md +32 -0
  1431. package/docs/util/equal/isArrayEqual.md +26 -0
  1432. package/docs/util/equal/isArrayWith.md +25 -0
  1433. package/docs/util/equal/isDeepEqual.md +26 -0
  1434. package/docs/util/equal/isEqual.md +25 -0
  1435. package/docs/util/equal/isEqualGreater.md +25 -0
  1436. package/docs/util/equal/isEqualLess.md +25 -0
  1437. package/docs/util/equal/isGreater.md +25 -0
  1438. package/docs/util/equal/isInArray.md +25 -0
  1439. package/docs/util/equal/isLess.md +25 -0
  1440. package/docs/util/equal/isMapEqual.md +26 -0
  1441. package/docs/util/equal/isObjectEqual.md +28 -0
  1442. package/docs/util/equal/isObjectMatch.md +28 -0
  1443. package/docs/util/equal/isObjectWith.md +25 -0
  1444. package/docs/util/equal/isShallowEqual.md +26 -0
  1445. package/docs/util/equal/notArrayWith.md +25 -0
  1446. package/docs/util/equal/notDeepEqual.md +25 -0
  1447. package/docs/util/equal/notEqual.md +25 -0
  1448. package/docs/util/equal/notInArray.md +25 -0
  1449. package/docs/util/equal/notObjectWith.md +25 -0
  1450. package/docs/util/equal/notShallowEqual.md +25 -0
  1451. package/docs/util/equal.md +102 -0
  1452. package/docs/util/error/PossibleMessage.md +12 -0
  1453. package/docs/util/error/getMessage.md +24 -0
  1454. package/docs/util/error/getNamedMessage.md +26 -0
  1455. package/docs/util/error/isError.md +25 -0
  1456. package/docs/util/error/joinMessage.md +27 -0
  1457. package/docs/util/error/logError.md +24 -0
  1458. package/docs/util/error/requireMessage.md +31 -0
  1459. package/docs/util/error/splitMessage.md +33 -0
  1460. package/docs/util/error.md +67 -0
  1461. package/docs/util/file/FileCapture.md +14 -0
  1462. package/docs/util/file/FileTypes.md +14 -0
  1463. package/docs/util/file/IMAGE_TYPES.md +12 -0
  1464. package/docs/util/file/MEDIA_TYPES.md +12 -0
  1465. package/docs/util/file/VIDEO_TYPES.md +12 -0
  1466. package/docs/util/file/getFileAccept.md +25 -0
  1467. package/docs/util/file/getFileExtension.md +24 -0
  1468. package/docs/util/file/requireFileExtension.md +31 -0
  1469. package/docs/util/file/splitFileExtension.md +26 -0
  1470. package/docs/util/file.md +49 -0
  1471. package/docs/util/filter/Match.md +12 -0
  1472. package/docs/util/filter/filterArray.md +27 -0
  1473. package/docs/util/filter/filterItems.md +26 -0
  1474. package/docs/util/filter/filterSequence.md +26 -0
  1475. package/docs/util/filter.md +57 -0
  1476. package/docs/util/focus/getFirstFocusable.md +25 -0
  1477. package/docs/util/focus.md +25 -0
  1478. package/docs/util/format/ArrayFormatOptions.md +13 -0
  1479. package/docs/util/format/CurrencyFormatOptions.md +13 -0
  1480. package/docs/util/format/DateFormatOptions.md +21 -0
  1481. package/docs/util/format/FormatOptions.md +20 -0
  1482. package/docs/util/format/NumberFormatOptions.md +13 -0
  1483. package/docs/util/format/PercentFormatOptions.md +13 -0
  1484. package/docs/util/format/UnitFormatOptions.md +25 -0
  1485. package/docs/util/format/formatArray.md +26 -0
  1486. package/docs/util/format/formatBoolean.md +24 -0
  1487. package/docs/util/format/formatCurrency.md +33 -0
  1488. package/docs/util/format/formatDate.md +33 -0
  1489. package/docs/util/format/formatDateTime.md +33 -0
  1490. package/docs/util/format/formatNumber.md +25 -0
  1491. package/docs/util/format/formatObject.md +27 -0
  1492. package/docs/util/format/formatPercent.md +29 -0
  1493. package/docs/util/format/formatRange.md +26 -0
  1494. package/docs/util/format/formatTime.md +33 -0
  1495. package/docs/util/format/formatURI.md +33 -0
  1496. package/docs/util/format/formatURL.md +33 -0
  1497. package/docs/util/format/formatUnit.md +35 -0
  1498. package/docs/util/format/formatUnitAbbr.md +41 -0
  1499. package/docs/util/format/formatValue.md +37 -0
  1500. package/docs/util/format/formatValues.md +33 -0
  1501. package/docs/util/format.md +114 -0
  1502. package/docs/util/function/AnyCaller.md +17 -0
  1503. package/docs/util/function/AnyFunction.md +12 -0
  1504. package/docs/util/function/Arguments.md +12 -0
  1505. package/docs/util/function/BLACKHOLE.md +24 -0
  1506. package/docs/util/function/Callback.md +12 -0
  1507. package/docs/util/function/ErrorCallback.md +12 -0
  1508. package/docs/util/function/PASSTHROUGH.md +24 -0
  1509. package/docs/util/function/UnknownFunction.md +12 -0
  1510. package/docs/util/function/ValueCallback.md +12 -0
  1511. package/docs/util/function/assertFunction.md +30 -0
  1512. package/docs/util/function/isFunction.md +24 -0
  1513. package/docs/util/function.md +65 -0
  1514. package/docs/util/geo/AddressData.md +34 -0
  1515. package/docs/util/geo/COUNTRIES.md +7 -0
  1516. package/docs/util/geo/Country.md +12 -0
  1517. package/docs/util/geo/PossibleCountry.md +16 -0
  1518. package/docs/util/geo/formatAddress.md +32 -0
  1519. package/docs/util/geo/formatCountry.md +25 -0
  1520. package/docs/util/geo/getCountry.md +26 -0
  1521. package/docs/util/geo/requireCountry.md +31 -0
  1522. package/docs/util/geo.md +74 -0
  1523. package/docs/util/hash/hashString.md +26 -0
  1524. package/docs/util/hash/hashStringBetween.md +27 -0
  1525. package/docs/util/hash.md +29 -0
  1526. package/docs/util/http/OptionalRequestHandler.md +18 -0
  1527. package/docs/util/http/OptionalRequestHandlers.md +17 -0
  1528. package/docs/util/http/RequestBodyMethod.md +12 -0
  1529. package/docs/util/http/RequestHandler.md +18 -0
  1530. package/docs/util/http/RequestHeadMethod.md +12 -0
  1531. package/docs/util/http/RequestMethod.md +17 -0
  1532. package/docs/util/http/RequestOptions.md +20 -0
  1533. package/docs/util/http/RequestParams.md +16 -0
  1534. package/docs/util/http/assertRequestHeadPayload.md +38 -0
  1535. package/docs/util/http/createFormDataRequest.md +35 -0
  1536. package/docs/util/http/createHeadRequest.md +29 -0
  1537. package/docs/util/http/createJSONRequest.md +30 -0
  1538. package/docs/util/http/createRequest.md +40 -0
  1539. package/docs/util/http/createTextRequest.md +36 -0
  1540. package/docs/util/http/createXMLRequest.md +42 -0
  1541. package/docs/util/http/getErrorResponse.md +32 -0
  1542. package/docs/util/http/getResponse.md +27 -0
  1543. package/docs/util/http/isRequestHeadMethod.md +30 -0
  1544. package/docs/util/http/isRequestMethod.md +30 -0
  1545. package/docs/util/http/mergeRequestOptions.md +28 -0
  1546. package/docs/util/http/parseRequestBody.md +34 -0
  1547. package/docs/util/http/parseRequestFormData.md +37 -0
  1548. package/docs/util/http/parseRequestJSON.md +31 -0
  1549. package/docs/util/http/parseResponseBody.md +33 -0
  1550. package/docs/util/http/parseResponseFormData.md +37 -0
  1551. package/docs/util/http/parseResponseJSON.md +37 -0
  1552. package/docs/util/http.md +104 -0
  1553. package/docs/util/hydrate/DehydratedObject.md +22 -0
  1554. package/docs/util/hydrate/Hydrations.md +18 -0
  1555. package/docs/util/hydrate/dehydrate.md +35 -0
  1556. package/docs/util/hydrate/hydrate.md +88 -0
  1557. package/docs/util/hydrate.md +14 -0
  1558. package/docs/util/index.md +4 -0
  1559. package/docs/util/item/Identifier.md +12 -0
  1560. package/docs/util/item/Item.md +12 -0
  1561. package/docs/util/item/ItemSequence.md +17 -0
  1562. package/docs/util/item/Items.md +17 -0
  1563. package/docs/util/item/ItemsSequence.md +17 -0
  1564. package/docs/util/item/OptionalItem.md +16 -0
  1565. package/docs/util/item/OptionalItemSequence.md +17 -0
  1566. package/docs/util/item/getIdentifier.md +24 -0
  1567. package/docs/util/item/getIdentifiers.md +24 -0
  1568. package/docs/util/item/getItem.md +26 -0
  1569. package/docs/util/item/hasIdentifier.md +25 -0
  1570. package/docs/util/item.md +68 -0
  1571. package/docs/util/iterate/DeepIterable.md +17 -0
  1572. package/docs/util/iterate/countItems.md +25 -0
  1573. package/docs/util/iterate/flattenItems.md +24 -0
  1574. package/docs/util/iterate/getChunks.md +26 -0
  1575. package/docs/util/iterate/getRange.md +27 -0
  1576. package/docs/util/iterate/hasItems.md +25 -0
  1577. package/docs/util/iterate/interleaveItems.md +29 -0
  1578. package/docs/util/iterate/isIterable.md +24 -0
  1579. package/docs/util/iterate/limitItems.md +26 -0
  1580. package/docs/util/iterate/mergeItems.md +25 -0
  1581. package/docs/util/iterate/omitItems.md +26 -0
  1582. package/docs/util/iterate/pickItems.md +26 -0
  1583. package/docs/util/iterate/reduceItems.md +41 -0
  1584. package/docs/util/iterate.md +84 -0
  1585. package/docs/util/jwt/TokenClaims.md +26 -0
  1586. package/docs/util/jwt/TokenData.md +35 -0
  1587. package/docs/util/jwt/encodeToken.md +36 -0
  1588. package/docs/util/jwt/getRequestToken.md +24 -0
  1589. package/docs/util/jwt/requireRequestToken.md +31 -0
  1590. package/docs/util/jwt/setRequestToken.md +25 -0
  1591. package/docs/util/jwt/splitToken.md +32 -0
  1592. package/docs/util/jwt/verifyRequestToken.md +33 -0
  1593. package/docs/util/jwt/verifyToken.md +35 -0
  1594. package/docs/util/jwt.md +78 -0
  1595. package/docs/util/lazy/Lazy.md +12 -0
  1596. package/docs/util/lazy/getLazy.md +37 -0
  1597. package/docs/util/lazy.md +12 -0
  1598. package/docs/util/link/PossibleLink.md +16 -0
  1599. package/docs/util/link/getLink.md +43 -0
  1600. package/docs/util/link/requireLink.md +41 -0
  1601. package/docs/util/link.md +47 -0
  1602. package/docs/util/log/logRequest.md +24 -0
  1603. package/docs/util/log/logRequestError.md +25 -0
  1604. package/docs/util/log/logRequestResponse.md +25 -0
  1605. package/docs/util/log.md +28 -0
  1606. package/docs/util/map/ImmutableMap.md +17 -0
  1607. package/docs/util/map/MapItem.md +17 -0
  1608. package/docs/util/map/MapKey.md +17 -0
  1609. package/docs/util/map/MapValue.md +17 -0
  1610. package/docs/util/map/MutableMap.md +16 -0
  1611. package/docs/util/map/PossibleMap.md +18 -0
  1612. package/docs/util/map/PossibleStringMap.md +16 -0
  1613. package/docs/util/map/assertMap.md +31 -0
  1614. package/docs/util/map/assertMapItem.md +32 -0
  1615. package/docs/util/map/getMap.md +27 -0
  1616. package/docs/util/map/getMapItem.md +25 -0
  1617. package/docs/util/map/isMap.md +24 -0
  1618. package/docs/util/map/isMapItem.md +25 -0
  1619. package/docs/util/map/limitMap.md +26 -0
  1620. package/docs/util/map/removeMapItems.md +25 -0
  1621. package/docs/util/map/requireMapItem.md +32 -0
  1622. package/docs/util/map/setMapItem.md +26 -0
  1623. package/docs/util/map/setMapItems.md +25 -0
  1624. package/docs/util/map.md +91 -0
  1625. package/docs/util/merge/deepMerge.md +37 -0
  1626. package/docs/util/merge/exactMerge.md +26 -0
  1627. package/docs/util/merge/mergeArray.md +28 -0
  1628. package/docs/util/merge/mergeObject.md +32 -0
  1629. package/docs/util/merge/shallowMerge.md +37 -0
  1630. package/docs/util/merge.md +67 -0
  1631. package/docs/util/null/Nullable.md +12 -0
  1632. package/docs/util/null/Nullish.md +12 -0
  1633. package/docs/util/null/assertNotNull.md +31 -0
  1634. package/docs/util/null/assertNotNullish.md +31 -0
  1635. package/docs/util/null/assertNull.md +31 -0
  1636. package/docs/util/null/assertNullish.md +31 -0
  1637. package/docs/util/null/getNull.md +19 -0
  1638. package/docs/util/null/isNull.md +24 -0
  1639. package/docs/util/null/isNullish.md +24 -0
  1640. package/docs/util/null/notNull.md +24 -0
  1641. package/docs/util/null/notNullish.md +24 -0
  1642. package/docs/util/null/requireNotNull.md +31 -0
  1643. package/docs/util/null/requireNotNullish.md +31 -0
  1644. package/docs/util/null.md +55 -0
  1645. package/docs/util/number/PossibleNumber.md +16 -0
  1646. package/docs/util/number/assertInteger.md +33 -0
  1647. package/docs/util/number/assertNumber.md +33 -0
  1648. package/docs/util/number/boundNumber.md +33 -0
  1649. package/docs/util/number/getClosestNumber.md +25 -0
  1650. package/docs/util/number/getInteger.md +31 -0
  1651. package/docs/util/number/getNumber.md +32 -0
  1652. package/docs/util/number/getPercent.md +25 -0
  1653. package/docs/util/number/isBetween.md +26 -0
  1654. package/docs/util/number/isInteger.md +26 -0
  1655. package/docs/util/number/isNumber.md +26 -0
  1656. package/docs/util/number/requireInteger.md +33 -0
  1657. package/docs/util/number/requireNumber.md +33 -0
  1658. package/docs/util/number/roundNumber.md +27 -0
  1659. package/docs/util/number/roundStep.md +25 -0
  1660. package/docs/util/number/sumNumbers.md +24 -0
  1661. package/docs/util/number/truncateNumber.md +26 -0
  1662. package/docs/util/number/wrapNumber.md +36 -0
  1663. package/docs/util/number.md +91 -0
  1664. package/docs/util/object/DeepMutable.md +19 -0
  1665. package/docs/util/object/DeepPartial.md +19 -0
  1666. package/docs/util/object/DeepReadonly.md +19 -0
  1667. package/docs/util/object/ImmutableObject.md +12 -0
  1668. package/docs/util/object/Key.md +12 -0
  1669. package/docs/util/object/Mutable.md +18 -0
  1670. package/docs/util/object/MutableObject.md +12 -0
  1671. package/docs/util/object/OmitProps.md +17 -0
  1672. package/docs/util/object/PickProps.md +17 -0
  1673. package/docs/util/object/PossibleObject.md +18 -0
  1674. package/docs/util/object/Prop.md +12 -0
  1675. package/docs/util/object/Value.md +12 -0
  1676. package/docs/util/object/assertObject.md +30 -0
  1677. package/docs/util/object/assertPlainObject.md +30 -0
  1678. package/docs/util/object/assertProp.md +31 -0
  1679. package/docs/util/object/cloneObject.md +24 -0
  1680. package/docs/util/object/cloneObjectWith.md +32 -0
  1681. package/docs/util/object/deleteProp.md +12 -0
  1682. package/docs/util/object/deleteProps.md +19 -0
  1683. package/docs/util/object/fromProp.md +25 -0
  1684. package/docs/util/object/getKeys.md +30 -0
  1685. package/docs/util/object/getObject.md +25 -0
  1686. package/docs/util/object/getProp.md +25 -0
  1687. package/docs/util/object/getProps.md +30 -0
  1688. package/docs/util/object/getPrototype.md +25 -0
  1689. package/docs/util/object/isObject.md +24 -0
  1690. package/docs/util/object/isPlainObject.md +25 -0
  1691. package/docs/util/object/isProp.md +25 -0
  1692. package/docs/util/object/omitProp.md +19 -0
  1693. package/docs/util/object/omitProps.md +26 -0
  1694. package/docs/util/object/pickProps.md +25 -0
  1695. package/docs/util/object/setProp.md +27 -0
  1696. package/docs/util/object/setProps.md +20 -0
  1697. package/docs/util/object/withProp.md +27 -0
  1698. package/docs/util/object/withProps.md +30 -0
  1699. package/docs/util/object.md +140 -0
  1700. package/docs/util/path/AbsolutePath.md +12 -0
  1701. package/docs/util/path/Path.md +17 -0
  1702. package/docs/util/path/PathPart.md +12 -0
  1703. package/docs/util/path/PossiblePath.md +12 -0
  1704. package/docs/util/path/RelativePath.md +12 -0
  1705. package/docs/util/path/cleanPath.md +31 -0
  1706. package/docs/util/path/getPath.md +28 -0
  1707. package/docs/util/path/isAbsolutePath.md +24 -0
  1708. package/docs/util/path/isPathActive.md +26 -0
  1709. package/docs/util/path/isPathProud.md +26 -0
  1710. package/docs/util/path/isRelativePath.md +24 -0
  1711. package/docs/util/path/joinPath.md +31 -0
  1712. package/docs/util/path/matchPathPrefix.md +34 -0
  1713. package/docs/util/path/requirePath.md +34 -0
  1714. package/docs/util/path/splitPath.md +25 -0
  1715. package/docs/util/path.md +82 -0
  1716. package/docs/util/query/Query.md +36 -0
  1717. package/docs/util/query/QueryFilter.md +27 -0
  1718. package/docs/util/query/QueryItems.md +28 -0
  1719. package/docs/util/query/QueryOrder.md +26 -0
  1720. package/docs/util/query/compareQueryItems.md +26 -0
  1721. package/docs/util/query/filterQueryItems.md +27 -0
  1722. package/docs/util/query/getQueryAfter.md +42 -0
  1723. package/docs/util/query/getQueryBefore.md +42 -0
  1724. package/docs/util/query/getQueryFilters.md +24 -0
  1725. package/docs/util/query/getQueryItemsAfter.md +42 -0
  1726. package/docs/util/query/getQueryLimit.md +24 -0
  1727. package/docs/util/query/getQueryOrders.md +24 -0
  1728. package/docs/util/query/limitQueryItems.md +25 -0
  1729. package/docs/util/query/matchQueryItem.md +25 -0
  1730. package/docs/util/query/queryItems.md +26 -0
  1731. package/docs/util/query/queryWritableItems.md +26 -0
  1732. package/docs/util/query/sortQueryItems.md +25 -0
  1733. package/docs/util/query.md +137 -0
  1734. package/docs/util/random/getRandom.md +25 -0
  1735. package/docs/util/random/getRandomCharacter.md +24 -0
  1736. package/docs/util/random/getRandomExcept.md +27 -0
  1737. package/docs/util/random/getRandomItem.md +30 -0
  1738. package/docs/util/random/getRandomKey.md +27 -0
  1739. package/docs/util/random.md +47 -0
  1740. package/docs/util/regexp/ALWAYS_REGEXP.md +6 -0
  1741. package/docs/util/regexp/Matchable.md +17 -0
  1742. package/docs/util/regexp/Matchables.md +18 -0
  1743. package/docs/util/regexp/NEVER_REGEXP.md +6 -0
  1744. package/docs/util/regexp/NamedRegExp/exec.md +10 -0
  1745. package/docs/util/regexp/NamedRegExp.md +19 -0
  1746. package/docs/util/regexp/NamedRegExpData.md +14 -0
  1747. package/docs/util/regexp/NamedRegExpExecArray.md +21 -0
  1748. package/docs/util/regexp/PossibleRegExp.md +17 -0
  1749. package/docs/util/regexp/TypedRegExp/exec.md +10 -0
  1750. package/docs/util/regexp/TypedRegExp.md +19 -0
  1751. package/docs/util/regexp/TypedRegExpExecArray.md +15 -0
  1752. package/docs/util/regexp/allMatch.md +25 -0
  1753. package/docs/util/regexp/anyMatch.md +25 -0
  1754. package/docs/util/regexp/assertRegExp.md +30 -0
  1755. package/docs/util/regexp/createRegExpAll.md +26 -0
  1756. package/docs/util/regexp/createRegExpAny.md +26 -0
  1757. package/docs/util/regexp/escapeRegExp.md +25 -0
  1758. package/docs/util/regexp/getMatch.md +32 -0
  1759. package/docs/util/regexp/getMatchGroups.md +29 -0
  1760. package/docs/util/regexp/getRegExp.md +30 -0
  1761. package/docs/util/regexp/getRegExpSource.md +25 -0
  1762. package/docs/util/regexp/isMatch.md +26 -0
  1763. package/docs/util/regexp/isRegExp.md +24 -0
  1764. package/docs/util/regexp/noneMatch.md +25 -0
  1765. package/docs/util/regexp/notMatch.md +26 -0
  1766. package/docs/util/regexp/requireMatch.md +38 -0
  1767. package/docs/util/regexp/requireMatchGroups.md +35 -0
  1768. package/docs/util/regexp.md +105 -0
  1769. package/docs/util/sequence/IteratorAbortResult.md +23 -0
  1770. package/docs/util/sequence/IteratorAbortableResult.md +18 -0
  1771. package/docs/util/sequence/callSequence.md +26 -0
  1772. package/docs/util/sequence/isSequence.md +25 -0
  1773. package/docs/util/sequence/mergeSequences.md +25 -0
  1774. package/docs/util/sequence/repeatDelay.md +24 -0
  1775. package/docs/util/sequence/repeatUntil.md +32 -0
  1776. package/docs/util/sequence/runSequence.md +38 -0
  1777. package/docs/util/sequence.md +99 -0
  1778. package/docs/util/serialise/serialise.md +81 -0
  1779. package/docs/util/serialise.md +8 -0
  1780. package/docs/util/set/ImmutableSet.md +16 -0
  1781. package/docs/util/set/MutableSet.md +16 -0
  1782. package/docs/util/set/PossibleSet.md +17 -0
  1783. package/docs/util/set/SetItem.md +17 -0
  1784. package/docs/util/set/addSetItem.md +26 -0
  1785. package/docs/util/set/addSetItems.md +26 -0
  1786. package/docs/util/set/assertSet.md +31 -0
  1787. package/docs/util/set/assertSetItem.md +32 -0
  1788. package/docs/util/set/deleteSetItems.md +26 -0
  1789. package/docs/util/set/getSet.md +25 -0
  1790. package/docs/util/set/isSet.md +24 -0
  1791. package/docs/util/set/isSetItem.md +25 -0
  1792. package/docs/util/set/limitSet.md +26 -0
  1793. package/docs/util/set.md +81 -0
  1794. package/docs/util/sort/Compare.md +13 -0
  1795. package/docs/util/sort/compareAscending.md +34 -0
  1796. package/docs/util/sort/compareDescending.md +26 -0
  1797. package/docs/util/sort/sortArray.md +27 -0
  1798. package/docs/util/sort.md +73 -0
  1799. package/docs/util/source/Sourceable.md +20 -0
  1800. package/docs/util/source/getSource.md +26 -0
  1801. package/docs/util/source/requireSource.md +33 -0
  1802. package/docs/util/source.md +48 -0
  1803. package/docs/util/start/PossibleStarter.md +17 -0
  1804. package/docs/util/start/STOPHOLE.md +13 -0
  1805. package/docs/util/start/StartCallback.md +16 -0
  1806. package/docs/util/start/Starter/start.md +13 -0
  1807. package/docs/util/start/Starter/stop.md +13 -0
  1808. package/docs/util/start/Starter.md +32 -0
  1809. package/docs/util/start/StopCallback.md +12 -0
  1810. package/docs/util/start/getStarter.md +25 -0
  1811. package/docs/util/start.md +76 -0
  1812. package/docs/util/string/NotString.md +25 -0
  1813. package/docs/util/string/PossibleString.md +16 -0
  1814. package/docs/util/string/Segments.md +12 -0
  1815. package/docs/util/string/assertString.md +37 -0
  1816. package/docs/util/string/assertStringLength.md +33 -0
  1817. package/docs/util/string/getFirstLine.md +24 -0
  1818. package/docs/util/string/getRef.md +24 -0
  1819. package/docs/util/string/getSlug.md +24 -0
  1820. package/docs/util/string/getString.md +25 -0
  1821. package/docs/util/string/getWords.md +28 -0
  1822. package/docs/util/string/isLowercaseLetter.md +24 -0
  1823. package/docs/util/string/isNonEmptyString.md +24 -0
  1824. package/docs/util/string/isString.md +24 -0
  1825. package/docs/util/string/isStringBetween.md +26 -0
  1826. package/docs/util/string/isStringLength.md +26 -0
  1827. package/docs/util/string/isUppercaseLetter.md +24 -0
  1828. package/docs/util/string/joinStrings.md +31 -0
  1829. package/docs/util/string/limitString.md +28 -0
  1830. package/docs/util/string/requireRef.md +37 -0
  1831. package/docs/util/string/requireSlug.md +31 -0
  1832. package/docs/util/string/requireString.md +37 -0
  1833. package/docs/util/string/requireStringLength.md +39 -0
  1834. package/docs/util/string/sanitizeMultilineText.md +31 -0
  1835. package/docs/util/string/sanitizeText.md +28 -0
  1836. package/docs/util/string/sanitizeWord.md +33 -0
  1837. package/docs/util/string/simplifyString.md +33 -0
  1838. package/docs/util/string/splitString.md +65 -0
  1839. package/docs/util/string/trimString.md +30 -0
  1840. package/docs/util/string.md +114 -0
  1841. package/docs/util/template/TemplateMatches.md +16 -0
  1842. package/docs/util/template/TemplatePlaceholders.md +16 -0
  1843. package/docs/util/template/TemplateValues.md +23 -0
  1844. package/docs/util/template/getPlaceholders.md +30 -0
  1845. package/docs/util/template/matchPathTemplate.md +42 -0
  1846. package/docs/util/template/matchPathTemplates.md +31 -0
  1847. package/docs/util/template/matchTemplate.md +40 -0
  1848. package/docs/util/template/matchTemplates.md +31 -0
  1849. package/docs/util/template/renderPathTemplate.md +47 -0
  1850. package/docs/util/template/renderTemplate.md +38 -0
  1851. package/docs/util/template.md +94 -0
  1852. package/docs/util/timeout/Timeout/clear.md +12 -0
  1853. package/docs/util/timeout/Timeout/set.md +12 -0
  1854. package/docs/util/timeout/Timeout.md +39 -0
  1855. package/docs/util/timeout.md +43 -0
  1856. package/docs/util/transform/Transforms.md +18 -0
  1857. package/docs/util/transform/mapArray.md +26 -0
  1858. package/docs/util/transform/mapDictionary.md +27 -0
  1859. package/docs/util/transform/mapEntries.md +27 -0
  1860. package/docs/util/transform/mapEntryValues.md +27 -0
  1861. package/docs/util/transform/mapItems.md +26 -0
  1862. package/docs/util/transform/mapProps.md +27 -0
  1863. package/docs/util/transform/mapSequence.md +27 -0
  1864. package/docs/util/transform/transformObject.md +40 -0
  1865. package/docs/util/transform.md +85 -0
  1866. package/docs/util/tree/DocumentationElement.md +22 -0
  1867. package/docs/util/tree/DocumentationElementProps.md +46 -0
  1868. package/docs/util/tree/DocumentationExample.md +20 -0
  1869. package/docs/util/tree/DocumentationParam.md +30 -0
  1870. package/docs/util/tree/DocumentationReturn.md +22 -0
  1871. package/docs/util/tree/DocumentationThrow.md +22 -0
  1872. package/docs/util/tree/SearchTreeOptions.md +22 -0
  1873. package/docs/util/tree/TreeElement.md +26 -0
  1874. package/docs/util/tree/TreeElementProps.md +33 -0
  1875. package/docs/util/tree/TreeElements.md +17 -0
  1876. package/docs/util/tree/flattenTree.md +35 -0
  1877. package/docs/util/tree/searchTree.md +42 -0
  1878. package/docs/util/tree.md +77 -0
  1879. package/docs/util/types/Resolve.md +18 -0
  1880. package/docs/util/types/UnionToIntersection.md +18 -0
  1881. package/docs/util/types.md +9 -0
  1882. package/docs/util/undefined/assertDefined.md +31 -0
  1883. package/docs/util/undefined/getUndefined.md +20 -0
  1884. package/docs/util/undefined/isDefined.md +24 -0
  1885. package/docs/util/undefined/isUndefined.md +24 -0
  1886. package/docs/util/undefined/notUndefined.md +6 -0
  1887. package/docs/util/undefined/requireDefined.md +31 -0
  1888. package/docs/util/undefined.md +42 -0
  1889. package/docs/util/units/ANGLE_UNITS.md +6 -0
  1890. package/docs/util/units/AREA_UNITS.md +6 -0
  1891. package/docs/util/units/AngleUnitKey.md +14 -0
  1892. package/docs/util/units/AreaUnitKey.md +14 -0
  1893. package/docs/util/units/LENGTH_UNITS.md +6 -0
  1894. package/docs/util/units/LengthUnitKey.md +14 -0
  1895. package/docs/util/units/MASS_UNITS.md +6 -0
  1896. package/docs/util/units/MassUnitKey.md +14 -0
  1897. package/docs/util/units/PERCENT_UNITS.md +6 -0
  1898. package/docs/util/units/POINT_UNITS.md +6 -0
  1899. package/docs/util/units/PercentUnitKey.md +16 -0
  1900. package/docs/util/units/PointUnitKey.md +16 -0
  1901. package/docs/util/units/SPEED_UNITS.md +6 -0
  1902. package/docs/util/units/SpeedUnitKey.md +14 -0
  1903. package/docs/util/units/TEMPERATURE_UNITS.md +6 -0
  1904. package/docs/util/units/TemperatureUnitKey.md +14 -0
  1905. package/docs/util/units/Unit/format.md +14 -0
  1906. package/docs/util/units/Unit/formatAbbr.md +14 -0
  1907. package/docs/util/units/Unit/from.md +12 -0
  1908. package/docs/util/units/Unit/to.md +12 -0
  1909. package/docs/util/units/Unit.md +43 -0
  1910. package/docs/util/units/UnitList/convert.md +12 -0
  1911. package/docs/util/units/UnitList/require.md +12 -0
  1912. package/docs/util/units/UnitList.md +39 -0
  1913. package/docs/util/units/VOLUME_UNITS.md +6 -0
  1914. package/docs/util/units/VolumeUnitKey.md +14 -0
  1915. package/docs/util/units.md +91 -0
  1916. package/docs/util/update/Update.md +22 -0
  1917. package/docs/util/update/Updates.md +55 -0
  1918. package/docs/util/update/getUpdates.md +32 -0
  1919. package/docs/util/update/updateData.md +34 -0
  1920. package/docs/util/update.md +78 -0
  1921. package/docs/util/uri/HTTP_SCHEMES.md +12 -0
  1922. package/docs/util/uri/ImmutableURI.md +49 -0
  1923. package/docs/util/uri/ImmutableURIConstructor.md +17 -0
  1924. package/docs/util/uri/PossibleURI.md +16 -0
  1925. package/docs/util/uri/PossibleURIParams.md +18 -0
  1926. package/docs/util/uri/URIHash.md +12 -0
  1927. package/docs/util/uri/URIParams.md +16 -0
  1928. package/docs/util/uri/URIScheme.md +12 -0
  1929. package/docs/util/uri/URISchemes.md +17 -0
  1930. package/docs/util/uri/URISearch.md +12 -0
  1931. package/docs/util/uri/URIString.md +19 -0
  1932. package/docs/util/uri/assertURI.md +31 -0
  1933. package/docs/util/uri/clearURIParams.md +28 -0
  1934. package/docs/util/uri/getURI.md +26 -0
  1935. package/docs/util/uri/getURIParam.md +25 -0
  1936. package/docs/util/uri/getURIParams.md +34 -0
  1937. package/docs/util/uri/isURI.md +24 -0
  1938. package/docs/util/uri/omitURIParam.md +12 -0
  1939. package/docs/util/uri/omitURIParams.md +28 -0
  1940. package/docs/util/uri/requireURI.md +31 -0
  1941. package/docs/util/uri/requireURIParam.md +26 -0
  1942. package/docs/util/uri/withURIParam.md +37 -0
  1943. package/docs/util/uri/withURIParams.md +37 -0
  1944. package/docs/util/uri.md +100 -0
  1945. package/docs/util/url/BaseURL.md +21 -0
  1946. package/docs/util/url/ImmutableURL.md +39 -0
  1947. package/docs/util/url/ImmutableURLConstructor.md +19 -0
  1948. package/docs/util/url/PossibleURL.md +16 -0
  1949. package/docs/util/url/URLString.md +14 -0
  1950. package/docs/util/url/assertURL.md +31 -0
  1951. package/docs/util/url/getBaseURL.md +26 -0
  1952. package/docs/util/url/getBasedURI.md +31 -0
  1953. package/docs/util/url/getURL.md +26 -0
  1954. package/docs/util/url/isBaseURL.md +25 -0
  1955. package/docs/util/url/isURL.md +25 -0
  1956. package/docs/util/url/isURLActive.md +28 -0
  1957. package/docs/util/url/isURLProud.md +29 -0
  1958. package/docs/util/url/matchURLPrefix.md +37 -0
  1959. package/docs/util/url/requireBaseURL.md +31 -0
  1960. package/docs/util/url/requireURL.md +32 -0
  1961. package/docs/util/url.md +98 -0
  1962. package/docs/util/uuid/getUUID.md +28 -0
  1963. package/docs/util/uuid/randomUUID.md +18 -0
  1964. package/docs/util/uuid/requireUUID.md +30 -0
  1965. package/docs/util/uuid.md +37 -0
  1966. package/docs/util/validate/Validator/validate.md +12 -0
  1967. package/docs/util/validate/Validator.md +18 -0
  1968. package/docs/util/validate/ValidatorType.md +17 -0
  1969. package/docs/util/validate/Validators.md +17 -0
  1970. package/docs/util/validate/ValidatorsType.md +17 -0
  1971. package/docs/util/validate/getValid.md +33 -0
  1972. package/docs/util/validate/requireValid.md +35 -0
  1973. package/docs/util/validate/validateArray.md +33 -0
  1974. package/docs/util/validate/validateData.md +36 -0
  1975. package/docs/util/validate/validateDictionary.md +33 -0
  1976. package/docs/util/validate/validateItems.md +41 -0
  1977. package/docs/util/validate.md +88 -0
  1978. package/docs/util/xml/escapeXML.md +26 -0
  1979. package/docs/util/xml/getXML.md +36 -0
  1980. package/docs/util/xml.md +41 -0
  1981. package/extract/DirectoryExtractor.d.ts +1 -0
  1982. package/extract/DirectoryExtractor.js +3 -0
  1983. package/package.json +5 -4
  1984. package/schema/DataSchema.d.ts +17 -1
  1985. package/schema/DataSchema.js +18 -1
  1986. package/schema/QuerySchema.d.ts +46 -0
  1987. package/schema/QuerySchema.js +110 -0
  1988. package/schema/ThroughSchema.d.ts +11 -0
  1989. package/schema/ThroughSchema.js +16 -0
  1990. package/schema/UpdatesSchema.d.ts +45 -0
  1991. package/schema/UpdatesSchema.js +88 -0
  1992. package/schema/index.d.ts +2 -0
  1993. package/schema/index.js +2 -0
  1994. package/skills/shelving/SKILL.md +34 -0
@@ -0,0 +1,12 @@
1
+ # CachedAPIProvider.invalidate()
2
+
3
+ - Kind: method
4
+ - Member of: `CachedAPIProvider`
5
+
6
+ Invalidate the cached result for a specific endpoint and payload.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ invalidate(endpoint: Endpoint<PP, RR>, payload: PP): void
12
+ ```
@@ -0,0 +1,12 @@
1
+ # CachedAPIProvider.invalidateAll()
2
+
3
+ - Kind: method
4
+ - Member of: `CachedAPIProvider`
5
+
6
+ Invalidate every cached result for an endpoint, across all payloads.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ invalidateAll(endpoint: Endpoint<PP, RR>): void
12
+ ```
@@ -0,0 +1,12 @@
1
+ # CachedAPIProvider.refresh()
2
+
3
+ - Kind: method
4
+ - Member of: `CachedAPIProvider`
5
+
6
+ Refresh the cached result for a specific endpoint and payload.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ refresh(endpoint: Endpoint<PP, RR>, payload: PP): Promise<void>
12
+ ```
@@ -0,0 +1,12 @@
1
+ # CachedAPIProvider.refreshAll()
2
+
3
+ - Kind: method
4
+ - Member of: `CachedAPIProvider`
5
+
6
+ Refresh every cached result for an endpoint, across all payloads.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ refreshAll(endpoint: Endpoint<PP, RR>): Promise<void>
12
+ ```
@@ -0,0 +1,65 @@
1
+ # CachedAPIProvider
2
+
3
+ - Kind: class
4
+ - Import: `import { CachedAPIProvider } from "shelving/api";`
5
+ - Extends: `ThroughAPIProvider<P, R>`
6
+ - Implements: `AsyncDisposable`
7
+
8
+ API provider wrapper that serves requests through an `APICache` so repeated calls reuse cached results.
9
+ - On `call(...)`, triggers `cache.refresh(maxAge)` for the endpoint+payload before awaiting `cache.call(...)`.
10
+ - `invalidate`, `invalidateAll`, `refresh`, and `refreshAll` pass through to the underlying cache and use `this.maxAge` as the default refresh timing.
11
+
12
+ A wrapping provider that serves calls through an `APICache`. Repeated calls for the same endpoint and payload skip the network and return the cached value, and it exposes `invalidate` / `refresh` helpers for cache control.
13
+
14
+ The constructor takes the `source` provider and an optional default `maxAge` (defaults to `AVOID_REFRESH` — only refetch when a value is missing or invalidated).
15
+
16
+ ## Usage
17
+
18
+ ```ts
19
+ import { CachedAPIProvider, ValidationAPIProvider, ClientAPIProvider } from "shelving/api"
20
+
21
+ const provider = new CachedAPIProvider(
22
+ new ValidationAPIProvider(new ClientAPIProvider({ url: "https://api.example.com" }))
23
+ )
24
+
25
+ await provider.call(getUser, { id: "u_1" }) // fetches
26
+ await provider.call(getUser, { id: "u_1" }) // returns cached
27
+
28
+ provider.invalidate(getUser, { id: "u_1" }) // mark stale
29
+ provider.refresh(getUser, { id: "u_1" }) // re-fetch eagerly
30
+ ```
31
+
32
+ `invalidateAll(endpoint)` and `refreshAll(endpoint)` act on every cached payload for an endpoint at once.
33
+
34
+
35
+ ## Signatures
36
+
37
+ ```ts
38
+ new CachedAPIProvider<P, R>(source: APIProvider<P, R>, maxAge: number = AVOID_REFRESH)
39
+ ```
40
+
41
+ ## Parameters
42
+
43
+ | Param | Type | Description |
44
+ | --- | --- | --- |
45
+ | `source` | `APIProvider<P, R>` | |
46
+ | `maxAge` | `number` | Defaults to `AVOID_REFRESH`. |
47
+
48
+ ## Returns
49
+
50
+ | Type | Description |
51
+ | --- | --- |
52
+ | `CachedAPIProvider<P, R>` | |
53
+
54
+ ## Properties
55
+
56
+ | Property | Type | Description |
57
+ | --- | --- | --- |
58
+ | `maxAge` | `number \| undefined` | The maximum age used when calling `call()`, defaulting to `AVOID_REFRESH` (only refresh if invalidated or still loading). - Not used for `refresh()` calls, which always refetch immediately. Read only. |
59
+
60
+ ## Methods
61
+
62
+ - [CachedAPIProvider.invalidate()](CachedAPIProvider/invalidate.md): Invalidate the cached result for a specific endpoint and payload.
63
+ - [CachedAPIProvider.invalidateAll()](CachedAPIProvider/invalidateAll.md): Invalidate every cached result for an endpoint, across all payloads.
64
+ - [CachedAPIProvider.refresh()](CachedAPIProvider/refresh.md): Refresh the cached result for a specific endpoint and payload.
65
+ - [CachedAPIProvider.refreshAll()](CachedAPIProvider/refreshAll.md): Refresh every cached result for an endpoint, across all payloads.
@@ -0,0 +1,60 @@
1
+ # ClientAPIProvider
2
+
3
+ - Kind: class
4
+ - Import: `import { ClientAPIProvider } from "shelving/api";`
5
+ - Extends: `APIProvider<P, R>`
6
+
7
+ A client-side API provider that sends requests over the network using `fetch()`.
8
+ - Can be used on a server environment to make outgoing API calls, or in a browser environment to call a server API.
9
+ - Renders endpoint paths and query params into the URL and sends body payloads as JSON.
10
+ - Parses JSON responses and throws `ResponseError` for non-2xx responses.
11
+ - Extendable with custom request-building and response-parsing logic by overriding `createRequest()` and `parseResponse()`.
12
+ - Wrap in `ValidationAPIProvider` to add automatic validation of request payloads and response results against endpoint schemas.
13
+
14
+ The concrete network provider. `ClientAPIProvider` sends requests over the network with the global `fetch()` API and is the innermost provider in almost every chain.
15
+
16
+ The constructor takes `{ url, options?, timeout? }` — a base URL that endpoint paths are resolved against, optional default `RequestInit` options, and a request timeout in milliseconds (default `20000`).
17
+
18
+ ## Usage
19
+
20
+ ```ts
21
+ import { ClientAPIProvider } from "shelving/api"
22
+
23
+ const provider = new ClientAPIProvider({
24
+ url: "https://api.example.com",
25
+ timeout: 10_000,
26
+ })
27
+
28
+ const user = await provider.call(getUser, { id: "u_123" })
29
+ ```
30
+
31
+ In practice you wrap it — e.g. `new ValidationAPIProvider(new ClientAPIProvider({ url }))` — so payloads and results are validated. See `shelving/api` for building a provider chain.
32
+
33
+
34
+ ## Signatures
35
+
36
+ ```ts
37
+ new ClientAPIProvider<P, R>({ url, options = {}, timeout = 20_000 }: ClientAPIProviderOptions)
38
+ ```
39
+
40
+ ## Parameters
41
+
42
+ | Param | Type | Description |
43
+ | --- | --- | --- |
44
+ | `options` | `ClientAPIProviderOptions` | |
45
+ | `.url` | `PossibleURL` | The common base URL for all rendered endpoint requests. Note: When resolving URLs for endpoints this is treated as if it ends in a slash. - e.g. in `http://p.com/a/b/c` the path will be relative to `c` as if a `/` trailing slash was present. - This is different to the default behaviour of `new URL()`, but is the more natural expected result - This is consistent with our e.g. `getURL()` utilities. Read only. |
46
+ | `.options` | `Omit<RequestOptions, "signal">` | Options used for HTTP requests created with `this.createRequest()` and `this.fetch()` - Omits `signal` because it's not relevant at the provider level. Read only. Optional. |
47
+ | `.timeout` | `number \| undefined` | Timeout in milliseconds before the request is aborted with `TimeoutError`. - Defaults to `20_000` (20 seconds) — chosen to fire before common platform wall-clock caps (Cloudflare Workers ~30s, Vercel/AWS API Gateway ~29s) so the abort propagates as a clean rejection instead of an opaque runtime termination. - Pass `0` to disable the timeout (e.g. for streaming or long-poll endpoints). Raise it for specifically slow endpoints. Read only. Optional. |
48
+
49
+ ## Returns
50
+
51
+ | Type | Description |
52
+ | --- | --- |
53
+ | `ClientAPIProvider<P, R>` | |
54
+
55
+ ## Properties
56
+
57
+ | Property | Type | Description |
58
+ | --- | --- | --- |
59
+ | `options` | `RequestOptions` | Default options used for HTTP requests created with `this.createRequest()` and `this.fetch()` Read only. |
60
+ | `timeout` | `number` | Timeout in milliseconds before the request is aborted, or `0` for no timeout. Read only. |
@@ -0,0 +1,24 @@
1
+ # ClientAPIProviderOptions
2
+
3
+ - Kind: interface
4
+ - Import: `import { ClientAPIProviderOptions } from "shelving/api";`
5
+
6
+ Options for constructing a `ClientAPIProvider`.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ {
12
+ readonly url: PossibleURL;
13
+ readonly options?: Omit<RequestOptions, "signal">;
14
+ readonly timeout?: number | undefined;
15
+ }
16
+ ```
17
+
18
+ ## Properties
19
+
20
+ | Property | Type | Description |
21
+ | --- | --- | --- |
22
+ | `url` | `PossibleURL` | The common base URL for all rendered endpoint requests. Note: When resolving URLs for endpoints this is treated as if it ends in a slash. - e.g. in `http://p.com/a/b/c` the path will be relative to `c` as if a `/` trailing slash was present. - This is different to the default behaviour of `new URL()`, but is the more natural expected result - This is consistent with our e.g. `getURL()` utilities. Read only. |
23
+ | `options` | `Omit<RequestOptions, "signal">` | Options used for HTTP requests created with `this.createRequest()` and `this.fetch()` - Omits `signal` because it's not relevant at the provider level. Read only. Optional. |
24
+ | `timeout` | `number \| undefined` | Timeout in milliseconds before the request is aborted with `TimeoutError`. - Defaults to `20_000` (20 seconds) — chosen to fire before common platform wall-clock caps (Cloudflare Workers ~30s, Vercel/AWS API Gateway ~29s) so the abort propagates as a clean rejection instead of an opaque runtime termination. - Pass `0` to disable the timeout (e.g. for streaming or long-poll endpoints). Raise it for specifically slow endpoints. Read only. Optional. |
@@ -0,0 +1,43 @@
1
+ # DELETE()
2
+
3
+ - Kind: function
4
+ - Import: `import { DELETE } from "shelving/api";`
5
+
6
+ Define a `DELETE` endpoint at a path, with validated payload and result types.
7
+ - "The DELETE method deletes the specified resource."
8
+
9
+ *Factory for `Endpoint`.*
10
+
11
+ ## Signatures
12
+
13
+ ```ts
14
+ DELETE(path: AbsolutePath, payload?: Schema<P>, result?: Schema<R>): Endpoint<P, R>
15
+ DELETE(path: AbsolutePath, payload: Schema<P>): Endpoint<P, undefined>
16
+ DELETE(path: AbsolutePath, payload: undefined, result: Schema<R>): Endpoint<undefined, R>
17
+ ```
18
+
19
+ ## Parameters
20
+
21
+ | Param | Type | Description |
22
+ | --- | --- | --- |
23
+ | `path` | `AbsolutePath` | The endpoint path, possibly including `{placeholders}` |
24
+ | `payload` | `Schema<P>` | An optional `Schema` validating the request payload. Optional. |
25
+ | `result` | `Schema<R>` | An optional `Schema` validating the response result. Optional. |
26
+ | `path` | `AbsolutePath` | |
27
+ | `payload` | `Schema<P>` | |
28
+ | `payload` | `undefined` | |
29
+ | `result` | `Schema<R>` | |
30
+
31
+ ## Returns
32
+
33
+ | Type | Description |
34
+ | --- | --- |
35
+ | `Endpoint<P, R>` | An `Endpoint` configured for the `DELETE` method. |
36
+ | `Endpoint<P, undefined>` | |
37
+ | `Endpoint<undefined, R>` | |
38
+
39
+ ## Examples
40
+
41
+ ```ts
42
+ DELETE("/users/{id}")
43
+ ```
@@ -0,0 +1,37 @@
1
+ # DebugAPIProvider
2
+
3
+ - Kind: class
4
+ - Import: `import { DebugAPIProvider } from "shelving/api";`
5
+ - Extends: `ThroughAPIProvider<P, R>`
6
+
7
+ Provider that logs every request, response, and error to the console in detail to help diagnose issues in development.
8
+
9
+ A wrapping provider for development. `DebugAPIProvider` writes verbose console output for every call — including full request and response bodies — so you can see exactly what is going over the wire.
10
+
11
+ It is the noisy counterpart to `LoggingAPIProvider`: use `DebugAPIProvider` while developing, and `LoggingAPIProvider` (or nothing) in production.
12
+
13
+ ## Usage
14
+
15
+ ```ts
16
+ import { ClientAPIProvider, DebugAPIProvider } from "shelving/api"
17
+
18
+ const provider = new DebugAPIProvider(
19
+ new ClientAPIProvider({ url: "https://api.example.com" })
20
+ )
21
+
22
+ await provider.call(getUser, { id: "u_123" })
23
+ // Console shows the full request and response, including bodies.
24
+ ```
25
+
26
+
27
+ ## Signatures
28
+
29
+ ```ts
30
+ new DebugAPIProvider<P, R>()
31
+ ```
32
+
33
+ ## Returns
34
+
35
+ | Type | Description |
36
+ | --- | --- |
37
+ | `DebugAPIProvider<P, R>` | |
@@ -0,0 +1,12 @@
1
+ # Endpoint.handler()
2
+
3
+ - Kind: method
4
+ - Member of: `Endpoint`
5
+
6
+ Create an endpoint handler pairing for this endpoint.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ handler(callback: EndpointCallback<P, R, C>): EndpointHandler<P, R, C>
12
+ ```
@@ -0,0 +1,12 @@
1
+ # Endpoint.match()
2
+
3
+ - Kind: method
4
+ - Member of: `Endpoint`
5
+
6
+ Match a method/path pair against this endpoint and return any matched `{placeholder}` params.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ match(method: RequestMethod, path: AbsolutePath, caller: AnyCaller = this.match): RequestParams | undefined
12
+ ```
@@ -0,0 +1,13 @@
1
+ # Endpoint.renderPath()
2
+
3
+ - Kind: method
4
+ - Member of: `Endpoint`
5
+
6
+ Render the path for this endpoint with the given payload.
7
+ - Path might contain `{placeholder}` values that are replaced with values from `payload`.
8
+
9
+ ## Signatures
10
+
11
+ ```ts
12
+ renderPath(payload: P, caller: AnyCaller = this.renderPath): AbsolutePath
13
+ ```
@@ -0,0 +1,12 @@
1
+ # Endpoint.toString()
2
+
3
+ - Kind: method
4
+ - Member of: `Endpoint`
5
+
6
+ Convert this endpoint to a string in `METHOD /path` form, e.g. `GET /user/{id}`
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ toString(): string
12
+ ```
@@ -0,0 +1,52 @@
1
+ # Endpoint
2
+
3
+ - Kind: class
4
+ - Import: `import { Endpoint } from "shelving/api";`
5
+
6
+ A typed API resource definition pairing a method and path with payload and result schemas.
7
+ - Acts as the contract both ends of an API agree on: providers render requests from it, handlers validate against it.
8
+ - Path may contain `{placeholder}` segments that are filled from the payload at request time.
9
+
10
+ ## Signatures
11
+
12
+ ```ts
13
+ new Endpoint<P, R>(method: RequestMethod, path: AbsolutePath, payload: Schema<P>, result: Schema<R>)
14
+ ```
15
+
16
+ ## Parameters
17
+
18
+ | Param | Type | Description |
19
+ | --- | --- | --- |
20
+ | `method` | `RequestMethod` | |
21
+ | `path` | `AbsolutePath` | |
22
+ | `payload` | `Schema<P>` | |
23
+ | `result` | `Schema<R>` | |
24
+
25
+ ## Returns
26
+
27
+ | Type | Description |
28
+ | --- | --- |
29
+ | `Endpoint<P, R>` | |
30
+
31
+ ## Properties
32
+
33
+ | Property | Type | Description |
34
+ | --- | --- | --- |
35
+ | `method` | `RequestMethod` | The HTTP method this endpoint responds to, e.g. `GET` Read only. |
36
+ | `path` | `AbsolutePath` | Endpoint path, possibly including placeholders e.g. `/users/{id}` Read only. |
37
+ | `placeholders` | `TemplatePlaceholders` | The `{placeholder}` segments extracted from `path`, used to render and match URLs. Read only. |
38
+ | `payload` | `Schema<P>` | The `Schema` that request payloads are validated against. Read only. |
39
+ | `result` | `Schema<R>` | The `Schema` that response results are validated against. Read only. |
40
+
41
+ ## Examples
42
+
43
+ ```ts
44
+ const getUser = new Endpoint("GET", "/users/{id}", USER_PAYLOAD, USER_RESULT);
45
+ ```
46
+
47
+ ## Methods
48
+
49
+ - [Endpoint.renderPath()](Endpoint/renderPath.md): Render the path for this endpoint with the given payload.
50
+ - [Endpoint.match()](Endpoint/match.md): Match a method/path pair against this endpoint and return any matched {placeholder} params.
51
+ - [Endpoint.handler()](Endpoint/handler.md): Create an endpoint handler pairing for this endpoint.
52
+ - [Endpoint.toString()](Endpoint/toString.md): Convert this endpoint to a string in METHOD /path form, e.g. GET /user/{id}
@@ -0,0 +1,15 @@
1
+ # EndpointCache.call()
2
+
3
+ - Kind: method
4
+ - Member of: `EndpointCache`
5
+
6
+ Fetch (or return a cached result) for the given payload.
7
+ - Returns the cached value immediately if one exists.
8
+ - Waits for the in-flight fetch if the store is loading.
9
+ - Throws if the fetch fails, matching `APIProvider.call` behaviour.
10
+
11
+ ## Signatures
12
+
13
+ ```ts
14
+ call(payload: P, maxAge: number = AVOID_REFRESH, caller: AnyCaller = this.call): Promise<R>
15
+ ```
@@ -0,0 +1,13 @@
1
+ # EndpointCache.get()
2
+
3
+ - Kind: method
4
+ - Member of: `EndpointCache`
5
+
6
+ Get (or create) the `EndpointStore` for the given payload.
7
+ - Stores are keyed by the rendered request URL, so equivalent payloads share a store.
8
+
9
+ ## Signatures
10
+
11
+ ```ts
12
+ get(payload: P, caller: AnyCaller = this.get): EndpointStore<P, R>
13
+ ```
@@ -0,0 +1,12 @@
1
+ # EndpointCache.invalidate()
2
+
3
+ - Kind: method
4
+ - Member of: `EndpointCache`
5
+
6
+ Invalidate a specific store so the next read refetches.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ invalidate(payload: P, caller: AnyCaller = this.invalidate): void
12
+ ```
@@ -0,0 +1,12 @@
1
+ # EndpointCache.invalidateAll()
2
+
3
+ - Kind: method
4
+ - Member of: `EndpointCache`
5
+
6
+ Invalidate all stores so the next read of any payload refetches.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ invalidateAll(): void
12
+ ```
@@ -0,0 +1,12 @@
1
+ # EndpointCache.refresh()
2
+
3
+ - Kind: method
4
+ - Member of: `EndpointCache`
5
+
6
+ Trigger a refetch on a specific store.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ refresh(payload: P, maxAge?: number, caller: AnyCaller = this.refresh): Promise<void>
12
+ ```
@@ -0,0 +1,12 @@
1
+ # EndpointCache.refreshAll()
2
+
3
+ - Kind: method
4
+ - Member of: `EndpointCache`
5
+
6
+ Trigger a refetch on all stores.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ refreshAll(maxAge?: number): Promise<void>
12
+ ```
@@ -0,0 +1,51 @@
1
+ # EndpointCache
2
+
3
+ - Kind: class
4
+ - Import: `import { EndpointCache } from "shelving/api";`
5
+ - Implements: `AsyncDisposable`
6
+
7
+ Cache of `EndpointStore` objects for a single endpoint, keyed by the rendered request URL of each payload.
8
+ - Use `get(payload)` to retrieve or create the `EndpointStore` for a given payload.
9
+ - Disposing the cache disposes every nested `EndpointStore` and clears the map.
10
+
11
+ ## Signatures
12
+
13
+ ```ts
14
+ new EndpointCache<P, R>(endpoint: Endpoint<P, R>, provider: APIProvider<P, R>)
15
+ ```
16
+
17
+ ## Parameters
18
+
19
+ | Param | Type | Description |
20
+ | --- | --- | --- |
21
+ | `endpoint` | `Endpoint<P, R>` | |
22
+ | `provider` | `APIProvider<P, R>` | |
23
+
24
+ ## Returns
25
+
26
+ | Type | Description |
27
+ | --- | --- |
28
+ | `EndpointCache<P, R>` | |
29
+
30
+ ## Properties
31
+
32
+ | Property | Type | Description |
33
+ | --- | --- | --- |
34
+ | `endpoint` | `Endpoint<P, R>` | The endpoint that every store in this cache fetches from. Read only. |
35
+ | `provider` | `APIProvider<P, R>` | The `APIProvider` used to render URLs and fetch results for this endpoint. Read only. |
36
+
37
+ ## Examples
38
+
39
+ ```ts
40
+ const cache = new EndpointCache(getUser, provider);
41
+ const user = await cache.call({ id: "abc" });
42
+ ```
43
+
44
+ ## Methods
45
+
46
+ - [EndpointCache.get()](EndpointCache/get.md): Get (or create) the EndpointStore for the given payload.
47
+ - [EndpointCache.call()](EndpointCache/call.md): Fetch (or return a cached result) for the given payload.
48
+ - [EndpointCache.invalidate()](EndpointCache/invalidate.md): Invalidate a specific store so the next read refetches.
49
+ - [EndpointCache.invalidateAll()](EndpointCache/invalidateAll.md): Invalidate all stores so the next read of any payload refetches.
50
+ - [EndpointCache.refresh()](EndpointCache/refresh.md): Trigger a refetch on a specific store.
51
+ - [EndpointCache.refreshAll()](EndpointCache/refreshAll.md): Trigger a refetch on all stores.
@@ -0,0 +1,25 @@
1
+ # EndpointCallback
2
+
3
+ - Kind: type
4
+ - Import: `import { EndpointCallback } from "shelving/api";`
5
+
6
+ A function that handles an endpoint request, receiving a validated payload and returning a result.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ (payload: P, request: Request, context: C) => R | Response | Promise<R | Response>
12
+ ```
13
+
14
+ ## Returns
15
+
16
+ | Type | Description |
17
+ | --- | --- |
18
+ | `Response` | Returning a `Response` object (this will pass back to the client without validation). |
19
+ | `R` | Returning the return type of the handler (this will be validated against the Endpoint's result schema). |
20
+
21
+ ## Types
22
+
23
+ - `Request`
24
+ - `Response`
25
+ - `Promise`
@@ -0,0 +1,23 @@
1
+ # EndpointHandler
2
+
3
+ - Kind: interface
4
+ - Import: `import { EndpointHandler } from "shelving/api";`
5
+
6
+ A typed endpoint definition paired with its implementation callback.
7
+ - Created with `Endpoint.handler()`; matched and invoked by `handleEndpoints()`.
8
+
9
+ ## Signatures
10
+
11
+ ```ts
12
+ {
13
+ readonly endpoint: Endpoint<P, R>;
14
+ readonly callback: EndpointCallback<P, R, C>;
15
+ }
16
+ ```
17
+
18
+ ## Properties
19
+
20
+ | Property | Type | Description |
21
+ | --- | --- | --- |
22
+ | `endpoint` | `Endpoint<P, R>` | Read only. |
23
+ | `callback` | `EndpointCallback<P, R, C>` | Read only. |
@@ -0,0 +1,17 @@
1
+ # EndpointHandlers
2
+
3
+ - Kind: type
4
+ - Import: `import { EndpointHandlers } from "shelving/api";`
5
+
6
+ A collection of endpoint handlers that can be matched and invoked by `handleEndpoints()`.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ Iterable<AnyEndpointHandler<C>>
12
+ ```
13
+
14
+ ## Types
15
+
16
+ - `Iterable`
17
+ - [AnyEndpointHandler](AnyEndpointHandler.md): An EndpointHandler with any payload and result type, for use where the specific types don't matter.
@@ -0,0 +1,41 @@
1
+ # EndpointStore
2
+
3
+ - Kind: class
4
+ - Import: `import { EndpointStore } from "shelving/api";`
5
+ - Extends: `PayloadFetchStore<P, R>`
6
+
7
+ Store that loads and tracks the result of calling a single API endpoint with a fixed payload, through an `APIProvider`.
8
+
9
+ ## Signatures
10
+
11
+ ```ts
12
+ new EndpointStore<P, R>(endpoint: Endpoint<P, R>, payload: P, provider: APIProvider<P, R>)
13
+ ```
14
+
15
+ ## Parameters
16
+
17
+ | Param | Type | Description |
18
+ | --- | --- | --- |
19
+ | `endpoint` | `Endpoint<P, R>` | |
20
+ | `payload` | `P` | |
21
+ | `provider` | `APIProvider<P, R>` | |
22
+
23
+ ## Returns
24
+
25
+ | Type | Description |
26
+ | --- | --- |
27
+ | `EndpointStore<P, R>` | |
28
+
29
+ ## Properties
30
+
31
+ | Property | Type | Description |
32
+ | --- | --- | --- |
33
+ | `provider` | `APIProvider<P, R>` | The API provider this store calls the endpoint through. Read only. |
34
+ | `endpoint` | `Endpoint<P, R>` | The endpoint this store calls to fetch its result. Read only. |
35
+
36
+ ## Examples
37
+
38
+ ```ts
39
+ const store = new EndpointStore(endpoint, payload, provider);
40
+ const result = await store; // R
41
+ ```
@@ -0,0 +1,17 @@
1
+ # EndpointType
2
+
3
+ - Kind: type
4
+ - Import: `import { EndpointType } from "shelving/api";`
5
+
6
+ Extract the result type from an `Endpoint`.
7
+
8
+ ## Signatures
9
+
10
+ ```ts
11
+ X extends Endpoint<unknown, infer Y> ? Y : never
12
+ ```
13
+
14
+ ## Types
15
+
16
+ - [Endpoint](Endpoint.md): A typed API resource definition pairing a method and path with payload and result schemas.
17
+ - `Y`