Merge branch 'master' into hack/map-search-preview

.env.example

@@ -1,4 +1,5 @@
 ENV='qaext'
 LOCATION='qaext'
 QACREDS_PSW='ADD-THE-REAL-PSW'
+QACREDS_USER_PSW='ADD-THE-REAL-PSW'
 QA_PORTAL_CREDS_PSW='ADD-THE-REAL-PSW'

.github/workflows/deploy-docs.yml

@@ -1,8 +1,12 @@
 name: Deploy Documentation
-# After a push to master, redeploy the docs
+# This is called from the release workflow so that the
+# docs are updated and stamped with the version numbers 
+# from the current release instead of the previous release
 on:
-  push:
-    branches: [master]
+  workflow_call:
+
+  # push:
+  #   branches: [master]
 
 jobs:
   build-and-deploy:

.github/workflows/release.yml

@@ -9,6 +9,7 @@ on:
       - beta
       # - alpha disabled to allow push to alpha then merge to master w/o incurring a release
       - next
+      - '[0-9]+.[0-9]+.x'
     # Dont run if it's just markdown or doc files
     paths-ignore:
       - "**.md"
@@ -74,3 +75,9 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: npm run release
+
+  deploy-docs:
+    name: 'Deploy Documentation'
+    uses: ./.github/workflows/deploy-docs.yml
+    needs:
+      - release

docs/build-typedoc.js

