@shoplflow/extension 0.0.2

package/manifest.ts

@@ -0,0 +1,37 @@
+import packageJson from './package.json';
+
+/**
+ * After changing, please reload the extension at `chrome://extensions`
+ */
+const manifest: chrome.runtime.ManifestV3 = {
+  manifest_version: 3,
+  name: packageJson.name,
+  version: packageJson.version,
+  description: packageJson.description,
+  permissions: ['storage'],
+  action: {
+    default_popup: 'src/pages/popup/index.html',
+    default_icon: 'icon-34.png',
+  },
+
+  icons: {
+    '128': 'icon-128.png',
+  },
+  content_scripts: [
+    {
+      matches: ['http://*/*', 'https://*/*', '<all_urls>'],
+      js: ['src/pages/content/index.js'],
+      // KEY for cache invalidation
+      css: ['assets/css/contentStyle<KEY>.chunk.css'],
+    },
+  ],
+  devtools_page: 'src/pages/devtools/index.html',
+  web_accessible_resources: [
+    {
+      resources: ['assets/js/*.js', 'assets/css/*.css', 'icon-128.png', 'icon-34.png'],
+      matches: ['*://*/*'],
+    },
+  ],
+};
+
+export default manifest;

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "@shoplflow/extension",
+  "version": "0.0.2",
+  "license": "MIT",
+  "description": "Shoplflow 점유율 확인 extension",
+  "type": "module",
+  "dependencies": {
+    "@shoplflow/base": "^0.26.0",
+    "chart.js": "^4.4.0",
+    "construct-style-sheets-polyfill": "^3.1.0",
+    "react": "18.2.0",
+    "react-chartjs-2": "^5.2.0",
+    "react-dom": "18.2.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.7.2",
+    "@commitlint/config-conventional": "^17.7.0",
+    "@emotion/styled": "^11.11.0",
+    "@rollup/plugin-typescript": "^8.5.0",
+    "@testing-library/react": "13.4.0",
+    "@twind/core": "^1.1.3",
+    "@twind/preset-autoprefix": "^1.0.7",
+    "@twind/preset-tailwind": "^1.1.4",
+    "@types/chrome": "0.0.224",
+    "@types/node": "18.15.11",
+    "@types/react": "18.2.29",
+    "@types/react-dom": "18.2.13",
+    "@types/ws": "^8.5.4",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "@typescript-eslint/parser": "^6.7.5",
+    "@vitejs/plugin-react": "2.2.0",
+    "chokidar": "^3.5.3",
+    "cross-env": "^7.0.3",
+    "fs-extra": "11.1.0",
+    "lint-staged": "^14.0.1",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^2.8.8",
+    "rollup": "2.79.1",
+    "sass": "1.62.1",
+    "ts-jest": "29.0.2",
+    "ts-loader": "9.4.2",
+    "tslib": "^2.6.2",
+    "typescript": "4.9.5",
+    "vite": "3.2.7",
+    "ws": "8.13.0"
+  },
+  "scripts": {
+    "build": "vite build",
+    "build:firefox": "tsc --noEmit && cross-env __FIREFOX__=true vite build",
+    "build:watch": "cross-env __DEV__=true vite build -w --mode development",
+    "build:firefox:watch": "cross-env __DEV__=true __FIREFOX__=true vite build -w --mode development",
+    "build:hmr": "rollup --config utils/reload/rollup.config.ts",
+    "wss": "node utils/reload/initReloadServer.js",
+    "dev": "pnpm build:hmr && (run-p wss build:watch)",
+    "dev:firefox": "pnpm build:hmr && (run-p wss build:firefox:watch)"
+  }
+}

package/public/manifest.json

@@ -0,0 +1,45 @@
+{
+  "manifest_version": 3,
+  "name": "@shoplflow/extension",
+  "version": "0.0.2",
+  "description": "Shoplflow 점유율 확인 extension",
+  "permissions": [
+    "storage"
+  ],
+  "action": {
+    "default_popup": "src/pages/popup/index.html",
+    "default_icon": "icon-34.png"
+  },
+  "icons": {
+    "128": "icon-128.png"
+  },
+  "content_scripts": [
+    {
+      "matches": [
+        "http://*/*",
+        "https://*/*",
+        "<all_urls>"
+      ],
+      "js": [
+        "src/pages/content/index.js"
+      ],
+      "css": [
+        "assets/css/contentStyle17107484687.chunk.css"
+      ]
+    }
+  ],
+  "devtools_page": "src/pages/devtools/index.html",
+  "web_accessible_resources": [
+    {
+      "resources": [
+        "assets/js/*.js",
+        "assets/css/*.css",
+        "icon-128.png",
+        "icon-34.png"
+      ],
+      "matches": [
+        "*://*/*"
+      ]
+    }
+  ]
+}

