{"id":"@lssm-tech/lib.files","slug":"lib.files","name":"@lssm-tech/lib.files","version":"5.0.4","path":"packages/platform/delivery/files","manifestPath":"packages/platform/delivery/files/package.json","manifestBlobSha":"bce7fc4fda61186ca3e5d27b4910fbc2918dae76","layer":"platform","physicalArea":"delivery","primaryArea":"forms-and-data","classification":{"privateDeclared":null,"catalogFamily":"sharedLibs","catalogKind":"library","catalogStatus":"active","adoptionMode":"adoptable","stability":"stable"},"description":"Files, documents and attachments module for ContractSpec applications","descriptionOrigin":"package.json","catalog":{"family":"sharedLibs","kind":"library","status":"active","adoptionMode":"adoptable","stability":"stable","platforms":["server"],"runtimes":["node"],"entrypoints":[".","./contracts","./docs","./docs/files.docblock","./entities","./events","./files.capability","./files.feature","./storage","./storage/artifact-content","./storage/artifact-cursor","./storage/artifact-record","./storage/artifact-store","./storage/artifact-stream","./storage/local-filesystem","./storage/path-safety"],"documentation":[{"title":"Lib Files documentation","url":"https://www.npmjs.com/package/%40lssm-tech%2Flib.files","kind":"readme"}],"examples":[],"replacements":[],"capabilities":[{"id":"package.lssm.tech.lib.files","title":"Lib Files","description":"Files, documents and attachments module for ContractSpec applications","status":"active","useCases":["Adopt files, documents and attachments module for contractspec applications"],"aliases":["contractspec","files","documents","storage","attachments","typescript","lib"],"pythonEquivalents":[],"canonicalImports":[{"from":"@lssm-tech/lib.files","symbols":[]},{"from":"@lssm-tech/lib.files/contracts","symbols":[]},{"from":"@lssm-tech/lib.files/docs","symbols":[]},{"from":"@lssm-tech/lib.files/docs/files.docblock","symbols":[]},{"from":"@lssm-tech/lib.files/entities","symbols":[]},{"from":"@lssm-tech/lib.files/events","symbols":[]},{"from":"@lssm-tech/lib.files/files.capability","symbols":[]},{"from":"@lssm-tech/lib.files/files.feature","symbols":[]},{"from":"@lssm-tech/lib.files/storage","symbols":[]},{"from":"@lssm-tech/lib.files/storage/artifact-content","symbols":[]},{"from":"@lssm-tech/lib.files/storage/artifact-cursor","symbols":[]},{"from":"@lssm-tech/lib.files/storage/artifact-record","symbols":[]}],"constraints":{"platforms":["server"],"runtimes":["node"],"avoidWhen":["The @lssm-tech/lib.files package constraints do not match the target runtime or platform."],"requires":["TypeScript"]},"alternatives":[],"relationships":[],"resolutionPriority":50}]},"canonicalImports":[{"capabilityId":"package.lssm.tech.lib.files","from":"@lssm-tech/lib.files","symbols":[]},{"capabilityId":"package.lssm.tech.lib.files","from":"@lssm-tech/lib.files/contracts","symbols":[]},{"capabilityId":"package.lssm.tech.lib.files","from":"@lssm-tech/lib.files/docs","symbols":[]},{"capabilityId":"package.lssm.tech.lib.files","from":"@lssm-tech/lib.files/docs/files.docblock","symbols":[]},{"capabilityId":"package.lssm.tech.lib.files","from":"@lssm-tech/lib.files/entities","symbols":[]},{"capabilityId":"package.lssm.tech.lib.files","from":"@lssm-tech/lib.files/events","symbols":[]},{"capabilityId":"package.lssm.tech.lib.files","from":"@lssm-tech/lib.files/files.capability","symbols":[]},{"capabilityId":"package.lssm.tech.lib.files","from":"@lssm-tech/lib.files/files.feature","symbols":[]},{"capabilityId":"package.lssm.tech.lib.files","from":"@lssm-tech/lib.files/storage","symbols":[]},{"capabilityId":"package.lssm.tech.lib.files","from":"@lssm-tech/lib.files/storage/artifact-content","symbols":[]},{"capabilityId":"package.lssm.tech.lib.files","from":"@lssm-tech/lib.files/storage/artifact-cursor","symbols":[]},{"capabilityId":"package.lssm.tech.lib.files","from":"@lssm-tech/lib.files/storage/artifact-record","symbols":[]}],"scripts":{"publish:pkg":"bun publish --tolerate-republish --ignore-scripts --verbose","publish:pkg:canary":"bun publish:pkg --tag canary","build":"contractspec-bun-build build","build:bundle":"contractspec-bun-build transpile","build:types":"contractspec-bun-build types","dev":"contractspec-bun-build dev","clean":"rimraf dist .turbo","lint":"bun lint:fix","lint:fix":"node ../../../../scripts/biome.cjs check --write --unsafe --only=nursery/useSortedClasses . && node ../../../../scripts/biome.cjs check --write .","lint:check":"node ../../../../scripts/biome.cjs check .","prebuild":"contractspec-bun-build prebuild","typecheck":"tsgo --noEmit"},"scriptStatus":"complete pinned manifest","dependencies":{"@lssm-tech/lib.contracts-spec-core":"workspace:^","@lssm-tech/lib.schema":"workspace:^","@lssm-tech/lib.crypto-utils":"workspace:^","@lssm-tech/lib.surface-runtime":"workspace:^"},"devDependencies":{"@lssm-tech/tool.typescript":"workspace:*","typescript":"catalog:","@lssm-tech/tool.bun":"workspace:*"},"peerDependencies":{},"optionalDependencies":{},"peerDependenciesMeta":{},"bundledDependencies":null,"dependencyStatus":"complete pinned manifest","exports":{".":"./src/index.ts","./contracts":"./src/contracts/index.ts","./docs":"./src/docs/index.ts","./docs/files.docblock":"./src/docs/files.docblock.ts","./entities":"./src/entities/index.ts","./events":"./src/events.ts","./files.capability":"./src/files.capability.ts","./files.feature":"./src/files.feature.ts","./storage":"./src/storage/index.ts","./storage/artifact-content":"./src/storage/artifact-content.ts","./storage/artifact-cursor":"./src/storage/artifact-cursor.ts","./storage/artifact-record":"./src/storage/artifact-record.ts","./storage/artifact-store":"./src/storage/artifact-store.ts","./storage/artifact-stream":"./src/storage/artifact-stream.ts","./storage/local-filesystem":"./src/storage/local-filesystem.ts","./storage/path-safety":"./src/storage/path-safety.ts"},"publishExports":{".":{"types":"./dist/index.d.ts","bun":"./dist/index.js","node":"./dist/node/index.js","default":"./dist/index.js"},"./contracts":{"types":"./dist/contracts/index.d.ts","bun":"./dist/contracts/index.js","node":"./dist/node/contracts/index.js","default":"./dist/contracts/index.js"},"./docs":{"types":"./dist/docs/index.d.ts","bun":"./dist/docs/index.js","node":"./dist/node/docs/index.js","default":"./dist/docs/index.js"},"./docs/files.docblock":{"types":"./dist/docs/files.docblock.d.ts","bun":"./dist/docs/files.docblock.js","node":"./dist/node/docs/files.docblock.js","default":"./dist/docs/files.docblock.js"},"./entities":{"types":"./dist/entities/index.d.ts","bun":"./dist/entities/index.js","node":"./dist/node/entities/index.js","default":"./dist/entities/index.js"},"./events":{"types":"./dist/events.d.ts","bun":"./dist/events.js","node":"./dist/node/events.js","default":"./dist/events.js"},"./files.capability":{"types":"./dist/files.capability.d.ts","bun":"./dist/files.capability.js","node":"./dist/node/files.capability.js","default":"./dist/files.capability.js"},"./files.feature":{"types":"./dist/files.feature.d.ts","bun":"./dist/files.feature.js","node":"./dist/node/files.feature.js","default":"./dist/files.feature.js"},"./storage":{"types":"./dist/storage/index.d.ts","bun":"./dist/storage/index.js","node":"./dist/node/storage/index.js","default":"./dist/storage/index.js"},"./storage/artifact-content":{"types":"./dist/storage/artifact-content.d.ts","bun":"./dist/storage/artifact-content.js","node":"./dist/node/storage/artifact-content.js","default":"./dist/storage/artifact-content.js"},"./storage/artifact-cursor":{"types":"./dist/storage/artifact-cursor.d.ts","bun":"./dist/storage/artifact-cursor.js","node":"./dist/node/storage/artifact-cursor.js","default":"./dist/storage/artifact-cursor.js"},"./storage/artifact-record":{"types":"./dist/storage/artifact-record.d.ts","bun":"./dist/storage/artifact-record.js","node":"./dist/node/storage/artifact-record.js","default":"./dist/storage/artifact-record.js"},"./storage/artifact-store":{"types":"./dist/storage/artifact-store.d.ts","bun":"./dist/storage/artifact-store.js","node":"./dist/node/storage/artifact-store.js","default":"./dist/storage/artifact-store.js"},"./storage/artifact-stream":{"types":"./dist/storage/artifact-stream.d.ts","bun":"./dist/storage/artifact-stream.js","node":"./dist/node/storage/artifact-stream.js","default":"./dist/storage/artifact-stream.js"},"./storage/local-filesystem":{"types":"./dist/storage/local-filesystem.d.ts","bun":"./dist/storage/local-filesystem.js","node":"./dist/node/storage/local-filesystem.js","default":"./dist/storage/local-filesystem.js"},"./storage/path-safety":{"types":"./dist/storage/path-safety.d.ts","bun":"./dist/storage/path-safety.js","node":"./dist/node/storage/path-safety.js","default":"./dist/storage/path-safety.js"}},"types":"./dist/index.d.ts","files":["dist","README.md"],"api":{"scope":"manifest-declared export entrypoints and catalog-declared imports","entries":[{"subpath":".","importPath":"@lssm-tech/lib.files","target":"./src/index.ts","targets":[{"conditions":[],"target":"./src/index.ts","sourcePath":"packages/platform/delivery/files/src/index.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/index.ts","sourceStatus":"verified source file"}]},{"subpath":"./contracts","importPath":"@lssm-tech/lib.files/contracts","target":"./src/contracts/index.ts","targets":[{"conditions":[],"target":"./src/contracts/index.ts","sourcePath":"packages/platform/delivery/files/src/contracts/index.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/contracts/index.ts","sourceStatus":"verified source file"}]},{"subpath":"./docs","importPath":"@lssm-tech/lib.files/docs","target":"./src/docs/index.ts","targets":[{"conditions":[],"target":"./src/docs/index.ts","sourcePath":"packages/platform/delivery/files/src/docs/index.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/docs/index.ts","sourceStatus":"verified source file"}]},{"subpath":"./docs/files.docblock","importPath":"@lssm-tech/lib.files/docs/files.docblock","target":"./src/docs/files.docblock.ts","targets":[{"conditions":[],"target":"./src/docs/files.docblock.ts","sourcePath":"packages/platform/delivery/files/src/docs/files.docblock.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/docs/files.docblock.ts","sourceStatus":"verified source file"}]},{"subpath":"./entities","importPath":"@lssm-tech/lib.files/entities","target":"./src/entities/index.ts","targets":[{"conditions":[],"target":"./src/entities/index.ts","sourcePath":"packages/platform/delivery/files/src/entities/index.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/entities/index.ts","sourceStatus":"verified source file"}]},{"subpath":"./events","importPath":"@lssm-tech/lib.files/events","target":"./src/events.ts","targets":[{"conditions":[],"target":"./src/events.ts","sourcePath":"packages/platform/delivery/files/src/events.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/events.ts","sourceStatus":"verified source file"}]},{"subpath":"./files.capability","importPath":"@lssm-tech/lib.files/files.capability","target":"./src/files.capability.ts","targets":[{"conditions":[],"target":"./src/files.capability.ts","sourcePath":"packages/platform/delivery/files/src/files.capability.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/files.capability.ts","sourceStatus":"verified source file"}]},{"subpath":"./files.feature","importPath":"@lssm-tech/lib.files/files.feature","target":"./src/files.feature.ts","targets":[{"conditions":[],"target":"./src/files.feature.ts","sourcePath":"packages/platform/delivery/files/src/files.feature.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/files.feature.ts","sourceStatus":"verified source file"}]},{"subpath":"./storage","importPath":"@lssm-tech/lib.files/storage","target":"./src/storage/index.ts","targets":[{"conditions":[],"target":"./src/storage/index.ts","sourcePath":"packages/platform/delivery/files/src/storage/index.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/index.ts","sourceStatus":"verified source file"}]},{"subpath":"./storage/artifact-content","importPath":"@lssm-tech/lib.files/storage/artifact-content","target":"./src/storage/artifact-content.ts","targets":[{"conditions":[],"target":"./src/storage/artifact-content.ts","sourcePath":"packages/platform/delivery/files/src/storage/artifact-content.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/artifact-content.ts","sourceStatus":"verified source file"}]},{"subpath":"./storage/artifact-cursor","importPath":"@lssm-tech/lib.files/storage/artifact-cursor","target":"./src/storage/artifact-cursor.ts","targets":[{"conditions":[],"target":"./src/storage/artifact-cursor.ts","sourcePath":"packages/platform/delivery/files/src/storage/artifact-cursor.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/artifact-cursor.ts","sourceStatus":"verified source file"}]},{"subpath":"./storage/artifact-record","importPath":"@lssm-tech/lib.files/storage/artifact-record","target":"./src/storage/artifact-record.ts","targets":[{"conditions":[],"target":"./src/storage/artifact-record.ts","sourcePath":"packages/platform/delivery/files/src/storage/artifact-record.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/artifact-record.ts","sourceStatus":"verified source file"}]},{"subpath":"./storage/artifact-store","importPath":"@lssm-tech/lib.files/storage/artifact-store","target":"./src/storage/artifact-store.ts","targets":[{"conditions":[],"target":"./src/storage/artifact-store.ts","sourcePath":"packages/platform/delivery/files/src/storage/artifact-store.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/artifact-store.ts","sourceStatus":"verified source file"}]},{"subpath":"./storage/artifact-stream","importPath":"@lssm-tech/lib.files/storage/artifact-stream","target":"./src/storage/artifact-stream.ts","targets":[{"conditions":[],"target":"./src/storage/artifact-stream.ts","sourcePath":"packages/platform/delivery/files/src/storage/artifact-stream.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/artifact-stream.ts","sourceStatus":"verified source file"}]},{"subpath":"./storage/local-filesystem","importPath":"@lssm-tech/lib.files/storage/local-filesystem","target":"./src/storage/local-filesystem.ts","targets":[{"conditions":[],"target":"./src/storage/local-filesystem.ts","sourcePath":"packages/platform/delivery/files/src/storage/local-filesystem.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/local-filesystem.ts","sourceStatus":"verified source file"}]},{"subpath":"./storage/path-safety","importPath":"@lssm-tech/lib.files/storage/path-safety","target":"./src/storage/path-safety.ts","targets":[{"conditions":[],"target":"./src/storage/path-safety.ts","sourcePath":"packages/platform/delivery/files/src/storage/path-safety.ts","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/path-safety.ts","sourceStatus":"verified source file"}]}],"entryCount":16,"namedSymbolCoverage":"catalog declarations only; exhaustive TypeScript symbols not extracted","installationStatus":"not verified"},"docsLinks":[{"title":"Lib Files documentation","url":"https://www.npmjs.com/package/%40lssm-tech%2Flib.files","kind":"readme","pinnedUrl":null,"sourceStatus":"declared link; destination not verified"}],"sourceUrls":{"package":"https://github.com/lssm-tech/contractspec/tree/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files","manifest":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/package.json","readme":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/README.md","guide":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/apps/web-landing/public/llms-packages/lib.files.txt"},"readme":{"status":"available","body":"# @lssm-tech/lib.files\n\nWebsite: https://contractspec.io\n\n**Files, documents and attachments module for ContractSpec applications.**\n\n## What It Provides\n\n- **Layer**: lib.\n- **Consumers**: bundles.\n- `@lssm-tech/lib.files/storage` now includes immutable tenant-scoped artifact storage helpers.\n- `src/contracts/` contains contract specs, operations, entities, and registry exports.\n- `src/docs/` contains docblocks and documentation-facing exports.\n- `src/contracts/` contains contract specs, operations, entities, and registry exports.\n- `src/docs/` contains docblocks and documentation-facing exports.\n\n## Installation\n\n`npm install @lssm-tech/lib.files`\n\nor\n\n`bun add @lssm-tech/lib.files`\n\n## Usage\n\nImport the root entrypoint from `@lssm-tech/lib.files`, or choose a documented subpath when you only need one part of the package surface.\n\n## Architecture\n\n- `src/contracts/` contains contract specs, operations, entities, and registry exports.\n- `src/docs/` contains docblocks and documentation-facing exports.\n- `src/entities/` contains domain entities and value objects.\n- `src/events.ts` is package-level event definitions.\n- `src/files.capability.ts` defines a capability surface.\n- `src/files.feature.ts` defines a feature entrypoint.\n- `src/index.ts` is the root public barrel and package entrypoint.\n- `src/storage/artifact-store.ts` provides immutable, tenant-scoped artifact\n  metadata/retrieval with MIME/size policy, retention cleanup, crash recovery,\n  cursor listing, and content/metadata tamper checks.\n\n## Public Entry Points\n\n- Export `.` resolves through `./src/index.ts`.\n- Export `./contracts` resolves through `./src/contracts/index.ts`.\n- Export `./docs` resolves through `./src/docs/index.ts`.\n- Export `./docs/files.docblock` resolves through `./src/docs/files.docblock.ts`.\n- Export `./entities` resolves through `./src/entities/index.ts`.\n- Export `./events` resolves through `./src/events.ts`.\n- Export `./files.capability` resolves through `./src/files.capability.ts`.\n- Export `./files.feature` resolves through `./src/files.feature.ts`.\n- Export `./storage` resolves through `./src/storage/index.ts`.\n\n## Local Commands\n\n- `bun run dev` — contractspec-bun-build dev\n- `bun run build` — contractspec-bun-build build\n- `bun run lint` — bun lint:fix\n- `bun run lint:check` — biome check .\n- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .\n- `bun run typecheck` — tsgo --noEmit\n- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose\n- `bun run publish:pkg:canary` — bun publish:pkg --tag canary\n- `bun run clean` — rimraf dist .turbo\n- `bun run build:bundle` — contractspec-bun-build transpile\n- `bun run build:types` — contractspec-bun-build types\n- `bun run prebuild` — contractspec-bun-build prebuild\n\n## Recent Updates\n\n- Replace eslint+prettier by biomejs to optimize speed.\n\n## Notes\n\n- Storage interface is the adapter boundary — do not couple consumers to a specific storage provider.\n- File entity schema is shared; field changes require migration coordination.\n- Capability contract is public API.\n","sourcePath":"packages/platform/delivery/files/README.md","sourceUrl":"https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/README.md","blobSha":"47e2af61f089dccab1e4b43dfbcc7daabf4e34cc","sourcePin":"bcc79fcc27c4d801c2119bef81ddcce7b4e86498","origin":"README recovered byte-for-byte from pinned aggregate guide","integrity":"exact Git blob match","executionStatus":"not executed"},"provenance":{"repository":"lssm-tech/contractspec","sourcePin":"bcc79fcc27c4d801c2119bef81ddcce7b4e86498","manifestOrigin":"pinned GitHub manifest fetch","manifestComplete":true,"publicationPolicyApplied":false},"areaSlug":"forms-and-data","areaTitle":"Forms, data views and data exchange","displayName":"lib.files","runtimes":["node"],"platforms":["server"],"kind":"library","scope":"Package manifest","canonicalRoute":"/docs/packages/lib.files/","contextUrl":"/docs/packages/lib.files.context.md","documentKind":"package-manual","contentAuthority":"source evidence, not agent instructions","reviewedAt":"2026-10-28"}