Skip to content

Commit 3531bfd

Browse files
authored
Release-20250430
Release 20250430
2 parents 86a7645 + 27efcf2 commit 3531bfd

File tree

6 files changed

+86
-51
lines changed

6 files changed

+86
-51
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ To quickly get started building an Adobe Express add-on, follow these steps, or
2727

2828
You'll need:
2929

30-
- Node 16 or better
31-
- NPM 8 or better
30+
- Node 18 or better
31+
- NPM 10 or better
3232
- A text editor
3333
- A free Adobe account — don't have one? Get one [here](https://www.adobe.com/express/)
3434

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"changes": [
3+
{
4+
"packageName": "@adobe/ccweb-add-on-sdk-types",
5+
"comment": "Renamed enum TextType to TextLayout, ColorPickerEvent enum to ColorPickerEvents, updated TextAlignment enum, stabilized ColorPicker API, exported payload types ",
6+
"type": "minor"
7+
}
8+
],
9+
"packageName": "@adobe/ccweb-add-on-sdk-types"
10+
}

packages/wxp-sdk-types/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@adobe/ccweb-add-on-sdk-types",
3-
"version": "1.15.0",
3+
"version": "1.16.0",
44
"author": "Adobe",
55
"license": "MIT",
66
"description": "Type definitions for Adobe Creative Cloud Web Add-on SDK.",

packages/wxp-sdk-types/sandbox/express-document-sdk.d.ts

