Lavss NPM | npm.io

OneEntry SDK

OneEntry Headless CMS SDK is an SDK that provides an easy way to interact with the OneEntry Headless CMS API.

Official Site

Visit the official OneEntry website at https://oneentry.cloud to learn more about the OneEntry Headless CMS.

Sign Up

To get started with OneEntry, sign up for an account at https://account.oneentry.cloud/authentication/register.

Installation

To install the OneEntry Headless CMS SDK in your project, run the following command:

npm install oneentry

Usage

To use the OneEntry Headless CMS SDK in your project, import the defineOneEntry function:

import { defineOneEntry } from 'oneentry'

const {
        Admins,
        AttributesSets,
        Blocks,
        Forms,
        FormData,
        FileUploading,
        GeneralTypes,
        Locales,
        Markers,
        Menus,
        Pages,
        Products,
        ProductStatuses,
        System,
        Templates,
        TemplatePreviews
} = defineOneEntry('your-url')

const api = defineOneEntry('your-url')

If you chose token protection to ensure connection security, just pass your token to the function as an optional parameter.

You can get a token as follows 1) Log in to your personal account 2) Go to the "Projects" tab and select a project 3) Go to the "Access" tab 4) Set the switch to "Security API Token" 5) Log in to the project, go to the settings section and open the token tab 6) Get and copy the token of your project

Also, you can connect a tls certificate to secure your project. In this case, do not transfer the "token" at all. Learn more about security

const api = defineOneEntry('your-url', 'your-token')

Admins

const { Admins } = defineOneEntry('your-url')

Admins.getAdminsInfo(langCode, offset, limit)

const value = await Admins.getAdminsInfo('en_US', 0, 30)

This method retrieves all user objects of type admin from the API. It returns a Promise that resolves to an array of AdminEntity objects.

Example return:

[
  {
    "id": 1764,
    "identifier": "admin1",
    "attributeSetId": 7,
    "isSync": false,
    "attributeValues": {
      "marker": {
        "value": "",
        "type": "string"
      }
    },
    "position": 192
  }
]

id: number object identifier example: 1764

identifier: string textual identifier for the record field example: admin1 default: admin1

attributeSetId: number Attribute set identifier example: 7

isSync boolean Page indexing flag (true or false) example: false

attributeValues: Record<string, string> Array of attribute values from the index (presented as a pair of user attribute identifier: attribute value) example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }

position: number Position number (for sorting) example: 192

AttributesSets

const { AttributesSets } = defineOneEntry('your-url');

AttributesSets.getAttributesByMarker(marker, langCode)

const value = await AttributesSets.getAttributesByMarker('my-marker', 'en_US')

This method return all attributes with data from the attribute sets.

Example return:

[
  {
    "type": "list",
    "marker": "list1",
    "position": 192,
    "validators": {
      "requiredValidator": {
        "strict": true
      },
      "defaultValueValidator": {
        "fieldDefaultValue": 11
      }
    },
    "localizeInfos": {
      "title": "My attribute"
    },
    "listTitles": [
      {
        "title": "red",
        "value": 1,
        "position": 1,
        "extendedValue": null,
        "extendedValueType": null
      },
      {
        "title": "yellow",
        "value": 2,
        "position": 2,
        "extendedValue": null,
        "extendedValueType": null
      }
    ]
  }
]

type: string attribute type example: list

marker: string textual identifier of the attribute (marker) Enum: string, text, textWithHeader, integer, real, float, dateTime, date, time, file, image, groupOfImages, radioButton, list, button example: list1

position: number position number for sorting example: 192

validators: Record<string, any> set of validators for validation example: OrderedMap { "requiredValidator": OrderedMap { "strict": true }, "defaultValueValidator": OrderedMap { "fieldDefaultValue": 11 } }

localizeInfos: Record<string, any> localization data for the set (name) example: OrderedMap { "title": "My attribute" }

listTitles Record<string, any> array of values (with extended data) for list and radioButton attributes example: List OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null }

AttributesSets.getSingleAttributeByMarkerSet(attributeMarker, setMarker, langCode)

const value = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1', 'en_US')

This method return a single attribute with data from the attribute sets.

Example return:

{
  "type": "list",
  "marker": "list1",
  "position": 192,
  "validators": {
    "requiredValidator": {
      "strict": true
    },
    "defaultValueValidator": {
      "fieldDefaultValue": 11
    }
  },
  "localizeInfos": {
    "title": "My attribute"
  },
  "listTitles": [
    {
      "title": "red",
      "value": 1,
      "position": 1,
      "extendedValue": null,
      "extendedValueType": null
    },
    {
      "title": "yellow",
      "value": 2,
      "position": 2,
      "extendedValue": null,
      "extendedValueType": null
    }
  ]
}

