@constructor-io/constructorio-node 4.3.0 → 4.3.1

package/src/types/tests/browse.test-d.ts

@@ -0,0 +1,120 @@
+import { expectAssignable } from 'tsd';
+import { GetBrowseResultsResponse } from '../browse';
+
+expectAssignable<GetBrowseResultsResponse>({
+  response: {
+    result_sources: {
+      token_match: {
+        count: 19,
+      },
+      embeddings_match: {
+        count: 0,
+      },
+    },
+    facets: [
+      {
+        display_name: 'pet',
+        name: 'pet',
+        type: 'multiple',
+        options: [
+          {
+            status: 'selected',
+            count: 12,
+            display_name: 'dog',
+            value: 'dog',
+            data: {},
+          },
+        ],
+        hidden: false,
+        data: {},
+      },
+    ],
+    results: [
+      {
+        matched_terms: [],
+        data: {
+          id: '123',
+          url: 'https://example',
+          brand: 'Bravecto',
+          price: 21.99,
+          item_name: 'Name',
+          image_url: 'https://example',
+          published: true,
+          variation_id: '123',
+        },
+        value: 'Name',
+        is_slotted: false,
+        labels: {},
+        variations: [
+          {
+            data: {
+              brand_slug: '123',
+              variation_id: '123',
+            },
+            value: '123',
+          },
+        ],
+      },
+    ],
+    sort_options: [
+      {
+        sort_by: 'item_name',
+        display_name: 'A - Z',
+        sort_order: 'descending',
+        status: '',
+      },
+    ],
+    refined_content: [],
+    total_num_results: 19,
+    features: [
+      {
+        feature_name: 'auto_generated_refined_query_rules',
+        display_name: 'Affinity Engine',
+        enabled: true,
+        variant: {
+          name: 'default_rules',
+          display_name: 'Default weights',
+        },
+      },
+    ],
+  },
+  result_id: 'e5941e13-f4ca-4efb-9326-893fd49b4e71',
+  request: {
+    page: 1,
+    num_results_per_page: 24,
+    filters: {
+      pet: ['dog', 'dog_&_cat'],
+      type: ['flea_&_tick'],
+    },
+    sort_by: 'relevance',
+    sort_order: 'descending',
+    browse_filter_name: 'group_id',
+    browse_filter_value: '123',
+    term: '',
+    fmt_options: {
+      groups_start: 'current',
+      groups_max_depth: 1,
+    },
+    section: 'Products',
+    features: {
+      query_items: true,
+      auto_generated_refined_query_rules: true,
+      manual_searchandizing: true,
+      personalization: true,
+      filter_items: true,
+    },
+    feature_variants: {
+      query_items: 'query_items_ctr_and_l2r',
+      auto_generated_refined_query_rules: 'default_rules',
+      manual_searchandizing: null,
+      personalization: 'default_personalization',
+      filter_items: 'filter_items_w_and_purchases',
+    },
+    filter_match_types: {
+      pet: 'any',
+      type: 'any',
+    },
+    searchandized_items: {},
+  },
+  ad_based: true,
+});

package/src/types/tests/catalog.test-d.ts

