@lightspeed/crane 1.2.1 → 1.2.2

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 1.2.2 - 2025-05-12
+
+_If you are upgrading: please see [UPGRADE.md](UPGRADE.md)._
+
+### Added
+
+- **Storefront (experimental):** add multipage support for Custom Templates.
+- Add image validation for custom section and template configuration files during the 'build' command.
+- Provide icon URL for 'Made With' component through the external content. 
+
+### Changed
+
+- **Breaking:** Change minimal supported Node.js version to 22 LTS.
+- **Breaking:** Upgrade ESLint dependency to version 9.
+
+### Removed
+
+- **Breaking:** Remove unused image resolutions from the templating files across all sections.
+
 ## 1.2.1 - 2025-04-17
 
 ### Added

package/README.md

@@ -22,6 +22,10 @@ permissions granted, as well as an optional test site in order to verify the cha
 
 ```For both the test site and the permission, please contact your Partner Manager!```
 
+### Recommended Node.js Version
+
+For the best compatibility and performance, it is recommended to use **Node.js 22.x**
+
 ### Installation
 
 The following commands need to be performed to install the required dependencies and Crane utility, along with our linter:
@@ -111,3 +115,10 @@ npm install
 
 3. HTTP 403 during deployment:
    Insufficient permissions, please contact your Partner Manager regarding the necessary permissions.
+
+### More information
+
+For more information regarding the notable changes for each versioned release and the upgrade guide, please refer to the following files:
+
+- [CHANGELOG](CHANGELOG.md)
+- [UPGRADE](UPGRADE.md)

package/UPGRADE.md

@@ -0,0 +1,30 @@
+# Upgrades
+
+## 1.2.1 to 1.2.2
+
+### Node.js Version Upgrade
+
+The required Node.js version has been updated from **20 LTS** to **22 LTS**. 
+Ensure that your environment is running Node.js 22 LTS to maintain compatibility with the latest dependencies.
+
+### Restriction on Image Resolutions
+
+As of this update, a new limitation on the types of image resolutions that can be uploaded has been added. 
+The build will fail if any resolutions other than the ones specified below are used:
+
+- **MOBILE_WEBP_HI_RES**: 1000px x 2000px
+- **WEBP_LOW_RES**: 200px x 200px
+- **WEBP_HI_2X_RES**: 2000px x 2000px
+- **MOBILE_WEBP_LOW_RES**: 100px x 200px
+- **ORIGINAL**: The original version of the image, not resized.
+
+Ensure that all images conform to these resolutions to prevent build failures.
+
+### ESLint upgrade from 8 to 9
+
+1. Create a file named ```eslint.config.cjs``` in custom app root directory.
+2. Add the following content to the file:
+```js
+module.exports = require('@lightspeed/eslint-config-crane');
+```
+3. Remove existing ```.eslintrc.cjs``` file

package/dist/app.d.mts

@@ -1,5 +1,5 @@
 import * as vue from 'vue';
