tests: coverage tests

Author: dreamorosi

Diff for: package-lock.json

@@ -40,6 +40,10 @@
         "default": "./lib/esm/index.js"
       }
     },
+    "./typeutils": {
+      "import": "./lib/esm/typeUtils.js",
+      "require": "./lib/cjs/typeUtils.js"
+    },
     "./types": {
       "import": "./lib/esm/types/index.js",
       "require": "./lib/cjs/types/index.js"
@@ -50,6 +54,10 @@
       "types": [
         "lib/cjs/types/index.d.ts",
         "lib/esm/types/index.d.ts"
+      ],
+      "typeutils": [
+        "lib/cjs/typeUtils.d.ts",
+        "lib/esm/typeUtils.d.ts"
       ]
     }
   },

Diff for: packages/commons/package.json

@@ -1,4 +1,14 @@
-export { isRecord, isString, isTruthy, isNullOrUndefined } from './guards.js';
+export {
+  isRecord,
+  isString,
+  isNumber,
+  isIntegerNumber,
+  isTruthy,
+  isNull,
+  isNullOrUndefined,
+  getType,
+  isStrictEqual,
+} from './typeUtils.js';
 export { Utility } from './Utility.js';
 export { EnvironmentVariablesService } from './config/EnvironmentVariablesService.js';
 export { addUserAgentMiddleware, isSdkClient } from './awsSdkUtils.js';

Diff for: packages/commons/src/guards.ts

@@ -0,0 +1,160 @@
+/**
+ * Returns true if the passed value is a record (object).
+ *
+ * @param value The value to check
+ */
+const isRecord = (value: unknown): value is Record<string, unknown> => {
+  return (
+    Object.prototype.toString.call(value) === '[object Object]' &&
+    !Object.is(value, null)
+  );
+};
+
+/**
+ * Check if a value is a string.
+ *
+ * @param value The value to check
+ */
+const isString = (value: unknown): value is string => {
+  return typeof value === 'string';
+};
+
+/**
+ * Check if a value is a number.
+ *
+ * @param value The value to check
+ */
+const isNumber = (value: unknown): value is number => {
+  return typeof value === 'number';
+};
+
+/**
+ * Check if a value is an integer number.
+ *
+ * @param value The value to check
+ */
+const isIntegerNumber = (value: unknown): value is number => {
+  return isNumber(value) && Number.isInteger(value);
+};
+
+/**
+ * Check if a value is truthy.
+ *
+ * @param value The value to check
+ */
+const isTruthy = (value: unknown): boolean => {
+  if (isString(value)) {
+    return value !== '';
+  } else if (isNumber(value)) {
+    return value !== 0;
+  } else if (typeof value === 'boolean') {
+    return value;
+  } else if (Array.isArray(value)) {
+    return value.length > 0;
+  } else if (isRecord(value)) {
+    return Object.keys(value).length > 0;
+  } else {
+    return false;
+  }
+};
+
+/**
+ * Check if a value is null.
+ *
+ * @param value The value to check
+ */
+const isNull = (value: unknown): value is null => {
+  return Object.is(value, null);
+};
+
+/**
+ * Check if a value is null or undefined.
+ *
+ * @param value The value to check
+ */
+const isNullOrUndefined = (value: unknown): value is null | undefined => {
+  return isNull(value) || Object.is(value, undefined);
+};
+
+/**
+ * Get the type of a value as a string.
+ *
+ * @param value The value to check
+ */
+const getType = (value: unknown): string => {
+  if (Array.isArray(value)) {
+    return 'array';
+  } else if (isRecord(value)) {
+    return 'object';
+  } else if (isString(value)) {
+    return 'string';
+  } else if (isNumber(value)) {
+    return 'number';
+  } else if (typeof value === 'boolean') {
+    return 'boolean';
+  } else if (isNull(value)) {
+    return 'null';
+  } else {
+    return 'unknown';
+  }
+};
+
+/**
+ * Check if two unknown values are strictly equal.
+ *
+ * If the values are arrays, then each element is compared, regardless of
+ * order. If the values are objects, then each key and value from left
+ * is compared to the corresponding key and value from right. If the
+ * values are primitives, then they are compared using strict equality.
+ *
+ * @param left Left side of strict equality comparison
+ * @param right Right side of strict equality comparison
+ */
+const isStrictEqual = (left: unknown, right: unknown): boolean => {
+  if (left === right) {
+    return true;
+  } else if (typeof left !== typeof right) {
+    return false;
+  } else if (Array.isArray(left) && Array.isArray(right)) {
+    if (left.length !== right.length) {
+      return false;
+    }
+    for (const [i, value] of left.entries()) {
+      if (!isStrictEqual(value, right[i])) {
+        return false;
+      }
+    }
+
+    return true;
+  } else if (isRecord(left) && isRecord(right)) {
+    const leftKeys = Object.keys(left);
+    const leftValues = Object.values(left);
+    const rightKeys = Object.keys(right);
+    const rightValues = Object.values(right);
+    if (
+      leftKeys.length !== rightKeys.length ||
+      leftValues.length !== rightValues.length
+    ) {
+      return false;
+    }
+
+    return (
+      isStrictEqual(leftKeys, rightKeys) &&
+      isStrictEqual(leftValues, rightValues)
+    );
+  } else {
+    return false;
+  }
+};
+
+export {
+  isRecord,
+  isString,
+  isNumber,
+  isIntegerNumber,
+  isTruthy,
+  isNull,
+  isNullOrUndefined,
+  getType,
+  isStrictEqual,
+};

