https://github.com/brikcss/ds-webalias
Turns any site into a replicated site using the DirectScale, Inc. webalias API.
https://github.com/brikcss/ds-webalias
Last synced: 2 months ago
JSON representation
Turns any site into a replicated site using the DirectScale, Inc. webalias API.
- Host: GitHub
- URL: https://github.com/brikcss/ds-webalias
- Owner: brikcss
- License: mit
- Created: 2019-04-10T21:09:31.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2019-06-12T19:50:55.000Z (about 6 years ago)
- Last Synced: 2025-04-02T09:02:12.769Z (3 months ago)
- Language: JavaScript
- Size: 438 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# DirectScale WebAlias Replication Plugin
## About
\[ IMPORTANT \]: Brikcss follows semantic versioning. Since this package is currently at major version zero, "anything may change at any time", and it "should not be considered stable".
This webalias module connects with the DirectScale, Inc. webalias API to help turn any website into a replicated solution. The plugin can either check the URL to auto-detect the webalias and client/company, or they can be manually configured.
This solution is built on [Brikcss Element](https://github.com/brikcss/element), a native Web Components library.
## Contributing
We ❤️❤️❤️ contributions of any kind, whether it's bug reports, questions or feature requests, pull requests, and especially spreading some love about this project to your friends and co-workers!
**[Read our contributing guidelines](./CONTRIBUTING.md) and get involved to support this project.**
## Browser Support\*
| Chrome | Firefox | Safari | Edge | IE |
| ------ | ------- | ------ | ---- | ------ |
| ✓ | ✓ | ✓ | ✓ | 11\*\* |
\*_With the [proper polyfills](#getting-started)._
\*\*_IE11 can be supported with a transpiled build for legacy browsers._
## Install
**From NPM:**
```bash
npm install -D @brikcss/ds-webalias
```
**From GitHub:**
Download the [latest release](https://github.com/brikcss/ds-webalias/releases/latest).
_Note: File paths are written for NPM installs. If you use the GitHub release, make sure to remove `node_modules/@brikcss/ds-webalias` from any file paths._
## Quick Start
Build your component in less than 5 minutes:
1. [Include Web Components polyfills](https://github.com/brikcss/element/blob/master/docs/web-components-polyfills.md).
2. Include the ESM Browser bundle and define your element:
```js
// app.js
import { WebAlias } from 'node_modules/@brikcss/ds-webalias/dist/esm/webalias.browser.js';
WebAlias.define('my-element');
// or window.customElements.define('my-element', WebAlias)
```
3. Use your element:
_in HTML:_
```html
```
If the webalias user's name is "John Doe", the UI will display _"Hello, John Doe!"_.
_in JS:_
```js
console.log(WebAlias.user.name); // John Doe
```
4. Tada! Check out [the examples](./examples) if you run into issues.
_Important: While the Browser ESM bundle works great for rapid development and prototyping, or if you only need to support modern browsers. For greater browser support, once your app is ready for production, replace the Browser ESM with [the Vanilla ESM (or UMD bundle)](https://github.com/brikcss/element/blob/master/docs/including-brikcss-modules.md)._
## WebAlias element attributes
The `web-alias` HTML element can have the following attributes:
### `prop`
_Type: `String` **(required)**_
Indicates the WebAlias property (from `WebAlias.propsMap`) to use.
### `before`
_Type: `String`_
String to insert before the webalias property.
### `after`
_Type: `String`_
String to insert after the webalias property.
## API
### `WebAlias.webalias`
_Type: `String` Default: `undefined` **(required)**_
The webalias passed to the webalias API. This -- along with the `WebAlias.client` and `WebAlias.env` properties -- will return the [webalias user](#webaliasuser).
### `WebAlias.client`
_Type: `String` Default: `undefined` **(required)**_
The client ID passed to the webalias API.
### `WebAlias.env`
_Type: `String` Default: `undefined` **(required)**_
Environment to use. Can be `dev`, `stage`, or `''` (live). This determines which database is checked.
### `WebAlias.urlCheck`
_Type: `String[]|Boolean` Default: `['webalias']`_
This value determines if and how WebAlias will automatically pull data from the URL. This is a String Array, with possible values of `webalias`, `client`, and `env`. For each property listed, WebAlias will automatically fetch that data property from the URL. By default, only the `webalias` property is checked for. Setting this value to `true` will check all three properties.
_Note: For each property listed, WebAlias calls `WebAlias[`get\${propertyName}FromUrl`](host)`. This means, if you want to customize how WebAlias gets each piece of data, simply override the corresponding method. For example, to override how WebAlias gets the `webalias` property from the URL:_
```js
WebAlias.getWebaliasFromUrl = function (host) {...}
```
### `WebAlias.user`
_Type: `Object` Default: `undefined`_
The webalias user data. The `WebAlias.webalias`, `WebAlias.client`, and `WebAlias.env` properties are used to fetch webalias data from DirectScale's replicated site webalias API, and then normalizing it as follows:
- `first` _{String}_: First name.
- `last` _{String}_: Last name.
- `name` _{String}_: First and last name.
- `email` _{String}_: Email address.
- `phone` _{String}_: Alias for `phone1`.
- `phone1` _{String}_: Phone 1.
- `phone2` _{String}_: Phone 2.
- `city` _{String}_: City.
- `state` _{String}_: State.
- `country` _{String}_: Country.
- `about` _{String}_: About the user.
- `company` _{String}_: Company.
- `language` _{String}_: Language.
- `imageUrl` _{String}_: URL for user's profile image.
- `image` _{String}_: User's profile `![]()
`.
- `imageData` _{String}_: Image data.
- `facebook` _{String}_: Facebook handle.
- `facebookLink` _{String}_: Facebook anchor tag hyperlink.
- `twitter` _{String}_: Twitter handle.
- `twitterLink` _{String}_: Twitter anchor tag hyperlink.
- `pinterest` _{String}_: Pinterest handle.
- `pinterestLink` _{String}_: Pinterest anchor tag hyperlink.
- `youTube` _{String}_: YouTube handle.
- `youTubeLink` _{String}_: YouTube anchor tag hyperlink.
- `linkedIn` _{String}_: LinkedIn handle.
- `linkedInLink` _{String}_: LinkedIn anchor tag hyperlink.
- `enrollmentUrl` _{String}_: URL to user's enrollment site.
- `enrollmentLink` _{String}_: Enrollment anchor tag hyperlink.
- `officeUrl` _{String}_: URL to user's back office.
- `officeLink` _{String}_: Back office anchor tag hyperlink.
- `shoppingUrl` _{String}_: URL to user's shopping site.
- `shoppingLink` _{String}_: Shopping cart anchor tag hyperlink.
- `replicatedSiteUrl` _{String}_: URL to user's replicated site.
- `replicatedSiteLink` _{String}_: Replicated/marketing site anchor tag hyperlink.
- `webalias` _{String}_: User's webalias.
- `customerId` _{String}_: User's customer ID.
- `backOfficeId` _{String}_: User's back office ID.
- `customerTypeId` _{String}_: User's customer type ID.
- `status` _{String}_: User status.
### `WebAlias.propsMap`
_Type: `Object` Default: (see source)_
`WebAlias.propsMap` maps out how `WebAlias.user` values are created. You can create new `WebAlias.user` properties by adding a new property to `WebAlias.propsMap`, and you can modify how any existing `WebAlias.user[prop]` is created by overriding the corresponding property in `WebAlias.propsMap`.
For example:
```js
// Modify an existing webalias property.
WebAlias.propsMap.name = function() {
return `${this.user.last}, ${this.user.first}`;
};
// Create a custom webalias property.
// NOTE: Since HTML markup is being created, use the render function provided (`r`) to correctly render your markup template.
WebAlias.propsMap.avatar = function(r) {
return r`
`;
};
```
These are used in the markup as usual:
```html
```
which, for the user "John Doe", will display the following in the UI (along with the user's image):
```html
Custom property for Doe, John!
```
### `WebAlias.shadowProps`
_Type: `Array` Default: `['facebookLink', 'twitterLink', 'pinterestLink', 'youTubeLink', 'linkedInLink', 'enrollmentLink', 'officeLink', 'shoppingLink', 'replicatedLink']`_
Some default properties in `WebAlias.propsMap` render with `` elements, which is part of the [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM) specification. Shadow DOM encapsulates elements, but also prevents global CSS from being applied _to children_ elements.
By default, Shadow DOM is not used, which allows global styles to be applied. However, if the `prop` attribute matches a value in `WebAlias.shadowProps`, shadow DOM will be created.
_NOTE: You may always [override properties of `WebAlias.propsMap`](#webaliaspropsmap) to control any of this behavior._
### `WebAlias.sourceUrl`
_Type: `String|Function` Default: `https://${WebAlias.webalias}.${WebAlias.client}.directscale${WebAlias.env}.com`_
Passed in the headers (as the `ApplicationUrl` parameter) to the webalias API.
## License
[See License](LICENSE.md).