feed-common 1.0.0 → 1.0.1

package/src/constants/profile.constants.ts

@@ -0,0 +1,369 @@
+import { ProductUploadMapSource } from '../types/profile.types.js';
+import { ProductUploadRuleFilterType } from '../types/profile.types.js';
+
+export const SOURCE_VENDORS = 'source.vendor';
+export const SOURCE_TAGS = 'source.tag';
+export const SOURCE_PORODUCT_TYPE = 'source.product_type';
+export const SOURCE_COLLECTIONS = 'source.collection';
+export const SOURCE_LANGUAGE = 'source.language';
+export const SOURCE_GOOGLE_CATEGORY = 'source.google_category';
+export const SOURCE_COUNTRY = 'source.country';
+
+export const SOURCE_SHOPIFY_VENDORS = 'shopify.vendor';
+export const SOURCE_SHOPIFY_BARCODE = 'shopify.barcode';
+export const SOURCE_SHOPIFY_SKU = 'shopify.sku';
+
+export const SOURCE_CUSTOM = 'custom_input';
+
+export const RuleOperators = {
+  contains: {
+    label: 'Contains',
+    value: 'contains',
+  },
+  notContains: {
+    label: 'Not Contains',
+    value: 'notContains',
+  },
+  equals: {
+    label: 'Equals',
+    value: 'equals',
+  },
+  notEquals: {
+    label: 'Not Equals',
+    value: 'notEquals',
+  },
+  startsWith: {
+    label: 'Starts With',
+    value: 'startsWith',
+  },
+  notStartsWith: {
+    label: 'Not Starts With',
+    value: 'notStartsWith',
+  },
+  endsWith: {
+    label: 'Ends With',
+    value: 'endsWith',
+  },
+  notEndsWith: {
+    label: 'Not Ends With',
+    value: 'notEndsWith',
+  },
+  in: {
+    label: 'In',
+    value: 'in',
+  },
+  notIn: {
+    label: 'Not In',
+    value: 'notIn',
+  },
+};
+
+export const PruoductUploadRulesOperators = {
+  string: [
+    RuleOperators.contains,
+    RuleOperators.notContains,
+    RuleOperators.equals,
+    RuleOperators.notEquals,
+    RuleOperators.startsWith,
+    RuleOperators.endsWith,
+    RuleOperators.notStartsWith,
+    RuleOperators.notEndsWith,
+  ],
+  list: [RuleOperators.in, RuleOperators.notIn],
+};
+
+export const ProductUploadRuleFilters: ProductUploadRuleFilterType[] = [
+  {
+    label: 'Title',
+    operators: PruoductUploadRulesOperators.string,
+    value: 'title',
+  },
+  {
+    label: 'Collection',
+    operators: PruoductUploadRulesOperators.list,
+    value: 'collection',
+  },
+  {
+    label: 'Product Type',
+    operators: PruoductUploadRulesOperators.list,
+    value: 'product_type',
+  },
+  {
+    label: 'Vendor',
+    operators: PruoductUploadRulesOperators.list,
+    value: 'vendor',
+  },
+  {
+    label: 'Tag',
+    operators: PruoductUploadRulesOperators.list,
+    value: 'tag',
+  },
+];
+
+const ShopifyProductSource = {
+  vendor: { label: 'Shopify Product Vendor', value: SOURCE_SHOPIFY_VENDORS },
+  barcode: { label: 'Shopify Product Barcode', value: SOURCE_SHOPIFY_BARCODE },
+  sku: { label: 'Shopify Product SKU', value: SOURCE_SHOPIFY_SKU },
+  custom: { label: 'Custom input', value: SOURCE_CUSTOM },
+};
+
+export const ProductUploadMappings: ProductUploadMapSource[] = [
+  {
+    required: true,
+    label: 'Content Language',
+    attribute: 'contentLanguage',
+    type: 'select',
+    choises: [SOURCE_LANGUAGE],
+    rules: ['title', 'collection', 'product_type', 'vendor', 'tag'],
+    description: 'Language for the item',
+  },
+  {
+    required: true,
+    label: 'Target Country',
+    attribute: 'targetCountry',
+    type: 'select',
+    choises: [SOURCE_COUNTRY],
+    rules: ['title', 'collection', 'product_type', 'vendor', 'tag'],
+    description: 'The item\'s country of sale',
+  },
+  {
+    required: false,
+    label: 'Adult',
+    attribute: 'adult',
+    type: 'select',
+    choises: [
+      { label: 'Yes', value: true },
+      { label: 'No', value: false },
+    ],
+    rules: ['title', 'collection', 'product_type', 'vendor', 'tag'],
+    description:
+      'Should be set to "Yes" if the item is targeted towards adults',
+  },
+  {
+    required: false,
+    label: 'Age Group',
+    attribute: 'ageGroup',
+    type: 'select',
+    choises: [
+      { label: '0-3 months old', value: 'newborn' },
+      { label: '3-12 months old', value: 'infant' },
+      { label: '1-5 years old', value: 'toddler' },
+      { label: '5-13 years old', value: 'kids' },
+      { label: '13 years old or more', value: 'adult' },
+    ],
+    rules: ['title', 'collection', 'product_type', 'vendor', 'tag'],
+    description: 'Target age group of the item',
+  },
+  {
+    required: false,
+    label: 'Availability',
+    attribute: 'availability',
+    type: 'select',
+    choises: [
+      { label: 'In Stock', value: 'in_stock' },
+      { label: 'Out Of Stock', value: 'out_of_stock' },
+      { label: 'Preorder', value: 'preorder' },
+      { label: 'Backorder', value: 'backorder' },
+    ],
+    rules: ['title', 'collection', 'product_type', 'vendor', 'tag'],
+    description: 'Availability status of the item',
+  },
+  {
+    required: false,
+    label: 'Brand',
+    attribute: 'brand',
+    type: 'select',
+    defaultValue: 'shopify.vendor',
+    rules: ['title', 'collection', 'product_type', 'vendor', 'tag'],
+    description: 'Brand of the item',
+    choises: [
+      ShopifyProductSource.vendor,
+      SOURCE_VENDORS,
+      ShopifyProductSource.custom,
+    ],
+  },
+  {
+    required: false,
+    label: 'Gender',
+    attribute: 'gender',
+    type: 'select',
+    choises: [
+      { label: 'Male', value: 'male' },
+      { label: 'Female', value: 'female' },
+      { label: 'Unisex', value: 'unisex' },
+    ],
+    rules: ['title', 'collection', 'product_type', 'vendor', 'tag'],
+    description: 'Target gender of the item',
+  },
+  {
+    required: false,
+    label: 'Google category',
+    attribute: 'googleProductCategory',
+    type: 'select',
+    choises: [SOURCE_GOOGLE_CATEGORY],
+    rules: ['title', 'collection', 'product_type', 'vendor', 'tag'],
+    description: 'Google\'s category of the item',
+  },
+  {
+    required: false,
+    label: 'GTIN',
+    attribute: 'gtin',
+    type: 'select',
+    defaultValue: 'shopify.vendor',
+    rules: ['title', 'collection', 'product_type', 'vendor', 'tag'],
+    description: 'Global Trade Item Number (GTIN) of the item',
+    choises: [
+      ShopifyProductSource.barcode,
+      ShopifyProductSource.sku,
+      { label: 'Custom input', value: SOURCE_CUSTOM },
+    ],
+  },
+  {
+    required: false,
+    label: 'MPN',
+    attribute: 'mpn',
+    type: 'select',
+    defaultValue: 'shopify.vendor',
+    rules: ['title', 'collection', 'product_type', 'vendor', 'tag'],
+    description: 'Manufacturer Part Number (MPN) of the item',
+    choises: [
+      ShopifyProductSource.barcode,
+      ShopifyProductSource.sku,
+      { label: 'Custom input', value: SOURCE_CUSTOM },
+    ],
+  },
+  {
+    required: false,
+    label: 'Included Destinations',
+    attribute: 'includedDestinations',
+    type: 'multiselect',
+    choises: [
+      { label: 'Shopping ads', value: 'Shopping_ads' },
+      { label: 'Dynamic remarketing ads', value: 'Display_ads' },
+      { label: 'Free listings', value: 'Free_listings' },
+    ],
+    rules: ['title', 'collection', 'product_type', 'vendor', 'tag'],
+    description:
+      'The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center)',
+  },
+  {
+    required: false,
+    label: 'Shipping label',
+    attribute: 'shippingLabel',
+    type: 'text',
+    rules: ['title', 'collection', 'product_type', 'vendor', 'tag'],
+    description:
+      'The shipping label of the product, used to group product in account-level shipping rules',
+  },
+
+  // /**
+  //  * The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
+  //  */
+  // availabilityDate?: string | null;
+  // /**
+  //  * Color of the item.
+  //  */
+  // color?: string | null;
+  // /**
+  //  * Condition or state of the item.
+  //  */
+  // condition?: string | null;
+  // /**
+  //  * Custom label 0 for custom grouping of items in a Shopping campaign.
+  //  */
+  // customLabel0?: string | null;
+  // /**
+  //  * Custom label 1 for custom grouping of items in a Shopping campaign.
+  //  */
+  // customLabel1?: string | null;
+  // /**
+  //  * Custom label 2 for custom grouping of items in a Shopping campaign.
+  //  */
+  // customLabel2?: string | null;
+  // /**
+  //  * Custom label 3 for custom grouping of items in a Shopping campaign.
+  //  */
+  // customLabel3?: string | null;
+  // /**
+  //  * Custom label 4 for custom grouping of items in a Shopping campaign.
+  //  */
+  // customLabel4?: string | null;
+  // /**
+  //  * The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date](https://support.google.com/merchants/answer/13034208) for more information.
+  //  */
+  // disclosureDate?: string | null;
+  // /**
+  //  * Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future.
+  //  */
+  // expirationDate?: string | null;
+  // /**
+  //  * The material of which the item is made.
+  //  */
+  // material?: string | null;
+  // /**
+  //  * Maximal product handling time (in business days).
+  //  */
+  // maxHandlingTime?: string | null;
+  // /**
+  //  * Minimal product handling time (in business days).
+  //  */
+  // minHandlingTime?: string | null;
+  // /**
+  //  * The pick up option for the item. Acceptable values are: - "`buy`" - "`reserve`" - "`ship to store`" - "`not supported`"
+  //  */
+  // pickupMethod?: string | null;
+  // /**
+  //  * Item store pickup timeline. Acceptable values are: - "`same day`" - "`next day`" - "`2-day`" - "`3-day`" - "`4-day`" - "`5-day`" - "`6-day`" - "`7-day`" - "`multi-week`"
+  //  */
+  // pickupSla?: string | null;
+  // /**
+  //  * The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+  //  */
+  // productHeight?: Schema$ProductDimension;
+  // /**
+  //  * The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+  //  */
+  // productLength?: Schema$ProductDimension;
+  // /**
+  //  * The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+  //  */
+  // productWidth?: Schema$ProductDimension;
+  // /**
+  //  * Shipping rules.
+  //  */
+  // shipping?: Schema$ProductShipping[];
+  // /**
+  //  * Height of the item for shipping.
+  //  */
+  // shippingHeight?: Schema$ProductShippingDimension;
+  // /**
+  //  * Length of the item for shipping.
+  //  */
+  // shippingLength?: Schema$ProductShippingDimension;
+  // /**
+  //  * Weight of the item for shipping.
+  //  */
+  // shippingWeight?: Schema$ProductShippingWeight;
+  // /**
+  //  * Width of the item for shipping.
+  //  */
+  // shippingWidth?: Schema$ProductShippingDimension;
+  // /**
+  //  * List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.
+  //  */
+  // shoppingAdsExcludedCountries?: string[] | null;
+  // /**
+  //  * Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition).
+  //  */
+  // sizes?: string[] | null;
+  // /**
+  //  * System in which the size is specified. Recommended for apparel items.
+  //  */
+  // sizeSystem?: string | null;
+  // /**
+  //  * The cut of the item. Recommended for apparel items.
+  //  */
+  // sizeType?: string | null;
+];
+export const CHANNEL = 'online';
+export const GMC_PRODUCT_ID_TEMPLATE = '{PRODUCT_ID}_{VARIANT_ID}';

