-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add dynamo and utils modules (#3)
* feat: add dynamo and utils modules * chore: update readme * chore: update readme * feat: modularize and add basic input validation * chore: update doc * chore: modularize tests * chore: update license year * feat: add query timing * chore: simplify tests * fix: toBoolean / isBoolean
- Loading branch information
1 parent
4a5308d
commit 5e2e605
Showing
34 changed files
with
3,334 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,4 +13,5 @@ | |
| module.exports = { | ||
| root: true, | ||
| extends: '@adobe/helix', | ||
| plugins: ['import'], | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,6 @@ | ||
| # spacecat-shared | ||
| Shared modules for Spacecat Services | ||
|
|
||
| ## Modules | ||
| - `spacecat-shared-dynamodb` - DynamoDB client for basic access | ||
| - `spacecat-shared-utils` - Utility functions |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,213 @@ | ||
| ## Functions | ||
|
|
||
| <dl> | ||
| <dt><a href="#createClient">createClient(log, dbClient, docClient)</a> ⇒ <code>Object</code></dt> | ||
| <dd><p>Creates a client object for interacting with DynamoDB.</p> | ||
| </dd> | ||
| <dt><a href="#isBoolean">isBoolean(value)</a> ⇒ <code>boolean</code></dt> | ||
| <dd><p>Determines if the given value is a boolean or a string representation of a boolean.</p> | ||
| </dd> | ||
| <dt><a href="#isInteger">isInteger(value)</a> ⇒ <code>boolean</code></dt> | ||
| <dd><p>Checks if the given value is an integer.</p> | ||
| </dd> | ||
| <dt><a href="#isNumber">isNumber(value)</a> ⇒ <code>boolean</code></dt> | ||
| <dd><p>Determines if the given value is a number.</p> | ||
| </dd> | ||
| <dt><a href="#isObject">isObject(obj)</a> ⇒ <code>boolean</code></dt> | ||
| <dd><p>Checks if the given parameter is an object and not an array or null.</p> | ||
| </dd> | ||
| <dt><a href="#isString">isString(str)</a> ⇒ <code>boolean</code></dt> | ||
| <dd><p>Determines if the given parameter is a string.</p> | ||
| </dd> | ||
| <dt><a href="#hasText">hasText(str)</a> ⇒ <code>boolean</code></dt> | ||
| <dd><p>Checks if the given string is not empty.</p> | ||
| </dd> | ||
| <dt><a href="#isValidDate">isValidDate(obj)</a> ⇒ <code>boolean</code></dt> | ||
| <dd><p>Checks whether the given object is a valid JavaScript Date.</p> | ||
| </dd> | ||
| <dt><a href="#isIsoDate">isIsoDate(str)</a> ⇒ <code>boolean</code></dt> | ||
| <dd><p>Validates whether the given string is a JavaScript ISO date string in | ||
| Zulu (UTC) timezone. Used for persisting system dates, which must be | ||
| independent of any user timezone.</p> | ||
| </dd> | ||
| <dt><a href="#isIsoTimeOffsetsDate">isIsoTimeOffsetsDate(str)</a> ⇒ <code>boolean</code></dt> | ||
| <dd><p>Validates whether the given string is a JavaScript ISO date string | ||
| following UTC time offsets format.</p> | ||
| </dd> | ||
| <dt><a href="#isValidUrl">isValidUrl(urlString)</a> ⇒ <code>boolean</code></dt> | ||
| <dd><p>Validates whether the given string is a valid URL with http or https protocol.</p> | ||
| </dd> | ||
| <dt><a href="#toBoolean">toBoolean(value)</a> ⇒ <code>boolean</code></dt> | ||
| <dd><p>Converts a given value to a boolean. Throws an error if the value is not a boolean.</p> | ||
| </dd> | ||
| <dt><a href="#arrayEquals">arrayEquals(a, b)</a> ⇒ <code>boolean</code></dt> | ||
| <dd><p>Compares two arrays for equality.</p> | ||
| </dd> | ||
| </dl> | ||
|
|
||
| <a name="createClient"></a> | ||
|
|
||
| ## createClient(log, dbClient, docClient) ⇒ <code>Object</code> | ||
| Creates a client object for interacting with DynamoDB. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>Object</code> - A client object with methods to interact with DynamoDB. | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | log | <code>Object</code> | The logging object, defaults to console. | | ||
| | dbClient | <code>DynamoDB</code> | The AWS SDK DynamoDB client instance. | | ||
| | docClient | <code>DynamoDBDocumentClient</code> | The AWS SDK DynamoDB Document client instance. | | ||
|
|
||
| <a name="isBoolean"></a> | ||
|
|
||
| ## isBoolean(value) ⇒ <code>boolean</code> | ||
| Determines if the given value is a boolean or a string representation of a boolean. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>boolean</code> - True if the value is a boolean or a string representation of a boolean. | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | value | <code>\*</code> | The value to check. | | ||
|
|
||
| <a name="isInteger"></a> | ||
|
|
||
| ## isInteger(value) ⇒ <code>boolean</code> | ||
| Checks if the given value is an integer. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>boolean</code> - True if the value is an integer, false otherwise. | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | value | <code>\*</code> | The value to check. | | ||
|
|
||
| <a name="isNumber"></a> | ||
|
|
||
| ## isNumber(value) ⇒ <code>boolean</code> | ||
| Determines if the given value is a number. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>boolean</code> - True if the value is a finite number, false otherwise. | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | value | <code>\*</code> | The value to check. | | ||
|
|
||
| <a name="isObject"></a> | ||
|
|
||
| ## isObject(obj) ⇒ <code>boolean</code> | ||
| Checks if the given parameter is an object and not an array or null. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>boolean</code> - True if the parameter is an object, false otherwise. | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | obj | <code>\*</code> | The object to check. | | ||
|
|
||
| <a name="isString"></a> | ||
|
|
||
| ## isString(str) ⇒ <code>boolean</code> | ||
| Determines if the given parameter is a string. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>boolean</code> - True if the parameter is a string, false otherwise. | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | str | <code>\*</code> | The string to check. | | ||
|
|
||
| <a name="hasText"></a> | ||
|
|
||
| ## hasText(str) ⇒ <code>boolean</code> | ||
| Checks if the given string is not empty. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>boolean</code> - True if the string is not empty, false otherwise. | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | str | <code>\*</code> | The string to check. | | ||
|
|
||
| <a name="isValidDate"></a> | ||
|
|
||
| ## isValidDate(obj) ⇒ <code>boolean</code> | ||
| Checks whether the given object is a valid JavaScript Date. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>boolean</code> - True if the given object is a valid Date object, false otherwise. | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | obj | <code>\*</code> | The object to check. | | ||
|
|
||
| <a name="isIsoDate"></a> | ||
|
|
||
| ## isIsoDate(str) ⇒ <code>boolean</code> | ||
| Validates whether the given string is a JavaScript ISO date string in | ||
| Zulu (UTC) timezone. Used for persisting system dates, which must be | ||
| independent of any user timezone. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>boolean</code> - True if the given string validates successfully. | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | str | <code>string</code> | The string to validate. | | ||
|
|
||
| <a name="isIsoTimeOffsetsDate"></a> | ||
|
|
||
| ## isIsoTimeOffsetsDate(str) ⇒ <code>boolean</code> | ||
| Validates whether the given string is a JavaScript ISO date string | ||
| following UTC time offsets format. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>boolean</code> - True if the given string validates successfully. | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | str | <code>string</code> | The string to validate. | | ||
|
|
||
| <a name="isValidUrl"></a> | ||
|
|
||
| ## isValidUrl(urlString) ⇒ <code>boolean</code> | ||
| Validates whether the given string is a valid URL with http or https protocol. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>boolean</code> - True if the given string validates successfully. | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | urlString | <code>string</code> | The string to validate. | | ||
|
|
||
| <a name="toBoolean"></a> | ||
|
|
||
| ## toBoolean(value) ⇒ <code>boolean</code> | ||
| Converts a given value to a boolean. Throws an error if the value is not a boolean. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>boolean</code> - The converted boolean value. | ||
| **Throws**: | ||
|
|
||
| - <code>Error</code> If the value is not a boolean or a boolean-like string. | ||
|
|
||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | value | <code>\*</code> | The value to convert. | | ||
|
|
||
| <a name="arrayEquals"></a> | ||
|
|
||
| ## arrayEquals(a, b) ⇒ <code>boolean</code> | ||
| Compares two arrays for equality. | ||
|
|
||
| **Kind**: global function | ||
| **Returns**: <code>boolean</code> - True if the arrays are equal, false otherwise. | ||
|
|
||
| | Param | Type | Description | | ||
| | --- | --- | --- | | ||
| | a | <code>Array</code> | The first array to compare. | | ||
| | b | <code>Array</code> | The second array to compare. | | ||
|
|
Oops, something went wrong.