@sitecore-jss/sitecore-jss-dev-tools 21.2.0-canary.9 → 21.2.0

package/dist/esm/templating/utils.js

@@ -0,0 +1,48 @@
+import fs from 'fs';
+import chokidar from 'chokidar';
+/**
+ * Using @var path find all files and generate output using @var resolveItem function for each file
+ * Can be used to generate list of components, templates, etc.
+ * @param {GetItemsSettings} settings
+ * @returns {Item[]} list of items
+ */
+export function getItems(settings) {
+    const { recursive = true, path, resolveItem, cb, fileFormat = new RegExp(/(.+)(?<!\.d)\.[jt]sx?$/), } = settings;
+    const items = [];
+    const folders = [];
+    if (!fs.existsSync(path))
+        return [];
+    fs.readdirSync(path, { withFileTypes: true }).forEach((item) => {
+        if (item.isDirectory()) {
+            folders.push(item);
+        }
+        if (fileFormat.test(item.name)) {
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const name = item.name.match(fileFormat)[1];
+            items.push(resolveItem(path, name));
+            cb && cb(name);
+        }
+    });
+    for (const folder of folders) {
+        recursive
+            ? items.push(...getItems({
+                path: `${path}/${folder.name}`,
+                resolveItem,
+                cb,
+                fileFormat,
+            }))
+            : items.push(resolveItem(`${path}/${folder.name}`, folder.name));
+    }
+    return items;
+}
+/**
+ * Run watch mode, watching on @var paths
+ * @param {string[]} paths paths to watch by chokidar
+ * @param {Function<void>} cb callback to run on file change
+ */
+export function watchItems(paths, cb) {
+    chokidar
+        .watch(paths, { ignoreInitial: true, awaitWriteFinish: true })
+        .on('add', cb)
+        .on('unlink', cb);
+}

package/nextjs.d.ts

@@ -0,0 +1 @@
+export * from './types/templating/nextjs/index';

package/nextjs.js

@@ -0,0 +1,3 @@
+const templating = require('./dist/cjs/templating/nextjs/index');
+
+module.exports = { ...templating };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-dev-tools",
-  "version": "21.2.0-canary.9",
+  "version": "21.2.0",
   "description": "Utilities to assist in the development and deployment of Sitecore JSS apps.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -33,7 +33,7 @@
     "url": "https://github.com/sitecore/jss/issues"
   },
   "dependencies": {
-    "@sitecore-jss/sitecore-jss": "^21.2.0-canary.9",
+    "@sitecore-jss/sitecore-jss": "21.2.0",
     "axios": "^1.3.2",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -84,9 +84,11 @@
     "typescript": "~4.9.5"
   },
   "types": "types/index.d.ts",
-  "gitHead": "d4ac1db367d5ce2060cd22d543c38019b1d230bb",
+  "gitHead": "579fe8bc9bf89855b9f878fca9d0430e10a36fd0",
   "files": [
     "dist",
-    "types"
+    "types",
+    "/*.js",
+    "/*.d.ts"
   ]
 }

package/react.d.ts

@@ -0,0 +1 @@
+export * from './types/templating/react/index';

package/react.js

@@ -0,0 +1,3 @@
+const templating = require('./dist/cjs/templating/react/index');
+
+module.exports = { ...templating };

package/types/index.d.ts