package/src/Components/ElementListCard.tsx

@@ -0,0 +1,35 @@
+import React from 'react';
+import { ColorTokens, Stack, Text } from '@shoplflow/base';
+interface ElementListCardProps {
+  title: string;
+  value: string;
+  valueColor?: ColorTokens;
+}
+
+const ElementListCard = ({ title, value, valueColor }: ElementListCardProps) => {
+  return (
+    <Stack.Horizontal
+      width={'100%'}
+      height={'20px'}
+      justify={'space-between'}
+      align={'center'}
+      spacing={'spacing04'}
+      style={{
+        padding: '16px 20px',
+        boxSizing: 'border-box',
+      }}>
+      <Text
+        typography={'body1_400'}
+        lineClamp={1}
+        color={valueColor}
+        style={{
+          width: '100px',
+        }}>
+        {title}
+      </Text>
+      <Text typography={'body1_700'}>{value}</Text>
+    </Stack.Horizontal>
+  );
+};
+
+export default ElementListCard;

package/src/assets/img/logo.svg

@@ -0,0 +1,7 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3">
+    <g fill="#61DAFB">
+        <path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/>
+        <circle cx="420.9" cy="296.5" r="45.7"/>
+        <path d="M520.5 78.1z"/>
+    </g>
+</svg>

package/src/environment.d.ts

@@ -0,0 +1,10 @@
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      __DEV__: string;
+      __FIREFOX__: string;
+    }
+  }
+}
+
+export {};

package/src/global.d.ts

@@ -0,0 +1,37 @@
+import Chrome from 'chrome';
+
+declare namespace chrome {
+  export default Chrome;
+}
+
+declare module 'virtual:reload-on-update-in-background-script' {
+  export const reloadOnUpdate: (watchPath: string) => void;
+  export default reloadOnUpdate;
+}
+
+declare module 'virtual:reload-on-update-in-view' {
+  const refreshOnUpdate: (watchPath: string) => void;
+  export default refreshOnUpdate;
+}
+
+declare module '*.svg' {
+  import React = require('react');
+  export const ReactComponent: React.SFC<React.SVGProps<SVGSVGElement>>;
+  const src: string;
+  export default src;
+}
+
+declare module '*.jpg' {
+  const content: string;
+  export default content;
+}
+
+declare module '*.png' {
+  const content: string;
+  export default content;
+}
+
+declare module '*.json' {
+  const content: string;
+  export default content;
+}

package/src/pages/background/index.ts

@@ -0,0 +1,11 @@
+import reloadOnUpdate from 'virtual:reload-on-update-in-background-script';
+
+reloadOnUpdate('pages/background');
+
+/**
+ * Extension reloading is necessary because the browser automatically caches the css.
+ * If you do not use the css of the content script, please delete it.
+ */
+reloadOnUpdate('pages/content/style.scss');
+
+console.log('background loaded');

package/src/pages/content/components/Demo/app.tsx

@@ -0,0 +1,93 @@
+import { useEffect, useRef } from 'react';
+import componentsInfoStorage from '@src/shared/storages/componentsInfoStorage';
+import useStorage from '@src/shared/hooks/useStorage';
+import { checkShopl } from '@root/utils/checkShopl';
+
+export default function App() {
+  const { refresh } = useStorage(componentsInfoStorage);
+  const observer = useRef(null);
+  function accessIframeContent(rootElement: HTMLElement) {
+    const components: HTMLElement[] = [];
+
+    function traverseNode(node: HTMLElement) {
+      if (node.id === 'root') {
+        Array.from(node.children).forEach(traverseNode);
+        return;
+      }
+
+      components.push(node);
+
+      if (node.tagName === 'IFRAME') {
+        const iframe = (node as HTMLIFrameElement).contentDocument;
+        traverseNode(iframe.body);
+        return;
+      }
+
+      Array.from(node.children).forEach(traverseNode);
+    }
+
+    traverseNode(rootElement);
+
+    return components;
+  }
+
+  const handleRenderComplete = async () => {
+    let rootElement = document.querySelector('#root');
+
+    let result: HTMLElement[] = [];
+
+    // If #root exists, search elements after #root
+    if (rootElement) {
+      result = accessIframeContent(rootElement);
+    } else {
+      // If #root doesn't exist, search all elements in body
+      rootElement = document.body;
+      result = accessIframeContent(rootElement);
+    }
+
+    // Update component info storage
+    const system = result.filter((element) => Boolean(element.dataset?.shoplflow));
+
+    if (system.length < 1) {
+      return;
+    }
+
+    const filterElements = system?.reduce((acc, element) => {
+      const elementName = element.dataset.shoplflow;
+      return {
+        ...acc,
+        [elementName]: elementName in acc ? acc[elementName] + 1 : 1,
+      };
+    });
+    if (system) {
+      await chrome.storage.local.set({
+        systems: system.length,
+        components: result.length,
+        systemElement: filterElements,
+      });
+    }
+  };
+
+  useEffect(() => {
+    const origin = window.location.origin;
+    if (!checkShopl(origin)) {
+      return;
+    }
+    handleRenderComplete();
+    observer.current = new MutationObserver(handleRenderComplete);
+
+    observer.current.observe(document.body || document.querySelector('#root'), {
+      childList: true,
+      attributes: true,
+      subtree: true,
+    });
+
+    return () => {
+      if (observer.current) {
+        observer.current.disconnect();
+      }
+    };
+  }, [handleRenderComplete, refresh]);
+
+  return null;
+}

