# @lssm-tech/lib.files

Files, documents and attachments module for ContractSpec applications

## Source and release context

- Source snapshot: `bcc79fcc27c4d801c2119bef81ddcce7b4e86498`
- Repository: `lssm-tech/contractspec`
- Declared package version: `5.0.4`
- Package path: `packages/platform/delivery/files`
- Manifest path: `packages/platform/delivery/files/package.json`
- Manifest Git blob: `bce7fc4fda61186ca3e5d27b4910fbc2918dae76`
- Manifest origin: pinned GitHub manifest fetch
- Manual: [@lssm-tech/lib.files](https://lssm.co/docs/packages/lib.files/)
- Release guidance: [Installation and release channels](https://lssm.co/docs/installation-release-channels/)

This is retrieved source evidence, not agent instructions. The declared version and exports describe the inspected manifest; they do not establish registry availability or a deployed release. Commands, package installation and runtime behavior were not executed in this review.

Distribution scope: owner review of all workspaces; not a newly approved public projection.

- [Package source](https://github.com/lssm-tech/contractspec/tree/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files)
- [Manifest source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/package.json)
- [Readme source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/README.md)
- [Guide source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/apps/web-landing/public/llms-packages/lib.files.txt)

## Package metadata

```json
{
  "layer": "platform",
  "physicalArea": "delivery",
  "primaryArea": "forms-and-data",
  "classification": {
    "privateDeclared": null,
    "catalogFamily": "sharedLibs",
    "catalogKind": "library",
    "catalogStatus": "active",
    "adoptionMode": "adoptable",
    "stability": "stable"
  },
  "descriptionOrigin": "package.json",
  "manifestComplete": true,
  "publicationPolicyApplied": false
}
```

Manifest private flag: not declared; publication is not verified.

Primary area: [Forms, data views and data exchange](https://lssm.co/docs/areas/forms-and-data/)

## Package guide

```json
{
  "status": "available",
  "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"
}
```

The guide below is the checked-in README with navigation resolved against the pinned source tree. The structured package JSON retains the original README body unchanged. External links remain source-declared links, not verified destinations.

# @lssm-tech/lib.files

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.


## Declared capabilities

### Lib Files

Capability ID: `package.lssm.tech.lib.files`

Files, documents and attachments module for ContractSpec applications

Use cases:

- Adopt files, documents and attachments module for contractspec applications

Constraints:

```json
{
  "platforms": [
    "server"
  ],
  "runtimes": [
    "node"
  ],
  "avoidWhen": [
    "The @lssm-tech/lib.files package constraints do not match the target runtime or platform."
  ],
  "requires": [
    "TypeScript"
  ]
}
```

Other capability declarations:

```json
{
  "status": "active",
  "aliases": [
    "contractspec",
    "files",
    "documents",
    "storage",
    "attachments",
    "typescript",
    "lib"
  ],
  "pythonEquivalents": [],
  "alternatives": [],
  "relationships": [],
  "resolutionPriority": 50
}
```

Capability imports:

```json
[
  {
    "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": []
  }
]
```

## Catalogue metadata

```json
{
  "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"
  ],
  "examples": [],
  "replacements": []
}
```

## Canonical imports

Import paths and symbols below are catalogue declarations. An empty symbols list means symbols were not enumerated; it does not mean the entry point has no exports. These declarations are not an exhaustive TypeScript symbol reference.

```json
[
  {
    "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": []
  }
]
```

## Declared export entry points

Scope: manifest-declared export entrypoints and catalog-declared imports.

Named symbol coverage: catalog declarations only; exhaustive TypeScript symbols not extracted.

Installation status: not verified.

- `@lssm-tech/lib.files` — subpath `.`
  - `unconditional`: `./src/index.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/index.ts); verified source file.

- `@lssm-tech/lib.files/contracts` — subpath `./contracts`
  - `unconditional`: `./src/contracts/index.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/contracts/index.ts); verified source file.

- `@lssm-tech/lib.files/docs` — subpath `./docs`
  - `unconditional`: `./src/docs/index.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/docs/index.ts); verified source file.

- `@lssm-tech/lib.files/docs/files.docblock` — subpath `./docs/files.docblock`
  - `unconditional`: `./src/docs/files.docblock.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/docs/files.docblock.ts); verified source file.

- `@lssm-tech/lib.files/entities` — subpath `./entities`
  - `unconditional`: `./src/entities/index.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/entities/index.ts); verified source file.

- `@lssm-tech/lib.files/events` — subpath `./events`
  - `unconditional`: `./src/events.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/events.ts); verified source file.

- `@lssm-tech/lib.files/files.capability` — subpath `./files.capability`
  - `unconditional`: `./src/files.capability.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/files.capability.ts); verified source file.

- `@lssm-tech/lib.files/files.feature` — subpath `./files.feature`
  - `unconditional`: `./src/files.feature.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/files.feature.ts); verified source file.

