@pintahub/database-schemas 6.16.0 → 6.18.0

package/README.md

@@ -128,7 +128,7 @@ Account, User, Store, Shop, ShopifyAPI
 Product, ProductFeature, ProductImage, ProductRaw, ProductType, ProductTag, ProductImport, Customize, CustomField, FieldSetting
 
 ### Collections & Groups
-Collection, Group, GroupItem, GroupArtwork
+Collection, Group, GroupItem, GroupArtwork, GroupSyncRule
 
 ### Orders & Fulfillment
 Order, OrderItem, Fulfillment, Payout
@@ -140,7 +140,7 @@ Post, Menu, MenuItem, AnnouncementBar
 Image, Artwork, Media, MediaUpload, TempUpload
 
 ### Analytics & Tracking
-StoreEvent, LatestEvent, RecentView, SearchTerm, FavoriteItem, TrackPage, MarketingCost
+StoreEvent, LatestEvent, RecentView, SearchTerm, FavoriteItem, TrackPage, MarketingCost, MarketingCostRaw
 
 ### Short URLs
 ShortUrl, ShortDomain, ShortLog, LogURL
@@ -158,7 +158,7 @@ CreatorReport, ProductReport
 Review
 
 ### Embedded Types
-`schemas/types/`: BrandSettings, DMCASetting, FacebookObject, FooterSetting, FreeShippingSetting, GoogleAnalytics, KlaviyoObject, MerchizeSettings, SocialsObject, TopBarSettings, TrustpilotObject
+`schemas/types/`: BrandSettings, DMCASetting, FacebookObject, FooterSetting, FreeShippingSetting, GoogleAnalytics, GroupSyncRuleMetafield, KlaviyoObject, MerchizeSettings, SocialsObject, TopBarSettings, TrustpilotObject
 
 `schemas/products/`: MediaObject, SeoObject, VideoObject
 

package/dist/interfaces/GroupSyncRule.d.ts

@@ -0,0 +1,14 @@
+import type { Types } from 'mongoose';
+import type { IGroupSyncRuleMetafield } from './types/GroupSyncRuleMetafield';
+export interface IGroupSyncRule {
+    store: Types.ObjectId;
+    /** Rule kind — decides which sub-document holds the target */
+    type: 'metafield';
+    /** Group field whose value the rule syncs */
+    group_field: 'title' | 'description' | 'label' | 'tags' | 'visibility' | 'trello_id' | 'user_idea';
+    /** Required when type is 'metafield' */
+    metafield?: IGroupSyncRuleMetafield;
+    updated_at?: Date;
+    created_at?: Date;
+}
+//# sourceMappingURL=GroupSyncRule.d.ts.map

package/dist/interfaces/GroupSyncRule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupSyncRule.d.ts","sourceRoot":"","sources":["../../src/interfaces/GroupSyncRule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,UAAU,CAAA;AACnC,OAAO,KAAK,EAAC,uBAAuB,EAAC,MAAM,gCAAgC,CAAA;AAE3E,MAAM,WAAW,cAAc;IAC3B,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAA;IACrB,8DAA8D;IAC9D,IAAI,EAAE,WAAW,CAAA;IACjB,6CAA6C;IAC7C,WAAW,EAAE,OAAO,GAAG,aAAa,GAAG,OAAO,GAAG,MAAM,GAAG,YAAY,GAAG,WAAW,GAAG,WAAW,CAAA;IAClG,wCAAwC;IACxC,SAAS,CAAC,EAAE,uBAAuB,CAAA;IACnC,UAAU,CAAC,EAAE,IAAI,CAAA;IACjB,UAAU,CAAC,EAAE,IAAI,CAAA;CACpB"}

package/dist/interfaces/GroupSyncRule.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=GroupSyncRule.js.map

package/dist/interfaces/GroupSyncRule.js.map

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

package/dist/interfaces/MarketingCostRaw.d.ts

@@ -0,0 +1,14 @@
+import type { Types } from 'mongoose';
+export interface IMarketingCostRaw {
+    marketing_cost: Types.ObjectId;
+    store: Types.ObjectId;
+    /** Whole CSV row, keyed by slugified header; values are raw strings, column set varies by export */
+    data: Record<string, any>;
+    /** Provenance only — S3 key of the source file */
+    source_key?: string;
+    /** Provenance only — record ordinal within that file (header is 0, first data row is 1); not a physical line number */
+    line?: number;
+    updated_at?: Date;
+    created_at?: Date;
+}
+//# sourceMappingURL=MarketingCostRaw.d.ts.map