package/src/pages/content/components/Demo/index.tsx

@@ -0,0 +1,27 @@
+import { createRoot } from 'react-dom/client';
+import App from '@src/pages/content/components/Demo/app';
+import refreshOnUpdate from 'virtual:reload-on-update-in-view';
+import { attachTwindStyle } from '@src/shared/style/twind';
+
+refreshOnUpdate('pages/content');
+
+const root = document.createElement('div');
+root.id = 'chrome-extension-boilerplate-react-vite-content-view-root';
+
+document.body.append(root);
+
+const rootIntoShadow = document.createElement('div');
+rootIntoShadow.id = 'shadow-root';
+
+const shadowRoot = root.attachShadow({ mode: 'open' });
+shadowRoot.appendChild(rootIntoShadow);
+
+/**
+ * https://github.com/Jonghakseo/chrome-extension-boilerplate-react-vite/pull/174
+ *
+ * In the firefox environment, the adoptedStyleSheets bug may prevent contentStyle from being applied properly.
+ * Please refer to the PR link above and go back to the contentStyle.css implementation, or raise a PR if you have a better way to improve it.
+ */
+attachTwindStyle(rootIntoShadow, shadowRoot);
+
+createRoot(rootIntoShadow).render(<App />);

package/src/pages/content/index.ts

@@ -0,0 +1,7 @@
+console.log('content loaded');
+
+/**
+ * @description
+ * Chrome extensions don't support modules in content scripts.
+ */
+import('./components/Demo');

package/src/pages/content/style.scss

@@ -0,0 +1,7 @@
+
+
+// CSS that can pollute global styles. Use it with caution.
+// If you use ShodowRoot for style pollution, this style will not be applied inside the content script.
+.content-view-style-may-be-not-working {
+  font-size: 30px;
+}

package/src/pages/options/Options.css

@@ -0,0 +1,8 @@
+.container {
+  width: 100%;
+  height: 50vh;
+  font-size: 2rem;
+  display: flex;
+  align-items: center;
+  justify-content: center;
+}

package/src/pages/options/Options.tsx

@@ -0,0 +1,8 @@
+import React from 'react';
+import '@pages/options/Options.css';
+
+const Options: React.FC = () => {
+  return <div className="container text-lime-400">Options</div>;
+};
+
+export default Options;

package/src/pages/options/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="ko">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Options</title>
+  </head>
+
+  <body>
+    <div id="app-container"></div>
+    <script type="module" src="./index.tsx"></script>
+  </body>
+</html>

package/src/pages/options/index.tsx

@@ -0,0 +1,18 @@
+import React from 'react';
+import { createRoot } from 'react-dom/client';
+import Options from '@pages/options/Options';
+import '@pages/options/index.css';
+import refreshOnUpdate from 'virtual:reload-on-update-in-view';
+
+refreshOnUpdate('pages/options');
+
+function init() {
+  const appContainer = document.querySelector('#app-container');
+  if (!appContainer) {
+    throw new Error('Can not find #app-container');
+  }
+  const root = createRoot(appContainer);
+  root.render(<Options />);
+}
+
+init();

package/src/pages/panel/Panel.css

@@ -0,0 +1,7 @@
+body {
+  background-color: #242424;
+}
+
+.container {
+  color: #ffffff;
+}

package/src/pages/panel/Panel.tsx