Lines changed: 55 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ declare namespace ApiConstants {
8181
StrokePosition,
8282
StrokeType,
8383
TextAlignment,
84-
TextType,
84+
TextLayout,
8585
EditorEvent,
8686
VisualEffectType,
8787
ParagraphListType,
@@ -105,7 +105,7 @@ declare interface ApiModuleExport {
105105
* @experimental
106106
*/
107107
export declare interface AreaTextLayout {
108-
type: TextType.area;
108+
type: TextLayout.area;
109109
/**
110110
* The width of the text node in pixels.
111111
*/
@@ -120,6 +120,11 @@ export declare interface AreaTextLayout {
120120
* <InlineAlert slots="text" variant="warning"/>
121121
*
122122
* *Do not depend on the literal numeric values of these constants*, as they may change. Always reference the enum identifiers in your code.
123+
*
124+
* <InlineAlert slots="text" variant="warning"/>
125+
*
126+
* *Additional arrowhead types may be added in the future.* If your code has different branches or cases depending on arrow type,
127+
* always have a default/fallback case to handle any unknown values you may encounter.
123128
*/
124129
declare enum ArrowHeadType {
125130
none = 0,
@@ -201,7 +206,7 @@ export declare class ArtboardNode extends VisualNode implements IRectangularNode
201206
* @experimental
202207
*/
203208
export declare interface AutoHeightTextLayout {
204-
type: TextType.autoHeight;
209+
type: TextLayout.autoHeight;
205210
/**
206211
* The width of the text node in pixels.
207212
*/
@@ -1477,7 +1482,7 @@ export declare interface Point {
14771482
* @experimental
14781483
*/
14791484
export declare interface PointTextLayout {
1480-
type: TextType.autoWidth;
1485+
type: TextLayout.autoWidth;
14811486
}
14821487

14831488
/**
@@ -1799,11 +1804,17 @@ declare interface StyleRange {
17991804
* <InlineAlert slots="text" variant="warning"/>
18001805
*
18011806
* *Do not depend on the literal numeric values of these constants*, as they may change. Always reference the enum identifiers in your code.
1807+
*
1808+
* <InlineAlert slots="text" variant="warning"/>
1809+
*
1810+
* *Additional alignment types may be added in the future.* If your code has different branches or cases depending on text alignment,
1811+
* always have a default/fallback case to handle any unknown values you may encounter.
18021812
*/
18031813
declare enum TextAlignment {
18041814
left = 1,
18051815
right = 2,
1806-
center = 3
1816+
center = 3,
1817+
justifyLeft = 4
18071818
}
18081819

18091820
/**
@@ -1917,6 +1928,43 @@ export declare class TextContentModel {
19171928
hasUnavailableFonts(): boolean;
19181929
}
19191930

1931+
/**
1932+
* <InlineAlert slots="text" variant="warning"/>
1933+
*
1934+
* *Do not depend on the literal numeric values of these constants*, as they may change. Always reference the enum identifiers in your code.
1935+
*
1936+
* <InlineAlert slots="text" variant="warning"/>
1937+
*
1938+
* *Additional text layout types may be added in the future.* If your code has different branches or cases depending on layout type,
1939+
* always have a default/fallback case to handle any unknown values you may encounter.
1940+
*/
1941+
declare enum TextLayout {
1942+
/**
1943+
* Area text: both width and height are explicitly set. If text content is too long to fit, the end of the text will be
1944+
* clipped. If text content is short, the frame's bounds will occupy extra height that is just blank space.
1945+
*/
1946+
area = 1,
1947+
/**
1948+
* Auto-height text: Width is explicitly set, and text wraps to use as much vertical space as necessary to display the
1949+
* full content.
1950+
*/
1951+
autoHeight = 2,
1952+
/**
1953+
* Auto-width, aka point text: both width and height are automatically determined based on the content. There is no
1954+
* automatic line wrapping, so the text will all be on one line unless the text contains explicit newlines.
1955+
*/
1956+
autoWidth = 3,
1957+
/**
1958+
* Text is arranged in a circle or arc. The API does not yet support setting or reading the details of this layout style.
1959+
*/
1960+
circular = 4,
1961+
/**
1962+
* Aka "Dynamic" layout in the UI: text size and styles are automatically varied to create an attractive multi-line layout.
1963+
* The API does not yet support setting or reading the details of this layout style.
1964+
*/
1965+
magicFit = 5
1966+
}
1967+
19201968
/**
19211969
* A TextNode represents a text display frame in the scenegraph. It may display an entire piece of text, or sometimes just
19221970
* a subset of longer text that flows across multiple TextNode "frames". Because of this, the TextNode does not directly hold
@@ -2006,7 +2054,7 @@ export declare class TextNode extends Node {
20062054
* If this TextNode is part of a multi-frame text content flow, it must be configured to use {@link AreaTextLayout}. Other
20072055
* layout modes, except for {@link AreaTextLayout}, are only available for single-frame text.
20082056
*
2009-
* @throws if changing text layout to/from {@link TextType.magicFit} or {@link TextType.circular} layout when the text contains font(s) unavailable to the current user.
2057+
* @throws if changing text layout to/from {@link TextLayout.magicFit} or {@link TextLayout.circular} layout when the text contains font(s) unavailable to the current user.
20102058
* @throws if {@link TextNode} is part of a multi-frame text content flow and the layout is not {@link AreaTextLayout}.
20112059
* @throws if {@link TextNode} is not a part of a multi-frame text content flow and the layout is {@link AreaTextLayout}.
20122060
*/
@@ -2021,25 +2069,6 @@ declare interface TextRange {
20212069
length: number;
20222070
}
20232071

2024-
/**
2025-
* <InlineAlert slots="text" variant="warning"/>
2026-
*
2027-
* *Do not depend on the literal numeric values of these constants*, as they may change. Always reference the enum identifiers in your code.
2028-
*/
2029-
declare enum TextType {
2030-
area = 1,
2031-
/**
2032-
* Soft bottom
2033-
*/
2034-
autoHeight = 2,
2035-
/**
2036-
* Point text
2037-
*/
2038-
autoWidth = 3,
2039-
circular = 4,
2040-
magicFit = 5
2041-
}
2042-
20432072
/**
20442073
* Font the current user does not have access or licensing permissions to create / edit content with.
20452074
*/
@@ -2091,7 +2120,7 @@ export declare interface UnorderedListStyleInput extends BaseParagraphListStyle
20912120
* @experimental
20922121
*/
20932122
export declare interface UnsupportedTextLayout {
2094-
type: TextType.magicFit | TextType.circular;
2123+
type: TextLayout.magicFit | TextLayout.circular;
20952124
}
20962125

20972126
/**

packages/wxp-sdk-types/ui/ui-sdk.d.ts

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -258,17 +258,15 @@ declare interface ApplicationBase {
258258
showModalDialog(dialogOptions: CustomDialogOptions): Promise<CustomDialogResult>;
259259

260260
/**
261-
* @experimental - Experimental API
262261
* Shows a color picker popover anchored to the specified element.
263262
* The anchor element must be an instance of HTMLElement.
264263
* Custom DOM events are dispatched on the anchor element when the color changes or the color picker closes.
265-
* See {@link ColorPickerEvents} for more details.
264+
* See {@link ColorPickerEvent} for more details.
266265
* @param anchorElement - The HTML element to anchor the color picker to.
267266
* @param options - Optional configuration options for customizing the color picker behavior and appearance.
268267
*/
269268
showColorPicker(anchorElement: HTMLElement, options?: ColorPickerOptions): Promise<void>;
270269
/**
271-
* @experimental - Experimental API
272270
* Hides the color picker popover if it is currently visible.
273271
*/
274272
hideColorPicker(): Promise<void>;
@@ -538,10 +536,9 @@ export declare interface ClientStorage {
538536
}
539537

540538
/**
541-
* @experimental - Experimental API
542539
* Custom DOM events dispatched on the anchor element passed to `showColorPicker()` API.
543540
*/
544-
export declare enum ColorPickerEvents {
541+
export declare enum ColorPickerEvent {
545542
/**
546543
* Color change event dispatched when a color is selected.
547544
* The event detail will contain a 'color' property of type string.
@@ -554,7 +551,6 @@ export declare enum ColorPickerEvents {
554551
}
555552

556553
/**
557-
* @experimental - Experimental API
558554
* Options that can be passed to the `showColorPicker` API to customize the color picker's behavior and appearance.
559555
*/
560556
export declare interface ColorPickerOptions {
@@ -564,10 +560,12 @@ export declare interface ColorPickerOptions {
564560
*/
565561
title?: string;
566562
/**
567-
* Initial color for the color picker, in 0xRRGGBB format.
563+
* Initial color for the color picker, in hex format.
564+
* Can provide either as a number in 0xRRGGBB or 0xRRGGBBAA format,
565+
* or as a string in "#RRGGBB" or "#RRGGBBAA" format.
568566
* Default color is 0xFFFFFF (white).
569567
*/
570-
initialColor?: number;
568+
initialColor?: number | string;
571569
/**
572570
* Placement of the color picker popover relative to the anchor element.
573571
* Default placement is ColorPickerPlacement.left.
@@ -586,7 +584,6 @@ export declare interface ColorPickerOptions {
586584
}
587585

588586
/**
589-
* @experimental - Experimental API
590587
* Denotes the placement of the color picker popover relative to its anchor element.
591588
* Used in the placement option of `showColorPicker()` API.
592589
*/
@@ -631,7 +628,6 @@ declare namespace Constants {
631628
DeviceClass,
632629
PlatformType,
633630
ColorPickerPlacement,
634-
ColorPickerEvents,
635631
AuthorizationStatus
636632
};
637633
}
@@ -856,21 +852,21 @@ export { Document_2 as Document };
856852
/**
857853
* The payload data sent to the document id available event handler.
858854
*/
859-
declare interface DocumentIdAvailableEventData {
855+
export declare interface DocumentIdAvailableEventData {
860856
documentId: string | undefined;
861857
}
862858

863859
/**
864860
* The payload data sent to the document link available event handler.
865861
*/
866-
declare interface DocumentLinkAvailableEventData {
862+
export declare interface DocumentLinkAvailableEventData {
867863
documentLink: string | undefined;
868864
}
869865

870866
/**
871867
* The payload data sent to the document title change event handler.
872868
*/
873-
declare interface DocumentTitleChangeEventData {
869+
export declare interface DocumentTitleChangeEventData {
874870
documentTitle: string;
875871
}
876872

@@ -907,7 +903,7 @@ export declare interface DragCompletionData {
907903
/**
908904
* Interface to provide drag options which can be passed to enableDragToDocument to change the drag behavior.
909905
*/
910-
declare interface DragOptions {
906+
export declare interface DragOptions {
911907
/**
912908
* Use preview size for the drag image instead of the element size
913909
*/
@@ -1778,7 +1774,7 @@ declare type UnproxyOrClone<T> = T extends RemoteObject<ProxyMarked> ? Local<T>
17781774
/**
17791775
* Callback to unregister iframe from the add-on SDK.
17801776
*/
1781-
declare type UnregisterIframe = () => void;
1777+
export declare type UnregisterIframe = () => void;
17821778

17831779
/**
17841780
* Types of dialog variants supported.

rush.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,43 +19,43 @@
1919
"packageName": "@adobe/ccweb-add-on-manifest",
2020
"projectFolder": "packages/add-on-manifest",
2121
"reviewCategory": "production",
22-
"shouldPublish": true
22+
"shouldPublish": false
2323
},
2424
{
2525
"packageName": "@adobe/ccweb-add-on-core",
2626
"projectFolder": "packages/wxp-core",
2727
"reviewCategory": "production",
28-
"shouldPublish": true
28+
"shouldPublish": false
2929
},
3030
{
3131
"packageName": "@adobe/create-ccweb-add-on",
3232
"projectFolder": "packages/create-ccweb-add-on",
3333
"reviewCategory": "production",
34-
"shouldPublish": true
34+
"shouldPublish": false
3535
},
3636
{
3737
"packageName": "@adobe/ccweb-add-on-scaffolder",
3838
"projectFolder": "packages/wxp-add-on-scaffolder",
3939
"reviewCategory": "production",
40-
"shouldPublish": true
40+
"shouldPublish": false
4141
},
4242
{
4343
"packageName": "@adobe/ccweb-add-on-scripts",
4444
"projectFolder": "packages/wxp-scripts",
4545
"reviewCategory": "production",
46-
"shouldPublish": true
46+
"shouldPublish": false
4747
},
4848
{
4949
"packageName": "@adobe/ccweb-add-on-ssl",
5050
"projectFolder": "packages/wxp-ssl",
5151
"reviewCategory": "production",
52-
"shouldPublish": true
52+
"shouldPublish": false
5353
},
5454
{
5555
"packageName": "@adobe/ccweb-add-on-analytics",
5656
"projectFolder": "packages/wxp-analytics",
5757
"reviewCategory": "production",
58-
"shouldPublish": true
58+
"shouldPublish": false
5959
},
6060
{
6161
"packageName": "@adobe/ccweb-add-on-sdk-types",

0 commit comments

Comments
 (0)