package/dist/interfaces/MarketingCostRaw.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarketingCostRaw.d.ts","sourceRoot":"","sources":["../../src/interfaces/MarketingCostRaw.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,UAAU,CAAA;AAEnC,MAAM,WAAW,iBAAiB;IAC9B,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAA;IAC9B,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAA;IACrB,oGAAoG;IACpG,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACzB,kDAAkD;IAClD,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,uHAAuH;IACvH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,IAAI,CAAA;IACjB,UAAU,CAAC,EAAE,IAAI,CAAA;CACpB"}

package/dist/interfaces/MarketingCostRaw.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=MarketingCostRaw.js.map

package/dist/interfaces/MarketingCostRaw.js.map

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

package/dist/interfaces/types/GroupSyncRuleMetafield.d.ts

@@ -0,0 +1,7 @@
+export interface IGroupSyncRuleMetafield {
+    namespace: string;
+    key: string;
+    /** Shopify metafield type, e.g. 'single_line_text_field' — not checked against the store's metafield definitions */
+    type: string;
+}
+//# sourceMappingURL=GroupSyncRuleMetafield.d.ts.map

package/dist/interfaces/types/GroupSyncRuleMetafield.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupSyncRuleMetafield.d.ts","sourceRoot":"","sources":["../../../src/interfaces/types/GroupSyncRuleMetafield.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACpC,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,oHAAoH;IACpH,IAAI,EAAE,MAAM,CAAA;CACf"}

package/dist/interfaces/types/GroupSyncRuleMetafield.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=GroupSyncRuleMetafield.js.map

package/dist/interfaces/types/GroupSyncRuleMetafield.js.map

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

package/dist/schemas/GroupSyncRule.d.ts

@@ -0,0 +1,37 @@
+import { Schema } from 'mongoose';
+/**
+ * A per-store rule that syncs one group field onto the group's member products when
+ * "Apply to products" runs. `type` names the kind of target, and each kind keeps its
+ * own config in a sub-document named after it (`metafield` for type 'metafield').
+ * Adding a kind means a new `type` enum value plus its own sub-document — the
+ * collection keeps its name.
+ */
+declare const GroupSyncRule: Schema<any, import("mongoose").Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, Record<string, any>, import("mongoose").Document<unknown, {}, Record<string, any>, {
+    id: string;
+}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & Omit<Record<string, any> & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, "id"> & {
+    id: string;
+}, {
+    [path: string]: import("mongoose").SchemaDefinitionProperty<undefined, any, any>;
+} | {
+    [x: string]: import("mongoose").SchemaDefinitionProperty<any, any, import("mongoose").Document<unknown, {}, Record<string, any>, {
+        id: string;
+    }, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & Omit<Record<string, any> & Required<{
+        _id: unknown;
+    }> & {
+        __v: number;
+    }, "id"> & {
+        id: string;
+    }> | undefined;
+}, {
+    [x: string]: any;
+} & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}>;
+export = GroupSyncRule;
+//# sourceMappingURL=GroupSyncRule.d.ts.map

package/dist/schemas/GroupSyncRule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupSyncRule.d.ts","sourceRoot":"","sources":["../../src/schemas/GroupSyncRule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAA;AAE/B;;;;;;GAMG;AACH,QAAA,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;EAiEjB,CAAA;AAoBF,SAAS,aAAa,CAAA"}

package/dist/schemas/GroupSyncRule.js

