@dataggo/node-akeneo-api 1.0.0

package/dist/mjs/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/mjs/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@dataggo/node-akeneo-api",
+  "version": "1.0.0",
+  "description": "A Node Rest Client for the Akeneo PIM",
+  "author": "Constant B <contact@dataggo>",
+  "license": "MIT",
+  "types": "dist/cjs/index.d.ts",
+  "exports": {
+    "import": "./dist/mjs/index.js",
+    "require": "./dist/cjs/index.js"
+  },
+  "main": "./dist/cjs/index.js",
+  "files": [
+    "dist/**/*"
+  ],
+  "scripts": {
+    "build": "rm -fr dist/* && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json && ./fixup",
+    "build:docs": "typedoc --tsconfig tsconfig-base.json",
+    "build:types": "rimraf dist/typings && tsc -p tsconfig-cjs.json --declaration --noEmit false --emitDeclarationOnly true --allowJs false",
+    "watch": "tsc  -w -p tsconfig.json && tsc -w -p tsconfig-cjs.json",
+    "prepare": "husky install",
+    "lint": "eslint src --max-warnings 0",
+    "test": "jest",
+    "prepublishOnly": "npm run build",
+    "publish": "npm publish --access public"
+  },
+  "dependencies": {
+    "axios": "^0.21.1",
+    "qs": "^6.9.6",
+    "ramda": "^0.27.1"
+  },
+  "devDependencies": {
+    "@types/axios": "^0.14.0",
+    "@types/jest": "^26.0.20",
+    "@types/node": "^14.14.22",
+    "@types/qs": "^6.9.5",
+    "@types/ramda": "^0.27.36",
+    "@typescript-eslint/eslint-plugin": "^4.15.2",
+    "@typescript-eslint/parser": "^4.15.2",
+    "eslint": "^7.21.0",
+    "eslint-config-airbnb-base": "14.2.1",
+    "eslint-config-prettier": "^8.1.0",
+    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-jest": "^24.1.5",
+    "eslint-plugin-prettier": "^3.3.1",
+    "husky": "^5.1.3",
+    "jest": "^26.6.3",
+    "jest-html-reporters": "^2.1.2",
+    "prettier": "^2.2.1",
+    "ts-jest": "^26.5.2",
+    "typedoc": "^0.20.19",
+    "typescript": "^4.1.3"
+  },
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "reporters": [
+      "default",
+      "jest-html-reporters"
+    ],
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverage": true,
+    "collectCoverageFrom": [
+      "src/**/*.(t|j)s"
+    ],
+    "coverageDirectory": "coverage",
+    "testEnvironment": "node"
+  }
+}