@@ -13,7 +13,7 @@ export { createDisconnectedDictionaryService, DisconnectedDictionaryServiceOptio
 export { createDefaultDocumentMiddleware, DefaultDocumentMiddlewareOptions, } from './disconnected-server/default-document';
 export { createDefaultDisconnectedServer, DisconnectedServerOptions, } from './disconnected-server/create-default-disconnected-server';
 export { ScJssConfig, JssConfiguration, resolveScJssConfig } from './resolve-scjssconfig';
-export { strip } from './templating/strip';
+export * from './templating';
 export * from './manifest';
 export * from './pipelines';
 export * from './update';

package/types/templating/components.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Describes a file that represents a component definition
+ */
+export interface ComponentFile {
+    path: string;
+    moduleName: string;
+    componentName: string;
+}
+/**
+ * Describes a package and components to be imported
+ */
+export interface PackageDefinition {
+    name: string;
+    components: {
+        moduleName: string;
+        componentName: string;
+    }[];
+}
+/**
+ * Get list of components from @var path
+ * Returns a list of components in the following format:
+ * {
+ *  path: 'path/to/component',
+ *  componentName: 'ComponentName',
+ *  moduleName: 'ComponentName'
+ * }
+ * @param {string} path path to search
+ */
+export declare function getComponentList(path: string): (PackageDefinition | ComponentFile)[];

package/types/templating/index.d.ts

@@ -0,0 +1,4 @@
+export { ComponentFile, PackageDefinition } from './components';
+export { PluginDefinition, generatePlugins, ModuleType } from './plugins';
+export { scaffoldFile } from './scaffold';
+export { strip } from './strip';

package/types/templating/nextjs/generate-component-builder.d.ts

@@ -0,0 +1,39 @@
+import { PackageDefinition } from '../components';
+/**
+ * Generate component builder based on provided settings
+ * @param {Object} [settings] settings for component builder generation
+ * @param {string} [settings.componentRootPath] path to components root
+ * @param {string} [settings.componentBuilderOutputPath] path to component builder output
+ * @param {PackageDefinition[]} [settings.packages] list of packages to include in component builder
+ * @param {boolean} [settings.watch] whether to watch for changes to component builder sources
+ */
+export declare function generateComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, watch, }?: {
+    componentRootPath?: string;
+    componentBuilderOutputPath?: string;
+    packages?: PackageDefinition[];
+    watch?: boolean;
+}): void;
+/**
+ * Watch for changes to component builder sources
+ * @param {Object} settings settings for component builder generation
+ * @param {string} settings.componentRootPath path to components root
+ * @param {string} settings.componentBuilderOutputPath path to component builder output
+ * @param {PackageDefinition[]} settings.packages list of packages to include in component builder
+ */
+export declare function watchComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, }: {
+    componentRootPath: string;
+    componentBuilderOutputPath: string;
+    packages: PackageDefinition[];
+}): void;
+/**
+ * Write component builder to file
+ * @param {Object} settings settings for component builder generation
+ * @param {string} settings.componentRootPath path to components root
+ * @param {string} settings.componentBuilderOutputPath path to component builder output
+ * @param {PackageDefinition[]} settings.packages list of packages to include in component builder
+ */
+export declare function writeComponentBuilder({ componentRootPath, componentBuilderOutputPath, packages, }: {
+    componentRootPath: string;
+    componentBuilderOutputPath: string;
+    packages: PackageDefinition[];
+}): void;

package/types/templating/nextjs/index.d.ts

@@ -0,0 +1,2 @@
+export { generateComponentBuilder } from './generate-component-builder';
+export { getComponentBuilderTemplate } from './templates/component-builder';

package/types/templating/nextjs/templates/component-builder.d.ts

@@ -0,0 +1,7 @@
+import { ComponentFile, PackageDefinition } from '../../components';
+/**
+ * Generate component builder template
+ * @param {(PackageDefinition | ComponentFile)[]} components components to include in component builder
+ * @returns generated component builder template
+ */
+export declare const getComponentBuilderTemplate: (components: (PackageDefinition | ComponentFile)[]) => string;

package/types/templating/plugins.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Identifies the format of the module to be compiled
+ */
+export declare enum ModuleType {
+    CJS = 0,
+    ESM = 1
+}
+/**
+ * Type to specify plugin file details
+ */
+export interface PluginFile {
+    path: string;
+    name: string;
+}
+/**
+ * Definition to be used for plugin registration during bootstrap
+ */
+export interface PluginDefinition {
+    /**
+     * destination path to compile plugins to
+     */
+    distPath: string;
+    /**
+     * source path for where the plugins are defined
+     */
+    rootPath: string;
+    /**
+     * CJS or ESM - which type to compile plugins to
+     */
+    moduleType: ModuleType;
+    /**
+     * whether to use relative or absolute paths in the generated file. By default, absolute paths are used.
+     */
+    relative?: boolean;
+    /**
+     * whether to suppress console output
+     */
+    silent?: boolean;
+}
+/**
+ * Get list of plugins from @var path
+ * Returns a list of plugins in the following format:
+ * {
+ *   path: 'path/to/plugin/foo',
+ *   name: 'fooPlugin'
+ * }
+ * @example getPluginList('src/foo/plugins', 'Foo')
+ * @param {Object} definition plugin definition
+ * @param {string} definition.path path to get plugin from
+ * @param {string} definition.pluginName plugin name
+ * @param {boolean} [definition.silent] whether to suppress console output
+ */
+export declare function getPluginList({ path, pluginName, silent, }: {
+    path: string;
+    pluginName: string;
+    silent?: boolean;
+}): PluginFile[];
+/**
+ * Generates the plugins file and saves it to the filesystem.
+ * By convention, we expect to find plugins under {pluginName}/plugins/** (subfolders are searched recursively).
+ * generated file will be saved to @var {distPath} and will contain a list of plugins in the following format:
+ * CJS: exports.fooPlugin = require('{pluginPath}');
+ * ESM: export { fooPlugin } from '{pluginPath}';
+ * @example generatePlugins({ distPath: 'src/temp/foo-plugins.js', rootPath: 'src/foo/plugins', moduleType: ModuleType.CJS })
+ * @param {PluginDefinition} definition plugin definition
+ */
+export declare function generatePlugins(definition: PluginDefinition): void;