@@ -0,0 +1,109 @@
+import { expectAssignable } from 'tsd';
+import {
+  FacetConfiguration,
+  FacetOptionConfiguration,
+  Item,
+  ItemGroup,
+  OneWaySynonymRelation,
+  RedirectRuleResponse,
+  Variation,
+} from '..';
+
+expectAssignable<Item>({
+  id: 'itemId',
+  name: 'Blue Shirt',
+  suggested_score: -1,
+  data: {
+    url: 'https://example.o',
+    facets: {
+      brand: ['Etch'],
+    },
+    group_ids: ['AP01', 'W676714', 'W678024'],
+    deactivated: false,
+    description: 'description',
+    topLevelCategory: 'Clearance',
+  },
+});
+
+expectAssignable<Variation>({
+  item_id: '728131de-e50a-4c95-adc3-9b8a37a426fb',
+  id: '01e17a49-8984-4bee-b137-a0b4e7f84d00',
+  name: 'product-01e17a49-8984-4bee-b137-a0b4e7f84d00',
+  suggested_score: -1,
+  data: {
+    url: 'https://constructor.io/products/',
+    brand: 'abc',
+    facets: {
+      color: ['blue'],
+    },
+    image_url: 'https://constructor.io/products/',
+    deactivated: false,
+    complexMetadataField: {
+      key1: 'val1',
+      key2: 'val2',
+    },
+  },
+});
+
+expectAssignable<ItemGroup>({
+  name: 'Group 433b2ba0-098e-447f-b772-8add363216eb',
+  id: 'group-433b2ba0-098e-447f-b772-8add363216eb',
+  data: null,
+  children: [],
+});
+
+expectAssignable<OneWaySynonymRelation>({
+  parent_phrase: 'phrase-1ac335a9-9cf4-4f21-b572-2a2aef27a192',
+  child_phrases: [
+    {
+      automatically_generated: false,
+      phrase: 'phrase-cddace02-02b4-462f-b8ed-cea41a18a8da',
+      created_at: '2022-12-12T13:58:44',
+      updated_at: '2022-12-12T13:58:44',
+    },
+  ],
+});
+
+expectAssignable<RedirectRuleResponse>({
+  id: 42492,
+  start_time: null,
+  end_time: null,
+  url: 'http://www.461c999c-365a-4925-89a2-2848b11cba2f.com',
+  user_segments: null,
+  metadata: null,
+  last_updated: '2022-12-14T22:44:32',
+  matches: [
+    {
+      id: 146617,
+      pattern: '461c999c-365a-4925-89a2-2848b11cba2f',
+      match_type: 'EXACT',
+    },
+  ],
+});
+
+expectAssignable<FacetConfiguration>({
+  name: 'facet-f664731d-9d84-4e82-bd2b-8528bb12d670',
+  display_name: 'Facet f664731d-9d84-4e82-bd2b-8528bb12d670',
+  sort_order: 'relevance',
+  sort_descending: true,
+  type: 'multiple',
+  range_type: null,
+  range_format: null,
+  range_inclusive: null,
+  bucket_size: null,
+  range_limits: null,
+  match_type: 'any',
+  position: null,
+  hidden: false,
+  protected: false,
+  data: {},
+});
+
+expectAssignable<FacetOptionConfiguration>({
+  value: 'facet-option-9c8e604b-b780-4264-9be2-c587fdcd8c33',
+  value_alias: null,
+  display_name: 'Facet Option 9c8e604b-b780-4264-9be2-c587fdcd8c33',
+  position: null,
+  data: null,
+  hidden: false,
+});

package/src/types/tests/quizzes.test-d.ts

