@sitecore-content-sdk/nextjs 0.1.0-beta.22 → 0.1.0-beta.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,42 +1,9 @@
1
1
  "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || (function () {
19
- var ownKeys = function(o) {
20
- ownKeys = Object.getOwnPropertyNames || function (o) {
21
- var ar = [];
22
- for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
- return ar;
24
- };
25
- return ownKeys(o);
26
- };
27
- return function (mod) {
28
- if (mod && mod.__esModule) return mod;
29
- var result = {};
30
- if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
- __setModuleDefault(result, mod);
32
- return result;
33
- };
34
- })();
35
2
  Object.defineProperty(exports, "__esModule", { value: true });
36
3
  exports.defineCliConfig = void 0;
37
4
  const config_1 = require("@sitecore-content-sdk/core/config");
38
- const byocTemplate = __importStar(require("../tools/templating/byoc-component"));
39
- const defaultTemplate = __importStar(require("../tools/templating/default-component"));
5
+ const byoc_component_1 = require("../tools/templating/byoc-component");
6
+ const default_component_1 = require("../tools/templating/default-component");
40
7
  /**
41
8
  * Accepts a `SitecoreCliConfigInput` object and returns the Sitecore Content SDK CLI configuration from the specified file,
42
9
  * updated with the required default values.
@@ -59,13 +26,5 @@ function addDefaultScaffoldTemplates(cliConfig) {
59
26
  if (!cliConfig.scaffold.templates) {
60
27
  cliConfig.scaffold.templates = [];
61
28
  }
62
- cliConfig.scaffold.templates.unshift({
63
- name: config_1.ComponentTemplateType.DEFAULT,
64
- generateTemplate: defaultTemplate.generateTemplate,
65
- getNextSteps: defaultTemplate.getNextSteps,
66
- }, {
67
- name: config_1.ComponentTemplateType.BYOC,
68
- generateTemplate: byocTemplate.generateTemplate,
69
- getNextSteps: byocTemplate.getNextSteps,
70
- });
29
+ cliConfig.scaffold.templates.unshift(default_component_1.defaultTemplate, byoc_component_1.byocTemplate);
71
30
  }
@@ -3,8 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.getNextSteps = exports.generateTemplate = void 0;
6
+ exports.byocTemplate = void 0;
7
7
  const chalk_1 = __importDefault(require("chalk"));
8
+ const config_1 = require("@sitecore-content-sdk/core/config");
9
+ const utils_1 = require("./utils");
8
10
  /**
9
11
  * Next.js BYOC component boilerplate
10
12
  * @param {string} componentName - the component name
@@ -52,7 +54,6 @@ FEAAS.External.registerComponent(${componentName}, {
52
54
  });
53
55
  `;
54
56
  };
55
- exports.generateTemplate = generateTemplate;
56
57
  /**
57
58
  * Generates a list of next steps when scaffolding a component.
58
59
  * @param {string} componentOutputPath - The file path where the component file is generated.
@@ -66,4 +67,9 @@ const getNextSteps = (componentOutputPath) => {
66
67
  }
67
68
  return nextSteps;
68
69
  };
69
- exports.getNextSteps = getNextSteps;
70
+ exports.byocTemplate = {
71
+ name: config_1.ComponentTemplateType.BYOC,
72
+ fileExtension: utils_1.COMPONENT_FILE_EXTENSION,
73
+ generateTemplate,
74
+ getNextSteps,
75
+ };
@@ -3,8 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.getNextSteps = exports.generateTemplate = void 0;
6
+ exports.defaultTemplate = void 0;
7
7
  const chalk_1 = __importDefault(require("chalk"));
8
+ const config_1 = require("@sitecore-content-sdk/core/config");
9
+ const utils_1 = require("./utils");
8
10
  /**
9
11
  * Next.js component boilerplate
10
12
  * @param {string} componentName - the component name
@@ -32,7 +34,6 @@ export const Default = (props: ${componentName}Props): JSX.Element => {
32
34
  };
33
35
  `;
34
36
  };
35
- exports.generateTemplate = generateTemplate;
36
37
  /**
37
38
  * Generates a list of next steps when scaffolding a component.
38
39
  * @param {string} componentOutputPath - The file path where the component file is generated.
@@ -45,4 +46,9 @@ const getNextSteps = (componentOutputPath) => {
45
46
  }
46
47
  return nextSteps;
47
48
  };
48
- exports.getNextSteps = getNextSteps;
49
+ exports.defaultTemplate = {
50
+ name: config_1.ComponentTemplateType.DEFAULT,
51
+ fileExtension: utils_1.COMPONENT_FILE_EXTENSION,
52
+ generateTemplate,
53
+ getNextSteps,
54
+ };
@@ -3,8 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.COMPONENT_FILE_EXTENSION = void 0;
6
7
  exports.watchItems = watchItems;
7
8
  const chokidar_1 = __importDefault(require("chokidar"));
9
+ /**
10
+ * The file extension for nextjs components
11
+ */
12
+ exports.COMPONENT_FILE_EXTENSION = 'tsx';
8
13
  /**
9
14
  * Run watch mode, watching on @var paths
10
15
  * @param {string[]} paths paths to watch by chokidar
@@ -1,6 +1,6 @@
1
- import { defineCliConfig as defineCliConfigCore, ComponentTemplateType, } from '@sitecore-content-sdk/core/config';
2
- import * as byocTemplate from '../tools/templating/byoc-component';
3
- import * as defaultTemplate from '../tools/templating/default-component';
1
+ import { defineCliConfig as defineCliConfigCore, } from '@sitecore-content-sdk/core/config';
2
+ import { byocTemplate } from '../tools/templating/byoc-component';
3
+ import { defaultTemplate } from '../tools/templating/default-component';
4
4
  /**
5
5
  * Accepts a `SitecoreCliConfigInput` object and returns the Sitecore Content SDK CLI configuration from the specified file,
6
6
  * updated with the required default values.
@@ -22,13 +22,5 @@ function addDefaultScaffoldTemplates(cliConfig) {
22
22
  if (!cliConfig.scaffold.templates) {
23
23
  cliConfig.scaffold.templates = [];
24
24
  }
25
- cliConfig.scaffold.templates.unshift({
26
- name: ComponentTemplateType.DEFAULT,
27
- generateTemplate: defaultTemplate.generateTemplate,
28
- getNextSteps: defaultTemplate.getNextSteps,
29
- }, {
30
- name: ComponentTemplateType.BYOC,
31
- generateTemplate: byocTemplate.generateTemplate,
32
- getNextSteps: byocTemplate.getNextSteps,
33
- });
25
+ cliConfig.scaffold.templates.unshift(defaultTemplate, byocTemplate);
34
26
  }
@@ -1,10 +1,12 @@
1
1
  import chalk from 'chalk';
2
+ import { ComponentTemplateType } from '@sitecore-content-sdk/core/config';
3
+ import { COMPONENT_FILE_EXTENSION } from './utils';
2
4
  /**
3
5
  * Next.js BYOC component boilerplate
4
6
  * @param {string} componentName - the component name
5
7
  * @returns component generated template
6
8
  */
