@energysage/es-ds-components 0.0.1 → 3.0.0-alpha.10

package/utils/get-es-nav-bar-account-content.ts

@@ -0,0 +1,55 @@
+// rooftop account links
+export default (
+    ES_DOMAIN = process.env.ES_DOMAIN || 'https://www.energysage.com',
+    ACCOUNTS_DOMAIN = process.env.ACCOUNTS_DOMAIN || 'https://accounts.energysage.com',
+    REGISTER_LINK = process.env.REGISTER_LINK || `${ACCOUNTS_DOMAIN}/register/?next=${ES_DOMAIN}/register-thanks/`,
+) => ({
+    mobileAccountButtonAltText: 'Open account menu',
+    loggedIn: {
+        items: [
+            {
+                name: 'My profile',
+                link: `${ES_DOMAIN}/profile/`,
+            },
+            {
+                name: 'My quotes',
+                link: `${ES_DOMAIN}/your-marketplace/`,
+            },
+            {
+                name: 'My messages',
+                link: `${ES_DOMAIN}/message/`,
+            },
+            {
+                name: 'My project preferences',
+                link: `${ES_DOMAIN}/market/solarpv/update/`,
+            },
+            {
+                name: 'Account settings',
+                link: `${ES_DOMAIN}/account-settings/router/`,
+            },
+            {
+                name: 'How it works',
+                link: `${ES_DOMAIN}/market-process/`,
+            },
+            {
+                name: 'Write a review',
+                link: `${ES_DOMAIN}/share-your-experience/`,
+            },
+            {
+                name: 'Sign out',
+                link: `${ES_DOMAIN}/logout/`,
+            },
+        ],
+    },
+    loggedOut: {
+        menuButtonText: 'Sign in',
+        signIn: {
+            name: 'Sign in',
+            link: `${ES_DOMAIN}/login/`,
+        },
+        createAccount: {
+            name: 'Create an account',
+            link: REGISTER_LINK,
+        },
+    },
+});

package/utils/get-es-nav-bar-global-content.ts

