JavaScript Content API Library · Dedicated Client Package

The JavaScript Content API Library a.k.a. Content API is an interface handling data coming from the FirstSpirit CaaS and the Navigation Service. The data is processed and transformed so that it can be used in any JavaScript project.

Attention We would like to inform you that the project previously known as "FSXA-API" has recently undergone a name change. The project is now called "JavaScript Content API Library", but please note that this change solely affects the project's name, repository, and associated branding elements. The core code and functionality of the library remain unchanged. The purpose and scope of the library, as well as its intended usage and compatibility, remain consistent. The decision to change the name was made as the term "fsxa" no longer accurately represents the project's current scope, as other components beyond the fsxa-api are now discontinued. The name change aims to align the project's branding with its refined purpose and to avoid any confusion regarding its functionality.

• JavaScript Content API Library
  • SubPackage
  • Experimental features
  • Legal Notices
  • Methods
    • Constructor
    • fetchNavigation
    • fetchElement
    • fetchByFilter
    • fetchProjectProperties
  • Filter
    • Logical Query Operators
    • Comparison Query Operators
    • Evaluation Query Operators
    • Array Query Operators
  • Helpers
  • Type Mapping
    • Input Components
  • Disclaimer

SubPackage

This package holds the compiled client part of the Content API and is a subset of its functionality. We removed redundant code, to shrink the size of the code sent to the user's client and therefore improve the Time to Interactive (TTI) and overall performance. such as the users' browser. It is optimized to hold only necessary parts needed for execution in a client context. The main functionality is to talk to a backend service, implemented by the FSXARemoteApi class.

Please Note:

To benefit from this package, you have to carefully split your own codebase into client-side code and SSR / backend code. Client-side related functionality of the Content API can be imported through the fsxa-proxy-api package. This package is intended to only enable FSXAProxyApi to work and provides necessary exported functionality to use it correctly.

Experimental features

Features marked as experimental are subject to change as long as they remain in the experimental state. Breaking changes to experimental features are not reflected in a major version changes.

Legal Notices

JavaScript Content API Library is a product of Crownpeak Technology GmbH, Dortmund, Germany. The JavaScript Content API Library is subject to the Apache-2.0 license.

Methods

In this section all available methods will be explained using examples.

Constructor

To be able to use the Content API, a new object must be created.

If you want to use the information provided by the CaaS in your frontend, you can use the FSXAProxyApi provided with this package. It proxies the requested resources to a middleware Rest Api, that does not expose secrets. If you want to use it in your server, you can use the FSXARemoteApi. This is not supported by this package. You have to implement all backend related code with the parent package fsxa-api. It then can be registered as a Rest Api that can be called from a FSXAProxyApi instance you can implement with this package (fsxa-proxy-api).

However, to have a fully running application, we recommend using the Content API in your server as well as in your frontend.

The log level can be: 0 = Info 1 = Log 2 = Warning 3 = Error 4 = None. The default is set to 3.

Here is an example of how the FSXAProxyApi could be used. Make sure you have fsxa-proxy-api installed.

import { FSXAProxyApi, LogLevel } from 'fsxa-proxy-api'

const locale = 'de_DE'
const proxyAPI = new FSXAProxyApi(
  'http://localhost:3002/api',
  LogLevel.INFO
)

// you can also fetch navigation from proxyAPI
const navigationResponse = await proxyAPI.fetchNavigation({
  locale,
  initialPath: '/'
})

fetchNavigation

This method fetches the navigation from the configured navigation service. You need to pass a FetchNavigationParams object.

Example:

proxyAPI.fetchNavigation({
  locale: 'en_EN',
  initialPath: '/',
})

fetchElement

This method fetches an element from the configured CaaS. The FetchElementParams object defines options to specify your request. Check FSXARemoteApi.buildCaaSUrl from the fsxa-api package to know which URL will be used.

proxyAPI.fetchElement({
  id: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  locale: 'de_DE',
})

Note The 'raw' CaaS data might be helpful when you want to know the key names that you can filter for. It is possible to access that data directly with the authorization header and the CaaS Url when working with the fsxa-api package.

fetchByFilter

Returns the matching CaaS data entries. It maps the given entries to a more frontend-friendly format. Unnecessary fields will be omitted and the structure is simpler.

Expects as input parameter an array of filters and a language abbreviation. Optionally a page number, page size, sort and additional parameters can be passed. Optionally, a remoteProject can be passed. If one is passed, the element will be fetched from this project instead of the default one.

Several filter objects can be specified in the filter array, the results will then correspond to all specified filters.

One filter object must have a: field which specifies the searched key, operator which specifies the search operation, value which specifies the value that is looked for.

More information to the filters

In this example we search for all elements with the fsType equals Example. We want the 2nd page with a maximum of 50 entries. The results should be sorted by fsType descending. However, we do not want the identifier to appear:

proxyApi.fetchByFilter({
  filters: [
    {
      field: 'fsType',
      operator: ComparisonQueryOperatorEnum.EQUALS,
      value: 'Example',
    },
  ],
  locale: 'en',
  page: 2,
  pagesize: 50,
  additionalParams: { keys: { identifier: 0 } },
  sort: [{ name: 'fsType', order: 'desc' }],
})

The default sorting is by the id descending. MultiSort is possible and the first sort param is prioritized over subsequent. The sorting is happening on the raw data.

Attention The keys names which are passed to the fetchByFilter method (e.g. in the filters or the additionalParams) have to match the key names that are present in the CaaS data.

