@ninetailed/experience.js-utils-contentful 2.0.0-beta.10

package/README.md

@@ -0,0 +1,11 @@
+# utils-contentful
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build utils-contentful` to build the library.
+
+## Running unit tests
+
+Run `nx test utils-contentful` to execute the unit tests via [Jest](https://jestjs.io).

package/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@ninetailed/experience.js-utils-contentful",
+  "version": "2.0.0-beta.10",
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts"
+}

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types';
+export { AudienceMapper, ExperienceMapper } from './lib';

package/src/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExperienceMapper = exports.AudienceMapper = void 0;
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./types"), exports);
+var lib_1 = require("./lib");
+Object.defineProperty(exports, "AudienceMapper", { enumerable: true, get: function () { return lib_1.AudienceMapper; } });
+Object.defineProperty(exports, "ExperienceMapper", { enumerable: true, get: function () { return lib_1.ExperienceMapper; } });
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/utils/contentful/src/index.ts"],"names":[],"mappings":";;;;AAAA,uDAAwB;AACxB,6BAAyD;AAAhD,qGAAA,cAAc,OAAA;AAAE,uGAAA,gBAAgB,OAAA"}

package/src/lib/AudienceMapper.d.ts

@@ -0,0 +1,6 @@
+import { AudienceEntry } from '../types/AudienceEntry';
+export declare class AudienceMapper {
+    static mapAudience(audience: AudienceEntry): {
+        id: string;
+    };
+}

package/src/lib/AudienceMapper.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AudienceMapper = void 0;
+class AudienceMapper {
+    static mapAudience(audience) {
+        return {
+            id: audience.sys.id,
+        };
+    }
+}
+exports.AudienceMapper = AudienceMapper;
+//# sourceMappingURL=AudienceMapper.js.map

package/src/lib/AudienceMapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AudienceMapper.js","sourceRoot":"","sources":["../../../../../../packages/utils/contentful/src/lib/AudienceMapper.ts"],"names":[],"mappings":";;;AAEA,MAAa,cAAc;IACzB,MAAM,CAAC,WAAW,CAAC,QAAuB;QACxC,OAAO;YACL,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE;SACpB,CAAC;IACJ,CAAC;CACF;AAND,wCAMC"}

package/src/lib/ExperienceMapper.d.ts

@@ -0,0 +1,19 @@
+import { Baseline, Variant, ExperienceConfiguration } from '@ninetailed/experience.js';
+import { Entry } from 'contentful';
+import { ExperienceEntry } from '../types';
+import { BaselineWithExperiencesEntry } from '../types/BaselineWithExperiencesEntry';
+declare type MapVariantOptions = {
+    hidden: boolean;
+};
+declare type MapBaseline<BaselineType = Entry<unknown>> = (baseline: BaselineType) => Baseline;
+declare type MapVariant<VariantType = Entry<unknown>> = (variant: VariantType, options: MapVariantOptions) => Variant;
+declare type MapExperienceOptions<BaselineType = Entry<unknown>, VariantType = Entry<unknown>> = {
+    mapBaseline?: MapBaseline<BaselineType>;
+    mapVariant?: MapVariant<VariantType>;
+};
+export declare class ExperienceMapper {
+    static mapExperience<BaselineType = Entry<unknown>>(entry: ExperienceEntry, baseline: BaselineType, options?: MapExperienceOptions<BaselineType>): ExperienceConfiguration;
+    static mapExperiment(entry: ExperienceEntry): ExperienceConfiguration;
+    static mapBaselineWithExperiences(entry: BaselineWithExperiencesEntry): ExperienceConfiguration[];
+}
+export {};

package/src/lib/ExperienceMapper.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExperienceMapper = void 0;
+const AudienceMapper_1 = require("./AudienceMapper");
+const defaultMapBaseline = (baseline) => (Object.assign(Object.assign({}, baseline), { id: baseline.sys.id }));
+const defaultMapVariant = (variant, { hidden }) => (Object.assign(Object.assign({}, variant), { id: variant.sys.id, hidden: hidden }));
+class ExperienceMapper {
+    static mapExperience(entry, baseline, options) {
+        const _mapBaseline = ((options === null || options === void 0 ? void 0 : options.mapBaseline) ||
+            defaultMapBaseline);
+        const _mapVariant = (options === null || options === void 0 ? void 0 : options.mapVariant) || defaultMapVariant;
+        const config = Object.assign({ traffic: 0, distribution: [0.5, 0.5], components: [
+                {
+                    baseline: { id: '' },
+                    variants: [{ id: '', hidden: false }],
+                },
+            ] }, entry.fields.nt_config);
+        const variantReferences = (entry.fields.nt_variants || []).filter((variantReference) => !!variantReference);
+        return Object.assign(Object.assign({ id: entry.sys.id, type: entry.fields.nt_type }, (entry.fields.nt_audience
+            ? {
+                audience: AudienceMapper_1.AudienceMapper.mapAudience(entry.fields.nt_audience),
+            }
+            : {})), { trafficAllocation: config.traffic, distribution: config.distribution.map((percentage, index) => ({
+                index,
+                start: config.distribution.slice(0, index).reduce((a, b) => a + b, 0),
+                end: config.distribution.slice(0, index + 1).reduce((a, b) => a + b, 0),
+            })), components: config.components.map((component) => {
+                return {
+                    baseline: _mapBaseline(baseline),
+                    variants: component.variants
+                        .map((variant) => {
+                        const matchingVariant = variantReferences.find((variantReference) => variantReference.sys.id === variant.id);
+                        if (!matchingVariant) {
+                            return null;
+                        }
+                        return _mapVariant(matchingVariant, { hidden: variant.hidden });
+                    })
+                        .filter((variant) => variant !== null),
+                };
+            }) });
+    }
+    static mapExperiment(entry) {
+        return this.mapExperience(entry, null, {
+            mapBaseline: () => ({ id: '' }),
+            mapVariant: () => ({ id: '', hidden: false }),
+        });
+    }
+    static mapBaselineWithExperiences(entry) {
+        return entry.fields.nt_experiences.map((experience) => this.mapExperience(experience, entry));
+    }
+}
+exports.ExperienceMapper = ExperienceMapper;
+//# sourceMappingURL=ExperienceMapper.js.map

package/src/lib/ExperienceMapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExperienceMapper.js","sourceRoot":"","sources":["../../../../../../packages/utils/contentful/src/lib/ExperienceMapper.ts"],"names":[],"mappings":";;;AASA,qDAAkD;AAuBlD,MAAM,kBAAkB,GAAgC,CAAC,QAAQ,EAAE,EAAE,CAAC,iCACjE,QAAQ,KACX,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,EAAE,IACnB,CAAC;AAEH,MAAM,iBAAiB,GAA+B,CACpD,OAAO,EACP,EAAE,MAAM,EAAE,EACV,EAAE,CAAC,iCACA,OAAO,KACV,EAAE,EAAE,OAAO,CAAC,GAAG,CAAC,EAAE,EAClB,MAAM,EAAE,MAAM,IACd,CAAC;AAEH,MAAa,gBAAgB;IAC3B,MAAM,CAAC,aAAa,CAClB,KAAsB,EACtB,QAAsB,EACtB,OAA4C;QAE5C,MAAM,YAAY,GAAG,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW;YACxC,kBAAkB,CAA8B,CAAC;QACnD,MAAM,WAAW,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,UAAU,KAAI,iBAAiB,CAAC;QAE7D,MAAM,MAAM,mBACV,OAAO,EAAE,CAAC,EACV,YAAY,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,EACxB,UAAU,EAAE;gBACV;oBACE,QAAQ,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;oBACpB,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;iBACtC;aACF,IACE,KAAK,CAAC,MAAM,CAAC,SAAS,CAC1B,CAAC;QACF,MAAM,iBAAiB,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,MAAM,CAC/D,CAAC,gBAAgB,EAAsC,EAAE,CACvD,CAAC,CAAC,gBAAgB,CACrB,CAAC;QAEF,qCACE,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,EAChB,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,OAAyB,IACzC,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW;YAC1B,CAAC,CAAC;gBACE,QAAQ,EAAE,+BAAc,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC;aAC/D;YACH,CAAC,CAAC,EAAE,CAAC,KACP,iBAAiB,EAAE,MAAM,CAAC,OAAO,EACjC,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;gBAC5D,KAAK;gBACL,KAAK,EAAE,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBACrE,GAAG,EAAE,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;aACxE,CAAC,CAAC,EACH,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE;gBAC9C,OAAO;oBACL,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC;oBAChC,QAAQ,EAAE,SAAS,CAAC,QAAQ;yBACzB,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;wBACf,MAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAC5C,CAAC,gBAAgB,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,KAAK,OAAO,CAAC,EAAE,CAC7D,CAAC;wBAEF,IAAI,CAAC,eAAe,EAAE;4BACpB,OAAO,IAAI,CAAC;yBACb;wBAED,OAAO,WAAW,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;oBAClE,CAAC,CAAC;yBACD,MAAM,CAAC,CAAC,OAAO,EAAsB,EAAE,CAAC,OAAO,KAAK,IAAI,CAAC;iBAC7D,CAAC;YACJ,CAAC,CAAC,IACF;IACJ,CAAC;IAED,MAAM,CAAC,aAAa,CAAC,KAAsB;QACzC,OAAO,IAAI,CAAC,aAAa,CAAO,KAAK,EAAE,IAAI,EAAE;YAC3C,WAAW,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC;YAC/B,UAAU,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;SAC9C,CAAC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,0BAA0B,CAC/B,KAAmC;QAEnC,OAAO,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CACpD,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,KAAK,CAAC,CACtC,CAAC;IACJ,CAAC;CACF;AA3ED,4CA2EC"}

package/src/lib/index.d.ts

@@ -0,0 +1,2 @@
+export { AudienceMapper } from './AudienceMapper';
+export { ExperienceMapper } from './ExperienceMapper';

package/src/lib/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExperienceMapper = exports.AudienceMapper = void 0;
+var AudienceMapper_1 = require("./AudienceMapper");
+Object.defineProperty(exports, "AudienceMapper", { enumerable: true, get: function () { return AudienceMapper_1.AudienceMapper; } });
+var ExperienceMapper_1 = require("./ExperienceMapper");
+Object.defineProperty(exports, "ExperienceMapper", { enumerable: true, get: function () { return ExperienceMapper_1.ExperienceMapper; } });
+//# sourceMappingURL=index.js.map

package/src/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/utils/contentful/src/lib/index.ts"],"names":[],"mappings":";;;AAAA,mDAAkD;AAAzC,gHAAA,cAAc,OAAA;AACvB,uDAAsD;AAA7C,oHAAA,gBAAgB,OAAA"}

package/src/types/AudienceEntry.d.ts

@@ -0,0 +1,12 @@
+import { Entry, EntryFields } from 'contentful';
+export declare type AudienceFields = {
+    /**
+     * The name of the audience (Short Text)
+     */
+    nt_name: EntryFields.Symbol;
+    /**
+     * The internal id of the audience (Short Text)
+     */
+    nt_audience_id: EntryFields.Symbol;
+};
+export declare type AudienceEntry = Entry<AudienceFields>;

package/src/types/AudienceEntry.js

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

package/src/types/AudienceEntry.js.map

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

package/src/types/BaselineWithExperiencesEntry.d.ts

@@ -0,0 +1,7 @@
+import { Entry } from 'contentful';
+import { ExperienceEntry } from './ExperienceEntry';
+declare type BaselineWithExperiencesFields<T> = T & {
+    nt_experiences: ExperienceEntry[];
+};
+export declare type BaselineWithExperiencesEntry<T = unknown> = Entry<BaselineWithExperiencesFields<T>>;
+export {};

package/src/types/BaselineWithExperiencesEntry.js

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

package/src/types/BaselineWithExperiencesEntry.js.map

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

package/src/types/ExperienceEntry.d.ts

@@ -0,0 +1,32 @@
+import { Distribution, BaselineWithVariants } from '@ninetailed/experience.js';
+import { Entry, EntryFields } from 'contentful';
+import { AudienceEntry } from './AudienceEntry';
+declare type Config = {
+    scatteredDistribution: Distribution[];
+    traffic: number;
+    components: BaselineWithVariants[];
+};
+declare type ExperienceFields<VariantEntry extends Entry<unknown> = Entry<unknown>> = {
+    /**
+     * The name of the experience (Short Text)
+     */
+    nt_name: EntryFields.Symbol;
+    /**
+     * The type if the experience (nt_experiment | nt_personalization)
+     */
+    nt_type: EntryFields.Symbol;
+    /**
+     * The config of the experience (JSON)
+     */
+    nt_config?: EntryFields.Object<Config>;
+    /**
+     * The audience of the experience (Audience)
+     */
+    nt_audience?: AudienceEntry;
+    /**
+     * All used variants of the experience (Contentful references to other Content Types)
+     */
+    nt_variants?: VariantEntry[];
+};
+export declare type ExperienceEntry = Entry<ExperienceFields>;
+export {};

package/src/types/ExperienceEntry.js

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

package/src/types/ExperienceEntry.js.map

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

package/src/types/index.d.ts

@@ -0,0 +1,2 @@
+export type { AudienceEntry } from './AudienceEntry';
+export type { ExperienceEntry } from './ExperienceEntry';

package/src/types/index.js

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

package/src/types/index.js.map

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