@@ -0,0 +1,82 @@
+import { expectAssignable } from 'tsd';
+import { QuizResultsResponse, NextQuestionResponse } from '..';
+
+expectAssignable<NextQuestionResponse>(
+  {
+    next_question: {
+      id: 2,
+      title: 'What do you want to ask',
+      description: 'Sample description',
+      type: 'multiple',
+      cta_text: 'Next',
+      images: {
+        primary_url: 'https://example.com/image',
+        primary_alt: 'Example image',
+        secondary_url: 'https://example.com/image',
+        secondary_alt: 'Example image',
+      },
+      options: [
+        {
+          id: 1,
+          value: 'Who',
+          attribute: {
+            name: 'group_id',
+            value: 'test-value',
+          },
+        },
+        {
+          id: 2,
+          value: 'What',
+          attribute: {
+            name: 'group_id',
+            value: 'test-value',
+          },
+        },
+      ],
+    },
+    version_id: '11db5ac7-67e1-4000-9000-414d8425cab3',
+    is_last_question: false,
+  },
+);
+
+expectAssignable<NextQuestionResponse>({
+  next_question: {
+    id: 1,
+    title: 'Sample open text question',
+    description: 'Sample description',
+    type: 'open',
+    cta_text: 'Next',
+    images: {
+      primary_url: 'https://example.com/image',
+      primary_alt: 'Example image',
+      secondary_url: 'https://example.com/image',
+      secondary_alt: 'Example image',
+    },
+    input_placeholder: 'Sample input placeholder',
+  },
+  version_id: '11db5ac7-67e1-4000-9000-414d8425cab3',
+  is_last_question: false,
+});
+
+expectAssignable<QuizResultsResponse>({
+  result: {
+    filter_expression: {
+      and: [
+        { name: 'group_id', value: 'W123456' },
+        {
+          or: [
+            { name: 'group_id', value: 'W95680' },
+            { name: 'group_id', value: 'W1338473' },
+          ],
+        },
+        {
+          or: [
+            { name: 'color', value: 'Blue' },
+          ],
+        },
+      ],
+    },
+    results_url: 'https://ac.cnstrc.com/browse/items?key=xaUaZEQHQWnrNZbq&num_results_per_page=10&collection_filter_expression=%3D%7B%22and%22%3A%5B%7B%22name%22%3A%22group_id%22%2C%22value%22%3A%22W123456%22%7D%2C%7B%22or%22%3A%5B%7B%22name%22%3A%22color%22%2C%22value%22%3A%22Purple%22%7D%2C%7B%22name%22%3A%22color%22%2C%22value%22%3A%22Black%22%7D%2C%7B%22name%22%3A%22color%22%2C%22value%22%3A%22Blue%22%7D%5D%7D%5D%7D',
+  },
+  version_id: '11db5ac7-67e1-4000-9000-414d8425cab3',
+});

package/src/types/tests/recommedations.test-d.ts

@@ -0,0 +1,45 @@
+import { expectAssignable } from 'tsd';
+import { RecommendationsResponse } from '../recommendations.d';
+
+expectAssignable<RecommendationsResponse>({
+  request: {
+    num_results: 4,
+    item_id: '',
+    filters: {
+      group_id: '87552491555',
+    },
+    pod_id: 'collection_page_1',
+  },
+  response: {
+    results: [
+      {
+        matched_terms: [],
+        data: {
+          id: '123',
+          url: 'https://example',
+          group_ids: ['123', '1234'],
+          ListPrice: 30,
+          image_url: 'https://example',
+          facets: [
+            {
+              name: 'IsBestSeller',
+              values: ['False'],
+            },
+          ],
+        },
+        value: 'ABC',
+        is_slotted: false,
+        labels: {},
+        strategy: {
+          id: 'filtered_items',
+        },
+      },
+    ],
+    total_num_results: 12,
+    pod: {
+      id: 'collection_page_1',
+      display_name: 'Highly Rated Products',
+    },
+  },
+  result_id: '618c2aa1-b851-451f-b228-61d02bf7e3c5',
+});

package/src/types/tests/search.test-d.ts

