Add publish types script (#2273)

* add publish types script * use postpublish script * 5.24.0-test.0 * 5.24.0-test.1 * uncomment * 5.24.0-test.2 * simplify automation * 5.24.0-test.3 * fix script * 5.24.0-test.4 * fix script * 5.24.0-test.5 * undici-type@5.24.0-test.5 * restore versions * delete generated file * Update update-undici-types-version.js Co-authored-by: Superchupu <53496941+SuperchupuDev@users.noreply.github.com> * fix contributor list and fix types export * this should fix types * one more adjustment * 5.24.0-test.6 * undici-types@5.24.0-test.6 * revert versions and add README for undici-types --------- Co-authored-by: Superchupu <53496941+SuperchupuDev@users.noreply.github.com>
nodejs · Sep 20, 2023 · 5c2e597 · 5c2e597
1 parent 985b381
commit 5c2e597
Show file tree

Hide file tree

Showing 6 changed files with 169 additions and 57 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1,57 +1,3 @@
-import Dispatcher from'./types/dispatcher'
-import { setGlobalDispatcher, getGlobalDispatcher } from './types/global-dispatcher'
-import { setGlobalOrigin, getGlobalOrigin } from './types/global-origin'
-import Pool from'./types/pool'
-import { RedirectHandler, DecoratorHandler } from './types/handlers'
-
-import BalancedPool from './types/balanced-pool'
-import Client from'./types/client'
-import buildConnector from'./types/connector'
-import errors from'./types/errors'
-import Agent from'./types/agent'
-import MockClient from'./types/mock-client'
-import MockPool from'./types/mock-pool'
-import MockAgent from'./types/mock-agent'
-import mockErrors from'./types/mock-errors'
-import ProxyAgent from'./types/proxy-agent'
-import { request, pipeline, stream, connect, upgrade } from './types/api'
-
-export * from './types/cookies'
-export * from './types/fetch'
-export * from './types/file'
-export * from './types/filereader'
-export * from './types/formdata'
-export * from './types/diagnostics-channel'
-export * from './types/websocket'
-export * from './types/content-type'
-export * from './types/cache'
-export { Interceptable } from './types/mock-interceptor'
-
-export { Dispatcher, BalancedPool, Pool, Client, buildConnector, errors, Agent, request, stream, pipeline, connect, upgrade, setGlobalDispatcher, getGlobalDispatcher, setGlobalOrigin, getGlobalOrigin, MockClient, MockPool, MockAgent, mockErrors, ProxyAgent, RedirectHandler, DecoratorHandler }
+export * from './types/index'
+import Undici from './types/index'
 export default Undici
-
-declare namespace Undici {
-  var Dispatcher: typeof import('./types/dispatcher').default
-  var Pool: typeof import('./types/pool').default;
-  var RedirectHandler: typeof import ('./types/handlers').RedirectHandler
-  var DecoratorHandler: typeof import ('./types/handlers').DecoratorHandler
-  var createRedirectInterceptor: typeof import ('./types/interceptors').createRedirectInterceptor
-  var BalancedPool: typeof import('./types/balanced-pool').default;
-  var Client: typeof import('./types/client').default;
-  var buildConnector: typeof import('./types/connector').default;
-  var errors: typeof import('./types/errors').default;
-  var Agent: typeof import('./types/agent').default;
-  var setGlobalDispatcher: typeof import('./types/global-dispatcher').setGlobalDispatcher;
-  var getGlobalDispatcher: typeof import('./types/global-dispatcher').getGlobalDispatcher;
-  var request: typeof import('./types/api').request;
-  var stream: typeof import('./types/api').stream;
-  var pipeline: typeof import('./types/api').pipeline;
-  var connect: typeof import('./types/api').connect;
-  var upgrade: typeof import('./types/api').upgrade;
-  var MockClient: typeof import('./types/mock-client').default;
-  var MockPool: typeof import('./types/mock-pool').default;
-  var MockAgent: typeof import('./types/mock-agent').default;
-  var mockErrors: typeof import('./types/mock-errors').default;
-  var fetch: typeof import('./types/fetch').fetch;
-  var caches: typeof import('./types/cache').caches;
-}
diff --git a/package.json b/package.json
@@ -11,12 +11,41 @@
     "url": "git+https://github.com/nodejs/undici.git"
   },
   "license": "MIT",
