@molecule/api-resource-device

Auto-generated, AI-first package reference for the molecule.dev ecosystem. It is written to be read by coding agents as much as by people, and is generated from this package's source — edit src/index.ts JSDoc, not this file.

The device resource for molecule.dev — one row per signed-in browser or app install, owned by a user. Devices anchor session context and push delivery: the row stores pushPlatform/pushSubscription, the routes cover device list/read/update/delete plus GET /devices/push/public-key (the VAPID key browsers need to subscribe), and API-side push fan-outs read the stored subscriptions.

Quick Start

import { createRequestHandler } from '@molecule/api-resource'
import { createRequestHandlerMap, resource, routes } from '@molecule/api-resource-device'

// Unlike newer resources, the handler map is a FACTORY — build it with the
// createRequestHandler from @molecule/api-resource (mlcl inject does this):
const requestHandlerMap = createRequestHandlerMap(createRequestHandler)

Type

resource

Installation

npm install @molecule/api-resource-device @molecule/api-bond @molecule/api-database @molecule/api-i18n @molecule/api-locales-device @molecule/api-resource zod

API

Interfaces

DeviceRequestHandlerMap

Shape of the device request-handler map produced by createRequestHandlerMap. Names match the route definitions in routes.ts. Exported so helpers that accept the map (e.g. mountDefaultDeviceRoutes) can type their parameter precisely instead of widening to Record<string, MoleculeRequestHandler>.

interface DeviceRequestHandlerMap {
  auth: MoleculeRequestHandler
  authUser: MoleculeRequestHandler
  del: MoleculeRequestHandler
  pushPublicKey: MoleculeRequestHandler
  query: MoleculeRequestHandler
  read: MoleculeRequestHandler
  update: MoleculeRequestHandler
}

Types

APNPushSubscription

APN push subscription type.

type APNPushSubscription = z.infer<typeof apnPushSubscriptionSchema>

CreateProps

Fields required when registering a new device (userId, name, push subscription).

type CreateProps = z.infer<typeof createPropsSchema>

FCMPushSubscription

FCM push subscription type.

type FCMPushSubscription = z.infer<typeof fcmPushSubscriptionSchema>

Props

Full device record properties (userId, name, push platform/subscription, timestamps).

type Props = z.infer<typeof propsSchema>

PushProps

Push notification properties for a device (device ID, platform, subscription data).

type PushProps = z.infer<typeof pushPropsSchema>

PushSubscription

Web Push subscription type.

type PushSubscription = z.infer<typeof webPushSubscriptionSchema>

UpdateProps

Updatable device fields (name, push platform, push subscription).

type UpdateProps = z.infer<typeof updatePropsSchema>

Functions

createRequestHandlerMap(createRequestHandler)

Creates the full request handler map for the Device resource. Maps handler names (matching route definitions) to Express middleware: auth, authUser (authorizers), and del, query, read, update (CRUD handlers).

function createRequestHandlerMap(
  createRequestHandler: (
    handler: Handler,
  ) => (req: MoleculeRequest, res: MoleculeResponse, next: MoleculeNextFunction) => Promise<void>,
): DeviceRequestHandlerMap

• createRequestHandler — Factory from @molecule/api-resource that wraps handler configs into Express middleware.

Returns: A DeviceRequestHandlerMap of handler names to Express middleware.

Constants

apnPushSubscriptionSchema

APN push subscription schema.

const apnPushSubscriptionSchema: z.ZodObject<{ registrationId: z.ZodString }, z.core.$strip>

createPropsSchema

Schema for creating a device.

