@twin.org/core 0.0.2-next.8 → 0.0.2

package/docs/reference/classes/RandomHelper.md

@@ -12,9 +12,17 @@ Class to help with random generation.
 
 `RandomHelper`
 
+## Properties
+
+### CLASS\_NAME {#class_name}
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
 ## Methods
 
-### generate()
+### generate() {#generate}
 
 > `static` **generate**(`length`): `Uint8Array`
 
@@ -33,3 +41,47 @@ The length of buffer to create.
 `Uint8Array`
 
 The random array.
+
+***
+
+### generateUuidV7() {#generateuuidv7}
+
+> `static` **generateUuidV7**(`format?`): `string`
+
+Generate a new UUIDv7.
+
+#### Parameters
+
+##### format?
+
+`"standard"` \| `"compact"`
+
+The format of the UUIDv7 string.
+
+#### Returns
+
+`string`
+
+The UUIDv7 string.
+
+***
+
+### uuidV7ExtractTimestamp() {#uuidv7extracttimestamp}
+
+> `static` **uuidV7ExtractTimestamp**(`uuid`): `number`
+
+Extract the unix timestamp (ms) from a UUIDv7.
+
+#### Parameters
+
+##### uuid
+
+`string`
+
+The UUIDv7 string.
+
+#### Returns
+
+`number`
+
+The unix timestamp in milliseconds.

package/docs/reference/classes/SharedStore.md

@@ -15,9 +15,9 @@ instance loads of a packages.
 
 ## Methods
 
-### get()
+### get() {#get}
 
-> `static` **get**\<`T`\>(`prop`): `undefined` \| `T`
+> `static` **get**\<`T`\>(`prop`): `T` \| `undefined`
 
 Get a property from the shared store.
 
@@ -37,13 +37,13 @@ The name of the property to get.
 
 #### Returns
 
-`undefined` \| `T`
+`T` \| `undefined`
 
 The property if it exists.
 
 ***
 
-### set()
+### set() {#set}
 
 > `static` **set**\<`T`\>(`prop`, `value`): `void`
 
@@ -75,7 +75,7 @@ The value to set.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > `static` **remove**(`prop`): `void`
 

package/docs/reference/classes/StringHelper.md

@@ -14,53 +14,75 @@ Class to help with string.
 
 ## Methods
 
-### trimTrailingSlashes()
+### trimTrailingSlashes() {#trimtrailingslashes}
 
 > `static` **trimTrailingSlashes**(`value`): `string`
 
-Trim trailing slashes from a string.
+Implementation signature for trimTrailingSlashes.
 
 #### Parameters
 
 ##### value
 
-The value to trim.
+`string`
 
-`undefined` | `string`
+The value to trim.
 
 #### Returns
 
 `string`
 
-The trimmed value.
+The trimmed string or the original.
 
 ***
 
-### trimLeadingSlashes()
+### trimLeadingSlashes() {#trimleadingslashes}
 
 > `static` **trimLeadingSlashes**(`value`): `string`
 
-Trim leading slashes from a string.
+Implementation signature for trimLeadingSlashes.
 
 #### Parameters
 
 ##### value
 
+`string`
+
 The value to trim.
 
-`undefined` | `string`
+#### Returns
+
+`string`
+
+The trimmed string or the original.
+
+***
+
+### trimLeadingAndTrailingSlashes() {#trimleadingandtrailingslashes}
+
+> `static` **trimLeadingAndTrailingSlashes**(`value`): `string`
+
+Trim both leading and trailing slashes from a string.
+
+#### Parameters
+
+##### value
+
+`string`
+
+The value to trim.
 
 #### Returns
 
 `string`
 
-The trimmed value.
+The trimmed string or the original.
 
 ***
 
-### kebabCase()
+### kebabCase() {#kebabcase}
 
-> `static` **kebabCase**(`input`, `stripInterfacePrefix`): `string`
+> `static` **kebabCase**(`input`, `stripInterfacePrefix?`): `string`
 
 Convert the input string to kebab case.
 
@@ -72,7 +94,7 @@ Convert the input string to kebab case.
 
 The input to convert.
 
-##### stripInterfacePrefix
+##### stripInterfacePrefix?
 
 `boolean` = `true`
 
@@ -86,9 +108,9 @@ The kebab case version of the input.
 
 ***
 
-### snakeCase()
+### snakeCase() {#snakecase}
 
-> `static` **snakeCase**(`input`, `stripInterfacePrefix`): `string`
+> `static` **snakeCase**(`input`, `stripInterfacePrefix?`): `string`
 
 Convert the input string to snake case.
 
@@ -100,7 +122,7 @@ Convert the input string to snake case.
 
 The input to convert.
 
