adding with-axiom example (vercel#38300)

## Documentation / Examples

- [ X ] Make sure the linting passes by running `pnpm lint`
- [ X ] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples)


This PR adds an example for using next.js with axiom.

Co-authored-by: Balázs Orbán <[email protected]>
Co-authored-by: Steven Tey <[email protected]>

examples/with-axiom/.gitignore

@@ -0,0 +1,37 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo

examples/with-axiom/README.md

@@ -0,0 +1,25 @@
+# Example app with Axiom
+
+This example shows how to use a [Next.js](https://nextjs.org/) project along with [Axiom](https://axiom.co) via the [next-axiom](https://github.com/axiomhq/next-axiom) package. A custom `withAxiom` wrapper is used to wrap the next config object, middleware and API functions. The `log` object could be used from frontend, middleware and API functions.
+
+## Deploy your own
+
+Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) or preview live with [StackBlitz](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/with-axiom)
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-axiom&project-name=with-axiom&repository-name=with-axiom)
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+
+## How to use
+
+Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example::
+
+```bash
+npx create-next-app --example with-axiom with-axiom-app
+# or
+yarn create next-app --example with-axiom with-axiom-app
+# or
+pnpm create next-app --example with-axiom with-axiom-app
+```
+
+Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)) and watch data coming into your Axiom dataset.

examples/with-axiom/middleware.ts

@@ -0,0 +1,9 @@
+import { NextResponse } from 'next/server'
+import { log, withAxiom } from 'next-axiom'
+
+async function middleware() {
+  log.info('Hello from middleware', { bar: 'baz' })
+  return NextResponse.next()
+}
+
+export default withAxiom(middleware)

examples/with-axiom/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

examples/with-axiom/next.config.js

@@ -0,0 +1,8 @@
+const { withAxiom } = require('next-axiom')
+
+/** @type {import('next').NextConfig} */
+const nextConfig = withAxiom({
+  reactStrictMode: true,
+})
+
+module.exports = nextConfig

examples/with-axiom/package.json

@@ -0,0 +1,21 @@
+{
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start"
+  },
+  "dependencies": {
+    "next": "latest",
+    "next-axiom": "^0.10.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "swr": "^1.3.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.0.5",
+    "@types/react-dom": "^18.0.1",
+    "@types/node": "^16.11.26",
+    "typescript": "^4.7.4"
+  }
+}

examples/with-axiom/pages/_app.tsx

@@ -0,0 +1,11 @@
+import { log } from 'next-axiom'
+import { AppProps } from 'next/app'
+export { reportWebVitals } from 'next-axiom'
+
+log.info('Hello from frontend', { foo: 'bar' })
+
+const MyApp = ({ Component, pageProps }: AppProps) => {
+  return <Component {...pageProps} />
+}
+
+export default MyApp

examples/with-axiom/pages/api/hello.ts

@@ -0,0 +1,10 @@
+// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
+import type { NextApiRequest, NextApiResponse } from 'next'
+import { log, withAxiom } from 'next-axiom'
+
+async function handler(req: NextApiRequest, res: NextApiResponse) {
+  log.info('Hello from function', { url: req.url })
+  res.status(200).json({ name: 'John Doe' })
+}
+
+export default withAxiom(handler)

examples/with-axiom/pages/index.tsx

@@ -0,0 +1,31 @@
+import { GetStaticPropsContext } from 'next'
+import { log } from 'next-axiom'
+import useSWR from 'swr'
+
+export const getStaticProps = async (ctx: GetStaticPropsContext) => {
+  log.info('Hello from SSR', { ctx })
+  return {
+    props: {},
+  }
+}
+
+const fetcher = async (...args: any[]) => {
+  log.info('Hello from SWR', { args })
+  const res = await fetch.apply(null, [...args])
+  return await res.json()
+}
+
+const Home = () => {
+  const { data, error } = useSWR('/api/hello', fetcher)
+
+  if (error) return <div>Failed to load</div>
+  if (!data) return <div>Loading...</div>
+
+  return (
+    <div>
+      <h1>{data.name}</h1>
+    </div>
+  )
+}
+
+export default Home

examples/with-axiom/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "incremental": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve"
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules"]
+}