package/src/index.ts

@@ -0,0 +1,11 @@
+export * from './constants/google.constants.js';
+export * from './constants/product.constants.js';
+export * from './constants/profile.constants.js';
+
+export * from './types/product.types.js';
+export * from './types/profile.types.js';
+export * from './types/company.types.js';
+
+export * from './utils/gmc.js';
+export * from './utils/profile.js';
+export * from './utils/utils.js';

package/src/types/company.types.ts

@@ -0,0 +1,10 @@
+export type CompanyActionProgress = {
+    progress: number;
+    totalCount: number;
+    name: 'shopify' | 'gmc' | 'issues' | 'shopify-collection';
+    threadId: string;
+};
+
+export type CompanyActivity = CompanyActionProgress & {
+    shop: string;
+};

package/src/types/product.types.ts

@@ -0,0 +1,97 @@
+import { GmcProductSyncStatus } from '../constants/google.constants.js';
+import { ProductSyncStatus } from '../constants/product.constants.js';
+
+export type AppProductStatus = 'active' | 'draft' | 'archived';
+
+export type AppProductVariant = {
+  id: number;
+  title: string;
+  price: string;
+  sku: string | null;
+  image_id: number | null;
+};
+
+export type GmcProductId = {
+  id: string;
+  profileId: string;
+  gmcAccount: string;
+  uploaded_at: string;
+  status?: GmcProductSyncStatus;
+};
+
+export type GoogleProductIssue = {
+  servability?: 'demoted' | 'disapproved' | 'unaffected' | string;
+  description?: string;
+  documentation?: string;
+};
+
+export type gmcIssue = {
+  gmcProductId: string;
+  gmcAccount: string;
+  updated_at: string;
+  issue: GoogleProductIssue[];
+};
+
+export type ShopifyCollection = {
+  id: number;
+  handle: string;
+  title: string;
+};
+
+export type AppProduct = {
+  status: AppProductStatus;
+  handle: string;
+  title: string;
+  category?: string;
+  id: number;
+  googleCategory?: number;
+  image?: string;
+  _id: string;
+  gmcIssues?: gmcIssue[];
+  gmcProductId?: GmcProductId[];
+  updated_at: string;
+  variants: AppProductVariant[];
+  images: {
+    src: string;
+    id: string;
+  }[];
+  collections: ShopifyCollection[];
+  tags: string[];
+  vendor: string;
+  product_type: string;
+  syncStatus: ProductSyncStatus;
+};
+
+export type GetProductsQuery = {
+  before?: string;
+  after?: string;
+  limit?: number;
+  handle?: string;
+  title?: string;
+  id?: number[];
+  sortField?: 'title' | 'id';
+  sort?: 'asc' | 'desc';
+  fields?: string[];
+  gmcProductId?: string[] | boolean;
+};
+
+export type GetProductsResponse = {
+  products: AppProduct[];
+  pagination: {
+    firstId: string;
+    lastId: string;
+    hasMore: boolean;
+    hasLess: boolean;
+  };
+};
+
+export type ProductsList = {
+  ids: string[];
+};
+
+export type UploadProductBulkPayload = {
+  collections: string[];
+  vendors: string[];
+  types: string[];
+  tags: string[];
+};

