@sankhyalabs/core 4.9.1 → 4.10.0

package/.docs/classes/OnboardingUtils.md

@@ -0,0 +1,126 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / OnboardingUtils
+
+# Class: OnboardingUtils
+
+## Table of contents
+
+### Constructors
+
+- [constructor](OnboardingUtils.md#constructor)
+
+### Properties
+
+- [USER\_GUIDE\_TAG\_ID](OnboardingUtils.md#user_guide_tag_id)
+- [instance](OnboardingUtils.md#instance)
+
+### Methods
+
+- [init](OnboardingUtils.md#init)
+- [injectScript](OnboardingUtils.md#injectscript)
+- [register](OnboardingUtils.md#register)
+- [getInstance](OnboardingUtils.md#getinstance)
+
+## Constructors
+
+### constructor
+
+• `Private` **new OnboardingUtils**()
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:5
+
+## Properties
+
+### USER\_GUIDE\_TAG\_ID
+
+▪ `Static` `Private` `Readonly` **USER\_GUIDE\_TAG\_ID**: ``"userGuideSnippet"``
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:2
+
+___
+
+### instance
+
+▪ `Static` `Private` **instance**: [`OnboardingUtils`](OnboardingUtils.md)
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:3
+
+## Methods
+
+### init
+
+▸ **init**(`apiKey`, `ctx`): `Promise`<`void`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `apiKey` | `string` |
+| `ctx` | `EnvironmentContext` |
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:14
+
+___
+
+### injectScript
+
+▸ `Private` **injectScript**(`apiKey`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `apiKey` | `string` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:23
+
+___
+
+### register
+
+▸ `Private` **register**(`ctx`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `ctx` | `EnvironmentContext` |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:34
+
+___
+
+### getInstance
+
+▸ `Static` **getInstance**(): [`OnboardingUtils`](OnboardingUtils.md)
+
+#### Returns
+
+[`OnboardingUtils`](OnboardingUtils.md)
+
+#### Defined in
+
+src/utils/OnboardingUtils.ts:7

package/.docs/modules.md

@@ -37,6 +37,7 @@
 - [MaskFormatter](classes/MaskFormatter-1.md)
 - [NumberUtils](classes/NumberUtils.md)
 - [ObjectUtils](classes/ObjectUtils.md)
+- [OnboardingUtils](classes/OnboardingUtils.md)
 - [ReadyUtil](classes/ReadyUtil.md)
 - [RequestMetadata](classes/RequestMetadata.md)
 - [SelectionInfo](classes/SelectionInfo.md)

package/dist/index.d.ts

@@ -28,4 +28,5 @@ import { UserAgentUtils } from "./utils/UserAgentUtils/index.js";
 import { JSUtils } from "./utils/JSUtils.js";
 import { DataUnitStorage } from "./dataunit/DataUnitStorage.js";
 import VersionUtils from './utils/VersionUtils.js';
-export { StringUtils, MaskFormatter, NumberUtils, FloatingManager, DateUtils, ArrayUtils, TimeFormatter, SkwHttpProvider, HttpProvider, RequestMetadata, AuthorizedServiceCaller, DataUnit, DataUnitStorage, Record, SavedRecord, DataType, UnitMetadata, FieldDescriptor, UserInterface, DependencyType, ChildDescriptor, ChildLink, DataUnitAction, Action, Change, Sort, Filter, ChangeOperation, DUActionInterceptor, ApplicationContext, WaitingChange, PageRequest, QuickFilter, ReadyUtil, ObjectUtils, WarningException, WaitingChangeException, ErrorException, ErrorTracking, ExecutionContext, PaginationInfo, SortingProvider, SortMode, LoadDataRequest, LoadDataResponse, SelectionInfo, SelectionMode, ElementIDUtils, IElementIDInfo, UserAgentUtils, JSUtils, VersionUtils };
+import { OnboardingUtils } from "./utils/OnboardingUtils.js";
+export { StringUtils, MaskFormatter, NumberUtils, FloatingManager, DateUtils, ArrayUtils, TimeFormatter, SkwHttpProvider, HttpProvider, RequestMetadata, AuthorizedServiceCaller, DataUnit, DataUnitStorage, Record, SavedRecord, DataType, UnitMetadata, FieldDescriptor, UserInterface, DependencyType, ChildDescriptor, ChildLink, DataUnitAction, Action, Change, Sort, Filter, ChangeOperation, DUActionInterceptor, ApplicationContext, WaitingChange, PageRequest, QuickFilter, ReadyUtil, ObjectUtils, WarningException, WaitingChangeException, ErrorException, ErrorTracking, ExecutionContext, PaginationInfo, SortingProvider, SortMode, LoadDataRequest, LoadDataResponse, SelectionInfo, SelectionMode, ElementIDUtils, IElementIDInfo, UserAgentUtils, JSUtils, VersionUtils, OnboardingUtils };

package/dist/index.js

@@ -25,6 +25,7 @@ import { UserAgentUtils } from "./utils/UserAgentUtils/index.js";
 import { JSUtils } from "./utils/JSUtils.js";
 import { DataUnitStorage } from "./dataunit/DataUnitStorage.js";
 import VersionUtils from './utils/VersionUtils.js';
+import { OnboardingUtils } from "./utils/OnboardingUtils.js";
 /*Classes públicas no pacote*/
-export { StringUtils, MaskFormatter, NumberUtils, FloatingManager, DateUtils, ArrayUtils, TimeFormatter, SkwHttpProvider, HttpProvider, RequestMetadata, AuthorizedServiceCaller, DataUnit, DataUnitStorage, DataType, UserInterface, DependencyType, DataUnitAction, Action, Change, ChangeOperation, ApplicationContext, ReadyUtil, ObjectUtils, WarningException, WaitingChangeException, ErrorException, ErrorTracking, SortMode, SelectionInfo, SelectionMode, ElementIDUtils, UserAgentUtils, JSUtils, VersionUtils };
+export { StringUtils, MaskFormatter, NumberUtils, FloatingManager, DateUtils, ArrayUtils, TimeFormatter, SkwHttpProvider, HttpProvider, RequestMetadata, AuthorizedServiceCaller, DataUnit, DataUnitStorage, DataType, UserInterface, DependencyType, DataUnitAction, Action, Change, ChangeOperation, ApplicationContext, ReadyUtil, ObjectUtils, WarningException, WaitingChangeException, ErrorException, ErrorTracking, SortMode, SelectionInfo, SelectionMode, ElementIDUtils, UserAgentUtils, JSUtils, VersionUtils, OnboardingUtils };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,eAAe,MAAM,yBAAyB,CAAC;AACtD,OAAO,SAAS,MAAM,sBAAsB,CAAC;AAC7C,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAC5E,OAAO,QAAQ,EAAE,EAAsB,MAAM,EAAE,eAAe,EAAgE,aAAa,EAAE,aAAa,EAAC,MAAM,wBAAwB,CAAC;AAC1L,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAiC,aAAa,EAAQ,QAAQ,EAA2B,cAAc,EAA8B,MAAM,qCAAqC,CAAC;AACxL,OAAO,EAAE,cAAc,EAAE,MAAM,EAAoB,MAAM,2CAA2C,CAAC;AACrG,OAAO,kBAAkB,MAAM,+BAA+B,CAAC;AAC/D,OAAO,SAAS,MAAM,sBAAsB,CAAC;AAC7C,OAAO,WAAW,MAAM,wBAAwB,CAAC;AACjD,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAChE,OAAO,sBAAsB,MAAM,wCAAwC,CAAC;AAC5E,OAAO,cAAc,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAI1D,OAAO,EAAE,cAAc,EAAkB,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,YAAY,MAAM,yBAAyB,CAAA;AAGlD,8BAA8B;AAC9B,OAAO,EACH,WAAW,EACX,aAAa,EACb,WAAW,EACX,eAAe,EACf,SAAS,EACT,UAAU,EACV,aAAa,EACb,eAAe,EACf,YAAY,EACZ,eAAe,EACf,uBAAuB,EACvB,QAAQ,EACR,eAAe,EAGf,QAAQ,EAGR,aAAa,EACb,cAAc,EAGd,cAAc,EACd,MAAM,EACN,MAAM,EAGN,eAAe,EAEf,kBAAkB,EAIlB,SAAS,EACT,WAAW,EACX,gBAAgB,EAChB,sBAAsB,EACtB,cAAc,EACd,aAAa,EAIb,QAAQ,EAGR,aAAa,EACb,aAAa,EACb,cAAc,EAEd,cAAc,EACd,OAAO,EACP,YAAY,EACf,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,eAAe,MAAM,yBAAyB,CAAC;AACtD,OAAO,SAAS,MAAM,sBAAsB,CAAC;AAC7C,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AAC5E,OAAO,QAAQ,EAAE,EAAsB,MAAM,EAAE,eAAe,EAAgE,aAAa,EAAE,aAAa,EAAC,MAAM,wBAAwB,CAAC;AAC1L,OAAO,EAAE,QAAQ,EAAE,MAAM,iCAAiC,CAAC;AAC3D,OAAO,EAAiC,aAAa,EAAQ,QAAQ,EAA2B,cAAc,EAA8B,MAAM,qCAAqC,CAAC;AACxL,OAAO,EAAE,cAAc,EAAE,MAAM,EAAoB,MAAM,2CAA2C,CAAC;AACrG,OAAO,kBAAkB,MAAM,+BAA+B,CAAC;AAC/D,OAAO,SAAS,MAAM,sBAAsB,CAAC;AAC7C,OAAO,WAAW,MAAM,wBAAwB,CAAC;AACjD,OAAO,gBAAgB,MAAM,kCAAkC,CAAC;AAChE,OAAO,sBAAsB,MAAM,wCAAwC,CAAC;AAC5E,OAAO,cAAc,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAI1D,OAAO,EAAE,cAAc,EAAkB,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,YAAY,MAAM,yBAAyB,CAAA;AAClD,OAAO,EAAE,eAAe,EAAC,MAAM,4BAA4B,CAAC;AAE5D,8BAA8B;AAC9B,OAAO,EACH,WAAW,EACX,aAAa,EACb,WAAW,EACX,eAAe,EACf,SAAS,EACT,UAAU,EACV,aAAa,EACb,eAAe,EACf,YAAY,EACZ,eAAe,EACf,uBAAuB,EACvB,QAAQ,EACR,eAAe,EAGf,QAAQ,EAGR,aAAa,EACb,cAAc,EAGd,cAAc,EACd,MAAM,EACN,MAAM,EAGN,eAAe,EAEf,kBAAkB,EAIlB,SAAS,EACT,WAAW,EACX,gBAAgB,EAChB,sBAAsB,EACtB,cAAc,EACd,aAAa,EAIb,QAAQ,EAGR,aAAa,EACb,aAAa,EACb,cAAc,EAEd,cAAc,EACd,OAAO,EACP,YAAY,EACZ,eAAe,EAClB,CAAC"}

package/dist/utils/OnboardingUtils.d.ts

@@ -0,0 +1,17 @@
+export declare class OnboardingUtils {
+    private static readonly USER_GUIDE_TAG_ID;
+    private static instance;
+    private constructor();
+    static getInstance(): OnboardingUtils;
+    init(apiKey: string, ctx: EnvironmentContext): Promise<void>;
+    private injectScript;
+    private register;
+}
+export declare class EnvironmentContext {
+    userID: string;
+    userName: string;
+    partnerName: string;
+    sysVersion: string;
+    environment: string;
+    clientGaId: string;
+}

package/dist/utils/OnboardingUtils.js

@@ -0,0 +1,41 @@
+export class OnboardingUtils {
+    constructor() { }
+    static getInstance() {
+        if (this.instance == null) {
+            this.instance = new OnboardingUtils();
+        }
+        return this.instance;
+    }
+    init(apiKey, ctx) {
+        if (!apiKey) {
+            return Promise.resolve();
+        }
+        this.injectScript(apiKey);
+        this.register(ctx);
+        return Promise.resolve();
+    }
+    injectScript(apiKey) {
+        if (window.document.head.querySelector(`script#${OnboardingUtils.USER_GUIDE_TAG_ID}`)) {
+            return;
+        }
+        const scriptEl = document.createElement('script');
+        scriptEl.setAttribute("id", OnboardingUtils.USER_GUIDE_TAG_ID);
+        scriptEl.innerText = `(function(g,u,i,d,e,s){g[e]=g[e]||[];var f=u.getElementsByTagName(i)[0];var k=u.createElement(i);k.async=true;k.src='https://static.userguiding.com/media/user-guiding-'+s+'-embedded.js';f.parentNode.insertBefore(k,f);if(g[d])return;var ug=g[d]={q:[]};ug.c=function(n){return function(){ug.q.push([n,arguments])};};var m=['previewGuide','finishPreview','track','identify','hideChecklist','launchChecklist'];for(var j=0;j<m.length;j+=1){ug[m[j]]=ug.c(m[j]);}})(window,document,'script','userGuiding','userGuidingLayer','${apiKey}');`;
+        window.document.head.appendChild(scriptEl);
+    }
+    register(ctx) {
+        window.userGuiding.identify(`${ctx.userID}-${ctx.userName}-${ctx.clientGaId}`, ctx);
+    }
+}
+OnboardingUtils.USER_GUIDE_TAG_ID = "userGuideSnippet";
+export class EnvironmentContext {
+    constructor() {
+        this.userID = "";
+        this.userName = "";
+        this.partnerName = "";
+        this.sysVersion = "";
+        this.environment = "";
+        this.clientGaId = "";
+    }
+}
+//# sourceMappingURL=OnboardingUtils.js.map

package/dist/utils/OnboardingUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OnboardingUtils.js","sourceRoot":"","sources":["../../src/utils/OnboardingUtils.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,eAAe;IAIxB,gBAAsB,CAAC;IAEhB,MAAM,CAAC,WAAW;QACrB,IAAG,IAAI,CAAC,QAAQ,IAAI,IAAI,EAAC;YACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;SACzC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAEM,IAAI,CAAC,MAAc,EAAE,GAAuB;QAC/C,IAAG,CAAC,MAAM,EAAC;YACP,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;SAC5B;QACD,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;QAC1B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QACnB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC7B,CAAC;IAEO,YAAY,CAAC,MAAc;QAC/B,IAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,eAAe,CAAC,iBAAiB,EAAE,CAAC,EAAC;YACjF,OAAO;SACV;QAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;QAClD,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,eAAe,CAAC,iBAAiB,CAAC,CAAC;QAC/D,QAAQ,CAAC,SAAS,GAAG,ygBAAygB,MAAM,KAAK,CAAC;QAC1iB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAEO,QAAQ,CAAC,GAAuB;QACnC,MAAc,CAAC,WAAW,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,UAAU,EAAE,EAAE,GAAG,CAAC,CAAC;IACjG,CAAC;;AAlCuB,iCAAiB,GAAG,kBAAkB,CAAC;AAqCnE,MAAM,OAAO,kBAAkB;IAA/B;QACK,WAAM,GAAW,EAAE,CAAC;QACpB,aAAQ,GAAW,EAAE,CAAC;QACtB,gBAAW,GAAW,EAAE,CAAC;QACzB,eAAU,GAAW,EAAE,CAAC;QACxB,gBAAW,GAAW,EAAE,CAAC;QACzB,eAAU,GAAW,EAAE,CAAC;IAC7B,CAAC;CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sankhyalabs/core",
-  "version": "4.9.1",
+  "version": "4.10.0",
   "description": "Modulo core JavaScript da Sankhya.",
   "main": "dist/index.js",
   "module": "dist/index.js",

package/src/index.ts

@@ -28,7 +28,7 @@ import { UserAgentUtils } from "./utils/UserAgentUtils/index.js";
 import { JSUtils } from "./utils/JSUtils.js";
 import { DataUnitStorage } from "./dataunit/DataUnitStorage.js";
 import VersionUtils from './utils/VersionUtils.js'
-
+import { OnboardingUtils} from "./utils/OnboardingUtils.js";
 
 /*Classes públicas no pacote*/
 export {
@@ -83,5 +83,6 @@ export {
     IElementIDInfo,
     UserAgentUtils,
     JSUtils,
-    VersionUtils
+    VersionUtils,
+    OnboardingUtils
 };

package/src/utils/OnboardingUtils.ts

@@ -0,0 +1,46 @@
+export class OnboardingUtils {
+    private static readonly USER_GUIDE_TAG_ID = "userGuideSnippet";
+    private static instance: OnboardingUtils;
+
+    private constructor(){}
+
+    public static getInstance(): OnboardingUtils {
+        if(this.instance == null){
+            this.instance = new OnboardingUtils();
+        }
+        return this.instance;
+    }
+
+    public init(apiKey: string, ctx: EnvironmentContext): Promise<void> {
+        if(!apiKey){
+            return Promise.resolve();
+        }
+        this.injectScript(apiKey);
+        this.register(ctx);
+        return Promise.resolve();
+    }
+
+    private injectScript(apiKey: string){
+        if(window.document.head.querySelector(`script#${OnboardingUtils.USER_GUIDE_TAG_ID}`)){
+            return;
+        }
+
+        const scriptEl = document.createElement('script');
+        scriptEl.setAttribute("id", OnboardingUtils.USER_GUIDE_TAG_ID);
+        scriptEl.innerText = `(function(g,u,i,d,e,s){g[e]=g[e]||[];var f=u.getElementsByTagName(i)[0];var k=u.createElement(i);k.async=true;k.src='https://static.userguiding.com/media/user-guiding-'+s+'-embedded.js';f.parentNode.insertBefore(k,f);if(g[d])return;var ug=g[d]={q:[]};ug.c=function(n){return function(){ug.q.push([n,arguments])};};var m=['previewGuide','finishPreview','track','identify','hideChecklist','launchChecklist'];for(var j=0;j<m.length;j+=1){ug[m[j]]=ug.c(m[j]);}})(window,document,'script','userGuiding','userGuidingLayer','${apiKey}');`;
+        window.document.head.appendChild(scriptEl);
+    }
+
+    private register(ctx: EnvironmentContext){
+        (window as any).userGuiding.identify(`${ctx.userID}-${ctx.userName}-${ctx.clientGaId}`, ctx);
+    }
+}
+
+export class EnvironmentContext {
+     userID: string = "";
+     userName: string = "";
+     partnerName: string = "";
+     sysVersion: string = "";
+     environment: string = "";
+     clientGaId: string = "";
+}