Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

2.9 KB
Raw Blame
// SiYuan - https://github.com/siyuan-note/siyuan
// Copyright (c) 2020-present, b3log.org
// SPDX-License-Identifier: AGPL-3.0-or-later

package apicontract

import (
	"encoding/json"
	"io"
	"mime/multipart"
)

type ImportTokenRequest struct {
	Token string `json:"token" api:"trim"`
}

type ImportDataRequest struct {
	File *multipart.FileHeader `json:"file" api:"optional"`
}

type DataImportPlan struct {
	ID        string   `json:"id"`
	Conflicts []string `json:"conflicts"`
	Encrypted []string `json:"encrypted"`
}

type DataImportRequest struct {
	ID string `json:"id" api:"trim"`
}

type DataImportMode string

const (
	DataImportSkip      DataImportMode = "skip"
	DataImportOverwrite DataImportMode = "overwrite"
)

type CommitDataImportRequest struct {
	ID       string         `json:"id" api:"trim"`
	Mode     DataImportMode `json:"mode" api:"enum=skip|overwrite"`
	Password string         `json:"password" api:"optional,trim"`
}

type DataImportResult struct {
	Skipped []string `json:"skipped"`
}

// ImportSYRequest 导入 .sy.zip,同名同内容的自定义表情复用;同名不同内容返回错误并保留已有文件。
type ImportSYRequest struct {
	File     *multipart.FileHeader `json:"file" api:"optional"`
	Notebook string                `json:"notebook" api:"optional"`
	ToPath   *string               `json:"toPath" api:"optional,nonnullable"`
}

func (request ImportSYRequest) TargetPath() string {
	if request.ToPath == nil {
		return "/"
	}
	return *request.ToPath
}

type ImportZipMarkdownRequest struct {
	File     *multipart.FileHeader `json:"file" api:"optional"`
	Notebook *string               `json:"notebook" api:"optional,nonnullable"`
	ToPath   *string               `json:"toPath" api:"optional,nonnullable"`
	SkipRoot string                `json:"skipRoot" api:"optional"`
}

type ContinueImportSYRequest struct {
	Token    string `json:"token" api:"trim"`
	Notebook string `json:"notebook" api:"trim"`
}

type ImportDocumentData struct {
	Type string `json:"type" api:"const=\"document\""`
}

type ImportMarkdownRequest struct {
	Notebook  string `json:"notebook"`
	LocalPath string `json:"localPath"`
	ToPath    string `json:"toPath"`
	SkipRoot  bool   `json:"skipRoot" api:"optional,nullable"`
}

func init() {
	ImportStdMd.decodeRequest = func(reader io.Reader) (request ImportMarkdownRequest, err error) {
		fields, err := blockRequestFields(reader, "/api/import/importStdMd")
		if err != nil {
			return request, err
		}
		if request.Notebook, err = legacyField[string](fields, "notebook", "String", true); err != nil {
			return request, err
		}
		if request.LocalPath, err = legacyField[string](fields, "localPath", "String", true); err != nil {
			return request, err
		}
		if request.ToPath, err = legacyField[string](fields, "toPath", "String", true); err != nil {
			return request, err
		}
		_ = json.Unmarshal(fields["skipRoot"], &request.SkipRoot)
		return request, nil
	}
}