🤖 Merge PR DefinitelyTyped#75043 feat(libnpmpublish): add support for stageId by @43081j

Author: 43081j

types/libnpmpublish/index.d.ts

@@ -35,6 +35,11 @@ export interface PublishOptions extends fetch.Options {
      * @default ["sha512"]
      */
     algorithms?: string[];
+    /**
+     * If true, the package will be published to the registry in a staged state, meaning it will not be publicly visible
+     * until someone manually approves it.
+     */
+    stage?: boolean;
 }
 
 /**
@@ -53,7 +58,16 @@ export interface PublishOptions extends fetch.Options {
  * await libpub.publish(manifest, tarData, { npmVersion: 'my-pub-script@1.0.2', token: 'my-auth-token-here' }, opts)
  * // Package has been published to the npm registry.
  */
-export function publish(manifest: PackageJson, tarballData: Buffer, options?: PublishOptions): Promise<Response>;
+export function publish(
+    manifest: PackageJson,
+    tarballData: Buffer,
+    options: PublishOptions & { stage: true },
+): Promise<Response & { stageId: string }>;
+export function publish(
+    manifest: PackageJson,
+    tarballData: Buffer,
+    options?: PublishOptions,
+): Promise<Response & { stageId?: string }>;
 
 /**
  * Unpublishes spec from the appropriate registry. The registry in question may have its own limitations on unpublishing.

types/libnpmpublish/libnpmpublish-tests.ts

@@ -31,8 +31,8 @@ async function test() {
     await libnpmpublish.publish();
     // @ts-expect-error
     await libnpmpublish.publish(manifest);
-    await libnpmpublish.publish(manifest, tarballData); // $ExpectType Response
-    await libnpmpublish.publish(manifest, tarballData, options); // $ExpectType Response
+    await libnpmpublish.publish(manifest, tarballData); // $ExpectType Response & { stageId?: string | undefined }
+    await libnpmpublish.publish(manifest, tarballData, options); // $ExpectType Response & { stageId?: string | undefined }
 
     const publishOptions = {
         ...options,
@@ -43,10 +43,23 @@ async function test() {
         npmVersion: "1.0.0",
         algorithms: ["sha512"],
     };
-    await libnpmpublish.publish(manifest, tarballData, publishOptions); // $ExpectType Response
+    await libnpmpublish.publish(manifest, tarballData, publishOptions); // $ExpectType Response & { stageId?: string | undefined }
 
     // @ts-expect-error
     await libnpmpublish.unpublish();
     await libnpmpublish.unpublish("npmpackage"); // $ExpectType boolean
     await libnpmpublish.unpublish("npmpackage", options); // $ExpectType boolean
 }
+
+async function stagingTest() {
+    const options = {
+        stage: true,
+    } as const;
+    const manifest: PackageJson = {
+        name: "",
+        version: "",
+    };
+    const tarballData: Buffer = Buffer.from("thisisafillerforthebuffertowork");
+
+    await libnpmpublish.publish(manifest, tarballData, options); // $ExpectType Response & { stageId: string }
+}

types/libnpmpublish/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/libnpmpublish",
-    "version": "9.0.9999",
+    "version": "11.2.9999",
     "projects": [
         "https://npmjs.com/package/libnpmpublish"
     ],