@@ -0,0 +1,90 @@
+"use strict";
+const mongoose_1 = require("mongoose");
+const GroupSyncRuleMetafield = require("./types/GroupSyncRuleMetafield");
+/**
+ * A per-store rule that syncs one group field onto the group's member products when
+ * "Apply to products" runs. `type` names the kind of target, and each kind keeps its
+ * own config in a sub-document named after it (`metafield` for type 'metafield').
+ * Adding a kind means a new `type` enum value plus its own sub-document — the
+ * collection keeps its name.
+ */
+const GroupSyncRule = new mongoose_1.Schema({
+    /** @ref Store */
+    store: {
+        type: mongoose_1.Schema.Types.ObjectId,
+        ref: 'Store',
+        index: true,
+        required: true,
+    },
+    /**
+     * Rule kind, which decides the sub-document that holds the target:
+     * - metafield: write the group field into a Shopify product metafield (`metafield`)
+     */
+    type: {
+        type: String,
+        trim: true,
+        required: true,
+        enum: ['metafield'],
+    },
+    /**
+     * Group field whose value the rule syncs, shared by every rule kind. `tags` is the
+     * only array field on Group; the rest are strings:
+     * - title
+     * - description
+     * - label
+     * - tags
+     * - visibility
+     * - trello_id
+     * - user_idea
+     */
+    group_field: {
+        type: String,
+        trim: true,
+        required: true,
+        enum: ['title', 'description', 'label', 'tags', 'visibility', 'trello_id', 'user_idea'],
+    },
+    /**
+     * Target metafield — required when `type` is 'metafield', absent for any other kind.
+     *
+     * The condition is only checked by document validation (`create()` / `save()`). Update
+     * queries skip it even with `runValidators: true`: `$unset: {metafield: 1}` goes through
+     * on a 'metafield' rule, while `$set` of an incomplete `metafield` object is still
+     * rejected by its own required fields. Write paths that update rules must keep `type`
+     * and `metafield` consistent themselves.
+     */
+    metafield: {
+        type: GroupSyncRuleMetafield,
+        required: function () {
+            return this.type === 'metafield';
+        },
+    },
+    /** Last update timestamp */
+    updated_at: {
+        type: Date,
+        default: Date.now,
+    },
+    /** Record creation timestamp */
+    created_at: {
+        type: Date,
+        default: Date.now,
+    }
+});
+/**
+ * One rule per metafield per store: two rules writing the same `namespace.key` would
+ * overwrite each other in whatever order they happen to run.
+ *
+ * Partial on `type: 'metafield'` on purpose. Rules of any other kind carry no
+ * `metafield`, and a plain unique index would index every one of them as
+ * (store, null, null), so the second such rule in a store would fail with E11000.
+ * A query only uses this index when its filter includes `type: 'metafield'`.
+ */
+GroupSyncRule.index({
+    store: 1,
+    'metafield.namespace': 1,
+    'metafield.key': 1,
+}, {
+    unique: true,
+    partialFilterExpression: { type: 'metafield' },
+});
+module.exports = GroupSyncRule;
+//# sourceMappingURL=GroupSyncRule.js.map

package/dist/schemas/GroupSyncRule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupSyncRule.js","sourceRoot":"","sources":["../../src/schemas/GroupSyncRule.ts"],"names":[],"mappings":";AAAA,uCAA+B;AAC/B,yEAAyE;AACzE;;;;;;GAMG;AACH,MAAM,aAAa,GAAG,IAAI,iBAAM,CAAsB;IAClD,iBAAiB;IACjB,KAAK,EAAE;QACH,IAAI,EAAE,iBAAM,CAAC,KAAK,CAAC,QAAQ;QAC3B,GAAG,EAAE,OAAO;QACZ,KAAK,EAAE,IAAI;QACX,QAAQ,EAAE,IAAI;KACjB;IAED;;;OAGG;IACH,IAAI,EAAE;QACF,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,CAAC,WAAW,CAAC;KACtB;IAED;;;;;;;;;;OAUG;IACH,WAAW,EAAE;QACT,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,IAAI;QACd,IAAI,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,CAAC;KAC1F;IAED;;;;;;;;OAQG;IACH,SAAS,EAAE;QACP,IAAI,EAAE,sBAAsB;QAC5B,QAAQ,EAAE;YACN,OAAO,IAAI,CAAC,IAAI,KAAK,WAAW,CAAA;QACpC,CAAC;KACJ;IAED,4BAA4B;IAC5B,UAAU,EAAE;QACR,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,IAAI,CAAC,GAAG;KACpB;IAED,gCAAgC;IAChC,UAAU,EAAE;QACR,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,IAAI,CAAC,GAAG;KACpB;CACJ,CAAC,CAAA;AAEF;;;;;;;;GAQG;AACH,aAAa,CAAC,KAAK,CAAC;IAChB,KAAK,EAAE,CAAC;IACR,qBAAqB,EAAE,CAAC;IACxB,eAAe,EAAE,CAAC;CACrB,EAAE;IACC,MAAM,EAAE,IAAI;IACZ,uBAAuB,EAAE,EAAC,IAAI,EAAE,WAAW,EAAC;CAC/C,CAAC,CAAA;AAEF,iBAAS,aAAa,CAAA"}

