@agnocon/piece-bigcommerce 0.1.11

package/dist/lib/triggers/shipment-created.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shipmentCreated = void 0;
+const tslib_1 = require("tslib");
+// Vendored from Activepieces packages/pieces/community/bigcommerce/src/lib/triggers/shipment-created.ts (MIT).
+// Generated by packages/scripts/vendor-ap.mjs - do not edit by hand.
+const pieces_framework_1 = require("@agnocon/pieces-framework");
+const auth_1 = require("../common/auth");
+const requests_1 = require("../common/requests");
+const TRIGGER_NAME = 'shipment created';
+const CACHE_KEY = `${TRIGGER_NAME}-trigger-store-key`;
+const TRIGGER_SCOPE = 'store/shipment/created';
+exports.shipmentCreated = (0, pieces_framework_1.createTrigger)({
+    auth: auth_1.bigcommerceAuth,
+    name: 'shipmentCreated',
+    displayName: 'Shipment Created',
+    description: 'Triggers when a new shipment is created',
+    aiMetadata: {
+        description: 'Fires when a new shipment is created for an order in the BigCommerce store (items are shipped/fulfilled). The event identifies the new shipment.',
+    },
+    props: {},
+    sampleData: {
+        producer: 'stores/xqcaklwsso',
+        hash: 'd7b899890f5e0e98a3e074f018b14b07d5d89360',
+        created_at: 1761808595,
+        store_id: '1003425529',
+        scope: 'store/shipment/created',
+        data: {
+            type: 'shipment',
+            id: 2,
+        },
+    },
+    type: pieces_framework_1.TriggerStrategy.WEBHOOK,
+    onEnable(context) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const webhook = yield requests_1.bigCommerceApiService.createWebhook({
+                auth: context.auth.props,
+                payload: {
+                    scope: TRIGGER_SCOPE,
+                    destination: context.webhookUrl,
+                    is_active: true,
+                },
+            });
+            yield context.store.put(CACHE_KEY, webhook.data.id);
+        });
+    },
+    onDisable(context) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const webhookId = (yield context.store.get(CACHE_KEY));
+            if (webhookId) {
+                yield requests_1.bigCommerceApiService
+                    .deleteWebhook({
+                    auth: context.auth.props,
+                    webhookId,
+                })
+                    .then(() => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                    yield context.store.delete(CACHE_KEY);
+                }));
+            }
+        });
+    },
+    run(context) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return [context.payload.body];
+        });
+    },
+});
+//# sourceMappingURL=shipment-created.js.map

