@ tcute/ 叶片

传单 (pub.leaflet.*) 计划定义

npm install @atcute/leaflet

使用量

import { PubLeafletDocument } from '@atcute/leaflet';
import { is } from '@atcute/lexicons';

const document: PubLeafletDocument.Main = {
    $type: 'pub.leaflet.document',
    title: 'Article title',
    author: 'did:plc:ia76kvnndjutgedggx2ibrem',
    description: 'Article description',
    publication: 'at://did:plc:ia76kvnndjutgedggx2ibrem/pub.leaflet.publication/3lpyvgcwc722m',
    publishedAt: '2025-05-25T14:44:37.870Z',
    pages: [
        {
            $type: 'pub.leaflet.pages.linearDocument',
            blocks: [
                {
                    $type: 'pub.leaflet.pages.linearDocument#block',
                    block: {
                        $type: 'pub.leaflet.blocks.text',
                        facets: [{ index: { byteEnd: 12, byteStart: 0 }, features: [] }],
                        plaintext: 'Hello world!',
                    },
                },
                {
                    $type: 'pub.leaflet.pages.linearDocument#block',
                    block: {
                        $type: 'pub.leaflet.blocks.text',
                        facets: [
                            {
                                index: { byteEnd: 9, byteStart: 0 },
                                features: [{ $type: 'pub.leaflet.richtext.facet#bold' }],
                            },
                        ],
                        plaintext: 'Bold text',
                    },
                },
                {
                    $type: 'pub.leaflet.pages.linearDocument#block',
                    block: {
                        $type: 'pub.leaflet.blocks.text',
                        facets: [
                            {
                                index: { byteEnd: 11, byteStart: 0 },
                                features: [{ $type: 'pub.leaflet.richtext.facet#italic' }],
                            },
                        ],
                        plaintext: 'Italic text',
                    },
                },
                {
                    $type: 'pub.leaflet.pages.linearDocument#block',
                    block: {
                        $type: 'pub.leaflet.blocks.text',
                        facets: [
                            {
                                index: { byteEnd: 16, byteStart: 0 },
                                features: [
                                    { $type: 'pub.leaflet.richtext.facet#bold' },
                                    { $type: 'pub.leaflet.richtext.facet#italic' },
                                ],
                            },
                        ],
                        plaintext: 'Bold italic text',
                    },
                },
                {
                    $type: 'pub.leaflet.pages.linearDocument#block',
                    block: { $type: 'pub.leaflet.blocks.text', facets: [], plaintext: '' },
                },
            ],
        },
    ],
};

is(PubLeafletDocument.mainSchema, document);
// -> true

与 @atcute/client

选择这3个选项之一来登记环境声明

// tsconfig.json
{
    "compilerOptions": {
        "types": ["@atcute/leaflet"],
    },
}

// env.d.ts
/// <reference types="@atcute/leaflet" />

// index.ts
import type {} from '@atcute/leaflet';

现在所有 XRPC 操作都应该在客户端可见

与 @atcute/lex-cli

创建您自己引用 Leaflet 类型的词典时, 请配置 lex- cli 从此导入 软件包 :

// file: lex.config.js
import { defineLexiconConfig } from '@atcute/lex-cli';

export default defineLexiconConfig({
    files: ['lexicons/**/*.json'],
    outdir: 'src/lexicons/',
    imports: ['@atcute/leaflet'],
});