Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 | 5x 5x 5x 5x 5x 18x 18x 18x 18x 18x 18x 18x 2x 2x 2x 2x 2x 2x 2x 18x 3x 3x 3x 3x 3x 3x 3x 18x 2x 2x 2x 2x 18x 1x 1x 18x 2x 2x 2x 2x 18x 3x 3x 4x 4x 4x 4x 4x 18x 1x 1x 18x 2x 2x 2x 2x 2x 2x 2x 2x 2x 18x 1x 1x 1x 1x 3x 6x 1x 1x 2x 2x 2x 2x 2x 1x 1x 2x 2x 7x 2x 2x 1x 1x | import { EditorAPI, EditorResponse, Id } from '../types/CommonTypes';
import {
ConnectorInstance,
ConnectorMappingDirection,
ConnectorMappingType,
ConnectorOptions,
ConnectorRegistration,
ConnectorState,
ConnectorStateType,
ConnectorToEngineMapping,
ConnectorType,
EngineToConnectorMapping,
} from '../types/ConnectorTypes';
import { getEditorResponseData } from '../utils/EditorResponseData';
import * as Next from '../next/types/ConnectorTypes';
import { WellKnownConfigurationKeys } from '../types/ConfigurationTypes';
import { ConnectorCompatibilityTools } from '../utils/ConnectorCompatibilityTools';
/**
* The ConnectorController manages lifetime of all available connectors, regardless of the type, in the
* document. Use it to add/remove connectors to a template, or set specific configuration.
*
* The way CHILI Studio handles different sources of resources is called 'Connectors'. A Connectors is an
* implementation of a set of capabilities we need to interact with a certain external resource management system.
* In essence a connector is the combination of a Javascript snippet and some metadata. The Javascript snippet
* is loaded in the studio engine using a sandboxed Javascript execution engine (QuickJs). This allows us to
* execute the media connector both on web using webassembly and on the server side during e.g. animation output
* generation.
* This controller is an interface to the running connector instance inside the studio engine. The engine will
* automatically register the 'grafx-media' and 'grafx-font' connectors. Custom connectors need to be registered
* manually.
*/
export class ConnectorController {
/**
* @ignore
*/
#editorAPI: EditorAPI;
#localConfig: Map<string, string>;
#connectorCompatibilityTools: ConnectorCompatibilityTools;
/**
* @ignore
*/
constructor(editorAPI: EditorAPI, localConfig: Map<string, string>) {
this.#editorAPI = editorAPI;
this.#localConfig = localConfig;
this.#connectorCompatibilityTools = new ConnectorCompatibilityTools();
}
/**
* Gets a connector by its id
* @param id the id of the connector
* @returns connector
*/
getById = async (id: Id) => {
// add backwards compatibility code
const res = await this.#editorAPI;
return res
.getConnectorById(id)
.then((result) => getEditorResponseData<Next.ConnectorInstance>(result))
.then((resp) => {
const update: EditorResponse<ConnectorInstance> = { ...resp, parsedData: null };
Eif (resp.parsedData) {
update.parsedData = this.#connectorCompatibilityTools.makeSingleConnectorBackwardsCompatible(
resp.parsedData,
this.#localConfig.get(WellKnownConfigurationKeys.GraFxStudioEnvironmentApiUrl),
);
}
return update;
});
};
/**
* Gets all available connectors of a 'ConnectorType'
* @param type type of connector you want to get
* @returns list of all available connectors of a 'ConnectorType'
*/
getAllByType = async (type: ConnectorType) => {
// add backwards compatibility code
const res = await this.#editorAPI;
return res
.getConnectors(type)
.then((result) => getEditorResponseData<Next.ConnectorInstance[]>(result))
.then((resp) => {
const update: EditorResponse<ConnectorInstance[]> = { ...resp, parsedData: null };
Eif (resp.parsedData) {
update.parsedData = this.#connectorCompatibilityTools.makeMultipleConnectorsBackwardsCompatible(
resp.parsedData,
this.#localConfig.get(WellKnownConfigurationKeys.GraFxStudioEnvironmentApiUrl),
);
}
return update;
});
};
/**
* Registers a new connector in the SDK. After successful registration, depending
* on the connector type, the connector can be configured and used in the template
* Remember to add custom authentication information after registering the connector
* @param registration registration object containing all details about the connector
* @returns the Id of the newly created connector, this Id should be used going forward.
*/
register = async (registration: ConnectorRegistration) => {
const res = await this.#editorAPI;
const connectorRegistration =
this.#connectorCompatibilityTools.makeConnectorSourceForwardsCompatible(registration);
return res
.registerConnector(JSON.stringify(connectorRegistration))
.then((result) => getEditorResponseData<Id>(result));
};
/**
* Unregisters a connector from the document.
* @param id the id of the connector to unregister
* @returns
*/
unregister = async (id: Id) => {
const res = await this.#editorAPI;
return res.unregisterConnector(id).then((result) => getEditorResponseData<null>(result));
};
/**
* Configures a registered connector. A configurator helper is passed as an argument
* of the callback for you to setup your connector.
* @param id the id of your registered connector
* @param configurationCallback callback to setup the connector
* @returns
*/
configure = async (id: Id, configurationCallback: (configurator: ConnectorConfigurator) => Promise<void>) => {
const res = await this.#editorAPI;
// wait for connector to be ready
await this.waitToBeReady(id);
// execute callback
await configurationCallback(new ConnectorConfigurator(id, res));
// invalidate connector in engine
return res.updateConnectorConfiguration(id).then((result) => getEditorResponseData<null>(result));
};
/**
* Gets the current state a connector is in, to wait until a connector is ready to be used, use the 'waitToBeReady'
* method in this controller.
* @param id the id of your registered connector you want to make sure it is loaded
* @returns connector state
*/
getState = async (id: Id) => {
const res = await this.#editorAPI;
return res.getConnectorState(id).then((result) => getEditorResponseData<ConnectorState>(result));
};
/**
* Gets the mapped data from connector.
* @param id the id of your registered connector
* @param direction the mapping direction
* @returns mappings
*/
async getMappings(
id: string,
direction: ConnectorMappingDirection.engineToConnector,
): Promise<EditorResponse<EngineToConnectorMapping[]>>;
async getMappings(
id: string,
direction: ConnectorMappingDirection.connectorToEngine,
): Promise<EditorResponse<ConnectorToEngineMapping[]>>;
async getMappings(id: string, direction?: undefined): Promise<EditorResponse<ConnectorMappingType[]>>;
async getMappings(id: string, direction?: ConnectorMappingDirection) {
const res = await this.#editorAPI;
return res
.getConnectorMappings(id)
.then((result) => getEditorResponseData<ConnectorMappingType[]>(result))
.then((result) =>
!direction
? result
: {
...result,
parsedData: result.parsedData?.filter((cm) => cm.direction === direction),
},
);
}
/**
* Gets the options from the connector.
* @param id the id of your registered connector
* @returns options
*/
getOptions = async (id: string) => {
const res = await this.#editorAPI;
return res.getConnectorOptions(id).then((result) => getEditorResponseData<ConnectorOptions>(result));
};
/**
* Connectors are loaded asynchronously in the editor engine, this causes some challenges while configuring them. To make sure
* an action on the connector will be available, it's advised to await this method. After the Promise resolves we are sure
* the connector is up and running. This is used internally by the configure method to ensure correct execution. It's especially
* useful during startup of the SDK / right after the loadDocument call.
* @param id the id of your registered connector you want to make sure it is loaded
* @returns
*/
waitToBeReady = async (id: Id, timeoutMilliseconds = 2000): Promise<EditorResponse<null>> => {
// minimum timeout is 500ms
let timeout = Math.max(timeoutMilliseconds, 500);
// maximum timeout is 5000ms
timeout = Math.min(timeout, 5000);
const waitTime = 100;
let retries = 0;
try {
// using while loop will prevent stack overflow issues when using recursion
// wait for maximum 2 seconds to fail
while (retries * waitTime < timeout) {
const result = await this.getState(id);
Eif (
result.success &&
result.parsedData &&
(result.parsedData.type === ConnectorStateType.running ||
result.parsedData.type === ConnectorStateType.ready)
) {
return getEditorResponseData<null>(
{ data: null, success: true, error: undefined, status: 0, parsedData: undefined },
false,
);
}
await new Promise((resolve) => setTimeout(resolve, waitTime));
retries++;
}
} catch (err) {
return getEditorResponseData<null>(
{
data: null,
success: false,
error: `Error while getting connector state ${err}`,
status: 50000,
parsedData: undefined,
},
false,
);
}
return getEditorResponseData<null>(
{
data: null,
success: false,
error: `Timed out waiting for connector`,
status: 50000,
parsedData: undefined,
},
false,
);
};
/**
* Updates the mappings for a given connector.
* @param id the id of your registered connector
* @param mappings An array of mapping objects
* @returns
*/
updateMappings = async (id: Id, mappings: ConnectorMappingType[]) => {
return await this.configure(id, async (config) => {
// Retrieve all existing mappings
const { parsedData: existingMappings } = await this.getMappings(id);
// Filter out old mappings that are being replaced with new ones
const filteredMappings =
existingMappings?.filter(
(mapping) =>
!mappings.some(
(newMapping) =>
newMapping.name === mapping.name && newMapping.direction === mapping.direction,
),
) ?? [];
// Filter out new mappings that have empty `name` or `value`
const validMappings = mappings.filter((i) => i.name !== '' && i.value !== '');
// Merge valid new mappings with the filtered existing mappings
const combinedMappings = [...filteredMappings, ...validMappings];
// Update the configuration with the resulted mappings
await config.setMappings(combinedMappings);
});
};
}
/**
* Helper to setup your connector
*/
class ConnectorConfigurator {
/**
* @ignore
*/
#connectorId: Id;
#res: EditorAPI;
/**
* @ignore
*/
constructor(id: Id, res: EditorAPI) {
this.#connectorId = id;
this.#res = res;
}
/**
* Allows to customize the context data a connector can work with. The options data
* will be available using the context parameter in the connector implementation code.
* @param options object containing key value data to pass to connector context
* @returns
*/
setOptions = async (options: ConnectorOptions) => {
return this.#res
.setConnectorOptions(this.#connectorId, JSON.stringify(options))
.then((result) => getEditorResponseData<null>(result));
};
/**
* Allows to map variables or strings to connector context data.
* By defining the mappings, we can trigger re-download of assets (dynamic asset provider)
* or populate filters for the query endpoint. The mapped data will be available using
* the context parameter in the connector implementation code.
*
* For the variables the mapping should follow the format "var.[variable id]". e.g. var.6B29FC40-CA47-1067-B31D-00DD010662DA
*
* @param mappings collection of mappings to set to this connector
* @returns
*/
setMappings = async (mappings: ConnectorMappingType[]) => {
const result = await this.#res.setConnectorMappings(
this.#connectorId,
mappings.map(function (m) {
return JSON.stringify(m);
}),
);
return getEditorResponseData<null>(result);
};
/**
* This method sets the HTTP headers for the 'staticKey' authentication type.
* These additional headers will be added to all connector http calls.
* Can only be used after a connector has been registered. (if you are using a grafx connector no registration is needed)
* @param headerName name of the header
* @param headerValue value of the header
* @returns
*/
setHttpHeader = async (headerName: string, headerValue: string) => {
return this.#res
.connectorAuthenticationSetHttpHeader(this.#connectorId, headerName, headerValue)
.then((result) => getEditorResponseData<null>(result));
};
}
|