package/src/types/profile.types.ts

@@ -0,0 +1,73 @@
+import {
+  ProductUploadRuleFilters,
+  ProductUploadMappings,
+} from '../constants/profile.constants.js';
+import { RuleOperators } from '../constants/profile.constants.js';
+
+export type ProductUploadRuleOpratorType = {
+  label: string;
+  value: string;
+};
+
+export type ProductUploadRuleFilterType = {
+  label: string;
+  operators: ProductUploadRuleOpratorType[];
+  value: string;
+  disabled?: boolean;
+};
+
+export type RuleOperatorsType = typeof RuleOperators;
+export type ValueType = string | string[] | number[] | number | boolean;
+export type OptionTypeItem = { label: string; value: ValueType };
+export type OptionTypeGroup = { title: string; options: OptionTypeItem[] };
+export type OptionType = OptionTypeItem | OptionTypeGroup | string;
+export type ProductUploadMapSource = {
+  required: boolean;
+  label: string;
+  attribute: string;
+  type: 'select' | 'multiselect' | 'text' | 'number';
+  choises?: OptionType[];
+  rules: ProductUploadRuleFilterType['value'][];
+  description?: string;
+  defaultValue?: ValueType;
+};
+
+export type ProductUploadMapping = {
+  attribute: MappingFields;
+  value: ValueType;
+  rules: {
+    sections: {
+      ruleItems: {
+        attribute: (typeof ProductUploadRuleFilters)[number]['value'];
+        operator: ProductUploadRuleOpratorType['value'];
+        value: string | string[] | number[] | number | boolean;
+        id: string;
+      }[];
+    }[];
+  };
+};
+
+type MappingFields = (typeof ProductUploadMappings)[number]['attribute'];
+
+export type ProductUploadProfile = {
+  id: string;
+  name: string;
+  active?: boolean;
+  rules: ProductUploadRules;
+  mappings: ProductUploadMapping[];
+};
+
+export type ProductUploadRules = {
+  sections: ProductUploadRuleSection[];
+};
+
+export type ProductUploadRuleSection = {
+  ruleItems: ProductUploadRuleItem[];
+};
+
+export type ProductUploadRuleItem = {
+  id: string;
+  attribute: string;
+  operator: string;
+  value: string | number | string[] | number[] | boolean;
+};

