@chainlink/external-adapter-framework 1.7.6 → 2.0.0

package/generator-adapter/node_modules/package-json/index.d.ts

@@ -1,6 +1,219 @@
-import {Agent as HttpAgent} from 'node:http';
-import {Agent as HttpsAgent} from 'node:https';
-import {Agents} from 'got';
+import type {PackageJson} from 'type-fest';
+
+type Person = Readonly<PackageJson.Person>;
+
+type PersonObject = Exclude<Person, string>;
+
+// eslint-disable-next-line unicorn/prevent-abbreviations
+type Dist = Readonly<{
+	/**
+	The URL of the tarball containing the payload for the package.
+	*/
+	tarball: string;
+
+	/**
+	The SHA-1 sum of the tarball.
+	*/
+	shasum: string;
+
+	/**
+	A string in the format `<hashAlgorithm>-<base64-hash>`. Refer to the {@link https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity Subresource Integrity} docs on MDN and the {@link https://github.com/npm/cacache#integrity `cacache`} package for more information.
+
+	@since April 2017
+	*/
+	integrity?: string;
+
+	/**
+	The number of files in the tarball, folder excluded.
+
+	@since February 2018
+	*/
+	fileCount?: number;
+
+	/**
+	The total bytes of the unpacked files in the tarball.
+
+	@since February 2018
+	*/
+	unpackedSize?: number;
+
+	/**
+	A PGP signature in the format `<package>@<version>:<integrity>`.
+
+	@since April 2018
+	@deprecated April 2023, see https://docs.npmjs.com/about-registry-signatures
+	*/
+	'npm-signature'?: string;
+
+	/**
+	ECDSA signature(s).
+
+	@see https://docs.npmjs.com/about-registry-signatures
+	@since April 2023
+	*/
+	signatures?: Array<{
+		/**
+		A SHA-256 public key.
+		*/
+		keyid: string;
+
+		sig: string;
+	}>;
+}>;
+
+type AbbreviatedVersionPackageJsonFields = (
+	| 'dependencies'
+	| 'optionalDependencies'
+	| 'devDependencies'
+	| 'bundleDependencies'
+	| 'peerDependencies'
+	| 'peerDependenciesMeta'
+	| 'bin'
+	| 'directories'
+	| 'engines'
+	| 'cpu'
+	| 'os'
+	| 'funding'
+);
+
+type AbbreviatedVersion = Readonly<{
+	/**
+	The name of the package.
+	*/
+	name: string;
+
+	/**
+	Package version, parseable by [`node-semver`](https://github.com/npm/node-semver).
+	*/
+	version: string;
+
+	dist: Dist;
+
+	/**
+	The deprecation warnings message of this version. A version is deprecated if this field is set.
+	*/
+	deprecated?: string;
+
+	/**
+	Whether or not this version has a shrinkwrap used to install it. If this field is `undefined`, the client must determine through other means if a shrinkwrap exists.
+	*/
+	_hasShrinkwrap?: boolean;
+
+	/**
+	Whether or not this version has an `install` script.
+	*/
+	hasInstallScript?: boolean;
+}> & Pick<Readonly<PackageJson>, AbbreviatedVersionPackageJsonFields>;
+
+// eslint-disable-next-line unicorn/prevent-abbreviations
+type DistTags = {
+	[tagName: string]: string;
+	latest: string;
+};
+
+type AbbreviatedMetadata = Readonly<{
+	/**
+	The name of the package.
+	*/
+	name: string;
+
+	/**
+	An {@link https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations ISO timestamp} of the last time the package was modified.
+	*/
+	modified: string;
+
+	'dist-tags': DistTags;
+
+	versions: Record<string, AbbreviatedVersion>;
+}>;
+
+type Repository = Readonly<Exclude<PackageJson['repository'], string>>;
+
+type HoistedPackageJsonFields = (
+	| 'author'
+	| 'bugs'
+	| 'contributors'
+	| 'description'
+	| 'homepage'
+	| 'keywords'
+	| 'license'
+);
+
+// Hoisted from latest version
+type HoistedData = Readonly<{
+	/**
+	People with permission to publish the package. Not authoritative but informational.
+	*/
+	maintainers?: PersonObject[];
+
+	repository?: Repository;
+}> & Pick<Readonly<PackageJson>, HoistedPackageJsonFields>;
+
+type FullVersion = Readonly<{
+	/**
+	`package@version`
+	*/
+	_id: string;
+
+	_shasum: string;
+
+	_from: string;
+
+	/**
+	The version of npm used to publish the package.
+	*/
+	_npmVersion: string;
+
+	/**
+	The version of Node.js used to publish the package.
+	*/
+	_nodeVersion: string;
+
+	/**
+	The npm user who published this version.
+	*/
+	_npmUser: PersonObject;
+
+	licenseText?: string;
+
+	gitHead?: string;
+}> & Readonly<Omit<PackageJson, 'repository'>> & Omit<AbbreviatedVersion, 'hasInstallScript'> & HoistedData;
+
+type FullMetadata = Readonly<{
+	/**
+	The name of the package, used as an ID in CouchDB.
+	*/
+	_id: string;
+
+	/**
+	The revision number of this version of the document in CouchDB.
+	*/
+	_rev: string;
+
+	/**
+	A mapping of versions to the time they were published. Each value is an {@link https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations ISO timestamp}.
+	*/
+	time: {
+		[version: string]: string;
+
+		/**
+		When the package was created.
+		*/
+		created: string;
+
+		/**
+		When the package was last modified.
+		*/
+		modified: string;
+	};
+
+	/**
+	NPM users who have starred the package.
+	*/
+	users?: Readonly<Record<string, boolean>>;
+
+	versions: Readonly<Record<string, FullVersion>>;
+}> & AbbreviatedMetadata & HoistedData;
 
 /**
 The error thrown when the given package version cannot be found.
@@ -20,7 +233,7 @@ export class PackageNotFoundError extends Error {
 	constructor(packageName: string);
 }
 
-export type Options = {
+export type Options = Readonly<{
 	/**
 	Package version such as `1.0.0` or a [dist tag](https://docs.npmjs.com/cli/dist-tag) such as `latest`.
 
@@ -32,125 +245,36 @@ export type Options = {
 
 	@default 'latest'
 	*/
