@chili-publish/studio-connectors 1.38.0 → 1.40.0

package/dist/index.d.ts

@@ -3,6 +3,13 @@ declare global {
 	var StudioFormData: StudioFormDataConstructor;
 	var FilePointer: FilePointerConstructor;
 }
+export interface BaseConnector<C extends Record<string, boolean | undefined>> {
+	getCapabilities(): C;
+	getConfigurationOptions(): ConnectorConfigOptions$1 | null;
+}
+export interface BidirectionalNavigation extends OneDirectionalNavigation {
+	previousPageToken?: string | null;
+}
 export interface ChiliBody {
 	arrayBuffer: ArrayBufferPointer;
 	text: string;
@@ -73,11 +80,11 @@ export interface ConnectorRuntimeContext {
 	platform: ChiliPlatform;
 	sdkVersion: string;
 }
-export interface DataConnector {
+/**
+ * Default implementation that we use for Output Data Source use case
+ */
+export interface DataConnector extends BaseConnector<DataConnectorCapabilities> {
 	getPage(config: PageConfig, context: Dictionary): Promise<DataPage>;
-	getModel(context: Dictionary): Promise<DataModel>;
-	getConfigurationOptions(): ConnectorConfigOptions$1 | null;
-	getCapabilities(): DataConnectorCapabilities;
 }
 export interface DataFilter {
 	property: string;
@@ -88,6 +95,20 @@ export interface DataSorting {
 	property: string;
 	direction: "asc" | "desc";
 }
+/**
+ * @experimental This interface is still experimental and might change in future releases.
+ *
+ * Contract for connectors that set `DataConnectorCapabilities.dataSourceVariable = true`.
+ * All three methods are required for the Data Source Variable feature.
+ */
+export interface DataSourceVariableCapability extends ModelCapability {
+	/** Bidirectional paged data. */
+	getPage(config: BidirectionalPageConfig, context: Dictionary): Promise<BidirectionalDataPage>;
+	/** Single item by ID; pageOptions (sorting, limit) used to build navigation tokens. */
+	getPageItemById(id: string, pageOptions: PageItemOptions, context: Dictionary): Promise<BidirectionalDataPageItem>;
+	/** Get the data model for the data source variable. */
+	getModel(context: Dictionary): Promise<DataSourceVariableDataModel>;
+}
 export interface Dictionary {
 	[Key: string]: string | boolean;
 }
@@ -136,10 +157,23 @@ export interface MediaConnector {
 export interface MediaConnectorUpload {
 	upload(filePointers: FilePointer$1[], context: Dictionary): Promise<Media$2[]>;
 }
-export interface PageConfig {
+/**
+ * Contract for connectors that set `DataConnectorCapabilities.model = true`.
+ */
+export interface ModelCapability {
+	getModel(context: Dictionary): Promise<DataModel>;
+}
+export interface OneDirectionalNavigation {
+	continuationToken?: string | null;
+}
+export interface PageConfigBase {
 	filters?: DataFilter[] | null;
 	sorting?: DataSorting[] | null;
-	continuationToken?: string | null;
+	limit: number;
+}
+/** Options for getPageItemById: sorting and limit used to build navigation tokens. */
+export interface PageItemOptions {
+	sorting?: DataSorting[] | null;
 	limit: number;
 }
 export interface StudioFormDataConstructor {
@@ -153,6 +187,11 @@ export type ArrayBufferPointer = {
 	id: string;
 	bytes: number;
 };
+export type BidirectionalDataPage = WithNavigation<Pick<QueryPage<DataItem>, "data">, BidirectionalNavigation>;
+export type BidirectionalDataPageItem = WithNavigation<{
+	data: DataItem;
+}, BidirectionalNavigation>;
+export type BidirectionalPageConfig = PageConfigBase & BidirectionalNavigation;
 export type ChiliPlatform = "web" | "server";
 export type ConnectorConfigContextType = "query" | "upload";
 export type ConnectorConfigOptions<Type, ContextType> = ConnectorConfigValue<Type, ContextType>[];
@@ -161,6 +200,7 @@ export type DataConnectorCapabilities = {
 	filtering: boolean;
 	sorting: boolean;
 	model: boolean;
+	dataSourceVariable?: boolean;
 };
 export type DataConnectorRuntimeContext = ConnectorRuntimeContext;
 export type DataItem = {
@@ -173,8 +213,9 @@ export type DataModelProperty = {
 	name: string;
 	type: string;
 };
-export type DataPage = Pick<QueryPage<DataItem>, "data"> & {
-	continuationToken?: string | null;
+export type DataPage = WithNavigation<Pick<QueryPage<DataItem>, "data">, OneDirectionalNavigation>;
+export type DataSourceVariableDataModel = DataModel & {
+	itemIdPropertyName: string;
 };
 export type DownloadIntent = "web" | "print" | "animation";
 export type DownloadType = "thumbnail" | "mediumres" | "highres" | "fullres" | "original";
@@ -201,6 +242,7 @@ export type MediaDetail<MediaType> = Media<MediaType> & {
 };
 export type MediaPage = QueryPage<Media$2>;
 export type MediaType = FileType | FolderType;
+export type PageConfig = PageConfigBase & OneDirectionalNavigation;
 export type QueryOptions = {
 	filter?: string[] | null;
 	collection?: string | null;
@@ -218,6 +260,7 @@ export type QueryPage<T> = {
 };
 export type StudioFetchBody = string | FilePointer$1 | StudioFormData$1;
 export type StudioFormDataValue = string | FilePointer$1;
+export type WithNavigation<T, N extends OneDirectionalNavigation | BidirectionalNavigation> = T & N;
 interface ConnectorHttpError$1 extends Error {
 	/**
 	 * The HTTP status code associated with the error.
@@ -247,10 +290,10 @@ declare namespace Media$1 {
 	export { DownloadIntent, DownloadType, FilePointer$1 as FilePointer, FileType, FolderType, Media$2 as Media, MediaConnector, MediaConnectorCapabilities, MediaConnectorUpload, MediaDetail$1 as MediaDetail, MediaPage, MediaType };
 }
 declare namespace Connector {
-	export { ArrayBufferPointer, ChiliBody, ChiliPlatform, ChiliRequestInit, ChiliResponse, ConnectorConfigContextType, ConnectorConfigOptions$1 as ConnectorConfigOptions, ConnectorConfigValue$1 as ConnectorConfigValue, ConnectorConfigValueType, ConnectorHttpError$1 as ConnectorHttpError, ConnectorRuntimeContext, Dictionary, FilePointer$1 as FilePointer, QueryOptions, StudioFetchBody, StudioFormData$1 as StudioFormData, StudioFormDataValue };
+	export { ArrayBufferPointer, BaseConnector, ChiliBody, ChiliPlatform, ChiliRequestInit, ChiliResponse, ConnectorConfigContextType, ConnectorConfigOptions$1 as ConnectorConfigOptions, ConnectorConfigValue$1 as ConnectorConfigValue, ConnectorConfigValueType, ConnectorHttpError$1 as ConnectorHttpError, ConnectorRuntimeContext, Dictionary, FilePointer$1 as FilePointer, QueryOptions, StudioFetchBody, StudioFormData$1 as StudioFormData, StudioFormDataValue };
 }
 declare namespace Data {
-	export { DataConnector, DataConnectorCapabilities, DataConnectorRuntimeContext, DataItem, DataModel, DataModelProperty, DataPage, PageConfig };
+	export { BidirectionalDataPage, BidirectionalDataPageItem, BidirectionalPageConfig, DataConnector, DataConnectorCapabilities, DataConnectorRuntimeContext, DataItem, DataModel, DataModelProperty, DataPage, DataSourceVariableCapability, DataSourceVariableDataModel, ModelCapability, PageConfig, PageItemOptions };
 }
 declare namespace Font {
 	export { FontConnectorCapabilities, FontFamily, FontFamilyPage, FontPreviewFormat, FontStyle, GrafxFontConnector };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chili-publish/studio-connectors",
-    "version": "1.38.0",
+    "version": "1.40.0",
     "types": "dist/index.d.ts",
     "repository": {
         "type": "git",