@adobe/spacecat-shared-utils 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# @adobe/spacecat-shared-utils-v1.0.0 (2023-11-28)
+
+
+### Features
+
+* add dynamo and utils modules ([#3](https://github.com/adobe-rnd/spacecat-shared/issues/3)) ([5e2e605](https://github.com/adobe-rnd/spacecat-shared/commit/5e2e6059648f4f554168dabeab737f6a09d8a050))
+
+# @adobe/spacecat-shared-example-v1.0.0 (2023-11-27)
+
+
+### Bug Fixes
+
+* bogus change to force release ([e77e830](https://github.com/adobe-rnd/spacecat-shared/commit/e77e8305c96ac2504aeb22af44d45cb4acbcae56))
+* package name to "adobe" ([475434e](https://github.com/adobe-rnd/spacecat-shared/commit/475434e6619c2128ba1a8308a4eed23cf3d40691))
+* remove unneeded import (force release) ([49964f9](https://github.com/adobe-rnd/spacecat-shared/commit/49964f99906d5a0fafeb68b460cb19f98a51fc86))
+* repo reference ([881487d](https://github.com/adobe-rnd/spacecat-shared/commit/881487dce4c840ac2bf02a285f17cac511d39c88))
+* roll-back esm monorepo ([ab77518](https://github.com/adobe-rnd/spacecat-shared/commit/ab775187dc79a7f2cdb0ca4fa31198202be78143))
+* set package version to semantic, remove dev deps ([bf62c5f](https://github.com/adobe-rnd/spacecat-shared/commit/bf62c5fe013dbbb7425eb21cffa23e7f01322aee))
+* set to semantic-release versioning ([9209799](https://github.com/adobe-rnd/spacecat-shared/commit/92097995b657207996dd6a35277fdfcd3f3e8fb9))
+* variouss ([ea9d44f](https://github.com/adobe-rnd/spacecat-shared/commit/ea9d44f6071c1a53d2c31515966e7cdf44be7ae9))
+
+
+### Features
+
+* test ([bd3cc5d](https://github.com/adobe-rnd/spacecat-shared/commit/bd3cc5df89ccde75b86b000e8495893f4b099b5b))

package/LICENSE.txt

@@ -0,0 +1,264 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+APACHE JACKRABBIT SUBCOMPONENTS
+
+Apache Jackrabbit includes parts with separate copyright notices and license
+terms. Your use of these subcomponents is subject to the terms and conditions
+of the following licenses:
+
+    XPath 2.0/XQuery 1.0 Parser:
+    http://www.w3.org/2002/11/xquery-xpath-applets/xgrammar.zip
+
+    Copyright (C) 2002 World Wide Web Consortium, (Massachusetts Institute of
+    Technology, European Research Consortium for Informatics and Mathematics,
+    Keio University). All Rights Reserved.
+
+    This work is distributed under the W3C(R) Software License in the hope
+    that it will be useful, but WITHOUT ANY WARRANTY; without even the
+    implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+
+    W3C(R) SOFTWARE NOTICE AND LICENSE
+    http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
+
+    This work (and included software, documentation such as READMEs, or
+    other related items) is being provided by the copyright holders under
+    the following license. By obtaining, using and/or copying this work,
+    you (the licensee) agree that you have read, understood, and will comply
+    with the following terms and conditions.
+
+    Permission to copy, modify, and distribute this software and its
+    documentation, with or without modification, for any purpose and
+    without fee or royalty is hereby granted, provided that you include
+    the following on ALL copies of the software and documentation or
+    portions thereof, including modifications:
+
+       1. The full text of this NOTICE in a location viewable to users
+          of the redistributed or derivative work.
+
+       2. Any pre-existing intellectual property disclaimers, notices,
+          or terms and conditions. If none exist, the W3C Software Short
+          Notice should be included (hypertext is preferred, text is
+          permitted) within the body of any redistributed or derivative code.
+
+       3. Notice of any changes or modifications to the files, including
+          the date changes were made. (We recommend you provide URIs to the
+          location from which the code is derived.)
+
+    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT
+    HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED,
+    INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS
+    FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR
+    DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,
+    TRADEMARKS OR OTHER RIGHTS.
+
+    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL
+    OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR
+    DOCUMENTATION.
+
+    The name and trademarks of copyright holders may NOT be used in
+    advertising or publicity pertaining to the software without specific,
+    written prior permission. Title to copyright in this software and
+    any associated documentation will at all times remain with
+    copyright holders.

package/README.md

@@ -0,0 +1,3 @@
+# Spacecat Shared - Utils
+
+A collection of utility functions.

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@adobe/spacecat-shared-utils",
+  "version": "1.0.0",
+  "description": "Shared modules of the Spacecat Services - utils",
+  "type": "module",
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "scripts": {
+    "test": "c8 mocha",
+    "lint": "eslint .",
+    "clean": "rm -rf package-lock.json node_modules"
+  },
+  "mocha": {
+    "reporter": "mocha-multi-reporters",
+    "reporter-options": "configFile=.mocha-multi.json",
+    "spec": "test/*.test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/adobe-rnd/spacecat-shared.git"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/adobe-rnd/spacecat-shared/issues"
+  },
+  "homepage": "https://github.com/adobe-rnd/spacecat-shared#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "chai": "4.3.10"
+  }
+}

package/src/functions.js

@@ -0,0 +1,171 @@
+/*
+ * 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.
+ */
+
+// Precompile regular expressions
+const REGEX_ISO_DATE = /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z/;
+const REGEX_TIME_OFFSET_DATE = /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}(Z|[+-]\d{2}:\d{2})/;
+
+/**
+ * Determines case-insensitively if the given value is a boolean or a string
+ * representation of a boolean.
+ *
+ * @param {*} value - The value to check.
+ * @returns {boolean} True if the value is a boolean or a string representation of a boolean.
+ */
+function isBoolean(value) {
+  const lowerCaseValue = String(value).toLowerCase();
+  return typeof value === 'boolean' || lowerCaseValue === 'true' || lowerCaseValue === 'false';
+}
+
+/**
+ * Checks if the given value is an integer.
+ *
+ * @param {*} value - The value to check.
+ * @returns {boolean} True if the value is an integer, false otherwise.
+ */
+function isInteger(value) {
+  return typeof value === 'number' && Number.isInteger(value);
+}
+
+/**
+ * Determines if the given value is a number.
+ *
+ * @param {*} value - The value to check.
+ * @returns {boolean} True if the value is a finite number, false otherwise.
+ */
+function isNumber(value) {
+  return typeof value === 'number' && Number.isFinite(value);
+}
+
+/**
+ * Checks if the given parameter is an object and not an array or null.
+ *
+ * @param {*} obj - The object 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';
+}
+
+/**
+ * Determines if the given parameter is a string.
+ *
+ * @param {*} str - The string to check.
+ * @returns {boolean} True if the parameter is a string, false otherwise.
+ */
+function isString(str) {
+  return (!!str || str === '') && typeof str === 'string';
+}
+
+/**
+ * Checks if the given string is not empty.
+ *
+ * @param {*} str - The string to check.
+ * @returns {boolean} True if the string is not empty, false otherwise.
+ */
+function hasText(str) {
+  return !!str && typeof str === 'string';
+}
+
+/**
+ * Checks whether the given object is a valid JavaScript Date.
+ *
+ * @param {*} obj - The object 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());
+}
+
+/**
+ * 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.
+ *
+ * @param {string} str - The string to validate.
+ * @returns {boolean} True if the given string validates successfully.
+ */
+function isIsoDate(str) {
+  if (!REGEX_ISO_DATE.test(str)) {
+    return false;
+  }
+
+  const date = new Date(str);
+  return isValidDate(date) && date.toISOString() === str;
+}
+
+/**
+ * Validates whether the given string is a JavaScript ISO date string
+ * following UTC time offsets format.
+ *
+ * @param {string} str - The string to validate.
+ * @returns {boolean} True if the given string validates successfully.
+ */
+function isIsoTimeOffsetsDate(str) {
+  return REGEX_TIME_OFFSET_DATE.test(str);
+}
+
+/**
+ * Validates whether the given string is a valid URL with http or https protocol.
+ *
+ * @param {string} urlString - The string to validate.
+ * @returns {boolean} True if the given string validates successfully.
+ */
+function isValidUrl(urlString) {
+  try {
+    const url = new URL(urlString);
+    return url.protocol === 'http:' || url.protocol === 'https:';
+  } catch (e) {
+    return false;
+  }
+}
+
+/**
+ * Converts a given value to a boolean. Throws an error if the value is not a boolean.
+ *
+ * @param {*} value - The value to convert.
+ * @returns {boolean} The converted boolean value.
+ * @throws {Error} If the value is not a boolean or a boolean-like string.
+ */
+function toBoolean(value) {
+  if (!isBoolean(value)) {
+    throw new Error('Not a boolean value');
+  }
+  return JSON.parse(String(value).toLowerCase());
+}
+
+/**
+ * Compares two arrays for equality. Supports primitive array item types only.
+ *
+ * @param {Array} a - The first array to compare.
+ * @param {Array} b - The second array to compare.
+ * @returns {boolean} True if the arrays are equal, false otherwise.
+ */
+const arrayEquals = (a, b) => Array.isArray(a)
+  && Array.isArray(b)
+  && a.length === b.length
+  && a.every((val, index) => val === b[index]);
+
+export {
+  arrayEquals,
+  hasText,
+  isBoolean,
+  isInteger,
+  isValidDate,
+  isIsoDate,
+  isIsoTimeOffsetsDate,
+  isNumber,
+  isObject,
+  isString,
+  toBoolean,
+  isValidUrl,
+};