@@ -0,0 +1,482 @@
+/* eslint-disable no-unused-vars */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+const NAV_BAR_ICONS = {
+    CALCULATOR: 'calculator',
+    ES_LEAF: 'es-leaf',
+    LIGHT_BULB: 'light-bulb',
+};
+
+export default (
+    ES_DOMAIN = process.env.ES_DOMAIN || 'https://www.energysage.com',
+    // exposed separately from ES_DOMAIN in case we want to use prod for images in local/dev
+    ES_IMAGE_DOMAIN = process.env.ES_IMAGE_DOMAIN || 'https://www.energysage.com',
+    // keeping NEWS_DOMAIN to minimize breaking change, but it is deprecated
+    NEWS_DOMAIN = process.env.NEWS_DOMAIN || 'https://www.energysage.com',
+    COMMUNITY_SOLAR_DOMAIN = process.env.COMMUNITY_SOLAR_DOMAIN || 'https://communitysolar.energysage.com',
+    HEAT_PUMPS_DOMAIN = process.env.HEAT_PUMPS_DOMAIN || 'https://heatpumps.energysage.com',
+    EV_RAIVEN_DOMAIN = 'https://shop.energysage.com/',
+) => ({
+    home: {
+        name: 'EnergySage',
+        link: ES_DOMAIN,
+    },
+    mainMenuText: 'Main menu',
+    mobileCloseButtonAltText: 'Close',
+    mobileNavButtonAltText: 'Open navigation menu',
+    seeAllText: 'See all',
+    topLevelMenus: [
+        {
+            name: 'Tips & guides',
+            subHeading: 'Learn from experts',
+            icon: NAV_BAR_ICONS.LIGHT_BULB,
+            topics: [
+                {
+                    name: 'Solar',
+                    subtopics: [
+                        {
+                            name: 'Home solar guide',
+                            link: `${ES_DOMAIN}/solar/`,
+                        },
+                        {
+                            name: 'Community solar guide',
+                            link: `${ES_DOMAIN}/community-solar/`,
+                        },
+                        {
+                            name: 'Best solar panels',
+                            link: `${ES_DOMAIN}/solar/best-solar-panels-complete-ranking/`,
+                        },
+                        {
+                            name: 'How much do solar panels cost?',
+                            link: `${ES_DOMAIN}/local-data/solar-panel-cost/`,
+                        },
+                    ],
+                },
+                {
+                    name: 'Backup power',
+                    subtopics: [
+                        {
+                            name: 'Backup power guide',
+                            link: `${ES_DOMAIN}/energy-storage/`,
+                        },
+                        {
+                            name: 'Best home batteries',
+                            link: `${ES_DOMAIN}/energy-storage/best-home-batteries/`,
+                        },
+                        {
+                            name: 'Home batteries vs. generators',
+                            // eslint-disable-next-line max-len
+                            link: `${ES_DOMAIN}/energy-storage/battery-backup-power-vs-generators-which-is-right-for-you/`,
+                        },
+                    ],
+                },
+                {
+                    name: 'Heating & cooling',
+                    subtopics: [
+                        {
+                            name: 'Heat pump guide',
+                            link: `${ES_DOMAIN}/heat-pumps/`,
+                        },
+                        {
+                            name: 'How much do heat pumps cost?',
+                            // eslint-disable-next-line max-len
+                            link: `${ES_DOMAIN}/heat-pumps/costs-and-benefits-air-source-heat-pumps/`,
+                        },
+                        {
+                            name: 'How do heat pumps work?',
+                            link: `${ES_DOMAIN}/heat-pumps/how-do-heat-pumps-work/`,
+                        },
+                    ],
+                },
+                {
+                    name: 'Electric vehicles',
+                    subtopics: [
+                        {
+                            name: 'EV charging guide',
+                            link: `${ES_DOMAIN}/ev-charging/`,
+                        },
+                        {
+                            name: 'Electric vehicles guide',
+                            link: `${ES_DOMAIN}/electric-vehicles/`,
+                        },
+                        {
+                            name: 'Best EV chargers',
+                            link: `${ES_DOMAIN}/ev-charging/ev-charging-stations/`,
+                        },
+                        {
+                            name: 'How much does it cost to charge an EV?',
+                            link: `${ES_DOMAIN}/ev-charging/electric-vehicle-charging-cost/`,
+                        },
+                    ],
+                },
+                {
+                    name: 'Smart home',
+                    subtopics: [
+                        {
+                            name: 'Home electricity guide',
+                            link: `${ES_DOMAIN}/electricity/`,
+                        },
+                        {
+                            name: 'Home energy management guide',
+                            link: `${ES_DOMAIN}/energy-management/`,
+                        },
+                        {
+                            name: 'Energy efficiency',
+                            link: `${ES_DOMAIN}/energy-efficiency/`,
+                        },
+                        {
+                            name: 'Best smart home gadgets',
+                            link: `${ES_DOMAIN}/energy-products/`,
+                        },
+                    ],
+                },
+                {
+                    name: 'For your business',
+                    subtopics: [
+                        {
+                            name: 'Solar for businesses',
+                            link: `${ES_DOMAIN}/business-solutions/commercial-solar-benefits/`,
+                        },
+                        {
+                            name: 'Solar for nonprofit organizations',
+                            link: `${ES_DOMAIN}/business-solutions/solar-nonprofit-benefits-financing/`,
+                        },
+                        {
+                            name: 'Backup power for businesses',
+                            link: `${ES_DOMAIN}/business-solutions/energy-storage-for-businesses/`,
+                        },
+                    ],
+                },
+                {
+                    name: 'Clean energy financing',
+                    subtopics: [
+                        {
+                            name: 'How to pay for solar',
+                            link: `${ES_DOMAIN}/solar/how-to-pay-for-solar/`,
+                        },
+                        {
+                            name: 'How to choose a solar loan',
+                            link: `${ES_DOMAIN}/solar/solar-loans/`,
+                        },
+                        {
+                            name: 'What to know about solar leases',
+                            link: `${ES_DOMAIN}/solar/solar-leases/`,
+                        },
+                        {
+                            name: 'Explore cost-saving clean energy incentives',
+                            link: `${ES_DOMAIN}/shop/clean-energy-savings-and-tax-incentives/`,
+                        },
+                    ],
+                },
+                {
+                    name: 'News',
+                    subtopics: [
+                        {
+                            name: 'How long can you run your house on a Tesla Powerwall?',
+                            // eslint-disable-next-line max-len
+                            link: `${ES_DOMAIN}/energy-storage/tesla-powerwall-how-much-home-can-you-run-on-it-for-how-long/`,
+                        },
+                        {
+                            name: 'How have solar panel cost and efficiency changed over time?',
+                            link: `${ES_DOMAIN}/solar/solar-panel-efficiency-cost-over-time/`,
+                        },
+                    ],
+                    link: `${ES_DOMAIN}/blog/`,
+                },
+            ],
+            featuredArticle: {
+                linkName: "Editors' pick",
+                linkUrl: `${ES_DOMAIN}/solar/are-solar-panels-worth-it/`,
+                lede: 'Are solar panels worth it?',
+                image500: `${ES_IMAGE_DOMAIN}/static/img/navbar/articles/are-solar-panels-worth-it-500w.png`,
+                imageAlt: 'home with solar panels',
+            },
+        },
+        {
+            name: 'Solar calculator',
+            subHeading: 'Check your savings',
+            icon: NAV_BAR_ICONS.CALCULATOR,
+            link: `${ES_DOMAIN}/solar/calculator/`,
+            topics: [],
+        },
+        {
+            name: 'About us',
+            subHeading: 'Why EnergySage',
+            icon: NAV_BAR_ICONS.ES_LEAF,
+            topics: [
+                {
+                    name: 'Our company',
+                    subtopics: [
+                        {
+                            name: 'Mission & values',
+                            link: `${ES_DOMAIN}/about-us/company/`,
+                        },
+                        {
+                            name: 'How it works',
+                            link: `${ES_DOMAIN}/shop/home-solar/`,
+                        },
+                        {
+                            name: 'Our team',
+                            link: `${ES_DOMAIN}/about-us/team/`,
+                        },
+                        {
+                            name: 'Our Energy Advisors',
+                            link: `${ES_DOMAIN}/energy-advisors/`,
+                        },
+                        {
+                            name: 'Careers',
+                            link: `${ES_DOMAIN}/about-us/careers/`,
+                        },
+                    ],
+                },
+                {
+                    name: 'Our work',
+                    subtopics: [
+                        {
+                            name: 'Market intel',
+                            link: `${ES_DOMAIN}/data/`,
+                        },
+                        {
+                            name: 'Editorial guidelines',
+                            link: `${ES_DOMAIN}/editorial-guidelines/`,
+                        },
+                        {
+                            name: 'Press',
+                            link: `${ES_DOMAIN}/press/`,
+                        },
+                    ],
+                },
+                {
+                    name: 'Work with us',
+                    subtopics: [
+                        {
+                            name: 'Solar & HVAC installers',
+                            link: `${ES_DOMAIN}/installers/`,
+                        },
+                        {
+                            name: 'Corporate partnerships',
+                            link: `${ES_DOMAIN}/partners/corporations`,
+                        },
+                        {
+                            name: 'Community programs',
+                            link: `${ES_DOMAIN}/partners/non-profits`,
+                        },
+                        {
+                            name: 'Utility programs',
+                            link: `${ES_DOMAIN}/partners/utilities`,
+                        },
+                        {
+                            name: 'Others',
+                            link: `${ES_DOMAIN}/partners/`,
+                        },
+                    ],
+                },
+            ],
+            featuredArticle: {
+                linkName: 'New research',
+                linkUrl: `${ES_DOMAIN}/press/energysage-marketplace-intel-report-19`,
+                lede: "EnergySage Intel's latest Solar & Storage Marketplace Report",
+                image500: `${ES_IMAGE_DOMAIN}/static/img/navbar/articles/latest-market-intel-500w.png`,
+                imageAlt: 'market intel report charts',
+            },
+        },
+    ],
+    products: [
+        {
+            name: 'Home solar',
+            link: `${ES_DOMAIN}/shop/home-solar/`,
+            topics: [
+                {
+                    name: 'Rooftop solar',
+                    subHeading: 'Install solar on your property',
+                    link: `${ES_DOMAIN}/shop/home-solar/`,
+                    showItemsOnMobile: false,
+                    subtopics: [
+                        {
+                            name: 'Home solar guide',
+                            link: `${ES_DOMAIN}/solar/`,
+                        },
+                        {
+                            name: 'Solar calculator',
+                            link: `${ES_DOMAIN}/solar/calculator/`,
+                        },
+                        {
+                            name: 'Search local installers',
+                            // eslint-disable-next-line max-len
+                            link: `${ES_DOMAIN}/supplier/search?selected_facets=services:installers&selected_facets=technology_types:Solar%20PV`,
+                        },
+                        {
+                            name: 'Financing',
+                            link: `${ES_DOMAIN}/financing/`,
+                        },
+                        {
+                            name: 'Solar loan providers',
+                            link: `${ES_DOMAIN}/solar/financing/loan-providers/`,
+                        },
+                        {
+                            name: 'Equipment rebates',
+                            link: `${ES_DOMAIN}/promotions/`,
+                        },
+                        {
+                            name: 'Compare solar panels',
+                            link: `${ES_DOMAIN}/solar-panels/`,
+                        },
+                        {
+                            name: 'Compare inverters',
+                            link: `${ES_DOMAIN}/solar-inverters/`,
+                        },
+                        {
+                            name: 'Solar incentives',
+                            link: `${ES_DOMAIN}/local-data/solar-rebates-incentives/`,
+                        },
+                        {
+                            name: 'Backup power guide',
+                            link: `${ES_DOMAIN}/energy-storage/`,
+                        },
+                        {
+                            name: 'Get personalized quotes',
+                            link: `${ES_DOMAIN}/market/start/`,
+                            emphasize: true,
+                        },
+                    ],
+                },
+                {
+                    name: 'Community solar',
+                    subHeading: 'Go solar with no equipment',
+                    link: `${ES_DOMAIN}/shop/community-solar/`,
+                    showItemsOnMobile: false,
+                    subtopics: [
+                        {
+                            name: 'Community solar guide',
+                            link: `${ES_DOMAIN}/community-solar/`,
+                        },
+                        {
+                            name: 'Search solar farms',
+                            link: `${COMMUNITY_SOLAR_DOMAIN}/projects`,
+                            newTab: true,
+                            emphasize: true,
+                        },
+                    ],
+                },
+            ],
+            featuredArticle: {
+                eyebrow: "Editors' pick",
+                link: `${ES_DOMAIN}/local-data/solar-panel-cost/`,
+                name: 'How much do solar panels cost?',
+                image500: `${ES_IMAGE_DOMAIN}/static/img/navbar/articles/solar-panel-cost-500w.png`,
+                imageAlt: 'home with solar panels and money',
+            },
+        },
+        {
+            name: 'Community solar',
+            link: `${ES_DOMAIN}/shop/community-solar/`,
+            items: [
+                {
+                    name: 'Community solar',
+                    link: `${ES_DOMAIN}/shop/community-solar/`,
+                },
+                {
+                    name: 'Community solar guide',
+                    link: `${ES_DOMAIN}/community-solar/`,
+                },
+                {
+                    name: 'Search solar farms ',
+                    link: `${COMMUNITY_SOLAR_DOMAIN}/projects`,
+                    newTab: true,
+                    emphasize: true,
+                },
+            ],
+        },
+        {
+            name: 'Heating & cooling',
+            link: `${ES_DOMAIN}/shop/heat-pumps/`,
+            items: [
+                {
+                    name: 'Heating & cooling',
+                    link: `${ES_DOMAIN}/shop/heat-pumps/`,
+                },
+                {
+                    name: 'Heat pump guide',
+                    link: `${ES_DOMAIN}/heat-pumps/`,
+                },
+                {
+                    name: 'Heat pump incentives',
+                    link: `${ES_DOMAIN}/heat-pumps/heat-pump-incentives/`,
+                },
+                {
+                    name: 'Financing',
+                    link: `${ES_DOMAIN}/financing/`,
+                },
+                {
+                    name: 'Get personalized quotes',
+                    link: `${ES_DOMAIN}/shop/heat-pumps/`,
+                    newTab: true,
+                    emphasize: true,
+                },
+            ],
+        },
+        {
+            name: 'Backup power',
+            link: `${ES_DOMAIN}/energy-storage/`,
+            items: [
+                {
+                    name: 'Backup power guide',
+                    link: `${ES_DOMAIN}/energy-storage/`,
+                },
+                {
+                    name: 'Home battery incentives',
+                    link: `${ES_DOMAIN}/energy-storage/benefits-of-storage/energy-storage-incentives/`,
+                },
+                {
+                    name: 'Compare home batteries',
+                    link: `${ES_DOMAIN}/solar-batteries/`,
+                },
+                {
+                    name: 'Get quotes for solar + batteries',
+                    link: `${ES_DOMAIN}/market/start/`,
+                    emphasize: true,
+                },
+            ],
+        },
+        {
+            name: 'EV charging',
+            link: `${ES_DOMAIN}/ev-charging/`,
+            items: [
+                {
+                    name: 'EV charging guide',
+                    link: `${ES_DOMAIN}/ev-charging/`,
+                },
+                {
+                    name: 'Electric vehicle guide',
+                    link: `${ES_DOMAIN}/electric-vehicles/`,
+                },
+                {
+                    name: 'Shop EV chargers',
+                    link: `${EV_RAIVEN_DOMAIN}`,
+                    emphasize: true,
+                },
+            ],
+        },
+        {
+            name: 'For your business',
+            link: `${ES_DOMAIN}/businesses/`,
+            items: [
+                {
+                    name: 'For your business',
+                    link: `${ES_DOMAIN}/businesses/`,
+                },
+                {
+                    name: 'Solar for businesses',
+                    link: `${ES_DOMAIN}/business-solutions/commercial-solar-benefits/`,
+                },
+                {
+                    name: 'Solar for nonprofit organizations',
+                    link: `${ES_DOMAIN}/business-solutions/solar-nonprofit-benefits-financing/`,
+                },
+                {
+                    name: 'Energy storage for businesses',
+                    link: `${ES_DOMAIN}/business-solutions/energy-storage-for-businesses/`,
+                },
+            ],
+        },
+    ],
+});