package/dist/schemas/MarketingCostRaw.d.ts

@@ -0,0 +1,35 @@
+import { Schema } from 'mongoose';
+/**
+ * The raw CSV row behind one MarketingCost doc — every column of the Facebook Ads
+ * export, exactly as parsed. The cost import writes one MarketingCost per CSV row,
+ * so this is a 1:1 snapshot of a single row, never an aggregate of several.
+ */
+declare const MarketingCostRaw: Schema<any, import("mongoose").Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, Record<string, any>, import("mongoose").Document<unknown, {}, Record<string, any>, {
+    id: string;
+}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & Omit<Record<string, any> & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, "id"> & {
+    id: string;
+}, {
+    [path: string]: import("mongoose").SchemaDefinitionProperty<undefined, any, any>;
+} | {
+    [x: string]: import("mongoose").SchemaDefinitionProperty<any, any, import("mongoose").Document<unknown, {}, Record<string, any>, {
+        id: string;
+    }, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & Omit<Record<string, any> & Required<{
+        _id: unknown;
+    }> & {
+        __v: number;
+    }, "id"> & {
+        id: string;
+    }> | undefined;
+}, {
+    [x: string]: any;
+} & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}>;
+export = MarketingCostRaw;
+//# sourceMappingURL=MarketingCostRaw.d.ts.map

package/dist/schemas/MarketingCostRaw.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarketingCostRaw.d.ts","sourceRoot":"","sources":["../../src/schemas/MarketingCostRaw.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAA;AAC/B;;;;GAIG;AACH,QAAA,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;EA6DpB,CAAA;AAaF,SAAS,gBAAgB,CAAA"}

package/dist/schemas/MarketingCostRaw.js

@@ -0,0 +1,75 @@
+"use strict";
+const mongoose_1 = require("mongoose");
+/**
+ * The raw CSV row behind one MarketingCost doc — every column of the Facebook Ads
+ * export, exactly as parsed. The cost import writes one MarketingCost per CSV row,
+ * so this is a 1:1 snapshot of a single row, never an aggregate of several.
+ */
+const MarketingCostRaw = new mongoose_1.Schema({
+    /** @ref MarketingCost — 1:1; the unique index at the bottom of this file is what enforces it */
+    marketing_cost: {
+        type: mongoose_1.Schema.Types.ObjectId,
+        required: true,
+    },
+    /** @ref Store */
+    store: {
+        type: mongoose_1.Schema.Types.ObjectId,
+        ref: 'Store',
+        index: true,
+        required: true,
+    },
+    /**
+     * The whole CSV row, keyed by slugified header — `Amount spent (USD)` arrives as
+     * `amountspentusd`. Read key names off a real doc, not off the export's header line.
+     *
+     * Deliberately a bare Mixed with no sub-schema: the column set changes between
+     * exports (24 columns in one file, 26 with `day` and `adsetid` in another uploaded
+     * the same day), and declaring any child field would switch strict mode on for this
+     * branch and silently drop every column that was not declared.
+     *
+     * Values are raw strings straight from the CSV — nothing is parsed or coerced, so a
+     * metric the export left blank is `""`, not 0. Mutating this in place on a hydrated
+     * doc needs `markModified('data')`; the import writes it through `$set` instead.
+     */
+    data: {
+        type: mongoose_1.Schema.Types.Mixed,
+        required: true,
+    },
+    /** Provenance only: S3 key of the file this row came from. Not indexed, never read from */
+    source_key: {
+        type: String,
+        trim: true,
+    },
+    /**
+     * Provenance only: which record of that file this row was, as counted by
+     * `@pintahub/csv-importer` — the header is 0, so the first data row is 1.
+     * Not a physical line number: the parser runs with `skip_empty_lines`, so a
+     * blank line in the file shifts every later record. Good enough to find a row
+     * again, wrong for `sed -n '<line>p'`. Not indexed, never read from.
+     */
+    line: {
+        type: Number,
+    },
+    /** Last update timestamp */
+    updated_at: {
+        type: Date,
+        default: Date.now,
+    },
+    /** Record creation timestamp */
+    created_at: {
+        type: Date,
+        default: Date.now,
+    }
+});
+/**
+ * 1:1 with MarketingCost, and the whole idempotency mechanism of the cost import:
+ * the importer upserts on this key, so re-importing the same file creates no
+ * duplicate, and a restate (a second export file covering the same report date)
+ * overwrites the raw row at the same moment it overwrites `cost.amount` — the two
+ * can never drift apart.
+ */
+MarketingCostRaw.index({
+    marketing_cost: 1,
+}, { unique: true });
+module.exports = MarketingCostRaw;
+//# sourceMappingURL=MarketingCostRaw.js.map

