Cut release v0.19.1 (#2240)

Co-authored-by: Kurt Hutten <k.hutten@protonmail.ch>

.codespellrc

@@ -0,0 +1,3 @@
+[codespell]
+ignore-words-list: crate,everytime,inout,co-ordinate,ot,nwo,absolutey,atleast
+skip: **/target,node_modules,build,**/Cargo.lock,./docs/kcl/*.md,./src-tauri/gen/schemas

.env.development

@@ -1,7 +1,5 @@
-VITE_KC_API_WS_MODELING_URL=wss://api.dev.kittycad.io/ws/modeling/commands
-VITE_KC_API_BASE_URL=https://api.dev.kittycad.io
-VITE_KC_SITE_BASE_URL=https://dev.kittycad.io
+VITE_KC_API_WS_MODELING_URL=wss://api.dev.zoo.dev/ws/modeling/commands
+VITE_KC_API_BASE_URL=https://api.dev.zoo.dev
+VITE_KC_SITE_BASE_URL=https://dev.zoo.dev
 VITE_KC_SKIP_AUTH=false
 VITE_KC_CONNECTION_TIMEOUT_MS=5000
-VITE_KC_CONNECTION_WEBRTC_REPORT_STATS_MS=0
-VITE_KC_SENTRY_DSN=

.env.production

@@ -1,7 +1,5 @@
-VITE_KC_API_WS_MODELING_URL=wss://api.kittycad.io/ws/modeling/commands
-VITE_KC_API_BASE_URL=https://api.kittycad.io
-VITE_KC_SITE_BASE_URL=https://kittycad.io
+VITE_KC_API_WS_MODELING_URL=wss://api.zoo.dev/ws/modeling/commands
+VITE_KC_API_BASE_URL=https://api.zoo.dev
+VITE_KC_SITE_BASE_URL=https://zoo.dev
 VITE_KC_SKIP_AUTH=false
 VITE_KC_CONNECTION_TIMEOUT_MS=15000
-VITE_KC_CONNECTION_WEBRTC_REPORT_STATS_MS=30000
-VITE_KC_SENTRY_DSN=https://a814f2f66734989a90367f48feee28ca@o1042111.ingest.sentry.io/4505789425844224

.eslintignore

@@ -1 +1,2 @@
-src/wasm-lib/pkg/wasm_lib.js
+src/wasm-lib/*
+*.typegen.ts

.eslintrc

@@ -1,4 +1,8 @@
 {
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+      "project": "./tsconfig.json"
+    },
     "plugins": [
       "css-modules"
     ],
@@ -11,6 +15,16 @@
       "semi": [
         "error",
         "never"
-      ]
-    }
+      ],
+      "react-hooks/exhaustive-deps": "off",
+    },
+    "overrides": [
+      {
+        "files": ["e2e/**/*.ts"], // Update the pattern based on your file structure
+        "rules": {
+          "@typescript-eslint/no-floating-promises": "warn",
+          "testing-library/prefer-screen-queries": "off"
+        }
+      }
+    ]
 }

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,85 @@
+name: Bug Report
+description: File a bug report for the Zoo Modeling App
+title: "[BUG]: "
+labels: ["bug"]
+assignees: []
+body:
+  - type: markdown
+    attributes:
+      value: "Thank you for taking the time to report a bug. Please provide as much information as possible to help us resolve it."
+
+  - type: textarea
+    id: describe-bug
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+      placeholder: "Explain the bug..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: reproduce-bug
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: Description of what you expected to happen.
+      placeholder: "I expected that..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots and Recordings 
+      description: If applicable, add screenshots to help explain your problem. Maximum upload size is 10MB.
+      placeholder: "You can attach images or video recordings here."
+    validations:
+      required: false
+
+  - type: input
+    id: desktop-os
+    attributes:
+      label: Desktop OS
+      description: "Your operating system"
+      placeholder: "example: Windows 10, MacOS Big Sur"
+    validations:
+      required: true
+
+  - type: input
+    id: browser
+    attributes:
+      label: Browser
+      description: "If you are using the web version, please specify the browser you are using."
+      placeholder: "example: Chrome, Safari"
+    validations:
+      required: false
+
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: "The version of the Zoo Modeling App you're using."
+      placeholder: "example: v0.15.0. You can find this in the settings."
+    validations:
+      required: true
+
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional Context
+      description: Add any other context about the problem here.
+      placeholder: "Anything else you want to add..."
+    validations:
+      required: false

.github/dependabot.yml

@@ -9,15 +9,27 @@ updates:
       directory: '/' # Location of package manifests
       schedule:
           interval: 'daily'
+      reviewers:
+          - franknoirot 
+          - irev-dev
     - package-ecosystem: 'github-actions' # See documentation for possible values
       directory: '/' # Location of package manifests
       schedule:
           interval: 'daily'
+      reviewers:
+          - adamchalmers
+          - jessfraz
     - package-ecosystem: 'cargo' # See documentation for possible values
       directory: '/src/wasm-lib/' # Location of package manifests
       schedule:
           interval: 'daily'
+      reviewers:
+          - adamchalmers
+          - jessfraz
     - package-ecosystem: 'cargo' # See documentation for possible values
       directory: '/src-tauri/' # Location of package manifests
       schedule:
           interval: 'daily'
+      reviewers:
+          - adamchalmers
+          - jessfraz

.github/workflows/build-and-store-wasm.yml

@@ -0,0 +1,35 @@
+name: Build and Store WASM
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-and-upload:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+      - name: Install dependencies
+        run: yarn
+      - name: Install Playwright Browsers
+        run: yarn playwright install --with-deps
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@stable
+      - name: Cache wasm
+        uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: './src/wasm-lib'
+      - name: build wasm
+        run: yarn build:wasm
+
+
+      # Upload the WASM bundle as an artifact
+      - uses: actions/upload-artifact@v2
+        with:
+          name: wasm-bundle
+          path: src/wasm-lib/pkg

.github/workflows/cargo-bench.yml

@@ -0,0 +1,42 @@
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '**.rs'
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
+      - '**/rust-toolchain.toml'
+      - .github/workflows/cargo-bench.yml
+  pull_request:
+    paths:
+      - '**.rs'
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
+      - '**/rust-toolchain.toml'
+      - .github/workflows/cargo-bench.yml
+  workflow_dispatch:
+permissions: read-all
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+name: cargo bench
+jobs:
+  cargo-bench:
+    name: Benchmark with iai
+    runs-on: ubuntu-latest-8-cores
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - name: Install dependencies
+        run: |
+          cargo install cargo-criterion
+          sudo apt update
+          sudo apt install -y valgrind
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2.6.1
+      - name: Benchmark kcl library
+        shell: bash
+        run: |-
+          cd src/wasm-lib/kcl; cargo bench -- iai
+

.github/workflows/cargo-build.yml

@@ -1,47 +0,0 @@
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - '**.rs'
-      - '**/Cargo.toml'
-      - '**/Cargo.lock'
-      - '**/rust-toolchain.toml'
-      - .github/workflows/cargo-build.yml
-  pull_request:
-    paths:
-      - '**.rs'
-      - '**/Cargo.toml'
-      - '**/Cargo.lock'
-      - '**/rust-toolchain.toml'
-      - .github/workflows/cargo-build.yml
-name: cargo build
-jobs:
-  cargobuild:
-    name: cargo build
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        dir: ['src/wasm-lib']
-    steps:
-      - uses: actions/checkout@v3
-
-      - name: Install latest rust
-        uses: actions-rs/toolchain@v1
-        with:
-            toolchain: stable
-            override: true
-
-      - name: install dependencies
-        if: matrix.dir ==  'src-tauri'
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev libappindicator3-dev librsvg2-dev patchelf
-      - name: Rust Cache
-        uses: Swatinem/rust-cache@v2.6.1
-
-      - name: Run cargo build
-        run: |
-          cd "${{ matrix.dir }}"
-          cargo build --all
-        shell: bash

.github/workflows/cargo-clippy.yml

@@ -9,12 +9,9 @@ on:
       - '**.rs'
       - .github/workflows/cargo-clippy.yml
   pull_request:
-    paths:
-      - '**/Cargo.toml'
-      - '**/Cargo.lock'
-      - '**/rust-toolchain.toml'
-      - '**.rs'
-      - .github/workflows/cargo-build.yml
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
 name: cargo clippy
 jobs:
   cargoclippy:
@@ -22,9 +19,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        dir: ['src/wasm-lib']
+        dir: ['src/wasm-lib', 'src-tauri']
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install latest rust
         uses: actions-rs/toolchain@v1
         with:
@@ -34,13 +31,26 @@ jobs:
 
       - name: install dependencies
         if: matrix.dir ==  'src-tauri'
+        shell: bash
         run: |
           sudo apt-get update
-          sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev libappindicator3-dev librsvg2-dev patchelf
+          sudo apt-get install -y \
+            libgtk-3-dev \
+            libayatana-appindicator3-dev \
+            webkit2gtk-driver \
+            libsoup-3.0-dev \
+            libjavascriptcoregtk-4.1-dev \
+            libwebkit2gtk-4.1-dev \
+            at-spi2-core \
+            xvfb
+          yarn install
+          yarn build:wasm
+          yarn build:local
+
       - name: Rust Cache
         uses: Swatinem/rust-cache@v2.6.1
 
       - name: Run clippy
         run: |
           cd "${{ matrix.dir }}"