package/types/templating/react/generate-component-builder.d.ts

@@ -0,0 +1,25 @@
+import { PackageDefinition } from '../components';
+/**
+ * Generate component builder based on provided settings
+ * @param {Object} settings settings for component builder generation
+ * @param {string} settings.componentRootPath path to components root
+ * @param {PackageDefinition[]} settings.packages list of packages to include in component builder
+ * @param {boolean} settings.watch whether to watch for changes to component builder sources
+ */
+export declare function generateComponentBuilder({ componentRootPath, packages, watch, }: {
+    componentRootPath?: string;
+    packages?: PackageDefinition[];
+    watch?: boolean;
+}): void;
+/**
+ * Watch for changes to component builder sources
+ * @param {string} componentRootPath root path to components
+ * @param {PackageDefinition[]} [packages] packages to include in component builder
+ */
+export declare function watchComponentBuilder(componentRootPath: string, packages?: PackageDefinition[]): void;
+/**
+ * Write component builder to file
+ * @param {string} componentRootPath root path to components
+ * @param {PackageDefinition[]} [packages] packages to include in component builder
+ */
+export declare function writeComponentBuilder(componentRootPath: string, packages?: PackageDefinition[]): void;

package/types/templating/react/index.d.ts

@@ -0,0 +1,2 @@
+export { getComponentBuilderTemplate } from './templates/component-builder';
+export { generateComponentBuilder } from './generate-component-builder';

package/types/templating/react/templates/component-builder.d.ts

@@ -0,0 +1,8 @@
+import { ComponentFile, PackageDefinition } from '../../components';
+/**
+ * Generate component builder template
+ * @param {(PackageDefinition | ComponentFile)[]} components components to include in component builder
+ * @param {string} distPath destination path for component builder
+ * @returns generated component builder template
+ */
+export declare const getComponentBuilderTemplate: (components: (PackageDefinition | ComponentFile)[], distPath: string) => string;

package/types/templating/scaffold.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Force to use `crlf` line endings, we are using `crlf` across the project.
+ * Replace: `lf` (\n), `cr` (\r)
+ * @param {string} content
+ */
+export declare function editLineEndings(content: string): string;
+/**
+ * Creates a file relative to the specified path if the file doesn't exist.
+ * Creates directories as needed.
+ * Does not overwrite existing files.
+ * @param {string} filePath - the file path
+ * @param {string} fileContent - the file content
+ * @returns {string} the file path if the file was created, otherwise null
+ */
+export declare function scaffoldFile(filePath: string, fileContent: string): string | null;

package/types/templating/utils.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Settings for @var getItems function
+ */
+export type GetItemsSettings<Item> = {
+    /**
+     * items path
+     */
+    path: string;
+    /**
+     * Resolve item in required data format
+     */
+    resolveItem: (path: string, name: string) => Item;
+    /**
+     * Will be called when new file is found
+     */
+    cb?: (name: string) => void;
+    /**
+     * Matches specific files format
+     */
+    fileFormat?: RegExp;
+    /**
+     * Wether to search recursively
+     */
+    recursive?: boolean;
+};
+/**
+ * Using @var path find all files and generate output using @var resolveItem function for each file
+ * Can be used to generate list of components, templates, etc.
+ * @param {GetItemsSettings} settings
+ * @returns {Item[]} list of items
+ */
+export declare function getItems<Item>(settings: GetItemsSettings<Item>): Item[];
+/**
+ * Run watch mode, watching on @var paths
+ * @param {string[]} paths paths to watch by chokidar
+ * @param {Function<void>} cb callback to run on file change
+ */
+export declare function watchItems(paths: string[], cb: () => void): void;