@dataggo/node-akeneo-api 1.0.0

package/dist/cjs/types.d.ts

@@ -0,0 +1,243 @@
+import { AxiosRequestConfig } from 'axios';
+export declare type AppParams = {
+    /**
+     * API host
+     */
+    url: string;
+    /**
+     * App access token
+     */
+    accessToken: string;
+    /**
+     * Optional: axiosOptions (https://github.com/axios/axios#request-config)
+     */
+    axiosOptions?: AxiosRequestConfig;
+};
+export declare type ClientParams = {
+    /**
+     * API host
+     */
+    url: string;
+    /**
+     * username
+     */
+    username: string;
+    /**
+     * password
+     */
+    password: string;
+    /**
+     * clientId of your app
+     */
+    clientId: string;
+    /**
+     * matching secret
+     */
+    secret: string;
+    /**
+     * Optional: axiosOptions (https://github.com/axios/axios#request-config)
+     */
+    axiosOptions?: AxiosRequestConfig;
+};
+export declare type PaginationType = 'page' | 'search_after';
+export declare type ProductModelQueryParameters = {
+    search?: string;
+    scope?: string;
+    locales?: string;
+    attributes?: string;
+    pagination_type?: PaginationType;
+    page?: number;
+    search_after?: string;
+    limit?: number;
+    with_count?: boolean;
+};
+export declare type ProductQueryParameters = {
+    search?: string;
+    scope?: string;
+    locales?: string;
+    attributes?: string;
+    pagination_type?: PaginationType;
+    page?: number;
+    search_after?: string;
+    limit?: number;
+    with_count?: boolean;
+    with_attribute_options?: boolean;
+    with_quality_scores?: boolean;
+};
+export declare type CategoryQueryParameters = {
+    search?: string;
+    page?: number;
+    limit?: number;
+    with_count?: boolean;
+};
+export declare type AttributeQueryParameters = {
+    search?: string;
+    page?: number;
+    limit?: number;
+    with_count?: boolean;
+};
+export declare type AttributeOptionQueryParameters = {
+    page?: number;
+    limit?: number;
+    with_count?: boolean;
+};
+export declare type ReferenceEntityQueryParameters = {
+    search?: string;
+    page?: number;
+    limit?: number;
+    with_count?: boolean;
+};
+export declare type FamilyQueryParameters = {
+    search?: string;
+    page?: number;
+    limit?: number;
+    with_count?: boolean;
+};
+export declare type FamilyVariantQueryParameters = {
+    page?: number;
+    limit?: number;
+    with_count?: boolean;
+};
+export declare type ReferenceEntityRecordQueryParameters = {
+    search_after?: string;
+};
+export declare type AssetFamilyQueryParameters = {
+    search_after?: string;
+};
+export declare type AssetQueryParameters = {
+    search?: string;
+    channel?: string;
+    locales?: string;
+    search_after?: string;
+};
+export declare type ListResponse<T> = {
+    items_count?: number;
+    current_page?: number;
+    items: T[];
+};
+declare type Association = {
+    products: string[];
+    product_models: string[];
+    groups: string[];
+};
+export declare type ProductModel = {
+    code: string;
+    family: string;
+    family_variant: string;
+    parent?: string;
+    categories: string[];
+    values: Record<string, any>;
+    created: string;
+    updated: string;
+    associations: Record<string, Association>;
+    quantified_associations: Record<string, Association>;
+    metadata: Record<string, any>;
+};
+export declare type Product = {
+    identifier: string;
+    uuid?: string;
+    enabled: boolean;
+    family: string;
+    categories: string[];
+    groups: string[];
+    parent: string;
+    values: Record<string, any>;
+    associations: Record<string, Association>;
+    created: string;
+    updated: string;
+    quantified_associations: Record<string, Association>;
+    metadata: Record<string, any>;
+};
+export declare type Family = {
+    code: string;
+    attribute_as_label: string;
+    attribute_as_image: string;
+    attributes: string[];
+    attribute_requirements: Record<string, any>;
+    labels: Record<string, any>;
+};
+declare type VariantAttributeSet = {
+    level: number;
+    attributes: string[];
+    axes: string[];
+};
+export declare type Variant = {
+    code: string;
+    variant_attribute_sets: VariantAttributeSet[];
+    labels: Record<string, any>;
+};
+export declare type Attribute = {
+    code: string;
+    type: string;
+    labels: Record<string, string>;
+    group: string;
+    group_labels: Record<string, string>;
+    sort_order: number;
+    localizable: boolean;
+    scopable: boolean;
+    available_locales: string[];
+    unique: boolean;
+    useable_as_grid_filter: boolean;
+    max_characters: number;
+    validation_rule: string;
+    validation_regexp: string;
+    wysiwyg_enabled: boolean;
+    number_min: string;
+    number_max: string;
+    decimals_allowed: boolean;
+    negative_allowed: boolean;
+    metric_family: string;
+    default_metric_unit: string;
+    date_min: string;
+    date_max: string;
+    allowed_extensions: string[];
+    max_file_size: string;
+    reference_data_name: string;
+    default_value: boolean;
+};
+export declare type AttributeOption = {
+    code: string;
+    attribute: string;
+    sort_order: number;
+    labels: Record<string, string>;
+};
+declare type ValuesRecord = {
+    locale: string;
+    channel: string;
+    data: string | string[];
+};
+export declare type KeyValueMap = Record<string, any>;
+export declare type Entity = {
+    code: string;
+    labels: KeyValueMap;
+};
+export declare type EntityRecord = {
+    code: string;
+    values: Record<string, ValuesRecord[]>;
+};
+export declare type Category<T = KeyValueMap> = {
+    code: string;
+    parent?: string;
+    labels: T;
+};
+export declare type AssetFamily = {
+    code: string;
+    labels: Record<string, string>;
+    attribute_as_main_media: string;
+    product_link_rules: Record<string, Record<string, string>>[];
+    transformations: any[];
+    naming_convention: {
+        source: {
+            property: string;
+            channel: any;
+            locale: any;
+        };
+        pattern: string;
+        abort_asset_creation_on_error: boolean;
+    };
+};
+export declare type Asset = {
+    code: string;
+    values: Record<string, ValuesRecord[]>;
+};
+export {};