-          cargo clippy --all --tests -- -D warnings
+          cargo clippy --all --tests --benches -- -D warnings

.github/workflows/cargo-fmt.yml

@@ -18,6 +18,9 @@ on:
 permissions:
   packages: read
   contents: read
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
 name: cargo fmt
 jobs:
   cargofmt:
@@ -27,7 +30,7 @@ jobs:
       matrix:
         dir: ['src/wasm-lib', 'src-tauri']
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install latest rust
         uses: actions-rs/toolchain@v1
         with:

.github/workflows/cargo-test-tauri.yml

@@ -0,0 +1,57 @@
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'src-tauri/**.rs'
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
+      - '**/rust-toolchain.toml'
+      - .github/workflows/cargo-test-tauri.yml
+  pull_request:
+    paths:
+      - 'src-tauri/**.rs'
+      - '**/Cargo.toml'
+      - '**/Cargo.lock'
+      - '**/rust-toolchain.toml'
+      - .github/workflows/cargo-test-tauri.yml
+  workflow_dispatch:
+permissions: read-all
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+name: cargo test of tauri
+jobs:
+  cargotest:
+    name: cargo test
+    runs-on: ubuntu-latest-8-cores
+    strategy:
+      matrix:
+        dir: ['src-tauri']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install latest rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+      - name: install dependencies
+        if: matrix.dir ==  'src-tauri'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            libgtk-3-dev \
+            libayatana-appindicator3-dev \
+            webkit2gtk-driver \
+            libsoup-3.0-dev \
+            libjavascriptcoregtk-4.1-dev \
+            libwebkit2gtk-4.1-dev \
+            at-spi2-core \
+            xvfb
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2.6.1
+      - name: cargo test
+        shell: bash
+        run: |-
+          cd "${{ matrix.dir }}"
+          cargo test --all

.github/workflows/cargo-test.yml

@@ -3,21 +3,25 @@ on:
     branches:
       - main
     paths:
-      - '**.rs'
+      - 'src/wasm-lib/**.rs'
       - '**/Cargo.toml'
       - '**/Cargo.lock'
       - '**/rust-toolchain.toml'
       - .github/workflows/cargo-test.yml
+
   pull_request:
     paths:
-      - '**.rs'
+      - 'src/wasm-lib/**.rs'
       - '**/Cargo.toml'
       - '**/Cargo.lock'
       - '**/rust-toolchain.toml'
       - .github/workflows/cargo-test.yml
   workflow_dispatch:
 permissions: read-all
-name: cargo test
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+name: cargo test of wasm-lib
 jobs:
   cargotest:
     name: cargo test
@@ -26,7 +30,7 @@ jobs:
       matrix:
         dir: ['src/wasm-lib']
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install latest rust
         uses: actions-rs/toolchain@v1
         with:
@@ -37,6 +41,20 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev libappindicator3-dev librsvg2-dev patchelf
+      - name: Install vector
+        run: |
+          curl --proto '=https' --tlsv1.2 -sSfL https://sh.vector.dev > /tmp/vector.sh
+          chmod +x /tmp/vector.sh
+          /tmp/vector.sh -y -no-modify-path
+          mkdir -p /tmp/vector
+          cp .github/workflows/vector.toml /tmp/vector.toml
+          sed -i "s#GITHUB_WORKFLOW#${GITHUB_WORKFLOW}#g" /tmp/vector.toml
+          sed -i "s#GITHUB_REPOSITORY#${GITHUB_REPOSITORY}#g" /tmp/vector.toml
+          sed -i "s#GITHUB_SHA#${GITHUB_SHA}#g" /tmp/vector.toml
+          sed -i "s#GITHUB_REF_NAME#${GITHUB_REF_NAME}#g" /tmp/vector.toml
+          sed -i "s#GH_ACTIONS_AXIOM_TOKEN#${{secrets.GH_ACTIONS_AXIOM_TOKEN}}#g" /tmp/vector.toml
+          cat /tmp/vector.toml
+          ${HOME}/.vector/bin/vector --config /tmp/vector.toml &
       - uses: taiki-e/install-action@cargo-llvm-cov
       - uses: taiki-e/install-action@nextest
       - name: Rust Cache
@@ -45,7 +63,16 @@ jobs:
         shell: bash
         run: |-
           cd "${{ matrix.dir }}"
-          cargo test --all
+          cargo llvm-cov nextest --all --lcov --output-path lcov.info --test-threads=1 --no-fail-fast -P ci 2>&1 | tee /tmp/github-actions.log
         env:
           KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
+          RUST_MIN_STACK: 10485760000
+      - name: Upload to codecov.io
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{secrets.CODECOV_TOKEN}}
+          fail_ci_if_error: true
+          flags: wasm-lib
+          verbose: true
+          files: lcov.info
 

.github/workflows/check-exampleKcl.yml

@@ -0,0 +1,36 @@
+name: Check Onboarding KCL
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+    paths:
+      - 'src/lib/exampleKcl.ts'
+
+permissions:
+  contents: read
+  issues: write
+  pull-requests: write
+
+jobs:
+  comment:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Comment on PR
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const message = '`src/lib/exampleKcl.ts` has been updated in this PR, please review and update the `src/routes/onboarding`, if needed.';
+            const issue_number = context.payload.pull_request.number;
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+
+            // Post a comment on the PR
+            await github.rest.issues.createComment({
+              owner,
+              repo,
+              issue_number,
+              body: message,
+            });

.github/workflows/ci.yml

@@ -1,164 +1,320 @@
-name: CI 
+name: CI
 
 on:
   pull_request:
   push:
     branches:
-        - main
+      - main
   release:
     types: [published]
+  schedule:
+    - cron: '0 4 * * *'
+  # Daily at 04:00 AM UTC
+  # Will checkout the last commit from the default branch (main as of 2023-10-04)
+
+env:
+  BUILD_RELEASE: ${{ github.event_name == 'release' || github.event_name == 'schedule' || github.event_name == 'pull_request' && contains(github.event.pull_request.title, 'Cut release v') }}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
 
 jobs:
-
   check-format:
-    runs-on: 'ubuntu-20.04'
+    runs-on: 'ubuntu-latest'
     steps:
-
-      - uses: actions/checkout@v3
-
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
-
+          cache: 'yarn'
       - run: yarn install
-
       - run: yarn fmt-check
 
+  check-types:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+      - run: yarn install
+      - uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: './src/wasm-lib'
+
+      - run: yarn build:wasm
+      - run: yarn xstate:typegen
+      - run: yarn tsc
+
+
+  check-typos:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+      - name: Install codespell
+        run: |
+            python -m pip install codespell
+      - name: Run codespell
+        run: codespell --config .codespellrc # Edit this file to tweak the typo list and other configuration.
+
 
   build-test-web:
-    runs-on: ubuntu-20.04
-    outputs:
-      version: ${{ steps.export_version.outputs.version }}
+    runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v4
 
-      - uses: actions/checkout@v3
-
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
+          cache: 'yarn'
 
       - run: yarn install
 
-      - run: yarn build:wasm
+      - uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: './src/wasm-lib'
 
-      - run: yarn tsc
+      - run: yarn build:wasm
 
       - run: yarn simpleserver:ci
 
       - run: yarn test:nowatch
 
-      - run: yarn test:cov
 
