@yeoman/types 0.5.0 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yeoman/types",
-  "version": "0.5.0",
+  "version": "1.0.1",
   "private": false,
   "description": "Common API for yeoman's generator/environment stack",
   "keywords": [
@@ -56,5 +56,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "3ed560f6ed88dc0e2cc414b77676462f2934aad2"
+  "gitHead": "3bf825011c63cd0a235f8fbf4a0cc14c77cf9dc2"
 }

package/types/environment/environment.d.ts

@@ -1,4 +1,4 @@
-import type { Transform } from 'node:stream';
+import type { PipelineSource, Transform } from 'node:stream';
 import type { Store } from 'mem-fs';
 import type { MemFsEditorFile } from 'mem-fs-editor';
 
@@ -16,11 +16,12 @@ 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.
    */
@@ -40,21 +41,31 @@ export type BaseEnvironmentOptions = BaseGeneratorOptions & {
    * `mem-fs` Store.
    */
   sharedFs?: Store;
+
+  /**
+   * Input/Output adapter.
+   */
+  adapter?: A;
 };
 
 export type ApplyTransformsOptions = {
   name?: string;
   log?: boolean;
-  stream?: ReturnType<Store<MemFsEditorFile>['stream']>;
+  stream?: PipelineSource<any>;
   streamOptions?: Parameters<Store<MemFsEditorFile>['stream']>[0];
 };
 
+/**
+ * BaseEnvironment provides the api used by yeoman-test and yeoman-generator that should remain stable between major yeoman-environment versions.
+ */
 export type BaseEnvironment<A = InputOutputAdapter, S extends Store<MemFsEditorFile> = Store<MemFsEditorFile>> = {
   cwd: string;
   adapter: A;
   sharedFs: S;
 
   emit(eventName: string | symbol, ...args: any[]): boolean;
+  on(eventName: string | symbol, listener: (...args: any[]) => void): unknown;
+  once(eventName: string | symbol, listener: (...args: any[]) => void): unknown;
 
   applyTransforms(transformStreams: Transform[], options?: ApplyTransformsOptions): Promise<void>;
 
@@ -184,19 +195,6 @@ export type BaseEnvironment<A = InputOutputAdapter, S extends Store<MemFsEditorF
    */
   lookup(options?: LookupOptions): Promise<LookupGeneratorMeta[]>;
 
-  /**
-   * Checks whether a package with the specified `packageNamespace` has been registered.
-   *
-   * @param packageNamespace The package-namespace to check.
-   * @returns A value indicating whether a package with the specified `packageNamespace` has been registered.
-   */
-  isPackageRegistered(packageNamespace: string): boolean;
-
-  /**
-   * Gets the namespaces of all registered packages.
-   */
-  getRegisteredPackages(): string[];
-
   /**
    * Returns stored generators meta
    */

package/types/environment/methods-options.d.ts

@@ -40,30 +40,21 @@ export type LookupOptions = {
 };
 
 /**
- * Provides information about a generator.
+ * Provides lookup information about a generator.
  */
-export type LookupGeneratorMeta = {
-  /**
-   * A value indicating whether the generator could be registered.
-   */
-  registered: boolean;
-
-  /**
-   * The resolved path to the generator.
-   */
-  generatorPath?: string;
-
-  /**
-   * The namespace of the generator.
-   */
-  namespace?: string;
+export type LookupGeneratorMeta = NotRegisteredLookupGeneratorMeta | RegisteredLookupGeneratorMeta;
 
-  /**
-   * The path to the package containing the generator.
-   */
-  packagePath?: string;
+export type NotRegisteredLookupGeneratorMeta = Required<BaseGeneratorMeta> & {
+  /** Failed to register. */
+  registered: false;
 };
 
+export type RegisteredLookupGeneratorMeta = Required<BaseGeneratorMeta> &
+  GeneratorMeta & {
+    /** Successfully registered package. */
+    registered: true;
+  };
+
 export type BaseGeneratorMeta = {
   /** The key under which the generator can be retrieved */
   namespace: string;

package/types/generator/generator.d.ts

@@ -6,6 +6,10 @@ export type EnvironmentGenerator = {
   readonly env: BaseEnvironment;
   readonly features: unknown;
 
+  emit(eventName: string | symbol, ...args: any[]): boolean;
+  on(eventName: string | symbol, listener: (...args: any[]) => void): unknown;
+  once(eventName: string | symbol, listener: (...args: any[]) => void): unknown;
+
   _postConstruct?(): Promise<void>;
 
   destinationRoot(): string;