@sheerid/jslib 1.106.0 → 1.109.0

package/README.md

@@ -1,2 +1,106 @@
 # SheerID JavaScript Library
+
 See [https://developer.sheerid.com](https://developer.sheerid.com) for more
+
+## Step 1: Overview
+
+An overview of SheerID Installation Methods can be found [**here**](https://developer.sheerid.com/getting-started/install#install-snippets)
+
+This readme demonstrates options when SheerID is installed via the CDN.
+
+## Step 2: Install via the CDN
+
+Click [**here**](https://developer.sheerid.com/js-library#installation) for instructions. Once you have an html page with a form rendered in a div, you are ready to reference the various options outlined in this README
+
+## Set Options
+
+After step 2 you should have something like this:
+
+    <div id="my-form"></div>
+    <script>
+        var sheerId = window.sheerId;
+        sheerId.setOptions({logLevel: 'info'});
+
+        // Create a program at my.sheerid.com
+        var myProgramId = '<YOUR_PROGRAM_ID>';
+        var myDiv = document.getElementById('my-form');
+        var myForm = new sheerId.VerificationForm(myDiv, myProgramId);
+    </script>
+
+Many of the custom behaviors SheerID offers are exposed via `setOptions`. `sheerId.setOptions({logLevel: 'info'});` is setting the log level of the library to info, for increased debugging output while testing your program.
+
+### Available Options
+
+Pass all or a part of the following object to `sheerId.setOptions()`:
+
+    customFormFields: [],
+    doFetchTheme: true,
+    httpRequestTimeout: 10000, // ms
+    locale: null,
+    logLevel: "error",
+    messagesWithLocale: {},
+    minimumOrganizationSearchLength: 1,
+    mockStep: undefined,
+    mockSubSegment: undefined,
+    mockErrorId: undefined,
+    mockRewardCode: undefined,
+    mockRedirectUrl: undefined,
+    mockResponse: undefined,
+    privacyPolicyUrl: undefined,
+    useFingerprinting: false,
+    verificationId: undefined,
+
+For a full list of options, see https://developer.sheerid.com/jslib-api-docs/index.html#options
+
+## Custom Form Fields
+
+Custom form fields have the following interface:
+
+    export interface FormFieldConfig {
+        fieldId: string; // should be camelCase. Will be used the key in metadata where the value is stored. Also used to build localization message keys
+        fieldType: string; // Only text for now. Later: | "select" | "radio", etc
+        validate: (value: string | boolean) => ErrorId | string | undefined; // If value is invalid, return an error id or string so the error msg can be localized and shown
+        showPlaceholderAndHideLabel?: boolean;
+        required?: boolean;
+    }
+
+At the time of writing, only `fieldType=text` is supported. Provide an array of custom form fields to `setOptions` and they will be added below other form fields.
+
+The data that is collected for custom fields is attached to the verification as metadata with the metadata key = `fieldId`. This data will show up in Verification Reports.
+
+    sheerId.setOptions({
+        customFormFields: [
+            {
+                fieldId: "favoriteHairColor",
+                fieldType: "text",
+                showPlaceholderAndHideLabel: false,
+                required: true,
+                validate: (value) => {
+                    if (!value) {
+                        return "hairColorRequired"; // this becomes `errorId.hairColorRequired` in your localized messages object
+                    }
+                }
+            },
+        ],
+    });
+
+You will want to provide localized messaging for your field, which can be done with setOptions as well:
+
+    sheerId.setOptions({
+        messagesWithLocale: {
+            "en-US": {
+                favoriteHairColorPlaceholder: 'My hair is...',
+                favoriteHairColorLabel: 'Hair Color',
+                'errorId.hairColorRequired': 'Hair Color is Required',
+            },
+            es: {
+                testPlaceholder: 'Mi pelo es...',
+                testLabel: 'Color de pelo',
+                'errorId.myCustomErrorId': 'Se requiere color de cabello',
+            },
+        },
+    });
+
+**Note:** placeholder and label message keys are automatically formulated based on the fieldId: `${fieldId}Placeholder` and `${fieldId}Label`
+
+See it in action: https://jsfiddle.net/AaronSheerID/n91p2sya/

package/__tests__/__helpers__/renderers.d.ts

@@ -1,9 +1,16 @@
 declare class S {
     result: any;
+    messages: {};
     render(component: any): any;
     getRenderOutput(): any;
+    setMessages(messages: any): void;
 }
 export declare const ShallowCompat: {
     createRenderer: () => S;
 };
+export declare const toEventObject: (value: string | number) => {
+    target: {
+        value: string | number;
+    };
+};
 export {};

package/es5/Tmetrix.bundle.js

@@ -1,10 +1,10 @@
 /*!
  * 
- *     VERSION: 1.106.0
- *     BUILD_TIMESTAMP: 1658420075734
- *     BUILD_DATE: Thu Jul 21 2022 16:14:35 GMT+0000 (Coordinated Universal Time)
- *     BUILD_COMMIT: 7ac4f8800247d1f0f26b2ea2b9d01b934c79c0ae
+ *     VERSION: 1.109.0
+ *     BUILD_TIMESTAMP: 1659985090713
+ *     BUILD_DATE: Mon Aug 08 2022 18:58:10 GMT+0000 (Coordinated Universal Time)
+ *     BUILD_COMMIT: ad2320d3b2f9cbe444c1e33fcb9bd5455909a348
  * 
  */
-window.sheerIdCurrentScript=document.currentScript,window.sheerIdEs5="true",window.sheerIdPubV="1.106.0",(window.webpackJsonpsheerid=window.webpackJsonpsheerid||[]).push([[0],{513:function(e,t,n){"use strict";n.r(t),n.d(t,"ThreatMetrix",(function(){return r}));const r=(()=>{let e=window.hp_frame||null,t=window.tmx_frame||null,n=window.tmx_script||null;var r=r||{};return r.version=3,r.create_url=function(e,t,n,c,o){function i(){return Math.floor(2742745743359*Math.random())}function u(){return a(i())}function a(e){return(e+78364164096).toString(36)}var s=i(),l=i(),d=885187064159;l=((l=l-l%256+r.version)+s)%2742745743359,d=(d+s)%2742745743359;var p="https://"+e+"/"+(s=u()+a(s))+t,m=[(l=a(d)+a(l))+"="+n,u()+u()+"="+c];return void 0!==o&&o.length>0&&m.push(u()+u()+"="+o),p+"?"+m.join("&")},r.beacon=function(e,t,n,r){var c="turn:aa.online-metrix.net?transport=",o="1:"+t+":"+n,i={iceServers:[{urls:c+"tcp",username:o,credential:n},{urls:c+"udp",username:o,credential:n}]};try{var u=new RTCPeerConnection(i);u.createDataChannel(Math.random().toString());var a=function(){},s=function(e){u.setLocalDescription(e,a,a)};"undefined"==typeof Promise||u.createOffer.length>0?u.createOffer(s,a):u.createOffer().then(s,a)}catch(e){}},r.load_tags=function(e,t,n,c){r.beacon(e,t,n,c);var o=document.getElementsByTagName("head").item(0),i=document.createElement("script");i.id="tmx_tags_js",i.setAttribute("type","text/javascript");var u=r.create_url(e,".js",t,n,c);i.setAttribute("src",u),r.set_csp_nonce(i),o.appendChild(i)},r.load_iframe_tags=function(e,t,n,c){r.beacon(e,t,n,c);var o=r.create_url(e,".htm",t,n,c),i=document.createElement("iframe");i.title="empty",i.setAttribute("aria-disabled","true"),i.width="0",i.height="0",i.setAttribute("style","color:rgba(0,0,0,0); float:left; position:absolute; top:-200; left:-200; border:0px"),i.setAttribute("src",o),document.body.appendChild(i)},r.csp_nonce=null,r.register_csp_nonce=function(e){if(void 0!==e.currentScript&&null!==e.currentScript){var t=e.currentScript.getAttribute("nonce");null!=t&&""!==t?r.csp_nonce=t:void 0!==e.currentScript.nonce&&null!==e.currentScript.nonce&&""!==e.currentScript.nonce&&(r.csp_nonce=e.currentScript.nonce)}},r.set_csp_nonce=function(e){null!==r.csp_nonce&&(e.setAttribute("nonce",r.csp_nonce),e.getAttribute("nonce")!==r.csp_nonce&&(e.nonce=r.csp_nonce))},r.cleanup=function(){for(;null!==(e=document.getElementById("tdz_ifrm"));)e.parentElement.removeChild(e);for(;null!==(t=document.getElementById("tmx_tags_iframe"));)t.parentElement.removeChild(t);for(;null!==(n=document.getElementById("tmx_tags_js"));)n.parentElement.removeChild(n)},r.profile=function(e,t,n,c){r.cleanup(),r.register_csp_nonce(document),r.load_tags(e,t,n,c)},r.profile_iframe=function(e,t,n,c){r.cleanup(),r.register_csp_nonce(document),r.load_iframe_tags(e,t,n,c)},r})()}}]);
+window.sheerIdCurrentScript=document.currentScript,window.sheerIdEs5="true",window.sheerIdPubV="1.109.0",(window.webpackJsonpsheerid=window.webpackJsonpsheerid||[]).push([[0],{516:function(e,t,n){"use strict";n.r(t),n.d(t,"ThreatMetrix",(function(){return r}));const r=(()=>{let e=window.hp_frame||null,t=window.tmx_frame||null,n=window.tmx_script||null;var r=r||{};return r.version=3,r.create_url=function(e,t,n,c,o){function i(){return Math.floor(2742745743359*Math.random())}function u(){return a(i())}function a(e){return(e+78364164096).toString(36)}var s=i(),l=i(),d=885187064159;l=((l=l-l%256+r.version)+s)%2742745743359,d=(d+s)%2742745743359;var p="https://"+e+"/"+(s=u()+a(s))+t,m=[(l=a(d)+a(l))+"="+n,u()+u()+"="+c];return void 0!==o&&o.length>0&&m.push(u()+u()+"="+o),p+"?"+m.join("&")},r.beacon=function(e,t,n,r){var c="turn:aa.online-metrix.net?transport=",o="1:"+t+":"+n,i={iceServers:[{urls:c+"tcp",username:o,credential:n},{urls:c+"udp",username:o,credential:n}]};try{var u=new RTCPeerConnection(i);u.createDataChannel(Math.random().toString());var a=function(){},s=function(e){u.setLocalDescription(e,a,a)};"undefined"==typeof Promise||u.createOffer.length>0?u.createOffer(s,a):u.createOffer().then(s,a)}catch(e){}},r.load_tags=function(e,t,n,c){r.beacon(e,t,n,c);var o=document.getElementsByTagName("head").item(0),i=document.createElement("script");i.id="tmx_tags_js",i.setAttribute("type","text/javascript");var u=r.create_url(e,".js",t,n,c);i.setAttribute("src",u),r.set_csp_nonce(i),o.appendChild(i)},r.load_iframe_tags=function(e,t,n,c){r.beacon(e,t,n,c);var o=r.create_url(e,".htm",t,n,c),i=document.createElement("iframe");i.title="empty",i.setAttribute("aria-disabled","true"),i.width="0",i.height="0",i.setAttribute("style","color:rgba(0,0,0,0); float:left; position:absolute; top:-200; left:-200; border:0px"),i.setAttribute("src",o),document.body.appendChild(i)},r.csp_nonce=null,r.register_csp_nonce=function(e){if(void 0!==e.currentScript&&null!==e.currentScript){var t=e.currentScript.getAttribute("nonce");null!=t&&""!==t?r.csp_nonce=t:void 0!==e.currentScript.nonce&&null!==e.currentScript.nonce&&""!==e.currentScript.nonce&&(r.csp_nonce=e.currentScript.nonce)}},r.set_csp_nonce=function(e){null!==r.csp_nonce&&(e.setAttribute("nonce",r.csp_nonce),e.getAttribute("nonce")!==r.csp_nonce&&(e.nonce=r.csp_nonce))},r.cleanup=function(){for(;null!==(e=document.getElementById("tdz_ifrm"));)e.parentElement.removeChild(e);for(;null!==(t=document.getElementById("tmx_tags_iframe"));)t.parentElement.removeChild(t);for(;null!==(n=document.getElementById("tmx_tags_js"));)n.parentElement.removeChild(n)},r.profile=function(e,t,n,c){r.cleanup(),r.register_csp_nonce(document),r.load_tags(e,t,n,c)},r.profile_iframe=function(e,t,n,c){r.cleanup(),r.register_csp_nonce(document),r.load_iframe_tags(e,t,n,c)},r})()}}]);
 //# sourceMappingURL=Tmetrix.bundle.js.map