skyflow-js 1.32.0 → 1.33.0-beta.2

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
 All notable changes to this project will be documented in this file.
+
+## [1.32.0] - 2023-10-26
+### Added
+- `tokens` support in Get interface
+
 ## [1.31.1] - 2023-10-17
 ### Fixed
 - Expiration-year max-length based on format.

package/README.md

@@ -1809,12 +1809,19 @@ The sample response:
 ```
 
 - ### Using Skyflow ID's or Unique Column Values
-    You can retrieve data from the vault with the get(records) method using either Skyflow IDs or unique column values.
+    You can retrieve data from the vault with the `get(records, options)` method using either Skyflow IDs or unique column values.
 
     The records parameter accepts a JSON object that contains an array of either Skyflow IDs or unique column names and values.
 
-    Note: You can use either Skyflow IDs  or unique values to retrieve records. You can't use both at the same time.
+    The options is an optional `IGetOptions` object that retrieves the tokens for SkyflowIDs.
+ 
+    Notes:
 
+    - You can use either Skyflow IDs or unique values to retrieve records. You can't use both at the same time.
+    - `options` parameter is applicable only for retrieving tokens using Skyflow ID.
+    - You can't pass options along with the redaction type.
+    - `tokens` defaults to false.
+    
     Skyflow.RedactionTypes accepts four values:
     - `PLAIN_TEXT`
     - `MASKED`
@@ -1939,6 +1946,46 @@ Sample response:
 }
 ```
 
+[Example usage (Fetch tokens using Skyflow IDs)](https://github.com/skyflowapi/skyflow-js/blob/master/samples/using-script-tag/get-pure-js.html)
+```javascript
+skyflow.get({
+ records: [
+   {
+     ids: [
+      "f8d8a622-b557-4c6b-a12c-c5ebe0b0bfd9",
+      "da26de53-95d5-4bdb-99db-8d8c66a35ff9"
+    ],
+     table: "cards",
+   },
+ ],
+}, { tokens: true });
+```
+Sample response: 
+```javascript
+{
+  "records": [
+    {
+      "fields": {
+        "card_id": "f689e421-4cf8-4438-8dbd-cc8e7654b7d9",
+        "expiry_date": "d9ef1cb8-5c22-48b0-b769-64ac20ccee01",
+        "fullname": "37480f82-d237-4efc-a06a-ebe57121be06",
+        "id": "f8d2-b557-4c6b-a12c-c5ebfd9"
+      },
+      "table": "cards"
+    },
+    {
+      "fields": {
+        "card_id": "d794b64c-e283-4fb8-8eef-9f6710730b69",
+        "expiry_date": "ff848fc3-a093-4ed4-9414-877b74a33111",
+        "fullname": "dfb6c247-3ee6-4fd2-8d1e-19d8e11c25ce",
+        "id": "da53-95d5-4bdb-99db-8d8c5ff9"
+      },
+      "table": "cards"
+    }
+  ]
+}
+```
+
 ## Using Skyflow Elements to reveal data
 
 Skyflow Elements can be used to securely reveal data in a browser without exposing your front end to the sensitive data. This is great for use cases like card issuance where you may want to reveal the card number to a user without increasing your PCI compliance scope.