Skip to content
ContractSpec
Start here

Package manual · platform

·Forms, data views and data exchange

lib.files

Files, documents and attachments module for ContractSpec applications

platformlibraryv5.0.4stableservernode
@lssm-tech/lib.files
bun add @lssm-tech/lib.files
Package source ↗Manifest ↗

Manifest declarations describe the current workspace; they do not verify registry publication or runtime execution.

Package guide

Website: https://contractspec.io

Files, documents and attachments module for ContractSpec applications.

What It Provides

  • Layer: lib.
  • Consumers: bundles.
  • @lssm-tech/lib.files/storage now includes immutable tenant-scoped artifact storage helpers.
  • src/contracts/ contains contract specs, operations, entities, and registry exports.
  • src/docs/ contains docblocks and documentation-facing exports.
  • src/contracts/ contains contract specs, operations, entities, and registry exports.
  • src/docs/ contains docblocks and documentation-facing exports.

Installation

npm install @lssm-tech/lib.files

or

bun add @lssm-tech/lib.files

Usage

Import the root entrypoint from @lssm-tech/lib.files, or choose a documented subpath when you only need one part of the package surface.

Architecture

  • src/contracts/ contains contract specs, operations, entities, and registry exports.
  • src/docs/ contains docblocks and documentation-facing exports.
  • src/entities/ contains domain entities and value objects.
  • src/events.ts is package-level event definitions.
  • src/files.capability.ts defines a capability surface.
  • src/files.feature.ts defines a feature entrypoint.
  • src/index.ts is the root public barrel and package entrypoint.
  • src/storage/artifact-store.ts provides immutable, tenant-scoped artifact metadata/retrieval with MIME/size policy, retention cleanup, crash recovery, cursor listing, and content/metadata tamper checks.

Public Entry Points

  • Export . resolves through ./src/index.ts.
  • Export ./contracts resolves through ./src/contracts/index.ts.
  • Export ./docs resolves through ./src/docs/index.ts.
  • Export ./docs/files.docblock resolves through ./src/docs/files.docblock.ts.
  • Export ./entities resolves through ./src/entities/index.ts.
  • Export ./events resolves through ./src/events.ts.
  • Export ./files.capability resolves through ./src/files.capability.ts.
  • Export ./files.feature resolves through ./src/files.feature.ts.
  • Export ./storage resolves through ./src/storage/index.ts.

Local Commands

  • bun run dev — contractspec-bun-build dev
  • bun run build — contractspec-bun-build build
  • bun run lint — bun lint:fix
  • bun run lint:check — biome check .
  • bun run lint:fix — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
  • bun run typecheck — tsgo --noEmit
  • bun run publish:pkg — bun publish --tolerate-republish --ignore-scripts --verbose
  • bun run publish:pkg:canary — bun publish:pkg --tag canary
  • bun run clean — rimraf dist .turbo
  • bun run build:bundle — contractspec-bun-build transpile
  • bun run build:types — contractspec-bun-build types
  • bun run prebuild — contractspec-bun-build prebuild

Recent Updates

  • Replace eslint+prettier by biomejs to optimize speed.

Notes

  • Storage interface is the adapter boundary — do not couple consumers to a specific storage provider.
  • File entity schema is shared; field changes require migration coordination.
  • Capability contract is public API.

Relationships

THIS PACKAGElib.files16 import paths

Arrows point from a package to its direct dependency. Counts are derived from captured workspace manifests.

4 declarations

Declared capabilities

Lib Files

Files, documents and attachments module for ContractSpec applications

Scripts

  • publish:pkgbun publish --tolerate-republish --ignore-scripts --verbose
  • publish:pkg:canarybun publish:pkg --tag canary
  • buildcontractspec-bun-build build
  • build:bundlecontractspec-bun-build transpile
  • build:typescontractspec-bun-build types
  • devcontractspec-bun-build dev
  • cleanrimraf dist .turbo
  • lintbun lint:fix
  • lint:fixnode ../../../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../../../scripts/biome.cjs check --write .
  • lint:checknode ../../../../scripts/biome.cjs check .
  • prebuildcontractspec-bun-build prebuild
  • typechecktsgo --noEmit