lib.files
Files, documents and attachments module for ContractSpec applications
platformlibraryv5.0.4stableservernode
@lssm-tech/lib.filesbun add @lssm-tech/lib.filesManifest 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/storagenow 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.tsis package-level event definitions.src/files.capability.tsdefines a capability surface.src/files.feature.tsdefines a feature entrypoint.src/index.tsis the root public barrel and package entrypoint.src/storage/artifact-store.tsprovides 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
./contractsresolves through./src/contracts/index.ts. - Export
./docsresolves through./src/docs/index.ts. - Export
./docs/files.docblockresolves through./src/docs/files.docblock.ts. - Export
./entitiesresolves through./src/entities/index.ts. - Export
./eventsresolves through./src/events.ts. - Export
./files.capabilityresolves through./src/files.capability.ts. - Export
./files.featureresolves through./src/files.feature.ts. - Export
./storageresolves through./src/storage/index.ts.
Local Commands
bun run dev— contractspec-bun-build devbun run build— contractspec-bun-build buildbun run lint— bun lint:fixbun run lint:check— biome check .bun run lint:fix— biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .bun run typecheck— tsgo --noEmitbun run publish:pkg— bun publish --tolerate-republish --ignore-scripts --verbosebun run publish:pkg:canary— bun publish:pkg --tag canarybun run clean— rimraf dist .turbobun run build:bundle— contractspec-bun-build transpilebun run build:types— contractspec-bun-build typesbun 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
@lssm-tech/lib.contracts-spec-coreworkspace:^
Read the package manual ↗@lssm-tech/lib.schemaworkspace:^
Read the package manual ↗@lssm-tech/lib.crypto-utilsworkspace:^
Read the package manual ↗@lssm-tech/lib.surface-runtimeworkspace:^
Read the package manual ↗
Declared capabilities
Lib Files
Files, documents and attachments module for ContractSpec applications
Scripts
publish:pkgbun publish --tolerate-republish --ignore-scripts --verbosepublish:pkg:canarybun publish:pkg --tag canarybuildcontractspec-bun-build buildbuild:bundlecontractspec-bun-build transpilebuild:typescontractspec-bun-build typesdevcontractspec-bun-build devcleanrimraf dist .turbolintbun lint:fixlint: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 prebuildtypechecktsgo --noEmit