@happyvertical/smrt-assets-local

中文文档
0.62.1发布于 2026/11/17MITTypeScriptES Module近 30 天下载 1.4万

Local image metadata and variant processor for SMRT assets

原始使用文档
文档目录6 节
  1. Installation
  2. Quick start
  3. Standard variants
  4. Metadata
  5. Public API
  6. Development

@happyvertical/smrt-assets-local

Local image processing for the s-m-r-t asset runtime. It extracts normalized image metadata and generates deterministic WebP variants with Sharp, while asset identity, storage, tenancy, and publishing policy remain owned by @happyvertical/smrt-assets.

Choose this adapter for local development, single-node deployments, and apps that need practical image handling without a media-asset-management service.

Installation

pnpm add @happyvertical/smrt-assets @happyvertical/smrt-assets-local

sharp is installed by this adapter and is not pulled into core s-m-r-t asset consumers.

Quick start

import { createAssetRuntime } from '@happyvertical/smrt-assets';
import { createLocalAssetProcessor } from '@happyvertical/smrt-assets-local';

const runtime = await createAssetRuntime({
  db: 'assets.db',
  storage: './data/assets',
  capabilityProviders: [createLocalAssetProcessor()],
});

const source = await runtime.storeSourceAsset(
  'photo.png',
  imageBytes,
  { mimeType: 'image/png', typeSlug: 'image' },
);

const processed = await runtime.processAsset(source, {
  variants: [{ variant: 'thumb' }, { variant: 'card' }],
});

console.log(processed.metadata, processed.variants);

The processor saves normalized metadata onto the source asset and creates derived assets linked back to that source.

Standard variants

NameSizeFit
thumb160×160cover
card480×270cover
preview960×960inside
publish1200×630cover

Override presets or output quality when creating the processor:

const processor = createLocalAssetProcessor({
  quality: 85,
  variants: {
    card: { width: 640, height: 360, fit: 'cover' },
  },
});

Unknown variant names must provide explicit width and height. Repeated requests reuse a matching derived asset when the source version and parameters have not changed.

Metadata

extractAssetImageMetadataFromBuffer() normalizes orientation before reporting dimensions and returns stable metadata for MIME type, dimensions, captured time, and GPS coordinates when available. GPS values retain enough precision for nearby-photo search.

Non-image assets are explicitly skipped so a later registered provider can handle them.

Public API

ExportPurpose
createLocalAssetProcessor()Create an asset capability provider
extractAssetImageMetadataFromBuffer()Extract normalized image metadata
normalizeAssetImageMetadata()Normalize raw Sharp/EXIF metadata
LocalAssetProcessorOptionsConfigure variant presets and quality

Development

pnpm --filter @happyvertical/smrt-assets-local test
pnpm --filter @happyvertical/smrt-assets-local typecheck
pnpm --filter @happyvertical/smrt-assets-local build

See AGENTS.md for determinism, metadata, and provider-boundary requirements.

版本与发布记录

@happyvertical/smrt-assets-local 共发布 366 个版本,首次发布于 2026/06/23;过去 12 个月发布了 366 个版本。

版本发布日期距今
0.62.1latest2026/11/17今天
0.62.02026/11/17今天
0.61.62026/11/161 天前
0.61.52026/11/161 天前
0.61.42026/11/161 天前
0.61.32026/11/152 天前

关于 @happyvertical/smrt-assets-local 的常见问题

@happyvertical/smrt-assets-local 是什么?

Local image metadata and variant processor for SMRT assets

如何安装 @happyvertical/smrt-assets-local?

在项目目录运行 npm install @happyvertical/smrt-assets-local,或使用 pnpm add / yarn add / bun add。

@happyvertical/smrt-assets-local 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@happyvertical/smrt-assets-local 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@happyvertical/smrt-assets-local 可以商用吗?

@happyvertical/smrt-assets-local 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@happyvertical/smrt-assets-local 的下载量有多少?

根据 npm 官方下载统计,@happyvertical/smrt-assets-local 在 2026/10/17 – 2026/11/15 这 30 天内被下载 14,093 次,日均约 470 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@happyvertical/smrt-assets-local 还在维护吗?

最新版本 0.62.1 发布于 2026/11/17(今天);至今共发布 366 个版本,其中过去 12 个月发布了 366 个;首次发布于 2026/06/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。