const createPropsSchema: z.ZodObject<
  {
    userId: z.ZodString
    name: z.ZodOptional<z.ZodString>
    pushPlatform: z.ZodOptional<z.ZodEnum<{ fcm: 'fcm'; apn: 'apn' }>>
    pushSubscription: z.ZodOptional<
      z.ZodNullable<
        z.ZodUnion<
          readonly [
            z.ZodObject<
              {
                endpoint: z.ZodOptional<z.ZodString>
                keys: z.ZodOptional<
                  z.ZodObject<{ p256dh: z.ZodString; auth: z.ZodString }, z.core.$strip>
                >
              },
              z.core.$strip
            >,
            z.ZodObject<
              { registrationId: z.ZodString; registrationType: z.ZodLiteral<'FCM'> },
              z.core.$strip
            >,
            z.ZodObject<{ registrationId: z.ZodString }, z.core.$strip>,
          ]
        >
      >
    >
    hasPushSubscription: z.ZodOptional<z.ZodBoolean>
  },
  z.core.$strip
>

deviceService

DeviceService implementation for the bond system.

Provides device CRUD operations that other resources can use through get('device') / require('device').

const deviceService: DeviceService

fcmPushSubscriptionSchema

FCM push subscription schema.

const fcmPushSubscriptionSchema: z.ZodObject<
  { registrationId: z.ZodString; registrationType: z.ZodLiteral<'FCM'> },
  z.core.$strip
>

i18nRegistered

The i18n registered.

const i18nRegistered: true

propsSchema

The full schema for device props.

const propsSchema: z.ZodObject<
  {
    id: z.ZodString
    createdAt: z.ZodString
    updatedAt: z.ZodString
    userId: z.ZodString
    name: z.ZodOptional<z.ZodString>
    pushPlatform: z.ZodOptional<z.ZodEnum<{ fcm: 'fcm'; apn: 'apn' }>>
    pushSubscription: z.ZodOptional<
      z.ZodNullable<
        z.ZodUnion<
          readonly [
            z.ZodObject<
              {
                endpoint: z.ZodOptional<z.ZodString>
                keys: z.ZodOptional<
                  z.ZodObject<{ p256dh: z.ZodString; auth: z.ZodString }, z.core.$strip>
                >
              },
              z.core.$strip
            >,
            z.ZodObject<
              { registrationId: z.ZodString; registrationType: z.ZodLiteral<'FCM'> },
              z.core.$strip
            >,
            z.ZodObject<{ registrationId: z.ZodString }, z.core.$strip>,
          ]
        >
      >
    >
    hasPushSubscription: z.ZodOptional<z.ZodBoolean>
  },
  z.core.$strip
>

pushPropsSchema

Zod schema for push notification properties (device ID, platform, subscription).

const pushPropsSchema: z.ZodObject<
  {
    id: z.ZodString
    pushPlatform: z.ZodOptional<z.ZodEnum<{ fcm: 'fcm'; apn: 'apn' }>>
    pushSubscription: z.ZodOptional<
      z.ZodNullable<
        z.ZodUnion<
          readonly [
            z.ZodObject<
              {
                endpoint: z.ZodOptional<z.ZodString>
                keys: z.ZodOptional<
                  z.ZodObject<{ p256dh: z.ZodString; auth: z.ZodString }, z.core.$strip>
                >
              },
              z.core.$strip
            >,
            z.ZodObject<
              { registrationId: z.ZodString; registrationType: z.ZodLiteral<'FCM'> },
              z.core.$strip
            >,
            z.ZodObject<{ registrationId: z.ZodString }, z.core.$strip>,
          ]
        >
      >
    >
  },
  z.core.$strip
>

pushSubscriptionKeysSchema

Web Push subscription keys schema.

const pushSubscriptionKeysSchema: z.ZodObject<
  { p256dh: z.ZodString; auth: z.ZodString },
  z.core.$strip
>

pushSubscriptionSchema

Combined push subscription schema (union of all types).

const pushSubscriptionSchema: z.ZodOptional<
  z.ZodNullable<
    z.ZodUnion<
      readonly [
        z.ZodObject<
          {
            endpoint: z.ZodOptional<z.ZodString>
            keys: z.ZodOptional<
              z.ZodObject<{ p256dh: z.ZodString; auth: z.ZodString }, z.core.$strip>
            >
          },
          z.core.$strip
        >,
        z.ZodObject<
          { registrationId: z.ZodString; registrationType: z.ZodLiteral<'FCM'> },
          z.core.$strip
        >,
        z.ZodObject<{ registrationId: z.ZodString }, z.core.$strip>,
      ]
    >
  >
>

resource

The device resource definition.

const resource: types.Resource<unknown>

routes

Declarative route definitions for the Device resource, used to generate the Express router.

const routes: (
  | { method: 'get'; path: string; middlewares: string[]; handler: string }
  | { method: 'patch'; path: string; middlewares: string[]; handler: string }
  | { method: 'delete'; path: string; middlewares: string[]; handler: string }
)[]

updatePropsSchema

Zod schema for updating a device (partial pick of name, push platform, push subscription).

const updatePropsSchema: z.ZodObject<
  {
    name: z.ZodOptional<z.ZodOptional<z.ZodString>>
    pushPlatform: z.ZodOptional<z.ZodOptional<z.ZodEnum<{ fcm: 'fcm'; apn: 'apn' }>>>
    pushSubscription: z.ZodOptional<
      z.ZodOptional<
        z.ZodNullable<
          z.ZodUnion<
            readonly [
              z.ZodObject<
                {
                  endpoint: z.ZodOptional<z.ZodString>
                  keys: z.ZodOptional<
                    z.ZodObject<{ p256dh: z.ZodString; auth: z.ZodString }, z.core.$strip>
                  >
                },
                z.core.$strip
              >,
              z.ZodObject<
                { registrationId: z.ZodString; registrationType: z.ZodLiteral<'FCM'> },
                z.core.$strip
              >,
              z.ZodObject<{ registrationId: z.ZodString }, z.core.$strip>,
            ]
          >
        >
      >
    >
    hasPushSubscription: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>
  },
  z.core.$strip
>

webPushSubscriptionSchema

Web Push subscription schema.

const webPushSubscriptionSchema: z.ZodObject<
  {
    endpoint: z.ZodOptional<z.ZodString>
    keys: z.ZodOptional<z.ZodObject<{ p256dh: z.ZodString; auth: z.ZodString }, z.core.$strip>>
  },
  z.core.$strip
>

Namespaces

authorizers

Members:

• authorizers.auth — function: Middleware that checks if the request has an authenticated session (res.locals.session.userId).
• authorizers.authUser — function: Middleware that verifies the device belongs to the authenticated user. Queries the database

handlers

Members:

• handlers.del — function: Deletes a device by ID from the database.
• handlers.pushPublicKey — function: Push public key — GET /devices/push/public-key.
• handlers.query — function: Queries all devices belonging to the authenticated user. Supports pagination via before/after
• handlers.read — function: Reads a single device from res.locals.device, which is set by the authUser authorizer
• handlers.update — function: Updates a device's allowed fields: name, pushPlatform, pushSubscription, and

types

Members:

• types.APNPushSubscription — type: APN push subscription type.
• types.CreateProps — type: Fields required when registering a new device (userId, name, push subscription).
• types.FCMPushSubscription — type: FCM push subscription type.
• types.Props — type: Full device record properties (userId, name, push platform/subscription, timestamps).
• types.PushProps — type: Push notification properties for a device (device ID, platform, subscription data).
• types.PushSubscription — type: Web Push subscription type.
• types.UpdateProps — type: Updatable device fields (name, push platform, push subscription).
• types.Resource — type: An object describing the device resource.
• types.DeviceService — interface: DeviceService interface for the bond system.

z

Members:

• z.core — namespace
• z.infer — type
• z.output — type
• z.input — type
• z.JSONType — type
• z.globalRegistry — const
• z.GlobalMeta — interface
• z.registry — function
• z.config — function
• z.$output — const
• z.$input — const
• z.$brand — const
• z.clone — function
• z.regexes — namespace
• z.treeifyError — function
• z.prettifyError — function
• z.formatError — function
• z.flattenError — function
• z.TimePrecision — const
• z.util — namespace
• z.NEVER — const: A special constant with type never
• z.toJSONSchema — function
• z.fromJSONSchema — function: Converts a JSON Schema to a Zod schema. This function should be considered semi-experimental. It's behavior is liable to change.
• z.locales — namespace
• z.ZodISODateTime — interface
• z.ZodISODate — interface
• z.ZodISOTime — interface
• z.ZodISODuration — interface
• z.iso — namespace
• z.ZodCoercedString — interface
• z.ZodCoercedNumber — interface
• z.ZodCoercedBigInt — interface
• z.ZodCoercedBoolean — interface
• z.ZodCoercedDate — interface
• z.coerce — namespace
• z.string — function
• z.email — function
• z.guid — function
• z.uuid — function
• z.uuidv4 — function
• z.uuidv6 — function
• z.uuidv7 — function
• z.url — function
• z.httpUrl — function
• z.emoji — function
• z.nanoid — function
• z.cuid — function: Validates a CUID v1 string.
• z.cuid2 — function
• z.ulid — function
• z.xid — function
• z.ksuid — function
• z.ipv4 — function
• z.mac — function
• z.ipv6 — function
• z.cidrv4 — function
• z.cidrv6 — function
• z.base64 — function
• z.base64url — function
• z.e164 — function
• z.jwt — function
• z.stringFormat — function
• z.hostname — function
• z.hex — function
• z.hash — function
• z.number — function
• z.int — function
• z.float32 — function
• z.float64 — function
• z.int32 — function
• z.uint32 — function
• z.boolean — function
• z.bigint — function
• z.int64 — function
• z.uint64 — function
• z.symbol — function
• z.any — function
• z.unknown — function
• z.never — function
• z.date — function
• z.array — function
• z.keyof — function
• z.object — function
• z.strictObject — function
• z.looseObject — function
• z.union — function
• z.xor — function: Creates an exclusive union (XOR) where exactly one option must match.
• z.discriminatedUnion — function
• z.intersection — function
• z.tuple — function
• z.record — function
• z.partialRecord — function
• z.looseRecord — function
• z.map — function
• z.set — function
• z.nativeEnum — function
• z.literal — function
• z.file — function
• z.transform — function
• z.optional — function
• z.exactOptional — function
• z.nullable — function
• z.nullish — function
• z._default — function
• z.prefault — function
• z.nonoptional — function
• z.success — function
• z.nan — function
• z.pipe — function
• z.codec — function
• z.invertCodec — function
• z.readonly — function
• z.templateLiteral — function
• z.lazy — function
• z.promise — function
• z._function — function
• z.check — function
• z.custom — function
• z.refine — function
• z.superRefine — function
• z.json — function
• z.preprocess — function
• z.ZodStandardSchemaWithJSON — type
• z.ZodType — interface
• z._ZodType — interface
• z._ZodString — interface
• z.ZodString — interface
• z.ZodStringFormat — interface
• z.ZodEmail — interface
• z.ZodGUID — interface
• z.ZodUUID — interface
• z.ZodURL — interface
• z.ZodEmoji — interface
• z.ZodNanoID — interface
• z.ZodCUID — interface
• z.ZodCUID2 — interface
• z.ZodULID — interface
• z.ZodXID — interface
• z.ZodKSUID — interface
• z.ZodIPv4 — interface
• z.ZodMAC — interface
• z.ZodIPv6 — interface
• z.ZodCIDRv4 — interface
• z.ZodCIDRv6 — interface
• z.ZodBase64 — interface
• z.ZodBase64URL — interface
• z.ZodE164 — interface
• z.ZodJWT — interface
• z.ZodCustomStringFormat — interface
• z._ZodNumber — interface
• z.ZodNumber — interface
• z.ZodNumberFormat — interface
• z.ZodInt — interface
• z.ZodFloat32 — interface
• z.ZodFloat64 — interface
• z.ZodInt32 — interface
• z.ZodUInt32 — interface
• z._ZodBoolean — interface
• z.ZodBoolean — interface
• z._ZodBigInt — interface
• z.ZodBigInt — interface
• z.ZodBigIntFormat — interface
• z.ZodSymbol — interface
• z.ZodUndefined — interface
• z.undefined — function
• z.ZodNull — interface
• z.null — function
• z.ZodAny — interface
• z.ZodUnknown — interface
• z.ZodNever — interface
• z.ZodVoid — interface
• z.void — function
• z._ZodDate — interface
• z.ZodDate — interface
• z.ZodArray — interface
• z.SafeExtendShape — type
• z.ZodObject — interface
• z.ZodUnion — interface
• z.ZodXor — interface
• z.ZodDiscriminatedUnion — interface
• z.ZodIntersection — interface
• z.ZodTuple — interface
• z.ZodRecord — interface
• z.ZodMap — interface
• z.ZodSet — interface
• z.ZodEnum — interface
• z.enum — function
• z.ZodLiteral — interface
• z.ZodFile — interface
• z.ZodTransform — interface
• z.ZodOptional — interface
• z.ZodExactOptional — interface
• z.ZodNullable — interface
• z.ZodDefault — interface
• z.ZodPrefault — interface
• z.ZodNonOptional — interface
• z.ZodSuccess — interface
• z.ZodCatch — interface
• z.catch — function
• z.ZodNaN — interface
• z.ZodPipe — interface
• z.ZodCodec — interface
• z.ZodPreprocess — interface
• z.ZodReadonly — interface
• z.ZodTemplateLiteral — interface
• z.ZodLazy — interface
• z.ZodPromise — interface
• z.ZodFunction — interface
• z.function — function
• z.ZodCustom — interface
• z.describe — const
• z.meta — const
• z.instanceof — function
• z.stringbool — const
• z.ZodJSONSchemaInternals — interface
• z.ZodJSONSchema — interface
• z.lt — function
• z.lte — function
• z.gt — function
• z.gte — function
• z.positive — function
• z.negative — function
• z.nonpositive — function
• z.nonnegative — function
• z.multipleOf — function
• z.maxSize — function
• z.minSize — function
• z.size — function
• z.maxLength — function
• z.minLength — function
• z.length — function
• z.regex — function
• z.lowercase — function
• z.uppercase — function
• z.includes — function
• z.startsWith — function
• z.endsWith — function
• z.property — function
• z.mime — function
• z.overwrite — function
• z.normalize — function
• z.trim — function
• z.toLowerCase — function
• z.toUpperCase — function
• z.slugify — function
• z.RefinementCtx — interface
• z.ZodIssue — type
• z.ZodError — interface: An Error-like class used to store Zod validation issues.
• z.ZodRealError — const
• z.ZodFlattenedError — type
• z.ZodFormattedError — type
• z.ZodErrorMap — interface
• z.IssueData — type
• z.ZodSafeParseResult — type
• z.ZodSafeParseSuccess — type
• z.ZodSafeParseError — type
• z.parse — const
• z.parseAsync — const
• z.safeParse — const
• z.safeParseAsync — const
• z.encode — const
• z.decode — const
• z.encodeAsync — const
• z.decodeAsync — const
• z.safeEncode — const
• z.safeDecode — const
• z.safeEncodeAsync — const
• z.safeDecodeAsync — const
• z.setErrorMap — function
• z.getErrorMap — function
• z.TypeOf — type
• z.Infer — type
• z.ZodFirstPartySchemaTypes — type
• z.ZodIssueCode — const
• z.inferFlattenedErrors — type
• z.inferFormattedError — type
• z.BRAND — type: Use z.$brand instead
• z.ZodTypeAny — interface
• z.ZodSchema — interface
• z.Schema — interface
• z.ZodRawShape — type: Included for Zod 3 compatibility
• z.ZodFirstPartyTypeKind — enum

