西塞罗核心

核心课管理协议项目法律模板的语法,模式和逻辑.

文档

http://docs.accordproject.org 互联网档案馆的存檔,存档日期2013-12-21

安装

npm install @accordproject/cicero-core --save

使用量

cicero-core 是一个本地类型Script包,通过 lib/index.d.ts。 。 exports 地图 选择三块建筑中的一个 :

• require() 装入普通JS构建于 lib/· ;
• 节点的 import 装入 ES 模块 lib/esm/· ;
• 一个针对网页的捆绑器(webpack 5, Vite, Rollup, esbuilt) 加载浏览器 ES 模块 内建 lib/esm-browser/。 。 。 .

import { Template, Clause, TemplateLoader, TemplateLibrary } from '@accordproject/cicero-core';

没有预建的浏览器捆绑; 从捆绑的应用程序导入包 。 见 移民.md 如果你使用了早期版本的UMD捆.

浏览器支持

浏览器构建取代已建的节点( N)fs, (中文(简体) ), path, (中文(简体) ), util)带有空模块。 因此从文件系统或网络读取的API 浏览器中不可用 如果有人叫,他们就会扔下去。 浏览器的使用意在 内存档案(例如,作为 ArrayBuffer) (中文(简体) ).

在浏览器中不可用( 只有节点) :

• Template.fromDirectory() ——从磁盘读取模板目录.
• Template.fromUrl() 和装填者-- DefaultArchiveLoader, (中文(简体) ), HTTPArchiveLoader, (中文(简体) ), GitHubArchiveLoader, (中文(简体) ), CompositeArchiveLoader, (中文(简体) ), APArchiveLoader (文件系统/ URL 支持加载).
• TemplateLibrary 操作可以读取远程索引或使用上盘缓存.
• 模板保存器中的任何磁盘写入帮助器(例如提取归档到目录).

在浏览器中可用 :

• Template.fromArchive(buffer) 装入a(.cta(a) 存档 ArrayBuffer编号 :Uint8Array。 。 。 .
• template.toArchive(language, options) - 包括PKCS#12签名/核查 (密码学使用纯JS) node-forge 并在浏览器中运行).
• getMetadata(), (中文(简体) ), getModelManager(), (中文(简体) ), getTemplate(), (中文(简体) ), getLogicManager() 编辑 草稿/触发逻辑.

这些由Playwright端到端的测试在寄存器中进行 e2e/ 工作空间, 哪个捆绑 lib/esm-browser 在无头的铬中运行.

发展

cicero-core 以 TypeScript 书写(src/)并编为 lib/ 与 tsc。要求 节点.js 22.

npm run build         # tsc: src -> lib (+ .d.ts), then esbuild: lib/esm and lib/esm-browser
npm run test:esm      # smoke test of the ES module builds (after build)
npm run lint          # eslint + license header check
npm test              # lint + build + jest unit tests
npm run test:cov      # the above, with coverage

浏览器端到端( Playwright) 测试在 repo 中进行 e2e/ 工作空间; 从 寄存器根为 npm run test:e2e。 。 。 .

许可证

Accord Project源代码文件在位于LICENSE文件的Apache许可证2.0版本(Apache-2.0)下提供. 项目文件文件根据创用CC-BY-4.0国际许可证提供 http://creativecommons.org/licenses/by/ 4.0/ 页面存档备份,存于互联网档案馆。 。 。 .

(原始内容存档于2017-2019 Contact, Inc.