@frontastic/extension-types
Advanced tools
Comparing version 0.0.10 to 0.0.11
{ | ||
"name": "@frontastic/extension-types", | ||
"version": "0.0.10", | ||
"version": "0.0.11", | ||
"description": "Type definitions required for backend extension development with Frontastic", | ||
@@ -5,0 +5,0 @@ "main": "./src/ts/exports.ts", |
@@ -88,4 +88,22 @@ // This file is autogenerated – run `ant apidocs` to update it | ||
request?: Request; | ||
/** | ||
* Denotes whether a request is coming from the /frontastic/data-source-preview | ||
* Useful for determining when to send back a proper pagePreviewPayload. | ||
*/ | ||
isPreview?: boolean; | ||
} | ||
export interface DataSourcePreviewPayloadElement { | ||
/** | ||
* This will show up as the name of the element in the | ||
* data source preview list in Studio. | ||
*/ | ||
title: string; | ||
/** | ||
* This is the image URL that will be loaded when viewing | ||
* the data source preview list in Studio. | ||
*/ | ||
image?: string; | ||
} | ||
/** | ||
@@ -105,2 +123,9 @@ * Return type for "data-source" extensions. Can contain any payload, depending on the data source. | ||
dataSourcePayload: any; | ||
/** | ||
* Studio will get the data when showing the data source previews from this array. | ||
* | ||
* To increase performance it is recommended to only set this when the data source is requested with | ||
* the DataSourceContext.isPreview property is true. | ||
*/ | ||
previewPayload?: DataSourcePreviewPayloadElement[]; | ||
} | ||
@@ -107,0 +132,0 @@ |
@@ -12,2 +12,3 @@ // This file is autogenerated – run `ant apidocs` to update it | ||
configuration?: any; | ||
hasLivePage?: boolean; | ||
_urls?: any; | ||
@@ -14,0 +15,0 @@ /** |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
14384
447