type: string attribute type example: list

position: number position number for sorting example: 192

localizeInfos: Record<string, any> localization data for the set (name) example: OrderedMap { "title": "My attribute" }

Blocks

const { Blocks } = defineOneEntry('your-url');

Blocks.getBlockByMarker(marker, langCode)

const value = await Blocks.getBlockByMarker('my-marker', 'en_US')

This method return one blocks object by marker.

Example return:

{
  "id": 1764,
  "attributeSetId": 7,
  "localizeInfos": {
    "title": "My block"
  },
  "customSettings": {
    "sliderDelay": 0,
    "sliderDelayType": "",
    "productQuantity": 4,
    "productSortType": "By_ID",
    "productSortOrder": "Descending",
    "productCountElementsPerRow": 10,
    "similarProductRules": [
      {
        "property": "Descending",
        "includes": "",
        "keywords": "",
        "strict": ""
      }
    ]
  },
  "version": 10,
  "identifier": "catalog",
  "position": 192,
  "attributeValues": {
    "marker": {
      "value": "",
      "type": "string"
    }
  },
  "type": "forNewsPage",
  "templateIdentifier": null
}

id: number object identifier example: 1764

attributeSetId: number identifier for the used attribute set example: 7

localizeInfos: CommonLocalizeInfos block name with localization example: OrderedMap { "en_US": OrderedMap { "title": "My block" } }

customSettings: BlockCustomSettings custom settings for different block types example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productQuantity": 4, "productSortType": "By_ID", "productSortOrder": "Descending", "productCountElementsPerRow": 10, "similarProductRules": List OrderedMap { "property": "Descending", "includes": "", "keywords": "", "strict": "" } }

version: number object version number example: 10

identifier: string textual identifier for the field record example: catalog default: marker

position: number position number (for sorting) example: 192

attributeValues: Record<string, string> array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value) example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }

type: string block type example: forNewsPage

templateIdentifier: string template marker used by the block (can be null) Enum: forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service example: null

FileUploading

const { FileUploading } = defineOneEntry('your-url');

FileUploading.upload(data, fileQuery)

const query = {
        type:"page",
        entity:"editor",
        id:3787,
        width:0,
        height:0,
        compress:true,
    }

const value = await FileUploading.upload(data, query)

This method uploads a file to a cloud file storage. Pass to the date the value obtained from input type "file". Data is file object (or array), learn more - File Object

Example return:

[
  {
    "filename": "string",
    "downloadLink": "string",
    "size": 0
  }
]

filename: string filename with relative path

downloadLink: string link for downloading the file

size number size of the file in bytes

FileUploading.delete(filename, fileQuery)

const query = {
        type:"page",
        entity:"editor",
        id:3787
    }


const value = await FileUploading.delete("file.png", query)

This void method delete a file from the cloud file storage.

FileUploading.getFile(id, type, entity, filename)

const value = await FileUploading.getFile(123, 'page', 'editor', 'file.png')

This method return file object by parameters.

Example return:

{
  "file": "string"
}

Forms

const { Forms } = defineOneEntry('your-url');

Forms.getAllForms(langCode, offset, limit)

const value = await Forms.getAllForms('en_US', 0, 30)

This method retrieves all form objects from the API. It returns a Promise that resolves to an array of FormEntity objects.

Example return:

[
  {
    "id": 1764,
    "attributeSetId": 0,
    "processingType": "email",
    "localizeInfos": {
      "title": "My Form",
      "titleForSite": "",
      "successMessage": "",
      "unsuccessMessage": "",
      "urlAddress": "",
      "database": "0",
      "script": "0"
    },
    "processingData": "Unknown Type: ProcessingData",
    "version": 10,
    "identifier": "catalog",
    "position": 192,
    "attributes": [
      {
        "type": "list",
        "marker": "l1",
        "position": 2,
        "listTitles": [
          {
            "title": "red",
            "value": 1,
            "position": 1,
            "extendedValue": null,
            "extendedValueType": null
          },
          {
            "title": "yellow",
            "value": 2,
            "position": 2,
            "extendedValue": null,
            "extendedValueType": null
          }
        ],
        "validators": {},
        "localizeInfos": {
          "title": "l1"
        }
      }
    ]
  }
]

