preparing v2.0.2 release

Author: mschuchard

CHANGELOG.md

@@ -1,3 +1,6 @@
+### 2.0.2
+- Implement `map` type custom functions.
+
 ### 2.0.1
 - Implement `slice` type custom functions.
 

docs/data-sources/has_keys.md

@@ -58,7 +58,7 @@ data "stdlib_has_keys" "three_keys_all" {
 ### Required
 
 - `keys` (List of String) Names of the keys to check for existence in the map.
-- `map` (Map of String) Input map parameter from which to check a key's existence.
+- `map` (Map of String) Input map parameter from which to check the keys' existence.
 
 ### Optional
 

docs/data-sources/has_value.md

@@ -3,12 +3,12 @@
 page_title: "stdlib_has_value Data Source - stdlib"
 subcategory: ""
 description: |-
-  Return whether the input key parameter is present in the input map parameter. The input map must be single-level.
+  Return whether the input value parameter is present in the input map parameter. The input map must be single-level.
 ---
 
 # stdlib_has_value (Data Source)
 
-Return whether the input key parameter is present in the input map parameter. The input map must be single-level.
+Return whether the input value parameter is present in the input map parameter. The input map must be single-level.
 
 ## Example Usage
 

docs/data-sources/has_values.md

@@ -57,7 +57,7 @@ data "stdlib_has_values" "three_values_all" {
 
 ### Required
 
-- `map` (Map of String) Input map parameter from which to check a value's existence.
+- `map` (Map of String) Input map parameter from which to check the values' existence.
 - `values` (List of String) Names of the values to check for existence in the map.
 
 ### Optional

docs/data-sources/keys_delete.md

@@ -3,12 +3,12 @@
 page_title: "stdlib_keys_delete Data Source - stdlib"
 subcategory: ""
 description: |-
-  Return the input map parameter with the key parameter deleted from the map.
+  Return the input map parameter with the keys parameter deleted from the map.
 ---
 
 # stdlib_keys_delete (Data Source)
 
-Return the input map parameter with the key parameter deleted from the map.
+Return the input map parameter with the keys parameter deleted from the map.
 
 ## Example Usage
 
@@ -31,9 +31,9 @@ data "stdlib_keys_delete" "foo" {
 ### Required
 
 - `keys` (List of String) Names of the keys to delete from the map.
-- `map` (Map of String) Input map parameter from which to delete a key.
+- `map` (Map of String) Input map parameter from which to delete the keys.
 
 ### Read-Only
 
 - `id` (String) Aliased to string input parameter(s) for efficiency and proper plan diff detection.
-- `result` (Map of String) Function result storing the map with the key removed.
+- `result` (Map of String) Function result storing the map with the keys removed.

docs/functions/equal_map.md

@@ -0,0 +1,37 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "equal_map function - stdlib"
+subcategory: ""
+description: |-
+  Check equality of two maps
+---
+
+# function: equal_map
+
+Return whether the two input map parameters contain the same key-value pairs (equality check). The input maps must be single-level.
+
+## Example Usage
+
+```terraform
+# Reports whether the two maps contain the same key/value pairs:
+provider::stdlib::equal_map({ "hello" = "world" }, { "hello" = "world" })
+# result => true
+
+# Reports whether the two maps contain the same key/value pairs:
+provider::stdlib::equal_map({ "hello" = "world" }, { "foo" = "bar" })
+# result => false
+```
+
+## Signature
+
+<!-- signature generated by tfplugindocs -->
+```text
+equal_map(map_one map of string, map_two map of string) bool
+```
+
+## Arguments
+
+<!-- arguments generated by tfplugindocs -->
+1. `map_one` (Map of String) First input map parameter to check for equality with the second.
+1. `map_two` (Map of String) Second input map parameter to check for equality with the first.
+

docs/functions/flatten_map.md

@@ -0,0 +1,35 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "flatten_map function - stdlib"
+subcategory: ""
+description: |-
+  Flatten a list of maps
+---
+
+# function: flatten_map
+
+Return the flattened map of an input list of maps. Note that if a key is repeated between distinct element maps, then the last entry will overwrite any previous entries in the result (maps cannot contain repeated keys).
+
+## Example Usage
+
+```terraform
+# Flatten a list(map) into map:
+provider::stdlib::flatten_map([
+  { "hello" = "world" },
+  { "foo" = "bar" }
+])
+# result => {"hello" = "world", "foo = "bar}
+```
+
+## Signature
+
+<!-- signature generated by tfplugindocs -->
+```text
+flatten_map(list_of_maps list of map of string) map of string
+```
+
+## Arguments
+
+<!-- arguments generated by tfplugindocs -->
+1. `list_of_maps` (List of Map of String) Input list of maps to flatten.
+

docs/functions/has_key.md

@@ -0,0 +1,37 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "has_key function - stdlib"
+subcategory: ""
+description: |-
+  Check existence of key in map
+---
+
+# function: has_key
+
+Return whether the input key parameter is present in the input map parameter. The input map must be single-level.
+
+## Example Usage
+
+```terraform
+# Check existence of "foo" key in map:
+provider::stdlib::has_key({"hello" = "world", "foo" = "bar"}, "foo")
+# result => true
+
+# Check existence of "bar" key in map:
+provider::stdlib::has_key({"hello" = "world", "foo" = "bar"}, "bar")
+# result => false
+```
+
+## Signature
+
+<!-- signature generated by tfplugindocs -->
+```text
+has_key(map map of string, key string) bool
+```
+
+## Arguments
+
+<!-- arguments generated by tfplugindocs -->
+1. `map` (Map of String) Input map parameter from which to check a key's existence.
+1. `key` (String) Name of the key to check for existence in the map.
+

docs/functions/has_keys.md

@@ -0,0 +1,76 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "has_keys function - stdlib"
+subcategory: ""
+description: |-
+  Check existence of keys in map
+---
+
+# function: has_keys
+
+Return whether any or all of the input key parameters are present in the input map parameter. The input map must be single-level.
+
+## Example Usage
+
+```terraform
+# Check existence of either "bar" or "foo" keys in map:
+provider::stdlib::has_keys(
+  {
+    "hello" = "world",
+    "foo"   = "bar",
+    "baz"   = "bat"
+  },
+  ["bar", "foo"]
+)
+# result => true
+
+# Check existence of either "bar" or "pizza" keys in map:
+provider::stdlib::has_keys(
+  {
+    "hello" = "world",
+    "foo"   = "bar",
+    "baz"   = "bat"
+  },
+  ["bar", "pizza"]
+)
+# result => false
+
+# Check existence of "bar" and "foo" keys in map:
+provider::stdlib::has_keys(
+  {
+    "hello" = "world",
+    "foo"   = "bar",
+    "baz"   = "bat"
+  },
+  ["bar", "foo"],
+  true
+)
+# result => false
+
+# Check existence of "hello", "foo", and "baz" keys in map:
+provider::stdlib::has_keys(
+  {
+    "hello" = "world",
+    "foo"   = "bar",
+    "baz"   = "bat"
+  },
+  ["hello", "foo", "baz"],
+  true
+)
+# result => true
+```
+
+## Signature
+
+<!-- signature generated by tfplugindocs -->
+```text
+has_keys(map map of string, keys list of string, all bool...) bool
+```
+
+## Arguments
+
+<!-- arguments generated by tfplugindocs -->
+1. `map` (Map of String) Input map parameter from which to check the keys' existence.
+1. `keys` (List of String) Names of the keys to check for existence in the map.
+<!-- variadic argument generated by tfplugindocs -->
+1. `all` (Variadic, Boolean) Optional: Whether to check for all of the keys instead of the default any of the keys.

docs/functions/has_value.md

@@ -0,0 +1,37 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "has_value function - stdlib"
+subcategory: ""
+description: |-
+  Check existence of value in map
+---
+
+# function: has_value
+
+Return whether the input value parameter is present in the input map parameter. The input map must be single-level.
+
+## Example Usage
+
+```terraform
+# Check existence of "foo" value in map:
+provider::stdlib::has_key({"hello" = "world", "foo" = "bar"}, "foo")
+# result => false
+
+# Check existence of "bar" value in map:
+provider::stdlib::has_key({"hello" = "world", "foo" = "bar"}, "bar")
+# result => true
+```
+
+## Signature
+
+<!-- signature generated by tfplugindocs -->
+```text
+has_value(map map of string, value string) bool
+```
+
+## Arguments
+
+<!-- arguments generated by tfplugindocs -->
+1. `map` (Map of String) Input map parameter from which to check a value's existence.
+1. `value` (String) Name of the value to check for existence in the map.
+