create-sitecore-jss 22.6.0-canary.11 → 22.6.0-canary.13

package/dist/templates/vue/package.json

@@ -1,87 +1,87 @@
-{
-  "name": "<%- appName %>",
-  "version": "0.1.0",
-  "description": "Application utilizing Sitecore JavaScript Services and Vue (vue-cli).",
-  "private": true,
-  "config": {
-    "appName": "<%- appName %>",
-    "rootPlaceholders": [
-      "<%- helper.getAppPrefix(appPrefix, appName) %>jss-main"
-    ],
-    "sitecoreDistPath": "/dist/<%- appName %>",
-    "sitecoreConfigPath": "/App_Config/Include/zzz",
-    "graphQLEndpointPath": "/sitecore/api/graph/edge",
-    "buildArtifactsPath": "./dist",
-    "language": "en"
-  },
-  "author": {
-    "name": "Sitecore Corporation",
-    "url": "https://jss.sitecore.com"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sitecore/jss.git"
-  },
-  "bugs": {
-    "url": "https://github.com/sitecore/jss/issues"
-  },
-  "license": "Apache-2.0",
-  "scripts": {
-    "jss": "jss",
-    "start": "cross-env-shell JSS_MODE=disconnected \"npm-run-all --serial bootstrap --parallel start:vue start:proxy start:watch-components\"",
-    "start:connected": "npm-run-all --serial bootstrap start:vue start:watch-components",
-    "build": "npm-run-all --serial bootstrap build:client build:server",
-    "scaffold": "node scripts/scaffold-component.js",
-    "start:vue": "vue-cli-service serve --open --host localhost",
-    "start:proxy": "node scripts/disconnected-mode-proxy.js",
-    "start:watch-components": "node scripts/generate-component-factory.js --watch",
-    "build:client": "cross-env-shell BUILD_TARGET_ENV=client PUBLIC_URL=$npm_package_config_sitecoreDistPath \"vue-cli-service build\"",
-    "build:server": "cross-env-shell BUILD_TARGET_ENV=server \"vue-cli-service build --no-clean\"",
-    "bootstrap": "node scripts/bootstrap.js",
-    "graphql:update": "cross-env-shell VUE_CLI_BABEL_TRANSPILE_MODULES=true VUE_CLI_BABEL_TARGET_NODE=true \"node -r @babel/register ./scripts/update-graphql-fragment-data.js\"",
-    "lint": "vue-cli-service lint ./src/**/*.vue ./src/**/*.js ./sitecore/definitions/**/*.js ./scripts/**/*.js ./server/**/*.js ./data/**/*.yml",
-    "install-pre-push-hook": "node ./scripts/install-pre-push-hook.js"
-  },
-  "dependencies": {
-    "@apollo/client": "^3.7.4",
-    "@panter/vue-i18next": "~0.15.2",
-    "@sitecore-jss/sitecore-jss-vue": "<%- version %>",
-    "@vue/apollo-composable": "4.0.0-beta.2",
-    "@vue/apollo-option": "^4.0.0",
-    "@vue/apollo-ssr": "^4.0.0",
-    "bootstrap": "^5.2.3",
-    "cross-fetch": "~3.1.5",
-    "graphql": "^16.6.0",
-    "register-service-worker": "~1.7.2",
-    "serialize-javascript": "^6.0.1",
-    "vue": "^3.5.12",
-    "vue-i18n": "9.1.10",
-    "vue-meta": "3.0.0-alpha.10",
-    "vue-router": "4.0.16"
-  },
-  "devDependencies": {
-    "@babel/eslint-parser": "^7.19.1",
-    "@babel/register": "7.18.9",
-    "@sitecore-jss/sitecore-jss-cli": "<%- version %>",
-    "@sitecore-jss/sitecore-jss-dev-tools": "<%- version %>",
-    "@vue/cli-plugin-babel": "~5.0.8",
-    "@vue/cli-plugin-eslint": "~5.0.8",
-    "@vue/cli-service": "~5.0.8",
-    "@vue/eslint-config-prettier": "~7.0.0",
-    "chalk": "~4.1.2",
-    "chokidar": "~3.5.3",
-    "constant-case": "^3.0.4",
-    "cross-env": "~7.0.3",
-    "dotenv": "^16.0.3",
-    "eslint": "^8.56.0",
-    "eslint-plugin-prettier": "^5.0.0",
-    "eslint-plugin-vue": "~9.9.0",
-    "eslint-plugin-yaml": "^0.5.0",
-    "graphql-tag": "^2.12.6",
-    "html-loader": "~1.3.2",
-    "npm-run-all": "~4.1.5",
-    "null-loader": "~4.0.1",
-    "prettier": "^3.0.0",
-    "tslib": "2.5.1"
-  }
-}
+{
+  "name": "<%- appName %>",
+  "version": "0.1.0",
+  "description": "Application utilizing Sitecore JavaScript Services and Vue (vue-cli).",
+  "private": true,
+  "config": {
+    "appName": "<%- appName %>",
+    "rootPlaceholders": [
+      "<%- helper.getAppPrefix(appPrefix, appName) %>jss-main"
+    ],
+    "sitecoreDistPath": "/dist/<%- appName %>",
+    "sitecoreConfigPath": "/App_Config/Include/zzz",
+    "graphQLEndpointPath": "/sitecore/api/graph/edge",
+    "buildArtifactsPath": "./dist",
+    "language": "en"
+  },
+  "author": {
+    "name": "Sitecore Corporation",
+    "url": "https://jss.sitecore.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sitecore/jss.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sitecore/jss/issues"
+  },
+  "license": "Apache-2.0",
+  "scripts": {
+    "jss": "jss",
+    "start": "cross-env-shell JSS_MODE=disconnected \"npm-run-all --serial bootstrap --parallel start:vue start:proxy start:watch-components\"",
+    "start:connected": "npm-run-all --serial bootstrap start:vue start:watch-components",
+    "build": "npm-run-all --serial bootstrap build:client build:server",
+    "scaffold": "node scripts/scaffold-component.js",
+    "start:vue": "vue-cli-service serve --open --host localhost",
+    "start:proxy": "node scripts/disconnected-mode-proxy.js",
+    "start:watch-components": "node scripts/generate-component-factory.js --watch",
+    "build:client": "cross-env-shell BUILD_TARGET_ENV=client PUBLIC_URL=$npm_package_config_sitecoreDistPath \"vue-cli-service build\"",
+    "build:server": "cross-env-shell BUILD_TARGET_ENV=server \"vue-cli-service build --no-clean\"",
+    "bootstrap": "node scripts/bootstrap.js",
+    "graphql:update": "cross-env-shell VUE_CLI_BABEL_TRANSPILE_MODULES=true VUE_CLI_BABEL_TARGET_NODE=true \"node -r @babel/register ./scripts/update-graphql-fragment-data.js\"",
+    "lint": "vue-cli-service lint ./src/**/*.vue ./src/**/*.js ./sitecore/definitions/**/*.js ./scripts/**/*.js ./server/**/*.js ./data/**/*.yml",
+    "install-pre-push-hook": "node ./scripts/install-pre-push-hook.js"
+  },
+  "dependencies": {
+    "@apollo/client": "^3.7.4",
+    "@panter/vue-i18next": "~0.15.2",
+    "@sitecore-jss/sitecore-jss-vue": "<%- version %>",
+    "@vue/apollo-composable": "4.0.0-beta.2",
+    "@vue/apollo-option": "^4.0.0",
+    "@vue/apollo-ssr": "^4.0.0",
+    "bootstrap": "^5.2.3",
+    "cross-fetch": "~3.1.5",
+    "graphql": "^16.6.0",
+    "register-service-worker": "~1.7.2",
+    "serialize-javascript": "^6.0.1",
+    "vue": "^3.5.12",
+    "vue-i18n": "9.1.10",
+    "vue-meta": "3.0.0-alpha.10",
+    "vue-router": "4.0.16"
+  },
+  "devDependencies": {
+    "@babel/eslint-parser": "^7.19.1",
+    "@babel/register": "7.18.9",
+    "@sitecore-jss/sitecore-jss-cli": "<%- version %>",
+    "@sitecore-jss/sitecore-jss-dev-tools": "<%- version %>",
+    "@vue/cli-plugin-babel": "~5.0.8",
+    "@vue/cli-plugin-eslint": "~5.0.8",
+    "@vue/cli-service": "~5.0.8",
+    "@vue/eslint-config-prettier": "~7.0.0",
+    "chalk": "~4.1.2",
+    "chokidar": "~3.5.3",
+    "constant-case": "^3.0.4",
+    "cross-env": "~7.0.3",
+    "dotenv": "^16.0.3",
+    "eslint": "^8.56.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-vue": "~9.9.0",
+    "eslint-plugin-yaml": "^0.5.0",
+    "graphql-tag": "^2.12.6",
+    "html-loader": "~1.3.2",
+    "npm-run-all": "~4.1.5",
+    "null-loader": "~4.0.1",
+    "prettier": "^3.0.0",
+    "tslib": "2.5.1"
+  }
+}

