@vsf-enterprise/builder-api

4.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

4.0.0-rc.5

Patch Changes

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

4.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

4.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

4.0.0-rc.2

Patch Changes

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

4.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

4.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.

3.0.0

Major Changes

CHANGED

• Update @vue-storefront/middleware to ^5.1.0
• Update @vue-storefront/unified-data-model to ^3.0.0

2.3.0

Minor Changes

• ADDED userAttributes param to getPage. It allows you to pass any custom user attributes to the Builder.io's request.

2.2.0

Minor Changes

• CHANGED Upgraded the path-to-regexp package to version 8.0.0. Note that page path patterns must now follow a different convention. For more details, please refer to the Release Notes for path-to-regexp@8.0.0.

2.1.2

Patch Changes

• CHANGED getPage method requires a unified configuration with resolvePages and resolveFallbackPage defined.
• FIXED RegExp path matching in resolvePages.

2.1.1

Patch Changes

• FIXED Passing locale to Builder.io API

2.1.0

Minor Changes

• ADDED Unified extension which is available at the /unified namespace and adds a new getPage endpoint. The endpoint allows to fetch a unified page object, regardless of whether our page is built from a single Page model or multiple Section models.

To use the extension on the Storefront side:

1. Export extension types in the storefront-middleware/types.ts file:

+ export type { UnifiedEndpoints as UnifiedCmsEndpoints } from '@vsf-enterprise/builderio-api';

2. In the SDK config, add a new middlewareModule:

+ import type { UnifiedCmsEndpoints } from 'storefront-middleware/types';

+ unifiedCms: buildModule(middlewareModule<UnifiedCmsEndpoints>, {
+   apiUrl: `${config.middlewareUrl}/builderio/unified`,
+   defaultRequestConfig: {
+     headers: getRequestHeaders(),
+   },
+ }),
  // ...

3. In your page component, use the getPage method to fetch the page data:

const page = await sdk.unifiedCms.getPage({
  path: "/",
  locale: "en",
});

• CHANGED The BuilderIntegrationContext interface has been renamed to IntegrationContext. Update the relevant imports in your application.

import type {
- BuilderIntegrationContext
+ IntegrationContext as BuilderIntegrationContext
} from '@vsf-enterprise/builderio-api';

2.0.0

Major Changes

Created Builder.io new middleware module.

3.0.0

Major Changes

• BREAKING Updated @vue-storefront/middleware version to 4.1.0. Make sure this version is used in your project.

{
  ...
  "dependencies": {
-   "@vue-storefront/middleware": "3.x.x",
+   "@vue-storefront/middleware": "4.1.0"
  }
}

2.0.1

Patch Changes

Update axios to ^0.28.0 to avoid CVE-2023-45857

2.0.0

Major Changes

Update minimum Node version to 18

1.0.0

Major Changes

• ea7594a: Initial Major release