@chili-publish/studio-connectors 1.24.0 → 1.25.1

package/dist/Connector.Shared.d.ts

@@ -9,6 +9,11 @@ export interface ConnectorRuntimeContext {
     platform: ChiliPlatform;
     sdkVersion: string;
 }
+export interface FilePointer {
+    id: string;
+    url: string;
+    name: string;
+}
 export type QueryOptions = {
     sortOrder: string | null;
     collection: string | null;
@@ -17,11 +22,22 @@ export type QueryOptions = {
     pageSize: number;
     sortBy: string | null;
 };
+export type StudioFormDataValue = string | FilePointer;
+export interface StudioFormData {
+    append(name: string, value: StudioFormDataValue, filename?: string): void;
+    set(name: string, value: StudioFormDataValue, filename?: string): void;
+    delete(name: string): void;
+    forEach(callback: (value: StudioFormDataValue, name: string) => void): void;
+    get(name: string): StudioFormDataValue | null;
+    getAll(name: string): StudioFormDataValue[];
+    has(name: string): boolean;
+}
+export type StudioFetchBody = string | FilePointer | StudioFormData;
 export interface ChiliRequestInit {
     /**
-     * A BodyInit object or null to set request's body.
+     * A StudioFetchBody object or null to set request's body.
      */
-    body?: string | null;
+    body?: StudioFetchBody | null;
     /**
      * A Headers object, an object literal, or an array of two-item arrays to set request's headers.
      */
@@ -61,10 +77,12 @@ export interface ChiliResponse extends ChiliBody {
     readonly url: string;
 }
 export type ConnectorConfigValueType = 'text' | 'boolean';
+export type ConnectorConfigContextType = 'query' | 'upload';
 export interface ConnectorConfigValue {
     readonly name: string;
     readonly displayName: string;
     readonly type: ConnectorConfigValueType;
+    readonly context?: ConnectorConfigContextType[];
 }
 /**
  * A custom HTTP error for connectors.
@@ -98,6 +116,22 @@ export interface ConnectorHttpErrorConstructor {
      */
     readonly prototype: ConnectorHttpError;
 }
+export interface StudioFormDataConstructor {
+    new (): StudioFormData;
+    /**
+     * The prototype of StudioFormData.
+     */
+    readonly prototype: StudioFormData;
+}
+export interface FilePointerConstructor {
+    new (id: string, url: string, name: string): FilePointer;
+    /**
+     * The prototype of FilePointer.
+     */
+    readonly prototype: FilePointer;
+}
 declare global {
     var ConnectorHttpError: ConnectorHttpErrorConstructor;
+    var StudioFormData: StudioFormDataConstructor;
+    var FilePointer: FilePointerConstructor;
 }

package/dist/MediaConnector.d.ts

@@ -1,4 +1,4 @@
-import { ArrayBufferPointer, ConnectorConfigValue, Dictionary, QueryOptions } from './Connector.Shared';
+import { ArrayBufferPointer, ConnectorConfigValue, Dictionary, QueryOptions, FilePointer } from './Connector.Shared';
 export interface MediaConnector {
     detail(id: string, context: Dictionary): Promise<MediaDetail>;
     query(options: QueryOptions, context: Dictionary): Promise<MediaPage>;
@@ -6,6 +6,9 @@ export interface MediaConnector {
     getConfigurationOptions(): ConnectorConfigValue[] | null;
     getCapabilities(): MediaConnectorCapabilities;
 }
+export interface MediaConnectorUpload {
+    upload(filePointers: FilePointer[], context: Dictionary): Promise<Media[]>;
+}
 export type DownloadIntent = 'web' | 'print' | 'animation';
 export type DownloadType = 'thumbnail' | 'mediumres' | 'highres' | 'fullres' | 'original';
 export interface MediaPage {
@@ -32,4 +35,5 @@ export type MediaConnectorCapabilities = {
     detail: boolean;
     filtering: boolean;
     metadata?: boolean;
+    upload?: boolean;
 };

package/package.json

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