Diff for: packages/commons/src/index.ts

@@ -0,0 +1,74 @@
+# Powertools for AWS Lambda (TypeScript) - JMESPath Utility <!-- omit in toc -->
+
+Powertools for AWS Lambda (TypeScript) is a developer toolkit to implement Serverless [best practices and increase developer velocity](https://docs.powertools.aws.dev/lambda/typescript/latest/#features).
+
+You can use the package in both TypeScript and JavaScript code bases.
+
+- [Intro](#intro)
+- [Usage](#usage)
+- [Contribute](#contribute)
+- [Roadmap](#roadmap)
+- [Connect](#connect)
+- [How to support Powertools for AWS Lambda (TypeScript)?](#how-to-support-powertools-for-aws-lambda-typescript)
+  - [Becoming a reference customer](#becoming-a-reference-customer)
+  - [Sharing your work](#sharing-your-work)
+  - [Using Lambda Layer](#using-lambda-layer)
+- [License](#license)
+
+## Intro
+
+The JMESPath utility is a high-level function to parse and extract data from JSON objects using JMESPath expressions.
+
+## Usage
+
+To get started, install the library by running:
+
+```sh
+npm i @aws-lambda-powertools/jmespath
+```
+
+## Contribute
+
+If you are interested in contributing to this project, please refer to our [Contributing Guidelines](https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/CONTRIBUTING.md).
+
+## Roadmap
+
+The roadmap of Powertools for AWS Lambda (TypeScript) is driven by customers’ demand.  
+Help us prioritize upcoming functionalities or utilities by [upvoting existing RFCs and feature requests](https://github.com/aws-powertools/powertools-lambda-typescript/issues), or [creating new ones](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new/choose), in this GitHub repository.
+
+## Connect
+
+* **Powertools for AWS Lambda on Discord**: `#typescript` - **[Invite link](https://discord.gg/B8zZKbbyET)**
+* **Email**: [email protected]
+
+## How to support Powertools for AWS Lambda (TypeScript)?
+
+### Becoming a reference customer
+
+Knowing which companies are using this library is important to help prioritize the project internally. If your company is using Powertools for AWS Lambda (TypeScript), you can request to have your name and logo added to the README file by raising a [Support Powertools for AWS Lambda (TypeScript) (become a reference)](https://github.com/aws-powertools/powertools-lambda-typescript/issues/new?assignees=&labels=customer-reference&template=support_powertools.yml&title=%5BSupport+Lambda+Powertools%5D%3A+%3Cyour+organization+name%3E) issue.
+
+The following companies, among others, use Powertools:
+
+* [Hashnode](https://hashnode.com/)
+* [Trek10](https://www.trek10.com/)
+* [Elva](https://elva-group.com)
+* [globaldatanet](https://globaldatanet.com/)
+* [Bailey Nelson](https://www.baileynelson.com.au)
+* [Perfect Post](https://www.perfectpost.fr)
+* [Sennder](https://sennder.com/)
+* [Certible](https://www.certible.com/)
+* [tecRacer GmbH & Co. KG](https://www.tecracer.com/)
+* [AppYourself](https://appyourself.net)
+* [Alma Media](https://www.almamedia.fi)
+
+### Sharing your work
+
+Share what you did with Powertools for AWS Lambda (TypeScript) 💞💞. Blog post, workshops, presentation, sample apps and others. Check out what the community has already shared about Powertools for AWS Lambda (TypeScript) [here](https://docs.powertools.aws.dev/lambda/typescript/latest/we_made_this).
+
+### Using Lambda Layer
+
+This helps us understand who uses Powertools for AWS Lambda (TypeScript) in a non-intrusive way, and helps us gain future investments for other Powertools for AWS Lambda languages. When [using Layers](https://docs.powertools.aws.dev/lambda/typescript/latest/#lambda-layer), you can add Powertools as a dev dependency to not impact the development process.
+
+## License
+
+This library is licensed under the MIT-0 License. See the LICENSE file.

Diff for: packages/commons/src/typeUtils.ts

@@ -4,7 +4,9 @@ module.exports = {
     color: 'purple',
   },
   runner: 'groups',
-  preset: 'ts-jest',
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1',
+  },
   transform: {
     '^.+\\.ts?$': 'ts-jest',
   },
@@ -14,7 +16,11 @@ module.exports = {
   roots: ['<rootDir>/src', '<rootDir>/tests'],
   testPathIgnorePatterns: ['/node_modules/'],
   testEnvironment: 'node',
-  coveragePathIgnorePatterns: ['/node_modules/', '/types/'],
+  coveragePathIgnorePatterns: [
+    '/node_modules/',
+    'src/index.ts',
+    'src/types/index.ts',
+  ],
   coverageThreshold: {
     global: {
       statements: 100,