package/dist/lib/triggers/shipment-created.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipment-created.js","sourceRoot":"","sources":["../../../src/lib/triggers/shipment-created.ts"],"names":[],"mappings":";;;;AAAA,+GAA+G;AAC/G,qEAAqE;AACrE,gEAA2E;AAC3E,yCAAiD;AACjD,iDAA2D;AAE3D,MAAM,YAAY,GAAG,kBAAkB,CAAC;AACxC,MAAM,SAAS,GAAG,GAAG,YAAY,oBAAoB,CAAC;AACtD,MAAM,aAAa,GAAG,wBAAwB,CAAC;AAElC,QAAA,eAAe,GAAG,IAAA,gCAAa,EAAC;IAC3C,IAAI,EAAE,sBAAe;IACrB,IAAI,EAAE,iBAAiB;IACvB,WAAW,EAAE,kBAAkB;IAC/B,WAAW,EAAE,yCAAyC;IACtD,UAAU,EAAE;QACV,WAAW,EACT,kJAAkJ;KACrJ;IACD,KAAK,EAAE,EAAE;IACT,UAAU,EAAC;QACT,QAAQ,EAAE,mBAAmB;QAC7B,IAAI,EAAE,0CAA0C;QAChD,UAAU,EAAE,UAAU;QACtB,QAAQ,EAAE,YAAY;QACtB,KAAK,EAAE,wBAAwB;QAC/B,IAAI,EAAE;YACJ,IAAI,EAAE,UAAU;YAChB,EAAE,EAAE,CAAC;SAEN;KACF;IACD,IAAI,EAAE,kCAAe,CAAC,OAAO;IACvB,QAAQ,CAAC,OAAO;;YACpB,MAAM,OAAO,GAAG,MAAM,gCAAqB,CAAC,aAAa,CAAC;gBACxD,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK;gBACxB,OAAO,EAAE;oBACP,KAAK,EAAE,aAAa;oBACpB,WAAW,EAAE,OAAO,CAAC,UAAU;oBAC/B,SAAS,EAAE,IAAI;iBAChB;aACF,CAAC,CAAC;YAEH,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACtD,CAAC;KAAA;IACK,SAAS,CAAC,OAAO;;YACrB,MAAM,SAAS,GAAG,CAAC,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAW,CAAC;YAEjE,IAAI,SAAS,EAAE,CAAC;gBACd,MAAM,gCAAqB;qBACxB,aAAa,CAAC;oBACb,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK;oBACxB,SAAS;iBACV,CAAC;qBACD,IAAI,CAAC,GAAS,EAAE;oBACf,MAAM,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBACxC,CAAC,CAAA,CAAC,CAAC;YACP,CAAC;QACH,CAAC;KAAA;IACK,GAAG,CAAC,OAAO;;YACf,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC;KAAA;CACF,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@agnocon/piece-bigcommerce",
+  "version": "0.1.11",
+  "description": "AgnoCon bigcommerce connector",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "LICENSE.MIT-AP"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "vendor": "node ../scripts/vendor-ap.mjs piece-bigcommerce"
+  },
+  "dependencies": {
+    "@agnocon/core-utils": "0.2.0",
+    "@agnocon/piece-types": "0.3.1",
+    "@agnocon/pieces-common": "0.12.8",
+    "@agnocon/pieces-framework": "0.36.0",
+    "tslib": "2.6.2"
+  },
+  "devDependencies": {
+    "@types/node": "20.17.6",
+    "typescript": "5.5.4"
+  },
+  "license": "MIT",
+  "agnocon": {
+    "originVersion": "0.1.11"
+  },
+  "publishConfig": {
+    "access": "restricted",
+    "tag": "latest"
+  },
+  "keywords": [
+    "agnocon",
+    "connector"
+  ]
+}

package/src/index.ts