-##### stripInterfacePrefix
+##### stripInterfacePrefix?
 
 `boolean` = `true`
 
@@ -114,9 +136,9 @@ The snake case version of the input.
 
 ***
 
-### titleCase()
+### titleCase() {#titlecase}
 
-> `static` **titleCase**(`input`, `stripInterfacePrefix`): `string`
+> `static` **titleCase**(`input`, `stripInterfacePrefix?`): `string`
 
 Title case all the words.
 
@@ -128,7 +150,7 @@ Title case all the words.
 
 The input to convert.
 
-##### stripInterfacePrefix
+##### stripInterfacePrefix?
 
 `boolean` = `true`
 
@@ -142,9 +164,9 @@ The title case version of the input.
 
 ***
 
-### pascalCase()
+### pascalCase() {#pascalcase}
 
-> `static` **pascalCase**(`input`, `stripInterfacePrefix`): `string`
+> `static` **pascalCase**(`input`, `stripInterfacePrefix?`): `string`
 
 Pascal case all the words.
 
@@ -156,7 +178,7 @@ Pascal case all the words.
 
 The input to convert.
 
-##### stripInterfacePrefix
+##### stripInterfacePrefix?
 
 `boolean` = `true`
 
@@ -170,9 +192,9 @@ The pascal case version of the input.
 
 ***
 
-### camelCase()
+### camelCase() {#camelcase}
 
-> `static` **camelCase**(`input`, `stripInterfacePrefix`): `string`
+> `static` **camelCase**(`input`, `stripInterfacePrefix?`): `string`
 
 Camel case all the words.
 
@@ -184,7 +206,7 @@ Camel case all the words.
 
 The input to convert.
 
-##### stripInterfacePrefix
+##### stripInterfacePrefix?
 
 `boolean` = `true`
 
@@ -198,9 +220,9 @@ The camel case version of the input.
 
 ***
 
-### wordPath()
+### wordPath() {#wordpath}
 
-> `static` **wordPath**(`input`, `stripInterfacePrefix`): `string`
+> `static` **wordPath**(`input`, `stripInterfacePrefix?`): `string`
 
 Convert the words to a path.
 
@@ -212,7 +234,7 @@ Convert the words to a path.
 
 The input to convert.
 
-##### stripInterfacePrefix
+##### stripInterfacePrefix?
 
 `boolean` = `true`
 
@@ -226,7 +248,7 @@ The path version of the input.
 
 ***
 
-### stripPrefix()
+### stripPrefix() {#stripprefix}
 
 > `static` **stripPrefix**(`input`): `string`
 
@@ -248,7 +270,7 @@ The input with any interface prefix stripped.
 
 ***
 
-### words()
+### words() {#words}
 
 > `static` **words**(`input`): `string`[]
 
@@ -270,7 +292,7 @@ The string split into words.
 
 ***
 
-### isUtf8()
+### isUtf8() {#isutf8}
 
 > `static` **isUtf8**(`data`): `boolean`
 

package/docs/reference/classes/Uint8ArrayHelper.md

@@ -14,7 +14,7 @@ Class to help with uint8 arrays.
 
 ## Methods
 
-### concat()
+### concat() {#concat}
 
 > `static` **concat**(`arrays`): `Uint8Array`
 

package/docs/reference/classes/UnauthorizedError.md

@@ -1,6 +1,6 @@
 # Class: UnauthorizedError
 
-Class to handle errors which are triggered by access not being unauthorized.
+Class to handle errors which are triggered by access not being authorized.
 
 ## Extends
 
@@ -10,7 +10,7 @@ Class to handle errors which are triggered by access not being unauthorized.
 
 ### Constructor
 
-> **new UnauthorizedError**(`source`, `message`, `cause?`): `UnauthorizedError`
+> **new UnauthorizedError**(`source`, `message`, `properties?`, `cause?`): `UnauthorizedError`
 
 Create a new instance of UnauthorizedError.
 
@@ -26,7 +26,11 @@ The source of the error.
 
 `string`
 
-The message as a code.
+The message as an i18n key.
+
+##### properties?
+
+Any additional information for the error.
 
 ##### cause?
 
@@ -44,9 +48,9 @@ The cause of the error if we have wrapped another error.
 
 ## Properties
 
-### source?
+### source? {#source}
 
-> `optional` **source**: `string`
+> `optional` **source?**: `string`
 
 The source of the error.
 
@@ -56,9 +60,9 @@ The source of the error.
 
 ***
 
-### properties?
+### properties? {#properties}
 
-> `optional` **properties**: `object`
+> `optional` **properties?**: `object`
 
 Any additional information for the error.
 
@@ -72,9 +76,9 @@ Any additional information for the error.
 
 ***
 
-### cause?
+### cause? {#cause}
 