id: number object identifier example: 1764

attributeSetId: number identifier of the attribute set used

processingType: string form processing type example: email

localizeInfos: FormLocalizeInfos form name with localization Enum: db, email, script example: OrderedMap { "en_US": OrderedMap { "title": "My Form", "titleForSite": "", "successMessage": "", "unsuccessMessage": "", "urlAddress": "", "database": "0", "script": "0" } }

processingData: ProcessingData form data

version: number object version number example: 10

identifier: string textual identifier for the record field example: catalog default: marker

position: number position number (for sorting) example: 192

attributes: array of attribute values from the used attribute set for displaying the form (taking into account the specified language) example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "listTitles": List OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } , "validators": OrderedMap {}, "localizeInfos": OrderedMap { "title": "l1" } } ]

Forms.getFormByMarker(marker, langCode)

const value = await Forms.getFormByMarker('My form', 'en_US')

This method retrieves a single form object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a FormEntity object.

Example return:

{
  "id": 1764,
  "attributeSetId": 0,
  "processingType": "email",
  "localizeInfos": {
    "title": "My Form",
    "titleForSite": "",
    "successMessage": "",
    "unsuccessMessage": "",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  },
  "processingData": "Unknown Type: ProcessingData",
  "version": 10,
  "identifier": "catalog",
  "position": 192,
  "attributes": [
    {
      "type": "list",
      "marker": "l1",
      "position": 2,
      "listTitles": [
        {
          "title": "red",
          "value": 1,
          "position": 1,
          "extendedValue": null,
          "extendedValueType": null
        },
        {
          "title": "yellow",
          "value": 2,
          "position": 2,
          "extendedValue": null,
          "extendedValueType": null
        }
      ],
      "validators": {},
      "localizeInfos": {
        "title": "l1"
      }
    }
  ]
}

id: number object identifier example: 1764

attributeSetId: number identifier of the attribute set used

processingType: string form processing type example: email

processingData: ProcessingData form data

version: number object version number example: 10

identifier: string textual identifier for the record field example: catalog default: marker

position: number position number (for sorting) example: 192

FormData

const { FormData } = defineOneEntry('your-url');

FormData.postFormsData(data)

const value = await FormData.postFormsData(data)

This method retrieves all form data objects from the API. It returns a Promise that resolves to an array of objects of type CreateFormDataDto.

Example return:

{
  "id": 1764,
  "formIdentifier": "my-form",
  "time": "2023-02-12 10:56",
  "formData": {
    "marker": "name_1",
    "value": "Name"
  }
}

id: number object identifier example: 1764

formIdentifier: string Text identifier of the form object (marker) example: my-form

time: Date Date and time of form modification example: 2023-02-12 10:56

formData: FormDataLangType Data submitted by the form example: OrderedMap { "en_US": List OrderedMap { "marker": "naimenovanie_1", "value": "Name" } }

FormData.getFormsData(langCode, offset, limit)

const value = await FormData.getFormsData('en_US', 0, 30)

This method creates form data objects by sending a request to the API. It accepts an array of objects of type IFormsPost as the request body to provide the necessary form data. It returns a Promise that resolves to the created CreateFormDataDto objects.

Example return:

{
  "id": 1764,
  "formIdentifier": "my-form",
  "time": "2023-02-12 10:56",
  "formData": {
    "marker": "name_1",
    "value": "Name"
  },
  "attributeSetIdentifier": "test-form"
}

id: number object identifier example: 1764

formIdentifier: string Text identifier of the form object (marker) example: my-form

time: Date Date and time of form modification example: 2023-02-12 10:56

formData: FormDataLangType Data submitted by the form example: OrderedMap { "en_US": List OrderedMap { "marker": "naimenovanie_1", "value": "Name" } }

attributeSetIdentifier: string text identifier (marker) of the used attribute set example: test-form

FormData.getFormsDataByMarker(marker, langCode, offset, limit)

const value = await FormData.getFormsDataByMarker('my-marker', 'en_US', 0, 30)

This method retrieves a specific form data object by its marker from the API. It accepts a marker parameter as the marker of the form data. It returns a Promise that resolves to an array of objects of type FormDataEntity.

Example return:

{
  "id": 1764,
  "formIdentifier": "my-form",
  "time": "2023-02-12 10:56",
  "formData": {
     "marker": "name_1",
     "value": "Name"
  },
  "attributeSetIdentifier": "test-form"
}