@@ -0,0 +1,81 @@
+import { createPiece, PieceAuth } from '@agnocon/pieces-framework';
+import { abandonedCart } from './lib/triggers/abandoned-cart';
+import { cartCreated } from './lib/triggers/cart-created';
+import { customerAddressCreated } from './lib/triggers/customer-address-created';
+import { customerAddressUpdated } from './lib/triggers/customer-address-updated';
+import { customerCreated } from './lib/triggers/customer-created';
+import { customerUpdated } from './lib/triggers/customer-updated';
+import { orderCreated } from './lib/triggers/order-created';
+import { orderUpdated } from './lib/triggers/order-updated';
+import { orderStatusUpdated } from './lib/triggers/order-status-updated';
+import { productCreated } from './lib/triggers/product-created';
+import { shipmentCreated } from './lib/triggers/shipment-created';
+import { createCustomer } from './lib/actions/create-customer';
+import { bigcommerceAuth } from './lib/common/auth';
+import { createAProduct } from './lib/actions/create-a-product';
+import { updateAProduct } from './lib/actions/update-a-product';
+import { deleteAProduct } from './lib/actions/delete-a-product';
+import { getOrder } from './lib/actions/get-order';
+import { listOrders } from './lib/actions/list-orders';
+import { listCategories } from './lib/actions/list-categories';
+import { createBlogPost } from './lib/actions/create-blog-post';
+import { createCustomerAddress } from './lib/actions/create-customer-address';
+import { createCustomApiCallAction } from '@agnocon/pieces-common';
+import { bigCommerceAuth, GET_BASE_URL } from './lib/common/constants';
+import { searchCustomer } from './lib/actions/search-customer';
+import { searchProduct } from './lib/actions/search-product';
+import { searchCustomerAddress } from './lib/actions/search-customer-address';
+import { findOrCreateCustomer } from './lib/actions/find-or-create-customer';
+import { findOrCreateProduct } from './lib/actions/find-or-create-product';
+import { findOrCreateCustomersAddress } from './lib/actions/find-or-create-customers-address';
+
+export const bigcommerce = createPiece({
+  displayName: 'BigCommerce',
+  description:
+    'BigCommerce is a leading e-commerce platform that enables businesses to create and manage online stores.',
+  auth: bigcommerceAuth,
+  minimumSupportedRelease: '0.36.1',
+  logoUrl: 'https://cdn.activepieces.com/pieces/bigcommerce.png',
+  authors: ['gs03-dev', 'sanket-a11y', 'Angelebeats'],
+  actions: [
+    createCustomer,
+    createAProduct,
+    updateAProduct,
+    deleteAProduct,
+    getOrder,
+    listOrders,
+    listCategories,
+    createBlogPost,
+    createCustomerAddress,
+    searchCustomer,
+    searchProduct,
+    searchCustomerAddress,
+    findOrCreateCustomer,
+    findOrCreateProduct,
+    findOrCreateCustomersAddress,
+    createCustomApiCallAction({
+      auth: bigcommerceAuth,
+      baseUrl: (auth) => auth ? GET_BASE_URL(auth.props.storeHash) : '',
+      authMapping: async (auth: any) => {
+        return {
+          'X-Auth-Token': auth.props.accessToken,
+          'Content-Type': 'application/json',
+          Accept: 'application/json',
+        };
+      },
+    }),
+  ],
+  triggers: [
+    abandonedCart,
+    cartCreated,
+    customerAddressCreated,
+    customerAddressUpdated,
+    customerCreated,
+    customerUpdated,
+    orderCreated,
+    orderUpdated,
+    orderStatusUpdated,
+    productCreated,
+    shipmentCreated,
+  ],
+});

package/src/lib/actions/create-a-product.ts

@@ -0,0 +1,73 @@
+import { createAction, Property } from '@agnocon/pieces-framework';
+import { bigcommerceAuth } from '../common/auth';
+import { bigCommerceApiService } from '../common/requests';
+
+export const createAProduct = createAction({
+  auth: bigcommerceAuth,
+  name: 'createAProduct',
+  displayName: 'Create a Product',
+  description: 'Creates a Product',
+  audience: 'both',
+  aiMetadata: {
+    description:
+      'Creates a new catalog product in a BigCommerce store. Use to add an item to the store. Requires name, type (physical or digital), weight, and price; SKU, description, and brand_id are optional. Not idempotent: each call adds a new product, so search the catalog first if it may already exist.',
+    idempotent: false,
+  },
+  props: {
+    name: Property.ShortText({
+      displayName: 'Product Name',
+      description: 'Name of the product',
+      required: true,
+    }),
+    type: Property.StaticDropdown({
+      displayName: 'Product Type',
+      description: 'Type of product',
+      required: true,
+      options: {
+        options: [
+          { label: 'Physical', value: 'physical' },
+          { label: 'Digital', value: 'digital' },
+        ],
+      },
+    }),
+    sku: Property.ShortText({
+      displayName: 'SKU',
+      description: 'Product SKU',
+      required: false,
+    }),
+    description: Property.LongText({
+      displayName: 'Description',
+      description: 'Product description',
+      required: false,
+    }),
+    weight: Property.Number({
+      displayName: 'Weight',
+      description: 'Product weight',
+      required: true,
+    }),
+    price: Property.Number({
+      displayName: 'Price',
+      description: 'Product price',
+      required: true,
+    }),
+    brand_id: Property.Number({
+      displayName: 'Brand ID',
+      description: 'Brand ID',
+      required: false,
+    }),
+  },
+  async run(context) {
+    return await bigCommerceApiService.createProduct({
+      auth: context.auth.props,
+      payload: {
+        name: context.propsValue.name,
+        type: context.propsValue.type,
+        sku: context.propsValue.sku,
+        description: context.propsValue.description,
+        weight: context.propsValue.weight,
+        price: context.propsValue.price,
+        brand_id: context.propsValue.brand_id,
+      },
+    });
+  },
+});

