create-sitecore-jss 22.2.0-canary.8 → 22.2.0-canary.80

package/dist/templates/node-headless-ssr-proxy/src/index.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 import compression from 'compression';
 import 'dotenv/config';
-import scProxy from '@sitecore-jss/sitecore-jss-proxy';
+import { headlessProxy } from '@sitecore-jss/sitecore-jss-proxy';
 import { config } from './config';
 //import { cacheMiddleware } from './cacheMiddleware';
 
@@ -42,7 +42,14 @@ server.use((req, _res, next) => {
 });
 
 // For any other requests, we render app routes server-side and return them
-server.use('*', scProxy(config.serverBundle.renderView, config, config.serverBundle.parseRouteUrl));
+server.use(
+  '*',
+  headlessProxy.middleware(
+    config.serverBundle.renderView,
+    config,
+    config.serverBundle.parseRouteUrl
+  )
+);
 
 server.listen(port, () => {
   console.log(`server listening on port ${port}!`);

package/dist/templates/node-xmcloud-proxy/.env

@@ -1,4 +1,10 @@
-# Your proxy port (default: 3001)
+# To secure the Sitecore editor endpoint exposed by your proxy app
+# (`/api/editing/render` by default), a secret token is used.
+# The environment variable is used by `editingRouter`
+# We recommend an alphanumeric value of at least 16 characters.
+JSS_EDITING_SECRET=
+
+# Your proxy port (default: 3000)
 PROXY_PORT=
 
 # Your proxy server bundle path

package/dist/templates/node-xmcloud-proxy/README.md

@@ -33,4 +33,4 @@ The following environment variables can be set to configure the Proxy sample ins
 1. Run `npm run start`
 
 You should be able to see the following message:
-`server listening on port 3001!`.
+`server listening on port 3000!`.

package/dist/templates/node-xmcloud-proxy/gitignore

@@ -0,0 +1,33 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+
+# dependencies
+/node_modules
+
+# local env files
+.env.local
+.env.*.local
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+/connect.lock
+/libpeerconnection.log
+npm-debug.log
+testem.log
+/typings
+
+# System Files
+.DS_Store
+Thumbs.db
+
+# deploy platforms
+.vercel
+.netlify

package/dist/templates/node-xmcloud-proxy/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-xmcloud-sample",
-  "version": "22.1.0-canary",
+  "version": "22.2.0-canary",
   "description": "Node XM Cloud Proxy sample for running XM Cloud JSS SPA apps",
   "author": {
     "name": "Sitecore Corporation",
@@ -10,13 +10,14 @@
     "start": "ts-node ./src/index.ts"
   },
   "dependencies": {
+    "@sitecore-jss/sitecore-jss-proxy": "~22.2.0-canary",
     "compression": "^1.7.4",
     "express": "^4.18.2",
     "dotenv": "^16.0.3",
     "http-proxy-middleware": "^3.0.0"
   },
   "devDependencies": {
-    "@sitecore-jss/sitecore-jss": "~22.1.0-canary",
+    "@sitecore-jss/sitecore-jss": "~22.2.0-canary",
     "@types/compression": "^1.7.2",
     "@types/express": "^4.17.17",
     "ts-node": "^10.9.1",

package/dist/templates/node-xmcloud-proxy/src/config.ts

@@ -3,9 +3,15 @@ import { Config, ServerBundle } from './types';
 /**
  * The server.bundle.js file from your pre-built SPA app.
  */
-const bundlePath = process.env.PROXY_BUNDLE_PATH || `../dist/server.bundle`;
+const bundlePath = process.env.PROXY_BUNDLE_PATH || '../dist/server.bundle';
 
-const serverBundle: ServerBundle = require(bundlePath);
+let serverBundle: ServerBundle;
+
+try {
+  serverBundle = require(bundlePath);
+} catch (error) {
+  throw new Error(`ERROR: The server.bundle.js error. ${error}`);
+}
 
 export const config: Config = {
   /**
@@ -15,5 +21,5 @@ export const config: Config = {
   /**
    * Port which will be used when start the proxy
    */
-  port: process.env.PROXY_PORT || 3001,
+  port: process.env.PROXY_PORT || 3000,
 };

package/dist/templates/node-xmcloud-proxy/src/index.ts

@@ -3,6 +3,8 @@ import express, { Response } from 'express';
 import compression from 'compression';
 import { createProxyMiddleware } from 'http-proxy-middleware';
 import { debug } from '@sitecore-jss/sitecore-jss';
+import { editingRouter } from '@sitecore-jss/sitecore-jss-proxy';
+import { healthCheck } from '@sitecore-jss/sitecore-jss-proxy';
 import { config } from './config';
 
 const server = express();
@@ -21,12 +23,12 @@ const requiredProperties = [
   'renderView',
   'parseRouteUrl',
   'clientFactory',
-  'siteName',
+  'getClientFactoryConfig',
   'defaultLanguage',
   'layoutServiceFactory',
   'dictionaryServiceFactory',
-  'graphQLEndpointPath',
-  'graphQLEndpoint',
+  'components',
+  'metadata',
 ];
 
 const missingProperties = requiredProperties.filter((property) => !config.serverBundle[property]);
@@ -43,6 +45,31 @@ const layoutService = layoutServiceFactory.create();
 
 const dictionaryService = dictionaryServiceFactory.create();
 
+const clientFactoryConfig = config.serverBundle.getClientFactoryConfig();
+
+/**
+ * GraphQL endpoint resolution to meet the requirements of the http-proxy-middleware
+ */
+const graphQLEndpoint = (() => {
+  try {
+    const graphQLEndpoint = new URL(clientFactoryConfig.endpoint);
+    // Browser request path to the proxy. Includes only the pathname.
+    const pathname = graphQLEndpoint.pathname;
+    // Target URL for the proxy. Can't include the query string.
+    const target = `${graphQLEndpoint.protocol}//${graphQLEndpoint.hostname}${pathname}`;
+
+    return {
+      target,
+      path: pathname,
+    };
+  } catch (error) {
+    throw new Error(
+      `ERROR: The serverBundle should export a getClientFactoryConfig function with valid GraphQL endpoint URL returned, current value is ${clientFactoryConfig.endpoint}. ` +
+        'Please check your server bundle.'
+    );
+  }
+})();
+
 /**
  * Parse requested url in order to detect current route and language
  * @param {string} reqRoute requested route
@@ -94,13 +121,35 @@ server.use(
  * Proxy browser GraphQL requests to the Sitecore GraphQL endpoint
  */
 server.use(
-  config.serverBundle.graphQLEndpointPath,
+  graphQLEndpoint.path,
   createProxyMiddleware({
-    target: config.serverBundle.graphQLEndpoint,
+    target: graphQLEndpoint.target,
     changeOrigin: true,
   })
 );
 
+/**
+ * The health check endpoint
+ */
+server.use(healthCheck());
+
+/**
+ * Proxy editing requests through the editing router
+ */
+server.use(
+  '/api/editing',
+  editingRouter({
+    config: {
+      components: config.serverBundle.components,
+      metadata: config.serverBundle.metadata,
+    },
+    render: {
+      clientFactory: config.serverBundle.clientFactory,
+      renderView,
+    },
+  })
+);
+
 server.use(async (req, res) => {
   debug.proxy(`performing SSR for ${req.originalUrl}`);
 

package/dist/templates/node-xmcloud-proxy/src/types.ts

@@ -1,55 +1,23 @@
-import { GraphQLRequestClientFactory } from '@sitecore-jss/sitecore-jss';
+import {
+  GraphQLRequestClientFactory,
+  GraphQLRequestClientFactoryConfig,
+} from '@sitecore-jss/sitecore-jss';
 import { DictionaryService } from '@sitecore-jss/sitecore-jss/i18n';
-import { LayoutService, LayoutServiceData } from '@sitecore-jss/sitecore-jss/layout';
-
-interface ServerResponse {
-  /**
-   * The rendered HTML to return to the client
-   */
-  html: string;
-  /**
-   * Set the HTTP status code. If not set, the status code returned from Layout Service is returned.
-   */
-  status?: number;
-  /**
-   * Sets a redirect URL, causing the reply to send a HTTP redirect instead of the HTML content.
-   * Note: when using this you must set the status code to 301 or 302.
-   */
-  redirect?: string;
-}
-
-declare type AppRenderer = (
-  callback: (error: Error | null, result: ServerResponse | null) => void,
-  path: string,
-  /**
-   * Data returned by Layout Service. If the route does not exist, null.
-   */
-  layoutData: LayoutServiceData,
-  viewBag: {
-    [key: string]: unknown;
-    dictionary: { [key: string]: string };
-  }
-) => void;
-
-declare type RouteUrlParser = (
-  url: string
-) => {
-  sitecoreRoute?: string;
-  lang?: string;
-  qsParams?: string;
-};
+import { Metadata } from '@sitecore-jss/sitecore-jss/utils';
+import { LayoutService } from '@sitecore-jss/sitecore-jss/layout';
+import { AppRenderer, RouteUrlParser } from '@sitecore-jss/sitecore-jss-proxy';
 
 export interface ServerBundle {
   [key: string]: unknown;
   renderView: AppRenderer;
   parseRouteUrl: RouteUrlParser;
   clientFactory: GraphQLRequestClientFactory;
-  siteName: string;
+  getClientFactoryConfig: () => GraphQLRequestClientFactoryConfig;
   defaultLanguage: string;
   layoutServiceFactory: { create: () => LayoutService };
   dictionaryServiceFactory: { create: () => DictionaryService };
-  graphQLEndpointPath: string;
-  graphQLEndpoint: string;
+  components: string[] | Map<string, unknown>;
+  metadata: Metadata;
 }
 
 export interface Config {

package/dist/templates/react/scripts/generate-config.js

@@ -31,6 +31,11 @@ generateConfig();
  * NOTE! Any configs returned here will be written into the client-side JS bundle. DO NOT PUT SECRETS HERE.
  */
 function generateConfig() {
+  // Handle undefined values
+  Object.keys(defaultConfig).forEach((prop) => {
+    defaultConfig[prop] = defaultConfig[prop] || '';
+  });
+
   try {
     config = jssConfigFactory.create(defaultConfig);
   } catch (error) {
@@ -50,9 +55,11 @@ const config = {};\n`;
 
   // Set base configuration values, allowing override with environment variables
   Object.keys(config).forEach(prop => {
-    configText += `config.${prop} = process.env.REACT_APP_${constantCase(prop)} || "${
-      config[prop]?.trim()
-    }";\n`;
+    // Handle undefined values
+    const value = config[prop] || '';
+    configText += `config.${prop} = process.env.REACT_APP_${constantCase(
+      prop
+    )} || "${value.trim()}";\n`;
   });
   configText += 'module.exports = config;';
 

package/dist/templates/vue/scripts/generate-config.js

@@ -33,6 +33,11 @@ module.exports = function generateConfig(configOverrides) {
   // and finally config passed in the configOverrides param wins.
   const config = Object.assign(defaultConfig, scjssConfig, packageJson, configOverrides);
 
+  // Handle undefined values
+  Object.keys(config).forEach((prop) => {
+    config[prop] = config[prop] || '';
+  });
+
   // The GraphQL endpoint is an example of making a _computed_ config setting
   // based on other config settings.
   const computedConfig = {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-sitecore-jss",
-  "version": "22.2.0-canary.8",
+  "version": "22.2.0-canary.80",
   "description": "Sitecore JSS initializer",
   "bin": "./dist/index.js",
   "scripts": {
@@ -63,5 +63,5 @@
     "ts-node": "^10.9.1",
     "typescript": "~4.9.5"
   },
-  "gitHead": "755525262fcb998452876d2f28a57d130e29731c"
+  "gitHead": "0ecca7f10712e929cfe4375ccfbd479020cd30fc"
 }

package/dist/templates/angular/scripts/generate-component-factory.ts

@@ -1,166 +0,0 @@
-import * as fs from 'fs';
-const path = require('path');
-const chokidar = require('chokidar');
-
-/*
-  COMPONENT FACTORY GENERATION
-  Generates the /src/app/components/app-components.module.ts file which maps Angular components
-  to JSS components.
-
-  The component factory module defines a mapping between a string component name and a Angular component instance.
-  When the Sitecore Layout service returns a layout definition, it returns named components.
-  This mapping is used to construct the component hierarchy for the layout.
-
-  NOTE: this script can run in two modes. The default mode, the component factory file is written once.
-  But if `--watch` is a process argument, the component factory source folder will be watched,
-  and the componentFactory.js rewritten on added or deleted files.
-  This is used during `jss start` to pick up new or removed components at runtime.
-*/
-
-export interface PackageDefinition {
-  name: string;
-  components: {
-    moduleName: string;
-    componentName: string;
-  }[];
-}
-
-const componentFactoryPath = path.resolve('src/app/components/app-components.module.ts');
-const componentRootPath = 'src/app/components';
-
-const isWatch = process.argv.some((arg) => arg === '--watch');
-
-if (isWatch) {
-  watchComponentFactory();
-} else {
-  writeComponentFactory();
-}
-
-function watchComponentFactory() {
-  console.log(`Watching for changes to component factory sources in ${componentRootPath}...`);
-
-  chokidar
-    .watch(componentRootPath, { ignoreInitial: true, awaitWriteFinish: true })
-    .on('add', writeComponentFactory)
-    .on('unlink', writeComponentFactory);
-}
-
-function writeComponentFactory() {
-  const componentFactory = generateComponentFactory();
-
-  console.log(`Writing component factory to ${componentFactoryPath}`);
-
-  fs.writeFileSync(componentFactoryPath, componentFactory, { encoding: 'utf8' });
-}
-
-function generateComponentFactory() {
-  // By convention, we expect to find Angular components
-  // under /src/app/components/component-name/component-name.component.ts
-  // If a component-name.module.ts file exists, we will treat it as lazy loaded.
-  // If you'd like to use your own convention, encode it below.
-  // NOTE: generating the component factory module is also totally optional,
-  // and it can be maintained manually if preferred.
-
-  const imports: string[] = [];
-  /**
-   * You can specify components which you want to import from external/internal packages
-   * in format:
-   *  {
-   *    name: 'package name',
-   *    components: [
-   *      {
-   *        componentName: 'component name', // component rendering name,
-   *        moduleName: 'module name' // component name to import from the package
-   *      }
-   *    ]
-   *  }
-   */
-  const packages: PackageDefinition[] = [];
-  const registrations: string[] = [];
-  const lazyRegistrations: string[] = [];
-  const declarations: string[] = [];
-
-  packages.forEach((p) => {
-    const variables = p.components
-      .map((c) => {
-        registrations.push(`{ name: '${c.componentName}', type: ${c.moduleName} },`);
-        declarations.push(`${c.moduleName},`);
-
-        return c.moduleName;
-      })
-      .join(', ');
-    imports.push(`import { ${variables} } from '${p.name}'`);
-  });
-
-  fs.readdirSync(componentRootPath).forEach((componentFolder) => {
-    // ignore ts files in component root folder
-    if (componentFolder.endsWith('.ts') || componentFolder === '.gitignore') {
-      return;
-    }
-
-    const componentFilePath = path.join(componentRootPath, componentFolder, `${componentFolder}.component.ts`);
-
-    if (!fs.existsSync(componentFilePath)) {
-      return;
-    }
-
-    const componentFileContents = fs.readFileSync(componentFilePath, 'utf8');
-
-    // ASSUMPTION: your component should export a class directly that follows Angular conventions,
-    // i.e. `export class FooComponent` - so we can detect the component's name for auto registration.
-    const componentClassMatch = /export class (.+?)Component\b/g.exec(componentFileContents);
-
-    if (componentClassMatch === null) {
-      console.debug(`Component ${componentFilePath} did not seem to export a component class. It will be skipped.`);
-      return;
-    }
-
-    const componentName = componentClassMatch[1];
-    const importVarName = `${componentName}Component`;
-
-    // check for lazy loading needs
-    const moduleFilePath = path.join(componentRootPath, componentFolder, `${componentFolder}.module.ts`);
-    const isLazyLoaded = fs.existsSync(moduleFilePath);
-
-    if (isLazyLoaded) {
-      console.debug(`Registering JSS component (lazy) ${componentName}`);
-      lazyRegistrations.push(`{ path: '${componentName}', loadChildren: () => import('./${componentFolder}/${componentFolder}.module').then(m => m.${componentName}Module) },`);
-    } else {
-      console.debug(`Registering JSS component ${componentName}`);
-      imports.push(`import { ${importVarName} } from './${componentFolder}/${componentFolder}.component';`);
-      registrations.push(`{ name: '${componentName}', type: ${importVarName} },`);
-      declarations.push(`${importVarName},`);
-    }
-  });
-
-  return `// Do not edit this file, it is auto-generated at build time!
-// See scripts/generate-component-factory.js to modify the generation of this file.
-// Use app-components.shared.module.ts to modify the imports, etc of this module.
-// Note: code-generation is optional! See ./.gitignore for directions to remove it,
-// if you do not want it.
-
-import { NgModule } from '@angular/core';
-import { JssModule } from '@sitecore-jss/sitecore-jss-angular';
-import { AppComponentsSharedModule } from './app-components.shared.module';
-${imports.join('\n')}
-
-@NgModule({
-  imports: [
-    AppComponentsSharedModule,
-    JssModule.withComponents([
-      ${registrations.join('\n      ')}
-    ], [
-      ${lazyRegistrations.join('\n      ')}
-    ]),
-  ],
-  exports: [
-    JssModule,
-    AppComponentsSharedModule,
-  ],
-  declarations: [
-    ${declarations.join('\n    ')}
-  ],
-})
-export class AppComponentsModule { }
-`;
-}

package/dist/templates/angular/src/app/lib/graphql-client-factory.ts

@@ -1,28 +0,0 @@
-import {
-  GraphQLRequestClientFactoryConfig,
-  GraphQLRequestClient,
-} from '@sitecore-jss/sitecore-jss-angular';
-import { environment as env } from '../../environments/environment';
-
-// The GraphQLRequestClientFactory serves as the central hub for executing GraphQL requests within the application
-
-/**
- * Creates a new GraphQLRequestClientFactory instance
- * @returns GraphQLRequestClientFactory instance
- */
-export const createGraphQLClientFactory = () => {
-  let clientConfig: GraphQLRequestClientFactoryConfig;
-
-  if (env.graphQLEndpoint && env.sitecoreApiKey) {
-    clientConfig = {
-      endpoint: env.graphQLEndpoint,
-      apiKey: env.sitecoreApiKey,
-    };
-  } else {
-    throw new Error('Please configure your graphQLEndpoint and sitecoreApiKey.');
-  }
-
-  return GraphQLRequestClient.createClientFactory(clientConfig);
-};
-
-export const clientFactory = createGraphQLClientFactory();

package/dist/templates/angular-xmcloud/src/app/lib/graphql-client-factory.ts

@@ -1,44 +0,0 @@
-import {
-  GraphQLRequestClientFactoryConfig,
-  GraphQLRequestClient,
-} from '@sitecore-jss/sitecore-jss-angular';
-import { environment as env } from '../../environments/environment';
-
-// The GraphQLRequestClientFactory serves as the central hub for executing GraphQL requests within the application
-
-/**
- * Creates a new GraphQLRequestClientFactory instance
- * @returns GraphQLRequestClientFactory instance
- */
-export const createGraphQLClientFactory = () => {
-  let clientConfig: GraphQLRequestClientFactoryConfig;
-
-  // If we are in a production environment we are going to use Node XM Cloud proxy
-  if (env.production === 'true') {
-    if (env.proxyHost && env.sitecoreApiKey && env.graphQLEndpoint) {
-      // Server side requests should go directly to the Sitecore, browser requests should go through the proxy.
-      clientConfig = {
-        endpoint:
-          typeof window === 'undefined'
-            ? env.graphQLEndpoint
-            : `${env.proxyHost}${env.graphQLEndpointPath}`,
-        apiKey: env.sitecoreApiKey,
-      };
-    } else {
-      throw new Error('Please configure your proxyHost, sitecoreApiKey, graphQLEndpoint.');
-    }
-  } else {
-    if (env.graphQLEndpoint && env.sitecoreApiKey) {
-      clientConfig = {
-        endpoint: env.graphQLEndpoint,
-        apiKey: env.sitecoreApiKey,
-      };
-    } else {
-      throw new Error('Please configure your graphQLEndpoint and sitecoreApiKey.');
-    }
-  }
-
-  return GraphQLRequestClient.createClientFactory(clientConfig);
-};
-
-export const clientFactory = createGraphQLClientFactory();