donalffons · JohannesMerkt · Jun 10, 2022
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/.gitignore b/starter-templates/ocjs-create-react-app-web-and-service-worker/.gitignore
@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/README.md b/starter-templates/ocjs-create-react-app-web-and-service-worker/README.md
@@ -0,0 +1,19 @@
+# Create React App opencascade.js Template using web worker, service worker and typescript
+- opencascade.js operations are running on a **service worker** to avoid blocking the UI while performing CAD operations.
+- The **service worker** is used in **production only** to cache the application including the large wasm file of opencascade.js to speed up loading times when visiting the website a second time.
+
+## Development
+
+Use `npm start` to start the development mode. In this mode the service worker does not work and therefore opencascade.js takes longer to reload.
+
+## Production
+Use `npm run build` to create a production build `including the service worker`.
+To test the service worker you can then serve the build. For example with `npx serve -s build`.
+You will see on a second visit opencascade initializes faster.
+
+## More on service worker
+The service worker can have some weird behaviour. It does not update the service worker on its own once a new version of the service worker is used in production build. If you find a solution for this please contribute it to this template. 
+
+To make sure the new service worker is used unregister the service worker from within the dev tools in the browser manualy and then reload the website.
+
+If you want to **opt out of the service** worker go into `index.tsx` and change `serviceWorkerRegistration.register();` to `serviceWorkerRegistration.unregister();`.
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/package.json b/starter-templates/ocjs-create-react-app-web-and-service-worker/package.json
@@ -0,0 +1,58 @@
+{
+  "name": "ocjs-cra-web-and-service-worker-typescript",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@google/model-viewer": "^1.12.0",
+    "@testing-library/jest-dom": "^5.16.4",
+    "@testing-library/react": "^13.3.0",
+    "@testing-library/user-event": "^13.5.0",
+    "@types/jest": "^27.5.2",
+    "@types/node": "^17.0.41",
+    "@types/react": "^18.0.12",
+    "@types/react-dom": "^18.0.5",
+    "opencascade.js": "^2.0.0-beta.6e177a4",
+    "react": "^18.1.0",
+    "react-dom": "^18.1.0",
+    "react-scripts": "5.0.1",
+    "typescript": "^4.7.3",
+    "web-vitals": "^2.1.4",
+    "workbox-background-sync": "^6.5.3",
+    "workbox-broadcast-update": "^6.5.3",
+    "workbox-cacheable-response": "^6.5.3",
+    "workbox-cli": "^6.5.3",
+    "workbox-core": "^6.5.3",
+    "workbox-expiration": "^6.5.3",
+    "workbox-google-analytics": "^6.5.3",
+    "workbox-navigation-preload": "^6.5.3",
+    "workbox-precaching": "^6.5.3",
+    "workbox-range-requests": "^6.5.3",
+    "workbox-routing": "^6.5.3",
+    "workbox-strategies": "^6.5.3",
+    "workbox-streams": "^6.5.3"
+  },
+  "scripts": {
+    "start": "react-scripts start",
+    "build": "react-scripts build",
+    "test": "react-scripts test",
+    "eject": "react-scripts eject"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  }
+}
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/public/favicon.ico b/starter-templates/ocjs-create-react-app-web-and-service-worker/public/favicon.ico
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/public/index.html b/starter-templates/ocjs-create-react-app-web-and-service-worker/public/index.html
@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta name="description" content="Web site created using create-react-app" />
+    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <!--
+      manifest.json provides metadata used when your web app is installed on a
+      user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
+    -->
+    <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
+    <!--
+      Notice the use of %PUBLIC_URL% in the tags above.
+      It will be replaced with the URL of the `public` folder during the build.
+      Only files inside the `public` folder can be referenced from the HTML.
+
+      Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
+      work correctly both with client-side routing and a non-root public URL.
+      Learn how to configure a non-root public URL by running `npm run build`.
+    -->
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/public/logo192.png b/starter-templates/ocjs-create-react-app-web-and-service-worker/public/logo192.png
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/public/logo512.png b/starter-templates/ocjs-create-react-app-web-and-service-worker/public/logo512.png
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/public/manifest.json b/starter-templates/ocjs-create-react-app-web-and-service-worker/public/manifest.json
@@ -0,0 +1,25 @@
+{
+  "short_name": "React App",
+  "name": "Create React App Sample",
+  "icons": [
+    {
+      "src": "favicon.ico",
+      "sizes": "64x64 32x32 24x24 16x16",
+      "type": "image/x-icon"
+    },
+    {
+      "src": "logo192.png",
+      "type": "image/png",
+      "sizes": "192x192"
+    },
+    {
+      "src": "logo512.png",
+      "type": "image/png",
+      "sizes": "512x512"
+    }
+  ],
+  "start_url": ".",
+  "display": "standalone",
+  "theme_color": "#000000",
+  "background_color": "#ffffff"
+}
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/public/robots.txt b/starter-templates/ocjs-create-react-app-web-and-service-worker/public/robots.txt
@@ -0,0 +1,3 @@
+# https://www.robotstxt.org/robotstxt.html
+User-agent: *
+Disallow:
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/src/App.css b/starter-templates/ocjs-create-react-app-web-and-service-worker/src/App.css
@@ -0,0 +1,29 @@
+.App {
+  text-align: center;
+}
+
+.App-logo {
+  width: 25vw;
+  pointer-events: none;
+}
+
+.App-header {
+  background-color: #18191a;
+  min-height: 100vh;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+  justify-content: center;
+  font-size: calc(10px + 2vmin);
+  color: white;
+}
+
+.App-link {
+  color: #b39b00;
+}
+
+.App-viewport {
+  margin-top: 25px;
+  width: 500px;
+  height: 500px;
+}
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/src/App.test.tsx b/starter-templates/ocjs-create-react-app-web-and-service-worker/src/App.test.tsx
@@ -0,0 +1,9 @@
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import App from './App';
+
+test('renders learn opencascade.js link', () => {
+  render(<App />);
+  const linkElement = screen.getByText(/learn opencascade.js/i);
+  expect(linkElement).toBeInTheDocument();
+});
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/src/App.tsx b/starter-templates/ocjs-create-react-app-web-and-service-worker/src/App.tsx
@@ -0,0 +1,58 @@
+import { useEffect, useMemo, useState } from "react";
+import "./App.css";
+import "@google/model-viewer";
+
+declare global {
+  namespace JSX {
+    interface IntrinsicElements {
+      'model-viewer': ModelViewerJSX & React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> ;
+    }
+  }
+}
+
+interface ModelViewerJSX {
+  src: string
+  poster?: string
+  class?: string
+  // ... others
+}
+
+function App() {
+  const [modelUrl, setModelUrl] = useState<string>();
+  const worker = useMemo(() => new Worker(new URL('./openCascadeWorker.ts', import.meta.url)), []);
+
+  useEffect(() => {
+    worker.onmessage = ({ data }) => {
+      setModelUrl(data);
+      return () => worker.terminate();
+    }
+  }, [worker]);
+
+  return (
+    <div className="App">
+      <header className="App-header">
+        <img className="App-logo" src="https://github.com/donalffons/opencascade.js/raw/master/images/logo.svg" alt="Ocjs Logo" />
+        <p>
+          Edit <code>src/App.js</code> and save to reload.
+        </p>
+        <a
+          className="App-link"
+          href="https://ocjs.org/docs/about"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          Learn OpenCascade.js
+        </a>
+        {modelUrl === undefined ? (
+          <p>
+            Loading...
+          </p>
+        ) : (
+          <model-viewer class="App-viewport" src={modelUrl} camera-controls />
+        )}
+      </header>
+    </div>
+  );
+}
+
+export default App;
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/src/index.css b/starter-templates/ocjs-create-react-app-web-and-service-worker/src/index.css
@@ -0,0 +1,13 @@
+body {
+  margin: 0;
+  font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen',
+    'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue',
+    sans-serif;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+}
+
+code {
+  font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New',
+    monospace;
+}
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/src/index.tsx b/starter-templates/ocjs-create-react-app-web-and-service-worker/src/index.tsx
@@ -0,0 +1,28 @@
+import React from 'react';
+import ReactDOM from 'react-dom/client';
+import './index.css';
+import App from './App';
+import * as serviceWorkerRegistration from './serviceWorkerRegistration';
+import reportWebVitals from './reportWebVitals';
+
+const root = ReactDOM.createRoot(
+  document.getElementById('root') as HTMLElement
+);
+root.render(
+  <React.StrictMode>
+    <App />
+  </React.StrictMode>
+);
+
+// Opt into this service worker to cache the open cascade wasm file in a production build.
+// |
+// V
+// If you want your app to work offline and load faster, you can change
+// unregister() to register() below. Note this comes with some pitfalls.
+// Learn more about service workers: https://cra.link/PWA
+serviceWorkerRegistration.register();
+
+// If you want to start measuring performance in your app, pass a function
+// to log results (for example: reportWebVitals(console.log))
+// or send to an analytics endpoint. Learn more: https://bit.ly/CRA-vitals
+reportWebVitals();
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/src/logo.svg b/starter-templates/ocjs-create-react-app-web-and-service-worker/src/logo.svg
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/src/openCascadeWorker.ts b/starter-templates/ocjs-create-react-app-web-and-service-worker/src/openCascadeWorker.ts
@@ -0,0 +1,44 @@
+import initOpenCascade, { TopoDS_Shape } from "opencascade.js";
+import shapeToUrl from "./shapeToUrl";
+
+/* eslint-disable no-restricted-globals */
+
+initOpenCascade().then(oc => {
+  const sphere = new oc.BRepPrimAPI_MakeSphere_1(1);
+
+  // Take shape and subtract a translated and scaled sphere from it
+  const makeCut = (shape: TopoDS_Shape, translation: [number, number, number], scale: number) => {
+    const tf = new oc.gp_Trsf_1();
+    tf.SetTranslation_1(new oc.gp_Vec_4(translation[0], translation[1], translation[2]));
+    tf.SetScaleFactor(scale);
+    const loc = new oc.TopLoc_Location_2(tf);
+
+    const cut = new oc.BRepAlgoAPI_Cut_3(shape, sphere.Shape().Moved(loc, false), new oc.Message_ProgressRange_1());
+    cut.Build(new oc.Message_ProgressRange_1());
+
+    return cut.Shape();
+  };
+
+  // Let's make some cuts
+  const cut1 = makeCut(sphere.Shape(), [0, 0, 0.7], 1);
+  const cut2 = makeCut(cut1, [0, 0, -0.7], 1);
+  const cut3 = makeCut(cut2, [0, 0.25, 1.75], 1.825);
+  const cut4 = makeCut(cut3, [4.8, 0, 0], 5);
+
+  // Rotate around the Z axis
+  const makeRotation = (rotation: number) => {
+    const tf = new oc.gp_Trsf_1();
+    tf.SetRotation_1(new oc.gp_Ax1_2(new oc.gp_Pnt_1(), new oc.gp_Dir_4(0, 0, 1)), rotation);
+    const loc = new oc.TopLoc_Location_2(tf);
+    return loc;
+  };
+
+  // Combine the result
+  const fuse = new oc.BRepAlgoAPI_Fuse_3(cut4, cut4.Moved(makeRotation(Math.PI), false), new oc.Message_ProgressRange_1());
+  fuse.Build(new oc.Message_ProgressRange_1());
+  const result = fuse.Shape().Moved(makeRotation(-30 * Math.PI / 180), false);
+
+  self.postMessage(shapeToUrl(oc, result));
+});
+
+export {}
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/src/react-app-env.d.ts b/starter-templates/ocjs-create-react-app-web-and-service-worker/src/react-app-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="react-scripts" />
diff --git a/starter-templates/ocjs-create-react-app-web-and-service-worker/src/reportWebVitals.ts b/starter-templates/ocjs-create-react-app-web-and-service-worker/src/reportWebVitals.ts
@@ -0,0 +1,15 @@
+import { ReportHandler } from 'web-vitals';
+
+const reportWebVitals = (onPerfEntry?: ReportHandler) => {
+  if (onPerfEntry && onPerfEntry instanceof Function) {
+    import('web-vitals').then(({ getCLS, getFID, getFCP, getLCP, getTTFB }) => {
+      getCLS(onPerfEntry);
+      getFID(onPerfEntry);
+      getFCP(onPerfEntry);
+      getLCP(onPerfEntry);
+      getTTFB(onPerfEntry);
+    });
+  }
+};
+
+export default reportWebVitals;