Skip to content

Repository files navigation

Filecheck Integrations

Official Filecheck packages for custom stacks. All browser wrappers are thin shims around the Element loaded from https://cdn.filecheck.io/element/v1/filecheck.js — they never bundle or reimplement Element logic.

Package Registry Purpose
filecheck-js npm Typed async loader for the CDN Element script + all shared TypeScript types
filecheck-react npm React component + hook wrapping the Element
filecheck-vue npm Vue 3 component + composable wrapping the Element
filecheck-node npm Server SDK: jobs API, uploads, webhooks, jobs.verify()
filecheck/filecheck-php Packagist PHP server SDK mirroring filecheck (standalone repo, nested here)

Development

pnpm install
pnpm build       # build all packages
pnpm test        # vitest across the workspace
pnpm typecheck   # tsc --strict per package
pnpm lint        # biome
pnpm size        # element-js bundle-size gate (< 3 kB min+gzip)

The PHP SDK lives in filecheck-php/ as its own git repository (Packagist requires the repo root to be the composer.json root); it is excluded from this repo's git history. See filecheck-php/README.md.

Releases are driven by changesets: pnpm changeset to record a change, CI publishes from main. All packages are independently versioned, MIT licensed, and start at 0.1.0 (1.0.0 only after the Element API is confirmed stable).

Type vendoring

filecheck-js vendors the Element's public types from the filecheck repo (packages/element/src). Run pnpm sync:types (with a sibling ../filecheck checkout, or FILECHECK_REPO=<path>) to diff the vendored copies against upstream before a release.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages