akeneo-custom-component

Akeneo PIM JavaScript SDK

Overview

The Akeneo PIM JavaScript SDK is designed to help you build applications that are compatible with the UI extension Custom Component feature.

How the UI extension Custom Component feature works?

The Custom Component feature is a type of UI Extension allowing PIM users to upload JavaScript applications directly into the PIM. With its intuitive methods, it simplifies interactions with the Akeneo PIM API by abstracting the complexities of API calls, authentication, and data transformation. It is designed to provide a uniform experience for developers, featuring robust typing support through TypeScript declarations. This enables you to focus on developing your integration without being hindered by API intricacies.

If you're unfamiliar with the UI Extension feature, you can find more information in the Akeneo documentation.

For more information about the available features, integration architecture, constraints, permissions and access control or development workflow you can look at the Advanced Extension in depth documentation.

For more information about the SDK deployment you can look at the Advanced Extensions API deployment or UI deployment.

Quick Start Example

Here's a simple example showing how to use the SDK to list assets from a specific family:

// Access the Asset API
const assetApi = PIM.api.asset_v1;

// List assets with filters
const listParams = {
  assetFamilyCode: 'packshots',
};

// Call the API and handle the response
try {
  const assetList = await assetApi.list(listParams);
  console.log('Assets found:', assetList);
} catch (error) {
  console.error('Error fetching assets:', error);
}

Claude Code Plugin

This repository includes a Claude Code plugin (akeneo-custom-component) that helps you build and deploy Akeneo Custom Components directly from your Claude Code session. It provides an awareness skill that triggers automatically when Custom Components are mentioned, and a guided setup skill (/akeneo-cc-setup) that scaffolds, builds, and deploys a component step by step.

Installation

/plugin marketplace add akeneo/extension-sdk
/plugin install akeneo-custom-component@akeneo-custom-component

⚠️ Warning: Before installing the plugin, make sure you have a GitHub SSH key configured on your machine. Without it, the plugin installation may fail. You can follow the GitHub documentation on generating and adding an SSH key if you haven't done so already.

Further Documentation

For more detailed information about the Akeneo PIM API, please refer to the official Akeneo API documentation.