@openpass/openpass-js-sdk - npm Package Compare versions

Comparing version 2.1.6 to 2.1.7

dist/cjs/package.json

@@ -6,3 +6,3 @@ {
     "license": "MIT",
-    "version": "2.1.5",
+    "version": "2.1.6",
     "repository": {
@@ -9,0 +9,0 @@ "type": "git",

dist/cjs/src/auth/constants.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.POPUP_MESSAGE_SOURCE = exports.PARAM_CODE_RESPONSE_MODE_MESSAGE = exports.PARAM_CODE_RESPONSE_MODE = exports.PARAM_ERROR_URI = exports.PARAM_ERROR_DESCRIPTION = exports.PARAM_ERROR = exports.PARAM_GRANT_TYPE_VALUE = exports.PARAM_CODE = exports.PARAM_SCOPE_VALUE = exports.PARAM_SCOPE = exports.PARAM_RESPONSE_TYPE_VALUE = exports.PARAM_CODE_CHALLENGE_METHOD_VALUE = exports.PARAM_CODE_CHALLENGE_METHOD = exports.PARAM_CODE_CHALLENGE = exports.PARAM_CLIENT_ID = exports.PARAM_RESPONSE_TYPE = exports.PARAM_REDIRECT_URI = exports.PARAM_STATE = void 0;
+exports.POPUP_MESSAGE_SOURCE = exports.PARAM_CODE_RESPONSE_MODE_MESSAGE = exports.PARAM_CODE_RESPONSE_MODE = exports.PARAM_ERROR_URI = exports.PARAM_ERROR_DESCRIPTION = exports.PARAM_ERROR = exports.PARAM_GRANT_TYPE_VALUE = exports.PARAM_CODE = exports.PARAM_SCOPE_VALUE = exports.PARAM_SCOPE = exports.PARAM_RESPONSE_TYPE_VALUE = exports.PARAM_CODE_CHALLENGE_METHOD_VALUE = exports.PARAM_CODE_CHALLENGE_METHOD = exports.PARAM_CODE_CHALLENGE = exports.PARAM_CLIENT_ID = exports.PARAM_RESPONSE_TYPE = exports.PARAM_REDIRECT_URI = exports.PARAM_STATE = exports.PARAM_SDK_VERSION = exports.PARAM_SDK_NAME = exports.HEADER_SDK_VERSION = exports.HEADER_SDK_NAME = exports.SDK_NAME = void 0;
+exports.SDK_NAME = "openpass-js-sdk";
+exports.HEADER_SDK_NAME = "OpenPass-SDK-Name";
+exports.HEADER_SDK_VERSION = "OpenPass-SDK-Version";
+exports.PARAM_SDK_NAME = "sdk_name";
+exports.PARAM_SDK_VERSION = "sdk_version";
 exports.PARAM_STATE = "state";
@@ -5,0 +10,0 @@ exports.PARAM_REDIRECT_URI = "redirect_uri";

dist/cjs/src/auth/openPassClient.js

@@ -15,3 +15,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const openPassApiClient_1 = require("./apiClient/openPassApiClient");
+const openPassApiClient_1 = require("./api/openPassApiClient");
 const redirect_1 = __importDefault(require("./redirect"));
@@ -18,0 +18,0 @@ const popup_1 = __importDefault(require("./popup"));

dist/cjs/src/auth/url.js

@@ -6,2 +6,3 @@ "use strict";
 const path_1 = require("./utils/path");
+const package_json_1 = require("../../package.json");
 const parseAuthRedirectUrlParams = (queryString) => {
@@ -37,9 +38,11 @@ const params = new URLSearchParams(queryString);
     const challengeCodeParam = `${constants_1.PARAM_CODE_CHALLENGE}=${session.codeChallenge}`;
-    const responseMode = session.responseMode ? `${constants_1.PARAM_CODE_RESPONSE_MODE}=${session.responseMode}` : "";
+    const responseModeParam = session.responseMode ? `${constants_1.PARAM_CODE_RESPONSE_MODE}=${session.responseMode}` : "";
+    const sdkNameParam = `${constants_1.PARAM_SDK_NAME}=${constants_1.SDK_NAME}`;
+    const sdkVersionParam = `${constants_1.PARAM_SDK_VERSION}=${package_json_1.version}`;
     let loginUri = `${(0, path_1.joinPaths)([
         baseUrl,
         authorizeEndpoint,
-    ])}?${responseTypeParam}&${clientIdParam}&${scopeParam}&${stateParam}&${challengeMethodParam}&${challengeCodeParam}`;
+    ])}?${responseTypeParam}&${clientIdParam}&${scopeParam}&${stateParam}&${challengeMethodParam}&${challengeCodeParam}&${sdkNameParam}&${sdkVersionParam}`;
     loginUri = redirectParam ? `${loginUri}&${redirectParam}` : loginUri;
-    loginUri = responseMode ? `${loginUri}&${responseMode}` : loginUri;
+    loginUri = responseModeParam ? `${loginUri}&${responseModeParam}` : loginUri;
     return loginUri;
@@ -46,0 +49,0 @@ };

dist/cjs/src/buttons/signInButton.js

@@ -26,2 +26,4 @@ "use strict";
 const functions_1 = require("./utils/functions");
+const openPassTelemetryApiClient_1 = require("./telemetry/openPassTelemetryApiClient");
+const config_1 = require("../config");
 const openPassClient_1 = __importDefault(require("../auth/openPassClient"));
@@ -127,2 +129,6 @@ const renderSignInButton = () => {
     }));
+    // Send telemetry event
+    const telemetryClient = new openPassTelemetryApiClient_1.OpenPassTelemetryApiClient((0, config_1.getOpenPassApiBaseUrl)(ssoBaseUri));
+    // Do not await the result, this is a fire and forget operation
+    telemetryClient.sendTelemetryEvent(clientId, "SignInButtonShown");
 };
@@ -129,0 +135,0 @@ exports.renderSignInButton = renderSignInButton;

dist/esm/package.json

@@ -6,3 +6,3 @@ {
     "license": "MIT",
-    "version": "2.1.5",
+    "version": "2.1.6",
     "repository": {
@@ -9,0 +9,0 @@ "type": "git",

dist/esm/src/auth/constants.js

@@ -0,1 +1,6 @@
+export const SDK_NAME = "openpass-js-sdk";
+export const HEADER_SDK_NAME = "OpenPass-SDK-Name";
+export const HEADER_SDK_VERSION = "OpenPass-SDK-Version";
+export const PARAM_SDK_NAME = "sdk_name";
+export const PARAM_SDK_VERSION = "sdk_version";
 export const PARAM_STATE = "state";
@@ -2,0 +7,0 @@ export const PARAM_REDIRECT_URI = "redirect_uri";

dist/esm/src/auth/openPassClient.js

@@ -10,3 +10,3 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
 };
-import { OpenPassApiClient } from "./apiClient/openPassApiClient";
+import { OpenPassApiClient } from "./api/openPassApiClient";
 import RedirectAuth from "./redirect";
@@ -13,0 +13,0 @@ import PopupAuth from "./popup";

dist/esm/src/auth/url.js

@@ -1,3 +0,4 @@
-import { PARAM_CLIENT_ID, PARAM_CODE, PARAM_CODE_CHALLENGE, PARAM_CODE_CHALLENGE_METHOD, PARAM_CODE_RESPONSE_MODE, PARAM_ERROR, PARAM_ERROR_DESCRIPTION, PARAM_ERROR_URI, PARAM_REDIRECT_URI, PARAM_RESPONSE_TYPE, PARAM_RESPONSE_TYPE_VALUE, PARAM_SCOPE, PARAM_SCOPE_VALUE, PARAM_STATE, } from "./constants";
+import { PARAM_CLIENT_ID, PARAM_CODE, PARAM_CODE_CHALLENGE, PARAM_CODE_CHALLENGE_METHOD, PARAM_CODE_RESPONSE_MODE, PARAM_ERROR, PARAM_ERROR_DESCRIPTION, PARAM_ERROR_URI, PARAM_REDIRECT_URI, PARAM_RESPONSE_TYPE, PARAM_RESPONSE_TYPE_VALUE, PARAM_SCOPE, PARAM_SCOPE_VALUE, PARAM_SDK_NAME, PARAM_SDK_VERSION, PARAM_STATE, SDK_NAME, } from "./constants";
 import { joinPaths } from "./utils/path";
+import { version as sdkVersion } from "../../package.json";
 export const parseAuthRedirectUrlParams = (queryString) => {
@@ -31,9 +32,11 @@ const params = new URLSearchParams(queryString);
     const challengeCodeParam = `${PARAM_CODE_CHALLENGE}=${session.codeChallenge}`;
-    const responseMode = session.responseMode ? `${PARAM_CODE_RESPONSE_MODE}=${session.responseMode}` : "";
+    const responseModeParam = session.responseMode ? `${PARAM_CODE_RESPONSE_MODE}=${session.responseMode}` : "";
+    const sdkNameParam = `${PARAM_SDK_NAME}=${SDK_NAME}`;
+    const sdkVersionParam = `${PARAM_SDK_VERSION}=${sdkVersion}`;
     let loginUri = `${joinPaths([
         baseUrl,
         authorizeEndpoint,
-    ])}?${responseTypeParam}&${clientIdParam}&${scopeParam}&${stateParam}&${challengeMethodParam}&${challengeCodeParam}`;
+    ])}?${responseTypeParam}&${clientIdParam}&${scopeParam}&${stateParam}&${challengeMethodParam}&${challengeCodeParam}&${sdkNameParam}&${sdkVersionParam}`;
     loginUri = redirectParam ? `${loginUri}&${redirectParam}` : loginUri;
