Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@parameter1/base-cms-marko-web-identity-x
Advanced tools
Readme
Include @parameter1/base-cms-marko-web-identity-x
as a project/website dependency.
Include IdentityX tenant configuration within your site
// your-site/config/identity-x.js
const IdentityX = require('@parameter1/base-cms-marko-web-identity-x/config');
const config = new IdentityX({
appId: '<MY-APPLICATION-ID>',
});
module.exports = config;
// your-site/server/routes/identity-x.js
const IdentityX = require('@parameter1/base-cms-marko-web-identity-x');
const config = require('../../config/identity-x');
const authenticate = require('../templates/user/authenticate');
const login = require('../templates/user/login');
const logout = require('../templates/user/logout');
const register = require('../templates/user/register');
const profile = require('../templates/user/profile');
module.exports = (app) => {
IdentityX(app, config);
app.get(config.getEndpointFor('authenticate'), (req, res) => {
res.marko(authenticate);
});
app.get(config.getEndpointFor('login'), (req, res) => {
res.marko(login);
});
app.get(config.getEndpointFor('logout'), (req, res) => {
res.marko(logout);
});
app.get(config.getEndpointFor('register'), (req, res) => {
res.marko(register);
});
app.get(config.getEndpointFor('profile'), (req, res) => {
res.marko(profile);
});
};
// your-site/server/routes/index.js
const IdentityX = require('./identity-x');
module.exports = (app) => {
IdentityX(app);
// ...
};
login
, logout
, authenticate
, register
and profile
templates. These templates must include the relevant <marko-web-identity-x-form-...>
component.<marko-web-default-page-layout>
<@page>
<marko-web-identity-x-form-authenticate />
</@page>
</marko-web-default-page-layout>
// your-site/browser/index.js
import IdentityX from '@parameter1/base-cms-marko-web-identity-x/browser';
IdentityX(Browser);
// ...
export default Browser;
Include the <marko-web-identity-x-form-authenticate>
component in the template where users land after authenticating (/user/authenticate).
Include the <marko-web-identity-x-form-login>
component to display the login form.
Include the <marko-web-identity-x-form-register>
component to display the register form.
Include the <marko-web-identity-x-form-logout>
component to display the logout form.
Include the <marko-web-identity-x-form-profile>
component to display the user profile form.
Include the <marko-web-identity-x-context>
component where you'd like access to IdentityX context.
<!-- your-site/server/templates/some-page.marko -->
<marko-web-identity-x-context|{ user, hasUser }|>
<if(hasUser)>
<h1>Hello ${user.givenName}!</h1>
</if>
</marko-web-identity-x-context>
Include the <marko-web-identity-x-access>
component where you'd like to ensure access levels are met:
<!-- your-site/server/templates/content/index.marko -->
$ const { isRequired, accessLevels } = getAsObject(content, 'userRegistration');
<marko-web-identity-x-access|context|
enabled=isRequired
required-access-level-ids=accessLevels
>
$ const {
canAccess,
isLoggedIn,
requiresAccessLevel,
hasRequiredAccessLevel,
messages,
} = context;
<if(!canAccess)>
<if(isLoggedIn && !hasRequiredAccessLevel)>
$!{messages.loggedInNoAccess}
</if>
<else-if(!isLoggedIn && requiresAccessLevel)>
$!{messages.loggedOutNoAccess}
</else-if>
<else-if(!isLoggedIn)>
<h5>You must be logged-in to access this content.</h5>
<cms-browser-component name="IdentitySignInForm" />
</else-if>
</if>
<else>
<p>This is secret content only some can see!</p>
</else>
</marko-web-identity-x-access>
You can change the default IdentityX Vue components by passing them to the component loader in your site's browser config:
import IdentityX from '@parameter1/base-cms-marko-web-identity-x/browser';
+ import MyLoginComponent from './my-login-component.vue';
-IdentityX(Browser);
+IdentityX(Browser, {
+ CustomLoginComponent: MyLoginComponent,
+});
This package emits the following events via the EventBus/global Vue root. Each payload will be an
object and will include a label
field tied to the eventLabel
prop of the emitting component.
Each payload may include additional data, as relevant.
All components support passing an object of additionalEventData
, which when present will append
data both to the submission (for backend hook handling) and to the emitted event payload.
Event name | Event payload | Details |
---|---|---|
identity-x-login-link-sent | { label, ...additionalEventData } | Fires when a user submits their email to start the login handshake. |
identity-x-authenticated | { label, ...additionalEventData, mustReVerifyProfile, isProfileComplete, requiresCustomFieldAnswers } | Fires when a user has completed the login handshake and is now fully authenticated. |
identity-x-logout | { label, ...additionalEventData } | Fires when a user has logged out successfully. |
identity-x-profile-updated | { label, ...additionalEventData } | Fires when a user has submitted an update to their profile/fields. |
identity-x-comment-post-submitted | { label, ...additionalEventData } | Fires when a user posts a comment to a comment stream |
identity-x-comment-report-submitted | { label, ...additionalEventData, id } | Fires when a user reports a comment on a comment stream |
identity-x-comment-stream-login-link-sent | { label, ...additionalEventData } | Fires when a user starts login from a comment stream |
Each component will emit an event when the component is displayed.
Event name | Event payload | Details |
---|---|---|
identity-x-authenticate-displayed | { label, ...additionalEventData } | |
identity-x-login-displayed | { label, ...additionalEventData } | |
identity-x-logout-displayed | { label, ...additionalEventData } | |
identity-x-profile-displayed | { label, ...additionalEventData } | |
identity-x-comment-stream-displayed | { label, ...additionalEventData } | |
identity-x-comment-stream-loaded | { label, ...additionalEventData } | |
identity-x-comment-stream-loaded-more | { label, ...additionalEventData } |
Each component will emit an event when an error is encountered and include the error message as the
message
attribute of the emitted payload.
Event name | Event payload |
---|---|
identity-x-authenticate-errored | { label, message: '...', ...additionalEventData } |
identity-x-login-errored | { label, message: '...', ...additionalEventData } |
identity-x-logout-errored | { label, message: '...', ...additionalEventData } |
identity-x-profile-errored | { label, message: '...', ...additionalEventData } |
identity-x-comment-post-errored | { label, message: '...', ...additionalEventData } |
identity-x-comment-report-errored | { label, message: '...', ...additionalEventData } |
identity-x-comment-stream-errored | { label, message: '...', ...additionalEventData } |
FAQs
Marko Wrapper for IdentityX
The npm package @parameter1/base-cms-marko-web-identity-x receives a total of 978 weekly downloads. As such, @parameter1/base-cms-marko-web-identity-x popularity was classified as not popular.
We found that @parameter1/base-cms-marko-web-identity-x demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.