package/dist/schemas/MarketingCostRaw.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MarketingCostRaw.js","sourceRoot":"","sources":["../../src/schemas/MarketingCostRaw.ts"],"names":[],"mappings":";AAAA,uCAA+B;AAC/B;;;;GAIG;AACH,MAAM,gBAAgB,GAAG,IAAI,iBAAM,CAAsB;IACrD,gGAAgG;IAChG,cAAc,EAAE;QACZ,IAAI,EAAE,iBAAM,CAAC,KAAK,CAAC,QAAQ;QAC3B,QAAQ,EAAE,IAAI;KACjB;IAED,iBAAiB;IACjB,KAAK,EAAE;QACH,IAAI,EAAE,iBAAM,CAAC,KAAK,CAAC,QAAQ;QAC3B,GAAG,EAAE,OAAO;QACZ,KAAK,EAAE,IAAI;QACX,QAAQ,EAAE,IAAI;KACjB;IAED;;;;;;;;;;;;OAYG;IACH,IAAI,EAAE;QACF,IAAI,EAAE,iBAAM,CAAC,KAAK,CAAC,KAAK;QACxB,QAAQ,EAAE,IAAI;KACjB;IAED,2FAA2F;IAC3F,UAAU,EAAE;QACR,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,IAAI;KACb;IAED;;;;;;OAMG;IACH,IAAI,EAAE;QACF,IAAI,EAAE,MAAM;KACf;IAED,4BAA4B;IAC5B,UAAU,EAAE;QACR,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,IAAI,CAAC,GAAG;KACpB;IAED,gCAAgC;IAChC,UAAU,EAAE;QACR,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,IAAI,CAAC,GAAG;KACpB;CACJ,CAAC,CAAA;AAEF;;;;;;GAMG;AACH,gBAAgB,CAAC,KAAK,CAAC;IACnB,cAAc,EAAE,CAAC;CACpB,EAAE,EAAC,MAAM,EAAE,IAAI,EAAC,CAAC,CAAA;AAElB,iBAAS,gBAAgB,CAAA"}

package/dist/schemas/types/GroupSyncRuleMetafield.d.ts

@@ -0,0 +1,38 @@
+import { Schema } from 'mongoose';
+/**
+ * Embedded target of a `GroupSyncRule` whose `type` is 'metafield': the Shopify
+ * product metafield the rule writes the group field's value into.
+ *
+ * Keep this a separate Schema. Inlined into the parent as a plain object
+ * (`metafield: {namespace: String, key: String, type: String}`), the `type` key would
+ * be read as the type of `metafield` itself and the whole path would become a String.
+ */
+declare const GroupSyncRuleMetafield: Schema<any, import("mongoose").Model<any, any, any, any, any, any, any>, {}, {}, {}, {}, import("mongoose").DefaultSchemaOptions, Record<string, any>, import("mongoose").Document<unknown, {}, Record<string, any>, {
+    id: string;
+}, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & Omit<Record<string, any> & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}, "id"> & {
+    id: string;
+}, {
+    [path: string]: import("mongoose").SchemaDefinitionProperty<undefined, any, any>;
+} | {
+    [x: string]: import("mongoose").SchemaDefinitionProperty<any, any, import("mongoose").Document<unknown, {}, Record<string, any>, {
+        id: string;
+    }, import("mongoose").ResolveSchemaOptions<import("mongoose").DefaultSchemaOptions>> & Omit<Record<string, any> & Required<{
+        _id: unknown;
+    }> & {
+        __v: number;
+    }, "id"> & {
+        id: string;
+    }> | undefined;
+}, {
+    [x: string]: any;
+} & Required<{
+    _id: unknown;
+}> & {
+    __v: number;
+}>;
+export = GroupSyncRuleMetafield;
+//# sourceMappingURL=GroupSyncRuleMetafield.d.ts.map

