@chili-publish/studio-connectors 1.15.0 → 1.17.0

package/dist/DataConnector.d.ts

@@ -0,0 +1,42 @@
+import { ConnectorConfigValue, ConnectorRuntimeContext, Dictionary } from './Connector.Shared';
+export interface DataConnector {
+    getPage(config: PageConfig, context: Dictionary): Promise<DataPage>;
+    getModel(context: Dictionary): Promise<DataModel>;
+    getConfigurationOptions(): ConnectorConfigValue[] | null;
+    getCapabilities(): DataConnectorCapabilities;
+}
+export type DataConnectorRuntimeContext = ConnectorRuntimeContext;
+export type DataConnectorCapabilities = {
+    filtering: boolean;
+    sorting: boolean;
+    model: boolean;
+};
+export declare class DataModel {
+    properties: DataModelProperty[];
+}
+export declare class DataModelProperty {
+    name: string;
+    type: 'number' | 'boolean' | 'singleLine' | 'multiLine' | 'date';
+}
+export type DataItem = {
+    [key: string]: string | number | boolean | Date | null;
+};
+export interface DataPage {
+    data: DataItem[];
+    continuationToken?: string | null;
+}
+export interface PageConfig {
+    filters?: DataFilter[] | null;
+    sorting?: DataSorting[] | null;
+    continuationToken?: string | null;
+    limit: number;
+}
+export interface DataSorting {
+    property: string;
+    direction: 'asc' | 'desc';
+}
+export interface DataFilter {
+    property: string;
+    value: string;
+    type: 'contains' | 'exact';
+}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * as Connector from './Connector.Shared';
+export * as Data from './DataConnector';
 export * as Font from './FontConnector';
 export * as Media from './MediaConnector';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chili-publish/studio-connectors",
-    "version": "1.15.0",
+    "version": "1.17.0",
     "types": "dist/index.d.ts",
     "files": [
         "dist"