From 6a96287d5f803caa306fccab1ff8e48e8a4439e9 Mon Sep 17 00:00:00 2001 From: Quinn Turner Date: Sat, 1 Jun 2024 14:08:23 -0300 Subject: [PATCH 1/2] BREAKING: Change name of YarnBerry to Yarn2And3 --- index.d.ts | 7 ++++--- package.json | 4 ++-- pnpm-lock.yaml | 17 ++++++++++------- 3 files changed, 16 insertions(+), 12 deletions(-) diff --git a/index.d.ts b/index.d.ts index 93cbdf1..4f00c13 100644 --- a/index.d.ts +++ b/index.d.ts @@ -252,15 +252,16 @@ declare namespace NPMAuditReportV1 { } /** - * Yarn Berry's audit seems to be identical in structure to NPM's v6 audit format. + * Yarn 2 and 3 audit seems to be identical in structure to NPM's v6 audit format + * except that `runId` is not required. */ -declare namespace YarnBerryAuditReport { +declare namespace Yarn2And3AuditReport { interface Audit { readonly actions: Action[]; readonly advisories: AdvisoryMap; readonly muted: any[]; readonly metadata: AuditMetadata; - readonly runId: string; + readonly runId?: string; } interface AuditMetadata { diff --git a/package.json b/package.json index f1e88f3..c860c2a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "audit-types", - "version": "0.5.6", + "version": "0.6.0", "description": "Type definitions for package manager json audit responses", "private": false, "publishConfig": { @@ -26,7 +26,7 @@ "homepage": "https://github.com/quinnturner/audit-types#readme", "dependencies": {}, "devDependencies": { - "typescript": "^4.9.4" + "typescript": "^5.4.5" }, "files": [ "index.d.ts", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index ddde73b..8cffafc 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -1,15 +1,18 @@ -lockfileVersion: 5.4 +lockfileVersion: '6.0' -specifiers: - typescript: ^4.9.4 +settings: + autoInstallPeers: true + excludeLinksFromLockfile: false devDependencies: - typescript: 4.9.4 + typescript: + specifier: ^5.4.5 + version: 5.4.5 packages: - /typescript/4.9.4: - resolution: {integrity: sha512-Uz+dTXYzxXXbsFpM86Wh3dKCxrQqUcVMxwU54orwlJjOpO3ao8L7j5lH+dWfTwgCwIuM9GQ2kvVotzYJMXTBZg==} - engines: {node: '>=4.2.0'} + /typescript@5.4.5: + resolution: {integrity: sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==} + engines: {node: '>=14.17'} hasBin: true dev: true From cd5365bd6e7232f30036f1249ea87312c1375d52 Mon Sep 17 00:00:00 2001 From: Quinn Turner Date: Sat, 1 Jun 2024 14:10:23 -0300 Subject: [PATCH 2/2] Document missing Yarn v4 --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c43e3cd..962e5d8 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,10 @@ # audit-types -This project contains the TypeScript typings for all major dependency manager's audit output in JSON format. +This project contains the TypeScript typings for most major dependency managers' audit output in JSON format. - ✅ NPM V6 - ✅ NPM V7+ - ✅ Yarn Classic -- ✅ Yarn Berry +- ✅ Yarn Berry v2 and v3 +- ❌ Yarn Berry v4 - ✅ PNPM