package/dist/schemas/types/GroupSyncRuleMetafield.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupSyncRuleMetafield.d.ts","sourceRoot":"","sources":["../../../src/schemas/types/GroupSyncRuleMetafield.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,UAAU,CAAA;AAC/B;;;;;;;GAOG;AACH,QAAA,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;EA4B1B,CAAA;AAEF,SAAS,sBAAsB,CAAA"}

package/dist/schemas/types/GroupSyncRuleMetafield.js

@@ -0,0 +1,38 @@
+"use strict";
+const mongoose_1 = require("mongoose");
+/**
+ * Embedded target of a `GroupSyncRule` whose `type` is 'metafield': the Shopify
+ * product metafield the rule writes the group field's value into.
+ *
+ * Keep this a separate Schema. Inlined into the parent as a plain object
+ * (`metafield: {namespace: String, key: String, type: String}`), the `type` key would
+ * be read as the type of `metafield` itself and the whole path would become a String.
+ */
+const GroupSyncRuleMetafield = new mongoose_1.Schema({
+    _id: false,
+    /** Shopify metafield namespace, e.g. 'custom' */
+    namespace: {
+        type: String,
+        trim: true,
+        required: true,
+    },
+    /** Shopify metafield key within the namespace, e.g. 'design_title' */
+    key: {
+        type: String,
+        trim: true,
+        required: true,
+    },
+    /**
+     * Shopify metafield type, e.g. 'single_line_text_field' or 'list.single_line_text_field'.
+     * Typed in by the admin; deliberately not an enum and not checked against the store's
+     * metafield definitions, so a wrong type only surfaces as a Shopify error when the
+     * rule is applied.
+     */
+    type: {
+        type: String,
+        trim: true,
+        required: true,
+    },
+});
+module.exports = GroupSyncRuleMetafield;
+//# sourceMappingURL=GroupSyncRuleMetafield.js.map

package/dist/schemas/types/GroupSyncRuleMetafield.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GroupSyncRuleMetafield.js","sourceRoot":"","sources":["../../../src/schemas/types/GroupSyncRuleMetafield.ts"],"names":[],"mappings":";AAAA,uCAA+B;AAC/B;;;;;;;GAOG;AACH,MAAM,sBAAsB,GAAG,IAAI,iBAAM,CAAsB;IAC3D,GAAG,EAAE,KAAK;IAEV,iDAAiD;IACjD,SAAS,EAAE;QACP,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,IAAI;KACjB;IAED,sEAAsE;IACtE,GAAG,EAAE;QACD,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,IAAI;KACjB;IAED;;;;;OAKG;IACH,IAAI,EAAE;QACF,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,IAAI;KACjB;CACJ,CAAC,CAAA;AAEF,iBAAS,sBAAsB,CAAA"}

package/dist/types.d.ts

@@ -15,11 +15,13 @@ export type { IFulfillment } from './interfaces/Fulfillment';
 export type { IGroup } from './interfaces/Group';
 export type { IGroupArtwork } from './interfaces/GroupArtwork';
 export type { IGroupItem } from './interfaces/GroupItem';
+export type { IGroupSyncRule } from './interfaces/GroupSyncRule';
 export type { IImage } from './interfaces/Image';
 export type { IImageObject } from './interfaces/ImageObject';
 export type { ILatestEvent } from './interfaces/LatestEvent';
 export type { ILogURL } from './interfaces/LogURL';
 export type { IMarketingCost } from './interfaces/MarketingCost';
+export type { IMarketingCostRaw } from './interfaces/MarketingCostRaw';
 export type { IMedia } from './interfaces/Media';
 export type { IMediaUpload } from './interfaces/MediaUpload';
 export type { IMenu } from './interfaces/Menu';
@@ -68,6 +70,7 @@ export type { IFacebookObject } from './interfaces/types/FacebookObject';
 export type { IFooterSetting } from './interfaces/types/FooterSetting';
 export type { IFreeShippingSetting } from './interfaces/types/FreeShippingSetting';
 export type { IGoogleAnalytics } from './interfaces/types/GoogleAnalytics';
