@sitecore-jss/sitecore-jss-dev-tools 22.3.0 → 22.3.1-canary.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sitecore-jss/sitecore-jss-dev-tools",
-  "version": "22.3.0",
+  "version": "22.3.1-canary.2",
   "description": "Utilities to assist in the development and deployment of Sitecore JSS apps.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -13,10 +13,10 @@
     "test": "mocha --require ts-node/register -r tsconfig-paths/register  \"./src/**/*.test.ts\"",
     "prepublishOnly": "npm run build",
     "coverage": "nyc npm test",
-    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --readme none --out ../../ref-docs/sitecore-jss-dev-tools src/index.ts --githubPages false"
+    "generate-docs": "npx typedoc --plugin typedoc-plugin-markdown --outputFileStrategy Members --parametersFormat table --readme none --out ../../ref-docs/sitecore-jss-dev-tools src/index.ts --githubPages false"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "bin": {
     "scjss-deploy": "./dist/cjs/bin/deploy.js",
@@ -33,7 +33,7 @@
   },
   "dependencies": {
     "@babel/parser": "^7.24.0",
-    "@sitecore-jss/sitecore-jss": "22.3.0",
+    "@sitecore-jss/sitecore-jss": "^22.3.1-canary.2",
     "axios": "^1.3.2",
     "chalk": "^4.1.2",
     "chokidar": "^3.6.0",
@@ -66,7 +66,7 @@
     "@types/glob": "^8.0.1",
     "@types/js-yaml": "^4.0.5",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^20.14.2",
+    "@types/node": "^22.9.0",
     "@types/readline-sync": "^1.4.4",
     "@types/resolve": "^1.20.2",
     "@types/sinon": "^10.0.13",
@@ -76,17 +76,17 @@
     "chai": "^4.3.7",
     "cross-env": "^7.0.3",
     "del-cli": "^5.0.0",
-    "eslint": "^8.33.0",
+    "eslint": "^8.56.0",
     "mocha": "^10.2.0",
     "nock": "^13.3.0",
     "nyc": "^15.1.0",
     "sinon": "^15.0.1",
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.1.2",
-    "typescript": "~4.9.5"
+    "typescript": "~5.6.3"
   },
   "types": "types/index.d.ts",