7
- export const generateTemplate = (componentName) => {
9
+ const generateTemplate = (componentName) => {
8
10
  return `import React from 'react';
9
11
  import * as FEAAS from '@sitecore-feaas/clientside/react';
10
12
 
@@ -51,7 +53,7 @@ FEAAS.External.registerComponent(${componentName}, {
51
53
  * @param {string} componentOutputPath - The file path where the component file is generated.
52
54
  * @returns {string[]} An array of strings, each representing a next step.
53
55
  */
54
- export const getNextSteps = (componentOutputPath) => {
56
+ const getNextSteps = (componentOutputPath) => {
55
57
  const nextSteps = [];
56
58
  nextSteps.push('* Modify component registration through FEAAS.External.registerComponent if needed');
57
59
  if (componentOutputPath) {
@@ -59,3 +61,9 @@ export const getNextSteps = (componentOutputPath) => {
59
61
  }
60
62
  return nextSteps;
61
63
  };
64
+ export const byocTemplate = {
65
+ name: ComponentTemplateType.BYOC,
66
+ fileExtension: COMPONENT_FILE_EXTENSION,
67
+ generateTemplate,
68
+ getNextSteps,
69
+ };
@@ -1,10 +1,12 @@
1
1
  import chalk from 'chalk';
2
+ import { ComponentTemplateType } from '@sitecore-content-sdk/core/config';
3
+ import { COMPONENT_FILE_EXTENSION } from './utils';
2
4
  /**
3
5
  * Next.js component boilerplate
4
6
  * @param {string} componentName - the component name
5
7
  * @returns component generated template
6
8
  */
7
- export const generateTemplate = (componentName) => {
9
+ const generateTemplate = (componentName) => {
8
10
  return `import React from 'react';
9
11
  import { ComponentParams, ComponentRendering } from '@sitecore-content-sdk/nextjs';
10
12
 
@@ -31,10 +33,16 @@ export const Default = (props: ${componentName}Props): JSX.Element => {
31
33
  * @param {string} componentOutputPath - The file path where the component file is generated.
32
34
  * @returns {string[]} An array of strings, each representing a next step.
33
35
  */
34
- export const getNextSteps = (componentOutputPath) => {
36
+ const getNextSteps = (componentOutputPath) => {
35
37
  const nextSteps = [];
36
38
  if (componentOutputPath) {
37
39
  nextSteps.push(`* Implement the React component in ${chalk.green(componentOutputPath)}`);
38
40
  }
39
41
  return nextSteps;
40
42
  };
43
+ export const defaultTemplate = {
44
+ name: ComponentTemplateType.DEFAULT,
45
+ fileExtension: COMPONENT_FILE_EXTENSION,
46
+ generateTemplate,
47
+ getNextSteps,
48
+ };
@@ -1,4 +1,8 @@
1
1
  import chokidar from 'chokidar';
2
+ /**
3
+ * The file extension for nextjs components
4
+ */
5
+ export const COMPONENT_FILE_EXTENSION = 'tsx';
2
6
  /**
3
7
  * Run watch mode, watching on @var paths
4
8
  * @param {string[]} paths paths to watch by chokidar
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sitecore-content-sdk/nextjs",
3
- "version": "0.1.0-beta.22",
3
+ "version": "0.1.0-beta.24",
4
4
  "main": "dist/cjs/index.js",
5
5
  "module": "dist/esm/index.js",
6
6
  "sideEffects": false,
@@ -74,8 +74,8 @@
74
74
  },
75
75
  "dependencies": {
76
76
  "@babel/parser": "^7.26.10",
77
- "@sitecore-content-sdk/core": "0.1.0-beta.22",
78
- "@sitecore-content-sdk/react": "0.1.0-beta.22",
77
+ "@sitecore-content-sdk/core": "0.1.0-beta.24",
78
+ "@sitecore-content-sdk/react": "0.1.0-beta.24",
79
79
  "@vercel/kv": "^3.0.0",
80
80
  "prop-types": "^15.8.1",
81
81
  "recast": "^0.23.11",
@@ -84,7 +84,7 @@
84
84
  },
85
85
  "description": "",
86
86
  "types": "types/index.d.ts",
87
- "gitHead": "5d08aecb15836849a90a2f93f15c6d8ec915f667",
87
+ "gitHead": "68d52610f8306266df0e0ddba6dc6c4d0f284ba5",
88
88
  "files": [
89
89
  "dist",
90
90
  "types",
@@ -1,12 +1,2 @@
1
- /**
2
- * Next.js BYOC component boilerplate
3
- * @param {string} componentName - the component name
4
- * @returns component generated template
5
- */
6
- export declare const generateTemplate: (componentName: string) => string;
7
- /**
8
- * Generates a list of next steps when scaffolding a component.
9
- * @param {string} componentOutputPath - The file path where the component file is generated.
10
- * @returns {string[]} An array of strings, each representing a next step.
11
- */
12
- export declare const getNextSteps: (componentOutputPath: string) => string[];
1
+ import { ScaffoldTemplate } from '@sitecore-content-sdk/core/config';
2
+ export declare const byocTemplate: ScaffoldTemplate;
@@ -1,12 +1,2 @@
1
- /**
2
- * Next.js component boilerplate
3
- * @param {string} componentName - the component name
4
- * @returns component generated template
5
- */
6
- export declare const generateTemplate: (componentName: string) => string;
7
- /**
8
- * Generates a list of next steps when scaffolding a component.
9
- * @param {string} componentOutputPath - The file path where the component file is generated.
10
- * @returns {string[]} An array of strings, each representing a next step.
11
- */
12
- export declare const getNextSteps: (componentOutputPath: string) => string[];
1
+ import { ScaffoldTemplate } from '@sitecore-content-sdk/core/config';
2
+ export declare const defaultTemplate: ScaffoldTemplate;
@@ -1,3 +1,7 @@
1
+ /**
2
+ * The file extension for nextjs components
3
+ */
4
+ export declare const COMPONENT_FILE_EXTENSION = "tsx";
1
5
  /**
2
6
  * Run watch mode, watching on @var paths
3
7
  * @param {string[]} paths paths to watch by chokidar