package/dist/cjs/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/mjs/endpoints/asset-family.d.ts

@@ -0,0 +1,39 @@
+import { AxiosInstance } from 'axios';
+import { Asset, AssetFamily, AssetFamilyQueryParameters, AssetQueryParameters, ListResponse } from '../types';
+/**
+ * @see https://api.akeneo.com/api-reference.html#Assetfamily
+ */
+export declare const get: (http: AxiosInstance, params: {
+    query?: AssetFamilyQueryParameters;
+}) => Promise<ListResponse<AssetFamily>>;
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_asset_family__code_
+ */
+export declare const getOne: (http: AxiosInstance, { code, query, }: {
+    code: string;
+    query?: {
+        with_attribute_options?: boolean | undefined;
+        with_quality_scores?: boolean | undefined;
+    } | undefined;
+}) => Promise<AssetFamily>;
+export declare const getAll: (http: AxiosInstance, { query }: {
+    query?: AssetFamilyQueryParameters | undefined;
+}) => Promise<ListResponse<AssetFamily>>;
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_assets
+ */
+export declare const getAssets: (http: AxiosInstance, { assetFamilyCode, query, }: {
+    assetFamilyCode: string;
+    query?: AssetQueryParameters | undefined;
+}) => Promise<ListResponse<Asset>>;
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_assets__code_
+ */
+export declare const getAsset: (http: AxiosInstance, { assetFamilyCode, code, }: {
+    assetFamilyCode: string;
+    code: string;
+}) => Promise<Asset>;
+export declare const getAssetsAll: (http: AxiosInstance, { assetFamilyCode, query, }: {
+    assetFamilyCode: string;
+    query?: AssetQueryParameters | undefined;
+}) => Promise<ListResponse<Asset>>;

package/dist/mjs/endpoints/asset-family.js

@@ -0,0 +1,31 @@
+import raw from './raw';
+/**
+ * @see https://api.akeneo.com/api-reference.html#Assetfamily
+ */
+export const get = (http, params) => raw.get(http, `/api/rest/v1/asset-families`, {
+    params: {
+        ...params.query,
+    },
+});
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_asset_family__code_
+ */
+export const getOne = (http, { code, query, }) => raw.getOne(http, `/api/rest/v1/asset-families/${code}`, {
+    params: query,
+});
+export const getAll = (http, { query }) => raw.getAllBySearchAfter(http, `/api/rest/v1/asset-families`, {
+    params: query,
+});
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_assets
+ */
+export const getAssets = (http, { assetFamilyCode, query, }) => raw.get(http, `/api/rest/v1/asset-families/${assetFamilyCode}/assets`, {
+    params: query,
+});
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_assets__code_
+ */
+export const getAsset = (http, { assetFamilyCode, code, }) => raw.getOne(http, `/api/rest/v1/asset-families/${assetFamilyCode}/assets/${code}`, {});
+export const getAssetsAll = (http, { assetFamilyCode, query, }) => raw.getAllBySearchAfter(http, `/api/rest/v1/asset-families/${assetFamilyCode}/assets`, {
+    params: query,
+});

