@chili-publish/studio-connectors 1.25.1 → 1.27.0

package/dist/index.d.ts

@@ -1,4 +1,265 @@
-export * as Connector from './Connector.Shared';
-export * as Data from './DataConnector';
-export * as Font from './FontConnector';
-export * as Media from './MediaConnector';
+declare global {
+	var ConnectorHttpError: ConnectorHttpErrorConstructor;
+	var StudioFormData: StudioFormDataConstructor;
+	var FilePointer: FilePointerConstructor;
+}
+export interface ChiliBody {
+	arrayBuffer: ArrayBufferPointer;
+	text: string;
+}
+export interface ChiliRequestInit {
+	/**
+	 * A StudioFetchBody object or null to set request's body.
+	 */
+	body?: StudioFetchBody | null;
+	/**
+	 * A Headers object, an object literal, or an array of two-item arrays to set request's headers.
+	 */
+	headers?: Dictionary;
+	/**
+	 * A cryptographic hash of the resource to be fetched by request. Sets request's integrity.
+	 */
+	integrity?: string;
+	/**
+	 * A string to set request's method.
+	 */
+	method?: string;
+	/**
+	 * A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.
+	 */
+	redirect?: "error" | "follow" | "manual";
+	/**
+	 * A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.
+	 */
+	referrer?: string;
+}
+export interface ChiliResponse extends ChiliBody {
+	readonly headers: Dictionary;
+	readonly ok: boolean;
+	readonly redirected: boolean;
+	readonly status: number;
+	readonly statusText: string;
+	readonly type: "basic" | "cors" | "default" | "error" | "opaque" | "opaqueredirect";
+	readonly url: string;
+}
+export interface ConnectorConfigValue<Type, ContextType> {
+	readonly name: string;
+	readonly displayName: string;
+	readonly type: Type;
+	readonly context?: ContextType[];
+}
+/**
+ * Interface for the constructor of ConnectorHttpError.
+ */
+export interface ConnectorHttpErrorConstructor {
+	/**
+	 * Creates a new ConnectorHttpError instance.
+	 *
+	 * @param status - The HTTP status code associated with the error.
+	 * @param message - Optional error message.
+	 * @returns A new instance of ConnectorHttpError.
+	 */
+	new (status: number, message?: string): ConnectorHttpError$1;
+	/**
+	 * The prototype of ConnectorHttpError.
+	 */
+	readonly prototype: ConnectorHttpError$1;
+}
+export interface ConnectorRuntimeContext {
+	options: Dictionary;
+	fetch(url: string, init: ChiliRequestInit): Promise<ChiliResponse>;
+	logError(msg: string): void;
+	platform: ChiliPlatform;
+	sdkVersion: string;
+}
+export interface DataConnector {
+	getPage(config: PageConfig, context: Dictionary): Promise<DataPage>;
+	getModel(context: Dictionary): Promise<DataModel>;
+	getConfigurationOptions(): ConnectorConfigOptions$1 | null;
+	getCapabilities(): DataConnectorCapabilities;
+}
+export interface DataFilter {
+	property: string;
+	value: string;
+	type: "contains" | "exact";
+}
+export interface DataSorting {
+	property: string;
+	direction: "asc" | "desc";
+}
+export interface Dictionary {
+	[Key: string]: string | boolean;
+}
+export interface FilePointerConstructor {
+	new (id: string, url: string, name: string): FilePointer$1;
+	/**
+	 * The prototype of FilePointer.
+	 */
+	readonly prototype: FilePointer$1;
+}
+export interface FontFamily {
+	id: string;
+	name: string;
+	fontStylesCount: number;
+	extensions: string[];
+}
+export interface FontStyle {
+	id: string;
+	name: string;
+	familyId: string;
+	familyName: string;
+}
+export interface GrafxFontConnector {
+	detail(connectorId: string, fontFamilyId: string, context: Dictionary): Promise<FontStyle[]>;
+	query(connectorId: string, queryOptions: QueryOptions, context: Dictionary): Promise<FontFamilyPage>;
+	download(styleId: string, context: Dictionary): Promise<ArrayBufferPointer>;
+	preview(familyId: string, previewFormat: FontPreviewFormat, context: Dictionary): Promise<ArrayBufferPointer>;
+	getConfigurationOptions(): ConnectorConfigOptions$1 | null;
+	getCapabilities(): FontConnectorCapabilities;
+}
+export interface Media<MediaType> {
+	id: string;
+	name: string;
+	relativePath: string;
+	metaData: Dictionary;
+	extension?: string;
+	type: MediaType;
+}
+export interface MediaConnector {
+	detail(id: string, context: Dictionary): Promise<MediaDetail$1>;
+	query(options: QueryOptions, context: Dictionary): Promise<MediaPage>;
+	download(id: string, previewType: DownloadType, intent: DownloadIntent, context: Dictionary): Promise<ArrayBufferPointer>;
+	getConfigurationOptions(): ConnectorConfigOptions$1 | null;
+	getCapabilities(): MediaConnectorCapabilities;
+}
+export interface MediaConnectorUpload {
+	upload(filePointers: FilePointer$1[], context: Dictionary): Promise<Media$2[]>;
+}
+export interface PageConfig {
+	filters?: DataFilter[] | null;
+	sorting?: DataSorting[] | null;
+	continuationToken?: string | null;
+	limit: number;
+}
+export interface StudioFormDataConstructor {
+	new (): StudioFormData$1;
+	/**
+	 * The prototype of StudioFormData.
+	 */
+	readonly prototype: StudioFormData$1;
+}
+export type ArrayBufferPointer = {
+	id: string;
+	bytes: number;
+};
+export type ChiliPlatform = "web" | "server";
+export type ConnectorConfigContextType = "query" | "upload";
+export type ConnectorConfigOptions<Type, ContextType> = ConnectorConfigValue<Type, ContextType>[];
+export type ConnectorConfigValueType = "text" | "boolean";
+export type DataConnectorCapabilities = {
+	filtering: boolean;
+	sorting: boolean;
+	model: boolean;
+};
+export type DataConnectorRuntimeContext = ConnectorRuntimeContext;
+export type DataItem = {
+	[key: string]: string | number | boolean | Date | null;
+};
+export type DataModel = {
+	properties: DataModelProperty[];
+};
+export type DataModelProperty = {
+	name: string;
+	type: string;
+};
+export type DataPage = Pick<QueryPage<DataItem>, "data"> & {
+	continuationToken?: string | null;
+};
+export type DownloadIntent = "web" | "print" | "animation";
+export type DownloadType = "thumbnail" | "mediumres" | "highres" | "fullres" | "original";
+export type FileType = 0;
+export type FolderType = 1;
+export type FontConnectorCapabilities = {
+	query: boolean;
+	detail: boolean;
+	preview: boolean;
+	filtering: boolean;
+};
+export type FontFamilyPage = QueryPage<FontFamily>;
+export type FontPreviewFormat = "square" | "line";
+export type MediaConnectorCapabilities = {
+	query: boolean;
+	detail: boolean;
+	filtering: boolean;
+	metadata?: boolean;
+	upload?: boolean;
+};
+export type MediaDetail<MediaType> = Media<MediaType> & {
+	width?: number;
+	height?: number;
+};
+export type MediaPage = QueryPage<Media$2>;
+export type MediaType = FileType | FolderType;
+export type QueryOptions = {
+	filter?: string[] | null;
+	collection?: string | null;
+	pageToken?: string | null;
+	pageSize?: number;
+	sortBy?: string | null;
+	sortOrder?: string | null;
+};
+export type QueryPage<T> = {
+	pageSize: number;
+	links: {
+		nextPage: string;
+	};
+	data: T[];
+};
+export type StudioFetchBody = string | FilePointer$1 | StudioFormData$1;
+export type StudioFormDataValue = string | FilePointer$1;
+interface ConnectorHttpError$1 extends Error {
+	/**
+	 * The HTTP status code associated with the error.
+	 */
+	readonly status: number;
+}
+interface FilePointer$1 {
+	id: string;
+	url: string;
+	name: string;
+}
+interface StudioFormData$1 {
+	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;
+}
+type ConnectorConfigOptions$1 = ConnectorConfigOptions<ConnectorConfigValueType, ConnectorConfigContextType>;
+type ConnectorConfigValue$1 = ConnectorConfigValue<ConnectorConfigValueType, ConnectorConfigContextType>;
+type Media$2 = Media<MediaType>;
+type MediaDetail$1 = MediaDetail<MediaType>;
+
+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 };
+}
+declare namespace Data {
+	export { DataConnector, DataConnectorCapabilities, DataConnectorRuntimeContext, DataItem, DataModel, DataModelProperty, DataPage, PageConfig };
+}
+declare namespace Font {
+	export { FontConnectorCapabilities, FontFamily, FontFamilyPage, FontPreviewFormat, FontStyle, GrafxFontConnector };
+}
+
+export {
+	Connector,
+	Data,
+	Font,
+	Media$1 as Media,
+};
+
+export {};

