@chili-publish/studio-connectors 1.7.4

package/dist/Connector.Shared.d.ts

@@ -0,0 +1,68 @@
+export interface Dictionary {
+    [Key: string]: string;
+}
+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 type QueryOptions = {
+    sortOrder: string | null;
+    collection: string | null;
+    filter: string[] | null;
+    pageToken: string | null;
+    pageSize: number;
+    sortBy: string | null;
+};
+export interface ChiliRequestInit {
+    /**
+     * A BodyInit object or null to set request's body.
+     */
+    body?: string | 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 interface ConnectorConfigValue {
+    readonly name: string;
+    readonly displayName: string;
+    readonly type: ConnectorConfigValueType;
+}

package/dist/FontConnector.d.ts

@@ -0,0 +1,35 @@
+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

@@ -0,0 +1,34 @@
+import { ArrayBufferPointer, ConnectorConfigValue, Dictionary, QueryOptions } 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 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;
+};

package/dist/index.d.ts

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

package/package.json

@@ -0,0 +1,17 @@
+{
+    "name": "@chili-publish/studio-connectors",
+    "version": "1.7.4",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "license": "MIT",
+    "devDependencies": {
+        "prettier": "^3.0.3",
+        "typescript": "^5.2.2"
+    },
+    "scripts": {
+        "build": "tsc",
+        "prepare-upload": "yarn build && yarn pack && mkdir ./upload/connectors/ -p && cp *.tgz ./upload/connectors/"
+    }
+}

package/readme.md

@@ -0,0 +1,45 @@
+# GraFx Studio Connectors
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://github.com/chili-publish/grafx-connector-template/blob/main/LICENSE)
+
+GraFx Studio Connectors is an innovative concept that enables seamless integration with any third-party application capable of serving Studio-compliant resources. We aim to provide a solution that is simple to explain, easy to develop, and maintainable.
+
+## 🌐 General Connector Concept
+
+Our high-level technical goals for the Studio Connectors are:
+
+- Written in popular and easily understood scripting languages (TS, JS).
+- Capable of running connector logic in both client (browser) and server contexts.
+- Secure and isolated from the browser.
+- Enforces memory and CPU limits to ensure an optimal user experience.
+- Small footprint with high performance.
+
+### 📐 Schematic
+![Connector Architecture Overview](./docs/assets/Connectors.png)
+
+### 🔒 Authentication
+We've decoupled authentication and authorization from the connector. You should not store application secrets or anything that allows malicious use of the API you want to connect to inside the connector code. We support several basic authentication methods:
+
+- HTTP Header
+- OAuth2 Client Credentials
+- OAuth2 Resource Owner Password Credentials
+
+You can choose an authentication method for both client (browser) and server side individually. We provide the tools for secure implementation, but the end responsibility lies with the connector author.
+
+### QuickJs
+We use [QuickJS](https://bellard.org/quickjs/) to execute all user-provided scripts, which acts as a Virtual Machine, ensuring the script can never access anything outside the VM. This allows us to restrict the available APIs to the connector developers, ensuring the connector code can safely run both on client (browser) and server (during output generation).
+
+## Connector.js 
+This repository contains examples of Typescript connectors that can be transpiled to a Javascript module. The current connector API is in version 1.0 and is the minimal APIs needed for a full-featured Media browser and things like Dynamic Asset Providers. We need your feedback! If you think you're missing critical stuff to implement your connector, let us know! Feel free to [open a ticket on the SDK repo](https://github.com/chili-publish/editor-sdk/issues/new/choose).
+
+## Connector.json
+This is the wrapper adding metadata to the connector script. This Json can be uploadded using the experimental Connector endpoints of the Environment API. Reach out to your Customer Success contacts to help you set this up. Later this year we will provide a UI to manage connectors on the GraFx platform.
+
+## 📚 SDK Documentation
+[Check out the official SDK documentation on GitHub](https://chili-publish.github.io/studio-sdk/)
+
+## 📬 Feedback?
+We'd love to hear from you! If you have any technical feedback, feature requests, bugs to report, or general technical questions, don’t hesitate to [create a new issue in the SDK repository](https://github.com/chili-publish/editor-sdk/issues/new/choose).
+
+## 📄 License
+This project is [MIT licensed](https://github.com/chili-publish/grafx-connector-template/blob/main/LICENSE).