bun-types 1.2.18-canary.20250702T140635 → 1.2.18

package/bun.d.ts

@@ -45,6 +45,7 @@ declare module "bun" {
   type DOMHighResTimeStamp = number;
   type EventListenerOrEventListenerObject = EventListener | EventListenerObject;
   type BlobOrStringOrBuffer = string | NodeJS.TypedArray | ArrayBufferLike | Blob;
+  type MaybePromise<T> = T | Promise<T>;
 
   namespace __internal {
     type LibDomIsLoaded = typeof globalThis extends { onabort: any } ? true : false;
@@ -7716,6 +7717,56 @@ declare module "bun" {
     timestamp?: number | Date,
   ): Buffer;
 
+  /**
+   * Generate a UUIDv5, which is a name-based UUID based on the SHA-1 hash of a namespace UUID and a name.
+   *
+   * @param name The name to use for the UUID
+   * @param namespace The namespace to use for the UUID
+   * @param encoding The encoding to use for the UUID
+   *
+   *
+   * @example
+   * ```js
+   * import { randomUUIDv5 } from "bun";
+   * const uuid = randomUUIDv5("www.example.com", "dns");
+   * console.log(uuid); // "6ba7b810-9dad-11d1-80b4-00c04fd430c8"
+   * ```
+   *
+   * ```js
+   * import { randomUUIDv5 } from "bun";
+   * const uuid = randomUUIDv5("www.example.com", "url");
+   * console.log(uuid); // "6ba7b811-9dad-11d1-80b4-00c04fd430c8"
+   * ```
+   */
+  function randomUUIDv5(
+    name: string | BufferSource,
+    namespace: string | BufferSource | "dns" | "url" | "oid" | "x500",
+    /**
+     * @default "hex"
+     */
+    encoding?: "hex" | "base64" | "base64url",
+  ): string;
+
+  /**
+   * Generate a UUIDv5 as a Buffer
+   *
+   * @param name The name to use for the UUID
+   * @param namespace The namespace to use for the UUID
+   * @param encoding The encoding to use for the UUID
+   *
+   * @example
+   * ```js
+   * import { randomUUIDv5 } from "bun";
+   * const uuid = randomUUIDv5("www.example.com", "url", "buffer");
+   * console.log(uuid); // <Buffer 6b a7 b8 11 9d ad 11 d1 80 b4 00 c0 4f d4 30 c8>
+   * ```
+   */
+  function randomUUIDv5(
+    name: string | BufferSource,
+    namespace: string | BufferSource | "dns" | "url" | "oid" | "x500",
+    encoding: "buffer",
+  ): Buffer;
+
   /**
    * Types for `bun.lock`
    */

package/docs/api/fetch.md

@@ -337,7 +337,7 @@ This will print the request and response headers to your terminal:
 ```sh
 [fetch] > HTTP/1.1 GET http://example.com/
 [fetch] > Connection: keep-alive
-[fetch] > User-Agent: Bun/1.2.18-canary.20250702T140635
+[fetch] > User-Agent: Bun/1.2.18
 [fetch] > Accept: */*
 [fetch] > Host: example.com
 [fetch] > Accept-Encoding: gzip, deflate, br

package/docs/api/spawn.md

@@ -140,7 +140,7 @@ You can read results from the subprocess via the `stdout` and `stderr` propertie
 ```ts
 const proc = Bun.spawn(["bun", "--version"]);
 const text = await proc.stdout.text();
-console.log(text); // => "1.2.18-canary.20250702T140635\n"
+console.log(text); // => "1.2.18\n"
 ```
 
 Configure the output stream by passing one of the following values to `stdout/stderr`:

package/docs/cli/pm.md

@@ -151,3 +151,44 @@ $ bun pm default-trusted
 ```
 
 see the current list on GitHub [here](https://github.com/oven-sh/bun/blob/main/src/install/default-trusted-dependencies.txt)
+
+## version
+
+To display current package version and help:
+
+```bash
+$ bun pm version
+bun pm version v1.2.18 (ca7428e9)
+Current package version: v1.0.0
+
+Increment:
+  patch      1.0.0 → 1.0.1
+  minor      1.0.0 → 1.1.0
+  major      1.0.0 → 2.0.0
+  prerelease 1.0.0 → 1.0.1-0
+  prepatch   1.0.0 → 1.0.1-0
+  preminor   1.0.0 → 1.1.0-0
+  premajor   1.0.0 → 2.0.0-0
+  from-git   Use version from latest git tag
+  1.2.3      Set specific version
+
+Options:
+  --no-git-tag-version Skip git operations
+  --allow-same-version Prevents throwing error if version is the same
+  --message=<val>, -m  Custom commit message
+  --preid=<val>        Prerelease identifier
+
+Examples:
+  $ bun pm version patch
+  $ bun pm version 1.2.3 --no-git-tag-version
+  $ bun pm version prerelease --preid beta
+```
+
+To bump the version in `package.json`:
+
+```bash
+$ bun pm version patch
+v1.0.1
+```
+
+Supports `patch`, `minor`, `major`, `premajor`, `preminor`, `prepatch`, `prerelease`, `from-git`, or specific versions like `1.2.3`. By default creates git commit and tag unless `--no-git-tag-version` was used to skip.

package/docs/cli/publish.md

@@ -7,7 +7,7 @@ Use `bun publish` to publish a package to the npm registry.
 $ bun publish
 
 ## Output
-bun publish v1.2.18-canary.20250702T140635 (ca7428e9)
+bun publish v1.2.18 (ca7428e9)
 
 packed 203B package.json
 packed 224B README.md

package/docs/guides/ecosystem/nuxt.md

@@ -9,7 +9,7 @@ $ bunx nuxi init my-nuxt-app
 ✔ Which package manager would you like to use?
 bun
 ◐ Installing dependencies...
-bun install v1.2.18-canary.20250702T140635 (16b4bf34)
+bun install v1.2.18 (16b4bf34)
  + @nuxt/devtools@0.8.2
  + nuxt@3.7.0
  785 packages installed [2.67s]

package/docs/guides/install/add-peer.md

@@ -15,7 +15,7 @@ This will add the package to `peerDependencies` in `package.json`.
 ```json-diff
 {
   "peerDependencies": {
-+   "@types/bun": "^1.2.18-canary.20250702T140635"
++   "@types/bun": "^1.2.18"
   }
 }
 ```
@@ -27,7 +27,7 @@ Running `bun install` will install peer dependencies by default, unless marked o
 ```json-diff
 {
   "peerDependencies": {
-    "@types/bun": "^1.2.18-canary.20250702T140635"
+    "@types/bun": "^1.2.18"
   },
   "peerDependenciesMeta": {
 +   "@types/bun": {

package/docs/guides/install/from-npm-install-to-bun-install.md

@@ -97,7 +97,7 @@ $ bun update
 $ bun update @types/bun --latest
 
 # Update a dependency to a specific version
-$ bun update @types/bun@1.2.18-canary.20250702T140635
+$ bun update @types/bun@1.2.18
 
 # Update all dependencies to the latest versions
 $ bun update --latest

package/docs/guides/test/run-tests.md

@@ -21,7 +21,7 @@ Here's what the output of a typical test run looks like. In this case, there are
 
 ```sh
 $ bun test
-bun test v1.2.18-canary.20250702T140635 (9c68abdb)
+bun test v1.2.18 (9c68abdb)
 
 test.test.js:
 ✓ add [0.87ms]
@@ -47,7 +47,7 @@ To only run certain test files, pass a positional argument to `bun test`. The ru
 
 ```sh
 $ bun test test3
-bun test v1.2.18-canary.20250702T140635 (9c68abdb)
+bun test v1.2.18 (9c68abdb)
 
 test3.test.js:
 ✓ add [1.40ms]
@@ -85,7 +85,7 @@ Adding `-t add` will only run tests with "add" in the name. This works with test
 
 ```sh
 $ bun test -t add
-bun test v1.2.18-canary.20250702T140635 (9c68abdb)
+bun test v1.2.18 (9c68abdb)
 
 test.test.js:
 ✓ add [1.79ms]

package/docs/guides/test/snapshot.md

@@ -18,7 +18,7 @@ The first time this test is executed, Bun will evaluate the value passed into `e
 
 ```sh
 $ bun test test/snap
-bun test v1.2.18-canary.20250702T140635 (9c68abdb)
+bun test v1.2.18 (9c68abdb)
 
 test/snap.test.ts:
 ✓ snapshot [1.48ms]
@@ -61,7 +61,7 @@ Later, when this test file is executed again, Bun will read the snapshot file an
 
 ```sh
 $ bun test
-bun test v1.2.18-canary.20250702T140635 (9c68abdb)
+bun test v1.2.18 (9c68abdb)
 
 test/snap.test.ts:
 ✓ snapshot [1.05ms]
@@ -78,7 +78,7 @@ To update snapshots, use the `--update-snapshots` flag.
 
 ```sh
 $ bun test --update-snapshots
-bun test v1.2.18-canary.20250702T140635 (9c68abdb)
+bun test v1.2.18 (9c68abdb)
 
 test/snap.test.ts:
 ✓ snapshot [0.86ms]

package/docs/guides/test/update-snapshots.md

@@ -29,7 +29,7 @@ To regenerate snapshots, use the `--update-snapshots` flag.
 
 ```sh
 $ bun test --update-snapshots
-bun test v1.2.18-canary.20250702T140635 (9c68abdb)
+bun test v1.2.18 (9c68abdb)
 
 test/snap.test.ts:
 ✓ snapshot [0.86ms]

package/docs/guides/util/version.md

@@ -5,7 +5,7 @@ name: Get the current Bun version
 Get the current version of Bun in a semver format.
 
 ```ts#index.ts
-Bun.version; // => "1.2.18-canary.20250702T140635"
+Bun.version; // => "1.2.18"
 ```
 
 ---

package/docs/installation.md

@@ -14,7 +14,7 @@ Kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1. Us
 ```bash#macOS/Linux_(curl)
 $ curl -fsSL https://bun.sh/install | bash # for macOS, Linux, and WSL
 # to install a specific version
-$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.18-canary.20250702T140635"
+$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.18"
 ```
 
 ```bash#npm
@@ -189,10 +189,10 @@ Since Bun is a single binary, you can install older versions of Bun by re-runnin
 
 ### Installing a specific version of Bun on Linux/Mac
 
-To install a specific version of Bun, you can pass the git tag of the version you want to install to the install script, such as `bun-v1.2.0` or `bun-v1.2.18-canary.20250702T140635`.
+To install a specific version of Bun, you can pass the git tag of the version you want to install to the install script, such as `bun-v1.2.0` or `bun-v1.2.18`.
 
 ```sh
-$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.18-canary.20250702T140635"
+$ curl -fsSL https://bun.sh/install | bash -s "bun-v1.2.18"
 ```
 
 ### Installing a specific version of Bun on Windows
@@ -201,7 +201,7 @@ On Windows, you can install a specific version of Bun by passing the version num
 
 ```sh
 # PowerShell:
-$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.18-canary.20250702T140635"
+$ iex "& {$(irm https://bun.sh/install.ps1)} -Version 1.2.18"
 ```
 
 ## Downloading Bun binaries directly

package/docs/runtime/debugger.md

@@ -124,11 +124,11 @@ await fetch("https://example.com", {
 This prints the `fetch` request as a single-line `curl` command to let you copy-paste into your terminal to replicate the request.
 
 ```sh
-[fetch] $ curl --http1.1 "https://example.com/" -X POST -H "content-type: application/json" -H "Connection: keep-alive" -H "User-Agent: Bun/1.2.18-canary.20250702T140635" -H "Accept: */*" -H "Host: example.com" -H "Accept-Encoding: gzip, deflate, br" --compressed -H "Content-Length: 13" --data-raw "{\"foo\":\"bar\"}"
+[fetch] $ curl --http1.1 "https://example.com/" -X POST -H "content-type: application/json" -H "Connection: keep-alive" -H "User-Agent: Bun/1.2.18" -H "Accept: */*" -H "Host: example.com" -H "Accept-Encoding: gzip, deflate, br" --compressed -H "Content-Length: 13" --data-raw "{\"foo\":\"bar\"}"
 [fetch] > HTTP/1.1 POST https://example.com/
 [fetch] > content-type: application/json
 [fetch] > Connection: keep-alive
-[fetch] > User-Agent: Bun/1.2.18-canary.20250702T140635
+[fetch] > User-Agent: Bun/1.2.18
 [fetch] > Accept: */*
 [fetch] > Host: example.com
 [fetch] > Accept-Encoding: gzip, deflate, br
@@ -170,7 +170,7 @@ This prints the following to the console:
 [fetch] > HTTP/1.1 POST https://example.com/
 [fetch] > content-type: application/json
 [fetch] > Connection: keep-alive
-[fetch] > User-Agent: Bun/1.2.18-canary.20250702T140635
+[fetch] > User-Agent: Bun/1.2.18
 [fetch] > Accept: */*
 [fetch] > Host: example.com
 [fetch] > Accept-Encoding: gzip, deflate, br

package/docs/test/dom.md

@@ -55,7 +55,7 @@ Let's run this test with `bun test`:
 
 ```bash
 $ bun test
-bun test v1.2.18-canary.20250702T140635
+bun test v1.2.18
 
 dom.test.ts:
 ✓ dom test [0.82ms]

package/experimental.d.ts

@@ -0,0 +1,276 @@
+declare module "bun" {
+  export namespace __experimental {
+    /**
+     * Base interface for static site generation route parameters.
+     *
+     * Supports both single string values and arrays of strings for dynamic route segments.
+     * This is typically used for route parameters like `[slug]`, `[...rest]`, or `[id]`.
+     *
+     * @warning These APIs are experimental and might be moved/changed in future releases.
+     *
+     * @example
+     * ```tsx
+     * // Simple slug parameter
+     * type BlogParams = { slug: string };
+     *
+     * // Multiple parameters
+     * type ProductParams = {
+     *   category: string;
+     *   id: string;
+     * };
+     *
+     * // Catch-all routes with string arrays
+     * type DocsParams = {
+     *   path: string[];
+     * };
+     * ```
+     */
+    export interface SSGParamsLike {
+      [key: string]: string | string[];
+    }
+
+    /**
+     * Configuration object for a single static route to be generated.
+     *
+     * Each path object contains the parameters needed to render a specific
+     * instance of a dynamic route at build time.
+     *
+     * @warning These APIs are experimental and might be moved/changed in future releases.
+     *
+     * @template Params - The shape of route parameters for this path
+     *
+     * @example
+     * ```tsx
+     * // Single blog post path
+     * const blogPath: SSGPath<{ slug: string }> = {
+     *   params: { slug: "my-first-post" }
+     * };
+     *
+     * // Product page with multiple params
+     * const productPath: SSGPath<{ category: string; id: string }> = {
+     *   params: {
+     *     category: "electronics",
+     *     id: "laptop-123"
+     *   }
+     * };
+     *
+     * // Documentation with catch-all route
+     * const docsPath: SSGPath<{ path: string[] }> = {
+     *   params: { path: ["getting-started", "installation"] }
+     * };
+     * ```
+     */
+    export interface SSGPath<Params extends SSGParamsLike = SSGParamsLike> {
+      params: Params;
+    }
+
+    /**
+     * Array of static paths to be generated at build time.
+     *
+     * This type represents the collection of all route configurations
+     * that should be pre-rendered for a dynamic route.
+     *
+     * @warning These APIs are experimental and might be moved/changed in future releases.
+     *
+     * @template Params - The shape of route parameters for these paths
+     *
+     * @example
+     * ```tsx
+     * // Array of blog post paths
+     * const blogPaths: SSGPaths<{ slug: string }> = [
+     *   { params: { slug: "introduction-to-bun" } },
+     *   { params: { slug: "performance-benchmarks" } },
+     *   { params: { slug: "getting-started-guide" } }
+     * ];
+     *
+     * // Mixed parameter types
+     * const productPaths: SSGPaths<{ category: string; id: string }> = [
+     *   { params: { category: "books", id: "javascript-guide" } },
+     *   { params: { category: "electronics", id: "smartphone-x" } }
+     * ];
+     * ```
+     */
+    export type SSGPaths<Params extends SSGParamsLike = SSGParamsLike> = SSGPath<Params>[];
+
+    /**
+     * Props interface for SSG page components.
+     *
+     * This interface defines the shape of props that will be passed to your
+     * static page components during the build process. The `params` object
+     * contains the route parameters extracted from the URL pattern.
+     *
+     * @warning These APIs are experimental and might be moved/changed in future releases.
+     *
+     * @template Params - The shape of route parameters for this page
+     *
+     * @example
+     * ```tsx
+     * // Blog post component props
+     * interface BlogPageProps extends SSGPageProps<{ slug: string }> {
+     *   // params: { slug: string } is automatically included
+     * }
+     *
+     * // Product page component props
+     * interface ProductPageProps extends SSGPageProps<{
+     *   category: string;
+     *   id: string;
+     * }> {
+     *   // params: { category: string; id: string } is automatically included
+     * }
+     *
+     * // Usage in component
+     * function BlogPost({ params }: BlogPageProps) {
+     *   const { slug } = params; // TypeScript knows slug is a string
+     *   return <h1>Blog post: {slug}</h1>;
+     * }
+     * ```
+     */
+    export interface SSGPageProps<Params extends SSGParamsLike = SSGParamsLike> {
+      params: Params;
+    }
+
+    /**
+     * React component type for SSG pages that can be statically generated.
+     *
+     * This type represents a React component that receives SSG page props
+     * and can be rendered at build time. The component can be either a regular
+     * React component or an async React Server Component for advanced use cases
+     * like data fetching during static generation.
+     *
+     * @warning These APIs are experimental and might be moved/changed in future releases.
+     *
+     * @template Params - The shape of route parameters for this page component
+     *
+     * @example
+     * ```tsx
+     * // Regular synchronous SSG page component
+     * const BlogPost: SSGPage<{ slug: string }> = ({ params }) => {
+     *   return (
+     *     <article>
+     *       <h1>Blog Post: {params.slug}</h1>
+     *       <p>This content was generated at build time!</p>
+     *     </article>
+     *   );
+     * };
+     *
+     * // Async React Server Component for data fetching
+     * const AsyncBlogPost: SSGPage<{ slug: string }> = async ({ params }) => {
+     *   // Fetch data during static generation
+     *   const post = await fetchBlogPost(params.slug);
+     *   const author = await fetchAuthor(post.authorId);
+     *
+     *   return (
+     *     <article>
+     *       <h1>{post.title}</h1>
+     *       <p>By {author.name}</p>
+     *       <div dangerouslySetInnerHTML={{ __html: post.content }} />
+     *     </article>
+     *   );
+     * };
+     *
+     * // Product page with multiple params and async data fetching
+     * const ProductPage: SSGPage<{ category: string; id: string }> = async ({ params }) => {
+     *   const [product, reviews] = await Promise.all([
+     *     fetchProduct(params.category, params.id),
+     *     fetchProductReviews(params.id)
+     *   ]);
+     *
+     *   return (
+     *     <div>
+     *       <h1>{product.name}</h1>
+     *       <p>Category: {params.category}</p>
+     *       <p>Price: ${product.price}</p>
+     *       <div>
+     *         <h2>Reviews ({reviews.length})</h2>
+     *         {reviews.map(review => (
+     *           <div key={review.id}>{review.comment}</div>
+     *         ))}
+     *       </div>
+     *     </div>
+     *   );
+     * };
+     * ```
+     */
+    export type SSGPage<Params extends SSGParamsLike = SSGParamsLike> = React.ComponentType<SSGPageProps<Params>>;
+
+    /**
+     * getStaticPaths is Bun's implementation of SSG (Static Site Generation) path determination.
+     *
+     * This function is called at your app's build time to determine which
+     * dynamic routes should be pre-rendered as static pages. It returns an
+     * array of path parameters that will be used to generate static pages for
+     * dynamic routes (e.g., [slug].tsx, [category]/[id].tsx).
+     *
+     * The function can be either synchronous or asynchronous, allowing you to
+     * fetch data from APIs, databases, or file systems to determine which paths
+     * should be statically generated.
+     *
+     * @warning These APIs are experimental and might be moved/changed in future releases.
+     *
+     * @template Params - The shape of route parameters for the dynamic route
+     *
+     * @returns An object containing an array of paths to be statically generated
+     *
+     * @example
+     * ```tsx
+     * // In pages/blog/[slug].tsx ———————————————————╮
+     * export const getStaticPaths: GetStaticPaths<{ slug: string }> = async () => {
+     *   // Fetch all blog posts from your CMS or API at build time
+     *   const posts = await fetchBlogPosts();
+     *
+     *   return {
+     *     paths: posts.map((post) => ({
+     *       params: { slug: post.slug }
+     *     }))
+     *   };
+     * };
+     *
+     * // In pages/products/[category]/[id].tsx
+     * export const getStaticPaths: GetStaticPaths<{
+     *   category: string;
+     *   id: string;
+     * }> = async () => {
+     *   // Fetch products from database
+     *   const products = await db.products.findMany({
+     *     select: { id: true, category: { slug: true } }
+     *   });
+     *
+     *   return {
+     *     paths: products.map(product => ({
+     *       params: {
+     *         category: product.category.slug,
+     *         id: product.id
+     *       }
+     *     }))
+     *   };
+     * };
+     *
+     * // In pages/docs/[...path].tsx (catch-all route)
+     * export const getStaticPaths: GetStaticPaths<{ path: string[] }> = async () => {
+     *   // Read documentation structure from file system
+     *   const docPaths = await getDocumentationPaths('./content/docs');
+     *
+     *   return {
+     *     paths: docPaths.map(docPath => ({
+     *       params: { path: docPath.split('/') }
+     *     }))
+     *   };
+     * };
+     *
+     * // Synchronous example with static data
+     * export const getStaticPaths: GetStaticPaths<{ id: string }> = () => {
+     *   const staticIds = ['1', '2', '3', '4', '5'];
+     *
+     *   return {
+     *     paths: staticIds.map(id => ({
+     *       params: { id }
+     *     }))
+     *   };
+     * };
+     * ```
+     */
+    export type GetStaticPaths<Params extends SSGParamsLike = SSGParamsLike> = () => MaybePromise<{
+      paths: SSGPaths<Params>;
+    }>;
+  }
+}

package/index.d.ts

@@ -20,6 +20,7 @@
 /// <reference path="./deprecated.d.ts" />
 /// <reference path="./redis.d.ts" />
 /// <reference path="./shell.d.ts" />
+/// <reference path="./experimental.d.ts" />
 
 /// <reference path="./bun.ns.d.ts" />
 

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.2.18-canary.20250702T140635",
+  "version": "1.2.18",
   "name": "bun-types",
   "license": "MIT",
   "types": "./index.d.ts",
@@ -20,7 +20,11 @@
   "dependencies": {
     "@types/node": "*"
   },
+  "peerDependencies": {
+    "@types/react": "^19"
+  },
   "devDependencies": {
+    "@types/react": "^19",
     "typescript": "^5.0.2"
   },
   "scripts": {