@owlmeans/storage-common 0.1.18-rc.2 → 0.1.18-rc.20

package/README.md

@@ -12,7 +12,7 @@ Shared types and schemas for OwlMeans object storage — file metadata, instance
 ## Installation
 
 ```bash
-bun add @owlmeans/storage-common
+bun add @owlmeans/storage-common@^0.1.18-rc.19
 ```
 
 ## API
@@ -59,7 +59,7 @@ This package ships embedded agent skills under `agent-meta/`. After installing y
 your project's skill store (`.agents/skills/`):
 
 ```sh
-npx @owlmeans/agent-skills
+npx @owlmeans/agent-skills@^0.1.18-rc.23
 ```
 
 The embedded files are version-matched to this package release. Do not edit them

package/agent-meta/manifest.json

@@ -1,8 +1,8 @@
 {
   "schemaVersion": 2,
   "package": "@owlmeans/storage-common",
-  "version": "0.1.18-rc.0",
-  "generatedAt": "2026-08-16T22:20:50.511Z",
+  "version": "0.1.18-rc.20",
+  "generatedAt": "2026-09-15T12:50:32.620Z",
   "canonicalRepo": "https://github.com/owlmeans/common",
   "entries": [
     {

package/agent-meta/skills/storage-common/SKILL.md

@@ -8,30 +8,42 @@ user-invocable: false
 # @owlmeans/storage-common
 
 **Layer:** Infra
-**Install:** `"@owlmeans/storage-common": "^0.1.18-rc.0"` in `dependencies`
+**Install:** `"@owlmeans/storage-common": "^0.1.18-rc.20"` in `dependencies`
 
 ## Key Exports
 
 | Export | Description |
 |--------|-------------|
-| `StorageBucket` types | Bucket descriptor (URL, credentials, prefix) |
-| `StorageObject` types | Stored object metadata |
-| Errors | Typed storage errors (NotFound, Forbidden, etc.) |
-| Constants | Default content types, MIME categories |
-| Model | Path/key normalization helpers |
+| `StoredFileMeta` | What a stored file is *about*: `alias`, `mimeType`, `scopes`, `status`, plus optional `entityId`, `sourceName`, `name`, `title` |
+| `StoredFileInstance`, `StoredFilePayload` | One rendition — `{ size, alias, url }` — and the same rendition carrying its bytes (`format`, `bytes`, `base64`) |
+| `StoredFile`, `StoredFileWithData` | The metadata plus its `instances` map, which is required; the `WithData` form makes each instance a `StoredFilePayload` and adds a record-level `format` |
+| `StoredFileMetaSchema`, `StoredFileInstanceSchema`, `StoredFilePayloadSchema`, `StoredFileSchema`, `StoredFileWithDataSchema` | The matching AJV schemas |
+| `StoredFileStatus`, `StoredFileFormat` | `uploaded` / `processing-ready` / `processed` / `cached` / `unknown`; `bytes` / `base64` |
+| Errors | `StoredFileError`, `OrphanFileError`, `FilePropertyError`, `FileStreamError`, `StorageApiError`, `FileTypeError` |
 
 ## Usage
 
+The shared vocabulary, not a resource: nothing here talks to a bucket or a database. A file record
+is stored in whatever resource an app registers for it, so criteria, sorting and paging are that
+resource's ([[resource]]) — this package only says what the record *is*.
+
 ```typescript
-import type { StorageBucket } from '@owlmeans/storage-common'
+import { StoredFileStatus, StoredFileSchema } from '@owlmeans/storage-common'
+import type { StoredFile } from '@owlmeans/storage-common'
 
-const bucket: StorageBucket = {
-  url: '/etc/app-config/s3-bucket-url',
-  apiKey: '/etc/master-secret/s3-storage',
-  basePrefix: 'uploads/',
-}
+const files = ctx.resource<Resource<StoredFile>>('files')
+await files.list({ entityId, status: StoredFileStatus.Processed }, { sort: ['name'] })
 ```
 
+A record is one logical file with **several instances** keyed by alias — the original, a thumbnail,
+a converted format — each with its own url and size. A screen picks the instance it wants; nothing
+re-derives a url by string surgery.
+
+`StoredFileWithData` is the shape that carries bytes, and it is the wire shape only while a payload
+is genuinely in flight. Strip it with `stripData` from [[storage-resource]] before a file record
+goes into a response that only needs urls.
+
 ## Depends On
 
-- `@owlmeans/error`, `@owlmeans/i18n`
+- `@owlmeans/error`, `@owlmeans/auth` (the shared `entityId` / id / scope value schemas)
+- peer `ajv`

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@owlmeans/storage-common",
   "type": "module",
-  "version": "0.1.18-rc.2",
+  "version": "0.1.18-rc.20",
   "license": "MIT",
   "scripts": {
     "build": "tsc -b",
@@ -24,8 +24,8 @@
     "ajv": "*"
   },
   "dependencies": {
-    "@owlmeans/auth": "^0.1.18-rc.2",
-    "@owlmeans/error": "^0.1.18-rc.2"
+    "@owlmeans/auth": "^0.1.18-rc.20",
+    "@owlmeans/error": "^0.1.18-rc.19"
   },
   "devDependencies": {
     "@owlmeans/dep-config": "workspace:*",