@twin.org/core 0.0.1-next.6 → 0.0.1-next.60

package/docs/changelog.md

@@ -1,5 +1,83 @@
 # @twin.org/core - Changelog
 
-## 0.0.1-next.6
+## [0.0.1-next.60](https://github.com/twinfoundation/framework/compare/core-v0.0.1-next.59...core-v0.0.1-next.60) (2025-06-17)
+
+
+### Features
+
+* improve error display in CLI ([94b6ca8](https://github.com/twinfoundation/framework/commit/94b6ca8bdcfe3ca7671c4095b436ea7bddaae98e))
+
+## [0.0.1-next.59](https://github.com/twinfoundation/framework/compare/core-v0.0.1-next.58...core-v0.0.1-next.59) (2025-06-17)
+
+
+### Features
+
+* propagate includeStackTrace on error conversion ([8471cbb](https://github.com/twinfoundation/framework/commit/8471cbb71f8fc98247a0e92126c438c1a8b04d9b))
+* propagate includeStackTrace on error conversion ([818337d](https://github.com/twinfoundation/framework/commit/818337d50d14bf5a7e8b3204649aa7527115cca9))
+
+## [0.0.1-next.58](https://github.com/twinfoundation/framework/compare/core-v0.0.1-next.57...core-v0.0.1-next.58) (2025-06-13)
+
+
+### Miscellaneous Chores
+
+* **core:** Synchronize repo versions
+
+## [0.0.1-next.57](https://github.com/twinfoundation/framework/compare/core-v0.0.1-next.56...core-v0.0.1-next.57) (2025-06-10)
+
+
+### Features
+
+* add guards arrayEndsWith and arrayStartsWith ([95d875e](https://github.com/twinfoundation/framework/commit/95d875ec8ccb4713c145fdde941d4cfedcec2ed3))
+
+## [0.0.1-next.56](https://github.com/twinfoundation/framework/compare/core-v0.0.1-next.55...core-v0.0.1-next.56) (2025-05-08)
+
+
+### Features
+
+* add ObjectOrArray and ArrayHelper methods ([0ac9077](https://github.com/twinfoundation/framework/commit/0ac907764d64b38ad1b04b0e9c3027055b527559))
+
+## [0.0.1-next.55](https://github.com/twinfoundation/framework/compare/core-v0.0.1-next.54...core-v0.0.1-next.55) (2025-05-07)
+
+
+### Miscellaneous Chores
+
+* **core:** Synchronize repo versions
+
+## [0.0.1-next.54](https://github.com/twinfoundation/framework/compare/core-v0.0.1-next.53...core-v0.0.1-next.54) (2025-05-06)
+
+
+### Miscellaneous Chores
+
+* **core:** Synchronize repo versions
+
+## [0.0.1-next.53](https://github.com/twinfoundation/framework/compare/core-v0.0.1-next.52...core-v0.0.1-next.53) (2025-05-01)
+
+
+### Features
+
+* async cache don't cache failures unless requested ([658ec4b](https://github.com/twinfoundation/framework/commit/658ec4b67a58a075de4702a3886d151e25ad3ddc))
+
+## [0.0.1-next.52](https://github.com/twinfoundation/framework/compare/core-v0.0.1-next.51...core-v0.0.1-next.52) (2025-04-17)
+
+
+### Features
+
+* use new shared store mechanism ([#131](https://github.com/twinfoundation/framework/issues/131)) ([934385b](https://github.com/twinfoundation/framework/commit/934385b2fbaf9f5c00a505ebf9d093bd5a425f55))
+
+## [0.0.1-next.51](https://github.com/twinfoundation/framework/compare/core-v0.0.1-next.50...core-v0.0.1-next.51) (2025-03-27)
+
+
+### Features
+
+* simplify async set ([#121](https://github.com/twinfoundation/framework/issues/121)) ([2693c32](https://github.com/twinfoundation/framework/commit/2693c325266fd1a0aede6f1336c8b254c981a9ca))
+
+## [0.0.1-next.50](https://github.com/twinfoundation/framework/compare/core-v0.0.1-next.49...core-v0.0.1-next.50) (2025-03-26)
+
+
+### Features
+
+* add set method for async caches ([ba34b55](https://github.com/twinfoundation/framework/commit/ba34b55e651ad56ab8fc59e139e4af631c19cda0))
+
+## 0.0.1-next.49
 
 - Initial Release

package/docs/reference/classes/AlreadyExistsError.md

@@ -8,37 +8,45 @@ Class to handle errors which are triggered by data already existing.
 
 ## Constructors
 
-### new AlreadyExistsError()
+### Constructor
 
-> **new AlreadyExistsError**(`source`, `message`, `existingId`?, `inner`?): [`AlreadyExistsError`](AlreadyExistsError.md)
+> **new AlreadyExistsError**(`source`, `message`, `existingId?`, `inner?`): `AlreadyExistsError`
 
 Create a new instance of AlreadyExistsError.
 
 #### Parameters
 
-• **source**: `string`
+##### source
+
+`string`
 
 The source of the error.
 
-• **message**: `string`
+##### message
+
+`string`
 
 The message as a code.
 
-• **existingId?**: `string`
+##### existingId?
+
+`string`
 
 The id for the item.
 
-• **inner?**: `unknown`
+##### inner?
+
+`unknown`
 
 The inner error if we have wrapped another error.
 
 #### Returns
 
-[`AlreadyExistsError`](AlreadyExistsError.md)
+`AlreadyExistsError`
 
 #### Overrides
 
-[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructors)
+[`BaseError`](BaseError.md).[`constructor`](BaseError.md#constructor)
 
 ## Properties
 
@@ -70,7 +78,7 @@ Any additional information for the error.
 
 #### Index Signature
 
- \[`id`: `string`\]: `unknown`
+\[`id`: `string`\]: `unknown`
 
 #### Inherited from
 
@@ -98,7 +106,9 @@ Construct an error from an existing one.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The existing error.
 
@@ -122,7 +132,9 @@ Flatten an error tree.
 
 #### Parameters
 
-• **err**: `unknown`
+##### err
+
+`unknown`
 
 The starting error.
 
@@ -146,10 +158,12 @@ Expand an error tree.
 
 #### Parameters
 
-• **errors**: `undefined` \| [`IError`](../interfaces/IError.md)[]
+##### errors
 
 The list of errors to expand.
 
+`undefined` | [`IError`](../interfaces/IError.md)[]
+
 #### Returns
 
 `undefined` \| [`IError`](../interfaces/IError.md)
@@ -170,14 +184,18 @@ Test to see if the error has the specified error name.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **name**: `string` \| `RegExp`
+##### name
 
 The name to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -198,14 +216,18 @@ Test to see if the error has the specified error message.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **message**: `string` \| `RegExp`
+##### message
 
 The message to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -226,14 +248,18 @@ Test to see if the error has the specified error code.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **code**: `string` \| `RegExp`
+##### code
 
 The code to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `boolean`
@@ -254,14 +280,18 @@ Test to see if any of the errors or children have the given error name.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **name**: `string` \| `RegExp`
+##### name
 
 The name to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -282,14 +312,18 @@ Test to see if any of the errors or children have the given error message.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **message**: `string` \| `RegExp`
+##### message
 
 The message to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -310,11 +344,15 @@ Test to see if any of the errors or children are from a specific class.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **cls**: `string`
+##### cls
+
+`string`
 
 The class to check for.
 
@@ -338,14 +376,18 @@ Test to see if any of the errors or children have the given error code.
 
 #### Parameters
 
-• **error**: `unknown`
+##### error
+
+`unknown`
 
 The error to test.
 
-• **code**: `string` \| `RegExp`
+##### code
 
 The code to check for.
 
+`string` | `RegExp`
+
 #### Returns
 
 `error is BaseError`
@@ -360,10 +402,18 @@ True if the error has the name.
 
 ### toJsonObject()
 
-> **toJsonObject**(): [`IError`](../interfaces/IError.md)
+> **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)
 
 Serialize the error to the error model.
 
+#### Parameters
+
+##### includeStackTrace?
+
+`boolean`
+
+Whether to include the error stack in the model, defaults to false.
+
 #### Returns
 
 [`IError`](../interfaces/IError.md)

package/docs/reference/classes/ArrayHelper.md

@@ -4,13 +4,13 @@ Class to help with arrays.
 
 ## Constructors
 
-### new ArrayHelper()
+### Constructor
 
-> **new ArrayHelper**(): [`ArrayHelper`](ArrayHelper.md)
+> **new ArrayHelper**(): `ArrayHelper`
 
 #### Returns
 
-[`ArrayHelper`](ArrayHelper.md)
+`ArrayHelper`
 
 ## Methods
 
@@ -22,11 +22,15 @@ Do the two arrays match.
 
 #### Parameters
 
-• **arr1**: `unknown`
+##### arr1
+
+`unknown`
 
 The first array.
 
-• **arr2**: `unknown`
+##### arr2
+
+`unknown`
 
 The second array.
 
@@ -35,3 +39,73 @@ The second array.
 `boolean`
 
 True if both arrays are empty of have the same values.
+
+***
+
+### fromObjectOrArray()
+
+Convert an object or array to an array.
+
+#### Param
+
+The object or array to convert.
+
+#### Call Signature
+
+> `static` **fromObjectOrArray**\<`T`\>(`value`): `undefined`
+
+Convert an object or array to an array.
+
+##### Type Parameters
+
+###### T
+
+`T` = `unknown`
+
+##### Parameters
+
+###### value
+
+`undefined`
+
+The object or array to convert.
+
+##### Returns
+
+`undefined`
+
+The array.
+
+##### Param
+
+The object or array to convert.
+
+#### Call Signature
+
+> `static` **fromObjectOrArray**\<`T`\>(`value`): `T`[]
+
+Convert an object or array to an array.
+
+##### Type Parameters
+
+###### T
+
+`T` = `unknown`
+
+##### Parameters
+
+###### value
+
+[`ObjectOrArray`](../type-aliases/ObjectOrArray.md)\<`T`\>
+
+The object or array to convert.
+
+##### Returns
+
+`T`[]
+
+The array.
+
+##### Param
+
+The object or array to convert.

package/docs/reference/classes/AsyncCache.md

@@ -4,40 +4,54 @@ Cache the results from asynchronous requests.
 
 ## Constructors
 
-### new AsyncCache()
+### Constructor
 
-> **new AsyncCache**(): [`AsyncCache`](AsyncCache.md)
+> **new AsyncCache**(): `AsyncCache`
 
 #### Returns
 
-[`AsyncCache`](AsyncCache.md)
+`AsyncCache`
 
 ## Methods
 
 ### exec()
 
-> `static` **exec**\<`T`\>(`key`, `ttlMs`, `requestMethod`): `undefined` \| `Promise`\<`T`\>
+> `static` **exec**\<`T`\>(`key`, `ttlMs`, `requestMethod`, `cacheFailures?`): `undefined` \| `Promise`\<`T`\>
 
 Execute an async request and cache the result.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **key**: `string`
+##### key
+
+`string`
 
 The key for the entry in the cache.
 
-• **ttlMs**: `undefined` \| `number`
+##### ttlMs
 
 The TTL of the entry in the cache.
 
-• **requestMethod**
+`undefined` | `number`
+
+##### requestMethod
+
+() => `Promise`\<`T`\>
 
 The method to call if not cached.
 
+##### cacheFailures?
+
+`boolean`
+
+Cache failure results, defaults to false.
+
 #### Returns
 
 `undefined` \| `Promise`\<`T`\>
@@ -54,11 +68,15 @@ Get an entry from the cache.
 
 #### Type Parameters
 
-• **T** = `unknown`
+##### T
+
+`T` = `unknown`
 
 #### Parameters
 
-• **key**: `string`
+##### key
+
+`string`
 
 The key to get from the cache.
 
@@ -70,6 +88,46 @@ The item from the cache if it exists.
 
 ***
 
+### set()
+
+> `static` **set**\<`T`\>(`key`, `value`, `ttlMs?`): `Promise`\<`void`\>
+
+Set an entry into the cache.
+
+#### Type Parameters
+
+##### T
+
+`T` = `unknown`
+
+#### Parameters
+
+##### key
+
+`string`
+
+The key to set in the cache.
+
+##### value
+
+`T`
+
+The value to set in the cache.
+
+##### ttlMs?
+
+`number`
+
+The TTL of the entry in the cache in ms, defaults to 1s.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
 ### remove()
 
 > `static` **remove**(`key`): `void`
@@ -78,7 +136,9 @@ Remove an entry from the cache.
 
 #### Parameters
 
-• **key**: `string`
+##### key
+
+`string`
 
 The key to remove from the cache.
 
@@ -90,13 +150,15 @@ The key to remove from the cache.
 
 ### clearCache()
 
-> `static` **clearCache**(`prefix`?): `void`
+> `static` **clearCache**(`prefix?`): `void`
 
 Clear the cache.
 
 #### Parameters
 
-• **prefix?**: `string`
+##### prefix?
+
+`string`
 
 Optional prefix to clear only entries with that prefix.
 

package/docs/reference/classes/Base32.md

@@ -4,13 +4,13 @@ Class to help with base63 Encoding/Decoding.
 
 ## Constructors
 
-### new Base32()
+### Constructor
 
-> **new Base32**(): [`Base32`](Base32.md)
+> **new Base32**(): `Base32`
 
 #### Returns
 
-[`Base32`](Base32.md)
+`Base32`
 
 ## Methods
 
@@ -22,7 +22,9 @@ Convert the base 32 string to a byte array.
 
 #### Parameters
 
-• **base32**: `string`
+##### base32
+
+`string`
 
 The base32 string to convert.
 
@@ -46,7 +48,9 @@ Convert a byte array to base 32.
 
 #### Parameters
 
-• **bytes**: `Uint8Array`
+##### bytes
+
+`Uint8Array`
 
 The byte array to convert.
 

package/docs/reference/classes/Base58.md

@@ -0,0 +1,61 @@
+# Class: Base58
+
+Class to help with base58 Encoding/Decoding.
+
+## Constructors
+
+### Constructor
+
+> **new Base58**(): `Base58`
+
+#### Returns
+
+`Base58`
+
+## Methods
+
+### decode()
+
+> `static` **decode**(`base58`): `Uint8Array`
+
+Convert the base 58 string to a byte array.
+
+#### Parameters
+
+##### base58
+
+`string`
+
+The base58 string to convert.
+
+#### Returns
+
+`Uint8Array`
+
+The byte array.
+
+#### Throws
+
+If the input string contains a character not in the Base58 alphabet.
+
+***
+
+### encode()
+
+> `static` **encode**(`bytes`): `string`
+
+Convert a byte array to base 58.
+
+#### Parameters
+
+##### bytes
+
+`Uint8Array`
+
+The byte array to encode.
+
+#### Returns
+
+`string`
+
+The data as base58 string.