package/src/lib/actions/create-blog-post.ts

@@ -0,0 +1,82 @@
+import { createAction, Property } from '@agnocon/pieces-framework';
+import { bigcommerceAuth } from '../common/auth';
+import { bigCommerceApiService } from '../common/requests';
+
+export const createBlogPost = createAction({
+  auth: bigcommerceAuth,
+  name: 'createBlogPost',
+  displayName: 'Create Blog Post',
+  description: 'Creates a blog post',
+  audience: 'both',
+  aiMetadata: {
+    description:
+      "Creates a blog post in a BigCommerce store's blog. Requires a title and body (HTML supported); author, URL, published date, meta description/keywords, tags, and a published flag are optional. Use to publish store blog content. Not idempotent: each call creates a new post.",
+    idempotent: false,
+  },
+  props: {
+    title: Property.ShortText({
+      displayName: 'Title',
+      description: 'Blog post title',
+      required: true,
+    }),
+    body: Property.LongText({
+      displayName: 'Body',
+      description: 'Blog post content (HTML supported)',
+      required: true,
+    }),
+    author: Property.ShortText({
+      displayName: 'Author',
+      description: 'Author name',
+      required: false,
+    }),
+    url: Property.ShortText({
+      displayName: 'URL',
+      description:
+        'URL for the public blog post. Example - /blog/welcome-bigcommerce/',
+      required: false,
+    }),
+    published_date: Property.DateTime({
+      displayName: 'Published Date',
+      description:
+        'Published Date for the blog post. Example - Wed, 10 Aug 2022 15:39:15 -0500',
+      required: false,
+    }),
+    meta_description: Property.LongText({
+      displayName: 'Meta Description',
+      description: 'Description text for this blog post’s <meta/> element.',
+      required: false,
+    }),
+    meta_keywords: Property.LongText({
+      displayName: 'Meta Keywords',
+      description: 'Comma seperated (,) Keywords for this blog post’s <meta/> element. Eg welcome, bigcommerce',
+      required: false,
+    }),
+    tags: Property.Array({
+      displayName: 'Tags',
+      description: 'Array of tags',
+      required: false,
+    }),
+    is_published: Property.Checkbox({
+      displayName: 'Is Published',
+      description: 'Whether the post is published',
+      required: false,
+      defaultValue: true,
+    }),
+  },
+  async run(context) {
+    return await bigCommerceApiService.createBlogPost({
+      auth: context.auth.props,
+      payload: {
+        title: context.propsValue.title,
+        body: context.propsValue.body,
+        author: context.propsValue.author,
+        tags: context.propsValue.tags,
+        is_published: context.propsValue.is_published,
+        meta_description: context.propsValue.meta_description,
+        meta_keywords: context.propsValue.meta_keywords,
+        published_date: context.propsValue.published_date,
+        url: context.propsValue.url,
+      },
+    });
+  },
+});

package/src/lib/actions/create-customer-address.ts

