@ninetailed/experience.js-utils 7.20.5 → 7.21.0

package/index.cjs.js

@@ -67,17 +67,17 @@ const Variant = zod.z.object({
   id: zod.z.string()
 }).catchall(zod.z.unknown());
 
-/**
- * Zod helper for parsing arrays and ignore items not specified in the schema
- *
- * @param zodUnion - union of known types
- *
- * @example
- * const binaryArraySchema = arrayIgnoreUnknown(z.union([z.literal('0'), z.literal('1')]))
- * type BinaryArray = z.TypeOf<typeof binaryArraySchema>
- *
- * const binaryArray: BinaryArray = binaryArraySchema.parse(['0', '1', '2', '0'])
- * console.log(binaryArray) // ['0', '1', '0']
+/**
+ * Zod helper for parsing arrays and ignore items not specified in the schema
+ *
+ * @param zodUnion - union of known types
+ *
+ * @example
+ * const binaryArraySchema = arrayIgnoreUnknown(z.union([z.literal('0'), z.literal('1')]))
+ * type BinaryArray = z.TypeOf<typeof binaryArraySchema>
+ *
+ * const binaryArray: BinaryArray = binaryArraySchema.parse(['0', '1', '2', '0'])
+ * console.log(binaryArray) // ['0', '1', '0']
  */
 function zodArrayIgnoreUnknown(zodType) {
   const isKnownItem = item => zodType.safeParse(item).success;
@@ -94,33 +94,33 @@ function isArray(item) {
 }
 
 const ExperienceSchema = zod.z.object({
-  /**
-   * The experience's ID from the Experience API's standpoint.
-   * It maps to the `nt_experience_id` field on the Ninetailed Experience entry in Contentful.
+  /**
+   * The experience's ID from the Experience API's standpoint.
+   * It maps to the `nt_experience_id` field on the Ninetailed Experience entry in Contentful.
    */
   id: zod.z.string(),
-  /**
-   * The name of the experience (Short Text)
+  /**
+   * The name of the experience (Short Text)
    */
   name: zod.z.string(),
-  /**
-   * The description of the experience (Short Text)
+  /**
+   * The description of the experience (Short Text)
    */
   description: zod.z.string().optional(),
-  /**
-   * The type if the experience (nt_experiment | nt_personalization)
+  /**
+   * The type if the experience (nt_experiment | nt_personalization)
    */
   type: zod.z.union([zod.z.string().regex(/^nt_experiment$/g), zod.z.string().regex(/^nt_personalization$/g)]),
-  /**
-   * The config of the experience (JSON)
+  /**
+   * The config of the experience (JSON)
    */
   config: Config.default({}),
-  /**
-   * The audience of the experience (Audience)
+  /**
+   * The audience of the experience (Audience)
    */
   audience: Audience.optional().nullable(),
-  /**
-   * All used variants of the experience (References to other Content Types)
+  /**
+   * All used variants of the experience (References to other Content Types)
    */
   variants: zodArrayIgnoreUnknown(Variant).default([])
 });

package/index.esm.js

@@ -65,17 +65,17 @@ const Variant = z.object({
   id: z.string()
 }).catchall(z.unknown());
 
-/**
- * Zod helper for parsing arrays and ignore items not specified in the schema
- *
- * @param zodUnion - union of known types
- *
- * @example
- * const binaryArraySchema = arrayIgnoreUnknown(z.union([z.literal('0'), z.literal('1')]))
- * type BinaryArray = z.TypeOf<typeof binaryArraySchema>
- *
- * const binaryArray: BinaryArray = binaryArraySchema.parse(['0', '1', '2', '0'])
- * console.log(binaryArray) // ['0', '1', '0']
+/**
+ * Zod helper for parsing arrays and ignore items not specified in the schema
+ *
+ * @param zodUnion - union of known types
+ *
+ * @example
+ * const binaryArraySchema = arrayIgnoreUnknown(z.union([z.literal('0'), z.literal('1')]))
+ * type BinaryArray = z.TypeOf<typeof binaryArraySchema>
+ *
+ * const binaryArray: BinaryArray = binaryArraySchema.parse(['0', '1', '2', '0'])
+ * console.log(binaryArray) // ['0', '1', '0']
  */
 function zodArrayIgnoreUnknown(zodType) {
   const isKnownItem = item => zodType.safeParse(item).success;
@@ -92,33 +92,33 @@ function isArray(item) {
 }
 
 const ExperienceSchema = z.object({
-  /**
-   * The experience's ID from the Experience API's standpoint.
-   * It maps to the `nt_experience_id` field on the Ninetailed Experience entry in Contentful.
+  /**
+   * The experience's ID from the Experience API's standpoint.
+   * It maps to the `nt_experience_id` field on the Ninetailed Experience entry in Contentful.
    */
   id: z.string(),
-  /**
-   * The name of the experience (Short Text)
+  /**
+   * The name of the experience (Short Text)
    */
   name: z.string(),
-  /**
-   * The description of the experience (Short Text)
+  /**
+   * The description of the experience (Short Text)
    */
   description: z.string().optional(),
-  /**
-   * The type if the experience (nt_experiment | nt_personalization)
+  /**
+   * The type if the experience (nt_experiment | nt_personalization)
    */
   type: z.union([z.string().regex(/^nt_experiment$/g), z.string().regex(/^nt_personalization$/g)]),
-  /**
-   * The config of the experience (JSON)
+  /**
+   * The config of the experience (JSON)
    */
   config: Config.default({}),
-  /**
-   * The audience of the experience (Audience)
+  /**
+   * The audience of the experience (Audience)
    */
   audience: Audience.optional().nullable(),
-  /**
-   * All used variants of the experience (References to other Content Types)
+  /**
+   * All used variants of the experience (References to other Content Types)
    */
   variants: zodArrayIgnoreUnknown(Variant).default([])
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ninetailed/experience.js-utils",
-  "version": "7.20.5",
+  "version": "7.21.0",
   "description": "Ninetailed Experience.js Utils",
   "license": "MIT",
   "repository": {
@@ -22,8 +22,8 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@ninetailed/experience.js": "7.20.5",
-    "@ninetailed/experience.js-shared": "7.20.5",
+    "@ninetailed/experience.js": "7.21.0",
+    "@ninetailed/experience.js-shared": "7.21.0",
     "zod": "3.23.0"
   }
 }

package/src/index.d.ts

@@ -1,11 +1,11 @@
-export { ExperienceMapper } from './lib/ExperienceMapper';
-export { Audience } from './types/Audience';
-export { Config } from './types/Config';
-export { Experience } from './types/Experience';
-export { Experiment } from './types/Experiment';
-export { Variant } from './types/Variant';
-export type { AudienceLike } from './types/Audience';
-export type { ConfigLike } from './types/Config';
-export type { ExperienceLike } from './types/Experience';
-export type { ExperimentLike } from './types/Experiment';
-export type { VariantLike } from './types/Variant';
+export { ExperienceMapper } from './lib/ExperienceMapper';
+export { Audience } from './types/Audience';
+export { Config } from './types/Config';
+export { Experience } from './types/Experience';
+export { Experiment } from './types/Experiment';
+export { Variant } from './types/Variant';
+export type { AudienceLike } from './types/Audience';
+export type { ConfigLike } from './types/Config';
+export type { ExperienceLike } from './types/Experience';
+export type { ExperimentLike } from './types/Experiment';
+export type { VariantLike } from './types/Variant';

package/src/lib/ExperienceMapper.d.ts

@@ -1,9 +1,9 @@
-import { ExperienceConfiguration, Reference } from '@ninetailed/experience.js';
-import { Experience, ExperienceLike } from '../types/Experience';
-import { ExperimentLike } from '../types/Experiment';
-export declare class ExperienceMapper {
-    static isExperienceEntry<Variant extends Reference>(experience: ExperienceLike<Variant>): experience is Experience<Variant>;
-    static mapExperience<Variant extends Reference>(experience: ExperienceLike<Variant>): ExperienceConfiguration<Variant>;
-    static isExperimentEntry<Variant extends Reference>(experiment: ExperimentLike<Variant>): experiment is ExperimentLike<Variant>;
-    static mapExperiment<Variant extends Reference>(experiment: ExperimentLike<Variant>): ExperienceConfiguration<Variant>;
-}
+import { ExperienceConfiguration, Reference } from '@ninetailed/experience.js-shared';
+import { Experience, ExperienceLike } from '../types/Experience';
+import { ExperimentLike } from '../types/Experiment';
+export declare class ExperienceMapper {
+    static isExperienceEntry<Variant extends Reference>(experience: ExperienceLike<Variant>): experience is Experience<Variant>;
+    static mapExperience<Variant extends Reference>(experience: ExperienceLike<Variant>): ExperienceConfiguration<Variant>;
+    static isExperimentEntry<Variant extends Reference>(experiment: ExperimentLike<Variant>): experiment is ExperimentLike<Variant>;
+    static mapExperiment<Variant extends Reference>(experiment: ExperimentLike<Variant>): ExperienceConfiguration<Variant>;
+}

package/src/types/Audience.d.ts

@@ -1,16 +1,16 @@
-import { z } from 'zod';
-export declare const Audience: z.ZodObject<{
-    id: z.ZodString;
-    name: z.ZodOptional<z.ZodString>;
-    description: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    id: string;
-    name?: string | undefined;
-    description?: string | undefined;
-}, {
-    id: string;
-    name?: string | undefined;
-    description?: string | undefined;
-}>;
-export type AudienceLike = z.input<typeof Audience>;
-export type Audience = z.infer<typeof Audience>;
+import { z } from 'zod';
+export declare const Audience: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodOptional<z.ZodString>;
+    description: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    name?: string | undefined;
+    description?: string | undefined;
+}, {
+    id: string;
+    name?: string | undefined;
+    description?: string | undefined;
+}>;
+export type AudienceLike = z.input<typeof Audience>;
+export type Audience = z.infer<typeof Audience>;