@vsf-enterprise/contentstack-sdk

5.0.0

Major Changes

• CHANGED Guarantee compatibility with @alokai/connect package.
• CHANGED Updated the package for compatibility with Node.js 22.

Key Updates:

• Upgraded to the latest version of Node.js 22
• Updated CI pipelines to use Node.js 22 for consistency.
• Updated .nvmrc or .node-version files to specify Node.js version 22.14.
• Upgraded @types/node to version ^22.13.17 for compatibility with the latest Node.js features.

Recommendations:

• Use Node.js version 22.14.0 or higher for optimal performance, security, and compatibility.
• While Node.js 20 is technically supported, it is not recommended as it may cause compatibility issues with certain packages and has not been thoroughly tested. CHANGED Replaced core dependencies with a new @alokai/connect package. @vue-storefront/middleware, @vue-storefront/sdk, vue-storefront/logger, vue-storefront/unified-data-model, @vue-storefront/multistore were replaced with @alokai/connect. The replacement preserves the same functionality and interface as the original packages. To read more about the @alokai/connect package, please refer to the documentation.

Minor Changes

• CHANGED Update axios version to "^1.7.9"

Patch Changes

• Updated dependencies:
  • @alokai/connect@1.0.0

5.0.0-rc.5

Patch Changes

• Updated dependencies:
  • @alokai/connect@1.0.0-rc.4

5.0.0-rc.4

Major Changes

• CHANGED Updated the package for compatibility with Node.js 22.

Key Updates:

• Upgraded to the latest version of Node.js 22
• Updated CI pipelines to use Node.js 22 for consistency.
• Updated .nvmrc or .node-version files to specify Node.js version 22.14.
• Upgraded @types/node to version ^22.13.17 for compatibility with the latest Node.js features.

Recommendations:

• Use Node.js version 22.14.0 or higher for optimal performance, security, and compatibility.
• While Node.js 20 is technically supported, it is not recommended as it may cause compatibility issues with certain packages and has not been thoroughly tested.

Patch Changes

• Updated dependencies:
  • @alokai/connect@1.0.0-rc.3

5.0.0-rc.3

Minor Changes

• CHANGED Update axios version to "^1.7.9"

Patch Changes

• Updated dependencies:
  • @alokai/connect@1.0.0-rc.2

5.0.0-rc.2

Patch Changes

• Updated dependencies:
  • @alokai/connect@1.0.0-rc.1

5.0.0-rc.1

Major Changes

Update packages to work with connect rc version

Patch Changes

• Updated dependencies:
  • @alokai/connect@1.0.0-rc.0

5.0.0-rc.0

Major Changes

CHANGED Replaced core dependencies with a new @alokai/connect package. @vue-storefront/middleware, @vue-storefront/sdk, vue-storefront/logger, vue-storefront/unified-data-model were replaced with @alokai/connect. The replacement preserves the same functionality and interface as the original packages. To read more about the @alokai/connect package, please refer to the documentation. You will also find a migration guide in the documentation.

4.4.0

Minor Changes

• CHANGED Replaced console and consola with Alokai Logger. To learn more about logger, visit Alokai Logger.

4.3.2

Patch Changes

• REMOVED the dependency to @vue-storefront/sdk-axios-request-sender. It was redundant and not used in the project.
• DEPRECATED ContentstackModuleType interface. It's redundant and will be removed in next major version after 04.2025.

4.3.1

Patch Changes

• FIXED Live preview cookie expiration time. Now the cookie will be valid for one hour.

4.3.0

Minor Changes

• ADDED New initLivePreview() utility for initializing the Live Preview in Contenstack. See the method's TSDoc for more information.

4.2.0

Minor Changes

• CHANGED The extractComponents utility has been marked as @deprecated and will be removed in 4 years from now (August 2028). Use getPage method which returns unified CMS page data.

- sdk.contentstack.utils.extractComponents(params);
+ sdk.unifiedCms.getPage(params);

4.1.0

Minor Changes

• CHANGED The extractComponents utility has been marked as @deprecated and will be removed in 4 years from now (August 2028). Use getPage method which returns unified CMS page data.

- sdk.contentstack.utils.extractComponents(params);
+ sdk.unifiedCms.getPage(params);

4.0.0

Major Changes

• CHANGED Implemented Alokai's middlewareModule.
• REMOVED The package no longer exports the GetContentParams interface. Instead, extract getContent method parameters from the Endpoints interface imported from@vsf-enterprise/contentstack-api:
• REMOVED The package no longer exports the HTTP Client used by the SDK because it now comes from the middlewareModule. Read this guide to find out how to modify the behaviour of the HTTP Client coming from the middlewareModule.

3.0.2

Patch Changes

• CHANGED Updated @vue-storefront/middleware version to 4.1.0.

3.0.1

Patch Changes

Update axios to ^0.28.0 to mitigate security vulnerability CVE-2023-45857

3.0.0

Major Changes

• CHANGED Changed minimum Node version from 16 to 18. The condition that was forcing the Node version to be lower than 19 is also removed.

2.3.0

Minor Changes

• 4af65fe: ADDED Added new addQuery param for the getContent method. The values passed to it will be used to call query.addQuery() internally.
  See the Contentstack documentation for addQuery for more information.
  Example:

  const content = await sdk.contentstack.getContent({
    id: "blt9fb6f1c06ef8549e",
    addQuery: { include_dimension: true },
  });
  

2.2.0

Minor Changes

• 80eeb99: Support for only feature.

2.1.0

Minor Changes

• 2f9d766: Add includeFallback property to automatically include the published fallback language content in your API response (more info here).

2.1.0-rc.0

Minor Changes

• Add includeFallback property to automatically include the published fallback language content in your API response.

2.0.0

Major Changes

• implemented @vue-storefront/sdk-axios-request-sender package in all SDK methods. All methods now send GET instead of POST requests to Vue Storefront's Server Middleware

1.2.0

Minor Changes

• added support for Node 18 and 20

1.1.1

Patch Changes

• added generic types in the getContent method

1.1.0

Minor Changes

• added types to utils

1.0.0

Major Changes

• initial release