@@ -0,0 +1,124 @@
+import { expectAssignable } from 'tsd';
+import { SearchResponse } from '../search';
+
+expectAssignable<SearchResponse>({
+  response: {
+    result_sources: {
+      token_match: {
+        count: 122,
+      },
+      embeddings_match: {
+        count: 0,
+      },
+    },
+    facets: [
+      {
+        display_name: 'price',
+        name: 'price',
+        data: {},
+        type: 'range',
+        hidden: false,
+        status: {},
+        min: 0.99,
+        max: 4799.99,
+      },
+    ],
+    groups: [
+      {
+        group_id: 'All',
+        display_name: 'All',
+        count: 454,
+        data: {},
+        children: [
+          {
+            group_id: '123',
+            display_name: '123',
+            count: 62,
+            data: {},
+            children: [],
+            parents: [
+              {
+                display_name: 'All',
+                group_id: 'All',
+              },
+            ],
+          },
+        ],
+        parents: [],
+      },
+    ],
+    results: [
+      {
+        matched_terms: ['red'],
+        data: {
+          id: '123',
+          url: 'https://example',
+          keywords: ['Red Rock'],
+          image_url: 'https://example',
+          group_ids: ['123', '1234'],
+        },
+        value: '123',
+        is_slotted: false,
+        labels: {},
+        variations: [
+          {
+            data: {
+              variation_id: '123',
+            },
+            value: '123',
+          },
+        ],
+      },
+    ],
+    sort_options: [
+      {
+        sort_by: 'relevance',
+        display_name: 'Relevance',
+        sort_order: 'descending',
+        status: 'selected',
+      },
+    ],
+    refined_content: [],
+    total_num_results: 454,
+    features: [
+      {
+        feature_name: 'auto_generated_refined_query_rules',
+        display_name: 'Affinity Engine',
+        enabled: true,
+        variant: {
+          name: 'default_rules',
+          display_name: 'Default weights',
+        },
+      },
+    ],
+  },
+  result_id: 'dda3208c-0f0c-412e-92d9-7abf1d21e228',
+  request: {
+    page: 1,
+    num_results_per_page: 50,
+    section: 'Products',
+    blacklist_rules: true,
+    term: 'red',
+    fmt_options: {
+      groups_start: 'current',
+      groups_max_depth: 1,
+    },
+    sort_by: 'relevance',
+    sort_order: 'descending',
+    features: {
+      query_items: true,
+      auto_generated_refined_query_rules: true,
+      manual_searchandizing: true,
+      personalization: true,
+      filter_items: true,
+    },
+    feature_variants: {
+      query_items: 'query_items_ctr_l2r_ctr_ss',
+      auto_generated_refined_query_rules: 'default_rules',
+      manual_searchandizing: null,
+      personalization: 'default_personalization',
+      filter_items: 'filter_items_w_and_purchases',
+    },
+    searchandized_items: {},
+  },
+});

package/src/types/tests/tasks.test-d.ts

@@ -0,0 +1,40 @@
+import { expectAssignable } from 'tsd';
+import { Task, TasksResponseType } from '../tasks';
+
+expectAssignable<TasksResponseType>({
+  tasks: [
+    {
+      id: 42386186,
+      status: 'IN_PROGRESS',
+      submission_time: '2022-12-14T23:16:22Z',
+      last_update: '2022-12-14T23:16:23Z',
+      start_time: '2022-12-14T23:16:23Z',
+      filename: 'key_fuErI2yBJPxKT0uF_Products_sync_2022-12-14-23-16-22.tar',
+      type: 'ingestion',
+      protocol: 'http',
+      bucket_name: 'constructor-io',
+      object_key: 'ingestion/catalogs/prod/companies/1812/key_fuErI2yBJPxKT0uF_Products_sync_2022-12-14-23-16-22.tar',
+    },
+  ],
+  total_count: 40,
+  status_counts: {
+    QUEUED: 0,
+    IN_PROGRESS: 0,
+    DONE: 38,
+    FAILED: 2,
+    CANCELED: 0,
+  },
+});
+
+expectAssignable<Task>({
+  id: 42386186,
+  status: 'IN_PROGRESS',
+  submission_time: '2022-12-14T23:16:22Z',
+  last_update: '2022-12-14T23:16:23Z',
+  start_time: '2022-12-14T23:16:23Z',
+  filename: 'key_fuErI2yBJPxKT0uF_Products_sync_2022-12-14-23-16-22.tar',
+  type: 'ingestion',
+  protocol: 'http',
+  bucket_name: 'constructor-io',
+  object_key: 'ingestion/catalogs/prod/companies/1812/key_fuErI2yBJPxKT0uF_Products_sync_2022-12-14-23-16-22.tar',
+});