-	readonly version?: string;
+	version?: string;
 
 	/**
 	By default, only an abbreviated metadata object is returned for performance reasons. [Read more.](https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md)
 
 	@default false
 	*/
-	readonly fullMetadata?: boolean;
+	fullMetadata?: boolean;
 
 	/**
 	Return the [main entry](https://registry.npmjs.org/ava) containing all versions.
 
 	@default false
 	*/
-	readonly allVersions?: boolean;
+	allVersions?: boolean;
 
 	/**
 	The registry URL is by default inferred from the npm defaults and `.npmrc`. This is beneficial as `package-json` and any project using it will work just like npm. This option is*only** intended for internal tools. You should __not__ use this option in reusable packages. Prefer just using `.npmrc` whenever possible.
 	*/
-	readonly registryUrl?: string;
+	registryUrl?: string;
 
 	/**
-	Overwrite the `agent` option that is passed down to [`got`](https://github.com/sindresorhus/got#agent). This might be useful to add [proxy support](https://github.com/sindresorhus/got#proxies).
-	*/
-	readonly agent?: Agents;
-};
+	Whether or not to omit deprecated versions of a package.
 
-export type FullMetadataOptions = {
-	/**
-	By default, only an abbreviated metadata object is returned for performance reasons. [Read more.](https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md)
+	If set, versions marked as deprecated on the registry are omitted from results. Providing a dist tag or a specific version will still return that version, even if it's deprecated. If no version can be found once deprecated versions are omitted, a `VersionNotFoundError` is thrown.
 
-	@default false
+	@default true
 	*/
-	readonly fullMetadata: true;
-} & Options;
-
-interface DistTags {
-	readonly [tagName: string]: string;
-	readonly latest: string;
-}
-
-interface AbbreviatedVersion {
-	readonly [key: string]: unknown;
-	readonly name: string;
-	readonly version: string;
-	readonly dist: {
-		readonly shasum: string;
-		readonly tarball: string;
-		readonly integrity?: string;
-	};
-	readonly deprecated?: string;
-	readonly dependencies?: Readonly<Record<string, string>>;
-	readonly optionalDependencies?: Readonly<Record<string, string>>;
-	readonly devDependencies?: Readonly<Record<string, string>>;
-	readonly bundleDependencies?: Readonly<Record<string, string>>;
-	readonly peerDependencies?: Readonly<Record<string, string>>;
-	readonly bin?: Readonly<Record<string, string>>;
-	readonly directories?: readonly string[];
-	readonly engines?: Readonly<Record<string, string>>;
-	readonly _hasShrinkwrap?: boolean;
-}
-
-interface Person {
-	readonly name?: string;
-	readonly email?: string;
-	readonly url?: string;
-}
-
-interface HoistedData {
-	readonly author?: Person;
-	readonly bugs?:
-	| {readonly url: string; readonly email?: string}
-	| {readonly url?: string; readonly email: string};
-	readonly contributors?: readonly Person[];
-	readonly description?: string;
-	readonly homepage?: string;
-	readonly keywords?: readonly string[];
-	readonly license?: string;
-	readonly maintainers?: readonly Person[];
-	readonly readme?: string;
-	readonly readmeFilename?: string;
-	readonly repository?: {readonly type: string; readonly url: string};
-}
-
-interface FullVersion extends AbbreviatedVersion, HoistedData {
-	readonly [key: string]: unknown;
-	readonly _id: string;
-	readonly _nodeVersion: string;
-	readonly _npmUser: string;
-	readonly _npmVersion: string;
-	readonly main?: string;
-	readonly files?: readonly string[];
-	readonly man?: readonly string[];
-	readonly scripts?: Readonly<Record<string, string>>;
-	readonly gitHead?: string;
-	readonly types?: string;
-	readonly typings?: string;
-}
-
-export interface FullMetadata extends AbbreviatedMetadata, HoistedData {
-	readonly [key: string]: unknown;
-	readonly _id: string;
-	readonly _rev: string;
-	readonly time: {
-		readonly [version: string]: string;
-		readonly created: string;
-		readonly modified: string;
-	};
-	readonly users?: Readonly<Record<string, boolean>>;
-	readonly versions: Readonly<Record<string, FullVersion>>;
-}
-
-export interface AbbreviatedMetadata {
-	readonly [key: string]: unknown;
-	readonly 'dist-tags': DistTags;
-	readonly modified: string;
-	readonly name: string;
-	readonly versions: Readonly<Record<string, AbbreviatedVersion>>;
-}
+	omitDeprecated?: boolean;
+}>;
 
 /**
 Get metadata of a package from the npm registry.
@@ -168,5 +292,12 @@ console.log(await packageJson('ava'));
 console.log(await packageJson('@sindresorhus/df'));
 ```
 */