package/dist/mjs/endpoints/attribute.d.ts

@@ -0,0 +1,24 @@
+import { AxiosInstance } from 'axios';
+import { ListResponse, Attribute, AttributeOption, AttributeQueryParameters, AttributeOptionQueryParameters } from '../types';
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_attributes
+ */
+export declare const get: (http: AxiosInstance, params: {
+    query?: AttributeQueryParameters;
+}) => Promise<ListResponse<Attribute>>;
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_attributes__code_
+ */
+export declare const getOne: (http: AxiosInstance, { code, }: {
+    code: string;
+}) => Promise<Attribute>;
+export declare const getAll: (http: AxiosInstance, { query }: {
+    query?: AttributeQueryParameters | undefined;
+}) => Promise<ListResponse<Attribute>>;
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_attributes__attribute_code__options
+ */
+export declare const getOptions: (http: AxiosInstance, { attributeCode, query, }: {
+    attributeCode: string;
+    query?: AttributeOptionQueryParameters | undefined;
+}) => Promise<ListResponse<AttributeOption>>;

package/dist/mjs/endpoints/attribute.js

@@ -0,0 +1,22 @@
+import raw from './raw';
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_attributes
+ */
+export const get = (http, params) => raw.get(http, `/api/rest/v1/attributes`, {
+    params: {
+        ...params.query,
+    },
+});
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_attributes__code_
+ */
+export const getOne = (http, { code, }) => raw.getOne(http, `/api/rest/v1/attributes/${code}`);
+export const getAll = (http, { query = {} }) => raw.getAllByPage(http, `/api/rest/v1/attributes`, {
+    params: query,
+});
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_attributes__attribute_code__options
+ */
+export const getOptions = (http, { attributeCode, query, }) => raw.getAllByPage(http, `/api/rest/v1/attributes/${attributeCode}/options`, {
+    params: query,
+});

package/dist/mjs/endpoints/category.d.ts

@@ -0,0 +1,21 @@
+import { AxiosInstance } from 'axios';
+import { ListResponse, Category, CategoryQueryParameters } from '../types';
+/**
+ * @see https://api.akeneo.com/api-reference.html#Category
+ */
+export declare const get: (http: AxiosInstance, params: {
+    query?: CategoryQueryParameters;
+}) => Promise<ListResponse<Category>>;
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_categories__code_
+ */
+export declare const getOne: (http: AxiosInstance, { code, ...params }: {
+    code: string;
+    query?: {
+        with_attribute_options?: boolean | undefined;
+        with_quality_scores?: boolean | undefined;
+    } | undefined;
+}) => Promise<Category>;
+export declare const getAll: (http: AxiosInstance, params: {
+    query?: CategoryQueryParameters;
+}) => Promise<ListResponse<Category>>;

package/dist/mjs/endpoints/category.js

@@ -0,0 +1,18 @@
+import raw from './raw';
+/**
+ * @see https://api.akeneo.com/api-reference.html#Category
+ */
+export const get = (http, params) => raw.get(http, `/api/rest/v1/categories`, {
+    params: {
+        ...params.query,
+    },
+});
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_categories__code_
+ */
+export const getOne = (http, { code, ...params }) => raw.getOne(http, `/api/rest/v1/categories/${code}`, {
+    params,
+});
+export const getAll = (http, params) => raw.getAllByPage(http, `/api/rest/v1/categories`, {
+    params,
+});

package/dist/mjs/endpoints/family.d.ts

@@ -0,0 +1,15 @@
+import { AxiosInstance } from 'axios';
+import { ListResponse, Family, Variant, FamilyQueryParameters, FamilyVariantQueryParameters } from '../types';
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_families
+ */
+export declare const get: (http: AxiosInstance, params: {
+    query?: FamilyQueryParameters;
+}) => Promise<ListResponse<Family>>;
+/**
+ * @see https://api.akeneo.com/api-reference.html#Familyvariant
+ */
+export declare const getVariants: (http: AxiosInstance, params: {
+    familyCode: string;
+    query?: FamilyVariantQueryParameters;
+}) => Promise<ListResponse<Variant>>;

