@adobe/spacecat-shared-utils 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-utils-v1.1.0](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.0.1...@adobe/spacecat-shared-utils-v1.1.0) (2023-11-29)
+
+
+### Features
+
+* add guards and use spacecat-shared-utils ([#6](https://github.com/adobe-rnd/spacecat-shared/issues/6)) ([27143cf](https://github.com/adobe-rnd/spacecat-shared/commit/27143cf2d4a439f1b5904e62756e59e501b3f67d))
+
 # [@adobe/spacecat-shared-utils-v1.0.1](https://github.com/adobe-rnd/spacecat-shared/compare/@adobe/spacecat-shared-utils-v1.0.0...@adobe/spacecat-shared-utils-v1.0.1) (2023-11-28)
 
 

package/README.md

@@ -1,3 +1,57 @@
-# Spacecat Shared - Utils
+# SpaceCat Shared Utilities
 
-A collection of utility functions.
+This repository contains a collection of shared utility functions used across various SpaceCat projects. These utilities provide a range of checks and validations, from basic data type validation to more complex checks like ISO date strings and URL validation.
+
+## Installation
+
+To install the SpaceCat Shared Utilities, you can use npm:
+
+```bash
+npm install spacecat-shared-utils
+```
+
+Or, if you are using yarn:
+
+```bash
+yarn add spacecat-shared-utils
+```
+
+## Usage
+
+Here's how you can use the different utility functions in your project:
+
+```javascript
+import { isBoolean, isValidUrl } from 'spacecat-shared-utils';
+
+console.log(isBoolean('true')); // true
+console.log(isValidUrl('https://www.example.com')); // true
+```
+
+## Functions
+
+The library includes the following utility functions:
+
+- `isBoolean(value)`: Determines if the given value is a boolean or a string representation of a boolean.
+- `isInteger(value)`: Checks if the given value is an integer.
+- `isValidDate(obj)`: Checks whether the given object is a valid JavaScript Date.
+- `isIsoDate(str)`: Validates whether the given string is a JavaScript ISO date string in Zulu (UTC) timezone.
+- `isIsoTimeOffsetsDate(str)`: Validates whether the given string is a JavaScript ISO date string following UTC time offsets format.
+- `isNumber(value)`: Determines if the given value is a number.
+- `isObject(obj)`: Checks if the given parameter is an object and not an array or null.
+- `isString(str)`: Determines if the given parameter is a string.
+- `toBoolean(value)`: Converts a given value to a boolean. Throws an error if the value is not a boolean.
+- `arrayEquals(a, b)`: Compares two arrays for equality.
+- `isValidUrl(urlString)`: Validates whether the given string is a valid URL with http or https protocol.
+- `hasText(str)`: Checks if the given string is not empty.
+
+## Testing
+
+This library includes a comprehensive test suite to ensure the reliability of the utility functions. To run the tests, use the following command:
+
+```bash
+npm test
+```
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE.txt) file for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-utils",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Shared modules of the Spacecat Services - utils",
   "type": "module",
   "main": "src/index.js",

package/src/functions.js

@@ -49,21 +49,21 @@ function isNumber(value) {
 /**
  * Checks if the given parameter is an object and not an array or null.
  *
- * @param {*} obj - The object to check.
+ * @param {*} value - The value to check.
  * @returns {boolean} True if the parameter is an object, false otherwise.
  */
-function isObject(obj) {
-  return !Array.isArray(obj) && obj !== null && typeof obj === 'object';
+function isObject(value) {
+  return !Array.isArray(value) && value !== null && typeof value === 'object';
 }
 
 /**
  * Determines if the given parameter is a string.
  *
- * @param {*} str - The string to check.
+ * @param {*} value - The value to check.
  * @returns {boolean} True if the parameter is a string, false otherwise.
  */
-function isString(str) {
-  return (!!str || str === '') && typeof str === 'string';
+function isString(value) {
+  return (!!value || value === '') && typeof value === 'string';
 }
 
 /**
@@ -73,17 +73,17 @@ function isString(str) {
  * @returns {boolean} True if the string is not empty, false otherwise.
  */
 function hasText(str) {
-  return !!str && typeof str === 'string';
+  return !!str && isString(str);
 }
 
 /**
  * Checks whether the given object is a valid JavaScript Date.
  *
- * @param {*} obj - The object to check.
+ * @param {*} value - The value to check.
  * @returns {boolean} True if the given object is a valid Date object, false otherwise.
  */
-function isValidDate(obj) {
-  return obj instanceof Date && !Number.isNaN(obj.getTime());
+function isValidDate(value) {
+  return value instanceof Date && !Number.isNaN(value.getTime());
 }
 
 /**

package/src/index.d.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2023 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+export function arrayEquals<T>(a: T[], b: T[]): boolean;
+
+export function hasText(str: string): boolean;
+
+export function isBoolean(value: unknown): boolean;
+
+export function isInteger(value: unknown): boolean;
+
+export function isValidDate(value: unknown): boolean;
+
+export function isIsoDate(str: string): boolean;
+
+export function isIsoTimeOffsetsDate(str: string): boolean;
+
+export function isNumber(value: unknown): boolean;
+
+export function isObject(value: unknown): boolean;
+
+export function isString(value: unknown): boolean;
+
+export function toBoolean(value: unknown): boolean;
+
+export function isValidUrl(urlString: string): boolean;