Skip to content

[CDX-173] Add support for fmt_options in recommendations request #380

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
esezen merged 3 commits into from
Jun 17, 2025
Merged

[CDX-173] Add support for fmt_options in recommendations request #380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
770012f
Add support for fmt_options in recommendations request
esezen Jun 16, 2025
f9b826b
Update link to v1 recommendations pod results documentation
esezen Jun 16, 2025
3039bd4
Move block
esezen Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions spec/src/modules/recommendations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,26 @@ describe(`ConstructorIO - Recommendations${bundledDescriptionSuffix}`, () => {
});
});

it('Should return a response with valid itemIds, and fmtOptions', (done) => {
const hiddenFields = ['testField', 'hiddenField2'];
const fmtOptions = { hidden_fields: hiddenFields };
const { recommendations } = new ConstructorIO({
apiKey: testApiKey,
fetch: fetchSpy,
});

recommendations.getRecommendations(podId, { itemIds, fmtOptions }).then((res) => {
const requestedUrlParams = helpers.extractUrlParamsFromFetch(fetchSpy);

expect(res).to.have.property('request').to.be.an('object');
expect(res).to.have.property('response').to.be.an('object');
expect(res).to.have.property('result_id').to.be.an('string');
expect(res.request.fmt_options.hidden_fields).to.eql(hiddenFields);
expect(requestedUrlParams.fmt_options).to.have.property('hidden_fields').to.eql(hiddenFields);
done();
});
});

it('Should return a response with valid itemIds, and numResults', (done) => {
const numResults = 2;
const { recommendations } = new ConstructorIO({
Expand Down
7 changes: 7 additions & 0 deletions src/modules/recommendations.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ function createRecommendationsUrl(podId, parameters, options) {
variationsMap,
hiddenFields,
preFilterExpression,
fmtOptions,
} = parameters;

// Pull num results number from parameters
Expand Down Expand Up @@ -63,6 +64,11 @@ function createRecommendationsUrl(podId, parameters, options) {
queryParams.filters = filters;
}

// Pull format options from parameters
if (fmtOptions) {
queryParams.fmt_options = fmtOptions;
}

// Pull hidden fields from parameters
if (hiddenFields) {
if (queryParams.fmt_options) {
Expand Down Expand Up @@ -117,6 +123,7 @@ class Recommendations {
* @param {object} [parameters.filters] - Key / value mapping of filters used to refine results
* @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
* @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.com/reference/configuration-collections
* @param {object} [parameters.fmtOptions] - An object containing options to format different aspects of the response. Please refer to https://docs.constructor.com/reference/v1-recommendations-get-pod-results for details
* @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
* @param {object} [networkParameters] - Parameters relevant to the network request
* @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
Expand Down
3 changes: 2 additions & 1 deletion src/types/recommendations.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ConstructorClientOptions, NetworkParameters, VariationsMap, FilterExpression } from '.';
import { ConstructorClientOptions, NetworkParameters, VariationsMap, FilterExpression, FmtOptions } from '.';
import EventDispatcher from './event-dispatcher';

export default Recommendations;
Expand All @@ -12,6 +12,7 @@ export interface RecommendationsParameters {
variationsMap?: VariationsMap;
hiddenFields?: string[];
preFilterExpression?: FilterExpression;
fmtOptions?: FmtOptions;
}

declare class Recommendations {
Expand Down