npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@yangcurve/actions

v0.0.13

Published

Server Action wrapper inspired by trpc.

Downloads

5

Readme

ACTIONS

Server Action wrapper inspired by trpc.

USAGE

pnpm add @yangcurve/actions

Initialize Procedures

// procedures.ts
import { authOptions } from '@/server/auth'
import { prisma } from '@/server/prisma'
import { createProcedure } from '@yangcurve/actions'
import { getServerSession } from 'next-auth'

const createContext = async () => ({
  db: prisma,
  session: await getServerSession(authOptions),
})

const procedure = createProcedure(createContext)

export const publicProcedure = procedure
export const protectedProcedure = procedure.use((ctx) => {
  if (!ctx.session || !ctx.session.user) {
    throw new Error('UNAUTHENTICATED')
  }

  return {
    ...ctx,
    session: {
      ...ctx.session,
    },
  }
})

Define Server Actions

// post.ts
'use server'

import { protectedProcedure, publicProcedure } from './procedures'
import { z } from 'zod'

export const hello = publicProcedure
  .input(z.object({ text: z.string() }))
  .query(async ({ input }) => {
    return {
      greeting: `Hello ${input.text}`,
    }
  })

export const getSecretMessage = protectedProcedure.query(async () => {
  return 'you can now see this secret message!'
})

export const create = protectedProcedure
  .input(z.object({ title: z.string().min(1) }))
  .mutation(async ({ ctx, input }) => {
    const newPost = ctx.db.post.create({
      data: {
        title: input.title,
      },
    })
    return newPost
  })

Register Server Actions to one object

// actions.ts
import * as post from './post'
import { type FlattenObjectKeys, type InferActionIOFromKey } from '@yangcurve/actions'

export const actions = {
  post,
} as const
export type Actions = typeof actions

type ActionKey = FlattenObjectKeys<Actions>
export type ActionInput<Key extends ActionKey> = InferActionIOFromKey<'input', Key, Actions>
export type ActionOutput<Key extends ActionKey> = InferActionIOFromKey<'output', Key, Actions>

Create Client Side API

// client.ts
import { actions } from './actions'
import { createClientApi } from '@yangcurve/actions'

export const api = createClientApi(actions)

In Server Component:

type NewPost = ActionOutput<'post.create'>
const ServerComponent: React.FC = async () => {
  const message = await actions.post.hello({ text: 'from server' })
  const newPost: NewPost = await actions.post.create({ title: 'new post from server' })

  return (
    <>
      <div>{message.greeting}</div>
      <div>title of new post: {newPost.title}</div>
    </>
  )
}

In client Component:

type NewPost = ActionOutput<'post.create'>
const ClientComponent: React.FC = () => {
  const [newPost, setNewPost] = useState<NewPost | undefined>()
  const { data: message, isLoading } = api.query('post.hello')({ text: 'from client' })
  const { mutate } = api.mutation('post.create')({
    onSuccess: (data) => {
      setNewPost(data)
    },
  })

  if (isLoading) return <></>
  return (
    <>
      <div>{message?.greeting}</div>
      {newPost ? (
        <div>title of new post: {newPost.title}</div>
      ) : (
        <button onClick={() => mutate({ title: 'new post from client' })}>
          create new post
        </button>
      )}
    </>
  )
}