@@ -0,0 +1,78 @@
+import { createAction, Property } from '@agnocon/pieces-framework';
+import { bigcommerceAuth } from '../common/auth';
+import { customerDropdown } from '../common/props';
+import { bigCommerceApiService } from '../common/requests';
+
+export const createCustomerAddress = createAction({
+  auth: bigcommerceAuth,
+  name: 'createCustomerAddress',
+  displayName: 'Create Customer Address',
+  description: "Creates a customer's address",
+  audience: 'both',
+  aiMetadata: {
+    description:
+      'Adds a new address to an existing BigCommerce customer, identified by customer_id (selected from a dropdown of store customers). Requires name, address line 1, city, state/province, postal code, and an ISO 3166-1 alpha-2 country code. Use to attach a shipping or billing address to a customer. Not idempotent: each call appends a new address even if an identical one exists, so use Find or Create Customer’s Address to avoid duplicates.',
+    idempotent: false,
+  },
+  props: {
+    customer_id: customerDropdown({
+      required: true
+    }),
+    first_name: Property.ShortText({
+      displayName: 'First Name',
+      required: true,
+    }),
+    last_name: Property.ShortText({
+      displayName: 'Last Name',
+      required: true,
+    }),
+    address1: Property.ShortText({
+      displayName: 'Address Line 1',
+      required: true,
+    }),
+    address2: Property.ShortText({
+      displayName: 'Address Line 2',
+      required: false,
+    }),
+    city: Property.ShortText({
+      displayName: 'City',
+      required: true,
+    }),
+    state_or_province: Property.ShortText({
+      displayName: 'State/Province',
+      required: true,
+    }),
+    postal_code: Property.ShortText({
+      displayName: 'Postal Code',
+      required: true,
+    }),
+    country_code: Property.ShortText({
+      displayName: 'Country Code',
+      description: 'ISO 3166-1 alpha-2 country code',
+      required: true,
+    }),
+    phone: Property.ShortText({
+      displayName: 'Phone',
+      required: false,
+    }),
+  },
+  async run(context) {
+    return await bigCommerceApiService.createCustomerAddress({
+      auth: context.auth.props,
+      payload: [
+        {
+          customer_id: context.propsValue.customer_id,
+          first_name: context.propsValue.first_name,
+          last_name: context.propsValue.last_name,
+          address1: context.propsValue.address1,
+          address2: context.propsValue.address2,
+          city: context.propsValue.city,
+          state_or_province: context.propsValue.state_or_province,
+          postal_code: context.propsValue.postal_code,
+          country_code: context.propsValue.country_code,
+          phone: context.propsValue.phone,
+        },
+      ],
+    });
+  },
+});

package/src/lib/actions/create-customer.ts

@@ -0,0 +1,63 @@
+import { createAction, Property } from '@agnocon/pieces-framework';
+import { bigcommerceAuth } from '../common/auth';
+import { bigCommerceApiService } from '../common/requests';
+
+export const createCustomer = createAction({
+  auth: bigcommerceAuth,
+  name: 'createCustomer',
+  displayName: 'Create Customer',
+  description: 'Creates a customer',
+  audience: 'both',
+  aiMetadata: {
+    description:
+      'Creates a new customer record in a BigCommerce store from an email plus first/last name (company, phone, and notes optional). Use to register a shopper or contact. Not idempotent: each call adds a new customer, and BigCommerce rejects a duplicate email rather than returning the existing one, so call Search Customer or Find or Create Customer first if the customer may already exist.',
+    idempotent: false,
+  },
+  props: {
+    email: Property.ShortText({
+      displayName: 'Email',
+      description: 'Customer email address',
+      required: true,
+    }),
+    first_name: Property.ShortText({
+      displayName: 'First Name',
+      description: 'Customer first name',
+      required: true,
+    }),
+    last_name: Property.ShortText({
+      displayName: 'Last Name',
+      description: 'Customer last name',
+      required: true,
+    }),
+    company: Property.ShortText({
+      displayName: 'Company',
+      description: 'Customer company name',
+      required: false,
+    }),
+    phone: Property.ShortText({
+      displayName: 'Phone',
+      description: 'Customer phone number',
+      required: false,
+    }),
+    notes: Property.LongText({
+      displayName: 'Notes',
+      description: 'Customer notes',
+      required: false,
+    }),
+  },
+  async run(context) {
+    return await bigCommerceApiService.createCustomer({
+      auth: context.auth.props,
+      payload: [
+        {
+          email: context.propsValue.email,
+          first_name: context.propsValue.first_name,
+          last_name: context.propsValue.last_name,
+          company: context.propsValue.company,
+          phone: context.propsValue.phone,
+          notes: context.propsValue.notes,
+        },
+      ],
+    });
+  },
+});