package/dist/mjs/endpoints/family.js

@@ -0,0 +1,17 @@
+import raw from './raw';
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_families
+ */
+export const get = (http, params) => raw.get(http, `/api/rest/v1/families`, {
+    params: {
+        ...params.query,
+    },
+});
+/**
+ * @see https://api.akeneo.com/api-reference.html#Familyvariant
+ */
+export const getVariants = (http, params) => raw.get(http, `/api/rest/v1/families/${params.familyCode}/variants`, {
+    params: {
+        ...params.query,
+    },
+});

package/dist/mjs/endpoints/index.d.ts

@@ -0,0 +1,7 @@
+export * as assetFamily from './asset-family';
+export * as attribute from './attribute';
+export * as category from './category';
+export * as family from './family';
+export * as productModel from './product-model';
+export * as product from './product';
+export * as referenceEntity from './reference-entity';

package/dist/mjs/endpoints/index.js

@@ -0,0 +1,7 @@
+export * as assetFamily from './asset-family';
+export * as attribute from './attribute';
+export * as category from './category';
+export * as family from './family';
+export * as productModel from './product-model';
+export * as product from './product';
+export * as referenceEntity from './reference-entity';

package/dist/mjs/endpoints/product-model.d.ts

@@ -0,0 +1,17 @@
+import { AxiosInstance } from 'axios';
+import { ListResponse, ProductModel, ProductModelQueryParameters } from '../types';
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_product_models
+ */
+export declare const get: (http: AxiosInstance, { query }: {
+    query?: ProductModelQueryParameters | undefined;
+}) => Promise<ListResponse<ProductModel>>;
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_product_models__code_
+ */
+export declare const getOne: (http: AxiosInstance, params: {
+    code: string;
+}) => Promise<ProductModel>;
+export declare const getAll: (http: AxiosInstance, { query }: {
+    query?: ProductModelQueryParameters | undefined;
+}) => Promise<ListResponse<ProductModel>>;

package/dist/mjs/endpoints/product-model.js

@@ -0,0 +1,22 @@
+import raw from './raw';
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_product_models
+ */
+export const get = (http, { query }) => raw.get(http, `/api/rest/v1/product-models`, {
+    params: query,
+});
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_product_models__code_
+ */
+export const getOne = (http, params) => raw.getOne(http, `/api/rest/v1/product-models/${params.code}`, {});
+export const getAll = (http, { query }) => {
+    // support legacy pagination_type "page"
+    if (query?.pagination_type === 'page') {
+        return raw.getAllByPage(http, `/api/rest/v1/product-models`, {
+            params: query,
+        });
+    }
+    return raw.getAllBySearchAfter(http, `/api/rest/v1/product-models`, {
+        params: query,
+    });
+};

package/dist/mjs/endpoints/product.d.ts

@@ -0,0 +1,21 @@
+import { AxiosInstance } from 'axios';
+import { ListResponse, Product, ProductQueryParameters } from '../types';
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_products
+ */
+export declare const get: (http: AxiosInstance, { query }: {
+    query?: ProductQueryParameters | undefined;
+}) => Promise<ListResponse<Product>>;
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_products__code_
+ */
+export declare const getOne: (http: AxiosInstance, { code, query, }: {
+    code: string;
+    query?: {
+        with_attribute_options?: boolean | undefined;
+        with_quality_scores?: boolean | undefined;
+    } | undefined;
+}) => Promise<Product>;
+export declare const getAll: (http: AxiosInstance, { query }: {
+    query?: ProductQueryParameters | undefined;
+}) => Promise<ListResponse<Product>>;

package/dist/mjs/endpoints/product.js

@@ -0,0 +1,24 @@
+import raw from './raw';
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_products
+ */
+export const get = (http, { query }) => raw.get(http, `/api/rest/v1/products`, {
+    params: query,
+});
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_products__code_
+ */
+export const getOne = (http, { code, query, }) => raw.getOne(http, `/api/rest/v1/products/${code}`, {
+    params: query,
+});
+export const getAll = (http, { query = {} }) => {
+    // support legacy pagination_type "page"
+    if (query?.pagination_type === 'page') {
+        return raw.getAllByPage(http, `/api/rest/v1/products`, {
+            params: query,
+        });
+    }
+    return raw.getAllBySearchAfter(http, `/api/rest/v1/products`, {
+        params: query,
+    });
+};

package/dist/mjs/endpoints/raw.d.ts

