matrix-react-sdk
Version:
SDK for matrix.org using React
45 lines (39 loc) • 4.59 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.WidgetVariableCustomisations = void 0;
/*
* Copyright 2024 New Vector Ltd.
* Copyright 2021 The Matrix.org Foundation C.I.C.
*
* SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
* Please see LICENSE files in the repository root for full details.
*/
// Populate this class with the details of your customisations when copying it.
/**
* Provides a partial set of the variables needed to render any widget. If
* variables are missing or not provided then they will be filled with the
* application-determined defaults.
*
* This will not be called until after isReady() resolves.
* @returns {Partial<Omit<ITemplateParams, "widgetRoomId">>} The variables.
*/
function provideVariables() {
return {};
}
/**
* Resolves to whether or not the customisation point is ready for variables
* to be provided. This will block widgets being rendered.
* @returns {Promise<boolean>} Resolves when ready.
*/
async function isReady() {
return; // default no waiting
}
// This interface summarises all available customisation points and also marks
// them all as optional. This allows customisers to only define and export the
// customisations they need while still maintaining type safety.
// A real customisation module will define and export one or more of the
// customisation points that make up the interface above.
const WidgetVariableCustomisations = exports.WidgetVariableCustomisations = {};
//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJuYW1lcyI6WyJwcm92aWRlVmFyaWFibGVzIiwiaXNSZWFkeSIsIldpZGdldFZhcmlhYmxlQ3VzdG9taXNhdGlvbnMiLCJleHBvcnRzIl0sInNvdXJjZXMiOlsiLi4vLi4vc3JjL2N1c3RvbWlzYXRpb25zL1dpZGdldFZhcmlhYmxlcy50cyJdLCJzb3VyY2VzQ29udGVudCI6WyIvKlxuICogQ29weXJpZ2h0IDIwMjQgTmV3IFZlY3RvciBMdGQuXG4gKiBDb3B5cmlnaHQgMjAyMSBUaGUgTWF0cml4Lm9yZyBGb3VuZGF0aW9uIEMuSS5DLlxuICpcbiAqIFNQRFgtTGljZW5zZS1JZGVudGlmaWVyOiBBR1BMLTMuMC1vbmx5IE9SIEdQTC0zLjAtb25seVxuICogUGxlYXNlIHNlZSBMSUNFTlNFIGZpbGVzIGluIHRoZSByZXBvc2l0b3J5IHJvb3QgZm9yIGZ1bGwgZGV0YWlscy5cbiAqL1xuXG4vLyBQb3B1bGF0ZSB0aGlzIGNsYXNzIHdpdGggdGhlIGRldGFpbHMgb2YgeW91ciBjdXN0b21pc2F0aW9ucyB3aGVuIGNvcHlpbmcgaXQuXG5pbXBvcnQgeyBJVGVtcGxhdGVQYXJhbXMgfSBmcm9tIFwibWF0cml4LXdpZGdldC1hcGlcIjtcblxuLyoqXG4gKiBQcm92aWRlcyBhIHBhcnRpYWwgc2V0IG9mIHRoZSB2YXJpYWJsZXMgbmVlZGVkIHRvIHJlbmRlciBhbnkgd2lkZ2V0LiBJZlxuICogdmFyaWFibGVzIGFyZSBtaXNzaW5nIG9yIG5vdCBwcm92aWRlZCB0aGVuIHRoZXkgd2lsbCBiZSBmaWxsZWQgd2l0aCB0aGVcbiAqIGFwcGxpY2F0aW9uLWRldGVybWluZWQgZGVmYXVsdHMuXG4gKlxuICogVGhpcyB3aWxsIG5vdCBiZSBjYWxsZWQgdW50aWwgYWZ0ZXIgaXNSZWFkeSgpIHJlc29sdmVzLlxuICogQHJldHVybnMge1BhcnRpYWw8T21pdDxJVGVtcGxhdGVQYXJhbXMsIFwid2lkZ2V0Um9vbUlkXCI+Pn0gVGhlIHZhcmlhYmxlcy5cbiAqL1xuZnVuY3Rpb24gcHJvdmlkZVZhcmlhYmxlcygpOiBQYXJ0aWFsPE9taXQ8SVRlbXBsYXRlUGFyYW1zLCBcIndpZGdldFJvb21JZFwiPj4ge1xuICAgIHJldHVybiB7fTtcbn1cblxuLyoqXG4gKiBSZXNvbHZlcyB0byB3aGV0aGVyIG9yIG5vdCB0aGUgY3VzdG9taXNhdGlvbiBwb2ludCBpcyByZWFkeSBmb3IgdmFyaWFibGVzXG4gKiB0byBiZSBwcm92aWRlZC4gVGhpcyB3aWxsIGJsb2NrIHdpZGdldHMgYmVpbmcgcmVuZGVyZWQuXG4gKiBAcmV0dXJucyB7UHJvbWlzZTxib29sZWFuPn0gUmVzb2x2ZXMgd2hlbiByZWFkeS5cbiAqL1xuYXN5bmMgZnVuY3Rpb24gaXNSZWFkeSgpOiBQcm9taXNlPHZvaWQ+IHtcbiAgICByZXR1cm47IC8vIGRlZmF1bHQgbm8gd2FpdGluZ1xufVxuXG4vLyBUaGlzIGludGVyZmFjZSBzdW1tYXJpc2VzIGFsbCBhdmFpbGFibGUgY3VzdG9taXNhdGlvbiBwb2ludHMgYW5kIGFsc28gbWFya3Ncbi8vIHRoZW0gYWxsIGFzIG9wdGlvbmFsLiBUaGlzIGFsbG93cyBjdXN0b21pc2VycyB0byBvbmx5IGRlZmluZSBhbmQgZXhwb3J0IHRoZVxuLy8gY3VzdG9taXNhdGlvbnMgdGhleSBuZWVkIHdoaWxlIHN0aWxsIG1haW50YWluaW5nIHR5cGUgc2FmZXR5LlxuZXhwb3J0IGludGVyZmFjZSBJV2lkZ2V0VmFyaWFibGVzQ3VzdG9taXNhdGlvbnMge1xuICAgIHByb3ZpZGVWYXJpYWJsZXM/OiB0eXBlb2YgcHJvdmlkZVZhcmlhYmxlcztcblxuICAgIC8vIElmIG5vdCBwcm92aWRlZCwgdGhlIGFwcCB3aWxsIGFzc3VtZSB0aGF0IHRoZSBjdXN0b21pc2F0aW9uIGlzIGFsd2F5cyByZWFkeS5cbiAgICBpc1JlYWR5PzogdHlwZW9mIGlzUmVhZHk7XG59XG5cbi8vIEEgcmVhbCBjdXN0b21pc2F0aW9uIG1vZHVsZSB3aWxsIGRlZmluZSBhbmQgZXhwb3J0IG9uZSBvciBtb3JlIG9mIHRoZVxuLy8gY3VzdG9taXNhdGlvbiBwb2ludHMgdGhhdCBtYWtlIHVwIHRoZSBpbnRlcmZhY2UgYWJvdmUuXG5leHBvcnQgY29uc3QgV2lkZ2V0VmFyaWFibGVDdXN0b21pc2F0aW9uczogSVdpZGdldFZhcmlhYmxlc0N1c3RvbWlzYXRpb25zID0ge307XG4iXSwibWFwcGluZ3MiOiI7Ozs7OztBQUFBO0FBQ0E7QUFDQTtBQUNBO0FBQ0E7QUFDQTtBQUNBOztBQUVBOztBQUdBO0FBQ0E7QUFDQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBQ0E7QUFDQSxTQUFTQSxnQkFBZ0JBLENBQUEsRUFBbUQ7RUFDeEUsT0FBTyxDQUFDLENBQUM7QUFDYjs7QUFFQTtBQUNBO0FBQ0E7QUFDQTtBQUNBO0FBQ0EsZUFBZUMsT0FBT0EsQ0FBQSxFQUFrQjtFQUNwQyxPQUFPLENBQUM7QUFDWjs7QUFFQTtBQUNBO0FBQ0E7O0FBUUE7QUFDQTtBQUNPLE1BQU1DLDRCQUE0RCxHQUFBQyxPQUFBLENBQUFELDRCQUFBLEdBQUcsQ0FBQyxDQUFDIiwiaWdub3JlTGlzdCI6W119