package/utils/mime-type-finder.ts

@@ -0,0 +1,48 @@
+// Takes four bytes of a file as a string and returns a MIME type string corresponding to the file type.
+const mimeTypesAndHexes = [
+    {
+        mime: 'image/jpeg',
+        humanReadable: '.jpeg',
+        hexes: ['FFD8FFE0', 'FFD8FFE1', 'FFD8FFE2', 'FFD8FFE8'],
+    },
+    {
+        mime: 'image/png',
+        humanReadable: '.png',
+        hexes: ['89504E47'],
+    },
+    {
+        mime: 'image/gif',
+        humanReadable: '.gif',
+        hexes: ['47494638'],
+    },
+    {
+        mime: 'image/tiff',
+        humanReadable: '.tiff',
+        hexes: ['4D4D002A', '4D4D002B', '49492A00'],
+    },
+    {
+        mime: 'application/msword', // .doc
+        humanReadable: '.doc',
+        hexes: ['0D444F43'],
+    },
+    {
+        mime: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', // .docx
+        humanReadable: '.docx',
+        hexes: ['504B0304'],
+    },
+    {
+        mime: 'application/pdf',
+        humanReadable: '.pdf',
+        hexes: ['25504446'],
+    },
+];
+
+export const mimeTypes = mimeTypesAndHexes.map(({ mime }) => mime);
+
+export function getHumanReadableTypeFromMime(mimeType: any) {
+    return mimeTypesAndHexes.find((mimeTypeAndHex) => mimeTypeAndHex.mime === mimeType)?.humanReadable;
+}
+
+export function findMimeType(hex: any) {
+    return mimeTypesAndHexes.find((mimeType) => mimeType.hexes.includes(hex))?.mime;
+}

