@axenda/zatca

中文文档
1.0.4发布于 2021/11/20MITTypeScriptCommonJS近 30 天下载 1.5万

NPM

中文使用文档
文档目录13 节
  1. 安装
  2. 使用量
  3. 内容提要
  4. 导入
  5. 代表发票QR代码
  6. 生成 TLV
  7. 生成 Base64
  8. 渲染QR 代码
  9. 使用 QR 代码图像数据
  10. 测试
  11. 一揽子路线图
  12. 捐款
  13. 许可证

ZATCA (法图拉) QR- Code 执行

NPM

GitHub Workflow Status (branch) codecov GitHub License

一个非官方的软件包,帮助开发人员执行方便的ZATCA(Fatoora)QR代码,电子发票在其中需要该代码 沙特阿拉伯.

在前端和后端的节点项目中都可以使用.

✅已验证为自2021年11月18日起与ZATCA的SDK相同出品.

安装

要启动, 请安装软件包 :

npm i --save @axenda/zatca

使用量

内容提要

简单,你只需要生成一个QR代码就是:

import { Invoice } from '@axenda/zatca';

const invoice = new Invoice({
    sellerName: 'Axenda',
    vatRegistrationNumber: '1234567891',
    invoiceTimestamp: '2021-12-04T00:00:00Z',
    invoiceTotal: '100.00',
    invoiceVatTotal: '15.00',
});

const imageData = await invoice.render();

// Read the following sections for more details.

导入

首先,进口发票类或Tag类,代表发票QR代码:

import { Invoice } from '@axenda/zatca';
// or
import { Tag } from '@axenda/zatca';

代表发票QR代码

第二,创建发票实例或一系列 Tag 类:

const invoice = new Invoice({
    sellerName: 'Axenda',
    vatRegistrationNumber: '1234567891',
    invoiceTimestamp: '2021-12-04T00:00:00Z',
    invoiceTotal: '100.00',
    invoiceVatTotal: '15.00',
});
// or
const tags: Tag[] = [
    new Tag(1, 'Axenda'),
    new Tag(2, '1234567891'),
    new Tag(3, '2021-12-04T00:00:00Z'),
    new Tag(4, '100.00'),
    new Tag(5, '15.00'),
];

生成 TLV

现在可以从发票或标签阵列中生成 TLV 字符串 :

invoice.toTlv();

// or using tags array

import { toTlv } from '@axenda/zatca';

toTlv(tags)

生成 Base64

您从发票或标签阵列生成 Base64 字符串 :

invoice.toBase64();

// or using tags array

import { tagsToBase64 } from '@axenda/zatca';

tagsToBase64(tags);

渲染QR 代码

您可以从 Base64 字符串中生成图像数据( png)并在浏览器中渲染:

await invoice.render();

// or using tags array

import { renderTags } from '@axenda/zatca';

await renderTags(tags);

使用 QR 代码图像数据

使用图像数据在浏览器中显示 QR 代码 :

<!-- For React -->
<img src={imageData} alt="Invoice QR Code">
<!-- For Angular -->
<img [src]="imageData"/>
<!-- Just use the imageData variable no matter what framework you use  -->

测试

要运行测试套件,首先安装依赖关系,然后运行 npm test数字 :

npm install
npm test

一揽子路线图

  • 支持 ZATCA 发票 QR 编码阶段 1
  • 审查软件包 API 一致性
  • 支持 ZATCA 发票 QR 编码阶段 2

捐款

欢迎 捐款 任何种类的人。 请拿一个 时间来回顾 提交文件的准则。 。 。 .

许可证

麻省理工学院许可证(MIT). 请看 许可证文件 更多信息.

版本与发布记录

@axenda/zatca 共发布 5 个版本,首次发布于 2021/11/19;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.0.4latest2021/11/204 年前
1.0.32021/11/204 年前
1.0.22021/11/204 年前
1.0.12021/11/194 年前
1.0.02021/11/194 年前

关于 @axenda/zatca 的常见问题

如何安装 @axenda/zatca?

在项目目录运行 npm install @axenda/zatca,或使用 pnpm add / yarn add / bun add。

@axenda/zatca 支持 TypeScript 吗?

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

@axenda/zatca 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@axenda/zatca 可以商用吗?

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

@axenda/zatca 的下载量有多少?

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

@axenda/zatca 还在维护吗?

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