Update v5 docs (#384)

* Configure API Extractor
* Document `getPublicSuffix`
* Document `canonicalDomain`
* Document `pathMatch`
* Document `permuteDomain`
* Document `cookieCompare`
* Document `defaultPath`
* Document `domainMatch`
* Document `formatDate`
* Document `parseDate`
* Document `version`
* Document `permutePath`
* Document `ParameterError`
* Document `CookieJar`
* Update readme with examples and links to API
* Fix error message test
* Document `Store` and `MemoryStore`
* Update lib/memstore.ts
* Add primary landing page
* Document `PrefixSecurity`
* Document `Cookie`
* Replace derived `CreateCookieOptions` with explicit type
* Fix warnings and un-ignore the docs folder
* GitHub Action changes for API and docs
* Don't stop the unit test matrix on fail
* Update README.md
* Update lockfile

.eslintrc.json

@@ -14,6 +14,6 @@
   "reportUnusedDisableDirectives": true,
   "rules": {
     "@typescript-eslint/explicit-function-return-type": "error",
-    "max-lines": ["warn", 500]
+    "max-lines": ["warn", 2000]
   }
 }

.github/workflows/integration.yaml

@@ -1,28 +1,82 @@
-name: Actions-CI
+name: CI
 
 on:
   push:
-    branches: [master, v5]
+    branches: [master]
   pull_request:
-    branches: [master, v5]
+
+permissions:
+  contents: read
 
 jobs:
-  build:
+  lint:
+    name: Lint
     runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Run Linter
+        run: npm run eslint
+      - name: Run Formatter
+        run: npm run prettier
 
+  test:
+    name: Test - ${{ matrix.node-version }}
+    runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
         node-version: [latest, lts/*, lts/-1]
-
     steps:
-      - uses: actions/checkout@v2
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node.js (${{ matrix.node-version }})
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: npm
-      - name: Install dependencies and test
-        run: npm install
-      - run: npm test
-      - run: npm run eslint
-      - run: npm run prettier
+      - name: Install dependencies
+        run: npm ci
+      - name: Run tests
+        run: npm test
+
+  api:
+    name: API & Doc Validation
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Extract API
+        run: npm run api:extract
+      - name: Generate docs
+        run: npm run api:docs
+      - name: Ensure API and doc changes have been committed
+        run: |
+          git add --renormalize .
+          if (( "$(git diff --ignore-space-at-eol --ignore-cr-at-eol | wc -l)" != 0 )); then
+            cat << EOF >> $GITHUB_STEP_SUMMARY
+          ### Detected uncommitted changes
+
+          \`\`\`shell
+          $(git diff)
+          \`\`\`
+          EOF
+            git diff
+            exit 1
+          fi

.gitignore

@@ -9,3 +9,4 @@ coverage
 .config
 .bash_history
 dist/
+tmp/