feed-common 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## [1.0.2](https://github.com/advertikon/package-maxify-feed-common/compare/v1.0.1...v1.0.2) (2024-02-02)
+
+
+### Bug Fixes
+
+* some changes ([e984a10](https://github.com/advertikon/package-maxify-feed-common/commit/e984a10d9816044b53ea894c881526a7af59ca40))
+
+## [1.0.1](https://github.com/advertikon/package-maxify-feed-common/compare/v1.0.0...v1.0.1) (2024-01-30)
+
+
+### Bug Fixes
+
+* add company types ([cd62d4d](https://github.com/advertikon/package-maxify-feed-common/commit/cd62d4d762b6afd72279426f42fab34eefce1bc0))
+* add type definitions ([8f5d33f](https://github.com/advertikon/package-maxify-feed-common/commit/8f5d33f69a5f65772fdc0f1ba7bb543ff0f88afe))
+* fix ci ([6444435](https://github.com/advertikon/package-maxify-feed-common/commit/6444435746003edbebe340a258f9c9c5b1639289))
+
 # 1.0.0 (2024-01-28)
 
 

package/dist/constants/google.constants.d.ts

@@ -0,0 +1,11 @@
+export declare enum GmcProductSyncStatus {
+    REJECTED = "rejected",
+    APPROVED = "approved",
+    WARNING = "warning",
+    SYNC_SCHEDULED = "sync_scheduled"
+}
+export declare enum GoogleAccountStatus {
+    ENABLED = "ENABLED",
+    REMOVED = "REMOVED",
+    REJECTED = "REJECTED"
+}

package/dist/constants/google.constants.js

@@ -2,8 +2,8 @@ export var GmcProductSyncStatus;
 (function (GmcProductSyncStatus) {
     GmcProductSyncStatus["REJECTED"] = "rejected";
     GmcProductSyncStatus["APPROVED"] = "approved";
-    GmcProductSyncStatus["WARINING"] = "warning";
-    GmcProductSyncStatus["SYNC_SHEDULED"] = "sync_sheduled";
+    GmcProductSyncStatus["WARNING"] = "warning";
+    GmcProductSyncStatus["SYNC_SCHEDULED"] = "sync_scheduled";
 })(GmcProductSyncStatus || (GmcProductSyncStatus = {}));
 export var GoogleAccountStatus;
 (function (GoogleAccountStatus) {

package/dist/constants/google.constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"google.constants.js","sourceRoot":"","sources":["../../src/constants/google.constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,6CAAqB,CAAA;IACrB,6CAAqB,CAAA;IACrB,4CAAoB,CAAA;IACpB,uDAA+B,CAAA;AACjC,CAAC,EALW,oBAAoB,KAApB,oBAAoB,QAK/B;AAED,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,0CAAmB,CAAA;IACnB,4CAAqB,CAAA;AACvB,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B"}
+{"version":3,"file":"google.constants.js","sourceRoot":"","sources":["../../src/constants/google.constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,6CAAqB,CAAA;IACrB,6CAAqB,CAAA;IACrB,2CAAmB,CAAA;IACnB,yDAAiC,CAAA;AACnC,CAAC,EALW,oBAAoB,KAApB,oBAAoB,QAK/B;AAED,MAAM,CAAN,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC7B,0CAAmB,CAAA;IACnB,0CAAmB,CAAA;IACnB,4CAAqB,CAAA;AACvB,CAAC,EAJW,mBAAmB,KAAnB,mBAAmB,QAI9B"}

package/dist/constants/product.constants.d.ts

@@ -0,0 +1,4 @@
+export declare enum ProductSyncStatus {
+    SYNCING = "syncing",
+    SYNCED = "synced"
+}

package/dist/constants/profile.constants.d.ts

@@ -0,0 +1,69 @@
+import { ProductUploadMapSource } from '../types/profile.types.js';
+import { ProductUploadRuleFilterType } from '../types/profile.types.js';
+export declare const SOURCE_VENDORS = "source.vendor";
+export declare const SOURCE_TAGS = "source.tag";
+export declare const SOURCE_PORODUCT_TYPE = "source.product_type";
+export declare const SOURCE_COLLECTIONS = "source.collection";
+export declare const SOURCE_LANGUAGE = "source.language";
+export declare const SOURCE_GOOGLE_CATEGORY = "source.google_category";
+export declare const SOURCE_COUNTRY = "source.country";
+export declare const SOURCE_SHOPIFY_VENDORS = "shopify.vendor";
+export declare const SOURCE_SHOPIFY_BARCODE = "shopify.barcode";
+export declare const SOURCE_SHOPIFY_SKU = "shopify.sku";
+export declare const SOURCE_CUSTOM = "custom_input";
+export declare const RuleOperators: {
+    contains: {
+        label: string;
+        value: string;
+    };
+    notContains: {
+        label: string;
+        value: string;
+    };
+    equals: {
+        label: string;
+        value: string;
+    };
+    notEquals: {
+        label: string;
+        value: string;
+    };
+    startsWith: {
+        label: string;
+        value: string;
+    };
+    notStartsWith: {
+        label: string;
+        value: string;
+    };
+    endsWith: {
+        label: string;
+        value: string;
+    };
+    notEndsWith: {
+        label: string;
+        value: string;
+    };
+    in: {
+        label: string;
+        value: string;
+    };
+    notIn: {
+        label: string;
+        value: string;
+    };
+};
+export declare const PruoductUploadRulesOperators: {
+    string: {
+        label: string;
+        value: string;
+    }[];
+    list: {
+        label: string;
+        value: string;
+    }[];
+};
+export declare const ProductUploadRuleFilters: ProductUploadRuleFilterType[];
+export declare const ProductUploadMappings: ProductUploadMapSource[];
+export declare const CHANNEL = "online";
+export declare const GMC_PRODUCT_ID_TEMPLATE = "{PRODUCT_ID}_{VARIANT_ID}";

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+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';
+export * from './utils/company.js';

package/dist/index.js

@@ -3,7 +3,9 @@ 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';
+export * from './utils/company.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC"}

package/dist/types/company.types.d.ts

@@ -0,0 +1,11 @@
+export type ServerSideEvent = {
+    shop: string;
+    threadId: string;
+    type: 'progress' | 'schedule';
+    name: string;
+};
+export type ServerSideProgressEvent = ServerSideEvent & {
+    progress: number;
+    totalCount: number;
+};
+export type ServerSideScheduleEvent = ServerSideEvent;

package/dist/types/company.types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=company.types.js.map

package/dist/types/company.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"company.types.js","sourceRoot":"","sources":["../../src/types/company.types.ts"],"names":[],"mappings":""}

package/dist/types/product.types.d.ts

@@ -0,0 +1,86 @@
+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/dist/types/profile.types.d.ts

@@ -0,0 +1,68 @@
+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;
+};
+export {};

package/dist/utils/company.d.ts

@@ -0,0 +1,3 @@
+import { ServerSideEvent, ServerSideProgressEvent, ServerSideScheduleEvent } from '../types/company.types.js';
+export declare function isServerSideProgressEvent(event: ServerSideEvent): event is ServerSideProgressEvent;
+export declare function isServerSideScheduleEvent(event: ServerSideEvent): event is ServerSideScheduleEvent;

package/dist/utils/company.js

@@ -0,0 +1,7 @@
+export function isServerSideProgressEvent(event) {
+    return event.type === 'progress';
+}
+export function isServerSideScheduleEvent(event) {
+    return event.type === 'schedule';
+}
+//# sourceMappingURL=company.js.map

package/dist/utils/company.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"company.js","sourceRoot":"","sources":["../../src/utils/company.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,yBAAyB,CAAE,KAAsB;IAC7D,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAE,KAAsB;IAC7D,OAAO,KAAK,CAAC,IAAI,KAAK,UAAU,CAAC;AACrC,CAAC"}

package/dist/utils/gmc.d.ts

@@ -0,0 +1,16 @@
+export declare function isGmcProductId(productId: string): boolean;
+export declare function GMCProductIdToShopify(productId: string): number;
+export declare function GmcIdParts(gmcProductId: string): {
+    channel: string;
+    locale: string;
+    country: string;
+    idPart: string;
+    shopifyId: number;
+    shopifyVariantId: number;
+};
+export declare function makeGmcIdPart(productId: number | null, variantId: number | null): string;
+export declare function getShopifyIdsFromGmcIdPart(gmcId: string): {
+    shopifyId: number;
+    shopifyVariantId: number;
+};
+export declare function getProductIdFromGmcId(gmcId: string): number;

package/dist/utils/profile.d.ts

@@ -0,0 +1,28 @@
+import { OptionType, OptionTypeItem, OptionTypeGroup, ProductUploadProfile } from '../types/profile.types.js';
+import { ProductUploadMapping } from '../types/profile.types.js';
+import { ProductUploadRuleFilterType } from '../types/profile.types.js';
+import { ProductUploadRuleItem, ProductUploadRuleSection, ProductUploadRules } from '../types/profile.types.js';
+export declare function checkRuleDuplication(rules: ProductUploadRuleItem[]): string[];
+export declare function checkRuleAlwaysness(rules: ProductUploadRuleItem[]): string[];
+export declare function checkRuleDeadlocks(sections: ProductUploadRuleSection[]): string[];
+export declare function getEmptyRuleItem(attribute?: ProductUploadRuleFilterType['value']): ProductUploadRuleItem;
+export declare function sortMappings(a: ProductUploadMapping, b: ProductUploadMapping): number;
+export declare function hasRules(rules: ProductUploadRules): boolean;
+/**
+ * Checks if two rules are the same
+ * @param a
+ * @param b
+ * @returns
+ */
+export declare function compareRules(a?: ProductUploadRules, b?: ProductUploadRules): boolean;
+export declare function compareMappings(a: ProductUploadMapping[], b: ProductUploadMapping[]): boolean;
+export declare function optionIsString(option: OptionType): option is string;
+export declare function optionIsItem(option: OptionType): option is OptionTypeItem;
+export declare function optionIsGroup(option: OptionType): option is OptionTypeGroup;
+export declare function detectProfileChange(a: ProductUploadProfile, b: ProductUploadProfile): {
+    name: boolean;
+    rules: boolean;
+    mappings: boolean;
+    id: boolean;
+};
+export declare function sanitizeUploadProfile(profile: ProductUploadProfile): ProductUploadProfile;

package/dist/utils/utils.d.ts

@@ -0,0 +1 @@
+export declare function code(): string;

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "feed-common",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Maxify feed common library",
   "main": "dist/index.js",
   "type": "module",
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "install-local": "scripts/install.sh"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.1",

package/src/constants/google.constants.ts

@@ -0,0 +1,12 @@
+export enum GmcProductSyncStatus {
+  REJECTED = 'rejected',
+  APPROVED = 'approved',
+  WARNING = 'warning',
+  SYNC_SCHEDULED = 'sync_scheduled',
+}
+
+export enum GoogleAccountStatus {
+  ENABLED = 'ENABLED',
+  REMOVED = 'REMOVED',
+  REJECTED = 'REJECTED',
+}

package/src/constants/product.constants.ts

@@ -0,0 +1,4 @@
+export enum ProductSyncStatus {
+  SYNCING = 'syncing',
+  SYNCED = 'synced',
+}