@sitecore-jss/sitecore-jss
Version:
This module is provided as a part of Sitecore JavaScript Rendering SDK. It contains the core JSS APIs (layout service) and utilities.
89 lines (88 loc) • 4.13 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.GraphQLLayoutService = exports.GRAPHQL_LAYOUT_QUERY_NAME = void 0;
const layout_service_1 = require("./layout-service");
const debug_1 = __importDefault(require("../debug"));
exports.GRAPHQL_LAYOUT_QUERY_NAME = 'JssLayoutQuery';
/**
* Service that fetch layout data using Sitecore's GraphQL API.
* @augments LayoutServiceBase
* @mixes GraphQLRequestClient
*/
class GraphQLLayoutService extends layout_service_1.LayoutServiceBase {
/**
* Fetch layout data using the Sitecore GraphQL endpoint.
* @param {GraphQLLayoutServiceConfig} serviceConfig configuration
*/
constructor(serviceConfig) {
super();
this.serviceConfig = serviceConfig;
this.graphQLClient = this.getGraphQLClient();
}
/**
* Fetch layout data for an item.
* @param {string} itemPath item path to fetch layout data for.
* @param {string} [language] the language to fetch layout data for.
* @returns {Promise<LayoutServiceData>} layout service data
*/
fetchLayoutData(itemPath, language) {
return __awaiter(this, void 0, void 0, function* () {
var _a, _b;
const query = this.getLayoutQuery(itemPath, language);
debug_1.default.layout('fetching layout data for %s %s %s', itemPath, language, this.serviceConfig.siteName);
const data = yield this.graphQLClient.request(query);
// If `rendered` is empty -> not found
return (((_b = (_a = data === null || data === void 0 ? void 0 : data.layout) === null || _a === void 0 ? void 0 : _a.item) === null || _b === void 0 ? void 0 : _b.rendered) || {
sitecore: { context: { pageEditing: false, language }, route: null },
});
});
}
/**
* Gets a GraphQL client that can make requests to the API. Uses graphql-request as the default
* library for fetching graphql data (@see GraphQLRequestClient). Override this method if you
* want to use something else.
* @returns {GraphQLClient} implementation
*/
getGraphQLClient() {
if (!this.serviceConfig.clientFactory) {
throw new Error('clientFactory needs to be provided when initializing GraphQL client.');
}
return this.serviceConfig.clientFactory({
debugger: debug_1.default.layout,
retries: this.serviceConfig.retries,
retryStrategy: this.serviceConfig.retryStrategy,
});
}
/**
* Returns GraphQL Layout query
* @param {string} itemPath page route
* @param {string} [language] language
* @returns {string} GraphQL query
*/
getLayoutQuery(itemPath, language) {
const languageVariable = language ? `, language:"${language}"` : '';
const layoutQuery = this.serviceConfig.formatLayoutQuery
? this.serviceConfig.formatLayoutQuery(this.serviceConfig.siteName, itemPath, language)
: `layout(site:"${this.serviceConfig.siteName}", routePath:"${itemPath}"${languageVariable})`;
return `query ${exports.GRAPHQL_LAYOUT_QUERY_NAME} {
${layoutQuery}{
item {
rendered
}
}
}`;
}
}
exports.GraphQLLayoutService = GraphQLLayoutService;