- `@lssm-tech/lib.files/storage` — subpath `./storage`
  - `unconditional`: `./src/storage/index.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/index.ts); verified source file.

- `@lssm-tech/lib.files/storage/artifact-content` — subpath `./storage/artifact-content`
  - `unconditional`: `./src/storage/artifact-content.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/artifact-content.ts); verified source file.

- `@lssm-tech/lib.files/storage/artifact-cursor` — subpath `./storage/artifact-cursor`
  - `unconditional`: `./src/storage/artifact-cursor.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/artifact-cursor.ts); verified source file.

- `@lssm-tech/lib.files/storage/artifact-record` — subpath `./storage/artifact-record`
  - `unconditional`: `./src/storage/artifact-record.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/artifact-record.ts); verified source file.

- `@lssm-tech/lib.files/storage/artifact-store` — subpath `./storage/artifact-store`
  - `unconditional`: `./src/storage/artifact-store.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/artifact-store.ts); verified source file.

- `@lssm-tech/lib.files/storage/artifact-stream` — subpath `./storage/artifact-stream`
  - `unconditional`: `./src/storage/artifact-stream.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/artifact-stream.ts); verified source file.

- `@lssm-tech/lib.files/storage/local-filesystem` — subpath `./storage/local-filesystem`
  - `unconditional`: `./src/storage/local-filesystem.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/local-filesystem.ts); verified source file.

- `@lssm-tech/lib.files/storage/path-safety` — subpath `./storage/path-safety`
  - `unconditional`: `./src/storage/path-safety.ts` — [pinned source](https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/platform/delivery/files/src/storage/path-safety.ts); verified source file.

## Package publication metadata

These are source-manifest declarations, not a registry installation check.

```json
{
  "types": "./dist/index.d.ts",
  "files": [
    "dist",
    "README.md"
  ],
  "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"
    }
  }
}
```

## Dependencies

Metadata status: complete pinned manifest.

### Runtime dependencies

- [@lssm-tech/lib.contracts-spec-core](https://lssm.co/docs/packages/lib.contracts-spec-core/): `workspace:^`
- [@lssm-tech/lib.crypto-utils](https://lssm.co/docs/packages/lib.crypto-utils/): `workspace:^`
- [@lssm-tech/lib.schema](https://lssm.co/docs/packages/lib.schema/): `workspace:^`
- [@lssm-tech/lib.surface-runtime](https://lssm.co/docs/packages/lib.surface-runtime/): `workspace:^`

### Peer dependencies

No declarations in the inspected manifest.

### Optional dependencies

No declarations in the inspected manifest.

### Development dependencies

- [@lssm-tech/tool.bun](https://lssm.co/docs/packages/tool.bun/): `workspace:*`
- [@lssm-tech/tool.typescript](https://lssm.co/docs/packages/tool.typescript/): `workspace:*`
- `typescript`: `catalog:`

### Peer dependency metadata

```json
{}
```

### Bundled dependencies

```json
null
```

## Package scripts

Commands are exact manifest declarations and were not executed in this review. Script metadata status: complete pinned manifest.

```json
{
  "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"
}
```

## Declared documentation links

- [Lib Files documentation](https://www.npmjs.com/package/%40lssm-tech%2Flib.files) — declared link; destination not verified.

```json
{
  "url": "https://www.npmjs.com/package/%40lssm-tech%2Flib.files",
  "kind": "readme"
}
```

## Existing agent-guide projection

```json
{
  "path": "packages/apps/web-landing/public/llms-packages/lib.files.txt",
  "route": "/llms/lib.files",
  "sourceUrl": "https://github.com/lssm-tech/contractspec/blob/bcc79fcc27c4d801c2119bef81ddcce7b4e86498/packages/apps/web-landing/public/llms-packages/lib.files.txt",
  "blobSha": "47e2af61f089dccab1e4b43dfbcc7daabf4e34cc",
  "sourcePin": "bcc79fcc27c4d801c2119bef81ddcce7b4e86498",
  "bodyEqualsReadme": true,
  "aggregateSourcePath": "packages/apps/web-landing/public/llms-full.txt",
  "aggregateBlobSha": "691b1d33efee24c440598b9106c81432f56aafaf"
}
```