0.6.35 • Published 2 months ago

@clerk/fastify v0.6.35

Weekly downloads
-
License
MIT
Repository
github
Last release
2 months ago

@clerk/fastify

Chat on Discord Clerk documentation Follow on Twitter

Changelog · Report a Bug · Request a Feature · Ask a Question


Overview

Clerk is the easiest way to add authentication and user management to your Fastify application. To gain a better understanding of the Clerk Backend API and SDK, refer to the Fastify SDK and Backend API documentation.

Getting Started

To use this plugin you should first create a Clerk application and retrieve a Secret Key and a Publishable Key for you application (see here) to be used as environment variables CLERK_PUBLISHABLE_KEY & CLERK_SECRET_KEY.

Prerequisites

  • Node.js v14+
  • Fastify v4+

Installation

npm install @clerk/fastify

Build

npm run build

Usage

Retrieve your Backend API key from the API Keys screen in your Clerk dashboard and set it as an environment variable in a .env file:

CLERK_PUBLISHABLE_KEY=pk_*******
CLERK_SECRET_KEY=sk_******

You will then be able to access all the available methods.

import 'dotenv/config'; // To read CLERK_PUBLISHABLE_KEY
import Fastify from 'fastify';
import { clerkPlugin, getAuth } from '@clerk/fastify';
import type { FastifyInstance } from 'fastify';

const server: FastifyInstance = Fastify({ logger: true });

server.register(clerkPlugin);

server.get('/private', async (req, reply) => {
  const auth = getAuth(req);
  if (!auth.userId) {
    return reply.code(403).send();
  }
  return { hello: 'world' };
});

const start = async () => {
  try {
    await server.listen({ port: 3000 });
  } catch (err) {
    server.log.error(err);
    process.exit(1);
  }
};
start();

Scoped routes

Support authenticated routes that the Clerk middleware will run as plugin in preHandler hook and unauthenticated routes that will not trigger the middleware using the Fastify docs.

import 'dotenv/config'; // To read CLERK_PUBLISHABLE_KEY
import Fastify from 'fastify';
import { clerkPlugin, getAuth } from '@clerk/fastify';
import type { FastifyReply, FastifyRequest, FastifyInstance } from 'fastify';

const server: FastifyInstance = Fastify({ logger: true });

const privateRoutes = async (fastify: FastifyInstance, _opts: any) => {
  fastify.register(clerkPlugin);

  fastify.get('/private', async (req: FastifyRequest, reply: FastifyReply) => {
    const auth = getAuth(req);

    if (!auth.userId) {
      return reply.code(403).send();
    }

    return { hello: 'world', auth };
  });
};

server.register(privateRoutes);

server.get('/public', async (_req, _reply) => {
  return { hello: 'world' };
});

const start = async () => {
  try {
    await server.listen({ port: 3000 });
  } catch (err) {
    server.log.error(err);
    process.exit(1);
  }
};
start();

Support

You can get in touch with us in any of the following ways:

Security

@clerk/fastify follows good practices of security, but 100% security cannot be assured.

@clerk/fastify is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.

1.0.0-beta.26

2 months ago

1.0.0-beta.27

2 months ago

1.0.0-beta.24

2 months ago

1.0.0-beta.25

2 months ago

0.6.35

2 months ago

1.0.0-beta.23

2 months ago

1.0.0-beta.22

3 months ago

1.0.0-beta-v5.21

3 months ago

0.6.34

3 months ago

0.6.33

3 months ago

1.0.0-beta-v5.20

3 months ago

0.6.32

4 months ago

1.0.0-alpha-v5.19

4 months ago

1.0.0-alpha-v5.18

4 months ago

0.6.31

4 months ago

1.0.0-alpha-v5.17

4 months ago

1.0.0-alpha-v5.15

4 months ago

0.6.30

4 months ago

1.0.0-alpha-v5.14

4 months ago

0.6.29

4 months ago

1.0.0-alpha-v5.13

4 months ago

0.6.28

4 months ago

1.0.0-alpha-v5.12

5 months ago

1.0.0-alpha-v5.11

5 months ago

0.6.27

5 months ago

0.6.26

5 months ago

0.6.25

5 months ago

1.0.0-alpha-v5.9

5 months ago

1.0.0-alpha-v5.8

5 months ago

0.6.24

5 months ago

1.0.0-alpha-v5.6

5 months ago

1.0.0-alpha-v5.7

5 months ago

1.0.0-alpha-v5.5

5 months ago

0.6.7

8 months ago

0.6.6

8 months ago

0.6.9

7 months ago

0.6.8

7 months ago

0.5.6

10 months ago

0.6.3

9 months ago

0.6.2

10 months ago

0.6.5

8 months ago

0.6.4

8 months ago

0.6.1

10 months ago

0.6.0

10 months ago

0.6.21

6 months ago

0.6.20

6 months ago

0.6.23

5 months ago

0.6.22

6 months ago

0.6.10

7 months ago

0.6.12

7 months ago