Services

This package exports services that should be registered with the bond system:

import { bond } from '@molecule/api-bond'
import { deviceService } from '@molecule/api-resource-device'

bond('device', deviceService)

Injection Notes

Requirements

Peer dependencies:

• @molecule/api-bond ^1.0.1
• @molecule/api-i18n ^1.0.1
• @molecule/api-locales-device ^1.0.1
• @molecule/api-resource ^1.0.1
• @molecule/api-database ^1.0.1

Runtime Dependencies

• @molecule/api-bond

• @molecule/api-database

• @molecule/api-i18n

• @molecule/api-locales-device

• @molecule/api-resource

• zod

• Table setup: setup/devices.sql ships with this package (the standard scaffold applies it as a base migration; resource.tableName is devices). When adding to an existing app, apply it before use.

• The handler map is a factory, not a constant. Call createRequestHandlerMap(createRequestHandler); do not import a requestHandlerMap constant like other resources export. Its auth / authUser entries are the authorizer middlewares the routes reference — authUser enforces that the session user OWNS the device row; removing either from the map ships the routes ungated (IDOR on other users' devices).

• Device rows are created by the auth flow, not by these routes — there is no POST /devices; signup/login registers the caller's device. Clients then save their push subscription via PATCH /devices/:id { pushSubscription, hasPushSubscription } — the contract the push fan-outs read.

• GET /devices/push/public-key is unauthenticated by design (VAPID public keys are public) and bond-gated: 404 when no push-notifications bond is wired, 503 when it is wired but unconfigured (VAPID_PUBLIC_KEY unset) — never a crash. Surface those states in the client instead of retrying.

E2E Tests

Integration checklist — drive the real UI (live preview, no mocks), adapt each item to this app's actual screens/flows, and check every box off one by one. A box you can't check is an integration bug to fix — not a skip:

• Registering a device persists a real row that appears in the signed-in user's device list: sign in on a fresh browser/install, open GET /devices, and the device shows with its name and timestamps — the current session's device sorted first and flagged isCurrent: true. Rows are created by the AUTH flow (signup/login → createOrUpdate), NOT a POST route; there is no POST /devices.
• Re-registering the SAME device does not duplicate it: sign in again from the same device (same user + device name) and the existing row is reused with a bumped updatedAt — the list count is unchanged, no second row appears. (The dedup key here is user + name, not a push token.)
• Saving a push subscription targets THIS device and only opted-in ones: PATCH /devices/:id { pushSubscription, pushPlatform, hasPushSubscription: true } stores the subscription (pushSubscription is what push actually targets), and a real push fan-out reaches exactly the user's devices where hasPushSubscription is true (getWithPushSubscription) — a device that never subscribed receives nothing.
• Refreshing the subscription replaces the stale one: PATCH the same device with a new pushSubscription and the next push goes to the NEW value, never the old — one current subscription per device, not a growing list. Clearing it (hasPushSubscription: false) drops the device from the fan-out set immediately, so it stops receiving.
• Last-seen tracks use: an active device's updatedAt advances on re-registration / updateLastSeen, so the list reflects recency.
• Removing a device deletes it and it can no longer be targeted OR used: DELETE /devices/:id removes the row, so it disappears from GET /devices, is excluded from every push fan-out, AND its session is revoked — the JWT bound to that deviceId is rejected on its very next request (exists() → false), for every copy of the token.
• AUTHORIZATION — devices are strictly per-user. GET /devices returns ONLY the session user's own rows; reading, updating, or deleting via /devices/:id is gated by authUser, which requires the device id AND its userId to match the session — so guessing another user's device id is rejected (401, no IDOR into their row or push subscription). The owner is always the session user: a device is registered under the caller's own userId, and one user can never PATCH a push subscription onto another user's device.