Storage

@microsoft/rayfin-storage is Rayfin's type-safe blob storage client. This page covers only what's currently verifiable from the Rayfin decorator reference and the permissions guide — it does not attempt to document the storage client's full API surface.

Enable storage

services:
  storage:
    enabled: true

Marking a class as blob storage: @blob()

@blob() is a class-level decorator that marks a class as a storage folder configuration — the storage equivalent of @entity() for data models. It's structurally different from a data entity, though: it takes an optional folder-name string instead of field options, and the properties inside the class are plain TypeScript fields rather than @text() / @uuid() decorated columns.

import { blob } from '@microsoft/rayfin-core';

@blob('uploads')
export class ProfileImage {
  owner_id!: string;
}

The string argument ('uploads' above) is the storage folder name; it defaults to the kebab-case class name if omitted. @blob() is exported from @microsoft/rayfin-core, alongside the data-model decorators — it isn't part of @microsoft/rayfin-storage itself. See Field types for the full decorator reference.

Storage permissions

The same @role() / @anonymous() / @authenticated() decorators used for data permissions work on @blob() classes. Applied to a blob entity, Rayfin generates a storage policy instead of a database policy, using the same policy / include / exclude options:

import { blob, authenticated } from '@microsoft/rayfin-core';

@blob('uploads')
@authenticated('*', {
  policy: (claims, item) => claims.sub.eq(item.owner_id),
})
export class ProfileImage {
  owner_id!: string;
}

This restricts every action ('*') on ProfileImage blobs to the authenticated user whose sub claim matches the blob's owner_id. See Permissions for the full reference — the decorator, its policy / include / exclude options, and how policies compile down — all of which applies the same way to storage entities as it does to data entities.

What isn't covered here

File upload, download, and listing operations are part of the @microsoft/rayfin-storage client, not the decorators above. That client's method signatures aren't verifiable from the sources this site is built from — see the note at the top of this page for how to look them up against the version actually installed in your project.