id: number object identifier example: 1764

formIdentifier: string Text identifier of the form object (marker) example: my-form

time: Date Date and time of form modification example: 2023-02-12 10:56

formData: FormDataLangType Data submitted by the form example: OrderedMap { "en_US": List OrderedMap { "marker": "naimenovanie_1", "value": "Name" } }

attributeSetIdentifier: string text identifier (marker) of the used attribute set example: test-form

GeneralTypes

const { GeneralTypes } = defineOneEntry('your-url');

GeneralTypes.getAllTypes()

const value = await GeneralTypes.getAllTypes()

This method retrieves all objects of type GeneralTypeEntity from the API. It returns a Promise that resolves to an array of GeneralTypeEntity objects.

Example return:

[
  {
    "id": 1,
    "type": "forNewsPage"
  }
]

id: number object identifier example: 1764

type: string type value example: forNewsPage Enum: forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service

Locales

const { Locales } = defineOneEntry('your-url')

Locales.getLocales()

const value = await Locales.getLocales()

This method retrieves all active language localization objects from the API. It returns a Promise that resolves to an array of LocaleEntity objects.

Example return:

[
    {
      "id": 1764,
      "shortCode": "en",
      "code": "en_US",
      "name": "Bengali",
      "nativeName": "বাংলা",
      "isActive": false,
      "image": "🇦🇨",
      "position": 1
    }
]

id: number object identifier example: 1764

shortCode: string language code (short) example: en

code: string language code with country code example: en_US

name string Language name (in English) example: Bengali

nativeName string Language name (in native language) example: বাংলা

isActive: boolean Flag of usage example: false

image: string Graphic image of the language (under development) example: 🇦🇨

position: { description:position number }

Markers

const { Markers } = defineOneEntry('your-url')

Markers.getMarkers(offset, limit)

const value = await Markers.getMarkers(0, 30)

This method return an array of all objects MarkerEntity.

Example return:

[
  {
    "id": 17,
    "updatedDate": "2023-12-18T08:53:37.422Z",
    "version": 10,
    "identifier": "catalog",
    "name": "string",
    "marker": "string",
    "localizeInfos": {
      "title": "My marker"
    }
  }
]

id: number object identifier example: 1764

updatedDate: string($date-time) object modification date

version: number version number of the object change example: 10

identifier?: string textual identifier for a record field example: catalog

name?: string name

marker?: string textual identifier

localizeInfos: CommonLocalizeInfos localized marker name example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }

Markers.getMarkerById(id)

const value = await Markers.getMarkerById(1)

This method return one object of MarkerEntity by id.

Example return:

{
  "id": 17,
  "updatedDate": "2023-12-18T08:55:22.581Z",
  "version": 10,
  "identifier": "catalog",
  "name": "string",
  "marker": "string",
  "localizeInfos": {
    "title": "My marker"
  }
}

id: number object identifier example: 1764

updatedDate: string($date-time) object modification date

version: number version number of the object change example: 10

identifier?: string textual identifier for a record field example: catalog

name?: string name

marker?: string textual identifier

localizeInfos: CommonLocalizeInfos localized marker name example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }

Markers.getMarkerByMarker(marker)

const value = await Markers.getMarkerByMarker('my-marker')

This method return one object of MarkerEntity by marker.

Example return:

{
  "id": 17,
  "updatedDate": "2023-12-18T08:59:42.006Z",
  "version": 10,
  "identifier": "catalog",
  "name": "string",
  "marker": "string",
  "localizeInfos": {
    "title": "My marker"
  }
}

id: number object identifier example: 1764

updatedDate: string($date-time) object modification date

version: number version number of the object change example: 10

identifier?: string textual identifier for a record field example: catalog

name?: string name

marker?: string textual identifier

localizeInfos: CommonLocalizeInfos localized marker name example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }

Menus

const { Menus } = defineOneEntry('your-url')

Menus.getMenusByMarker(marker)

const value = await Menus.getMenusByMarker('my-marker')

This method retrieves a single menu object based on its marker (marker) from the API. It returns a Promise that resolves to a single menu object as a ContentMenuDto object with included pages.

Example return:

{
  "id": 1764,
  "identifier": "catalog",
  "localizeInfos": {
    "title": "Main Menu"
  },
  "pages": [
    {
      "id": 11,
      "pageUrl": "122",
      "localizeInfos": {
        "en_US": {
          "title": "12",
          "content": "",
          "menuTitle": "12"
        }
      },
      "position": 0,
      "parentId": null
    }
  ]
}

