docs(logic): document base64url/2 and base64/2 predicates

ccamel · ccamel · commit 8bdc62507819 · 2025-03-28T18:08:01.000+01:00
diff --git a/docs/predicate/base64_2.md b/docs/predicate/base64_2.md
@@ -0,0 +1,59 @@
+---
+sidebar_position: 9
+---
+[//]: # (This file is auto-generated. Please do not modify it yourself.)
+
+# base64/2
+
+## Description
+
+`base64/2` is a predicate that unifies a string to a `base64/2` encoded string.
+
+The output is returned as an atom with padding included.
+
+The signature is as follows:
+
+```text
+base64(+Plain, -Encoded) is det
+base64(-Plain, +Encoded) is det
+```
+
+Where:
+
+- Plain is an atom, a list of characters, or character codes representing the unencoded text.
+- Encoded is an atom, a list of characters, or character codes representing the `base64/2` encoded form.
+
+The predicate is equivalent to base64\_encoded/3 with options: \[as\(atom\), encoding\(utf8\), charset\(classic\), padding\(true\)\].
+
+## Examples
+
+### Encode and decode a string into a Base64 encoded atom
+
+This scenario demonstrates how to encode an decode a plain string into a Base64-encoded atom using the `base64/2`
+predicate.
+
+Here are the steps of the scenario:
+
+- **Given** the query:
+
+```  prolog
+base64('Hello world', Encoded),
+base64(Decoded, 'SGVsbG8gd29ybGQ=').
+```
+
+- **When** the query is run
+- **Then** the answer we get is:
+
+```  yaml
+height: 42
+gas_used: 3976
+answer:
+  has_more: false
+  variables: ["Encoded", "Decoded"]
+  results:
+  - substitutions:
+    - variable: Encoded
+      expression: "'SGVsbG8gd29ybGQ='"
+    - variable: Decoded
+      expression: "'Hello world'"
+```
diff --git a/docs/predicate/base64_encoded_3.md b/docs/predicate/base64_encoded_3.md
@@ -1,13 +1,13 @@
 ---
-sidebar_position: 9
+sidebar_position: 10
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
 # base64_encoded/3
 
 ## Description
 
-`base64_encoded/3` is a predicate that unifies a string to a base64 encoded string as specified by [RFC 4648](<https://rfc-editor.org/rfc/rfc4648.html>).
+`base64_encoded/3` is a predicate that unifies a string to a Base64 encoded string as specified by [RFC 4648](<https://rfc-editor.org/rfc/rfc4648.html>).
 
 The signature is as follows:
 
@@ -20,7 +20,7 @@ base64_encoded(+Plain, +Encoded, +Options) is det
 Where:
 
 - Plain is an atom, a list of character codes, or list of characters containing the unencoded \(plain\) text.
-- Encoded is an atom or string containing the base64 encoded text.
+- Encoded is an atom or string containing the Base64 encoded text.
 - Options is a list of options that can be used to control the encoding process.
 
 ## Options
diff --git a/docs/predicate/base64_url_2.md b/docs/predicate/base64_url_2.md
@@ -0,0 +1,26 @@
+---
+sidebar_position: 11
+---
+[//]: # (This file is auto-generated. Please do not modify it yourself.)
+
+# base64_url/2
+
+## Description
+
+`base64_url/2` is a predicate that unifies a string to a Base64 URL\-safe encoded string.
+
+Encoded values are safe for use in URLs and filenames: "\+" is replaced by "\-", "/" by "\_", and padding is omitted.
+
+The signature is as follows:
+
+```text
+base64url(+Plain, -Encoded) is det
+base64url(-Plain, +Encoded) is det
+```
+
+Where:
+
+- Plain is an atom, a list of characters, or character codes representing the unencoded text.
+- Encoded is an atom, a list of characters, or character codes representing the Base64 URL\-safe encoded form.
+
+The predicate is equivalent to base64\_encoded/3 with options: \[as\(atom\), encoding\(utf8\), charset\(url\), padding\(false\)\].
diff --git a/docs/predicate/bech32_address_2.md b/docs/predicate/bech32_address_2.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 10
+sidebar_position: 12
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/block_header_1.md b/docs/predicate/block_header_1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 11
+sidebar_position: 13
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/block_height_1.md b/docs/predicate/block_height_1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 12
+sidebar_position: 14
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/block_time_1.md b/docs/predicate/block_time_1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 13
+sidebar_position: 15
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/chain_id_1.md b/docs/predicate/chain_id_1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 14
+sidebar_position: 16
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/consult_1.md b/docs/predicate/consult_1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 15
+sidebar_position: 17
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/crypto_data_hash_3.md b/docs/predicate/crypto_data_hash_3.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 16
+sidebar_position: 18
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/current_output_1.md b/docs/predicate/current_output_1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 17
+sidebar_position: 19
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/did_components_2.md b/docs/predicate/did_components_2.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 18
+sidebar_position: 20
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/ecdsa_verify_4.md b/docs/predicate/ecdsa_verify_4.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 19
+sidebar_position: 21
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/eddsa_verify_4.md b/docs/predicate/eddsa_verify_4.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 20
+sidebar_position: 22
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/hex_bytes_2.md b/docs/predicate/hex_bytes_2.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 21
+sidebar_position: 23
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/json_prolog_2.md b/docs/predicate/json_prolog_2.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 22
+sidebar_position: 24
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/json_read_2.md b/docs/predicate/json_read_2.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 23
+sidebar_position: 25
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/json_write_2.md b/docs/predicate/json_write_2.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 24
+sidebar_position: 26
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/open_3.md b/docs/predicate/open_3.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 26
+sidebar_position: 28
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/open_4.md b/docs/predicate/open_4.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 25
+sidebar_position: 27
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/read_string_3.md b/docs/predicate/read_string_3.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 27
+sidebar_position: 29
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/read_term_3.md b/docs/predicate/read_term_3.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 28
+sidebar_position: 30
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/retract_1.md b/docs/predicate/retract_1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 29
+sidebar_position: 31
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/source_file_1.md b/docs/predicate/source_file_1.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 30
+sidebar_position: 32
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/string_bytes_3.md b/docs/predicate/string_bytes_3.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 31
+sidebar_position: 33
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/term_to_atom_2.md b/docs/predicate/term_to_atom_2.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 32
+sidebar_position: 34
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/uri_encoded_3.md b/docs/predicate/uri_encoded_3.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 33
+sidebar_position: 35
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
diff --git a/docs/predicate/write_term_3.md b/docs/predicate/write_term_3.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 34
+sidebar_position: 36
 ---
 [//]: # (This file is auto-generated. Please do not modify it yourself.)
 
