@ atcute/ lexicon- doc

解析和作者 atproto lexicon 文档.

npm install @atcute/lexicon-doc

使用量

解析词典文档

import { findExternalReferences, lexiconDoc } from '@atcute/lexicon-doc';
import * as v from 'valibot';

const rawDoc = {
    lexicon: 1,
    id: 'com.example.post',
    defs: {
        main: {
            type: 'record',
            key: 'tid',
            record: {
                type: 'object',
                required: ['text', 'createdAt', 'author'],
                properties: {
                    text: { type: 'string', maxLength: 300 },
                    createdAt: { type: 'string', format: 'datetime' },
                    replyTo: { type: 'ref', ref: 'com.atproto.repo.strongRef' },
                },
            },
        },
    },
};

const doc = v.parse(lexiconDoc, rawDoc);
//    ^? LexiconDoc

const refs = findExternalReferences(doc);
//    ^? Set<string> { 'com.atproto.repo.strongRef' }

构建器 API

此软件包提供构建器功能, 便于编写词汇文档

import { document, record, object, string, required, build } from '@atcute/lexicon-doc/builder';

const post = document({
    id: 'com.example.post',
    defs: {
        main: record({
            key: 'tid',
            record: object({
                properties: {
                    text: required(string({ maxLength: 300 })),
                    createdAt: required(string({ format: 'datetime' })),
                },
            }),
        }),
    },
});

const lexicons = build({ documents: [post] });
//    ^? { 'com.example.post': { lexicon: 1, ... } }

aPI 验证

此软件包提供了远程计划验证功能

import { RecordValidator } from '@atcute/lexicon-doc/validations';

// lexicon documents retrieved from the network or loaded from disk
const docs = {
    'app.bsky.feed.post': {
        lexicon: 1,
        id: 'app.bsky.feed.post',
        defs: {
            main: {
                type: 'record',
                record: {
                    type: 'object',
                    required: ['text', 'createdAt'],
                    properties: {
                        text: { type: 'string', maxLength: 300 },
                        createdAt: { type: 'string', format: 'datetime' },
                    },
                },
            },
        },
    },
};

const validator = new RecordValidator(docs, 'app.bsky.feed.post');

validator.parse({
    key: '3m6bkzurm4c7w',
    object: {
        $type: 'app.bsky.feed.post',
        text: 'hello world',
        createdAt: '2024-01-01T00:00:00.000Z',
    },
});

JSON 计划

此软件包还提供了用于编写词典文档的JSON schemas, 添加一个 $schema 属性改为 您的文档 :

{
    "$schema": "https://unpkg.com/@atcute/lexicon-doc/schema/lexicon-doc.schema.json",
    "lexicon": 1,
    "id": "com.example.link",
    "defs": {
        "main": {
            "type": "record",
            "description": "a link submission",
            "key": "tid",
            "record": {
                "type": "object",
                "required": ["url", "createdAt"],
                "properties": {
                    "title": { "type": "string", "maxLength": 300 },
                    "url": { "type": "string", "format": "uri" },
                    "createdAt": { "type": "string", "format": "datetime" }
                }
            }
        }
    }
}