@@ -0,0 +1,11 @@
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
+import { ListResponse } from '../types';
+declare const _default: {
+    get: (http: AxiosInstance, url: string, config: AxiosRequestConfig) => Promise<ListResponse<any> & {
+        _links: any;
+    }>;
+    getOne: (http: AxiosInstance, url: string, config?: AxiosRequestConfig | undefined) => Promise<any>;
+    getAllByPage: (http: AxiosInstance, url: string, { params }: AxiosRequestConfig) => Promise<ListResponse<any>>;
+    getAllBySearchAfter: (http: AxiosInstance, url: string, config?: AxiosRequestConfig | undefined) => Promise<ListResponse<any>>;
+};
+export default _default;

package/dist/mjs/endpoints/raw.js

@@ -0,0 +1,81 @@
+import * as querystring from 'querystring';
+import errorHandler from '../error-handler';
+export default {
+    get: function get(http, url, config) {
+        return http
+            .get(url, {
+            ...config,
+        })
+            .then((response) => {
+            const { data } = response;
+            return {
+                ...(data.current_page ? { current_page: data.current_page } : {}),
+                ...(data.items_count ? { items_count: data.items_count } : {}),
+                items: data._embedded.items,
+                _links: data._links,
+            };
+        }, errorHandler);
+    },
+    getOne: function getOne(http, url, config) {
+        return http
+            .get(url, {
+            ...config,
+        })
+            .then((response) => {
+            const { data } = response;
+            return data;
+        }, errorHandler);
+    },
+    getAllByPage: async function getAllByPage(http, url, { params = {} }) {
+        const page = params?.page || 1;
+        const { items_count = 0, items } = await this.get(http, url, {
+            params: {
+                ...params,
+                with_count: true,
+                limit: 100,
+                page,
+            },
+        });
+        return items_count / 100 > page
+            ? {
+                items: [
+                    ...items,
+                    ...(await this.getAllByPage(http, url, {
+                        params: {
+                            ...params,
+                            limit: 100,
+                            page: page + 1,
+                        },
+                    })).items,
+                ],
+            }
+            : { items };
+    },
+    getAllBySearchAfter: async function getAllBySearchAfter(http, url, config) {
+        const params = config?.params;
+        const { items, _links } = await this.get(http, url, {
+            params: {
+                ...(params?.search_after ? { search_after: params.search_after } : {}),
+                pagination_type: 'search_after',
+                limit: 100,
+            },
+        });
+        const nextUrl = _links?.next?.href;
+        if (!nextUrl)
+            return { items };
+        const search_after = querystring.parse(nextUrl.split('?').at(1))?.search_after || '';
+        return {
+            items: [
+                ...items,
+                ...(await this.getAllBySearchAfter(http, url, {
+                    params: {
+                        ...params,
+                        limit: params?.limit || 100,
+                        pagination_type: 'search_after',
+                        search_after,
+                    },
+                })).items,
+            ],
+        };
+    },
+};

package/dist/mjs/endpoints/reference-entity.d.ts

@@ -0,0 +1,15 @@
+import { AxiosInstance } from 'axios';
+import { ListResponse, Entity, EntityRecord, ReferenceEntityQueryParameters, ReferenceEntityRecordQueryParameters } from '../types';
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_reference_entities
+ */
+export declare const get: (http: AxiosInstance, { query }: {
+    query?: ReferenceEntityQueryParameters | undefined;
+}) => Promise<ListResponse<Entity>>;
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_reference_entity_records
+ */
+export declare const getRecords: (http: AxiosInstance, { referenceEntityCode, query, }: {
+    referenceEntityCode: string;
+    query?: ReferenceEntityRecordQueryParameters | undefined;
+}) => Promise<ListResponse<EntityRecord>>;

package/dist/mjs/endpoints/reference-entity.js

@@ -0,0 +1,13 @@
+import raw from './raw';
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_reference_entities
+ */
+export const get = (http, { query }) => raw.get(http, `/api/rest/v1/reference-entities`, {
+    params: query,
+});
+/**
+ * @see https://api.akeneo.com/api-reference.html#get_reference_entity_records
+ */
+export const getRecords = (http, { referenceEntityCode, query, }) => raw.get(http, `/api/rest/v1/reference-entities/${referenceEntityCode}/records`, {
+    params: query,
+});

package/dist/mjs/error-handler.d.ts

@@ -0,0 +1,2 @@
+import { AxiosError } from 'axios';
+export default function errorHandler({ config, response }: AxiosError): never;