0.6.11

7 months ago

0.6.18

6 months ago

0.6.17

6 months ago

0.6.19

6 months ago

0.6.14

7 months ago

0.6.13

7 months ago

0.6.16

7 months ago

0.6.15

7 months ago

0.5.7

10 months ago

1.0.0-alpha-v5.4

5 months ago

1.0.0-alpha-v5.2

6 months ago

1.0.0-alpha-v5.3

5 months ago

1.0.0-alpha-v5.0

6 months ago

1.0.0-alpha-v5.1

6 months ago

0.5.5

10 months ago

0.4.6-snap.cd256f5

11 months ago

0.4.6-snap.77525ba

11 months ago

0.4.6-snap.691991c

11 months ago

0.4.6-snap.5fede9e

11 months ago

0.4.6-snap.5909c28

11 months ago

0.5.4

11 months ago

0.5.3

11 months ago

0.5.0

11 months ago

0.5.2

11 months ago

0.5.1

11 months ago

0.4.6-snap.46c588e

11 months ago

0.4.6-snap.3210eda

11 months ago

0.4.6-snap.f75792d

11 months ago

0.4.8

11 months ago

0.4.6-snap.8fda67e

11 months ago

0.4.6-snap.a0dd011

11 months ago

0.4.6-mytag.691991c

11 months ago

0.4.5

11 months ago

0.4.7

11 months ago

0.4.6

11 months ago

0.4.6-snap.e2ec9c0

11 months ago

0.4.6-snap.2150b23

11 months ago

0.4.6-snap.af9b738

11 months ago

0.4.6-snap.219d1fb

11 months ago

0.4.6-snap.9208293

11 months ago

0.4.3-staging.2

12 months ago

0.4.3-staging.1

12 months ago

0.4.3-staging.0

12 months ago

0.3.0-staging.1

1 year ago

0.3.0-staging.2

12 months ago

0.3.0

12 months ago

0.3.1

12 months ago

0.4.2-staging.0

12 months ago

0.4.2-staging.1

12 months ago

0.4.4

11 months ago

0.4.1

12 months ago

0.4.0

12 months ago

0.4.3

12 months ago

0.4.2

12 months ago

0.3.1-staging.3

12 months ago

0.4.1-staging.0

12 months ago

0.3.1-staging.2

12 months ago

0.4.1-staging.1

12 months ago

0.3.1-staging.1

12 months ago

0.3.1-staging.0

12 months ago

0.4.4-staging.0

11 months ago

0.4.5-staging.4

11 months ago

0.4.5-staging.3

11 months ago

0.4.5-staging.0

11 months ago

0.4.5-staging.2

11 months ago

0.4.5-staging.1

11 months ago

0.2.4-staging.0

1 year ago

0.3.0-staging.0

1 year ago

0.2.7-staging.1

1 year ago

0.2.7-staging.0

1 year ago

0.2.5-staging.0

1 year ago

0.2.3-staging.3

1 year ago

0.2.3-staging.2

1 year ago

0.2.6

1 year ago

0.2.6-staging.0

1 year ago

0.2.3

1 year ago

0.2.5

1 year ago

0.2.4

1 year ago

0.1.10

1 year ago

0.1.11

1 year ago

0.1.13

1 year ago

0.1.14

1 year ago

0.1.15

1 year ago

0.2.0-staging.0

1 year ago

0.2.1-staging.3

1 year ago

0.2.1-staging.1

1 year ago

0.2.1-staging.2

1 year ago

0.2.1-staging.0

1 year ago

0.1.9

1 year ago

0.2.2-staging.0

1 year ago

0.1.9-staging.0

1 year ago

0.1.9-staging.1

1 year ago

0.2.3-staging.0

1 year ago

0.2.3-staging.1

1 year ago

0.2.1

1 year ago

0.2.0

1 year ago

0.1.16

1 year ago

0.2.2

1 year ago

0.1.7-staging.0

1 year ago

0.1.8

1 year ago

0.1.7

1 year ago

0.1.8-staging.0

1 year ago

0.1.8-staging.1

1 year ago

0.1.5-staging.7

1 year ago

0.1.5-staging.6

1 year ago

0.1.6-staging.0

1 year ago

0.1.6

1 year ago

0.1.5

1 year ago

0.1.3-staging.0

1 year ago

0.1.3-staging.1

1 year ago

0.1.3-staging.2

1 year ago

0.1.4-staging.1

1 year ago

0.1.4-staging.0

1 year ago

0.1.5-staging.5

1 year ago

0.1.5-staging.4

1 year ago

0.1.5-staging.3

1 year ago

0.1.5-staging.2

1 year ago

0.1.5-staging.1

1 year ago

0.1.5-staging.0

1 year ago

0.1.4

1 year ago

0.1.3

1 year ago

0.1.2

1 year ago

0.1.2-staging.1

1 year ago

0.1.2-staging.0

1 year ago

0.1.1

1 year ago

0.1.1-staging.0

1 year ago