-      - run: yarn test:rust
-      
+  prepare-json-files:
+    runs-on: ubuntu-latest  # seperate job on Ubuntu for easy string manipulations (compared to Windows)
+    outputs:
+      version: ${{ steps.export_version.outputs.version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+
+      - name: Set nightly version
+        if: github.event_name == 'schedule'
+        run: |
+          VERSION=$(date +'%-y.%-m.%-d') yarn bump-jsons
+          echo "$(jq --arg url 'https://dl.zoo.dev/releases/modeling-app/nightly/last_update.json' \
+            '.plugins.updater.endpoints[]=$url' src-tauri/tauri.release.conf.json --indent 2)" > src-tauri/tauri.release.conf.json
+          echo "$(jq --arg id 'dev.zoo.modeling-app-nightly' \
+            '.identifier=$id' src-tauri/tauri.release.conf.json --indent 2)" > src-tauri/tauri.release.conf.json
+          echo "$(jq --arg name 'Zoo Modeling App (Nightly)' \
+            '.productName=$name' src-tauri/tauri.release.conf.json --indent 2)" > src-tauri/tauri.release.conf.json
+
+      - uses: actions/upload-artifact@v3
+        if: github.event_name == 'schedule'
+        with:
+          path: |
+            package.json
+            src-tauri/tauri.conf.json
+            src-tauri/tauri.release.conf.json
+
       - id: export_version
         run: echo "version=`cat package.json | jq -r '.version'`" >> "$GITHUB_OUTPUT"
 
 
-  build-apps:
-    needs: [check-format, build-test-web]
+  build-test-apps:
+    needs: [prepare-json-files]
     runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
-        os: [macos-latest, ubuntu-20.04, windows-latest]
+        os: [macos-14, ubuntu-latest, windows-latest]
+    env:
+      TAURI_ARGS_MACOS: ${{ matrix.os == 'macos-14' && '--target universal-apple-darwin' || '' }}
+      TAURI_ARGS_UBUNTU: ${{ matrix.os == 'ubuntu-latest' && '--bundles' || '' }}
     steps:
+      - uses: actions/checkout@v4
 
-      - uses: actions/checkout@v3
+      - uses: actions/download-artifact@v3
 
-      - name: install ubuntu system dependencies
-        if: matrix.os == 'ubuntu-20.04'
+      - name: Copy updated .json files
+        if: github.event_name == 'schedule'
+        run: |
+          ls -l artifact
+          cp artifact/package.json package.json
+          cp artifact/src-tauri/tauri.conf.json src-tauri/tauri.conf.json
+          cp artifact/src-tauri/tauri.release.conf.json src-tauri/tauri.release.conf.json
+
+      - name: Install ubuntu system dependencies
+        if: matrix.os == 'ubuntu-latest'
         run: |
           sudo apt-get update
-          sudo apt-get install -y libgtk-3-dev libwebkit2gtk-4.0-dev libayatana-appindicator3-dev librsvg2-dev
+          sudo apt-get install -y \
+            libgtk-3-dev \
+            libayatana-appindicator3-dev \
+            webkit2gtk-driver \
+            libsoup-3.0-dev \
+            libjavascriptcoregtk-4.1-dev \
+            libwebkit2gtk-4.1-dev \
+            at-spi2-core \
+            xvfb
 
       - name: Sync node version and setup cache
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
           cache: 'yarn' # Set this to npm, yarn or pnpm.
 
       - run: yarn install
 
-      - name: Rust setup
+      - name: Setup Rust
         uses: dtolnay/rust-toolchain@stable
 
-      - name: Rust cache
+      # TODO: re-enable for Windows builds, see https://github.com/tauri-apps/tauri/issues/9045
+      - name: Setup Rust cache
+        if: matrix.os != 'windows-latest'
         uses: swatinem/rust-cache@v2
         with:
           workspaces: './src-tauri -> target'
 
-      - name: wasm prep
+      - uses: Swatinem/rust-cache@v2
+        with:
+          workspaces: './src/wasm-lib'
+
+      - name: Run build:wasm manually
         shell: bash
+        env:
+          MODE: ${{ env.BUILD_RELEASE == 'true' && '--release' || '--debug' }}
         run: |
           mkdir src/wasm-lib/pkg; cd src/wasm-lib
-          npx wasm-pack build --target web --out-dir pkg
+          echo "building with ${{ env.MODE }}"
+          npx wasm-pack build --target web --out-dir pkg ${{ env.MODE }}
           cd ../../
           cp src/wasm-lib/pkg/wasm_lib_bg.wasm public
 
-      - name: macos sed
-        if: matrix.os == 'macos-latest'
-        shell: bash
-        run: |
-          sed -i '' 's/import.meta.url//g' "./src/wasm-lib/pkg/wasm_lib.js"
-
-      - name: ubuntu and windows sed
-        if: matrix.os != 'macos-latest'
-        shell: bash
-        run: |
-          sed -i 's/import.meta.url//g' "./src/wasm-lib/pkg/wasm_lib.js"
+      - name: Run vite build (build:both)
+        run: yarn vite build --mode ${{ env.BUILD_RELEASE == 'true' && 'production' || 'development' }}
 
       - name: Fix format
         run: yarn fmt
 
-      - name: Build the app for the current platform (no upload)
+      - name: Install x86 target for Universal builds (MacOS only)
+        if: matrix.os == 'macos-14'
+        run: |
+          rustup target add x86_64-apple-darwin
+
+      - name: Prepare certificate and variables (Windows only)
+        if: ${{ matrix.os == 'windows-latest' && env.BUILD_RELEASE == 'true' }}
+        run: |
+          echo "${{secrets.SM_CLIENT_CERT_FILE_B64 }}" | base64 --decode > /d/Certificate_pkcs12.p12
+          cat /d/Certificate_pkcs12.p12
+          echo "::set-output name=version::${GITHUB_REF#refs/tags/v}"
+          echo "SM_HOST=${{ secrets.SM_HOST }}" >> "$GITHUB_ENV"
+          echo "SM_API_KEY=${{ secrets.SM_API_KEY }}" >> "$GITHUB_ENV"
+          echo "SM_CLIENT_CERT_FILE=D:\\Certificate_pkcs12.p12" >> "$GITHUB_ENV"
+          echo "SM_CLIENT_CERT_PASSWORD=${{ secrets.SM_CLIENT_CERT_PASSWORD }}" >> "$GITHUB_ENV"
+          echo "C:\Program Files (x86)\Windows Kits\10\App Certification Kit" >> $GITHUB_PATH
+          echo "C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.8 Tools" >> $GITHUB_PATH
+          echo "C:\Program Files\DigiCert\DigiCert One Signing Manager Tools" >> $GITHUB_PATH
+        shell: bash
+
+      - name: Setup certicate with SSM KSP (Windows only)
+        if: ${{ matrix.os == 'windows-latest' && env.BUILD_RELEASE == 'true' }}
+        run: |
+          curl -X GET  https://one.digicert.com/signingmanager/api-ui/v1/releases/smtools-windows-x64.msi/download -H "x-api-key:%SM_API_KEY%" -o smtools-windows-x64.msi
+          msiexec /i smtools-windows-x64.msi /quiet /qn
+          smksp_registrar.exe list
+          smctl.exe keypair ls
+          C:\Windows\System32\certutil.exe -csp "DigiCert Signing Manager KSP" -key -user
+          smksp_cert_sync.exe
+        shell: cmd
+
+      - name: Build the app (debug)
         uses: tauri-apps/tauri-action@v0
+        if: ${{ env.BUILD_RELEASE == 'false' }}
+        with:
+          includeRelease: false
+          includeDebug: true
+          args: "${{ env.TAURI_ARGS_MACOS }} ${{ env.TAURI_ARGS_UBUNTU }}"
+
+      - name: Build the app (release) and sign
+        uses: tauri-apps/tauri-action@v0
+        if: ${{ env.BUILD_RELEASE == 'true' }}
         env:
-          TAURI_PRIVATE_KEY: ${{ secrets.TAURI_PRIVATE_KEY }}
-          TAURI_KEY_PASSWORD: ${{ secrets.TAURI_KEY_PASSWORD }}
+          TAURI_SIGNING_PRIVATE_KEY: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY }}
+          TAURI_SIGNING_PRIVATE_KEY_PASSWORD: ${{ secrets.TAURI_SIGNING_PRIVATE_KEY_PASSWORD }}
+          APPLE_CERTIFICATE: ${{ secrets.APPLE_CERTIFICATE }}
+          APPLE_CERTIFICATE_PASSWORD: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }}
+          APPLE_SIGNING_IDENTITY: ${{ secrets.APPLE_SIGNING_IDENTITY }}
+          APPLE_ID: ${{ secrets.APPLE_ID }}
+          APPLE_PASSWORD: ${{ secrets.APPLE_PASSWORD }}
+          APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID }}
+          TAURI_CONF_ARGS: "--config ${{ matrix.os == 'windows-latest' && 'src-tauri\\tauri.release.conf.json' || 'src-tauri/tauri.release.conf.json' }}"
+        with:
+          args: "${{ env.TAURI_CONF_ARGS }} ${{ env.TAURI_ARGS_MACOS }} ${{ env.TAURI_ARGS_UBUNTU }}"
 
       - uses: actions/upload-artifact@v3
+        if: matrix.os != 'ubuntu-latest'
+        env:
+          PREFIX: ${{ matrix.os == 'macos-14' && 'src-tauri/target/universal-apple-darwin' || 'src-tauri/target' }}
+          MODE: ${{ env.BUILD_RELEASE == 'true' && 'release' || 'debug' }}
         with:
-          path: src-tauri/target/release/bundle/*/*
+          path: "${{ env.PREFIX }}/${{ env.MODE }}/bundle/*/*"
+
+      # TODO: re-enable linux e2e tests when possible
+      - name: Run e2e tests (linux only)
+        if: false
+        run: |
+          cargo install tauri-driver
+          source .env.${{ env.BUILD_RELEASE == 'true' && 'production' || 'development' }}
+          export VITE_KC_API_BASE_URL
+          xvfb-run yarn test:e2e:tauri
+        env:
+          E2E_APPLICATION: "./src-tauri/target/${{ env.BUILD_RELEASE == 'true' && 'release' || 'debug' }}/zoo-modeling-app"
+          KITTYCAD_API_TOKEN: ${{ env.BUILD_RELEASE == 'true' && secrets.KITTYCAD_API_TOKEN || secrets.KITTYCAD_API_TOKEN_DEV }}
 
 
   publish-apps-release:
-    runs-on: ubuntu-20.04
-    if: github.event_name == 'release'
-    permissions:
-      contents: write
-    needs: [build-test-web, build-apps]
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'release' || github.event_name == 'schedule' }}
+    needs: [check-format, check-types, check-typos, build-test-web, prepare-json-files, build-test-apps]
     env:
-      VERSION_NO_V: ${{ needs.build-test-web.outputs.version }}
+      VERSION_NO_V: ${{ needs.prepare-json-files.outputs.version }}
+      VERSION: ${{ github.event_name == 'release' && format('v{0}', needs.prepare-json-files.outputs.version) || needs.prepare-json-files.outputs.version }}
+      PUB_DATE: ${{ github.event_name == 'release' && github.event.release.created_at || github.event.repository.updated_at }}
+      NOTES: ${{ github.event_name == 'release' && github.event.release.body || format('Nightly build, commit {0}', github.sha) }}
+      BUCKET_DIR: ${{ github.event_name == 'release' && 'dl.kittycad.io/releases/modeling-app' || 'dl.kittycad.io/releases/modeling-app/nightly' }}
+      WEBSITE_DIR: ${{ github.event_name == 'release' && 'dl.zoo.dev/releases/modeling-app' || 'dl.zoo.dev/releases/modeling-app/nightly' }}
+      URL_CODED_NAME: ${{ github.event_name == 'schedule' && 'Zoo%20Modeling%20App%20%28Nightly%29' || 'Zoo%20Modeling%20App' }}
     steps:
-
       - uses: actions/download-artifact@v3
 
       - name: Generate the update static endpoint
         run: |
-          ls -l artifact
-          ls -l artifact/*
+          ls -l artifact/*/*oo*
           DARWIN_SIG=`cat artifact/macos/*.app.tar.gz.sig`
-          LINUX_SIG=`cat artifact/appimage/*.AppImage.tar.gz.sig`
-          WINDOWS_SIG=`cat artifact/nsis/*.nsis.zip.sig`
-          RELEASE_DIR=https://dl.kittycad.io/releases/modeling-app/v${VERSION_NO_V}
+          WINDOWS_SIG=`cat artifact/msi/*.msi.zip.sig`
+          RELEASE_DIR=https://${WEBSITE_DIR}/${VERSION}
           jq --null-input \
-            --arg version "v${VERSION_NO_V}" \
+            --arg version "${VERSION}" \
+            --arg pub_date "${PUB_DATE}" \
+            --arg notes "${NOTES}" \
             --arg darwin_sig "$DARWIN_SIG" \
-            --arg darwin_url "$RELEASE_DIR/macos/kittycad-modeling-app.app.tar.gz" \
-            --arg linux_sig "$LINUX_SIG" \
-            --arg linux_url "$RELEASE_DIR/appimage/kittycad-modeling-app_${VERSION_NO_V}_amd64.AppImage.tar.gz" \
+            --arg darwin_url "$RELEASE_DIR/macos/${{ env.URL_CODED_NAME }}.app.tar.gz" \
             --arg windows_sig "$WINDOWS_SIG" \
-            --arg windows_url "$RELEASE_DIR/nsis/kittycad-modeling-app_${VERSION_NO_V}_x64-setup.nsis.zip" \
+            --arg windows_url "$RELEASE_DIR/msi/${{ env.URL_CODED_NAME }}_${VERSION_NO_V}_x64_en-US.msi.zip" \
             '{
               "version": $version,
