@microsoft/generator-sharepoint 1.21.1 → 1.22.0-beta.2

package/lib/generators/searchAdaptiveCardExtension/index.js

@@ -84,6 +84,7 @@ class SearchAdaptiveCardExtensionGenerator extends _BaseAdaptiveCardExtensionGen
     }
     writing() {
         if (this._shouldExecute()) {
+            this.sourceRoot(_path.join(__dirname, '../../templates/searchAdaptiveCardExtension'));
             super.writing(true);
         }
     }
@@ -109,4 +110,4 @@ module.exports = SearchAdaptiveCardExtensionGenerator;
 module.exports.defineOptions = defineOptions;
 module.exports.composeWith = composeWith;
 
-//#sourceMappingUrl=./index.js.map
+//# sourceMappingURL=./index.js.map

package/lib/generators/searchQueryModifier/index.js

@@ -110,6 +110,7 @@ class SearchQueryModifierGenerator extends _BaseExtensionGenerator.BaseExtension
     }
     writing() {
         if (this._shouldExecute()) {
+            this.sourceRoot(_path.join(__dirname, '../../templates/searchQueryModifier'));
             super.writing();
         }
     }
@@ -141,4 +142,4 @@ module.exports = SearchQueryModifierGenerator;
 module.exports.defineOptions = defineOptions;
 module.exports.composeWith = composeWith;
 
-//#sourceMappingUrl=./index.js.map
+//# sourceMappingURL=./index.js.map

package/lib/generators/solution/heft.package.json

@@ -6,12 +6,16 @@
     "node": ">=22.14.0 < 23.0.0"
   },
   "scripts": {
-    "build": "heft test --clean",
+    "build": "heft build --clean",
+    "test": "npm run build && heft test",
     "clean": "heft clean",
     "deploy": "heft dev-deploy",
     "start": "heft start --clean",
     "build-watch": "heft build --lite",
     "package-solution": "heft package-solution",
-    "deploy-azure-storage": "heft deploy-azure-storage"
+    "deploy-azure-storage": "heft deploy-azure-storage",
+    "eject-webpack": "heft eject-webpack",
+    "trust-dev-cert": "heft trust-dev-cert",
+    "untrust-dev-cert": "heft untrust-dev-cert"
   }
 }

package/lib/generators/solution/index.js

@@ -103,9 +103,10 @@ function defineOptions(generator) {
         description: 'If specified, the solution will have permissions to access web APIs ' + 'that are unique not shared with other components in the tenant',
         type: Boolean
     });