-import { App, Ref, Component } from 'vue';
+import type { Ref, App, Component } from 'vue';
 
 interface AppBaseContext {
     readonly appName: string;
@@ -56,6 +56,8 @@ interface GlobalDesign {
     customCss?: string;
 }
 
+
+
 interface VueBaseProps<CONTENT, DESIGN> {
     init: (app: App<Element>, contextValue: AppBaseContext, contentValue: CONTENT, designValue: DESIGN, defaultsValue: Record<string, unknown>, externalContent: ExternalContentData, globalDesignValue: GlobalDesign) => void;
     update: (app: App<Element>, contentValue: CONTENT, designValue: DESIGN, defaultsValue: Record<string, unknown>, externalContent: ExternalContentData, globalDesignValue: GlobalDesign) => void;
@@ -239,6 +241,15 @@ declare function useLogoElementContent<CONTENT>(): {
     };
 };
 
+
+
+
+
+
+
+
+
+
 declare function useTextElementDesign<DESIGN>(elementName: keyof DESIGN): {
     font: string | undefined;
     size: number | GlobalTextSizeString | undefined;
@@ -290,6 +301,10 @@ declare function useLayoutElementDesign(): {
 
 declare function useLogoElementDesign<DESIGN>(): vue.ComputedRef<LogoDesignData>;
 
+
+
+
+
 interface VueServerAppExtensions {
     init?: (app: App<Element>) => void;
     render?: <C, D>(app: App<Element>, context: AppBaseContext, data: AppBaseData<C, D>) => void;
@@ -304,6 +319,10 @@ declare function createVueServerApp<C, D>(appComponent: Component, extensions?:
     };
 };
 
+
+
+
+
 interface VueClientAppExtensions {
     init?: (app: App<Element>) => void;
     mount?: <C, D, S extends AppBaseState<C, D>>(app: App<Element>, rootContainer: string, state: S) => void;
@@ -383,5 +402,14 @@ interface InstantsiteJSAPI {
 
 declare function useInstantsiteJsApi(): InstantsiteJSAPI | undefined;
 
+
+
+
+
+
+
+
+
+
 export { EditorTypes, createVueClientApp, createVueServerApp, useBackgroundElementDesign, useButtonElementContent, useButtonElementDesign, useDeckElementContent, useImageElementContent, useImageElementDesign, useInputboxElementContent, useInstantsiteJsApi, useLayoutElementDesign, useLogoElementContent, useLogoElementDesign, useMenuElementContent, useNavigationMenuElementContent, useSelectboxElementContent, useSelectboxElementDesign, useTextElementDesign, useTextareaElementContent, useTextareaElementDesign, useToggleElementContent, useToggleElementDesign, useVueBaseProps };
 export type { ButtonContent, Card, Deck, ImageContent, InputBoxContent, SelectBoxContent, TextAreaContent, ToggleContent };

package/dist/app.d.ts

@@ -1,5 +1,5 @@
 import * as vue from 'vue';
-import { App, Ref, Component } from 'vue';
+import type { Ref, App, Component } from 'vue';
 
 interface AppBaseContext {
     readonly appName: string;
@@ -56,6 +56,8 @@ interface GlobalDesign {
     customCss?: string;
 }
 
+
+
 interface VueBaseProps<CONTENT, DESIGN> {
     init: (app: App<Element>, contextValue: AppBaseContext, contentValue: CONTENT, designValue: DESIGN, defaultsValue: Record<string, unknown>, externalContent: ExternalContentData, globalDesignValue: GlobalDesign) => void;
     update: (app: App<Element>, contentValue: CONTENT, designValue: DESIGN, defaultsValue: Record<string, unknown>, externalContent: ExternalContentData, globalDesignValue: GlobalDesign) => void;
@@ -239,6 +241,15 @@ declare function useLogoElementContent<CONTENT>(): {
     };
 };
 
+
+
+
+
+
+
+
+
+
 declare function useTextElementDesign<DESIGN>(elementName: keyof DESIGN): {
     font: string | undefined;
     size: number | GlobalTextSizeString | undefined;
@@ -290,6 +301,10 @@ declare function useLayoutElementDesign(): {
 
 declare function useLogoElementDesign<DESIGN>(): vue.ComputedRef<LogoDesignData>;
 
+
+
+
+
 interface VueServerAppExtensions {
     init?: (app: App<Element>) => void;
     render?: <C, D>(app: App<Element>, context: AppBaseContext, data: AppBaseData<C, D>) => void;
@@ -304,6 +319,10 @@ declare function createVueServerApp<C, D>(appComponent: Component, extensions?:
     };
 };
 
+
+
+
+
 interface VueClientAppExtensions {
     init?: (app: App<Element>) => void;
     mount?: <C, D, S extends AppBaseState<C, D>>(app: App<Element>, rootContainer: string, state: S) => void;
@@ -383,5 +402,14 @@ interface InstantsiteJSAPI {
 
 declare function useInstantsiteJsApi(): InstantsiteJSAPI | undefined;
 
+
+
+
+
+
+
+
+
+
 export { EditorTypes, createVueClientApp, createVueServerApp, useBackgroundElementDesign, useButtonElementContent, useButtonElementDesign, useDeckElementContent, useImageElementContent, useImageElementDesign, useInputboxElementContent, useInstantsiteJsApi, useLayoutElementDesign, useLogoElementContent, useLogoElementDesign, useMenuElementContent, useNavigationMenuElementContent, useSelectboxElementContent, useSelectboxElementDesign, useTextElementDesign, useTextareaElementContent, useTextareaElementDesign, useToggleElementContent, useToggleElementDesign, useVueBaseProps };
 export type { ButtonContent, Card, Deck, ImageContent, InputBoxContent, SelectBoxContent, TextAreaContent, ToggleContent };