package/utils/vuelidate-keys.ts

@@ -0,0 +1,39 @@
+/**
+ * constants.js
+ *
+ * String constants that can be used when defining validations objects
+ */
+
+const REQUIRED = 'vuelidateRequired';
+const MIN_VALUE = 'vuelidateMinValue';
+const MAX_VALUE = 'vuelidateMaxValue';
+const REQUIRED_IF = 'vuelidateRequiredIf';
+const NUMERIC = 'vuelidateNumeric';
+const INTEGER = 'vuelidateInteger';
+const MIN_LENGTH = 'vuelidateMinLength';
+const MAX_LENGTH = 'vuelidateMaxLength';
+const HAS_NUMBER = 'vuelidateHasNumber';
+const HAS_SPECIAL_CHARACTER = 'vuelidateHasSpecialCharacter';
+const HAS_UPPERCASE_LETTER = 'vuelidateHasUppercaseLetter';
+const HAS_LOWERCASE_LETTER = 'vuelidateHasLowercaseLetter';
+const EMAIL = 'vuelidateEmail';
+const PHONE = 'vuelidatePhone';
+const HELPERS = 'vuelidateHelpers';
+
+export default {
+    REQUIRED,
+    REQUIRED_IF,
+    MIN_VALUE,
+    MAX_VALUE,
+    MIN_LENGTH,
+    MAX_LENGTH,
+    NUMERIC,
+    INTEGER,
+    EMAIL,
+    PHONE,
+    HAS_NUMBER,
+    HAS_SPECIAL_CHARACTER,
+    HAS_UPPERCASE_LETTER,
+    HAS_LOWERCASE_LETTER,
+    HELPERS,
+};

package/components/TestComponent.vue

@@ -1,5 +0,0 @@
-<template>
-    <div>
-        This is a test component from es-ds-components
-    </div>
-</template>