@adobe/aio-commerce-sdk
用于Adobe App Builder应用程序的Meta-package再出Adobe Commerce SDK库.
这个软件包充当App Builder项目中访问常用的 Adobe Commercial 图书馆的方便切入点,类似于如何 @adobe/aio-sdk 用于一般 App 构建器开发的工作.
安装
npm install @adobe/aio-commerce-sdk
概览
这个 @adobe/aio-commerce-sdk 是一个元包,用于集成和再出口Adobe Commercial 库,用于App Builder应用程序。 与其安装和导入多个单个软件包,不如使用这个单个软件包来访问所有必要的商务功能.
当前图书馆
目前SDK包括:
-
@adobe/aio-commerce-lib-auth (英语): Adobe Commerce apps的认证公用事业,支持IMS和Commerce的集成认证.
-
@adobe/aio-commerce-lib-core (中文(简体) ): Adobe Commerce SDK的核心公用事业.
-
@adobe/aio-commercial-lib-api (英语):用于为I/O事件和Adobe商业建设HTTP/API客户端的一套公用事业.
-
@adobe/aio-commerce-lib-events (英语): 事件管理公用设施与Adobe I/O和商务活动API互动.
-
@adobe/aio-commerce-lib-webhooks (中文(简体) ):Webhook管理公用设施与Adobe Commerce Webhooks API互动.
使用量
直接从特定的库子路径导入 :
import {
assertImsAuthParams,
getImsAuthProvider,
assertIntegrationAuthParams,
getIntegrationAuthProvider,
} from "@adobe/aio-commerce-sdk/auth"; // <-- This is like @adobe/aio-commerce-lib-auth
import { AdobeCommerceHttpClient } from "@adobe/aio-commerce-sdk/api"; // <-- This is like @adobe/aio-commerce-lib-api
import {
createCommerceEventsApiClient,
updateEventingConfiguration,
} from "@adobe/aio-commerce-sdk/events/commerce"; // <-- This is like @adobe/aio-commerce-lib-events/commerce
import {
createCommerceWebhooksApiClient,
subscribeWebhook,
} from "@adobe/aio-commerce-sdk/webhooks/api"; // <-- This is like @adobe/aio-commerce-lib-webhooks/api
// Validate and create IMS auth provider
assertImsAuthParams(params);
const imsAuth = getImsAuthProvider(params);
const commerceHttpClientConfig = {
auth: imsAuth,
config: {
baseUrl: "https://na1-sandbox.api.commerce.adobe.com/{tenantId}/",
flavor: "saas",
},
};
const updateEventingConfigurationParams = {
enabled: true,
environmentId: "my-environment-id",
instanceId: "my-instance-id",
merchantId: "my-merchant-id",
providerId: "my-provider-id",
workspaceConfiguration: {
// ...
},
};
// Use the raw HTTP client
const commerceClient = new AdobeCommerceHttpClient(commerceHttpClientConfig);
await updateEventingConfiguration(
commerceClient,
updateEventingConfigurationParams,
);
// Or create an API client with a pre-bound HTTP client.
const commerceEventsClient = createCommerceEventsApiClient(
commerceHttpClientConfig,
);
await commerceEventsClient.updateEventingConfiguration(
updateEventingConfigurationParams,
);
// Create a webhooks API client
const commerceWebhooksClient = createCommerceWebhooksApiClient(
commerceHttpClientConfig,
);
// Subscribe to a webhook
await commerceWebhooksClient.subscribeWebhook({
webhook_method: "plugin.order.api.order_created",
webhook_type: "after",
batch_name: "default",
hook_name: "order_created",
url: "https://example.com/webhook",
method: "POST",
});
发票视图按钮帮助器来自 @adobe/aio-commerce-sdk/admin-ui/invoice-view-buttons匹配 useInvoiceViewButtonContext 钩子可用自 @adobe/aio-commerce-sdk/admin-ui/web见 管理用户界面使用指南 iframe( iframe) (view)和运行时间动作(worker) 实例.
信用备忘录视图按钮帮助器可用自 @adobe/aio-commerce-sdk/admin-ui/credit-memo-view-buttons。 。 。 .
匹配 useCreditMemoViewButtonContext 钩子可用自
@adobe/aio-commerce-sdk/admin-ui/web见
管理用户界面使用指南
iframe( iframe) (view)和运行时间动作(worker) 实例.
返回( RMA) 视图按钮帮助工具可用自 @adobe/aio-commerce-sdk/admin-ui/rma-view-buttons匹配 useRmaViewButtonContext 钩子可用自 @adobe/aio-commerce-sdk/admin-ui/web见 管理用户界面使用指南 iframe( iframe) (view)和运行时间动作(worker) 实例.
福利
- 简化扶养管理: 安装一个软件包而不是多个单个库
- 统一版本:所有包含的库一起测试兼容性
- 更好的开发者经验: 通用商务功能的单一进口来源
- 树摇动支持: 两种导入模式都支持去除已死代码
- 类型安全: 包含类型定义的完整类型脚本支持
捐款
这个包裹是Adobe Commerce SDK monorepo的一部分. 见 贡献指南 财务报告和审定财务报表 发展指南 (c) 发展结构和准则.
如果您想要将您的库添加到 SDK 中, 请参考开发指南的这一部分 : 添加到 SDK( 可选)