-    generator.option('use-heft', {
-        description: 'If specified, the solution will build the project using Heft',
-        type: Boolean
+    generator.option('use-gulp', {
+        description: 'If specified, the solution will build the project using the legacy Gulp tooling',
+        type: Boolean,
+        default: false
     });
 }
 class SolutionGenerator extends _BaseGenerator.BaseGenerator {
@@ -157,19 +158,19 @@ class SolutionGenerator extends _BaseGenerator.BaseGenerator {
         } else {
             isDomainIsolated = false;
         }
-        // allows to set --use-heft false
-        let useHeft = answers.useHeft;
-        const useHeftConfig = this.config.get('useHeft');
-        if (useHeftConfig !== undefined) {
-            if (typeof useHeftConfig === 'string') {
-                useHeft = useHeftConfig.toLowerCase() === 'true';
+        // allows to set --use-gulp false
+        let useGulp = false;
+        const useGulpConfig = this.config.get('useGulp');
+        if (useGulpConfig !== undefined) {
+            if (typeof useGulpConfig === 'string') {
+                useGulp = useGulpConfig.toLowerCase() === 'true';
             } else {
-                useHeft = useHeftConfig;
+                useGulp = useGulpConfig;
             }
         }
         const isPlusBeta = this.config.get('plusBeta');
         this.context.solutionName = solutionName;
-        this.context.useHeft = !!useHeft;
+        this.context.useGulp = useGulp;
         this.context.libraryName = _lodash.kebabCase(this.context.solutionName);
         this.context.libraryId = _utilities.generateGuid();
         this.context.solutionShortDescription = solutionShortDescription;
@@ -183,9 +184,9 @@ class SolutionGenerator extends _BaseGenerator.BaseGenerator {
         _YeomanConfiguration.YeomanConfiguration.libraryId = this.context.libraryId;
         _YeomanConfiguration.YeomanConfiguration.environment = environment;
         _YeomanConfiguration.YeomanConfiguration.packageManager = this.config.get('packageManager') || _YeomanConfiguration.YeomanConfiguration.packageManager || 'npm';
-        _YeomanConfiguration.YeomanConfiguration.useHeft = !!useHeft;
+        _YeomanConfiguration.YeomanConfiguration.useGulp = useGulp;
         this.config.set('solutionName', solutionName);
-        this.config.set('useHeft', useHeft);
+        this.config.set('useGulp', useGulp);
         this.config.set('environment', environment);
         this.config.set('solutionShortDescription', solutionShortDescription);
         this.config.set('skipFeatureDeployment', skipFeatureDeployment);
@@ -201,16 +202,16 @@ class SolutionGenerator extends _BaseGenerator.BaseGenerator {
     }
     configuring() {
         if (this._shouldExecute()) {
-            const packageJsonTemplate = this.context.useHeft ? require('./heft.package.json') : require('./non-heft.package.json');
+            const packageJsonTemplate = !this.context.useGulp ? require('./heft.package.json') : require('./non-heft.package.json');
             if (this.packageJsonManager.data) {
                 this.log(`Overwriting an existing "package.json"`);
             }
             packageJsonTemplate.name = this.context.libraryName;
             this.packageJsonManager.set(packageJsonTemplate);
-            if (this.context.useHeft) {
-                this.ensureDependencyGroup('useHeft');
-            } else {
+            if (this.context.useGulp) {
                 this.ensureDependencyGroup('useGulp');
+            } else {
+                this.ensureDependencyGroup('useHeft');
             }
             if (this.configJson.data) {
                 this.log(`Overwriting an existing "config.json"`);
@@ -228,10 +229,11 @@ class SolutionGenerator extends _BaseGenerator.BaseGenerator {
         if (this._shouldExecute()) {
             // eslint-disable-next-line no-console
             console.log();
+            this.sourceRoot(_path.join(__dirname, '../../templates/solution'));
             super.writing(false);
             const dest = this.destinationRoot();
             this.copyTemplate(_path.join(this.sourceRoot(), 'base'), dest);
-            if (this.context.useHeft) {
+            if (!this.context.useGulp) {
                 this.copyTemplate(_path.join(this.sourceRoot(), 'heft'), dest);
             } else {
                 this.copyTemplate(_path.join(this.sourceRoot(), 'gulp'), dest);
@@ -268,4 +270,4 @@ module.exports = SolutionGenerator;
 module.exports.composeWith = composeWith;
 module.exports.defineOptions = defineOptions;
 
-//#sourceMappingUrl=./index.js.map
+//# sourceMappingURL=./index.js.map

package/lib/generators/webpart/index.js

@@ -103,6 +103,7 @@ class WebpartGenerator extends _BaseComponentGenerator.BaseComponentGenerator {
     }
     writing() {
         if (this._shouldExecute()) {
+            this.sourceRoot(_path.join(__dirname, '../../templates/webpart'));
             super.writing(false);
             const dest = this._getOutputFolder(this.context.componentNameCamelCase);
             const template = this.context.template;
@@ -145,4 +146,4 @@ module.exports = WebpartGenerator;
 module.exports.defineOptions = defineOptions;
 module.exports.composeWith = composeWith;
 
-//#sourceMappingUrl=./index.js.map
+//# sourceMappingURL=./index.js.map

package/lib/{generators/dataVisualizationAdaptiveCardExtension/templates → templates/dataVisualizationAdaptiveCardExtension}/none/{componentClassName}.ts

@@ -19,7 +19,7 @@ export default class <%= componentClassName %> extends BaseAdaptiveCardExtension
   I<%= componentClassName %>Props,
   I<%= componentClassName %>State
 > {
-  private _deferredPropertyPane: <%= componentName %>PropertyPane;
+  private _deferredPropertyPane: <%= componentName %>PropertyPane | undefined;
 
   public onInit(): Promise<void> {
     this.state = { };
@@ -49,6 +49,6 @@ export default class <%= componentClassName %> extends BaseAdaptiveCardExtension
   }
 
   protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
-    return this._deferredPropertyPane?.getPropertyPaneConfiguration();
+    return this._deferredPropertyPane?.getPropertyPaneConfiguration() ?? super.getPropertyPaneConfiguration();
   }
 }

package/lib/{generators/genericAdaptiveCardExtension/templates → templates/genericAdaptiveCardExtension}/none/{componentClassName}.ts

@@ -18,7 +18,7 @@ export default class <%= componentClassName %> extends BaseAdaptiveCardExtension
   I<%= componentClassName %>Props,
   I<%= componentClassName %>State
 > {
-  private _deferredPropertyPane: <%= componentName %>PropertyPane;
+  private _deferredPropertyPane: <%= componentName %>PropertyPane | undefined;
 
   public onInit(): Promise<void> {
     this.state = { };
@@ -48,6 +48,6 @@ export default class <%= componentClassName %> extends BaseAdaptiveCardExtension
   }
 
   protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
-    return this._deferredPropertyPane?.getPropertyPaneConfiguration();
+    return this._deferredPropertyPane?.getPropertyPaneConfiguration() ?? super.getPropertyPaneConfiguration();
   }
 }

package/lib/{generators/searchAdaptiveCardExtension/templates → templates/searchAdaptiveCardExtension}/none/{componentClassName}.ts

@@ -25,7 +25,7 @@ export default class <%= componentClassName %> extends BaseAdaptiveCardExtension
   I<%= componentClassName %>Props,
   I<%= componentClassName %>State
 > {
-  private _deferredPropertyPane: <%= componentName %>PropertyPane;
+  private _deferredPropertyPane: <%= componentName %>PropertyPane | undefined;
 
   public onInit(): Promise<void> {
     this.state = { };
@@ -78,6 +78,6 @@ export default class <%= componentClassName %> extends BaseAdaptiveCardExtension
   }
 
   protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
-    return this._deferredPropertyPane?.getPropertyPaneConfiguration();
+    return this._deferredPropertyPane?.getPropertyPaneConfiguration() ?? super.getPropertyPaneConfiguration();
   }
 }

package/lib/{generators/searchQueryModifier/templates → templates/searchQueryModifier}/base/{componentClassName}.manifest.json

@@ -13,5 +13,5 @@
   // If true, the component can only be installed on sites where Custom Script is allowed.
   // Components that allow authors to embed arbitrary script code should set this to true.
   // https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f
-  "requiresCustomScript": false,
+  "requiresCustomScript": false
 }

package/lib/{generators/solution/templates → templates/solution}/base/README.md

@@ -46,7 +46,7 @@ Short summary on functionality and used technologies.
 - Ensure that you are at the solution folder
 - in the command-line run:
   - **npm install**
-  - **<% if(useHeft){ %>heft start<% } else { %>gulp serve<% } %>**
+  - **<% if(!useGulp){ %>npm run start<% } else { %>gulp serve<% } %>**
 
 > Include any additional steps as needed.
 

package/lib/{generators/solution/templates → templates/solution}/base/_gitignore

@@ -9,6 +9,10 @@ node_modules
 # Build generated files
 dist
 lib
+lib-dts
+lib-commonjs
+lib-esm
+jest-output
 release
 solution
 temp

package/lib/{generators/solution/templates → templates/solution}/base/config/deploy-azure-storage.json

@@ -4,4 +4,4 @@
   "account": "<!-- STORAGE ACCOUNT NAME -->",
   "container": "<%= libraryName %>",
   "accessKey": "<!-- ACCESS KEY -->"
-}
+}

package/lib/templates/solution/heft/_npmignore

@@ -0,0 +1,22 @@
+# Ignore everything by default
+**
+
+# Use negative patterns to bring back the specific things we want to publish
+!/bin/**
+!/dist/**
+!/EULA/**
+!/lib/**
+!ThirdPartyNotice.txt
+
+# Ignore certain files in the above folders
+/dist/*.stats.*
+/dist/**/*.js.map
+/lib/**/*.js.map
+/lib/**/test/**
+
+# NOTE: These don't need to be specified, because NPM includes them automatically.
+#
+# package.json
+# README (and its variants)
+# CHANGELOG (and its variants)
+# LICENSE / LICENCE

package/lib/templates/solution/heft/config/heft.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft.schema.json",
+
+  "extends": "@microsoft/spfx-web-build-rig/profiles/default/config/heft.json",
+
+  "phasesByName": {
+    "build": {
+      "tasksByName": {
+        // copies the localization js files to the lib folder
+        "copy-strings": {
+          "taskPlugin": {
+            "pluginPackage": "@rushstack/heft",
+            "pluginName": "copy-files-plugin",
+            "options": {
+              "copyOperations": [
+                {
+                  "sourcePath": "./src",
+                  "destinationFolders": ["./lib"],
+                  "fileExtensions": [".js"]
+                }
+              ]
+            }
+          }
+        }
+      }
+    },
+    "eject-webpack": {
+      "tasksByName": {
+        "eject-webpack": {
+          "taskPlugin": {
+            "pluginPackage": "@rushstack/heft",
+            "pluginName": "run-script-plugin",
+            "options": {
+              "scriptPath": "node_modules/@microsoft/spfx-heft-plugins/lib-commonjs/plugins/ejectWebpackPlugin/EjectWebpackPlugin.js"
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/lib/templates/solution/heft/config/sass.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/heft/v0/heft-sass-plugin.schema.json",
+
+  "extends": "@microsoft/spfx-web-build-rig/profiles/default/config/sass.json"
+}

package/lib/templates/solution/heft/config/typescript.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@microsoft/spfx-web-build-rig/profiles/default/config/typescript.json",
+
+  "staticAssetsToCopy": {
+    "fileExtensions": [".resx", ".jpg", ".png", ".woff", ".eot", ".ttf", ".svg", ".gif"],
+
+    "includeGlobs": ["webparts/*/loc/*.js"]
+  }
+}

package/lib/templates/solution/heft/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./node_modules/@microsoft/spfx-web-build-rig/profiles/default/tsconfig-base.json"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/generator-sharepoint",
-  "version": "1.21.1",
+  "version": "1.22.0-beta.2",
   "description": "Yeoman generator for the SharePoint Framework",
   "engines": {
     "node": ">=22.14.0 < 23.0.0"
@@ -34,31 +34,32 @@
     }
   },
   "dependencies": {
-    "@rushstack/node-core-library": "5.12.0",
-    "@rushstack/terminal": "0.15.1",
+    "@rushstack/node-core-library": "5.14.0",
+    "@rushstack/terminal": "0.15.4",
     "colors": "~1.2.1",
     "lodash": "4.17.21",
-    "mem-fs": "2.2.1",
+    "mem-fs": "^4.1.2",
     "update-notifier": "5.1.0",
     "uuid": "^9.0.0",
     "yeoman-generator": "5.10.0",
     "yosay": "2.0.2",
-    "@microsoft/spfx-heft-plugins": "1.21.1"
+    "@microsoft/spfx-heft-plugins": "1.22.0-beta.2"
   },
   "devDependencies": {
-    "@microsoft/rush-lib": "5.150.0",
-    "@rushstack/heft": "0.71.0",
-    "@rushstack/heft-isolated-typescript-transpile-plugin": "0.1.1",
-    "@rushstack/heft-typescript-plugin": "0.8.0",
+    "@rushstack/heft": "0.74.3",
+    "@rushstack/heft-isolated-typescript-transpile-plugin": "0.2.2",
+    "@rushstack/heft-typescript-plugin": "0.9.12",
     "@types/inquirer": "7.3.1",
     "@types/lodash": "4.14.117",
-    "@types/mem-fs-editor": "7.0.1",
     "@types/update-notifier": "5.1.0",
     "@types/uuid": "9.0.1",
     "@types/yeoman-generator": "5.2.14",
     "@types/yosay": "2.0.0",
     "eslint": "8.57.1",
-    "@msinternal/internal-node-rig": "0.1.0"
+    "mem-fs-editor": "^11.1.4",
+    "@msinternal/ms-graph-v3-bundle": "3.0.2",
+    "@msinternal/internal-node-rig": "0.1.0",
+    "@msinternal/sp-teams-lib": "0.24.149"
   },
   "scripts": {
     "build": "heft test --clean",

package/lib/generators/solution/templates/heft/_npmignore

@@ -1,16 +0,0 @@
-!dist
-config
-
-gulpfile.js
-
-release
-src
-temp
-
-tsconfig.json
-tslint.json
-
-*.log
-
-.yo-rc.json
-.vscode

package/lib/generators/solution/templates/heft/config/typescript.json

@@ -1,21 +0,0 @@
-{
-  "extends": "@microsoft/spfx-web-build-rig/profiles/default/config/typescript.json",
-
-  "staticAssetsToCopy": {
-    "fileExtensions": [
-      ".resx",
-      ".sass",
-      ".scss",
-      ".css",
-      ".jpg",
-      ".png",
-      ".woff",
-      ".eot",
-      ".ttf",
-      ".svg",
-      ".gif"
-    ],
-
-    "includeGlobs": ["webparts/*/loc/*.js"]
-  }
-}

package/lib/generators/solution/templates/heft/tsconfig.json

@@ -1,6 +0,0 @@
-{
-  "extends": "./node_modules/@microsoft/spfx-web-build-rig/profiles/default/tsconfig-base.json",
-  "compilerOptions": {
-    "skipLibCheck": true
-  }
-}