Skip to content

Deprecate hasIdentity and replace with isIdentityAvailable #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ashleysmithTTD merged 5 commits into from
Dec 12, 2024
Merged

Deprecate hasIdentity and replace with isIdentityAvailable #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6bc7d44
replace isloginrequired with no identity available function
ashleysmithTTD Dec 6, 2024
41209bf
fixed changes
ashleysmithTTD Dec 6, 2024
c86dfb9
to no identity available
ashleysmithTTD Dec 6, 2024
4869277
created new is identity available function
ashleysmithTTD Dec 12, 2024
5c7e420
fix readme link
ashleysmithTTD Dec 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions examples/cstg/html/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@
$('#login_required').text(
sdk.isLoginRequired() || sdk.isLoginRequired() === undefined ? 'yes' : 'no'
);
$(`#has_opted_out`).text(
sdk.hasOptedOut() ? 'yes' : 'no'
);
$(`#has_opted_out`).text(sdk.hasOptedOut() ? 'yes' : 'no');
$('#update_counter').text(callbackCounter);
$('#identity_state').text(String(JSON.stringify(state, null, 2)));

Expand Down
2 changes: 1 addition & 1 deletion examples/google-secure-signals-integration/with_sdk_v3/views/login.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!doctype html>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
Expand Down
19 changes: 12 additions & 7 deletions src/sdkBase.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,16 +181,20 @@ export abstract class SdkBase {
return this._initComplete;
}

/**
* Deprecated
*/
public isLoginRequired() {
return this.hasIdentity();
return !this.isIdentityAvailable();
}

/**
* @deprecated in version 3.10.0. Will remove in June 2025. Use isIdentityAvailable() instead.
**/
public hasIdentity() {
if (!this._initComplete) return undefined;
return !(this.isLoggedIn() || this._apiClient?.hasActiveRequests());
return !(this.isIdentityValid() || this._apiClient?.hasActiveRequests());
}

public isIdentityAvailable() {
return this.isIdentityValid() || this._apiClient?.hasActiveRequests();
}

public hasOptedOut() {
Expand Down Expand Up @@ -295,8 +299,9 @@ export abstract class SdkBase {
if (this.hasOptedOut()) this._callbackManager.runCallbacks(EventType.OptoutReceived, {});
}

private isLoggedIn() {
return this._identity && !hasExpired(this._identity.refresh_expires);
private isIdentityValid() {
const identity = this._identity ?? this.getIdentityNoInit();
return identity && !hasExpired(identity.refresh_expires);
Copy link
Contributor Author

@ashleysmithTTD ashleysmithTTD Dec 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Renamed function since its private and this makes more sense. Also added the getIdentityNoInit because we can have an identity without initComplete from the recent SDK changes

}

private temporarilyUnavailable(identity: Identity | OptoutIdentity | null | undefined) {
Expand Down
Loading