-  "gitHead": "81b0239517966b6d0debdf6da3f12a98228c4d0c",
+  "gitHead": "5b35bbbe22b6ea21a1829950e371d54422ebf8fd",
   "files": [
     "dist",
     "types",

package/types/manifest/generator/generate.d.ts

@@ -24,14 +24,12 @@ export interface GenerateToFileOptions extends GenerateOptions {
  * NOTE: media is not copied into the manifest when using this method,
  * and no files are written to disk. Use generateToFile() to make a manifest
  * that is designed to get packaged/imported.
- *
  * @param {GenerateOptions} config
  */
 export declare function generateToVariable({ requireArg, fileGlobs, pipelines, appName, excludeItems, excludeDictionary, language, pipelinePatchFileGlobs, debug, wipe, rootPlaceholders, skipPlaceholderBlacklist, }: GenerateOptions): Promise<ManifestInstance>;
 /**
  * generates a JSON manifest and writes its contents to a directory. Media referenced in the manifest
  * is also copied to the directory.
- *
  * @param {GenerateToFileOptions} config
  */
 export declare function generateToFile({ outputPath, excludeMedia, ...generateToVariableOptions }: GenerateToFileOptions): Promise<ManifestInstance>;

package/types/manifest/generator/pipelines/generateManifest/generateContentItems.d.ts

@@ -9,7 +9,7 @@ declare const _default: (args: GeneratePipelineArgs) => Promise<{
         appName: string;
         templates: TemplateDefinition[];
         placeholders: import("../../manifest.types").PlaceholderDefinition[];
-        media?: any[] | undefined;
+        media?: any[];
         dictionary: import("../../manifest.types").DictionaryDefinition[];
         language: string;
         wipeExisting: boolean;

package/types/manifest/generator/pipelines/generateManifest/generateDictionary.d.ts

@@ -9,7 +9,7 @@ declare const _default: (args: GeneratePipelineArgs) => {
             nonRoutes: import("../../manifest.types").ItemDefinition[];
         };
         placeholders: import("../../manifest.types").PlaceholderDefinition[];
-        media?: any[] | undefined;
+        media?: any[];
         language: string;
         wipeExisting: boolean;
         rootPlaceholders: string[];

package/types/manifest/generator/pipelines/generateManifest/generatePlaceholders.d.ts

@@ -8,7 +8,7 @@ declare const _default: (args: GeneratePipelineArgs) => Promise<{
             routes: import("../../manifest.types").RouteDefinition[];
             nonRoutes: import("../../manifest.types").ItemDefinition[];
         };
-        media?: any[] | undefined;
+        media?: any[];
         dictionary: import("../../manifest.types").DictionaryDefinition[];
         language: string;
         wipeExisting: boolean;

package/types/manifest/generator/pipelines/generateManifest/generateRenderings.d.ts

@@ -9,7 +9,7 @@ declare const _default: (args: GeneratePipelineArgs) => {
             nonRoutes: import("../../manifest.types").ItemDefinition[];
         };
         placeholders: import("../../manifest.types").PlaceholderDefinition[];
-        media?: any[] | undefined;
+        media?: any[];
         dictionary: import("../../manifest.types").DictionaryDefinition[];
         language: string;
         wipeExisting: boolean;

package/types/manifest/generator/pipelines/generateManifest/generateRouteItems.d.ts

@@ -9,7 +9,7 @@ declare const _default: (args: GeneratePipelineArgs) => Promise<{
         appName: string;
         templates: import("../../manifest.types").TemplateDefinition[];
         placeholders: import("../../manifest.types").PlaceholderDefinition[];
-        media?: any[] | undefined;
+        media?: any[];
         dictionary: import("../../manifest.types").DictionaryDefinition[];
         language: string;
         wipeExisting: boolean;

package/types/manifest/generator/traversal.d.ts

@@ -5,21 +5,18 @@ export declare const traverseItems: (items: any[], callback: (item: any, current
  * `items` is the root of the tree, eg routes or nonRoutes
  * the callback gets two arguments: the item definition, and the item type
  * ('item', 'rendering', or 'datasource')
- *
  * @param {any[]} items
  * @param {Function} callback
  */
 export declare function traverseAllItems(items: any[], callback: (item: any, type: string) => any): void;
 /**
  * Traverses every field value in an item array, including all children, datasource items, etc
- *
  * @param {any} items
  * @param {Function} callback
  */
 export declare function traverseAllFields(items: any, callback: (field: any) => any): void;
 /**
  * Traverses all rendering instance definitions in an item tree
- *
  * @param {any} items
  * @param {Function} callback
  */

package/types/manifest/generator/utils.d.ts

@@ -1,16 +1,15 @@
-/// <reference types="mocha" />
 import { ComponentDefinition, ItemDefinition, TemplateDefinition } from './manifest.types';
 /**
  * Iterates the keys of the given object and constructs a new object with keys that satisfy the given filter function.
- * @param {Object} obj
+ * @param {object} obj
  * @param {Function} filter
- * @returns {Object} filtered object
+ * @returns {object} filtered object
  */
 export declare const filterObject: (obj: any, filter: (key: string, value: any) => boolean) => {};
 export declare const convertComponentDataToFields: ({ data, context: { item }, }: {
     data: any;
     context: {
-        item?: ItemDefinition | undefined;
+        item?: ItemDefinition;
     };
 }) => any[] | undefined;
 export interface FieldValue {
@@ -57,11 +56,11 @@ export declare function findTemplate(templateName: string, templates: Array<Temp
 export declare function findTemplateForComponent(component: ComponentDefinition, templates: Array<TemplateDefinition>): TemplateDefinition | undefined;
 /**
  * Validates that a set of field values are defined on their template definitions
- * @param {Object} fields
+ * @param {object} fields
  * @param {TemplateDefinition | ComponentDefinition} template
  * @param {Function} handleError
  * @param {...Array<Array<TemplateDefinition | ComponentDefinition>>} inheritedTemplates
- * @returns {Object} validated fields
+ * @returns {object} validated fields
  */
 export declare function validateFieldDefinitions(fields: {
     [key: string]: any;

package/types/manifest/generator/validators.d.ts

@@ -1,9 +1,9 @@
 import * as joi from 'joi';
 export declare const validateTemplate: (template: any) => {
     valid: boolean;
-    error?: joi.ValidationError | undefined;
+    error?: joi.ValidationError;
 };
 export declare const validatePlaceholder: (placeholder: any) => {
     valid: boolean;
-    error?: joi.ValidationError | undefined;
+    error?: joi.ValidationError;
 };

package/types/manifest/utils.d.ts

@@ -7,5 +7,5 @@ export interface ResolveFilesArgs {
 export declare const resolveFiles: ({ fileGlob, extensions, recursive, workingDirectory, }: ResolveFilesArgs) => string[];
 export declare const importModules: ({ fileGlobs, workingDirectory, }: {
     fileGlobs: string[];
-    workingDirectory?: string | undefined;
+    workingDirectory?: string;
 }) => (() => unknown)[];

package/types/package-deploy.d.ts

@@ -1,6 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import https from 'https';
 import { ClientRequest, IncomingMessage } from 'http';
 export interface PackageDeployOptions {
@@ -27,7 +24,7 @@ export declare function normalizeFingerprint(fp: string): string;
  */
 export declare function doFingerprintsMatch(fp1: string, fp2: string): boolean;
 /**
- * @param {Object} params
+ * @param {object} params
  * @param {string[]} params.warnings
  * @param {string[]} params.errors
  * @param {Function} params.resolve
@@ -40,7 +37,7 @@ export declare function finishWatchJobStatusTask({ warnings, errors, resolve, re
     reject: () => void;
 }): void;
 /**
- * @param {Object} params
+ * @param {object} params
  * @param {string} params.message
  * @param {string} params.entryLevel
  * @param {string[]} params.warnings
@@ -73,10 +70,10 @@ export declare function extractProxy(proxy?: string): {
  */
 export declare function getHttpsTransport(options: PackageDeployOptions): {
     request: (reqOptions: https.RequestOptions, callback: (res: IncomingMessage) => void) => ClientRequest;
-    createServer<Request_1 extends typeof IncomingMessage = typeof IncomingMessage, Response_1 extends typeof import("http").ServerResponse = typeof import("http").ServerResponse>(requestListener?: import("http").RequestListener<Request_1, Response_1> | undefined): https.Server<Request_1, Response_1>;
-    createServer<Request_2 extends typeof IncomingMessage = typeof IncomingMessage, Response_2 extends typeof import("http").ServerResponse = typeof import("http").ServerResponse>(options: https.ServerOptions<Request_2, Response_2>, requestListener?: import("http").RequestListener<Request_2, Response_2> | undefined): https.Server<Request_2, Response_2>;
-    get(options: string | import("url").URL | https.RequestOptions, callback?: ((res: IncomingMessage) => void) | undefined): ClientRequest;
-    get(url: string | import("url").URL, options: https.RequestOptions, callback?: ((res: IncomingMessage) => void) | undefined): ClientRequest;
+    createServer<Request extends typeof IncomingMessage = typeof IncomingMessage, Response extends typeof import("http").ServerResponse = typeof import("http").ServerResponse>(requestListener?: import("http").RequestListener<Request, Response>): https.Server<Request, Response>;
+    createServer<Request extends typeof IncomingMessage = typeof IncomingMessage, Response extends typeof import("http").ServerResponse = typeof import("http").ServerResponse>(options: https.ServerOptions<Request, Response>, requestListener?: import("http").RequestListener<Request, Response>): https.Server<Request, Response>;
+    get(options: https.RequestOptions | string | import("url").URL, callback?: (res: IncomingMessage) => void): ClientRequest;
+    get(url: string | import("url").URL, options: https.RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest;
     Agent: typeof https.Agent;
     Server: typeof https.Server;
     globalAgent: https.Agent;

package/types/pipelines/configLoader.d.ts

@@ -1,12 +1,12 @@
 export declare const configLoader: ({ fileGlobs, workingDirectory, existingConfig, allowEmptyGlobs, createPipelinesRegistryImplementation, importModulesImplementation, }: {
     fileGlobs: string[];
-    workingDirectory?: string | undefined;
+    workingDirectory?: string;
     existingConfig?: any;
-    allowEmptyGlobs?: boolean | undefined;
-    createPipelinesRegistryImplementation?: ((existingConfig: any) => any) | undefined;
-    importModulesImplementation?: ((options: {
+    allowEmptyGlobs?: boolean;
+    createPipelinesRegistryImplementation?: (existingConfig: any) => any;
+    importModulesImplementation?: (options: {
         fileGlobs: string[];
         workingDirectory: string;
         allowEmptyGlobs: boolean;
-    }) => any) | undefined;
+    }) => any;
 }) => Promise<any>;

package/types/pipelines/pipeline.d.ts

@@ -1,6 +1,6 @@
 import { ExecutablePipeline, Processor } from './pipelineFactory';
 /**
- * @param {Object} args
+ * @param {object} args
  * @param {Processor[]} args.processors the processors to run (optional but must be specified if pipeline is not specified)
  * @param {any} args.pipelineArgs arguments to pass to the pipeline processors
  */

package/types/pipelines/utils.d.ts

@@ -3,12 +3,12 @@ export declare const resolveFiles: ({ fileGlob, extensions, recursive, workingDi
     extensions: string[];
     recursive: boolean;
     workingDirectory: string;
-    allowEmptyGlobs?: boolean | undefined;
+    allowEmptyGlobs?: boolean;
 }) => string | string[];
 export declare const importModules: ({ fileGlobs, workingDirectory, allowEmptyGlobs, }: {
     fileGlobs: string[];
-    workingDirectory?: string | undefined;
-    allowEmptyGlobs?: boolean | undefined;
+    workingDirectory?: string;
+    allowEmptyGlobs?: boolean;
 }) => {
     file: string;
     import: () => Promise<any>;

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

@@ -1,7 +1,7 @@
 import { ComponentFile, PackageDefinition } from '../components';
 /**
  * Generate component builder based on provided settings
- * @param {Object} [settings] settings for component builder generation
+ * @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
@@ -17,7 +17,7 @@ export declare function generateComponentBuilder({ componentRootPath, componentB
 }): void;
 /**
  * Watch for changes to component builder sources
- * @param {Object} settings settings for component builder generation
+ * @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
@@ -31,7 +31,7 @@ export declare function watchComponentBuilder({ componentRootPath, componentBuil
 }): void;
 /**
  * Write component builder to file
- * @param {Object} settings settings for component builder generation
+ * @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

package/types/templating/plugins.d.ts

@@ -45,7 +45,7 @@ export interface PluginDefinition {
  *   name: 'fooPlugin'
  * }
  * @example getPluginList('src/foo/plugins', 'Foo')
- * @param {Object} definition plugin definition
+ * @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

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

@@ -1,7 +1,7 @@
 import { ComponentFile, PackageDefinition } from '../components';
 /**
  * Generate component builder based on provided settings
- * @param {Object} settings settings for component builder generation
+ * @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 {ComponentFile[]} [settings.components] list of components to include in component builder
@@ -27,7 +27,7 @@ export declare function watchComponentBuilder({ componentRootPath, packages, com
 }): void;
 /**
  * Write component builder to file
- * @param {Object} settings settings for component builder generation
+ * @param {object} settings settings for component builder generation
  * @param {string} settings.componentRootPath root path to components
  * @param {PackageDefinition[]} settings.packages packages to include in component builder
  * @param {ComponentFile[]} settings.components list of components to include in component builder