+              "pub_date": $pub_date,
+              "notes": $notes,
               "platforms": {
                 "darwin-x86_64": {
                   "signature": $darwin_sig,
                   "url": $darwin_url
                 },
-                "linux-x86_64": {
-                  "signature": $linux_sig,
-                  "url": $linux_url
+                "darwin-aarch64": {
+                  "signature": $darwin_sig,
+                  "url": $darwin_url
                 },
                 "windows-x86_64": {
                   "signature": $windows_sig,
@@ -168,31 +324,87 @@ jobs:
             }' > last_update.json
             cat last_update.json
 
+      - name: Generate the download static endpoint
+        run: |
+          RELEASE_DIR=https://${WEBSITE_DIR}/${VERSION}
+          jq --null-input \
+            --arg version "${VERSION}" \
+            --arg pub_date "${PUB_DATE}" \
+            --arg notes "${NOTES}" \
+            --arg darwin_url "$RELEASE_DIR/dmg/${{ env.URL_CODED_NAME }}_${VERSION_NO_V}_universal.dmg" \
+            --arg windows_url "$RELEASE_DIR/msi/${{ env.URL_CODED_NAME }}_${VERSION_NO_V}_x64_en-US.msi" \
+            '{
+              "version": $version,
+              "pub_date": $pub_date,
+              "notes": $notes,
+              "platforms": {
+                "dmg-universal": {
+                  "url": $darwin_url
+                },
+                "msi-x86_64": {
+                  "url": $windows_url
+                }
+              }
+            }' > last_download.json
+            cat last_download.json
+
       - name: Authenticate to Google Cloud
-        uses: 'google-github-actions/auth@v1.1.1'
+        uses: 'google-github-actions/auth@v2.1.2'
         with:
           credentials_json: '${{ secrets.GOOGLE_CLOUD_DL_SA }}'
 
       - name: Set up Google Cloud SDK
-        uses: google-github-actions/setup-gcloud@v1.1.1
+        uses: google-github-actions/setup-gcloud@v2.1.0
         with:
           project_id: kittycadapi
-      
+
       - name: Upload release files to public bucket
-        uses: google-github-actions/upload-cloud-storage@v1.0.3
+        uses: google-github-actions/upload-cloud-storage@v2.1.0
         with:
           path: artifact
-          glob: '*/kittycad-modeling-app*'
+          glob: '*/Zoo*'
           parent: false
-          destination: dl.kittycad.io/releases/modeling-app/v${{ env.VERSION_NO_V }} 
-      
+          destination: ${{ env.BUCKET_DIR }}/${{ env.VERSION }}
+
       - name: Upload update endpoint to public bucket
-        uses: google-github-actions/upload-cloud-storage@v1.0.3
+        uses: google-github-actions/upload-cloud-storage@v2.1.0
         with:
           path: last_update.json
-          destination: dl.kittycad.io/releases/modeling-app
+          destination: ${{ env.BUCKET_DIR }}
+
+      - name: Upload download endpoint to public bucket
+        uses: google-github-actions/upload-cloud-storage@v2.1.0
+        with:
+          path: last_download.json
+          destination: ${{ env.BUCKET_DIR }}
 
       - name: Upload release files to Github
-        uses: softprops/action-gh-release@v1
+        if: ${{ github.event_name == 'release' }}
+        uses: softprops/action-gh-release@v2
         with:
-          files: artifact/*/kittycad-modeling-app*
+          files: 'artifact/*/Zoo*'
+
+  announce_release:
+    needs: [publish-apps-release]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release'
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install requests
+
+      - name: Announce Release
+        env:
+          DISCORD_WEBHOOK_URL: ${{ secrets.DISCORD_WEBHOOK_URL }}
+          RELEASE_VERSION: ${{ github.event.release.tag_name }}
+          RELEASE_BODY: ${{ github.event.release.body}}
+        run: python public/announce_release.py

.github/workflows/generate-website-docs.yml

@@ -0,0 +1,65 @@
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - .github/workflows/generate-website-docs.yml
+      - 'docs/**'
+  pull_request:
+    paths:
+      - .github/workflows/generate-website-docs.yml
+  workflow_dispatch:
+name: generate-website-docs
+concurrency:
+  group: docs-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  generate-website-docs:
+    name: generate-website-docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/create-github-app-token@v1
+        id: app-token
+        with:
+          # required
+          app-id: ${{ secrets.GH_ORG_APP_ID }}
+          private-key: ${{ secrets.GH_ORG_APP_PRIVATE_KEY }}
+          owner: ${{ github.repository_owner }}
+      # Checkout the docs repo since we will want to update the files there.
+      - uses: actions/checkout@v4
+        with:
+          repository: 'kittycad/documentation'
+          path: 'documentation'
+          token: ${{ steps.app-token.outputs.token }}
+      - name: move docs to docs
+        shell: bash
+        run: |
+          mkdir -p documentation/content/pages/docs/kcl/
+          # cleanup old
+          rm -rf documentation/content/pages/docs/kcl/*.md
+          # move new
+          mv -f docs/kcl/*.md documentation/content/pages/docs/kcl/
+      - name: commit the changes in the docs repo
+        shell: bash
+        run: |
+          cd documentation
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git add .
+          git commit -am "YOYO NEW KCL DOCS!!" || exit 0
+          git fetch origin
+          git rebase origin/main || exit 0
+          export NEW_BRANCH="update-kcl-docs"
+          git checkout -b "$NEW_BRANCH"
+          git push -f origin "$NEW_BRANCH"
+          gh pr create --title "Update KCL docs" \
+              --body "Updating the generated kcl docs cc @jessfraz @franknoirot merge this" \
+              --head "$NEW_BRANCH" \
+              --reviewer jessfraz \
+              --reviewer irev-dev \
+              --reviewer franknoirot \
+              --base main || true
+        env:
+          GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
+

.github/workflows/playwright.yml

@@ -0,0 +1,129 @@
+name: Playwright Tests
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  playwright-ubuntu:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest-8-cores
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version-file: '.nvmrc'
+        cache: 'yarn'
+    - uses: KittyCAD/action-install-cli@main
+    - name: Install dependencies
+      run: yarn
+    - name: Install Playwright Browsers
+      run: yarn playwright install --with-deps
+    - name: Setup Rust
+      uses: dtolnay/rust-toolchain@stable
+    - name: Cache wasm
+      uses: Swatinem/rust-cache@v2
+      with:
+        workspaces: './src/wasm-lib'
+    - name: build wasm
+      run: yarn build:wasm
+    - name: build web
+      run: yarn build:local
+    - name: Run ubuntu/chrome snapshots
+      run: yarn playwright test --project="Google Chrome" --update-snapshots e2e/playwright/snapshot-tests.spec.ts
+      env:
+        CI: true
+        token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
+        snapshottoken: ${{ secrets.KITTYCAD_API_TOKEN }}
+    - uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30
+    - name: check for changes
+      id: git-check
+      run: |
+          git add .
+          if git status | grep -q "Changes to be committed"
+          then
+            echo "::set-output name=modified::true"
+          else
+            echo "::set-output name=modified::false"
+          fi
+    - name: Commit changes, if any
+      if: steps.git-check.outputs.modified == 'true'
+      run: |
+        git add .
+        git config --local user.email "github-actions[bot]@users.noreply.github.com"
+        git config --local user.name "github-actions[bot]"
+        git remote set-url origin https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
+        git fetch origin
+        echo ${{ github.head_ref }}
+        git checkout ${{ github.head_ref }}
+        # TODO when safari works on ubuntu remove the os part of the commit message
+        git commit -am "A snapshot a day keeps the bugs away! 📷🐛 (OS: ubuntu)" || true
+        git push
+        git push origin ${{ github.head_ref }}
+    - name: Run ubuntu/chrome flow
+      run: yarn playwright test --project="Google Chrome" e2e/playwright/flow-tests.spec.ts
+      env:
+        CI: true
+        token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
+    - uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30
+
+  playwright-macos:
+    timeout-minutes: 60
+    runs-on: macos-14
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version-file: '.nvmrc'
+        cache: 'yarn'
+    - name: Install dependencies
+      run: yarn
+    - name: Install Playwright Browsers
+      run: yarn playwright install --with-deps
+    - name: Setup Rust
+      uses: dtolnay/rust-toolchain@stable
+    - name: Cache wasm
+      uses: Swatinem/rust-cache@v2
+      with:
+        workspaces: './src/wasm-lib'
+    - name: build wasm
+      run: yarn build:wasm
+    - name: build web
+      run: yarn build:local
+    - name: Run macos/safari flow
+      # safari doesn't work on Ubuntu because of the same reason tauri doesn't (webRTC issues)
+      # TODO remove this and the matrix and run all tests on ubuntu when this is fixed
+      run: yarn playwright test --project="webkit" e2e/playwright/flow-tests.spec.ts
+      env:
+        CI: true
+        token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
+    - uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: playwright-report
+        path: playwright-report/
+        retention-days: 30
+    - uses: actions/upload-artifact@v2
+      if: github.ref == 'refs/heads/main'
+      with:
+        name: wasm-bundle
+        path: src/wasm-lib/pkg

.github/workflows/update-dev-branch.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3.5.0
+      - uses: actions/checkout@v4
       - shell: bash
         run: |
           # checkout our branch

.github/workflows/vector.toml

@@ -0,0 +1,21 @@
+[sources.github-actions-file]
+type = "file"
+data_dir = "/tmp/vector"
+include = ["/tmp/github-actions.log"]
+
+# Modify the logs to include the action name.
+[transforms.add-action-name]
+type = "remap"
+inputs = [ "github-actions-file" ]
+source = '''
+.action = "GITHUB_WORKFLOW"
+.repo = "GITHUB_REPOSITORY"
+.sha = "GITHUB_SHA"
+.ref = "GITHUB_REF_NAME"
+'''
+
+[sinks.axiom]
+type = "axiom"
+inputs = ["add-action-name"]
+token = "GH_ACTIONS_AXIOM_TOKEN"
+dataset = "github-actions"

.gitignore

@@ -22,9 +22,35 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
+.idea
+.vscode
+src/wasm-lib/.idea
+src/wasm-lib/.vscode
+
 # rust
 src/wasm-lib/target
 src/wasm-lib/bindings
 src/wasm-lib/kcl/bindings
 public/wasm_lib_bg.wasm
 src/wasm-lib/lcov.info
+src/wasm-lib/grackle/test_json_output
+
+e2e/playwright/playwright-secrets.env
+e2e/playwright/temp1.png
+e2e/playwright/temp2.png
+# exports from snapshot-tests.spec.ts "exports of each format should work"
+e2e/playwright/export-snapshots/*
+!e2e/playwright/export-snapshots/*.png
+
+
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/
+
+
+## generated files
+src/**/*.typegen.ts
+src-tauri/gen
+
+src/wasm-lib/grackle/stdlib_cube_partial.json

.nvmrc

@@ -1 +1 @@
-v20.5.0
+v21.7.1

.prettierignore

@@ -5,3 +5,9 @@ coverage
 # Ignore Rust projects:
 *.rs
 target
+src/wasm-lib/pkg
+src/wasm-lib/kcl/bindings
+e2e/playwright/export-snapshots
+
+# XState generated files
+src/machines/**.typegen.ts

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 The Zoo Authors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,48 +1,73 @@
-## Kurt demo project
+![Zoo Modeling App](/public/zma-logomark-outlined.png)
 
-live at [app.kittycad.io](https://app.kittycad.io/)
+## Zoo Modeling App
 
-Not sure what to call this, it's both a language/interpreter and a UI that uses the language as the source of truth model the user build with direct-manipulation with the UI.
+live at [app.zoo.dev](https://app.zoo.dev/)
 
-It might make sense to split this repo up at some point, but not the lang and the UI are all togther in a react app
+A CAD application from the future, brought to you by the [Zoo team](https://zoo.dev).
 
-Originally Presented on 10/01/2023
+Modeling App is our take on what a modern modelling experience can be. It is applying several lessons learned in the decades since most major CAD tools came into existence:
 
-[Video](https://drive.google.com/file/d/183_wjqGdzZ8EEZXSqZ3eDcJocYPCyOdC/view?pli=1)
+- All artifacts—including parts and assemblies—should be represented as human-readable code. At the end of the day, your CAD project should be "plain text"
+  - This makes version control—which is a solved problem in software engineering—trivial for CAD
+- All GUI (or point-and-click) interactions should be actions performed on this code representation under the hood
+  - This unlocks a hybrid approach to modeling. Whether you point-and-click as you always have or you write your own KCL code, you are performing the same action in Modeling App
+- Everything graphics _has_ to be built for the GPU
+  - Most CAD applications have had to retrofit support for GPUs, but our geometry engine is made for GPUs (primarily Nvidia's Vulkan), getting the order of magnitude rendering performance boost with it
+- Make the resource-intensive pieces of an application auto-scaling
+  - One of the bottlenecks of today's hardware design tools is that they all rely on the local machine's resources to do the hardest parts, which include geometry rendering and analysis. Our geometry engine parallelizes rendering and just sends video frames back to the app (seriously, inspect source, it's just a `<video>` element), and our API will offload analysis as we build it in
 
-[demo-slides.pdf](https://github.com/KittyCAD/Eng/files/10398178/demo.pdf)
+We are excited about what a small team of people could build in a short time with our API. We welcome you to try our API, build your own applications, or contribute to ours!
 
-## To run, there are a couple steps since we're compiling rust to WASM, you'll need to have rust stuff installed, then
+Modeling App is a _hybrid_ user interface for CAD modeling. You can point-and-click to design parts (and soon assemblies), but everything you make is really just [`kcl` code](https://github.com/KittyCAD/kcl-experiments) under the hood. All of your CAD models can be checked into source control such as GitHub and responsibly versioned, rolled back, and more.
+
+The 3D view in Modeling App is just a video stream from our hosted geometry engine. The app sends new modeling commands to the engine via WebSockets, which returns back video frames of the view within the engine.
+
+## Tools
+
+- UI
+  - [React](https://react.dev/)
+  - [Headless UI](https://headlessui.com/)
+  - [TailwindCSS](https://tailwindcss.com/)
+  - [XState](https://xstate.js.org/)
+- Networking
+  - WebSockets (via [KittyCAD TS client](https://github.com/KittyCAD/kittycad.ts))
+- Code Editor
+  - [CodeMirror](https://codemirror.net/)
+  - Custom WASM LSP Server
+- Modeling
+  - [KittyCAD TypeScript client](https://github.com/KittyCAD/kittycad.ts)
+
+[Original demo video](https://drive.google.com/file/d/183_wjqGdzZ8EEZXSqZ3eDcJocYPCyOdC/view?pli=1)
+
+[Original demo slides](https://github.com/KittyCAD/Eng/files/10398178/demo.pdf)
+
+## Get started
+
+We recommend downloading the latest application binary from [our Releases page](https://github.com/KittyCAD/modeling-app/releases). If you don't see your platform or architecture supported there, please file an issue.
+
+## Running a development build
+
+First, [install Rust via `rustup`](https://www.rust-lang.org/tools/install). This project uses a lot of Rust compiled to [WASM](https://webassembly.org/) within it. We always use the latest stable version of Rust, so you may need to run `rustup update stable`. Then, run:
 
 ```
 yarn install
 ```
-then
+
+followed by:
+
 ```
-yarn build:wasm
+yarn build:wasm-dev
 ```
+
 That will build the WASM binary and put in the `public` dir (though gitignored)
 
-finally
+finally, to run the web app only, run:
+
 ```
 yarn start
 ```
 
-and `yarn test` you would have need to have built the WASM previously. The tests need to download the binary from a server, so if you've already got `yarn start` running, that will work, otherwise running
-```
-yarn simpleserver
-```
-in one terminal
-and 
-```
-yarn test
-```
-in another.
-
-If you want to edit the rust files, you can cd into `src/wasm-lib` and then use the usual rust commands, `cargo build`, `cargo test`, when you want to bring the changes back to the web-app, a fresh `yarn build:wasm` in the root will be needed.
-
-Worth noting that the integration of the WASM into this project is very hacky because I'm really pushing create-react-app further than what's practical, but focusing on features atm rather than the setup.
-
 ## Developing in Chrome
 
 Chrome is in the process of rolling out a new default which
@@ -52,13 +77,33 @@ enable third-party cookies. You can enable third-party cookies by clicking on
 the eye with a slash through it in the URL bar, and clicking on "Enable
 Third-Party Cookies".
 
+## Running tests
+
+First, start the dev server following "Running a development build" above.
+
+Then in another terminal tab, run:
+
+```
+yarn test
+```
+
+Which will run our suite of [Vitest unit](https://vitest.dev/) and [React Testing Library E2E](https://testing-library.com/docs/react-testing-library/intro/) tests, in interactive mode by default.
+
+For running the rust (not tauri rust though) only, you can
+```bash
+cd src/wasm-lib
+cargo test
+```
+
 ## Tauri
 
-To spin up up tauri dev, `yarn install` and `yarn build:wasm` need to have been done before hand then
+To spin up up tauri dev, `yarn install` and `yarn build:wasm-dev` need to have been done before hand then
+
 ```
 yarn tauri dev
 ```
-Will spin up the web app before opening up the tauri dev desktop app. Note that it's probably a good idea to close the browser tab that gets opened since at the time of writting they can conflict.
+
+Will spin up the web app before opening up the tauri dev desktop app. Note that it's probably a good idea to close the browser tab that gets opened since at the time of writing they can conflict.
 
 The dev instance automatically opens up the browser devtools which can be disabled by [commenting it out](https://github.com/KittyCAD/modeling-app/blob/main/src-tauri/src/main.rs#L92.)
 
@@ -67,22 +112,180 @@ To build, run `yarn tauri build`, or `yarn tauri build --debug` to keep access t
 Note that these became separate apps on Macos, so make sure you open the right one after a build 😉
 ![image](https://github.com/KittyCAD/modeling-app/assets/29681384/a08762c5-8d16-42d8-a02f-a5efc9ae5551)
 
-
 <img width="1232" alt="image" src="https://user-images.githubusercontent.com/29681384/211947063-46164bb4-7bdd-45cb-9a76-2f40c71a24aa.png">
 
 <img width="1232" alt="image (1)" src="https://user-images.githubusercontent.com/29681384/211947073-e76b4933-bef5-4636-bc4d-e930ac8e290f.png">
 
+## Before submitting a PR
+
+Before you submit a contribution PR to this repo, please ensure that:
+
+- There is a corresponding issue for the changes you want to make, so that discussion of approach can be had before work begins.
+- You have separated out refactoring commits from feature commits as much as possible
+- You have run all of the following commands locally:
+  - `yarn fmt`
+  - `yarn tsc`
+  - `yarn test`
+  - Here they are all together: `yarn fmt && yarn tsc && yarn test`
+
 ## Release a new version
 
-1. Bump the versions in the .json files by creating a `Bump to v{x}.{y}.{z}` PR, committing the changes from
+1. Bump the versions in the .json files by creating a `Cut release v{x}.{y}.{z}` PR, committing the changes from
 
 ```bash
 VERSION=x.y.z yarn run bump-jsons
 ```
-The PR may serve as a place to discuss the human-readable changelog and extra QA.
+
+Alternatively you can try the experimental `make-release.sh` bash script that will create the branch with the updated json files for you.
+run `./make-release.sh` for a patch update
+run `./make-release.sh "minor"` for minor
+run `./make-release.sh "major"` for major
+
+The PR may serve as a place to discuss the human-readable changelog and extra QA. A quick way of getting PR's merged since the last bump is to [use this PR filter](https://github.com/KittyCAD/modeling-app/pulls?q=is%3Apr+sort%3Aupdated-desc+is%3Amerged+), open up the browser console and paste in the following
+
+```typescript
+console.log(
+  '- ' +
+    Array.from(
+      document.querySelectorAll('[data-hovercard-type="pull_request"]')
+    ).map((a) => `[${a.innerText}](${a.href})`).join(`
+- `)
+)
+```
+grab the md list and delete any that are older than the last bump
 
 2. Merge the PR
 
 3. Create a new release and tag pointing to the bump version commit using semantic versioning `v{x}.{y}.{z}`
 
 4. A new Action kicks in at https://github.com/KittyCAD/modeling-app/actions, uploading artifacts to the release
+
+## Fuzzing the parser
+
+Make sure you install cargo fuzz:
+
+```bash
+$ cargo install cargo-fuzz
+```
+
+```bash
+$ cd src/wasm-lib/kcl
+
+# list the fuzz targets
+$ cargo fuzz list
+
+# run the parser fuzzer
+$ cargo +nightly fuzz run parser
+```
+
+For more information on fuzzing you can check out
+[this guide](https://rust-fuzz.github.io/book/cargo-fuzz.html).
+
+
+### Playwright
+
+First time running plawright locally, you'll need to add the secrets file
+```bash
+touch ./e2e/playwright/playwright-secrets.env
+printf 'token="your-token"\nsnapshottoken="your-snapshot-token"' > ./e2e/playwright/playwright-secrets.env
+```
+then replace "your-token" with a dev token from dev.zoo.dev/account/api-tokens
+
+then:
+run playwright
+```
+yarn playwright test
+```
+
+run a specific test suite
+```
+yarn playwright test src/e2e-tests/example.spec.ts
+```
+
+run a specific test change the test from `test('...` to `test.only('...`
+(note if you commit this, the tests will instantly fail without running any of the tests)
+
+run headed
+```
+yarn playwright test --headed
+```
+
+run with step through debugger
+```
+PWDEBUG=1 yarn playwright test
+```
+However, if you want a debugger I recommend using VSCode and the `playwright` extension, as the above command is a cruder debugger that steps into every function call which is annoying.
+With the extension you can set a breakpoint after `waitForDefaultPlanesVisibilityChange` in order to skip app loading, then the vscode debugger's "step over" is much better for being able to stay at the right level of abstraction as you debug the code.
+
+If you want to limit to a single browser use `--project="webkit"` or `firefox`, `Google Chrome`
+Or comment out browsers in `playwright.config.ts`.
+
+note chromium has encoder compat issues which is why were testing against the branded 'Google Chrome'
+
+You may consider using the VSCode extension, it's useful for running individual threads, but some some reason the "record a test" is locked to chromium with we can't use. A work around is to us the CI `yarn playwright codegen -b wk --load-storage ./store localhost:3000`
+
+<details>
+<summary>
+
+Where `./store` should look like this
+
+</summary>
+
+```JSON
+{
+  "cookies": [],
+  "origins": [
+    {
+      "origin": "http://localhost:3000",
+      "localStorage": [
+        {
+          "name": "store",
+          "value": "{\"state\":{\"openPanes\":[\"code\"]},\"version\":0}"
+        },
+        {
+          "name": "persistCode",
+          "value": ""
+        },
+        {
+          "name": "TOKEN_PERSIST_KEY",
+          "value": "your-token"
+        }
+      ]
+    }
+  ]
+}
+```
+
+</details>
+
+
+However because much of our tests involve clicking in the stream at specific locations, it's code-gen looks `await page.locator('video').click();` when really we need to use a pixel coord, so I think it's of limited use.
+
+#### Some notes on CI
+
+The tests are broken into snapshot tests and non-snapshot tests, and they run in that order, they automatically commit new snap shots, so if you see an image commit check it was an intended change. If we have non-determinism in the snapshots such that they are always committing new images, hopefully this annoyance makes us fix them asap, if you notice this happening let Kurt know. But for the odd occasion  `git reset --hard HEAD~ && git push -f` is your friend.
+
+How to interpret failing playwright tests?
+If your tests fail, click through to the action and see that the tests failed on a line that includes `await page.getByTestId('loading').waitFor({ state: 'detached' })`, this means the test fail because the stream never started. It's you choice if you want to re-run the test, or ignore the failure.
+
+We run on ubuntu and macos, because safari doesn't work on linux because of the dreaded "no RTCPeerConnection variable" error. But linux runs first and then macos for the same reason that we limit the number of parallel tests to 1 because we limit stream connections per user, so tests would start failing we if let them run together.
+
+If something fails on CI you can download the artifact, unzip it and then open `playwright-report/data/<UUID>.zip` with https://trace.playwright.dev/ to see what happened.
+
+#### Getting started writing a playwright test in our app
+
+Besides following the instructions above and using the playwright docs, our app is weird because of the whole stream thing, which means our testing is weird. Because we've just figured out this stuff and therefore docs might go stale quick here's a 15min vid/tutorial
+
+https://github.com/KittyCAD/modeling-app/assets/29681384/6f5e8e85-1003-4fd9-be7f-f36ce833942d
+
+<details>
+
+<summary>
+PS: for the debug panel, the following JSON is useful for snapping the camera
+</summary>
+
+```JSON
+{"type":"modeling_cmd_req","cmd_id":"054e5472-e5e9-4071-92d7-1ce3bac61956","cmd":{"type":"default_camera_look_at","center":{"x":15,"y":0,"z":0},"up":{"x":0,"y":0,"z":1},"vantage":{"x":30,"y":30,"z":30}}}
+```
+
+</details>

babel.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-  presets: ["@babel/preset-env"],
+  presets: ['@babel/preset-env'],
 }

docs/kcl/KNOWN-ISSUES.md

@@ -0,0 +1,20 @@
+---
+title: "KCL Known Issues"
+excerpt: "Known issues with the KCL standard library for the Zoo Modeling App."
+layout: manual
+---
+
+The following are bugs that are not in modeling-app or kcl itself. These bugs
+once fixed in engine will just start working here with no language changes.
+
+- **Sketch on Face**: If your sketch is outside the edges of the face (on which you
+    are sketching) you will get multiple models returned instead of one single
+    model for that sketch and its underlying 3D object.
+    If you see a red line around your model, it means this is happening.
+
+- **Import**: Right now you can import a file, even if that file has brep data
+    you cannot edit it, after v1, the engine will account for this. You also cannot
+    currently move or transform the imported objects at all, once we have assemblies
+    this will work.
+
+- **Fillets**: Fillets cannot intersect, you will get an error. Only simple fillet cases work currently.

docs/kcl/abs.md

@@ -0,0 +1,34 @@
+---
+title: "abs"
+excerpt: "Computes the absolute value of a number."
+layout: manual
+---
+
+Computes the absolute value of a number.
+
+
+
+```js
+abs(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = abs(-4)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/acos.md

@@ -0,0 +1,34 @@
+---
+title: "acos"
+excerpt: "Computes the arccosine of a number (in radians)."
+layout: manual
+---
+
+Computes the arccosine of a number (in radians).
+
+
+
+```js
+acos(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = acos(0.5)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/asin.md

@@ -0,0 +1,34 @@
+---
+title: "asin"
+excerpt: "Computes the arcsine of a number (in radians)."
+layout: manual
+---
+
+Computes the arcsine of a number (in radians).
+
+
+
+```js
+asin(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = asin(0.5)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/atan.md

@@ -0,0 +1,34 @@
+---
+title: "atan"
+excerpt: "Computes the arctangent of a number (in radians)."
+layout: manual
+---
+
+Computes the arctangent of a number (in radians).
+
+
+
+```js
+atan(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = atan(1.0)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/ceil.md

@@ -0,0 +1,34 @@
+---
+title: "ceil"
+excerpt: "Computes the smallest integer greater than or equal to a number."
+layout: manual
+---
+
+Computes the smallest integer greater than or equal to a number.
+
+
+
+```js
+ceil(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = ceil(4.5)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/cos.md

@@ -0,0 +1,34 @@
+---
+title: "cos"
+excerpt: "Computes the cosine of a number (in radians)."
+layout: manual
+---
+
+Computes the cosine of a number (in radians).
+
+
+
+```js
+cos(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const anotherVar = cos(2 * pi())
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/e.md

@@ -0,0 +1,33 @@
+---
+title: "e"
+excerpt: "Return the value of Euler’s number `e`."
+layout: manual
+---
+
+Return the value of Euler’s number `e`.
+
+
+
+```js
+e() -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = e()
+```
+
+### Arguments
+
+
+### Returns
+
+`number`
+
+
+

docs/kcl/floor.md

@@ -0,0 +1,34 @@
+---
+title: "floor"
+excerpt: "Computes the largest integer less than or equal to a number."
+layout: manual
+---
+
+Computes the largest integer less than or equal to a number.
+
+
+
+```js
+floor(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = floor(4.5)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/import.md

@@ -0,0 +1,136 @@
+---
+title: "import"
+excerpt: "Import a CAD file."
+layout: manual
+---
+
+Import a CAD file.
+
+For formats lacking unit data (STL, OBJ, PLY), the default import unit is millimeters. Otherwise you can specify the unit by passing in the options parameter. If you import a gltf file, we will try to find the bin file and import it as well.
+Import paths are relative to the current project directory. This only works in the desktop app not in browser.
+
+```js
+import(file_path: String, options?: ImportFormat) -> ImportedGeometry
+```
+
+### Examples
+
+```js
+const model = import("thing.obj")
+```
+
+```js
+const model = import("cube.obj", { type: "obj", units: "m" })
+```
+
+```js
+const model = import("my_model.gltf")
+```
+
+```js
+const model = import("my_model.sldprt")
+```
+
+```js
+const model = import("my_model.step")
+```
+
+### Arguments
+
+* `file_path`: `String` (REQUIRED)
+* `options`: `ImportFormat` - Import format specifier (OPTIONAL)
+```js
+{
+	type: "fbx",
+} |
+{
+	type: "gltf",
+} |
+{
+	// Co-ordinate system of input data. Defaults to the [KittyCAD co-ordinate system.
+	coords: {
+	// Axis the front face of a model looks along.
+	forward: {
+	// Axis specifier.
+	axis: "y" | "z",
+	// Specifies which direction the axis is pointing.
+	direction: "positive" | "negative",
+},
+	// Axis pointing up and away from a model.
+	up: {
+	// Axis specifier.
+	axis: "y" | "z",
+	// Specifies which direction the axis is pointing.
+	direction: "positive" | "negative",
+},
+},
+	type: "obj",
+	// The units of the input data. This is very important for correct scaling and when calculating physics properties like mass, etc. Defaults to millimeters.
+	units: "cm" | "ft" | "in" | "m" | "mm" | "yd",
+} |
+{
+	// Co-ordinate system of input data. Defaults to the [KittyCAD co-ordinate system.
+	coords: {
+	// Axis the front face of a model looks along.
+	forward: {
+	// Axis specifier.
+	axis: "y" | "z",
+	// Specifies which direction the axis is pointing.
+	direction: "positive" | "negative",
+},
+	// Axis pointing up and away from a model.
+	up: {
+	// Axis specifier.
+	axis: "y" | "z",
+	// Specifies which direction the axis is pointing.
+	direction: "positive" | "negative",
+},
+},
+	type: "ply",
+	// The units of the input data. This is very important for correct scaling and when calculating physics properties like mass, etc. Defaults to millimeters.
+	units: "cm" | "ft" | "in" | "m" | "mm" | "yd",
+} |
+{
+	type: "sldprt",
+} |
+{
+	type: "step",
+} |
+{
+	// Co-ordinate system of input data. Defaults to the [KittyCAD co-ordinate system.
+	coords: {
+	// Axis the front face of a model looks along.
+	forward: {
+	// Axis specifier.
+	axis: "y" | "z",
+	// Specifies which direction the axis is pointing.
+	direction: "positive" | "negative",
+},
+	// Axis pointing up and away from a model.
+	up: {
+	// Axis specifier.
+	axis: "y" | "z",
+	// Specifies which direction the axis is pointing.
+	direction: "positive" | "negative",
+},
+},
+	type: "stl",
+	// The units of the input data. This is very important for correct scaling and when calculating physics properties like mass, etc. Defaults to millimeters.
+	units: "cm" | "ft" | "in" | "m" | "mm" | "yd",
+}
+```
+
+### Returns
+
+`ImportedGeometry` - Data for an imported geometry.
+```js
+{
+	// The ID of the imported geometry.
+	id: uuid,
+	// The original file paths.
+	value: [string],
+}
+```
+
+
+

docs/kcl/index.md

@@ -0,0 +1,79 @@
+---
+title: "KCL Standard Library"
+excerpt: "Documentation for the KCL standard library for the Zoo Modeling App."
+layout: manual
+---
+
+## Table of Contents
+
+* [Types](kcl/types)
+* [Known Issues](kcl/KNOWN-ISSUES)
+* [`abs`](kcl/abs)
+* [`acos`](kcl/acos)
+* [`angleToMatchLengthX`](kcl/angleToMatchLengthX)
+* [`angleToMatchLengthY`](kcl/angleToMatchLengthY)
+* [`angledLine`](kcl/angledLine)
+* [`angledLineOfXLength`](kcl/angledLineOfXLength)
+* [`angledLineOfYLength`](kcl/angledLineOfYLength)
+* [`angledLineThatIntersects`](kcl/angledLineThatIntersects)
+* [`angledLineToX`](kcl/angledLineToX)
+* [`angledLineToY`](kcl/angledLineToY)
+* [`arc`](kcl/arc)
+* [`asin`](kcl/asin)
+* [`atan`](kcl/atan)
+* [`bezierCurve`](kcl/bezierCurve)
+* [`ceil`](kcl/ceil)
+* [`circle`](kcl/circle)
+* [`close`](kcl/close)
+* [`cos`](kcl/cos)
+* [`e`](kcl/e)
+* [`extrude`](kcl/extrude)
+* [`fillet`](kcl/fillet)
+* [`floor`](kcl/floor)
+* [`getEdge`](kcl/getEdge)
+* [`getExtrudeWallTransform`](kcl/getExtrudeWallTransform)
+* [`getNextAdjacentEdge`](kcl/getNextAdjacentEdge)
+* [`getOppositeEdge`](kcl/getOppositeEdge)
+* [`getPreviousAdjacentEdge`](kcl/getPreviousAdjacentEdge)
+* [`helix`](kcl/helix)
+* [`hole`](kcl/hole)
+* [`import`](kcl/import)
+* [`lastSegX`](kcl/lastSegX)
+* [`lastSegY`](kcl/lastSegY)
+* [`legAngX`](kcl/legAngX)
+* [`legAngY`](kcl/legAngY)
+* [`legLen`](kcl/legLen)
+* [`line`](kcl/line)
+* [`lineTo`](kcl/lineTo)
+* [`ln`](kcl/ln)
+* [`log`](kcl/log)
+* [`log10`](kcl/log10)
+* [`log2`](kcl/log2)
+* [`max`](kcl/max)
+* [`min`](kcl/min)
+* [`patternCircular2d`](kcl/patternCircular2d)
+* [`patternCircular3d`](kcl/patternCircular3d)
+* [`patternLinear2d`](kcl/patternLinear2d)
+* [`patternLinear3d`](kcl/patternLinear3d)
+* [`pi`](kcl/pi)
+* [`pow`](kcl/pow)
+* [`revolve`](kcl/revolve)
+* [`segAng`](kcl/segAng)
+* [`segEndX`](kcl/segEndX)
+* [`segEndY`](kcl/segEndY)
+* [`segLen`](kcl/segLen)
+* [`sin`](kcl/sin)
+* [`sqrt`](kcl/sqrt)
+* [`startProfileAt`](kcl/startProfileAt)
+* [`startSketchAt`](kcl/startSketchAt)
+* [`startSketchOn`](kcl/startSketchOn)
+* [`tan`](kcl/tan)
+* [`tangentialArc`](kcl/tangentialArc)
+* [`tangentialArcTo`](kcl/tangentialArcTo)
+* [`tau`](kcl/tau)
+* [`toDegrees`](kcl/toDegrees)
+* [`toRadians`](kcl/toRadians)
+* [`xLine`](kcl/xLine)
+* [`xLineTo`](kcl/xLineTo)
+* [`yLine`](kcl/yLine)
+* [`yLineTo`](kcl/yLineTo)

docs/kcl/legAngX.md

@@ -0,0 +1,35 @@
+---
+title: "legAngX"
+excerpt: "Returns the angle of the given leg for x."
+layout: manual
+---
+
+Returns the angle of the given leg for x.
+
+
+
+```js
+legAngX(hypotenuse: number, leg: number) -> number
+```
+
+### Tags
+
+* `utilities`
+
+### Examples
+
+```js
+legAngX(5, 3)
+```
+
+### Arguments
+
+* `hypotenuse`: `number` (REQUIRED)
+* `leg`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/legAngY.md

@@ -0,0 +1,35 @@
+---
+title: "legAngY"
+excerpt: "Returns the angle of the given leg for y."
+layout: manual
+---
+
+Returns the angle of the given leg for y.
+
+
+
+```js
+legAngY(hypotenuse: number, leg: number) -> number
+```
+
+### Tags
+
+* `utilities`
+
+### Examples
+
+```js
+legAngY(5, 3)
+```
+
+### Arguments
+
+* `hypotenuse`: `number` (REQUIRED)
+* `leg`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/legLen.md

@@ -0,0 +1,35 @@
+---
+title: "legLen"
+excerpt: "Returns the length of the given leg."
+layout: manual
+---
+
+Returns the length of the given leg.
+
+
+
+```js
+legLen(hypotenuse: number, leg: number) -> number
+```
+
+### Tags
+
+* `utilities`
+
+### Examples
+
+```js
+legLen(5, 3)
+```
+
+### Arguments
+
+* `hypotenuse`: `number` (REQUIRED)
+* `leg`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/ln.md

@@ -0,0 +1,34 @@
+---
+title: "ln"
+excerpt: "Computes the natural logarithm of the number."
+layout: manual
+---
+
+Computes the natural logarithm of the number.
+
+
+
+```js
+ln(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = ln(4)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/log.md

@@ -0,0 +1,35 @@
+---
+title: "log"
+excerpt: "Computes the logarithm of the number with respect to an arbitrary base."
+layout: manual
+---
+
+Computes the logarithm of the number with respect to an arbitrary base.
+
+The result might not be correctly rounded owing to implementation details; `log2()` can produce more accurate results for base 2, and `log10()` can produce more accurate results for base 10.
+
+```js
+log(num: number, base: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = log(4, 2)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+* `base`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/log10.md

@@ -0,0 +1,34 @@
+---
+title: "log10"
+excerpt: "Computes the base 10 logarithm of the number."
+layout: manual
+---
+
+Computes the base 10 logarithm of the number.
+
+
+
+```js
+log10(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = log10(4)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/log2.md

@@ -0,0 +1,34 @@
+---
+title: "log2"
+excerpt: "Computes the base 2 logarithm of the number."
+layout: manual
+---
+
+Computes the base 2 logarithm of the number.
+
+
+
+```js
+log2(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = log2(4)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/max.md

@@ -0,0 +1,34 @@
+---
+title: "max"
+excerpt: "Computes the maximum of the given arguments."
+layout: manual
+---
+
+Computes the maximum of the given arguments.
+
+
+
+```js
+max(args: [number]) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = max(4, 5, 6)
+```
+
+### Arguments
+
+* `args`: `[number]` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/min.md

@@ -0,0 +1,34 @@
+---
+title: "min"
+excerpt: "Computes the minimum of the given arguments."
+layout: manual
+---
+
+Computes the minimum of the given arguments.
+
+
+
+```js
+min(args: [number]) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = min(4, 5, 6)
+```
+
+### Arguments
+
+* `args`: `[number]` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/pi.md

@@ -0,0 +1,33 @@
+---
+title: "pi"
+excerpt: "Return the value of `pi`. Archimedes’ constant (π)."
+layout: manual
+---
+
+Return the value of `pi`. Archimedes’ constant (π).
+
+
+
+```js
+pi() -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = pi() * 3.0
+```
+
+### Arguments
+
+
+### Returns
+
+`number`
+
+
+

docs/kcl/pow.md

@@ -0,0 +1,35 @@
+---
+title: "pow"
+excerpt: "Computes the number to a power."
+layout: manual
+---
+
+Computes the number to a power.
+
+
+
+```js
+pow(num: number, pow: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = pow(4, 2)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+* `pow`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/sin.md

@@ -0,0 +1,34 @@
+---
+title: "sin"
+excerpt: "Computes the sine of a number (in radians)."
+layout: manual
+---
+
+Computes the sine of a number (in radians).
+
+
+
+```js
+sin(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = sin(2 * pi())
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/sqrt.md

@@ -0,0 +1,34 @@
+---
+title: "sqrt"
+excerpt: "Computes the square root of a number."
+layout: manual
+---
+
+Computes the square root of a number.
+
+
+
+```js
+sqrt(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = sqrt(4)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/tan.md

@@ -0,0 +1,34 @@
+---
+title: "tan"
+excerpt: "Computes the tangent of a number (in radians)."
+layout: manual
+---
+
+Computes the tangent of a number (in radians).
+
+
+
+```js
+tan(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = tan(2 * pi())
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/tau.md

@@ -0,0 +1,33 @@
+---
+title: "tau"
+excerpt: "Return the value of `tau`. The full circle constant (τ). Equal to 2π."
+layout: manual
+---
+
+Return the value of `tau`. The full circle constant (τ). Equal to 2π.
+
+
+
+```js
+tau() -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = tau()
+```
+
+### Arguments
+
+
+### Returns
+
+`number`
+
+
+

docs/kcl/toDegrees.md

@@ -0,0 +1,34 @@
+---
+title: "toDegrees"
+excerpt: "Converts a number from radians to degrees."
+layout: manual
+---
+
+Converts a number from radians to degrees.
+
+
+
+```js
+toDegrees(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = toDegrees(2 * pi())
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/toRadians.md

@@ -0,0 +1,34 @@
+---
+title: "toRadians"
+excerpt: "Converts a number from degrees to radians."
+layout: manual
+---
+
+Converts a number from degrees to radians.
+
+
+
+```js
+toRadians(num: number) -> number
+```
+
+### Tags
+
+* `math`
+
+### Examples
+
+```js
+const myVar = toRadians(180)
+```
+
+### Arguments
+
+* `num`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
+

docs/kcl/types.md

@@ -0,0 +1,79 @@
+---
+title: "KCL Types"
+excerpt: "Documentation of types for the KCL standard library for the Zoo Modeling App."
+layout: manual
+---
+
+`KCL` defines the following types and keywords the language.
+
+All these types can be nested in various forms where nesting applies. Like
+arrays can hold objects and vice versa.
+
+## Boolean
+
+`true` or `false` work when defining values.
+
+## Variable declaration
+
+Variables are defined with the `let` keyword like so:
+
+```
+let myBool = false
+```
+
+## Array
+
+An array is defined with `[]` braces. What is inside the brackets can
+be of any type. For example, the following is completely valid:
+
+```
+let myArray = ["thing", 2, false]
+```
+
+If you want to get a value from an array you can use the index like so:
+`myArray[0]`.
+
+
+## Object
+
+An object is defined with `{}` braces. Here is an example object:
+
+```
+let myObj = {a: 0, b: "thing"}
+```
+
+We support two different ways of getting properties from objects, you can call
+`myObj.a` or `myObj["a"]` both work.
+
+
+## Functions
+
+We also have support for defining your own functions. Functions can take in any
+type of argument. Below is an example of the syntax:
+
+```
+fn myFn = (x) => {
+  return x
+}
+```
+
+As you can see above `myFn` just returns whatever it is given.
+
+
+## Binary expressions
+
+You can also do math! Let's show an example below:
+
+```
+let myMathExpression = 3 + 1 * 2 / 3 - 7
+```
+
+You can nest expressions in parenthesis as well:
+
+```
+let myMathExpression = 3 + (1 * 2 / (3 - 7))
+```
+
+Please if you find any issues using any of the above expressions or syntax
+please file an issue with the `ast` label on the [modeling-app
+repo](https://github.com/KittyCAD/modeling-app/issues/new).