@@ -0,0 +1,65 @@
+import React, { useEffect, useState } from 'react';
+import '@pages/panel/Panel.css';
+import { ArcElement, Chart as ChartJS, Legend, Tooltip } from 'chart.js';
+import { ShoplflowProvider, Stack, Text } from '@shoplflow/base';
+import { Doughnut } from 'react-chartjs-2';
+ChartJS.register(Legend, ArcElement, Tooltip);
+const Panel: React.FC = () => {
+  const [{ systems, components, systemElement }, setData] = useState({
+    systems: 0,
+    components: 0,
+  });
+
+  useEffect(() => {
+    (async () => {
+      await chrome.storage.local.get(['systems', 'components', 'systemElement'], result => setData(result));
+    })();
+  }, []);
+
+  const percentage = (systems / components) * 100;
+
+  const data = {
+    labels: ['HTML 요소', 'shoplflow'],
+    datasets: [
+      {
+        label: '# 컴포넌트 개수',
+        data: [components - systems, systems],
+        backgroundColor: ['#3eb0b8', '#84c2fc'],
+        borderColor: ['#2f839f', '#3299fe'],
+        borderWidth: 1,
+      },
+    ],
+  };
+
+  console.log(systemElement);
+  return (
+    <ShoplflowProvider>
+      <Stack.Horizontal width={'100%'} align={'center'} spacing={'spacing20'}>
+        <Stack.Vertical height={'fit-content'} width={'200px'}>
+          <Doughnut data={data} />
+        </Stack.Vertical>
+        <Stack.Vertical width={'100%'} justify={'center'} align={'center'} height={'20px'}>
+          <Text typography={'title1_700'}>shoplflow 점유율 {percentage.toFixed(2)}%</Text>
+          <Stack.Horizontal width={'100%'} justify={'center'} align={'center'} height={'20px'}>
+            <Text typography={'caption_400'}>전체 컴포넌트 {components}</Text>
+            <Text typography={'caption_400'}>시스템 컴포넌트 {systems}</Text>
+          </Stack.Horizontal>
+          <Stack.Vertical>
+            {Object.keys(systemElement)?.map(key => (
+              <Stack.Horizontal key={key} width={'100%'} justify={'center'} align={'center'} height={'20px'}>
+                <Text typography={'caption_400'}>{key}</Text>
+                <Text typography={'caption_400'}>{systemElement[key]}개</Text>
+              </Stack.Horizontal>
+            ))}
+          </Stack.Vertical>
+          <Stack>{JSON.stringify(systemElement)}</Stack>
+        </Stack.Vertical>
+        <Stack.Vertical width={'100%'} justify={'center'} align={'end'} height={'20px'}>
+          <Text typography={'caption_400'}>@shoplflow</Text>
+        </Stack.Vertical>
+      </Stack.Horizontal>
+    </ShoplflowProvider>
+  );
+};
+
+export default Panel;

package/src/pages/panel/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="ko">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Devtools Panel</title>
+  </head>
+
+  <body>
+    <div id="app-container"></div>
+    <script type="module" src="./index.tsx"></script>
+  </body>
+</html>

package/src/pages/panel/index.tsx

@@ -0,0 +1,20 @@
+import React from 'react';
+import { createRoot } from 'react-dom/client';
+import Panel from '@pages/panel/Panel';
+import '@pages/panel/index.css';
+import refreshOnUpdate from 'virtual:reload-on-update-in-view';
+import { attachTwindStyle } from '@src/shared/style/twind';
+
+refreshOnUpdate('pages/panel');
+
+function init() {
+  const appContainer = document.querySelector('#app-container');
+  if (!appContainer) {
+    throw new Error('Can not find #app-container');
+  }
+  attachTwindStyle(appContainer, document);
+  const root = createRoot(appContainer);
+  root.render(<Panel />);
+}
+
+init();

package/src/pages/popup/Popup.css

@@ -0,0 +1,44 @@
+.App {
+  position: absolute;
+  top: 0;
+  bottom: 0;
+  left: 0;
+  right: 0;
+  text-align: center;
+  padding: 20px;
+  background-color: var(--neutral100);
+}
+
+.App-logo {
+  height: 30vmin;
+  pointer-events: none;
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  .App-logo {
+    animation: App-logo-spin infinite 20s linear;
+  }
+}
+
+.App-header {
+  height: 100%;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  font-size: calc(10px + 2vmin);
+  color: white;
+}
+
+.App-link {
+  color: #61dafb;
+}
+
+@keyframes App-logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}