-  "author": "Matteo Collina <hello@matteocollina.com>",
   "contributors": [
+    {
+      "name": "Daniele Belardi",
+      "url": "https://github.com/dnlup",
+      "author": true
+    },
+    {
+      "name": "Ethan Arrowood",
+      "url": "https://github.com/ethan-arrowood",
+      "author": true
+    },
+    {
+      "name": "Matteo Collina",
+      "url": "https://github.com/mcollina",
+      "author": true
+    },
+    {
+      "name": "Matthew Aitken",
+      "url": "https://github.com/KhafraDev",
+      "author": true
+    },
     {
       "name": "Robert Nagy",
       "url": "https://github.com/ronag",
       "author": true
+    },
+    {
+      "name": "Szymon Marczak",
+      "url": "https://github.com/szmarczak",
+      "author": true
+    },
+    {
+      "name": "Tomas Della Vedova",
+      "url": "https://github.com/delvedor",
+      "author": true
     }
   ],
   "keywords": [
@@ -64,6 +93,7 @@
     "bench:run": "CONNECTIONS=1 node benchmarks/benchmark.js; CONNECTIONS=50 node benchmarks/benchmark.js",
     "serve:website": "docsify serve .",
     "prepare": "husky install",
+    "postpublish": "node scripts/update-undici-types-version.js && cd types && npm publish",
     "fuzz": "jsfuzz test/fuzzing/fuzz.js corpus"
   },
   "devDependencies": {

diff --git a/scripts/update-undici-types-version.js b/scripts/update-undici-types-version.js
@@ -0,0 +1,18 @@
+const fs = require('node:fs')
+const path = require('node:path')
+const childProcess = require('node:child_process')
+
+const packageJSONPath = path.join(__dirname, '..', 'package.json')
+const packageJSONRaw = fs.readFileSync(packageJSONPath, 'utf-8')
+const packageJSON = JSON.parse(packageJSONRaw)
+const version = packageJSON.version
+
+const packageTypesJSONPath = path.join(__dirname, '..', 'types', 'package.json')
+const packageTypesJSONRaw = fs.readFileSync(packageTypesJSONPath, 'utf-8')
+const packageTypesJSON = JSON.parse(packageTypesJSONRaw)
+packageTypesJSON.version = version
+
+fs.writeFileSync(packageTypesJSONPath, JSON.stringify(packageTypesJSON, null, 2))
+
+childProcess.execSync('git add types/package.json', { cwd: path.join(__dirname, '..') })
+childProcess.execSync(`git commit -n -m 'undici-types@${version}'`, { cwd: path.join(__dirname, '..') })
diff --git a/types/README.md b/types/README.md
@@ -0,0 +1,6 @@
+# undici-types
+
+This package is a dual-publish of the [undici](https://www.npmjs.com/package/undici) library types. The `undici` package **still contains types**. This package is for users who _only_ need undici types (such as for `@types/node`). It is published alongside every release of `undici`, so you can always use the same version.
+
+- [GitHub nodejs/undici](https://github.com/nodejs/undici)
+- [Undici Documentation](https://undici.nodejs.org/#/)
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -0,0 +1,57 @@
+import Dispatcher from'./dispatcher'
+import { setGlobalDispatcher, getGlobalDispatcher } from './global-dispatcher'
+import { setGlobalOrigin, getGlobalOrigin } from './global-origin'
+import Pool from'./pool'
+import { RedirectHandler, DecoratorHandler } from './handlers'
+
+import BalancedPool from './balanced-pool'
+import Client from'./client'
+import buildConnector from'./connector'
+import errors from'./errors'
+import Agent from'./agent'
+import MockClient from'./mock-client'
+import MockPool from'./mock-pool'
+import MockAgent from'./mock-agent'
+import mockErrors from'./mock-errors'
+import ProxyAgent from'./proxy-agent'
+import { request, pipeline, stream, connect, upgrade } from './api'
+
+export * from './cookies'
+export * from './fetch'
+export * from './file'
+export * from './filereader'
+export * from './formdata'
+export * from './diagnostics-channel'
+export * from './websocket'
+export * from './content-type'
+export * from './cache'
+export { Interceptable } from './mock-interceptor'
+
+export { Dispatcher, BalancedPool, Pool, Client, buildConnector, errors, Agent, request, stream, pipeline, connect, upgrade, setGlobalDispatcher, getGlobalDispatcher, setGlobalOrigin, getGlobalOrigin, MockClient, MockPool, MockAgent, mockErrors, ProxyAgent, RedirectHandler, DecoratorHandler }
+export default Undici
+
+declare namespace Undici {
+  var Dispatcher: typeof import('./dispatcher').default
+  var Pool: typeof import('./pool').default;
+  var RedirectHandler: typeof import ('./handlers').RedirectHandler
+  var DecoratorHandler: typeof import ('./handlers').DecoratorHandler
+  var createRedirectInterceptor: typeof import ('./interceptors').createRedirectInterceptor
+  var BalancedPool: typeof import('./balanced-pool').default;
+  var Client: typeof import('./client').default;
+  var buildConnector: typeof import('./connector').default;
+  var errors: typeof import('./errors').default;
+  var Agent: typeof import('./agent').default;
+  var setGlobalDispatcher: typeof import('./global-dispatcher').setGlobalDispatcher;
+  var getGlobalDispatcher: typeof import('./global-dispatcher').getGlobalDispatcher;
+  var request: typeof import('./api').request;
+  var stream: typeof import('./api').stream;
+  var pipeline: typeof import('./api').pipeline;
+  var connect: typeof import('./api').connect;
+  var upgrade: typeof import('./api').upgrade;
+  var MockClient: typeof import('./mock-client').default;
+  var MockPool: typeof import('./mock-pool').default;
+  var MockAgent: typeof import('./mock-agent').default;
+  var mockErrors: typeof import('./mock-errors').default;
+  var fetch: typeof import('./fetch').fetch;
+  var caches: typeof import('./cache').caches;
+}
diff --git a/types/package.json b/types/package.json
@@ -0,0 +1,55 @@
+{
+  "name": "undici-types",
+  "version": "5.24.0",
+  "description": "A stand-alone types package for Undici",
+  "homepage": "https://undici.nodejs.org",
+  "bugs": {
+    "url": "https://github.com/nodejs/undici/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nodejs/undici.git"
+  },
+  "license": "MIT",
+  "types": "index.d.ts",
+  "files": [
+    "*.d.ts"
+  ],
+  "contributors": [
+    {
+      "name": "Daniele Belardi",
+      "url": "https://github.com/dnlup",
+      "author": true
+    },
+    {
+      "name": "Ethan Arrowood",
+      "url": "https://github.com/ethan-arrowood",
+      "author": true
+    },
+    {
+      "name": "Matteo Collina",
+      "url": "https://github.com/mcollina",
+      "author": true
+    },
+    {
+      "name": "Matthew Aitken",
+      "url": "https://github.com/KhafraDev",
+      "author": true
+    },
+    {
+      "name": "Robert Nagy",
+      "url": "https://github.com/ronag",
+      "author": true
+    },
+    {
+      "name": "Szymon Marczak",
+      "url": "https://github.com/szmarczak",
+      "author": true
+    },
+    {
+      "name": "Tomas Della Vedova",
+      "url": "https://github.com/delvedor",
+      "author": true
+    }
+  ]
+}