❤
npm
Sign UpSign In

@contentful/ecommerce-app-base
TypeScript icon, indicating that this package has built-in type declarations

4.0.37 • Public • Published

CircleCI

ecommerce-app-base

@contentful/ecommerce-app-base is a library that helps you to quickly build an app to integrate your e-commerce system of choice with Contentful. Many e-commerce integrations are very similar, therefore this library provides the boilerplate for your app and you only need to add the code for your specific service.

This library creates an app which can be used in the entry field location to select stock keeping units (sku) from your e-commerce service. The library also provides a configuration screen for an easy customization.

Usage

import { setup } from '@contentful/ecommerce-app-base';

setup({
  makeCTA: () => 'Select products',
  name: 'My SKU App',
  logo: 'https://example.com/logo.svg',
  color: '#d7f0fa',
  description: 'My example SKU App',
  parameterDefinitions: [
    {
      "id": "category",
      "type": "Symbol",
      "name": "Catehory",
      "description": "Product category of our shop",
      "required": true
    }
  ],
  validateParameters: () => null,
  fetchProductPreviews: async (skus) => {
      const responess = await Promise.all(
          skus.map(sku => fetch(`https://example.com/products/${sku}`))
      );
      return responses.map(response => response.json());
  },
  renderDialog: (sdk) => {
    const config = sdk.parameters.invocation;

    const container = document.createElement('div');
    container.innerHTML = `<iframe src="https://example.com/products-search?category=${config.category}" />`;
    document.body.appendChild(container);
  },
  openDialog: async (sdk, currentValue, config) => {
    return await sdk.dialogs.openCurrentApp({
      parameters: { config, currentValue },
    });
  },
  isDisabled: () => false,
  productCardVersion: 'v2'  
});

Type Documentation

Components

Apps

These Contentful apps use @contentful/ecommerce-app-base. Look at their source code to learn how they utilize this library:

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
4.0.3722latest
2.0.0-canary1canary

Version History

VersionDownloads (Last 7 Days)Published
4.0.3722
4.0.361
4.0.3327
4.0.321
4.0.94
4.0.72
4.0.61
4.0.51
4.0.31
4.0.22
4.0.01
3.6.112
3.6.101
3.6.91
3.6.11
3.6.01
3.5.441
3.5.431
3.5.421
3.5.411
3.5.401
3.5.392
3.5.381
3.5.371
3.5.361
3.5.351
3.5.341
3.5.321
3.5.311
3.5.301
3.5.291
3.5.281
3.5.271
3.5.261
3.5.251
3.5.241
3.5.231
3.5.221
3.5.211
3.5.201
3.5.191
3.5.182
3.5.171
3.5.162
3.5.151
3.5.142
3.5.132
3.5.121
3.5.111
3.5.101
3.5.91
3.5.81
3.5.71
3.5.61
3.5.51
3.5.41
3.5.31
3.5.22
3.5.11
3.5.01
3.4.221
3.4.211
3.4.201
3.4.191
3.4.181
3.4.171
3.4.161
3.4.151
3.4.141
3.4.131
3.4.121
3.4.112
3.4.101
3.4.91
3.4.81
3.4.72
3.4.61
3.4.51
3.4.41
3.4.31
3.4.21
3.4.11
3.4.02
3.3.351
3.3.341
3.3.331
3.3.321
3.3.312
3.3.303
3.3.291
3.3.281
3.3.271
3.3.262
3.3.252
3.3.241
3.3.231
3.3.221
3.3.211
3.3.202
3.3.192
3.3.181
3.3.171
3.3.161
3.3.152
3.3.141
3.3.131
3.3.121
3.3.112
3.3.101
3.3.91
3.3.81
3.3.71
3.3.61
3.3.52
3.3.41
3.3.31
3.3.21
3.3.111
3.3.01
3.2.62
3.2.51
3.2.42
3.2.31
3.2.21
3.2.11
3.2.01
3.1.751
3.1.741
3.1.732
3.1.721
3.1.711
3.1.701
3.1.691
3.1.681
3.1.678
3.1.661
3.1.651
3.1.641
3.1.631
3.1.621
3.1.612
3.1.601
3.1.591
3.1.582
3.1.571
3.1.562
3.1.552
3.1.541
3.1.531
3.1.521
3.1.511
3.1.501
3.1.481
3.1.471
3.1.461
3.1.452
3.1.442
3.1.431
3.1.422
3.1.381
3.1.371
3.1.361
3.1.351
3.1.341
3.1.332
3.1.321
3.1.311
3.1.301
3.1.291
3.1.281
3.1.271
3.1.261
3.1.251
3.1.241
3.1.231
3.1.221
3.1.201
3.1.191
3.1.181
3.1.171
3.1.161
3.1.151
3.1.141
3.1.131
3.1.121
3.1.111
3.1.101
3.1.92
3.1.81
3.1.71
3.1.62
3.1.51
3.1.42
3.1.31
3.1.21
3.1.11
3.1.01
3.0.201
3.0.191
3.0.182
3.0.171
3.0.162
3.0.151
3.0.141
3.0.132
3.0.121
3.0.112
3.0.101
3.0.91
3.0.81
3.0.71
3.0.61
3.0.52
3.0.41
3.0.32
3.0.22
3.0.11
3.0.02
2.6.941
2.6.932
2.6.921
2.6.911
2.6.901
2.6.892
2.6.881
2.6.871
2.6.862
2.6.851
2.6.841
2.6.831
2.6.821
2.6.811
2.6.801
2.6.791
2.6.781
2.6.771
2.6.761
2.6.751
2.6.741
2.6.731
2.6.721
2.6.711
2.6.701
2.6.691
2.6.681
2.6.671
2.6.661
2.6.651
2.6.641
2.6.631
2.6.621
2.6.611
2.6.601
2.6.571
2.6.561
2.6.551
2.6.541
2.6.531
2.6.522
2.6.511
2.6.501
2.6.491
2.6.481
2.6.471
2.6.461
2.6.452
2.6.441
2.6.431
2.6.421
2.6.411
2.6.401
2.6.391
2.6.381
2.6.371
2.6.361
2.6.351
2.6.341
2.6.331
2.6.321
2.6.311
2.6.303
2.6.291
2.6.281
2.6.272
2.6.261
2.6.251
2.6.241
2.6.231
2.6.221
2.6.212
2.6.201
2.6.191
2.6.182
2.6.172
2.6.161
2.6.151
2.6.141
2.6.131
2.6.122
2.6.111
2.6.102
2.6.91
2.6.81
2.6.71
2.6.61
2.6.51
2.6.42
2.6.31
2.6.21
2.6.11
2.6.02
2.5.322
2.5.311
2.5.301
2.3.01
2.1.01
2.0.02
2.0.0-canary1
1.0.71
1.0.61
1.0.52
1.0.41
1.0.31
1.0.21
1.0.11

Package Sidebar

Install

npm i @contentful/ecommerce-app-base

Repository

github.com/contentful/apps

Homepage

github.com/contentful/apps#readme

Weekly Downloads

454

Version

4.0.37

License

MIT

Unpacked Size

167 kB

Total Files

105

Last publish

Collaborators

  • contentful-ecosystem
Try on RunKit
Report malware