package/dist/templates/vue/public/index.html

@@ -1,27 +1,27 @@
-<!DOCTYPE html>
-<html>
-
-<head>
-  <meta charset="utf-8">
-  <meta http-equiv="X-UA-Compatible" content="IE=edge">
-  <meta name="viewport" content="width=device-width,initial-scale=1.0">
-  <link rel="icon" href="<%= BASE_URL %>favicon.ico">
-</head>
-
-<body>
-  <noscript>
-    You need to enable JavaScript to run this app.
-  </noscript>
-  <div id="root"></div>
-  <script type="application/json" id="__JSS_STATE__">null</script>
-
-  <!--
-    This HTML file is a template.
-    If you open it directly in the browser, you will see an empty page.
-
-    You can add webfonts, meta tags, or analytics to this file.
-    The build step will place the bundled scripts into the <body> tag.
-  -->
-</body>
-
-</html>
+<!DOCTYPE html>
+<html>
+
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width,initial-scale=1.0">
+  <link rel="icon" href="<%= BASE_URL %>favicon.ico">
+</head>
+
+<body>
+  <noscript>
+    You need to enable JavaScript to run this app.
+  </noscript>
+  <div id="root"></div>
+  <script type="application/json" id="__JSS_STATE__">null</script>
+
+  <!--
+    This HTML file is a template.
+    If you open it directly in the browser, you will see an empty page.
+
+    You can add webfonts, meta tags, or analytics to this file.
+    The build step will place the bundled scripts into the <body> tag.
+  -->
+</body>
+
+</html>