fetchProjectProperties

Returns the project properties of the given language.

Expects a parameter object with the locale.

ATTENTION: Works only with CaaSConnect module version 3 onwards.

Example:

proxyApi.fetchProjectProperties({
  locale: 'de_DE',
})

Filter

You can customize your queries in the fetchByFilter method with these operations. For more information please refer to the MongoDB documentation. Links are provided in each section.

Helpers

There are also some additional helper methods which can be used for different purposes.

type AvailableLocaleParams = {
  navigationServiceURL: string
  projectId: string
  contentMode: string | ('preview' | 'release')
}

getAvailableLocales({
  projectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
  navigationServiceURL: 'https://your.navigation-service.url/navigation',
  contentMode: 'preview',
})

This method provides a list of available locales configured in your FirstSpirit project. It is recommended that the configuration matches the ISO format. E.g. ["en_GB", "de_DE"]

  Promise<string[]>

Logical Query Operators

These operators can also be found in the MongoDB Documentation

| Enum | Operation | |------------------------------|-----------| | LogicalQueryOperatorEnum.AND | $and | | LogicalQueryOperatorEnum.NOT | $not | | LogicalQueryOperatorEnum.NOR | $nor | | LogicalQueryOperatorEnum.OR | $or |

Comparison Query Operators

These operators can also be found in the MongoDB Documentation

| Enum | Operation | |-------------------------------------------------|-----------| | ComparisonQueryOperatorEnum.GREATER_THAN_EQUALS | $gte | | ComparisonQueryOperatorEnum.GREATER_THAN | $gt | | ComparisonQueryOperatorEnum.EQUALS | $eq | | ComparisonQueryOperatorEnum.IN | $in | | ComparisonQueryOperatorEnum.LESS_THAN | $lt | | ComparisonQueryOperatorEnum.LESS_THAN_EQUALS | $lte | | ComparisonQueryOperatorEnum.NOT_EQUALS | $ne | | ComparisonQueryOperatorEnum.NOT_IN | $nin |

Evaluation Query Operators

These operators can also be found in the MongoDB Documentation

| Enum | Operation | |-----------------------------------|-----------| | EvaluationQueryOperatorEnum.REGEX | $regex |

Array Query Operators

These operators can also be found in the MongoDB Documentation

| Enum | Operation | |----------------------------|-----------| | ArrayQueryOperatorEnum.ALL | $all |

Type Mapping

Input Components

This table gives an overview of the FirstSpirit input components, which can be defined in the "Form" tab of the FirstSpirit templates. Each input component has a (Java) data type, which has a representation in the CaaS. Those values are mapped to an interface of the Content API.

| FirstSpirit Input Component | CaaS Representation | Content API Value | |--------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| | FS_CATALOGCatalog<Catalog$Card> | = CaaSApi_FSCatalog= CaaSApi_Card[] | Section[] | | CMS_INPUT_CHECKBOXSet<Option> | = CaaSApi_CMSInputCheckbox= CaaSApi_Option[] | Option[] | | CMS_INPUT_COMBOBOXOption | = CaaSApi_CMSInputCombobox= CaaSApi_Option|null | Option | | FS_DATASETDatasetContainer | = CaaSApi_FSDataset= CaaSApi_Dataset|CaaSApi_DataEntry[]|null | Dataset | | CMS_INPUT_DATEDate | = CaaSApi_CMSInputDate= string(ISO_8601)|null | Date | | CMS_INPUT_DOMDomElement | = CaaSApi_CMSInputDOM= string (FS-XML) | RichTextElement[] | | CMS_INPUT_DOMTABLETable | = CaaSApi_CMSInputDOMTable= string (FS-XML) | RichTextElement[] | | CMS_INPUT_IMAGEMAPMappingMedium | = CaaSApi_CMSImageMap= CaaSApi_CMSImageMap | ImageMap | | FS_INDEXIndex<Index$Record> | = CaaSApi_FSIndex= CaaSApi_Record[] | DataEntries[] | | CMS_INPUT_LINKLink | = CaaSApi_CMSInputLink= Object | Link | | CMS_INPUT_LISTSet<Option> | = CaaSApi_CMSInputList= any[] | Option[] | | CMS_INPUT_NUMBERNumber | = CaaSApi_CMSInputNumber= number | number | | CMS_INPUT_PERMISSIONPermissions | = CaaSApi_CMSInputPermission= CaaSAPI_PermissionActivity[][] | Permission | | CMS_INPUT_RADIOBUTTONOption | = CaaSApi_CMSInputRadioButton= CaaSApi_Option|null | Option | | FS_REFERENCETargetReference | = CaaSApi_FSReference= CaaSApi_BaseRef|CaaSApi_PageRefRef|CaaSApi_GCARef|CaaSApi_MediaRef|null | | CMS_INPUT_TEXTString | = CaaSApi_CMSInputText= string | string | | CMS_INPUT_TEXTAREAString | = CaaSApi_CMSInputTextArea= string | string | | CMS_INPUT_TOGGLEBoolean | = CaaSApi_CMSInputToggle= boolean|null | boolean |

Disclaimer

This document is provided for information purposes only. Crownpeak Technology may change the contents hereof without notice. This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties and conditions of merchantability or fitness for a particular purpose. Crownpeak Technology specifically disclaims any liability with respect to this document and no contractual obligations are formed either directly or indirectly by this document. The technologies, functionality, services, and processes described herein are subject to change without notice.