+export type { IGroupSyncRuleMetafield } from './interfaces/types/GroupSyncRuleMetafield';
 export type { IKlaviyoObject } from './interfaces/types/KlaviyoObject';
 export type { IMerchizeSettings } from './interfaces/types/MerchizeSettings';
 export type { ISocialsObject } from './interfaces/types/SocialsObject';

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,YAAY,EAAC,QAAQ,EAAC,MAAM,sBAAsB,CAAA;AAClD,YAAY,EAAC,gBAAgB,EAAC,MAAM,8BAA8B,CAAA;AAClE,YAAY,EAAC,QAAQ,EAAC,MAAM,sBAAsB,CAAA;AAClD,YAAY,EAAC,gBAAgB,EAAC,MAAM,8BAA8B,CAAA;AAClE,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAA;AACtD,YAAY,EAAC,gBAAgB,EAAC,MAAM,8BAA8B,CAAA;AAClE,YAAY,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAA;AACtD,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAA;AAC5D,YAAY,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAA;AAC5D,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAA;AAC9C,YAAY,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAA;AAC5D,YAAY,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAA;AACtD,YAAY,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAA;AAC9C,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,OAAO,EAAC,MAAM,qBAAqB,CAAA;AAChD,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAA;AAC9C,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,KAAK,EAAC,MAAM,mBAAmB,CAAA;AAC5C,YAAY,EAAC,SAAS,EAAC,MAAM,uBAAuB,CAAA;AACpD,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAA;AAC9C,YAAY,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAA;AACtD,YAAY,EAAC,OAAO,EAAC,MAAM,qBAAqB,CAAA;AAChD,YAAY,EAAC,KAAK,EAAC,MAAM,mBAAmB,CAAA;AAC5C,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,gBAAgB,EAAC,MAAM,8BAA8B,CAAA;AAClE,YAAY,EAAC,QAAQ,EAAC,MAAM,sBAAsB,CAAA;AAClD,YAAY,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAA;AAChE,YAAY,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAA;AAC5D,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAA;AAChE,YAAY,EAAC,OAAO,EAAC,MAAM,qBAAqB,CAAA;AAChD,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,KAAK,EAAC,MAAM,mBAAmB,CAAA;AAC5C,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,kBAAkB,EAAC,MAAM,gCAAgC,CAAA;AACtE,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,SAAS,EAAC,MAAM,uBAAuB,CAAA;AACpD,YAAY,EAAC,SAAS,EAAC,MAAM,uBAAuB,CAAA;AACpD,YAAY,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAA;AAC9C,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAA;AAC5D,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAA;AACtD,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,KAAK,EAAC,MAAM,mBAAmB,CAAA;AAC5C,YAAY,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAA;AAC5D,YAAY,EAAC,YAAY,EAAC,MAAM,mCAAmC,CAAA;AACnE,YAAY,EAAC,UAAU,EAAC,MAAM,iCAAiC,CAAA;AAC/D,YAAY,EAAC,YAAY,EAAC,MAAM,mCAAmC,CAAA;AACnE,YAAY,EAAC,cAAc,EAAC,MAAM,kCAAkC,CAAA;AACpE,YAAY,EAAC,YAAY,EAAC,MAAM,gCAAgC,CAAA;AAChE,YAAY,EAAC,eAAe,EAAC,MAAM,mCAAmC,CAAA;AACtE,YAAY,EAAC,cAAc,EAAC,MAAM,kCAAkC,CAAA;AACpE,YAAY,EAAC,oBAAoB,EAAC,MAAM,wCAAwC,CAAA;AAChF,YAAY,EAAC,gBAAgB,EAAC,MAAM,oCAAoC,CAAA;AACxE,YAAY,EAAC,cAAc,EAAC,MAAM,kCAAkC,CAAA;AACpE,YAAY,EAAC,iBAAiB,EAAC,MAAM,qCAAqC,CAAA;AAC1E,YAAY,EAAC,cAAc,EAAC,MAAM,kCAAkC,CAAA;AACpE,YAAY,EAAC,eAAe,EAAC,MAAM,mCAAmC,CAAA;AACtE,YAAY,EAAC,iBAAiB,EAAC,MAAM,qCAAqC,CAAA"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,YAAY,EAAC,QAAQ,EAAC,MAAM,sBAAsB,CAAA;AAClD,YAAY,EAAC,gBAAgB,EAAC,MAAM,8BAA8B,CAAA;AAClE,YAAY,EAAC,QAAQ,EAAC,MAAM,sBAAsB,CAAA;AAClD,YAAY,EAAC,gBAAgB,EAAC,MAAM,8BAA8B,CAAA;AAClE,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAA;AACtD,YAAY,EAAC,gBAAgB,EAAC,MAAM,8BAA8B,CAAA;AAClE,YAAY,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAA;AACtD,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAA;AAC5D,YAAY,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAA;AAC5D,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAA;AAC9C,YAAY,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAA;AAC5D,YAAY,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAA;AACtD,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAA;AAC9C,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,OAAO,EAAC,MAAM,qBAAqB,CAAA;AAChD,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,iBAAiB,EAAC,MAAM,+BAA+B,CAAA;AACpE,YAAY,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAA;AAC9C,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,KAAK,EAAC,MAAM,mBAAmB,CAAA;AAC5C,YAAY,EAAC,SAAS,EAAC,MAAM,uBAAuB,CAAA;AACpD,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAA;AAC9C,YAAY,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAA;AACtD,YAAY,EAAC,OAAO,EAAC,MAAM,qBAAqB,CAAA;AAChD,YAAY,EAAC,KAAK,EAAC,MAAM,mBAAmB,CAAA;AAC5C,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,gBAAgB,EAAC,MAAM,8BAA8B,CAAA;AAClE,YAAY,EAAC,QAAQ,EAAC,MAAM,sBAAsB,CAAA;AAClD,YAAY,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAA;AAChE,YAAY,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAA;AAC5D,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAA;AAChE,YAAY,EAAC,OAAO,EAAC,MAAM,qBAAqB,CAAA;AAChD,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,KAAK,EAAC,MAAM,mBAAmB,CAAA;AAC5C,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,kBAAkB,EAAC,MAAM,gCAAgC,CAAA;AACtE,YAAY,EAAC,cAAc,EAAC,MAAM,4BAA4B,CAAA;AAC9D,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,SAAS,EAAC,MAAM,uBAAuB,CAAA;AACpD,YAAY,EAAC,SAAS,EAAC,MAAM,uBAAuB,CAAA;AACpD,YAAY,EAAC,MAAM,EAAC,MAAM,oBAAoB,CAAA;AAC9C,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAA;AAC5D,YAAY,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAA;AACxD,YAAY,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAA;AACtD,YAAY,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAA;AAC1D,YAAY,EAAC,KAAK,EAAC,MAAM,mBAAmB,CAAA;AAC5C,YAAY,EAAC,aAAa,EAAC,MAAM,2BAA2B,CAAA;AAC5D,YAAY,EAAC,YAAY,EAAC,MAAM,mCAAmC,CAAA;AACnE,YAAY,EAAC,UAAU,EAAC,MAAM,iCAAiC,CAAA;AAC/D,YAAY,EAAC,YAAY,EAAC,MAAM,mCAAmC,CAAA;AACnE,YAAY,EAAC,cAAc,EAAC,MAAM,kCAAkC,CAAA;AACpE,YAAY,EAAC,YAAY,EAAC,MAAM,gCAAgC,CAAA;AAChE,YAAY,EAAC,eAAe,EAAC,MAAM,mCAAmC,CAAA;AACtE,YAAY,EAAC,cAAc,EAAC,MAAM,kCAAkC,CAAA;AACpE,YAAY,EAAC,oBAAoB,EAAC,MAAM,wCAAwC,CAAA;AAChF,YAAY,EAAC,gBAAgB,EAAC,MAAM,oCAAoC,CAAA;AACxE,YAAY,EAAC,uBAAuB,EAAC,MAAM,2CAA2C,CAAA;AACtF,YAAY,EAAC,cAAc,EAAC,MAAM,kCAAkC,CAAA;AACpE,YAAY,EAAC,iBAAiB,EAAC,MAAM,qCAAqC,CAAA;AAC1E,YAAY,EAAC,cAAc,EAAC,MAAM,kCAAkC,CAAA;AACpE,YAAY,EAAC,eAAe,EAAC,MAAM,mCAAmC,CAAA;AACtE,YAAY,EAAC,iBAAiB,EAAC,MAAM,qCAAqC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pintahub/database-schemas",
-  "version": "6.16.0",
+  "version": "6.18.0",
   "description": "Pintahub MongoDB schemas (TypeScript). Compatible with both schemis (CJS) and schemas-ts (ESM) resolvers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",