package/dist/index.js

@@ -0,0 +1,15 @@
+const e = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null
+}, Symbol.toStringTag, { value: "Module" })), o = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null
+}, Symbol.toStringTag, { value: "Module" })), t = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null
+}, Symbol.toStringTag, { value: "Module" })), n = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
+  __proto__: null
+}, Symbol.toStringTag, { value: "Module" }));
+export {
+  e as Connector,
+  o as Data,
+  t as Font,
+  n as Media
+};

package/package.json

@@ -1,18 +1,21 @@
 {
     "name": "@chili-publish/studio-connectors",
-    "version": "1.25.1",
+    "version": "1.27.0",
     "types": "dist/index.d.ts",
+    "type": "module",
     "files": [
         "dist"
     ],
     "license": "MIT",
     "devDependencies": {
         "prettier": "^3.0.3",
-        "typescript": "^5.2.2"
+        "typescript": "^5.2.2",
+        "vite": "^6.3.5",
+        "@types/node": "^22.15.18",
+        "dts-bundle-generator": "^9.0.0"
     },
     "scripts": {
-        "build": "tsc",
-        "build:uat": "tsc",
+        "build": "vite build",
         "prepare-upload": "yarn build && yarn pack && mkdir ./upload/connectors/ -p && cp *.tgz ./upload/connectors/"
     }
 }