package/dist/templates/vue/public/manifest.json

@@ -1,14 +1,14 @@
-{
-  "name": "Sitecore� JSS",
-  "short_name": "Sitecore� JSS",
-  "icons": [
-    {
-      "src": "/img/icons/android-chrome-192x192.png",
-      "sizes": "192x192",
-      "type": "image/png"
-    }
-  ],
-  "start_url": "/index.html",
-  "display": "standalone",
-  "theme_color": "#ffffff"
-}
+{
+  "name": "Sitecore� JSS",
+  "short_name": "Sitecore� JSS",
+  "icons": [
+    {
+      "src": "/img/icons/android-chrome-192x192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    }
+  ],
+  "start_url": "/index.html",
+  "display": "standalone",
+  "theme_color": "#ffffff"
+}

package/dist/templates/vue/public/robots.txt

@@ -1,2 +1,2 @@
-User-agent: *
-Disallow:
+User-agent: *
+Disallow:

package/dist/templates/vue/sitecore/config/{{appName}}.config

@@ -1,89 +1,89 @@
-<!--
-  JSS Sitecore Configuration Patch File
-
-  This configuration file registers the JSS site with Sitecore, and configures the Layout Service
-  to work with it. Config patches need to be deployed to the Sitecore server.
-
-  Normally `jss deploy config` can do this for local development. To manually deploy, or to deploy via CI,
-  this file can be placed in the `App_Config/Include` folder, or a subfolder of it, within the Sitecore site.
--->
-<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/"
-               xmlns:set="http://www.sitecore.net/xmlconfig/set/"
-               xmlns:role="http://www.sitecore.net/xmlconfig/role/">
-  <sitecore>
-    <settings>
-      <!--
-        PROXY CONFIGURATION
-        When running JSS with the headless proxy (node-headless-ssr-proxy),
-        the original IP address of clients is obscured by the proxy.
-        This setting tells Sitecore to read the forwarded header the proxy sends,
-        thus making analytics track the correct original client IP address.
-      -->
-      <setting name="Analytics.ForwardedRequestHttpHeader" set:value="X-Forwarded-For" />
-    </settings>
-    <sites>
-      <!--
-         JSS Site Registration
-        This configures the site with Sitecore - i.e. host headers, item paths.
-        If your JSS app lives within an existing Sitecore site, this may not be necessary.
-
-        IMPORTANT: JSS sites ship in 'live mode', which makes development and testing easy,
-        but disables workflow and publishing. Before going to production, change the `database`
-        below to `web` instead of `master`.
-      -->
-      <site patch:before="site[@name='website']"
-            inherits="website"
-            name="<%- appName %>"
-            hostName="<%- hostName.replace(/^https?:\/\//, '') %>"
-            rootPath="/sitecore/content/<%- appName %>"
-            startItem="/home"
-            database="master" />
-    </sites>
-    <javaScriptServices>
-      <apps>
-        <!--
-          JSS App Registration
-          The JSS app needs to be registered in order to support layout service and import services.
-
-          There are many available attributes, and they inherit the defaults if not explicitly specified here.
-          Defaults are defined in `/App_Config/Sitecore/JavaScriptServices/Sitecore.JavaScriptServices.Apps.config`
-
-          NOTE: graphQLEndpoint enables _Integrated GraphQL_. If not using integrated GraphQL, it can be removed.
-
-          NOTE: layoutServiceConfiguration should be set to "default" when using GraphQL Edge schema.
-          When using integrated GraphQL with Edge schema, a $language value is injected
-          since language is required in all Edge queries. "jss" configuration does not do this (which is backwards
-          compatible with JSS versions < 18.0.0).
-        -->
-        <app name="<%- appName %>"
-             layoutServiceConfiguration="default"
-             sitecorePath="/sitecore/content/<%- appName %>"
-             useLanguageSpecificLayout="true"
-             graphQLEndpoint="/sitecore/api/graph/edge"
-             inherits="defaults" />
-      </apps>
-      <!--
-        IMAGE RESIZING WHITELIST
-        Using Sitecore server-side media resizing (i.e. the `imageParams` or `srcSet` props on the `<Image/>` helper component)
-        could expose your Sitecore server to a denial-of-service attack by rescaling an image with many arbitrary dimensions.
-        In JSS resizing param sets that are unknown are rejected by a whitelist.
-
-        Sets of image sizing parameters that are used in app components must be whitelisted here.
-        If a param set is not whitelisted, the image will be returned _without resizing_.
-
-        To determine the image parameters being used, look at the query string on the `src` of the rendered image, i.e. '/img.jpg?mw=100&h=72' -> mw=100,h=72
-        Note: the parameter sets defined here are comma-delimited (,) instead of &-delimited like the query string. Multiple sets are endline-delimited.
-      -->
-      <allowedMediaParams>
-        <!-- XML element name is arbitary, useful for organizing and patching -->
-        <styleguide-image-sample>
-          mw=100,mh=50
-        </styleguide-image-sample>
-        <styleguide-image-sample-adaptive>
-          mw=300
-          mw=100
-        </styleguide-image-sample-adaptive>
-      </allowedMediaParams>
-    </javaScriptServices>
-  </sitecore>
-</configuration>
+<!--
+  JSS Sitecore Configuration Patch File
+
+  This configuration file registers the JSS site with Sitecore, and configures the Layout Service
+  to work with it. Config patches need to be deployed to the Sitecore server.
+
+  Normally `jss deploy config` can do this for local development. To manually deploy, or to deploy via CI,
+  this file can be placed in the `App_Config/Include` folder, or a subfolder of it, within the Sitecore site.
+-->
+<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/"
+               xmlns:set="http://www.sitecore.net/xmlconfig/set/"
+               xmlns:role="http://www.sitecore.net/xmlconfig/role/">
+  <sitecore>
+    <settings>
+      <!--
+        PROXY CONFIGURATION
+        When running JSS with the headless proxy (node-headless-ssr-proxy),
+        the original IP address of clients is obscured by the proxy.
+        This setting tells Sitecore to read the forwarded header the proxy sends,
+        thus making analytics track the correct original client IP address.
+      -->
+      <setting name="Analytics.ForwardedRequestHttpHeader" set:value="X-Forwarded-For" />
+    </settings>
+    <sites>
+      <!--
+         JSS Site Registration
+        This configures the site with Sitecore - i.e. host headers, item paths.
+        If your JSS app lives within an existing Sitecore site, this may not be necessary.
+
+        IMPORTANT: JSS sites ship in 'live mode', which makes development and testing easy,
+        but disables workflow and publishing. Before going to production, change the `database`
+        below to `web` instead of `master`.
+      -->
+      <site patch:before="site[@name='website']"
+            inherits="website"
+            name="<%- appName %>"
+            hostName="<%- hostName.replace(/^https?:\/\//, '') %>"
+            rootPath="/sitecore/content/<%- appName %>"
+            startItem="/home"
+            database="master" />
+    </sites>
+    <javaScriptServices>
+      <apps>
+        <!--
+          JSS App Registration
+          The JSS app needs to be registered in order to support layout service and import services.
+
+          There are many available attributes, and they inherit the defaults if not explicitly specified here.
+          Defaults are defined in `/App_Config/Sitecore/JavaScriptServices/Sitecore.JavaScriptServices.Apps.config`
+
+          NOTE: graphQLEndpoint enables _Integrated GraphQL_. If not using integrated GraphQL, it can be removed.
+
+          NOTE: layoutServiceConfiguration should be set to "default" when using GraphQL Edge schema.
+          When using integrated GraphQL with Edge schema, a $language value is injected
+          since language is required in all Edge queries. "jss" configuration does not do this (which is backwards
+          compatible with JSS versions < 18.0.0).
+        -->
+        <app name="<%- appName %>"
+             layoutServiceConfiguration="default"
+             sitecorePath="/sitecore/content/<%- appName %>"
+             useLanguageSpecificLayout="true"
+             graphQLEndpoint="/sitecore/api/graph/edge"
+             inherits="defaults" />
+      </apps>
+      <!--
+        IMAGE RESIZING WHITELIST
+        Using Sitecore server-side media resizing (i.e. the `imageParams` or `srcSet` props on the `<Image/>` helper component)
+        could expose your Sitecore server to a denial-of-service attack by rescaling an image with many arbitrary dimensions.
+        In JSS resizing param sets that are unknown are rejected by a whitelist.
+
+        Sets of image sizing parameters that are used in app components must be whitelisted here.
+        If a param set is not whitelisted, the image will be returned _without resizing_.
+
+        To determine the image parameters being used, look at the query string on the `src` of the rendered image, i.e. '/img.jpg?mw=100&h=72' -> mw=100,h=72
+        Note: the parameter sets defined here are comma-delimited (,) instead of &-delimited like the query string. Multiple sets are endline-delimited.
+      -->
+      <allowedMediaParams>
+        <!-- XML element name is arbitary, useful for organizing and patching -->
+        <styleguide-image-sample>
+          mw=100,mh=50
+        </styleguide-image-sample>
+        <styleguide-image-sample-adaptive>
+          mw=300
+          mw=100
+        </styleguide-image-sample-adaptive>
+      </allowedMediaParams>
+    </javaScriptServices>
+  </sitecore>
+</configuration>

package/dist/templates/vue/sitecore/definitions/components/GraphQL-IntegratedDemo.sitecore.graphql

@@ -1,71 +1,71 @@
-# This file contains a GraphQL query that will be executed and the result provided to
-# your JSS component. You can run this query in GraphiQL ($endpoint/ui) for a nice editing experience.
-
-# Note that we're executing _two queries_ (datasource and contextItem)
-# within the context of the IntegratedDemoQuery _operation_. This makes it
-# very efficient at gathering data from multiple sources.
-
-query IntegratedDemoQuery($datasource: String!, $contextItem: String!, $language: String!) {
-  # Datasource query
-  # $datasource will always be set to the ID of the rendering's datasource item
-  # (as long as the GraphQLData helper is used)
-  datasource: item(path: $datasource, language: $language) {
-    id
-    name
-    # Strongly-typed querying on known templates is possible!
-    ...on  <%- helper.getAppPrefix(appPrefix, appName, false) %>GraphQLIntegratedDemo {
-      # Single-line text field
-      sample1 {
-        # the 'jsonValue' field is a JSON blob that represents the object that
-        # should be passed to JSS field rendering helpers (i.e. text, image, link)
-        jsonValue
-        value
-      }
-      # General Link field
-      sample2 {
-        jsonValue
-        # Structured querying of the field's values is possible
-        text
-        target
-        url
-        # Access to the template definition is possible
-        definition {
-          type
-          shared
-        }
-      }
-    }
-  }
-
-  # Context/route item query
-  # $contextItem will always be set to the ID of the current context item (the route item)
-  # (as long as the GraphQLData helper is used)
-  contextItem: item(path: $contextItem, language: $language) {
-    id
-    # Get the page title from the app route template
-    ...on  <%- helper.getAppPrefix(appPrefix, appName, false) %>AppRoute {
-      pageTitle {
-        value
-      }
-    }
-
-    # List the children of the current route
-    children(hasLayout: true) {
-      results {
-        id
-        # typing fragments can be used anywhere!
-        # so in this case, we're grabbing the 'pageTitle'
-        # field on all child route items.
-        ...on  <%- helper.getAppPrefix(appPrefix, appName, false) %>AppRoute {
-          pageTitle {
-            jsonValue
-            value
-          }
-        }
-        url{
-          path
-        }
-      }
-    }
-  }
-}
+# This file contains a GraphQL query that will be executed and the result provided to
+# your JSS component. You can run this query in GraphiQL ($endpoint/ui) for a nice editing experience.
+
+# Note that we're executing _two queries_ (datasource and contextItem)
+# within the context of the IntegratedDemoQuery _operation_. This makes it
+# very efficient at gathering data from multiple sources.
+
+query IntegratedDemoQuery($datasource: String!, $contextItem: String!, $language: String!) {
+  # Datasource query
+  # $datasource will always be set to the ID of the rendering's datasource item
+  # (as long as the GraphQLData helper is used)
+  datasource: item(path: $datasource, language: $language) {
+    id
+    name
+    # Strongly-typed querying on known templates is possible!
+    ...on  <%- helper.getAppPrefix(appPrefix, appName, false) %>GraphQLIntegratedDemo {
+      # Single-line text field
+      sample1 {
+        # the 'jsonValue' field is a JSON blob that represents the object that
+        # should be passed to JSS field rendering helpers (i.e. text, image, link)
+        jsonValue
+        value
+      }
+      # General Link field
+      sample2 {
+        jsonValue
+        # Structured querying of the field's values is possible
+        text
+        target
+        url
+        # Access to the template definition is possible
+        definition {
+          type
+          shared
+        }
+      }
+    }
+  }
+
+  # Context/route item query
+  # $contextItem will always be set to the ID of the current context item (the route item)
+  # (as long as the GraphQLData helper is used)
+  contextItem: item(path: $contextItem, language: $language) {
+    id
+    # Get the page title from the app route template
+    ...on  <%- helper.getAppPrefix(appPrefix, appName, false) %>AppRoute {
+      pageTitle {
+        value
+      }
+    }
+
+    # List the children of the current route
+    children(hasLayout: true) {
+      results {
+        id
+        # typing fragments can be used anywhere!
+        # so in this case, we're grabbing the 'pageTitle'
+        # field on all child route items.
+        ...on  <%- helper.getAppPrefix(appPrefix, appName, false) %>AppRoute {
+          pageTitle {
+            jsonValue
+            value
+          }
+        }
+        url{
+          path
+        }
+      }
+    }
+  }
+}

package/dist/templates/vue/sitecore/gitignore

@@ -1,4 +1,4 @@
-manifest
-package
-update-package
-*.deploysecret.config
+manifest
+package
+update-package
+*.deploysecret.config