-    loginUri = responseMode ? `${loginUri}&${responseMode}` : loginUri;
+    loginUri = responseModeParam ? `${loginUri}&${responseModeParam}` : loginUri;
     return loginUri;
@@ -40,0 +43,0 @@ };

dist/esm/src/buttons/signInButton.js

@@ -20,2 +20,4 @@ // TODO: Additional settings, like Google do: https://developers.google.com/identity/gsi/web/tools/configurator
 import { executeFunctionByName } from "./utils/functions";
+import { OpenPassTelemetryApiClient } from "./telemetry/openPassTelemetryApiClient";
+import { getOpenPassApiBaseUrl } from "../config";
 import OpenPassClient from "../auth/openPassClient";
@@ -121,2 +123,6 @@ export const renderSignInButton = () => {
     }));
+    // Send telemetry event
+    const telemetryClient = new OpenPassTelemetryApiClient(getOpenPassApiBaseUrl(ssoBaseUri));
+    // Do not await the result, this is a fire and forget operation
+    telemetryClient.sendTelemetryEvent(clientId, "SignInButtonShown");
 };
@@ -123,0 +129,0 @@ const emptyStringAsUndefined = (string) => {

dist/types/src/auth/constants.d.ts

@@ -0,1 +1,6 @@
+export declare const SDK_NAME = "openpass-js-sdk";
+export declare const HEADER_SDK_NAME = "OpenPass-SDK-Name";
+export declare const HEADER_SDK_VERSION = "OpenPass-SDK-Version";
+export declare const PARAM_SDK_NAME = "sdk_name";
+export declare const PARAM_SDK_VERSION = "sdk_version";
 export declare const PARAM_STATE = "state";
@@ -2,0 +7,0 @@ export declare const PARAM_REDIRECT_URI = "redirect_uri";

dist/types/src/auth/popup.d.ts

@@ -1,2 +0,2 @@
-import { OpenPassApiClient } from "./apiClient/openPassApiClient";
+import { OpenPassApiClient } from "./api/openPassApiClient";
 import RedirectAuth from "./redirect";
@@ -3,0 +3,0 @@ import { AuthSession, OpenPassOptions, OpenPassTokens, SignInOptions, SignInResponse } from "./types";

dist/types/src/auth/redirect.d.ts

@@ -1,2 +0,2 @@
-import { OpenPassApiClient } from "./apiClient/openPassApiClient";
+import { OpenPassApiClient } from "./api/openPassApiClient";
 import { SignInStateRepository } from "./signInState";
@@ -3,0 +3,0 @@ import { OpenPassOptions, SignInOptions, SignInResponse } from "./types";

package.json

@@ -6,3 +6,3 @@ {
   "license": "MIT",
-  "version": "2.1.6",
+  "version": "2.1.7",
   "repository": {
@@ -9,0 +9,0 @@ "type": "git",

No alert changes

Improved metrics

Total package byte prevSize

646491

increased by2.2%

Number of package files

172

increased by2.99%

Lines of code

3585

increased by3.7%

No dependency changes