-export default function packageJson(packageName: string, options: FullMetadataOptions): Promise<FullMetadata>;
-export default function packageJson(packageName: string, options?: Options): Promise<AbbreviatedMetadata>;
+export default function packageJson<ProvidedOptions extends Options>(packageName: string, options?: ProvidedOptions): Promise<(
+	ProvidedOptions extends {fullMetadata: true}
+		? ProvidedOptions extends {allVersions: true}
+			? FullMetadata
+			: FullVersion & Pick<FullMetadata, 'time'>
+		: ProvidedOptions extends {allVersions: true}
+			? AbbreviatedMetadata
+			: AbbreviatedVersion
+)>;

package/generator-adapter/node_modules/package-json/index.js

@@ -1,20 +1,8 @@
-import {Agent as HttpAgent} from 'node:http';
-import {Agent as HttpsAgent} from 'node:https';
-import got from 'got';
+import ky from 'ky';
 import registryUrl from 'registry-url';
 import registryAuthToken from 'registry-auth-token';
 import semver from 'semver';
 
-// These agent options are chosen to match the npm client defaults and help with performance
-// See: `npm config get maxsockets` and #50
-const agentOptions = {
-	keepAlive: true,
-	maxSockets: 50,
-};
-
-const httpAgent = new HttpAgent(agentOptions);
-const httpsAgent = new HttpsAgent(agentOptions);
-
 export class PackageNotFoundError extends Error {
 	constructor(packageName) {
 		super(`Package \`${packageName}\` could not be found`);
@@ -29,14 +17,12 @@ export class VersionNotFoundError extends Error {
 	}
 }
 
-export default async function packageJson(packageName, options) {
-	options = {
-		version: 'latest',
-		...options,
-	};
+export default async function packageJson(packageName, options = {}) {
+	let {version = 'latest'} = options;
+	const {omitDeprecated = true} = options;
 
 	const scope = packageName.split('/')[0];
-	const registryUrl_ = options.registryUrl || registryUrl(scope);
+	const registryUrl_ = options.registryUrl ?? registryUrl(scope);
 	const packageUrl = new URL(encodeURIComponent(packageName).replace(/^%40/, '@'), registryUrl_);
 	const authInfo = registryAuthToken(registryUrl_.toString(), {recursive: true});
 
@@ -52,23 +38,11 @@ export default async function packageJson(packageName, options) {
 		headers.authorization = `${authInfo.type} ${authInfo.token}`;
 	}
 
-	const gotOptions = {
-		headers,
-		agent: {
-			http: httpAgent,
-			https: httpsAgent,
-		},
-	};
-
-	if (options.agent) {
-		gotOptions.agent = options.agent;
-	}
-
 	let data;
 	try {
-		data = await got(packageUrl, gotOptions).json();
+		data = await ky(packageUrl, {headers, keepalive: true}).json();
 	} catch (error) {
-		if (error?.response?.statusCode === 404) {
+		if (error?.response?.status === 404) {
 			throw new PackageNotFoundError(packageName);
 		}
 
@@ -79,15 +53,24 @@ export default async function packageJson(packageName, options) {
 		return data;
 	}
 
-	let {version} = options;
 	const versionError = new VersionNotFoundError(packageName, version);
 
 	if (data['dist-tags'][version]) {
-		const time = data.time;
+		const {time} = data;
 		data = data.versions[data['dist-tags'][version]];
 		data.time = time;
 	} else if (version) {
-		if (!data.versions[version]) {
+		const versionExists = Boolean(data.versions[version]);
+
+		if (omitDeprecated && !versionExists) {
+			for (const [metadataVersion, metadata] of Object.entries(data.versions)) {
+				if (metadata.deprecated) {
+					delete data.versions[metadataVersion];
+				}
+			}
+		}
+
+		if (!versionExists) {
 			const versions = Object.keys(data.versions);
 			version = semver.maxSatisfying(versions, version);
 
@@ -96,7 +79,7 @@ export default async function packageJson(packageName, options) {
 			}
 		}
 
-		const time = data.time;
+		const {time} = data;
 		data = data.versions[version];
 		data.time = time;
 

package/generator-adapter/node_modules/package-json/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "package-json",
-	"version": "8.1.1",
+	"version": "10.0.1",
 	"description": "Get metadata of a package from the npm registry",
 	"license": "MIT",
 	"repository": "sindresorhus/package-json",
@@ -11,14 +11,16 @@
 		"url": "https://sindresorhus.com"
 	},
 	"type": "module",
-	"exports": "./index.js",
-	"types": "./index.d.ts",
+	"exports": {
+		"types": "./index.d.ts",
+		"default": "./index.js"
+	},
+	"sideEffects": false,
 	"engines": {
-		"node": ">=14.16"
+		"node": ">=18"
 	},
 	"scripts": {
-		"//test": "xo && ava && tsd",
-		"test": "ava && tsd"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
 		"index.js",
@@ -36,16 +38,16 @@
 		"scoped"
 	],
 	"dependencies": {
-		"got": "^12.1.0",
-		"registry-auth-token": "^5.0.1",
-		"registry-url": "^6.0.0",
-		"semver": "^7.3.7"
+		"ky": "^1.2.0",
+		"registry-auth-token": "^5.0.2",
+		"registry-url": "^6.0.1",
+		"semver": "^7.6.0"
 	},
 	"devDependencies": {
-		"@types/node": "^17.0.40",
-		"ava": "^4.3.0",
-		"mock-private-registry": "^1.1.2",
-		"tsd": "^0.20.0",
-		"xo": "^0.49.0"
+		"@types/node": "^18",
+		"ava": "^6.1.1",
+		"private-registry-mock": "^0.3.0",
+		"tsd": "^0.30.7",
+		"xo": "^0.57.0"
 	}
 }

package/generator-adapter/node_modules/package-json/readme.md

@@ -53,7 +53,7 @@ The version can also be in any format supported by the [semver](https://github.c
 Type: `boolean`\
 Default: `false`
 
-By default, only an abbreviated metadata object is returned for performance reasons. [Read more.](https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md)
+By default, only an abbreviated metadata object is returned for performance reasons. [Read more](https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md), or see the [type definitions](index.d.ts).
 
 ##### allVersions
 
@@ -69,11 +69,14 @@ Default: Auto-detected
 
 The registry URL is by default inferred from the npm defaults and `.npmrc`. This is beneficial as `package-json` and any project using it will work just like npm. This option is **only** intended for internal tools. You should **not** use this option in reusable packages. Prefer just using `.npmrc` whenever possible.
 
-##### agent
+##### omitDeprecated
 
-Type: `object`
+Type: `boolean`\
+Default: `true`
+
+Whether or not to omit deprecated versions of a package.
 
-Overwrite the `agent` option that is passed down to [`got`](https://github.com/sindresorhus/got#agent). This might be useful to add [proxy support](https://github.com/sindresorhus/got#proxies).
+If set, versions marked as deprecated on the registry are omitted from results. Providing a dist tag or a specific version will still return that version, even if it's deprecated. If no version can be found once deprecated versions are omitted, a [`VersionNotFoundError`](#versionnotfounderror) is thrown.
 
 ### PackageNotFoundError
 
@@ -87,6 +90,12 @@ The error thrown when the given package version cannot be found.
 
 Both public and private registries are supported, for both scoped and unscoped packages, as long as the registry uses either bearer tokens or basic authentication.
 
+## Proxies
+
+Proxy support is not implemented in this package. If necessary, use a global agent that modifies [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API), which this package uses internally.
+
+Support for this may come to [Node.js in the future](https://github.com/nodejs/undici/issues/1650).
+
 ## Related
 
 - [package-json-cli](https://github.com/sindresorhus/package-json-cli) - CLI for this module

package/generator-adapter/node_modules/yeoman-generator/dist/actions/fs.d.ts

@@ -1,7 +1,7 @@
 import { type CopyOptions, type MemFsEditor } from 'mem-fs-editor';
 import type { Data as TemplateData, Options as TemplateOptions } from 'ejs';
 import type { OverloadParameters, OverloadReturnType } from '../types-utils.js';
-import type BaseGenerator from '../generator.js';
+import type { BaseGenerator } from '../generator.js';
 export type Template<D extends TemplateData, G> = {
     /**
      * Template file, absolute or relative to templatePath().

package/generator-adapter/node_modules/yeoman-generator/dist/actions/fs.js

@@ -1,4 +1,4 @@
-/* eslint max-params: [1, 5] */
+/* eslint max-params: [1, 6] */
 import assert from 'node:assert';
 function applyToFirstStringArg(customizer, args) {
     args[0] = Array.isArray(args[0]) ? args[0].map(arg => customizer(arg)) : customizer(args[0]);
@@ -28,8 +28,7 @@ export class FsMixin {
      */
     copyTemplate(...args) {
         const [from, to, options = {}, ...remaining] = args;
-        options.fromBasePath = options.fromBasePath ?? this.templatePath();
-        return this.fs.copy(from, this.destinationPath(to), options, ...remaining);
+        return this.fs.copy(from, this.destinationPath(to), { fromBasePath: this.templatePath(), ...options }, ...remaining);
     }
     /**
      * Copy file from templates folder to destination folder.
@@ -88,8 +87,7 @@ export class FsMixin {
      */
     copyDestination(...args) {
         const [from, to, options = {}, ...remaining] = args;
-        options.fromBasePath = options.fromBasePath ?? this.destinationPath();
-        return this.fs.copy(from, this.destinationPath(to), options, ...remaining);
+        return this.fs.copy(from, this.destinationPath(to), { fromBasePath: this.destinationPath(), ...options }, ...remaining);
     }
     /**
      * Move file from destination folder to another destination folder.
@@ -97,9 +95,8 @@ export class FsMixin {
      * Shortcut for this.fs!.move(this.destinationPath(from), this.destinationPath(to)).
      */
     moveDestination(...args) {
-        const [from, to, options = {}, ...remaining] = args;
-        options.fromBasePath = options.fromBasePath ?? this.destinationPath();
-        return this.fs.move(from, this.destinationPath(to), options, ...remaining);
+        const [from, to, options, ...remaining] = args;
+        return this.fs.move(from, this.destinationPath(to), { fromBasePath: this.destinationPath(), ...options }, ...remaining);
     }
     /**
      * Exists file on destination folder.
@@ -127,7 +124,10 @@ export class FsMixin {
         const templatePath = this.templatePath(...source);
         destination = Array.isArray(destination) ? destination : [destination];
         const destinationPath = this.destinationPath(...destination);
-        this.fs.copyTpl(templatePath, destinationPath, templateData, templateOptions, copyOptions);
+        this.fs.copyTpl(templatePath, destinationPath, templateData, templateOptions, {
+            fromBasePath: this.templatePath(),
+            ...copyOptions,
+        });
     }
     /**
      * Copy a template from templates folder to the destination.
@@ -147,7 +147,10 @@ export class FsMixin {
         const templatePath = this.templatePath(...source);
         destination = Array.isArray(destination) ? destination : [destination];
         const destinationPath = this.destinationPath(...destination);
-        return this.fs.copyTplAsync(templatePath, destinationPath, templateData, templateOptions, copyOptions);
+        return this.fs.copyTplAsync(templatePath, destinationPath, templateData, templateOptions, {
+            fromBasePath: this.templatePath(),
+            ...copyOptions,
+        });
     }
     /**
      * Copy templates from templates folder to the destination.
@@ -160,7 +163,10 @@ export class FsMixin {
         for (const template of templates) {
             const { templateData: eachData = templateData, source, destination } = template;
             if (!template.when || template.when(eachData, this)) {
-                this.renderTemplate(source, destination, eachData, template.templateOptions, template.copyOptions);
+                this.renderTemplate(source, destination, eachData, template.templateOptions, {
+                    fromBasePath: this.templatePath(),
+                    ...template.copyOptions,
+                });
             }
         }
     }
@@ -178,7 +184,10 @@ export class FsMixin {
         return Promise.all(templates.map(async (template) => {
             const { templateData: eachData = templateData, source, destination } = template;
             if (!template.when || template.when(eachData, this)) {
-                return this.renderTemplateAsync(source, destination, eachData, template.templateOptions, template.copyOptions);
+                return this.renderTemplateAsync(source, destination, eachData, template.templateOptions, {
+                    fromBasePath: this.templatePath(),
+                    ...template.copyOptions,
+                });
             }
             return;
         }));

package/generator-adapter/node_modules/yeoman-generator/dist/actions/help.d.ts

@@ -1,5 +1,5 @@
 import type { ArgumentSpec, CliOptionSpec } from '../types.js';
-import type BaseGenerator from '../generator.js';
+import type { BaseGenerator } from '../generator.js';
 export declare class HelpMixin {
     readonly _options: Record<string, CliOptionSpec>;
     readonly _arguments: ArgumentSpec[];