@yeoman/types 1.0.0 → 1.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yeoman/types",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "private": false,
   "description": "Common API for yeoman's generator/environment stack",
   "keywords": [
@@ -56,5 +56,9 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "cb5b453d1e92fcc70874d4cdaea77cf90fdd60f7"
+  "acceptDependencies": {
+    "mem-fs": ">=3.0.0",
+    "mem-fs-editor": ">=10.0.2"
+  },
+  "gitHead": "2baf8182008a615c9354e4bf980b7dba4d74b81d"
 }

package/types/environment/adapter.d.ts

@@ -42,6 +42,10 @@ type Task<TaskResultType> =
   | ((adapter: InputOutputAdapter) => PromiseLike<TaskResultType>)
   | ((adapter: InputOutputAdapter) => TaskResultType);
 
+export type ProgressCallback<ReturnType> = (progress: { step: (prefix: string, message: string, ...args: any[]) => void }) => ReturnType;
+export type ProgressOptions = { disabled?: boolean; name?: string };
+
 export type QueuedAdapter = InputOutputAdapter & {
   queue<TaskResultType>(fn: Task<TaskResultType>): Promise<void | TaskResultType>;
+  progress<ResultType>(fn: ProgressCallback<ResultType>, options?: ProgressOptions): Promise<void | ResultType>;
 };

package/types/environment/environment.d.ts

@@ -16,16 +16,22 @@ import type {
 } from './methods-options.js';
 
 export type EnvironmentConstructor<A extends InputOutputAdapter = InputOutputAdapter> = new (
-  options?: BaseEnvironmentOptions,
+  options?: BaseEnvironmentOptions<A>,
+  /** @deprecated */
   adapter?: A,
 ) => BaseEnvironment<A>;
 
-export type BaseEnvironmentOptions = BaseGeneratorOptions & {
+export type BaseEnvironmentOptions<A extends InputOutputAdapter = InputOutputAdapter> = BaseGeneratorOptions & {
   /**
    * The working-directory of the environment.
    */
   cwd?: string | undefined;
 
+  /**
+   * The working-directory for logs.
+   */
+  logCwd?: string | undefined;
+
   /**
    * A value indicating whether the experimental features should be enabled.
    */
@@ -40,6 +46,11 @@ export type BaseEnvironmentOptions = BaseGeneratorOptions & {
    * `mem-fs` Store.
    */
   sharedFs?: Store;
+
+  /**
+   * Input/Output adapter.
+   */
+  adapter?: A;
 };
 
 export type ApplyTransformsOptions = {
@@ -56,6 +67,10 @@ export type BaseEnvironment<A = InputOutputAdapter, S extends Store<MemFsEditorF
   cwd: string;
   adapter: A;
   sharedFs: S;
+  /**
+   * The working-directory for logs.
+   */
+  logCwd: string;
 
   emit(eventName: string | symbol, ...args: any[]): boolean;
   on(eventName: string | symbol, listener: (...args: any[]) => void): unknown;