package/dist/Connector.Shared.d.ts

@@ -1,137 +0,0 @@
-export interface Dictionary {
-    [Key: string]: string | boolean;
-}
-export type ChiliPlatform = 'web' | 'server';
-export interface ConnectorRuntimeContext {
-    options: Dictionary;
-    fetch(url: string, init: ChiliRequestInit): Promise<ChiliResponse>;
-    logError(msg: string): void;
-    platform: ChiliPlatform;
-    sdkVersion: string;
-}
-export interface FilePointer {
-    id: string;
-    url: string;
-    name: string;
-}
-export type QueryOptions = {
-    sortOrder: string | null;
-    collection: string | null;
-    filter: string[] | null;
-    pageToken: string | null;
-    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 StudioFetchBody object or null to set request's body.
-     */
-    body?: StudioFetchBody | null;
-    /**
-     * A Headers object, an object literal, or an array of two-item arrays to set request's headers.
-     */
-    headers?: Dictionary;
-    /**
-     * A cryptographic hash of the resource to be fetched by request. Sets request's integrity.
-     */
-    integrity?: string;
-    /**
-     * A string to set request's method.
-     */
-    method?: string;
-    /**
-     * A string indicating whether request follows redirects, results in an error upon encountering a redirect, or returns the redirect (in an opaque fashion). Sets request's redirect.
-     */
-    redirect?: 'error' | 'follow' | 'manual';
-    /**
-     * A string whose value is a same-origin URL, "about:client", or the empty string, to set request's referrer.
-     */
-    referrer?: string;
-}
-export interface ChiliBody {
-    arrayBuffer: ArrayBufferPointer;
-    text: string;
-}
-export type ArrayBufferPointer = {
-    id: string;
-    bytes: number;
-};
-export interface ChiliResponse extends ChiliBody {
-    readonly headers: Dictionary;
-    readonly ok: boolean;
-    readonly redirected: boolean;
-    readonly status: number;
-    readonly statusText: string;
-    readonly type: 'basic' | 'cors' | 'default' | 'error' | 'opaque' | 'opaqueredirect';
-    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.
- *
- * This should be thrown when any of the connector methods
- * failed due to a non OK HTTP status code.
- *
- * The framework will be able to handle this error in a better way
- * versus throwing a generic `Error`.
- */
-export interface ConnectorHttpError extends Error {
-    /**
-     * The HTTP status code associated with the error.
-     */
-    readonly status: number;
-}
-/**
- * Interface for the constructor of ConnectorHttpError.
- */
-export interface ConnectorHttpErrorConstructor {
-    /**
-     * Creates a new ConnectorHttpError instance.
-     *
-     * @param status - The HTTP status code associated with the error.
-     * @param message - Optional error message.
-     * @returns A new instance of ConnectorHttpError.
-     */
-    new (status: number, message?: string): ConnectorHttpError;
-    /**
-     * The prototype of ConnectorHttpError.
-     */
-    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/DataConnector.d.ts

@@ -1,42 +0,0 @@
-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/FontConnector.d.ts

@@ -1,35 +0,0 @@
-import { ArrayBufferPointer, ConnectorConfigValue, Dictionary, QueryOptions } from './Connector.Shared';
-export interface GrafxFontConnector {
-    detail(connectorId: string, fontFamilyId: string, context: Dictionary): Promise<FontStyle[]>;
-    query(connectorId: string, queryOptions: QueryOptions, context: Dictionary): Promise<FontFamilyPage>;
-    download(styleId: string, context: Dictionary): Promise<ArrayBufferPointer>;
-    preview(familyId: string, previewFormat: FontPreviewFormat, context: Dictionary): Promise<ArrayBufferPointer>;
-    getConfigurationOptions(): ConnectorConfigValue[] | null;
-    getCapabilities(): FontConnectorCapabilities;
-}
-export type FontPreviewFormat = 'square' | 'line';
-export interface FontFamilyPage {
-    pageSize: number;
-    data: FontFamily[];
-    links: {
-        nextPage: string;
-    };
-}
-export interface FontFamily {
-    id: string;
-    name: string;
-    fontStylesCount: number;
-    extensions: string[];
-}
-export interface FontStyle {
-    id: string;
-    name: string;
-    familyId: string;
-    familyName: string;
-}
-export type FontConnectorCapabilities = {
-    query: boolean;
-    detail: boolean;
-    preview: boolean;
-    filtering: boolean;
-};

package/dist/MediaConnector.d.ts

@@ -1,39 +0,0 @@
-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>;
-    download(id: string, previewType: DownloadType, intent: DownloadIntent, context: Dictionary): Promise<ArrayBufferPointer>;
-    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 {
-    pageSize: number;
-    data: Media[];
-    links: {
-        nextPage: string;
-    };
-}
-export interface Media {
-    id: string;
-    name: string;
-    relativePath: string;
-    type: number;
-    metaData: Dictionary;
-    extension?: string;
-}
-export interface MediaDetail extends Media {
-    width?: number;
-    height?: number;
-}
-export type MediaConnectorCapabilities = {
-    query: boolean;
-    detail: boolean;
-    filtering: boolean;
-    metadata?: boolean;
-    upload?: boolean;
-};