@veracity/vui 0.3.1 → 0.4.0

package/footer/consts.d.ts

@@ -1,20 +1,115 @@
-import { FooterColumnsData } from './footer.types';
+import { Environment } from '../utils';
 /**
  * Defines the structure of columns and sections of the Footer.
  * Links' url values here are unique references to actual urls in the footerLinks dictionary.
  */
-export declare const footerColumnsTemplate: FooterColumnsData;
+export declare const footerColumnsTemplate: {
+    readonly column1: {
+        readonly section1: {
+            readonly heading: "Platform";
+            readonly links: readonly [{
+                readonly text: "About Veracity";
+                readonly url: "aboutVeracity";
+            }, {
+                readonly text: "News";
+                readonly url: "news";
+            }, {
+                readonly text: "Marketplace";
+                readonly url: "marketplace";
+            }, {
+                readonly text: "Veracity trust center";
+                readonly url: "veracityTrustCenter";
+            }, {
+                readonly text: "Career";
+                readonly url: "career";
+            }];
+        };
+    };
+    readonly column2: {
+        readonly section1: {
+            readonly heading: "Products";
+            readonly links: readonly [{
+                readonly text: "Veracity Connected app";
+                readonly url: "veracityConnectedApp";
+            }, {
+                readonly text: "Veracity Data Fabric";
+                readonly url: "veracityDataFabric";
+            }, {
+                readonly text: "Deep Search";
+                readonly url: "deepSearch";
+            }, {
+                readonly text: "Asset Connect";
+                readonly url: "assetConnect";
+            }, {
+                readonly text: "Veracity Adapter for Power BI (VAP)";
+                readonly url: "veracityAdapterForPowerBI";
+            }];
+        };
+    };
+    readonly column3: {
+        readonly section1: {
+            readonly heading: "Partnership";
+            readonly links: readonly [{
+                readonly text: "Selling on Veracity";
+                readonly url: "sellingOnVeracity";
+            }, {
+                readonly text: "Veracity partner program";
+                readonly url: "veracityPartnerProgram";
+            }];
+        };
+        readonly section2: {
+            readonly heading: "Developer";
+            readonly links: readonly [{
+                readonly text: "Developer community";
+                readonly url: "developerCommunity";
+            }, {
+                readonly text: "Documentation";
+                readonly url: "documentation";
+            }, {
+                readonly text: "API explorer";
+                readonly url: "apiExplorer";
+            }];
+        };
+    };
+    readonly column4: {
+        readonly section1: {
+            readonly heading: "Support";
+            readonly links: readonly [{
+                readonly text: "Help center";
+                readonly url: "helpCenter";
+            }, {
+                readonly text: "Contact us";
+                readonly url: "contactUs";
+            }];
+        };
+        readonly section2: {
+            readonly heading: "Legal";
+            readonly links: readonly [{
+                readonly text: "Privacy statement";
+                readonly url: "privacyStatement";
+            }, {
+                readonly text: "Terms of use";
+                readonly url: "termsOfUse";
+            }, {
+                readonly text: "Cookies policy";
+                readonly url: "cookiesPolicy";
+            }];
+        };
+    };
+};
+/** Footer link URLs used in Production environment. */
 export declare const footerLinksProd: {
     readonly aboutVeracity: "https://www.veracity.com/about";
     readonly apiExplorer: "https://developer.veracity.com/api";
     readonly assetConnect: "https://www.veracity.com/article/veracity-asset";
     readonly career: "https://www.veracity.com/career";
-    readonly contactUs: "https://services.veracity.com/form/Support";
+    readonly contactUs: "https://support.veracity.com";
     readonly cookiesPolicy: "https://services.veracity.com/CookieList";
     readonly deepSearch: "https://store.veracity.com/veracity-deep-search";
     readonly developerCommunity: "https://developer.veracity.com";
     readonly documentation: "https://developer.veracity.com/docs";
-    readonly marketplace: "https://store.veracity.com/";
+    readonly helpCenter: "https://help-center.veracity.com";
+    readonly marketplace: "https://store.veracity.com";
     readonly news: "https://www.veracity.com";
     readonly privacyStatement: "https://services.veracity.com/PrivacyStatement";
     readonly sellingOnVeracity: "https://developer.veracity.com/article/are-you-ready-to-sell-on-veracity";
@@ -25,17 +120,19 @@ export declare const footerLinksProd: {
     readonly veracityPartnerProgram: "https://www.veracity.com/partner";
     readonly veracityTrustCenter: "https://www.veracity.com/veracity-trust-center";
 };
+/** Footer link URLs used in Staging environment. */
 export declare const footerLinksStag: {
     readonly aboutVeracity: "https://wwwstag.veracity.com/about";
     readonly apiExplorer: "https://developer.veracity.com/api";
     readonly assetConnect: "https://www.veracity.com/article/veracity-asset";
     readonly career: "https://wwwstag.veracity.com/career";
-    readonly contactUs: "https://servicesstag.veracity.com/form/Support";
+    readonly contactUs: "https://support.veracity.com";
     readonly cookiesPolicy: "https://servicesstag.veracity.com/CookieList";
     readonly deepSearch: "https://storestag.veracity.com/veracity-deep-search";
     readonly developerCommunity: "https://developerstag.veracity.com";
     readonly documentation: "https://developerstag.veracity.com/docs";
-    readonly marketplace: "https://storestag.veracity.com/";
+    readonly helpCenter: "https://help-center.veracity.com";
+    readonly marketplace: "https://storestag.veracity.com";
     readonly news: "https://wwwstag.veracity.com";
     readonly privacyStatement: "https://servicesstag.veracity.com/PrivacyStatement";
     readonly sellingOnVeracity: "https://developer.veracity.com/article/are-you-ready-to-sell-on-veracity";
@@ -46,17 +143,19 @@ export declare const footerLinksStag: {
     readonly veracityPartnerProgram: "https://wwwstag.veracity.com/partner";
     readonly veracityTrustCenter: "https://www.veracity.com/veracity-trust-center";
 };
+/** Footer link URLs used in Test environment. */
 export declare const footerLinksTest: {
     readonly aboutVeracity: "https://wwwtest.veracity.com/about";
     readonly apiExplorer: "https://developer.veracity.com/api";
     readonly assetConnect: "https://www.veracity.com/article/veracity-asset";
     readonly career: "https://www.veracity.com/career";
-    readonly contactUs: "https://servicestest.veracity.com/form/Support";
+    readonly contactUs: "https://support.veracity.com";
     readonly cookiesPolicy: "https://servicestest.veracity.com/CookieList";
     readonly deepSearch: "https://storetest.veracity.com/veracity-deep-search";
     readonly developerCommunity: "https://developertest.veracity.com";
     readonly documentation: "https://developertest.veracity.com/docs";
-    readonly marketplace: "https://storetest.veracity.com/";
+    readonly helpCenter: "https://help-center.veracity.com";
+    readonly marketplace: "https://storetest.veracity.com";
     readonly news: "https://wwwtest.veracity.com";
     readonly privacyStatement: "https://servicestest.veracity.com/PrivacyStatement";
     readonly sellingOnVeracity: "https://developer.veracity.com/article/are-you-ready-to-sell-on-veracity";
@@ -67,3 +166,4 @@ export declare const footerLinksTest: {
     readonly veracityPartnerProgram: "https://wwwtest.veracity.com/partner";
     readonly veracityTrustCenter: "https://www.veracity.com/veracity-trust-center";
 };
+export declare const footerLinks: Record<Environment, Record<string, string>>;

package/footer/consts.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.footerLinksTest = exports.footerLinksStag = exports.footerLinksProd = exports.footerColumnsTemplate = void 0;
+exports.footerLinks = exports.footerLinksTest = exports.footerLinksStag = exports.footerLinksProd = exports.footerColumnsTemplate = void 0;
 /**
  * Defines the structure of columns and sections of the Footer.
  * Links' url values here are unique references to actual urls in the footerLinks dictionary.
@@ -51,30 +51,33 @@ exports.footerColumnsTemplate = {
         section1: {
             heading: 'Support',
             links: [
-                { text: 'Contact us', url: 'contactUs' },
-                { text: 'Privacy statement', url: 'privacyStatement' }
+                { text: 'Help center', url: 'helpCenter' },
+                { text: 'Contact us', url: 'contactUs' }
             ]
         },
         section2: {
             heading: 'Legal',
             links: [
+                { text: 'Privacy statement', url: 'privacyStatement' },
                 { text: 'Terms of use', url: 'termsOfUse' },
                 { text: 'Cookies policy', url: 'cookiesPolicy' }
             ]
         }
     }
 };
+/** Footer link URLs used in Production environment. */
 exports.footerLinksProd = {
     aboutVeracity: 'https://www.veracity.com/about',
     apiExplorer: 'https://developer.veracity.com/api',
     assetConnect: 'https://www.veracity.com/article/veracity-asset',
     career: 'https://www.veracity.com/career',
-    contactUs: 'https://services.veracity.com/form/Support',
+    contactUs: 'https://support.veracity.com',
     cookiesPolicy: 'https://services.veracity.com/CookieList',
     deepSearch: 'https://store.veracity.com/veracity-deep-search',
     developerCommunity: 'https://developer.veracity.com',
     documentation: 'https://developer.veracity.com/docs',
-    marketplace: 'https://store.veracity.com/',
+    helpCenter: 'https://help-center.veracity.com',
+    marketplace: 'https://store.veracity.com',
     news: 'https://www.veracity.com',
     privacyStatement: 'https://services.veracity.com/PrivacyStatement',
     sellingOnVeracity: 'https://developer.veracity.com/article/are-you-ready-to-sell-on-veracity',
@@ -85,17 +88,19 @@ exports.footerLinksProd = {
     veracityPartnerProgram: 'https://www.veracity.com/partner',
     veracityTrustCenter: 'https://www.veracity.com/veracity-trust-center'
 };
+/** Footer link URLs used in Staging environment. */
 exports.footerLinksStag = {
     aboutVeracity: 'https://wwwstag.veracity.com/about',
     apiExplorer: 'https://developer.veracity.com/api',
     assetConnect: 'https://www.veracity.com/article/veracity-asset',
     career: 'https://wwwstag.veracity.com/career',
-    contactUs: 'https://servicesstag.veracity.com/form/Support',
+    contactUs: 'https://support.veracity.com',
     cookiesPolicy: 'https://servicesstag.veracity.com/CookieList',
     deepSearch: 'https://storestag.veracity.com/veracity-deep-search',
     developerCommunity: 'https://developerstag.veracity.com',
     documentation: 'https://developerstag.veracity.com/docs',
-    marketplace: 'https://storestag.veracity.com/',
+    helpCenter: 'https://help-center.veracity.com',
+    marketplace: 'https://storestag.veracity.com',
     news: 'https://wwwstag.veracity.com',
     privacyStatement: 'https://servicesstag.veracity.com/PrivacyStatement',
     sellingOnVeracity: 'https://developer.veracity.com/article/are-you-ready-to-sell-on-veracity',
@@ -106,17 +111,19 @@ exports.footerLinksStag = {
     veracityPartnerProgram: 'https://wwwstag.veracity.com/partner',
     veracityTrustCenter: 'https://www.veracity.com/veracity-trust-center'
 };
+/** Footer link URLs used in Test environment. */
 exports.footerLinksTest = {
     aboutVeracity: 'https://wwwtest.veracity.com/about',
     apiExplorer: 'https://developer.veracity.com/api',
     assetConnect: 'https://www.veracity.com/article/veracity-asset',
     career: 'https://www.veracity.com/career',
-    contactUs: 'https://servicestest.veracity.com/form/Support',
+    contactUs: 'https://support.veracity.com',
     cookiesPolicy: 'https://servicestest.veracity.com/CookieList',
     deepSearch: 'https://storetest.veracity.com/veracity-deep-search',
     developerCommunity: 'https://developertest.veracity.com',
     documentation: 'https://developertest.veracity.com/docs',
-    marketplace: 'https://storetest.veracity.com/',
+    helpCenter: 'https://help-center.veracity.com',
+    marketplace: 'https://storetest.veracity.com',
     news: 'https://wwwtest.veracity.com',
     privacyStatement: 'https://servicestest.veracity.com/PrivacyStatement',
     sellingOnVeracity: 'https://developer.veracity.com/article/are-you-ready-to-sell-on-veracity',
@@ -127,3 +134,8 @@ exports.footerLinksTest = {
     veracityPartnerProgram: 'https://wwwtest.veracity.com/partner',
     veracityTrustCenter: 'https://www.veracity.com/veracity-trust-center'
 };
+exports.footerLinks = {
+    Prod: exports.footerLinksProd,
+    Stag: exports.footerLinksStag,
+    Test: exports.footerLinksTest
+};

package/footer/footer.d.ts

@@ -5,7 +5,9 @@ import FooterHeading from './footerHeading';
 import FooterLink from './footerLink';
 import FooterRow from './footerRow';
 import FooterSection from './footerSection';
-declare const Footer: VuiComponent<"div", FooterProps> & {
+export declare const FooterBase: import("styled-components").StyledComponent<"div", import("styled-components").DefaultTheme, import("..").SystemProps, never>;
+/** Branded Veracity Footer with trademark and links sections. Controls max-width of the content. */
+export declare const Footer: VuiComponent<"div", FooterProps> & {
     Column: typeof FooterColumn;
     Heading: typeof FooterHeading;
     Link: typeof FooterLink;

package/footer/footer.js

@@ -1,4 +1,8 @@
 "use strict";
+var __makeTemplateObject = (this && this.__makeTemplateObject) || function (cooked, raw) {
+    if (Object.defineProperty) { Object.defineProperty(cooked, "raw", { value: raw }); } else { cooked.raw = raw; }
+    return cooked;
+};
 var __assign = (this && this.__assign) || function () {
     __assign = Object.assign || function(t) {
         for (var s, i = 1, n = arguments.length; i < n; i++) {
@@ -41,19 +45,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Footer = exports.FooterBase = void 0;
 var react_1 = __importDefault(require("react"));
 var box_1 = require("../box");
 var core_1 = require("../core");
 var divider_1 = require("../divider");
+var utils_1 = require("../utils");
 var footerColumn_1 = __importDefault(require("./footerColumn"));
 var footerHeading_1 = __importDefault(require("./footerHeading"));
 var footerLink_1 = __importDefault(require("./footerLink"));
 var footerRow_1 = __importDefault(require("./footerRow"));
 var footerSection_1 = __importDefault(require("./footerSection"));
 var footerTrademark_1 = __importDefault(require("./footerTrademark"));
-var Footer = (0, core_1.vui)(function (props, ref) {
-    var children = props.children, columns = props.columns, rest = __rest(props, ["children", "columns"]);
-    return (react_1.default.createElement(box_1.Box, __assign({ bg: "prussian.80", color: "white", px: 3, py: 5, ref: ref }, rest),
+exports.FooterBase = core_1.styled.divBox(templateObject_1 || (templateObject_1 = __makeTemplateObject(["\n\tbackground-color: prussian.80;\n\tcolor: white;\n\tpadding: 5 3;\n"], ["\n\tbackground-color: prussian.80;\n\tcolor: white;\n\tpadding: 5 3;\n"
+    /** Branded Veracity Footer with trademark and links sections. Controls max-width of the content. */
+])));
+/** Branded Veracity Footer with trademark and links sections. Controls max-width of the content. */
+exports.Footer = (0, core_1.vui)(function (props, ref) {
+    var children = props.children, className = props.className, columns = props.columns, rest = __rest(props, ["children", "className", "columns"]);
+    return (react_1.default.createElement(exports.FooterBase, __assign({ className: (0, utils_1.cs)('vui-footer', className), ref: ref }, rest),
         react_1.default.createElement(box_1.Box, { column: true, maxW: 1200, mx: "auto", w: "100%" }, children !== null && children !== void 0 ? children : (columns && (react_1.default.createElement(footerRow_1.default, null, Object.entries(columns).map(function (_a) {
             var _b = __read(_a, 2), columnName = _b[0], column = _b[1];
             return (react_1.default.createElement(footerColumn_1.default, { key: columnName }, Object.entries(column).map(function (_a) {
@@ -65,10 +75,11 @@ var Footer = (0, core_1.vui)(function (props, ref) {
             react_1.default.createElement(footerRow_1.default, null,
                 react_1.default.createElement(footerTrademark_1.default, null)))));
 });
-Footer.displayName = 'Footer';
-Footer.Column = footerColumn_1.default;
-Footer.Heading = footerHeading_1.default;
-Footer.Link = footerLink_1.default;
-Footer.Row = footerRow_1.default;
-Footer.Section = footerSection_1.default;
-exports.default = Footer;
+exports.Footer.displayName = 'Footer';
+exports.Footer.Column = footerColumn_1.default;
+exports.Footer.Heading = footerHeading_1.default;
+exports.Footer.Link = footerLink_1.default;
+exports.Footer.Row = footerRow_1.default;
+exports.Footer.Section = footerSection_1.default;
+exports.default = exports.Footer;
+var templateObject_1;

package/footer/footer.types.d.ts

@@ -11,20 +11,25 @@ export declare type FooterColumnProps = FooterBoxProps;
 export declare type FooterColumnsData = {
     [column: string]: FooterColumnData;
 };
+/** Link includes the label text and URL address. */
 export declare type FooterLinkData = {
     text: string;
     url: string;
 };
 export declare type FooterProps = FooterBoxProps & ThemingProps<'Footer'> & {
+    /** Data defining content of multiple columns. */
     columns?: FooterColumnsData;
 };
 /** Section consists of multiple links with text (label) and url */
 export declare type FooterSectionData = {
     heading: string;
+    /** Array of objects defining each link. */
     links: FooterLinkData[];
 };
 export declare type FooterSectionProps = FooterBoxProps & {
+    /** Socket placing a heading on top of the section. */
     heading?: FooterSectionData['heading'] | JSX.Element;
+    /** Socket placing a list of links below the heading. */
     links?: FooterSectionData['links'] | JSX.Element;
 };
 export {};