@@ -429,10 +429,12 @@ const md = new MarkdownIt();
       return api;
     })
     .then(api => {
+      api.generatedAt = new Date().toISOString();
       /**
        * Our final object looks like this:
        *
        * {
+       *   generated: '2023-09-18T19:46:07.314Z'
        *   packages: [Array of packages.],
        *   declarations: [Array of each exported declaration accross all source files.]
        *   index: { Object mapping each declaration.id as a key with the declaration as its value}
@@ -441,7 +443,7 @@ const md = new MarkdownIt();
        * We now export this to the Acetate source directory.
        */
       return new Promise((resolve, reject) => {
-        writeFile(OUTPUT, JSON.stringify(api, null, 2), e => {
+        writeFile(OUTPUT, JSON.stringify(api, null, 2), (e) => {
           if (e) {
             reject(e);
             return;

docs/src/_layout.html

@@ -4,6 +4,7 @@
     <meta charset="utf-8">
     <meta content="IE=edge" http-equiv="X-UA-Compatible">
     <meta name="viewport" content="width=device-width, user-scalable=no">
+    <meta name="date" content="{{data.typedoc.generatedAt}}">
     <title>{{title if title}}{{" | " + titleSegments | join(" |") if titleSegments}}{{" | " if title}}@esri/hub.js</title>
     {% if description %}
     <meta name="description" content="A modular, high quality toolkit for working with ArcGIS Hub">

karma.e2e.conf.js

@@ -12,7 +12,6 @@ module.exports = function(config) {
     browserDisconnectTimeout: 120000,
     pingTimeout: 1200000,
 
-
     // base path that will be used to resolve all patterns (eg. files, exclude)
     basePath: "",
 
@@ -23,7 +22,13 @@ module.exports = function(config) {
     // list of files / patterns to load in the browser
     files: [
       "packages/*/{src,e2e}/**/*.ts",
-      { pattern: 'e2e/test-images/*.jpg', watched: false, included: false, served: true, nocache: false }
+      {
+        pattern: "e2e/test-images/*.jpg",
+        watched: false,
+        included: false,
+        served: true,
+        nocache: false,
+      },
     ],
 
     // list of files to exclude
@@ -33,92 +38,85 @@ module.exports = function(config) {
       coverageOptions: {
         // Exclude all files - we don't want code coverage on e2e type tests
         // also critical so that we can debug in the code
-        exclude: [
-          /\.ts$/i,
-          /fixture*/,
-          /expected*/
-        ],
+        exclude: [/\.ts$/i, /fixture*/, /expected*/],
         threshold: {
           global: {
             statements: 0,
             branches: 0,
             functions: 0,
             lines: 0,
             excludes: [
-              'packages/*/examples/**/*.ts',
-              'packages/*/test/**/*.ts',
-              'packages/*/e2e/**/*.ts',
-            ]
-          }
-        }
+              "packages/*/examples/**/*.ts",
+              "packages/*/test/**/*.ts",
+              "packages/*/e2e/**/*.ts",
+            ],
+          },
+        },
       },
       reports: {
-        "json": {
-          "directory": "coverage",
-          "filename": "coverage.json"
+        json: {
+          directory: "coverage",
+          filename: "coverage.json",
         },
-        "html": "coverage"
+        html: "coverage",
       },
       compilerOptions: {
         module: "commonjs",
-        importHelpers: true
+        importHelpers: true,
       },
       tsconfig: "./tsconfig.json",
       bundlerOptions: {
         // validateSyntax: false,
         transforms: [
-          require("karma-typescript-es6-transform")(
-            {
-                presets: [
-                    ["@babel/preset-env", {
-                        targets: {
-                            chrome: "94"
-                        }
-                    }]
-                ]
-            }
-          )
+          require("karma-typescript-es6-transform")({
+            presets: [
+              [
+                "@babel/preset-env",
+                {
+                  targets: {
+                    chrome: "94",
+                  },
+                },
+              ],
+            ],
+          }),
         ],
         exclude: ["@esri/arcgis-rest-types"],
         resolve: {
           // karmas resolver cant figure out the symlinked deps from lerna
           // so we need to manually alias each package here.
           alias: fs
             .readdirSync("packages")
-            .filter(p => p[0] !== ".")
+            .filter((p) => p[0] !== ".")
             .reduce((alias, p) => {
               alias[`@esri/templates-${p}`] = `packages/${p}/src/index.ts`;
               return alias;
-            }, {})
-        }
-      }
+            }, {}),
+        },
+      },
     },
 
     // preprocess matching files before serving them to the browser
     // available preprocessors: https://npmjs.org/browse/keyword/karma-preprocessor
     preprocessors: {
       "packages/*/src/**/*.ts": ["karma-typescript"],
       "packages/*/e2e/**/*.ts": ["karma-typescript"],
-      "packages/*/e2e/**/helpers/config.ts": ["karma-typescript", "env"]
+      "packages/*/e2e/**/helpers/config.ts": ["karma-typescript", "env"],
     },
 
     // Expose this as `window.__env__.QACREDS_PSW
     // Used in config files in e2e folders
-    envPreprocessor: [
-      "QACREDS_PSW"
-    ],
+    envPreprocessor: ["QACREDS_PSW", "QACREDS_USER_PSW"],
 
     // test results reporter to use
     // possible values: 'dots', 'progress'
     // available reporters: https://npmjs.org/browse/keyword/karma-reporter
     // reporters: ["spec", "karma-typescript", "coverage"],
-    reporters: ["dots",  "karma-typescript"],
+    reporters: ["dots", "karma-typescript"],
     coverageReporter: {
       // specify a common output directory
-      dir: 'coverage',
-      reporters: [
-        { type: 'lcov', subdir: 'lcov' }
-      ]
+      dir: "coverage",
+      reporters: [{ type: "lcov", subdir: "lcov" }],
     },
 
     // web server port
@@ -136,24 +134,19 @@ module.exports = function(config) {
 
     // start these browsers
     // available browser launchers: https://npmjs.org/browse/keyword/karma-launcher
-    browsers: [
-      'Chrome',
-      'Edge',
-      'Firefox'
-    ],
+    browsers: ["Chrome", "Edge", "Firefox"],
     plugins: [
-      require('karma-env-preprocessor'),
-      require('@chiragrupani/karma-chromium-edge-launcher'),
-      require('karma-chrome-launcher'),
-      require('karma-coverage'), 
-      require('karma-firefox-launcher'),
-      require('karma-jasmine'),
-      require('karma-jasmine-diff-reporter'),
-      require('karma-safari-launcher'),
-      require('karma-spec-reporter'),
-      require('karma-typescript'),
-      require('karma-typescript-es6-transform')
-
+      require("karma-env-preprocessor"),
+      require("@chiragrupani/karma-chromium-edge-launcher"),
+      require("karma-chrome-launcher"),
+      require("karma-coverage"),
+      require("karma-firefox-launcher"),
+      require("karma-jasmine"),
+      require("karma-jasmine-diff-reporter"),
+      require("karma-safari-launcher"),
+      require("karma-spec-reporter"),
+      require("karma-typescript"),
+      require("karma-typescript-es6-transform"),
     ],
 
     // Continuous Integration mode
@@ -165,13 +158,13 @@ module.exports = function(config) {
     concurrency: Infinity,
     customLaunchers: {
       ChromeHeadlessCI: {
-        base: 'ChromeHeadless',
-        flags: ['--no-sandbox']
+        base: "ChromeHeadless",
+        flags: ["--no-sandbox"],
       },
       ChromeDevTools: {
-        base: 'Chrome',
-        flags: ['--auto-open-devtools-for-tabs']
-      }
+        base: "Chrome",
+        flags: ["--auto-open-devtools-for-tabs"],
+      },
     },
   });
 };