-> `optional` **cause**: [`IError`](../interfaces/IError.md)
+> `optional` **cause?**: [`IError`](../interfaces/IError.md)
 
 The cause of the error.
 
@@ -84,7 +88,7 @@ The cause of the error.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -92,7 +96,7 @@ Runtime name for the class.
 
 ## Methods
 
-### fromError()
+### fromError() {#fromerror}
 
 > `static` **fromError**(`err`): [`BaseError`](BaseError.md)
 
@@ -118,7 +122,7 @@ The new instance.
 
 ***
 
-### flatten()
+### flatten() {#flatten}
 
 > `static` **flatten**(`err`): [`IError`](../interfaces/IError.md)[]
 
@@ -144,9 +148,9 @@ The list of all internal errors.
 
 ***
 
-### expand()
+### expand() {#expand}
 
-> `static` **expand**(`errors`): `undefined` \| [`IError`](../interfaces/IError.md)
+> `static` **expand**(`errors`): [`IError`](../interfaces/IError.md) \| `undefined`
 
 Expand an error tree.
 
@@ -154,13 +158,13 @@ Expand an error tree.
 
 ##### errors
 
-The list of errors to expand.
+[`IError`](../interfaces/IError.md)[] \| `undefined`
 
-`undefined` | [`IError`](../interfaces/IError.md)[]
+The list of errors to expand.
 
 #### Returns
 
-`undefined` \| [`IError`](../interfaces/IError.md)
+[`IError`](../interfaces/IError.md) \| `undefined`
 
 The first level error.
 
@@ -170,7 +174,7 @@ The first level error.
 
 ***
 
-### isErrorName()
+### isErrorName() {#iserrorname}
 
 > `static` **isErrorName**(`error`, `name`): `error is BaseError`
 
@@ -186,9 +190,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -202,7 +206,7 @@ True if the error has the name.
 
 ***
 
-### isErrorMessage()
+### isErrorMessage() {#iserrormessage}
 
 > `static` **isErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -218,9 +222,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -234,7 +238,7 @@ True if the error has the name.
 
 ***
 
-### isErrorCode()
+### isErrorCode() {#iserrorcode}
 
 > `static` **isErrorCode**(`error`, `code`): `boolean`
 
@@ -250,9 +254,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -266,7 +270,7 @@ True if the error has the code.
 
 ***
 
-### someErrorName()
+### someErrorName() {#someerrorname}
 
 > `static` **someErrorName**(`error`, `name`): `error is BaseError`
 
@@ -282,9 +286,9 @@ The error to test.
 
 ##### name
 
-The name to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The name to check for.
 
 #### Returns
 
@@ -298,7 +302,7 @@ True if the error has the name.
 
 ***
 
-### someErrorMessage()
+### someErrorMessage() {#someerrormessage}
 
 > `static` **someErrorMessage**(`error`, `message`): `error is BaseError`
 
@@ -314,9 +318,9 @@ The error to test.
 
 ##### message
 
-The message to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The message to check for.
 
 #### Returns
 
@@ -330,7 +334,7 @@ True if the error has the name.
 
 ***
 
-### someErrorClass()
+### someErrorClass() {#someerrorclass}
 
 > `static` **someErrorClass**(`error`, `cls`): `error is BaseError`
 
@@ -362,7 +366,7 @@ True if the error has the specific class.
 
 ***
 
-### someErrorCode()
+### someErrorCode() {#someerrorcode}
 
 > `static` **someErrorCode**(`error`, `code`): `error is BaseError`
 
@@ -378,9 +382,9 @@ The error to test.
 
 ##### code
 
-The code to check for.
+`string` \| `RegExp`
 
-`string` | `RegExp`
+The code to check for.
 
 #### Returns
 
@@ -394,7 +398,7 @@ True if the error has the name.
 
 ***
 
-### isEmpty()
+### isEmpty() {#isempty}
 
 > `static` **isEmpty**(`err`): `boolean`
 
@@ -420,7 +424,7 @@ True if the error is empty.
 
 ***
 
-### isAggregateError()
+### isAggregateError() {#isaggregateerror}
 
 > `static` **isAggregateError**(`err`): `err is AggregateError`
 
@@ -446,7 +450,7 @@ True if the error is an aggregate error.
 
 ***
 
-### fromAggregate()
+### fromAggregate() {#fromaggregate}
 
 > `static` **fromAggregate**(`err`, `includeStackTrace?`): [`IError`](../interfaces/IError.md)[]
 
@@ -478,7 +482,7 @@ The array of errors.
 
 ***
 
-### toJsonObject()
+### toJsonObject() {#tojsonobject}
 
 > **toJsonObject**(`includeStackTrace?`): [`IError`](../interfaces/IError.md)