@adobe/ccweb-add-on-sdk-types 1.32.0 → 1.33.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/ui/ui-sdk.d.ts +14 -7
package/package.json
CHANGED
package/ui/ui-sdk.d.ts
CHANGED
|
@@ -175,7 +175,12 @@ export declare enum AppEvent {
|
|
|
175
175
|
/**
|
|
176
176
|
* triggered when the document's export permission status changes in review and approval workflow.
|
|
177
177
|
*/
|
|
178
|
-
documentExportAllowedChange = "documentExportAllowedChange"
|
|
178
|
+
documentExportAllowedChange = "documentExportAllowedChange",
|
|
179
|
+
|
|
180
|
+
/**
|
|
181
|
+
* triggered when the host delivers review settings (or related) updates to the add-on.
|
|
182
|
+
*/
|
|
183
|
+
updateReviewSettings = "updateReviewSettings"
|
|
179
184
|
}
|
|
180
185
|
|
|
181
186
|
export declare type AppEventHandlerType<Event extends AppEventType> = (data: AppEventsTypeMap[Event]) => void;
|
|
@@ -197,6 +202,9 @@ declare interface AppEventsTypeMap {
|
|
|
197
202
|
[AppEvent.documentPublishedLinkAvailable]: DocumentPublishedLinkAvailableEventData;
|
|
198
203
|
[AppEvent.documentTitleChange]: DocumentTitleChangeEventData;
|
|
199
204
|
[AppEvent.documentExportAllowedChange]: DocumentExportAllowedChangeEventData;
|
|
205
|
+
|
|
206
|
+
/** Delivered when the host sends review settings (or related) updates to the add-on. */
|
|
207
|
+
[AppEvent.updateReviewSettings]: undefined;
|
|
200
208
|
}
|
|
201
209
|
|
|
202
210
|
export declare type AppEventType = keyof AppEventsTypeMap & string;
|
|
@@ -889,7 +897,6 @@ export declare type DisableDragToDocument = () => void;
|
|
|
889
897
|
*/
|
|
890
898
|
declare interface Document_2 {
|
|
891
899
|
/**
|
|
892
|
-
* @experimental - Experimental API
|
|
893
900
|
* Review and Approval workflow
|
|
894
901
|
*/
|
|
895
902
|
readonly reviewAndApproval: ReviewAndApproval;
|
|
@@ -1984,7 +1991,6 @@ export declare interface RenditionOptions extends RangeOptions {
|
|
|
1984
1991
|
/**
|
|
1985
1992
|
* Rendition options for review asset export.
|
|
1986
1993
|
* Mirrors the service-side RenditionOptions for Review and Approval workflow — no page range, full document only.
|
|
1987
|
-
* @experimental - Experimental interface
|
|
1988
1994
|
*/
|
|
1989
1995
|
export declare interface RenditionOptionsReviewAndApproval extends Omit<RenditionOptions, "range" | "pageIds"> {}
|
|
1990
1996
|
|
|
@@ -2000,7 +2006,6 @@ export declare enum RenditionType {
|
|
|
2000
2006
|
|
|
2001
2007
|
/**
|
|
2002
2008
|
* Interface for Review and Approval workflow operations
|
|
2003
|
-
* @experimental - Experimental API
|
|
2004
2009
|
*/
|
|
2005
2010
|
export declare interface ReviewAndApproval {
|
|
2006
2011
|
/**
|
|
@@ -2025,6 +2030,11 @@ export declare interface ReviewAndApproval {
|
|
|
2025
2030
|
* @returns Promise that resolves when request is cancelled
|
|
2026
2031
|
*/
|
|
2027
2032
|
cancelReviewRequest(): Promise<void>;
|
|
2033
|
+
/**
|
|
2034
|
+
* Completes an ongoing 3P add-on review request, hides any blocking progress modal, and reloads the document
|
|
2035
|
+
* @returns Promise that resolves when the 3P add-on review is marked complete
|
|
2036
|
+
*/
|
|
2037
|
+
completeReviewRequest(): Promise<void>;
|
|
2028
2038
|
}
|
|
2029
2039
|
|
|
2030
2040
|
export declare enum ReviewStatus {
|
|
@@ -2114,7 +2124,6 @@ export declare interface SearchAction extends PanelAction {
|
|
|
2114
2124
|
|
|
2115
2125
|
/**
|
|
2116
2126
|
* Options for setting template review configuration
|
|
2117
|
-
* @experimental - Experimental interface
|
|
2118
2127
|
*/
|
|
2119
2128
|
export declare interface SetTemplateReviewConfigOptions {
|
|
2120
2129
|
/** Review Workflow ID to configure */
|
|
@@ -2157,7 +2166,6 @@ export declare interface SourceMimeTypeInfo {
|
|
|
2157
2166
|
|
|
2158
2167
|
/**
|
|
2159
2168
|
* Options for starting a review request
|
|
2160
|
-
* @experimental - Experimental interface
|
|
2161
2169
|
*/
|
|
2162
2170
|
export declare interface StartReviewRequestOptions {
|
|
2163
2171
|
/**
|
|
@@ -2171,7 +2179,6 @@ export declare interface StartReviewRequestOptions {
|
|
|
2171
2179
|
|
|
2172
2180
|
/**
|
|
2173
2181
|
* Response from starting a review request
|
|
2174
|
-
* @experimental - Experimental interface
|
|
2175
2182
|
*/
|
|
2176
2183
|
export declare interface StartReviewRequestResponse {
|
|
2177
2184
|
/** URL for the add-on to POST review decisions to */
|