package/src/utils/gmc.ts

@@ -0,0 +1,69 @@
+import { GMC_PRODUCT_ID_TEMPLATE } from '../constants/profile.constants.js';
+
+export function isGmcProductId (productId: string): boolean {
+  return new RegExp(
+    GMC_PRODUCT_ID_TEMPLATE.replace('{PRODUCT_ID}', '\\d+').replace(
+      '{VARIANT_ID}',
+      '\\d+'
+    )
+  ).test(productId);
+}
+
+export function GMCProductIdToShopify (productId: string): number {
+  const [, , , id] = productId.split(':');
+  return Number(getProductIdFromGmcId(id));
+}
+
+export function GmcIdParts (gmcProductId: string): {
+  channel: string;
+  locale: string;
+  country: string;
+  idPart: string;
+  shopifyId: number;
+  shopifyVariantId: number;
+} {
+  const [channel, locale, country, idPart] = gmcProductId.split(':');
+
+  if (!channel || !locale || !country || !idPart) {
+    throw new Error(`${gmcProductId} is not a valid GMC product id`);
+  }
+
+  return {
+    channel,
+    locale,
+    country,
+    idPart,
+    ...getShopifyIdsFromGmcIdPart(idPart),
+  };
+}
+
+export function makeGmcIdPart (
+  productId: number | null,
+  variantId: number | null
+): string {
+  return GMC_PRODUCT_ID_TEMPLATE.replace(
+    '{PRODUCT_ID}',
+    String(productId)
+  ).replace('{VARIANT_ID}', String(variantId));
+}
+
+export function getShopifyIdsFromGmcIdPart (gmcId: string): {
+  shopifyId: number;
+  shopifyVariantId: number;
+} {
+  if (!isGmcProductId(gmcId)) {
+    throw new Error(`${gmcId} is not a valid GMC product id part`);
+  }
+
+  const [productId, variantId] = gmcId.split('_');
+  return { shopifyId: Number(productId), shopifyVariantId: Number(variantId) };
+}
+
+export function getProductIdFromGmcId (gmcId: string): number {
+  if (!isGmcProductId(gmcId)) {
+    throw new Error(`${gmcId} is not a valid GMC product id part`);
+  }
+
+  const [productId] = gmcId.split('_');
+  return Number(productId);
+}