@deliverart/sdk-js-integration-types

中文文档
3.0.1发布于 2026/11/11TypeScriptESM + CJS近 30 天下载 3869

交付 JavaScript SDK 共享集成类型和计划

中文使用文档
文档目录4 节
  1. Tilby 产品频道
  2. CassaInCloud合同
  3. 大象合同
  4. Tilby 修正命令远程删除

@ deliverart/ sdk- js- 整合类型

电子商务激活数据接受可选布尔 showProductImages。 。 。 . 显示它保持启用 API 默认; 明确 false 隐藏产品相片 在编辑和网格布局中。 压缩菜单只保留文本.

用于交付艺术JavaScript SDK的共享集成类型和Zod schema包.

Tilby 产品频道

integrationTilbySyncSettingsSchema 默认 respectDeliverartChannel 改为 true 财务报告和审定财务报表 removeProductsWithoutDeliverartChannel 改为 false。过滤暂停 未指定产品,除非启用局部清除;清除需要混凝土 Tilby绘制并保存了未映射的手动产品. 过滤功能已禁用, 删除旗被忽略。 销售情况仍然独立. 可编辑计划保留合并补丁中省略的频道设置 .

当另一个 SDK 软件包需要集成enum 值时使用此软件包, IRI schemas, 可操作的集成计划,或服务特定集成数据计划 取决于 @deliverart/sdk-js-integration。 。 。 .

CassaInCloud合同

软件包导出远程 ProductChannel 数值,分别输入和初始出 频道政策类型,以及运行、范围、状况、问题类型,以及 一个同步的 CassaInCloud 目录绘图进程. productChannels 仍为贬值 别名用于 inboundProductChannels 用于一个兼容性释放.

大象合同

该套件出口大象服务、生命周期、保健、目录、证书模式和 餐饮会会员席与打入的IRI一起. 还出口 integrationElephantDataSchema 铅和活化请求的有效载荷. Catalog 导入状态、步骤和资源 -- -- error enum为消费者出口 使手动导入同步,而不取决于请求包.

管理供应需要一个或多个餐馆定义和条条条客户端提供 tenantId, (中文(简体) ), appId,以及 personalAccessToken 价值,因为 交付艺术解决他们. 只要提供就要求所有三个领域。 每个餐厅 必须使用 delivery 或者说 collection 并包括 application 财务报告和审定财务报表 elephant 目录频道. 支持的平台为 migros_yemek, (中文(简体) ), trendyol_go_meal, (中文(简体) ), fuudy, (中文(简体) ), getir,以及 yemeksepeti; 当提供平台证书时, 选择 平台的完整认证对象需要.

salesModeId 财务报告和审定财务报表 categoryId 需要这样做。 大象验证两个连接 测试和生产订单交付前的标识符.

import { integrationElephantDataSchema } from '@deliverart/sdk-js-integration-types'

const payload = integrationElephantDataSchema.parse({
  credentialMode: 'managed',
  restaurants: [
    {
      name: 'Restaurant Centre',
      platform: 'migros_yemek',
      platformRestaurantId: 'restaurant-123',
      platformChainId: 'group-456',
      authentication: {
        secret_key: '12345678901234567890123456789012',
        x_api_key: 'write-only-platform-key',
        store_id: 'restaurant-123',
        store_group_id: 'group-456',
      },
      salesModeId: 'a1538842-0931-4e23-8aaf-5bda59198581',
      categoryId: '20c71a6a-c924-42e0-9078-e3f672704dbb',
      defaultTaxRate: 10,
      // Omit to enable every menu channel for items created by Elephant.
      channels: ['application', 'elephant'],
      orderType: 'delivery',
      defaultPreparationTime: 15,
      acceptanceTimeout: 5,
    },
  ],
})

Tilby 修正命令远程删除

MappingSyncFailureCode.AMENDED_ORDER_REMOTE_DELETED 序列化为 amended_order_remote_deleted在确认后,它伴随人工解析 远程删除受修正历史或邻居意图保护的命令. 克能克之令和还款史被保留. 客户必须说明 登记审查与更正完成或确认退款分开.

providerCredentialSchema(requiredMessage) 应用本地 CassaInCloud/ Tilby 软件 32,768 UTF-8 字节绑定,同时保留输入清理和需要域消息. 使用此共享的策略来激活和普通的本地证书写作 . pnpm --filter @deliverart/sdk-js-integration-types test:provider-credentials:coverage 以100%的语句、分支、功能和行检查帮助者。 工作空间 lockfile 包括可复制冷冻安装的覆盖提供者.

Tilby 绘图失败包括 conflicting_component_prices: 一克农克 共有成分对产品具有不同的原始可选价格。 消费者 必须显示菜单价格审查解释,而不是重试订单或选择 一个价格。 本地目录工作者可以在之后重新检查这个只限价格的拒绝 校正; 身份失败仍然分开 。 发行兼容的 SDK 消费者 在启用API的映射成份编目之前.

catalog_write_outcome_unknown 表示本地目录发送有未完成的 坚固的警卫 巢组/价值创造可能已经发生;消费者 必须在不提供盲目重试或清理的情况下显示核查指导 通过通用映射编辑来守护。 内部守卫元数据不是API 字段。 在启用此作者之前公布兼容的消费者 .

版本与发布记录

@deliverart/sdk-js-integration-types 共发布 88 个版本,首次发布于 2026/05/27;过去 12 个月发布了 88 个版本。

版本发布日期距今
3.0.1latest2026/11/111 天前
3.0.02026/11/092 天前
3.0.0-dev.1dev2026/11/092 天前
2.48.12026/10/2518 天前
2.48.02026/10/2319 天前
2.47.02026/10/2319 天前

关于 @deliverart/sdk-js-integration-types 的常见问题

@deliverart/sdk-js-integration-types 是什么?

交付 JavaScript SDK 共享集成类型和计划

如何安装 @deliverart/sdk-js-integration-types?

在项目目录运行 npm install @deliverart/sdk-js-integration-types,或使用 pnpm add / yarn add / bun add。

@deliverart/sdk-js-integration-types 支持 TypeScript 吗?

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

@deliverart/sdk-js-integration-types 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@deliverart/sdk-js-integration-types 可以商用吗?

@deliverart/sdk-js-integration-types 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@deliverart/sdk-js-integration-types 的下载量有多少?

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

@deliverart/sdk-js-integration-types 还在维护吗?

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