feat: Publish info file (safe-global#1179)

Author: yagopv

.github/workflows/create-integrity-file.yml

@@ -0,0 +1,39 @@
+name: Create publish info file
+
+on:
+  release:
+    types: [created]
+  workflow_dispatch:
+  push:
+    branches:
+      - prepare-release
+
+permissions:
+  contents: read
+
+jobs:
+  generate-publish-info:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: yarn
+      - run: |
+          yarn install --frozen-lockfile
+          yarn build
+
+      - name: Run integrity check script
+        run: |
+          yarn generate-publish-info
+
+      - name: Upload YAML artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: publish-info
+          path: ./publish-info
+
+      - name: Show YAML output
+        run: cat ./publish-info/*.yml

.gitignore

@@ -65,3 +65,5 @@ openapi/
 yalc.lock
 # Local Netlify folder
 .netlify
+
+publish-info/

package.json

@@ -9,7 +9,8 @@
     "test": "FORCE_COLOR=1 lerna run test --stream",
     "play": "ts-node ./playground/config/run.ts",
     "format": "lerna run format && prettier --write \"playground/**/*.ts\"",
-    "prepare": "husky"
+    "prepare": "husky",
+    "generate-publish-info": "ts-node ./scripts/generate-publish-info.ts"
   },
   "workspaces": {
     "packages": [

packages/protocol-kit/tsconfig.build.json

@@ -4,7 +4,6 @@
     "declaration": true,
     "emitDeclarationOnly": true,
     "declarationMap": true,
-    "composite": true,
     "outDir": "dist"
   },
   "include": ["src/**/*", "test-utils/**/*"],

packages/protocol-kit/tsconfig.json

@@ -5,7 +5,6 @@
     "paths": {
       "@safe-global/protocol-kit/*": ["./src/*"]
     },
-    "composite": true,
     "outDir": "dist"
   },
   "include": ["src/**/*", "tests/**/*"],

packages/relay-kit/tsconfig.build.json

@@ -4,7 +4,6 @@
     "declaration": true,
     "emitDeclarationOnly": true,
     "declarationMap": true,
-    "composite": true,
     "outDir": "dist"
   },
   "include": ["src/**/*", "test-utils/**/*"],

packages/relay-kit/tsconfig.json

@@ -5,7 +5,6 @@
     "paths": {
       "@safe-global/relay-kit/*": ["./src/*"]
     },
-    "composite": true,
     "outDir": "dist"
   },
   "include": ["src/**/*"],

playground/tsconfig.json

@@ -1,7 +1,6 @@
 {
   "extends": "../tsconfig.settings.json",
   "compilerOptions": {
-    "composite": true,
     "noImplicitThis": false,
     "outDir": "dist"
   },

scripts/generate-publish-info.ts

@@ -0,0 +1,118 @@
+import { execFile } from 'child_process'
+import * as fs from 'fs'
+import * as path from 'path'
+import * as yaml from 'yaml'
+
+type PackagePublishInfo = {
+  id: string
+  name: string
+  version: string
+  size: number
+  unpackedSize: number
+  shasum: string
+  integrity: string
+  filename: string
+  entryCount: number
+}
+
+type NpmPublishOutput = Record<
+  string,
+  PackagePublishInfo & {
+    files?: string[]
+    bundled?: unknown[]
+  }
+>
+
+const executeCommand = (command: string, args: string[]): Promise<string> => {
+  return new Promise((resolve, reject) => {
+    execFile(command, args, (error, stdout, stderr) => {
+      if (error) {
+        return reject(`Error executing command: ${error.message}`)
+      }
+
+      if (stderr) {
+        console.warn(`Warning during execution: ${stderr}`)
+      }
+
+      resolve(stdout)
+    })
+  })
+}
+
+const writeToFile = (filePath: string, data: string): Promise<void> => {
+  return new Promise((resolve, reject) => {
+    const safeDir = path.join(process.cwd(), 'publish-info')
+
+    fs.mkdir(safeDir, { recursive: true, mode: 0o700 }, (err) => {
+      if (err) return reject(`Directory creation failed: ${err.message}`)
+
+      const fullPath = path.join(safeDir, path.basename(filePath))
+
+      fs.writeFile(fullPath, data, { mode: 0o600 }, (writeErr) => {
+        if (writeErr) return reject(`File write failed: ${writeErr.message}`)
+        resolve()
+      })
+    })
+  })
+}
+
+const sanitizePublishOutput = (jsonData: NpmPublishOutput): Record<string, PackagePublishInfo> => {
+  return Object.fromEntries(
+    Object.entries(jsonData).map(([pkgName, pkgData]) => {
+      const { files, bundled, ...cleanData } = pkgData
+
+      return [pkgName, cleanData]
+    })
+  )
+}
+
+const getReadableFilename = (): string => {
+  try {
+    const now = new Date()
+    const pad = (n: number) => n.toString().padStart(2, '0')
+    const datePart = [now.getFullYear(), pad(now.getMonth() + 1), pad(now.getDate())].join('-')
+    const timePart = [pad(now.getHours()), pad(now.getMinutes()), pad(now.getSeconds())].join('-')
+    const timestamp = `${datePart}_${timePart}`
+
+    return `publish-info_${timestamp}.yml`
+  } catch {
+    return `publish-info_${Date.now()}.yml`
+  }
+}
+
+const main = async () => {
+  try {
+    const projectRoot = path.join(__dirname, '../')
+    process.chdir(projectRoot)
+
+    const stdout = await executeCommand('npm', [
+      'publish',
+      '--access',
+      'public',
+      '--dry-run',
+      '--workspaces',
+      '--json',
+      '--ignore-scripts'
+    ])
+
+    let jsonOutput: NpmPublishOutput
+    try {
+      jsonOutput = JSON.parse(stdout) as NpmPublishOutput
+    } catch (parseError) {
+      throw new Error(`Error parsing JSON output: ${(parseError as Error).message}`)
+    }
+
+    const cleanedOutput = sanitizePublishOutput(jsonOutput)
+    const yamlOutput = yaml.stringify(cleanedOutput)
+
+    const outputFileName = getReadableFilename()
+    await writeToFile(outputFileName, yamlOutput)
+
+    console.log(`Output stored in ${outputFileName}`)
+  } catch (error) {
+    console.error(`Error: ${error instanceof Error ? error.message : error}`)
+    process.exit(1)
+  }
+}
+
+main()