package/src/lib/actions/delete-a-product.ts

@@ -0,0 +1,29 @@
+import { createAction, Property } from '@agnocon/pieces-framework';
+import { bigcommerceAuth } from '../common/auth';
+import { bigCommerceApiService } from '../common/requests';
+
+export const deleteAProduct = createAction({
+  auth: bigcommerceAuth,
+  name: 'deleteAProduct',
+  displayName: 'Delete a Product',
+  description: 'Deletes an existing Product',
+  audience: 'both',
+  aiMetadata: {
+    description:
+      'Permanently deletes a catalog product from a BigCommerce store by its productId. Use to remove an item from the store. This is destructive and cannot be undone. Effectively idempotent: deleting an already-removed product has no further effect, though the call may error if the id no longer exists.',
+    idempotent: true,
+  },
+  props: {
+    productId: Property.ShortText({
+      displayName: 'Product ID',
+      description: 'The ID of the product to delete',
+      required: true,
+    }),
+  },
+  async run(context) {
+    return await bigCommerceApiService.deleteProduct({
+      auth: context.auth.props,
+      productId: context.propsValue.productId,
+    });
+  },
+});

package/src/lib/actions/find-or-create-customer.ts

@@ -0,0 +1,81 @@
+import { createAction, Property } from '@agnocon/pieces-framework';
+import { bigcommerceAuth } from '../common/auth';
+import { bigCommerceApiService } from '../common/requests';
+
+export const findOrCreateCustomer = createAction({
+  auth: bigcommerceAuth,
+  name: 'findOrCreateCustomer',
+  displayName: 'Find or Create Customer',
+  description: 'Finds or creates a customer',
+  audience: 'both',
+  aiMetadata: {
+    description:
+      'Looks up a BigCommerce customer by email (and phone if given) and returns the match if found, otherwise creates a new customer from the supplied details. Use this instead of Create Customer when the customer may already exist, to avoid duplicate-email errors. Idempotent: repeated calls match the same existing record rather than creating duplicates.',
+    idempotent: true,
+  },
+  props: {
+    email: Property.ShortText({
+      displayName: 'Email',
+      description: 'Customer email address',
+      required: true,
+    }),
+    first_name: Property.ShortText({
+      displayName: 'First Name',
+      description: 'Customer first name',
+      required: true,
+    }),
+    last_name: Property.ShortText({
+      displayName: 'Last Name',
+      description: 'Customer last name',
+      required: true,
+    }),
+    company: Property.ShortText({
+      displayName: 'Company',
+      description: 'Customer company name',
+      required: false,
+    }),
+    phone: Property.ShortText({
+      displayName: 'Phone',
+      description: 'Customer phone number',
+      required: false,
+    }),
+    notes: Property.LongText({
+      displayName: 'Notes',
+      description: 'Customer notes',
+      required: false,
+    }),
+  },
+  async run(context) {
+    const params = new URLSearchParams();
+
+    params.append('email:in', context.propsValue.email);
+    
+    if (context.propsValue.phone)
+      params.append('phone:in', context.propsValue.phone);
+
+    const response = await bigCommerceApiService.fetchCustomers({
+      auth: context.auth.props,
+      queryString: params.toString(),
+    });
+
+    if (response.data && response.data.length > 0) {
+      return { found: true, data: response.data };
+    }
+
+    const newCustomer = await bigCommerceApiService.createCustomer({
+      auth: context.auth.props,
+      payload: [  
+        {
+          email: context.propsValue.email,
+          first_name: context.propsValue.first_name,
+          last_name: context.propsValue.last_name,
+          company: context.propsValue.company,
+          phone: context.propsValue.phone,
+          notes: context.propsValue.notes,
+        },
+      ],
+    });
+
+    return { found: false, data: newCustomer.data };
+  },
+});