id: number object identifier example: 1764

identifier: string textual identifier for a record field example: catalog

localizeInfos Record<string, any> json object description of the menu item with the language "en_US" (for example) example: OrderedMap { "en_US": OrderedMap { "title": "Main Menu" } }

pages: data of the pages included in the menu example: List OrderedMap { "id": 11, "pageUrl": "122", "localizeInfos": OrderedMap { "en_US": OrderedMap { "title": "12", "plainContent": "Content for catalog", "htmlContent": "Content for catalog", "menuTitle": "12" } }, "position": 0, "parentId": null }

Pages

const { Pages } = defineOneEntry('your-url')

In some methods, the langcode parameter can be either a string or an array of strings. It depends on which set of values will contain "attributeValues" and "localizeInfos"

Example:

 const value = await Pages.getRootPages('en_US')
 
 "localizeInfos": {
      {
        "title": "Catalog",
        "content": "Content from catalog",
        "menuTitle": "Catalog"
      }
 },
 "attributeValues": {
      {
        "marker": {
          "value": "Value",
          "type": "string"
        }
      }
 }

const value = await Pages.getRootPages([ 'en_US', 'it_IT' ])

 "localizeInfos": {
      en_US: {
        "title": "Catalog",
        "content": "Content from catalog",
        "menuTitle": "Catalog"
      },
      it_IT: {
        "title": "Catalogo",
        "content": "Contenuto dal catalogo",
        "menuTitle": "Catalogo"
      }
 },
 "attributeValues": {
      en_US: {
        "marker": {
          "value": "Value",
          "type": "string"
        }
      },
      it_IT: {
        "marker": {
          "value": "Valore",
          "type": "string"
        }
      }
 }

Pages.getRootPages(langCode)

const value = await Pages.getRootPages('en_US')

This method retrieves all top-level page objects from the API. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data. Get required language parameter.

Example return:

[
  {
      "id": 1764,
      "parentId": null,
      "config": {
        "rowsPerPage": 1,
        "productsPerRow": 1
      },
      "pageUrl": "string",
      "depth": 3,
      "localizeInfos": {
        "title": "Catalog",
        "content": "Content for catalog",
        "menuTitle": "Catalog"
      },
      "isVisible": true,
      "products": 0,
      "attributeSetId": 7,
      "isSync": false,
      "templateIdentifier": "my-template",
      "attributeValues": {
        "marker": {
          "value": "",
          "type": "string"
        }
      },
      "position": 192,
      "type": "forNewsPage",
      "childrenCount": 0
  }
]

id: number object identifier example: 1764

parentId number parent page identifier, if null, it is a top-level page example: null

config Record<string, number> output settings for catalog pages example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }

pageUrl string unique page URL

depth number page nesting depth relative to parentId example: 3

localizeInfos: Record<string, any> json description of the main page data object taking into account the language "en_US" (for example) example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "Content for catalog", "menuTitle": "Catalog" } }

isVisible: boolean Page visibility flag example: true

products number Number of products linked to the page example: 0

attributeSetId: number attribute set identifier example: 7

forms Array of FormEntity object identifier values linked to the page (optional)

blocks Array of BlockEntity object identifier values linked to the page (optional)

isSync: boolean indicator of page indexing (true or false) example: false

templateIdentifier: string Custom identifier of the linked template example: my-template

attributeValues: Record<string, string> Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value) example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }

position: number position number for sorting (optional) example: 192

type: string Page type example: forNewsPage Enum: forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service

childrenCount: number number of nested pages example: 0

Pages.getCatalogPages(langCode, limit, offset)

const value = await Pages.getCatalogPages('en_US', 0, 30)

This method retrieves all page objects with product information as an array from the API. It accepts two optional parameters limit and offset for pagination and language code parameter. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data.

Example return:

[
  {
      "id": 1764,
      "parentId": null,
      "config": {
        "rowsPerPage": 1,
        "productsPerRow": 1
      },
      "pageUrl": "string",
      "depth": 3,
      "localizeInfos": {
        "title": "Catalog",
        "content": "Content for catalog",
        "menuTitle": "Catalog"
      },
      "isVisible": true,
      "products": 0,
      "attributeSetId": 7,
      "isSync": false,
      "templateIdentifier": "my-template",
      "attributeValues": {
        "marker": {
          "value": "",
          "type": "string"
        }
      },
      "position": 192,
      "type": "forNewsPage",
      "childrenCount": 0
  }
]