diff --git a/.storybook/main.ts b/.storybook/main.ts index 2429e5c2dd25..cc31e8098476 100644 --- a/.storybook/main.ts +++ b/.storybook/main.ts @@ -1,5 +1,19 @@ import * as path from "node:path"; import type { StorybookConfig } from "@storybook/react-vite"; +import { existsSync, readdirSync } from "node:fs"; + +const isFolderEmptyOrNotExists = (folderPath: string) => { + if (!existsSync(folderPath)) { + return true; // Folder does not exist + } + const contents = readdirSync(folderPath); + + return contents.length === 0; +}; + +const hasPrivateFolders = !isFolderEmptyOrNotExists( + path.join(__dirname, "../../packages/sdk-components-animation/private-src") +); const visualTestingStories: StorybookConfig["stories"] = [ { @@ -67,7 +81,17 @@ export default { }, resolve: { ...config.resolve, - conditions: ["webstudio", "import", "module", "browser", "default"], + conditions: hasPrivateFolders + ? [ + "webstudio-private", + "webstudio", + "import", + "module", + "browser", + "default", + ] + : ["webstudio", "import", "module", "browser", "default"], + alias: [ { find: "~", diff --git a/apps/builder/vite.config.ts b/apps/builder/vite.config.ts index 3357db040a3d..c4780a2cc208 100644 --- a/apps/builder/vite.config.ts +++ b/apps/builder/vite.config.ts @@ -1,4 +1,4 @@ -import { resolve } from "node:path"; +import path, { resolve } from "node:path"; import { defineConfig, type CorsOptions } from "vite"; import { vitePlugin as remix } from "@remix-run/dev"; import { vercelPreset } from "@vercel/remix/vite"; @@ -9,13 +9,28 @@ import { getAuthorizationServerOrigin, isBuilderUrl, } from "./app/shared/router-utils/origins"; -import { readFileSync } from "node:fs"; +import { readFileSync, readdirSync, existsSync } from "node:fs"; + +const isFolderEmptyOrNotExists = (folderPath: string) => { + if (!existsSync(folderPath)) { + return true; // Folder does not exist + } + const contents = readdirSync(folderPath); + + return contents.length === 0; +}; + +const hasPrivateFolders = !isFolderEmptyOrNotExists( + path.join(__dirname, "../../packages/sdk-components-animation/private-src") +); export default defineConfig(({ mode }) => { if (mode === "test") { return { resolve: { - conditions: ["webstudio"], + conditions: hasPrivateFolders + ? ["webstudio-private", "webstudio"] + : ["webstudio"], alias: [ { find: "~", @@ -69,7 +84,10 @@ export default defineConfig(({ mode }) => { }, ], resolve: { - conditions: ["webstudio"], + conditions: hasPrivateFolders + ? ["webstudio-private", "webstudio"] + : ["webstudio"], + alias: [ { find: "~", diff --git a/packages/sdk-components-animation/LICENSE-scroll-timeline b/packages/sdk-components-animation/LICENSE-scroll-timeline deleted file mode 100644 index f49a4e16e68b..000000000000 --- a/packages/sdk-components-animation/LICENSE-scroll-timeline +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. \ No newline at end of file diff --git a/packages/sdk-components-animation/package.json b/packages/sdk-components-animation/package.json index ce873a03dd56..4c32dda89905 100644 --- a/packages/sdk-components-animation/package.json +++ b/packages/sdk-components-animation/package.json @@ -14,6 +14,7 @@ ], "exports": { ".": { + "webstudio-private": "./private-src/components.ts", "webstudio": "./src/components.ts", "types": "./lib/types/components.d.ts", "import": "./lib/components.js" diff --git a/packages/sdk-components-animation/private-src b/packages/sdk-components-animation/private-src index 84bf6c2bf004..33beb37e4f7d 160000 --- a/packages/sdk-components-animation/private-src +++ b/packages/sdk-components-animation/private-src @@ -1 +1 @@ -Subproject commit 84bf6c2bf0044b6d8ce98a4fa863ff5277f5d300 +Subproject commit 33beb37e4f7dccb89a2e4a8cf70b041bb554f65d diff --git a/packages/sdk-components-animation/src/scroll.stories.tsx b/packages/sdk-components-animation/src/scroll.stories.tsx deleted file mode 100644 index 862a1bee3040..000000000000 --- a/packages/sdk-components-animation/src/scroll.stories.tsx +++ /dev/null @@ -1,267 +0,0 @@ -import { parseCssValue } from "@webstudio-is/css-data"; -import { Box, Grid, styled } from "@webstudio-is/design-system"; - -import { Scroll } from "./scroll"; - -const DEBUG = false; - -const H1 = styled("h1"); -const Img = styled("img"); - -export default { - title: "Scroll Animations", -}; - -export const InOut = { - parameters: { - layout: "fullscreen", - }, - - render() { - return ( - - -

- HELLO WORLD -

- - - Start scrolling, and when the current box scrolls out, the “HELLO - WORLD” header will finish animation - - - - When you see this box, the “HELLO WORLD” header will fly out. - - - ); - }, -}; - -export const ClosestProgress = { - parameters: { - layout: "fullscreen", - }, - - render() { - return ( - - - - Scroll right, see progress. -
- Here, "source: closest" is used because the nearest scrollable - - containing block - {" "} - ancestor of the progress indicator is document.scrollingElement. - More details{" "} - - here - - . - - - - - - - ); - }, -}; - -export const Photo = { - parameters: { - layout: "fullscreen", - }, - - render() { - return ( - - - - - -

- Bye, little elephants! -

- - - - - ); - }, -}; diff --git a/packages/sdk-components-animation/src/scroll.tsx b/packages/sdk-components-animation/src/scroll.tsx index ff058683b1d3..17e0cc3f5aab 100644 --- a/packages/sdk-components-animation/src/scroll.tsx +++ b/packages/sdk-components-animation/src/scroll.tsx @@ -1,196 +1,5 @@ -import { - forwardRef, - Suspense, - useId, - useLayoutEffect, - type ElementRef, -} from "react"; -import { ErrorBoundary } from "react-error-boundary"; -import { ClientOnly } from "./shared/client-only"; -import { PolyfillLoader } from "./shared/scroll-polyfill"; -import { DebugDelayLoader } from "./shared/debug-delay-loader"; -import { - escapeCssSpecifier, - convertToSupportedRangeUnit, -} from "./shared/css-utils"; -import type { - AnimationAction, - ScrollRangeValue, -} from "./shared/animation-types"; -import { findKeyframeStylesWithZeroOffset } from "./shared/keyframes"; -import { hyphenateProperty, toValue } from "@webstudio-is/css-engine"; -import { getSourceElement } from "./shared/scroll"; - -const componentAttributeId = `data-ws-animate-id`; - -const createSelector = (id: string) => `[${componentAttributeId}="${id}"] > *`; - -const cartesian = (a: A[], b: B[]) => - a.flatMap((x) => b.map((y) => [x, y] as const)); - -/** - * Scroll does not support https://drafts.csswg.org/scroll-animations/#named-ranges - * However, for simplicity and type unification with the view, we will use the names "start" and "end," - * which will be transformed as follows: - * - "start" → `calc(0% + range)` - * - "end" → `calc(100% - range)` - */ -const getScrollRangeValue = ( - [name, value]: ScrollRangeValue, - element: HTMLElement -) => { - const elementFontSize = parseFloat(getComputedStyle(element).fontSize); - // See also WAAPI has bug https://issues.chromium.org/issues/40929569#comment9 - // so we are using calc even it it's not needed in some cases - if (name === "start") { - return `calc(0% + ${toValue(convertToSupportedRangeUnit(value, { elementFontSize }))})`; - } - return `calc(100% - ${toValue(convertToSupportedRangeUnit(value, { elementFontSize }))})`; -}; - -const Animate = ({ id, action }: { id: string; action: AnimationAction }) => { - useLayoutEffect(() => { - const selector = createSelector(id); - const elements = document.querySelectorAll(selector); - - if (elements.length === 0) { - return; - } - - const elementsAnimations = cartesian( - Array.from(elements), - action.animations - ); - - const disposables = elementsAnimations - .map(([element, animation]) => { - if (element instanceof HTMLElement) { - const source = getSourceElement(action.source ?? "root", element); - - if (source === undefined) { - return; - } - - const timeline = new ScrollTimeline({ - source, - axis: action.axis ?? "block", - }); - - const keyframeEffectOptoins: EffectTiming = { - easing: animation.timing.easing, - fill: animation.timing.fill, - }; - - const rangeStart = animation.timing.rangeStart - ? getScrollRangeValue(animation.timing.rangeStart, element) - : undefined; - - const rangeEnd = animation.timing.rangeEnd - ? getScrollRangeValue(animation.timing.rangeEnd, element) - : undefined; - - const keyframes = animation.keyframes.map((animationKeyframe) => { - const keyframe: Keyframe = { - offset: animationKeyframe.offset, - composite: "auto", - // Probably having linear() easing we don't need easing per keyframe - // easing: animationKeyframe.easing, - }; - - for (const [property, value] of Object.entries( - animationKeyframe.styles - )) { - keyframe[property] = toValue(value); - } - return keyframe; - }); - - const nativeAnimation = element.animate(keyframes, { - ...keyframeEffectOptoins, - // Scroll dependent options - timeline, - // @ts-expect-error missing in types - rangeStart, - rangeEnd, - }); - - return () => { - nativeAnimation.cancel(); - }; - } - }) - .filter((disposable) => disposable !== undefined); - - return () => { - disposables.forEach((dispose) => dispose()); - }; - }, [action.animations, action.axis, action.source, id]); - - return undefined; -}; - -/** - * We use JavaScript to execute animations. - * For animations that run initially, such as scroll or view-based animations, - * we need to set the initial position during server rendering. - * - * On the client side, there's another issue: we use Scroll and View Timeline polyfills. - * These polyfills must be loaded dynamically because they rely on the `window` object globally, - * making them incompatible with standard imports. - * Similarly, for SSR, we need to set styles if the polyfill hasn't loaded yet. - */ -const StylesBeforeAnimate = ({ - id, - action, -}: { - id: string; - action: AnimationAction; -}) => { - const selector = createSelector(id); - - const animationsWithInitialStyles = action.animations.filter( - (animation) => - animation.timing.fill === "backwards" || animation.timing.fill === "both" - ); - - let styleContent = ""; - - let animationId = 0; - for (const animation of animationsWithInitialStyles) { - const styles = findKeyframeStylesWithZeroOffset(animation.keyframes); - if (styles === undefined) { - continue; - } - - const style = Object.entries(styles).map( - ([property, value]) => `${hyphenateProperty(property)}:${toValue(value)};` - ); - - // We use animation to set initial styles to ensure the exact same behavior - // (including specificity and keyframe composition) as the animation executed afterward. - styleContent = ` - ${styleContent} - - @keyframes ws-scroll-animation-${id}-${animationId} { - from { - ${style} - composite: auto; - } - } - - ${selector} { - animation-name: ws-scroll-animation-${id}-${animationId}; - animation-fill-mode: backwards; - animation-play-state: paused; - animation-duration: 1ms; - - } - `; - animationId++; - } - - return