datocms-plugin-sdk 0.3.35-alpha.0 → 0.5.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/connect.js +17 -6
- package/dist/cjs/connect.js.map +1 -1
- package/dist/cjs/guards.js +3 -2
- package/dist/cjs/guards.js.map +1 -1
- package/dist/esm/connect.d.ts +18 -3
- package/dist/esm/connect.js +18 -7
- package/dist/esm/connect.js.map +1 -1
- package/dist/esm/guards.d.ts +5 -1
- package/dist/esm/guards.js +2 -1
- package/dist/esm/guards.js.map +1 -1
- package/dist/esm/types.d.ts +32 -6
- package/dist/types/connect.d.ts +18 -3
- package/dist/types/guards.d.ts +5 -1
- package/dist/types/types.d.ts +32 -6
- package/package.json +4 -4
- package/src/connect.ts +54 -5
- package/src/guards.ts +6 -1
- package/src/types.ts +41 -6
- package/types.json +2011 -1484
package/dist/cjs/connect.js
CHANGED
|
@@ -111,7 +111,7 @@ var buildRenderUtils = function (parent) {
|
|
|
111
111
|
function connect(configuration) {
|
|
112
112
|
if (configuration === void 0) { configuration = {}; }
|
|
113
113
|
return __awaiter(this, void 0, void 0, function () {
|
|
114
|
-
var assetSources, mainNavigationTabs, settingsAreaSidebarItemGroups, contentAreaSidebarItems, manualFieldExtensions, itemFormSidebarPanels, listener, penpalConnection, parent, initialSettings, render, render, renderUtils_1, render, renderUtils_2, render, renderUtils_3, render, renderUtils_4, render, renderUtils_5, render, renderUtils_6, render;
|
|
114
|
+
var assetSources, mainNavigationTabs, settingsAreaSidebarItemGroups, contentAreaSidebarItems, manualFieldExtensions, itemFormSidebarPanels, listener, penpalConnection, parent, initialSettings, render, render, renderUtils_1, render, renderUtils_2, render, renderUtils_3, render, renderUtils_4, render, renderUtils_5, render, renderUtils_6, render, renderUtils_7, render;
|
|
115
115
|
return __generator(this, function (_a) {
|
|
116
116
|
switch (_a.label) {
|
|
117
117
|
case 0:
|
|
@@ -208,7 +208,7 @@ function connect(configuration) {
|
|
|
208
208
|
listener = render;
|
|
209
209
|
render(initialSettings);
|
|
210
210
|
}
|
|
211
|
-
if ((0, guards_1.
|
|
211
|
+
if ((0, guards_1.isRenderSidebarPanelParent)(parent, initialSettings)) {
|
|
212
212
|
renderUtils_4 = buildRenderUtils(parent);
|
|
213
213
|
render = function (settings) {
|
|
214
214
|
if (!configuration.renderItemFormSidebarPanel) {
|
|
@@ -219,24 +219,35 @@ function connect(configuration) {
|
|
|
219
219
|
listener = render;
|
|
220
220
|
render(initialSettings);
|
|
221
221
|
}
|
|
222
|
-
if ((0, guards_1.
|
|
222
|
+
if ((0, guards_1.isRenderItemFormOutletParent)(parent, initialSettings)) {
|
|
223
223
|
renderUtils_5 = buildRenderUtils(parent);
|
|
224
|
+
render = function (settings) {
|
|
225
|
+
if (!configuration.renderItemFormOutlet) {
|
|
226
|
+
return;
|
|
227
|
+
}
|
|
228
|
+
configuration.renderItemFormOutlet(settings.itemFormOutletId, __assign(__assign(__assign({}, parent), settings), renderUtils_5));
|
|
229
|
+
};
|
|
230
|
+
listener = render;
|
|
231
|
+
render(initialSettings);
|
|
232
|
+
}
|
|
233
|
+
if ((0, guards_1.isRenderFieldExtensionParent)(parent, initialSettings)) {
|
|
234
|
+
renderUtils_6 = buildRenderUtils(parent);
|
|
224
235
|
render = function (settings) {
|
|
225
236
|
if (!configuration.renderFieldExtension) {
|
|
226
237
|
return;
|
|
227
238
|
}
|
|
228
|
-
configuration.renderFieldExtension(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings),
|
|
239
|
+
configuration.renderFieldExtension(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings), renderUtils_6));
|
|
229
240
|
};
|
|
230
241
|
listener = render;
|
|
231
242
|
render(initialSettings);
|
|
232
243
|
}
|
|
233
244
|
if ((0, guards_1.isRenderManualFieldExtensionConfigScreenParent)(parent, initialSettings)) {
|
|
234
|
-
|
|
245
|
+
renderUtils_7 = buildRenderUtils(parent);
|
|
235
246
|
render = function (settings) {
|
|
236
247
|
if (!configuration.renderManualFieldExtensionConfigScreen) {
|
|
237
248
|
return;
|
|
238
249
|
}
|
|
239
|
-
configuration.renderManualFieldExtensionConfigScreen(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings),
|
|
250
|
+
configuration.renderManualFieldExtensionConfigScreen(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings), renderUtils_7));
|
|
240
251
|
};
|
|
241
252
|
listener = render;
|
|
242
253
|
render(initialSettings);
|
package/dist/cjs/connect.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"connect.js","sourceRoot":"","sources":["../../src/connect.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+EAAyD;AA4BzD,
|
|
1
|
+
{"version":3,"file":"connect.js","sourceRoot":"","sources":["../../src/connect.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+EAAyD;AA4BzD,mCAYkB;AAgOlB,SAAS,YAAY,CACnB,EAA+D;IAE/D,OAAO,UACL,MAAe,EACf,GAA6B;QAE7B,IAAI,CAAC,EAAE,EAAE;YACP,OAAO,EAAE,CAAC;SACX;QAED,IAAM,MAAM,GAA2B,EAAE,CAAC;QAE1C,KAAoB,UAAM,EAAN,iBAAM,EAAN,oBAAM,EAAN,IAAM,EAAE;YAAvB,IAAM,KAAK,eAAA;YACd,IAAM,QAAQ,GAAG,GAAG,CAAC,SAAS,CAC5B,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CACxB,CAAC;YAChB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,wBAAO,GAAG,KAAE,QAAQ,UAAA,IAAG,CAAC;SACpD;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAcD,IAAM,gBAAgB,GAAG,UAAC,MAA+C;IACvE,IAAI,SAAS,GAAkB,IAAI,CAAC;IAEpC,IAAM,YAAY,GAAG,UAAC,MAAe;QACnC,IAAM,UAAU,GACd,MAAM,KAAK,SAAS;YAClB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,EAAE,CAAC,MAAM,CAAC;YACpE,CAAC,CAAC,MAAM,CAAC;QAEb,IAAI,UAAU,KAAK,SAAS,EAAE;YAC5B,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC7B,SAAS,GAAG,UAAU,CAAC;SACxB;IACH,CAAC,CAAC;IAEF,IAAI,kBAAkB,GAAG,KAAK,CAAC;IAC/B,IAAI,gBAAgB,GAA4B,IAAI,CAAC;IAErD,IAAM,WAAW,GAAG,cAAM,OAAA,YAAY,EAAE,EAAd,CAAc,CAAC;IAEzC,IAAM,gBAAgB,GAAG;QACvB,YAAY,EAAE,CAAC;QAEf,IAAI,kBAAkB,EAAE;YACtB,OAAO;SACR;QAED,kBAAkB,GAAG,IAAI,CAAC;QAE1B,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAErD,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;YAC7C,UAAU,EAAE,IAAI;YAChB,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,IAAI;YACb,aAAa,EAAE,IAAI;SACpB,CAAC,CAAC;QAEH,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACjD,CAAC,CAAC;IAEF,IAAM,eAAe,GAAG;QACtB,IAAI,CAAC,kBAAkB,EAAE;YACvB,OAAO;SACR;QAED,kBAAkB,GAAG,KAAK,CAAC;QAE3B,IAAI,gBAAgB,EAAE;YACpB,gBAAgB,CAAC,UAAU,EAAE,CAAC;SAC/B;QAED,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACpD,CAAC,CAAC;IAEF,OAAO,EAAE,YAAY,cAAA,EAAE,gBAAgB,kBAAA,EAAE,eAAe,iBAAA,EAAE,CAAC;AAC7D,CAAC,CAAC;AAEF,SAAsB,OAAO,CAC3B,aAAkD;IAAlD,8BAAA,EAAA,kBAAkD;;;;;;oBAGhD,YAAY,GAMV,aAAa,aANH,EACZ,kBAAkB,GAKhB,aAAa,mBALG,EAClB,6BAA6B,GAI3B,aAAa,8BAJc,EAC7B,uBAAuB,GAGrB,aAAa,wBAHQ,EACvB,qBAAqB,GAEnB,aAAa,sBAFM,EACrB,qBAAqB,GACnB,aAAa,sBADM,CACL;oBAGd,QAAQ,GAAwC,IAAI,CAAC;oBAEnD,gBAAgB,GAAG,IAAA,yBAAe,EAAC;wBACvC,OAAO,EAAE;4BACP,UAAU,EAAE,cAAM,OAAA,OAAO,EAAP,CAAO;4BACzB,gBAAgB,EAAE;gCAChB,OAAA,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,UAAC,EAAY;wCAAX,GAAG,QAAA,EAAE,KAAK,QAAA;oCAC5C,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;wCAC/B,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;qCACpB;oCAED,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gCACtB,CAAC,CAAC,CACH;4BARD,CAQC;4BACH,YAAY,cAAA;4BACZ,kBAAkB,oBAAA;4BAClB,6BAA6B,+BAAA;4BAC7B,uBAAuB,yBAAA;4BACvB,qBAAqB,uBAAA;4BACrB,qBAAqB,uBAAA;4BACrB,uBAAuB,EAAE,YAAY,CACnC,aAAa,CAAC,uBAAuB,CACtC;4BACD,iCAAiC,EAAE,YAAY,CAC7C,aAAa,CAAC,iCAAiC,CAChD;4BACD,uCAAuC,EAAE,YAAY,CACnD,aAAa,CAAC,uCAAuC,CACtD;4BACD,8DAA8D;4BAC9D,QAAQ,EAAR,UAAS,WAAgB;gCACvB,IAAI,QAAQ,EAAE;oCACZ,QAAQ,CAAC,WAAW,CAAC,CAAC;iCACvB;4BACH,CAAC;4BACD,sCAAsC,EACpC,aAAa,CAAC,sCAAsC;yBACvD;qBACF,CAAC,CAAC;oBAEoB,qBAAM,gBAAgB,CAAC,OAAO,EAAA;;oBAA/C,MAAM,GAAW,SAA8B;oBAC7B,qBAAM,MAAM,CAAC,WAAW,EAAE,EAAA;;oBAA5C,eAAe,GAAG,SAA0B;oBAElD,IAAI,IAAA,qBAAY,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBACzC,oDAAoD;qBACrD;oBAED,IAAI,IAAA,uBAAc,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGrC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;gCACzB,OAAO;6BACR;4BAED,aAAa,CAAC,MAAM,uBACf,MAAM,GACN,QAAQ,EACX,CAAC;wBACL,CAAC,CAAC;wBAEF,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,IAAA,2BAAkB,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGzC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE;gCAC7B,OAAO;6BACR;4BAED,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,wBACnC,MAAM,GACN,QAAQ,EACX,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,IAAA,mCAA0B,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGjD,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE;gCACrC,OAAO;6BACR;4BAED,aAAa,CAAC,kBAAkB,gCAC3B,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,IAAA,4BAAmB,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAG1C,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE;gCAC9B,OAAO;6BACR;4BAED,aAAa,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,iCACrC,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,IAAA,kCAAyB,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGhD,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE;gCACpC,OAAO;6BACR;4BAED,aAAa,CAAC,iBAAiB,CAAC,QAAQ,CAAC,aAAa,iCACjD,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,IAAA,mCAA0B,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGjD,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,0BAA0B,EAAE;gCAC7C,OAAO;6BACR;4BAED,aAAa,CAAC,0BAA0B,CAAC,QAAQ,CAAC,aAAa,iCAC1D,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,IAAA,qCAA4B,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGnD,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE;gCACvC,OAAO;6BACR;4BAED,aAAa,CAAC,oBAAoB,CAAC,QAAQ,CAAC,gBAAgB,iCACvD,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,IAAA,qCAA4B,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGnD,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE;gCACvC,OAAO;6BACR;4BAED,aAAa,CAAC,oBAAoB,CAAC,QAAQ,CAAC,gBAAgB,iCACvD,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,IAAA,uDAA8C,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAKrE,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,sCAAsC,EAAE;gCACzD,OAAO;6BACR;4BAED,aAAa,CAAC,sCAAsC,CAClD,QAAQ,CAAC,gBAAgB,iCAEpB,MAAM,GACN,QAAQ,GACR,aAAW,EAEjB,CAAC;wBACJ,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;;;;;CACF;AAvPD,0BAuPC"}
|
package/dist/cjs/guards.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.isRenderAssetSourceParent = exports.isRenderManualFieldExtensionConfigScreenParent = exports.isRenderFieldExtensionParent = exports.
|
|
3
|
+
exports.isRenderAssetSourceParent = exports.isRenderManualFieldExtensionConfigScreenParent = exports.isRenderFieldExtensionParent = exports.isRenderItemFormOutletParent = exports.isRenderSidebarPanelParent = exports.isRenderModalParent = exports.isRenderConfigScreenParent = exports.isRenderPageParent = exports.isOnBootParent = exports.isInitParent = void 0;
|
|
4
4
|
function buildGuard(mode) {
|
|
5
5
|
return function (parent, settings) {
|
|
6
6
|
return settings.mode === mode;
|
|
@@ -11,7 +11,8 @@ exports.isOnBootParent = buildGuard('onBoot');
|
|
|
11
11
|
exports.isRenderPageParent = buildGuard('renderPage');
|
|
12
12
|
exports.isRenderConfigScreenParent = buildGuard('renderConfigScreen');
|
|
13
13
|
exports.isRenderModalParent = buildGuard('renderModal');
|
|
14
|
-
exports.
|
|
14
|
+
exports.isRenderSidebarPanelParent = buildGuard('renderItemFormSidebarPanel');
|
|
15
|
+
exports.isRenderItemFormOutletParent = buildGuard('renderItemFormOutlet');
|
|
15
16
|
exports.isRenderFieldExtensionParent = buildGuard('renderFieldExtension');
|
|
16
17
|
exports.isRenderManualFieldExtensionConfigScreenParent = buildGuard('renderManualFieldExtensionConfigScreen');
|
|
17
18
|
exports.isRenderAssetSourceParent = buildGuard('renderAssetSource');
|
package/dist/cjs/guards.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"guards.js","sourceRoot":"","sources":["../../src/guards.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"guards.js","sourceRoot":"","sources":["../../src/guards.ts"],"names":[],"mappings":";;;AAeA,SAAS,UAAU,CAAmB,IAAY;IAChD,OAAO,UAAC,MAAc,EAAE,QAA0B;QAChD,OAAA,QAAQ,CAAC,IAAI,KAAK,IAAI;IAAtB,CAAsB,CAAC;AAC3B,CAAC;AAEY,QAAA,YAAY,GAAG,UAAU,CAAc,MAAM,CAAC,CAAC;AAE/C,QAAA,cAAc,GAAG,UAAU,CAAgB,QAAQ,CAAC,CAAC;AAErD,QAAA,kBAAkB,GAAG,UAAU,CAAoB,YAAY,CAAC,CAAC;AAEjE,QAAA,0BAA0B,GAAG,UAAU,CAClD,oBAAoB,CACrB,CAAC;AAEW,QAAA,mBAAmB,GAAG,UAAU,CAC3C,aAAa,CACd,CAAC;AAEW,QAAA,0BAA0B,GAAG,UAAU,CAClD,4BAA4B,CAC7B,CAAC;AAEW,QAAA,4BAA4B,GAAG,UAAU,CACpD,sBAAsB,CACvB,CAAC;AAEW,QAAA,4BAA4B,GAAG,UAAU,CACpD,sBAAsB,CACvB,CAAC;AAEW,QAAA,8CAA8C,GAAG,UAAU,CACtE,wCAAwC,CACzC,CAAC;AAEW,QAAA,yBAAyB,GAAG,UAAU,CACjD,mBAAmB,CACpB,CAAC"}
|
package/dist/esm/connect.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Field, ModelBlock } from './SiteApiSchema';
|
|
2
|
-
import { AssetSource, ContentAreaSidebarItem, FieldExtensionOverride, InitPropertiesAndMethods, ItemFormSidebarPanel, MainNavigationTab, ManualFieldExtension, OnBootPropertiesAndMethods, RenderAssetSourcePropertiesAndMethods, RenderConfigScreenPropertiesAndMethods, RenderFieldExtensionPropertiesAndMethods, RenderManualFieldExtensionConfigScreenPropertiesAndMethods, RenderModalPropertiesAndMethods, RenderPagePropertiesAndMethods,
|
|
3
|
-
import { StructuredTextCustomBlockStyle, StructuredTextCustomMark } from '.';
|
|
2
|
+
import { AssetSource, ContentAreaSidebarItem, FieldExtensionOverride, InitPropertiesAndMethods, ItemFormSidebarPanel, MainNavigationTab, ManualFieldExtension, OnBootPropertiesAndMethods, RenderAssetSourcePropertiesAndMethods, RenderConfigScreenPropertiesAndMethods, RenderFieldExtensionPropertiesAndMethods, RenderManualFieldExtensionConfigScreenPropertiesAndMethods, RenderModalPropertiesAndMethods, RenderPagePropertiesAndMethods, RenderSidebarPanelPropertiesAndMethods, SettingsAreaSidebarItemGroup } from './types';
|
|
3
|
+
import { ItemFormOutlet, RenderItemFormOutletPropertiesAndMethods, StructuredTextCustomBlockStyle, StructuredTextCustomMark } from '.';
|
|
4
4
|
export declare type SizingUtilities = {
|
|
5
5
|
/**
|
|
6
6
|
* Listens for DOM changes and automatically calls `setHeight` when it detects
|
|
@@ -26,7 +26,8 @@ export declare type FieldIntentCtx = InitPropertiesAndMethods & {
|
|
|
26
26
|
export declare type RenderPageCtx = RenderPagePropertiesAndMethods;
|
|
27
27
|
export declare type RenderModalCtx = RenderModalPropertiesAndMethods & SizingUtilities;
|
|
28
28
|
export declare type RenderAssetSourceCtx = RenderAssetSourcePropertiesAndMethods & SizingUtilities;
|
|
29
|
-
export declare type RenderItemFormSidebarPanelCtx =
|
|
29
|
+
export declare type RenderItemFormSidebarPanelCtx = RenderSidebarPanelPropertiesAndMethods & SizingUtilities;
|
|
30
|
+
export declare type RenderItemFormOutletCtx = RenderItemFormOutletPropertiesAndMethods & SizingUtilities;
|
|
30
31
|
export declare type RenderFieldExtensionCtx = RenderFieldExtensionPropertiesAndMethods & SizingUtilities;
|
|
31
32
|
export declare type RenderManualFieldExtensionConfigScreenCtx = RenderManualFieldExtensionConfigScreenPropertiesAndMethods & SizingUtilities;
|
|
32
33
|
export declare type RenderConfigScreenCtx = RenderConfigScreenPropertiesAndMethods & SizingUtilities;
|
|
@@ -78,6 +79,13 @@ export declare type FullConnectParameters = {
|
|
|
78
79
|
* @group sidebarPanels
|
|
79
80
|
*/
|
|
80
81
|
itemFormSidebarPanels: (itemType: ModelBlock, ctx: IntentCtx) => ItemFormSidebarPanel[];
|
|
82
|
+
/**
|
|
83
|
+
* Use this function to declare custom outlets to be shown at the top of the
|
|
84
|
+
* record's editing page
|
|
85
|
+
*
|
|
86
|
+
* @group sidebarPanels
|
|
87
|
+
*/
|
|
88
|
+
itemFormOutlets: (itemType: ModelBlock, ctx: IntentCtx) => ItemFormOutlet[];
|
|
81
89
|
/**
|
|
82
90
|
* Use this function to automatically force one or more field extensions to a
|
|
83
91
|
* particular field
|
|
@@ -128,6 +136,13 @@ export declare type FullConnectParameters = {
|
|
|
128
136
|
* @group sidebarPanels
|
|
129
137
|
*/
|
|
130
138
|
renderItemFormSidebarPanel: (sidebarPaneId: string, ctx: RenderItemFormSidebarPanelCtx) => void;
|
|
139
|
+
/**
|
|
140
|
+
* This function will be called when the plugin needs to render an outlet (see
|
|
141
|
+
* the `itemFormOutlets` function)
|
|
142
|
+
*
|
|
143
|
+
* @group sidebarPanels
|
|
144
|
+
*/
|
|
145
|
+
renderItemFormOutlet: (itemFormOutletId: string, ctx: RenderItemFormOutletCtx) => void;
|
|
131
146
|
/**
|
|
132
147
|
* This function will be called when the user selects one of the plugin's
|
|
133
148
|
* asset sources to upload a new media file.
|
package/dist/esm/connect.js
CHANGED
|
@@ -46,7 +46,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
|
46
46
|
}
|
|
47
47
|
};
|
|
48
48
|
import connectToParent from 'penpal/lib/connectToParent';
|
|
49
|
-
import { isInitParent, isOnBootParent, isRenderAssetSourceParent, isRenderConfigScreenParent, isRenderFieldExtensionParent, isRenderManualFieldExtensionConfigScreenParent, isRenderModalParent, isRenderPageParent,
|
|
49
|
+
import { isInitParent, isOnBootParent, isRenderAssetSourceParent, isRenderConfigScreenParent, isRenderFieldExtensionParent, isRenderItemFormOutletParent, isRenderManualFieldExtensionConfigScreenParent, isRenderModalParent, isRenderPageParent, isRenderSidebarPanelParent, } from './guards';
|
|
50
50
|
function toMultifield(fn) {
|
|
51
51
|
return function (fields, ctx) {
|
|
52
52
|
if (!fn) {
|
|
@@ -105,7 +105,7 @@ var buildRenderUtils = function (parent) {
|
|
|
105
105
|
export function connect(configuration) {
|
|
106
106
|
if (configuration === void 0) { configuration = {}; }
|
|
107
107
|
return __awaiter(this, void 0, void 0, function () {
|
|
108
|
-
var assetSources, mainNavigationTabs, settingsAreaSidebarItemGroups, contentAreaSidebarItems, manualFieldExtensions, itemFormSidebarPanels, listener, penpalConnection, parent, initialSettings, render, render, renderUtils_1, render, renderUtils_2, render, renderUtils_3, render, renderUtils_4, render, renderUtils_5, render, renderUtils_6, render;
|
|
108
|
+
var assetSources, mainNavigationTabs, settingsAreaSidebarItemGroups, contentAreaSidebarItems, manualFieldExtensions, itemFormSidebarPanels, listener, penpalConnection, parent, initialSettings, render, render, renderUtils_1, render, renderUtils_2, render, renderUtils_3, render, renderUtils_4, render, renderUtils_5, render, renderUtils_6, render, renderUtils_7, render;
|
|
109
109
|
return __generator(this, function (_a) {
|
|
110
110
|
switch (_a.label) {
|
|
111
111
|
case 0:
|
|
@@ -202,7 +202,7 @@ export function connect(configuration) {
|
|
|
202
202
|
listener = render;
|
|
203
203
|
render(initialSettings);
|
|
204
204
|
}
|
|
205
|
-
if (
|
|
205
|
+
if (isRenderSidebarPanelParent(parent, initialSettings)) {
|
|
206
206
|
renderUtils_4 = buildRenderUtils(parent);
|
|
207
207
|
render = function (settings) {
|
|
208
208
|
if (!configuration.renderItemFormSidebarPanel) {
|
|
@@ -213,24 +213,35 @@ export function connect(configuration) {
|
|
|
213
213
|
listener = render;
|
|
214
214
|
render(initialSettings);
|
|
215
215
|
}
|
|
216
|
-
if (
|
|
216
|
+
if (isRenderItemFormOutletParent(parent, initialSettings)) {
|
|
217
217
|
renderUtils_5 = buildRenderUtils(parent);
|
|
218
|
+
render = function (settings) {
|
|
219
|
+
if (!configuration.renderItemFormOutlet) {
|
|
220
|
+
return;
|
|
221
|
+
}
|
|
222
|
+
configuration.renderItemFormOutlet(settings.itemFormOutletId, __assign(__assign(__assign({}, parent), settings), renderUtils_5));
|
|
223
|
+
};
|
|
224
|
+
listener = render;
|
|
225
|
+
render(initialSettings);
|
|
226
|
+
}
|
|
227
|
+
if (isRenderFieldExtensionParent(parent, initialSettings)) {
|
|
228
|
+
renderUtils_6 = buildRenderUtils(parent);
|
|
218
229
|
render = function (settings) {
|
|
219
230
|
if (!configuration.renderFieldExtension) {
|
|
220
231
|
return;
|
|
221
232
|
}
|
|
222
|
-
configuration.renderFieldExtension(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings),
|
|
233
|
+
configuration.renderFieldExtension(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings), renderUtils_6));
|
|
223
234
|
};
|
|
224
235
|
listener = render;
|
|
225
236
|
render(initialSettings);
|
|
226
237
|
}
|
|
227
238
|
if (isRenderManualFieldExtensionConfigScreenParent(parent, initialSettings)) {
|
|
228
|
-
|
|
239
|
+
renderUtils_7 = buildRenderUtils(parent);
|
|
229
240
|
render = function (settings) {
|
|
230
241
|
if (!configuration.renderManualFieldExtensionConfigScreen) {
|
|
231
242
|
return;
|
|
232
243
|
}
|
|
233
|
-
configuration.renderManualFieldExtensionConfigScreen(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings),
|
|
244
|
+
configuration.renderManualFieldExtensionConfigScreen(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings), renderUtils_7));
|
|
234
245
|
};
|
|
235
246
|
listener = render;
|
|
236
247
|
render(initialSettings);
|
package/dist/esm/connect.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"connect.js","sourceRoot":"","sources":["../../src/connect.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,eAAe,MAAM,4BAA4B,CAAC;AA4BzD,OAAO,EACL,YAAY,EACZ,cAAc,EACd,yBAAyB,EACzB,0BAA0B,EAC1B,4BAA4B,EAC5B,8CAA8C,EAC9C,mBAAmB,EACnB,kBAAkB,EAClB,
|
|
1
|
+
{"version":3,"file":"connect.js","sourceRoot":"","sources":["../../src/connect.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,eAAe,MAAM,4BAA4B,CAAC;AA4BzD,OAAO,EACL,YAAY,EACZ,cAAc,EACd,yBAAyB,EACzB,0BAA0B,EAC1B,4BAA4B,EAC5B,4BAA4B,EAC5B,8CAA8C,EAC9C,mBAAmB,EACnB,kBAAkB,EAClB,0BAA0B,GAE3B,MAAM,UAAU,CAAC;AAgOlB,SAAS,YAAY,CACnB,EAA+D;IAE/D,OAAO,UACL,MAAe,EACf,GAA6B;QAE7B,IAAI,CAAC,EAAE,EAAE;YACP,OAAO,EAAE,CAAC;SACX;QAED,IAAM,MAAM,GAA2B,EAAE,CAAC;QAE1C,KAAoB,UAAM,EAAN,iBAAM,EAAN,oBAAM,EAAN,IAAM,EAAE;YAAvB,IAAM,KAAK,eAAA;YACd,IAAM,QAAQ,GAAG,GAAG,CAAC,SAAS,CAC5B,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CACxB,CAAC;YAChB,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,wBAAO,GAAG,KAAE,QAAQ,UAAA,IAAG,CAAC;SACpD;QAED,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAcD,IAAM,gBAAgB,GAAG,UAAC,MAA+C;IACvE,IAAI,SAAS,GAAkB,IAAI,CAAC;IAEpC,IAAM,YAAY,GAAG,UAAC,MAAe;QACnC,IAAM,UAAU,GACd,MAAM,KAAK,SAAS;YAClB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,qBAAqB,EAAE,CAAC,MAAM,CAAC;YACpE,CAAC,CAAC,MAAM,CAAC;QAEb,IAAI,UAAU,KAAK,SAAS,EAAE;YAC5B,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YAC7B,SAAS,GAAG,UAAU,CAAC;SACxB;IACH,CAAC,CAAC;IAEF,IAAI,kBAAkB,GAAG,KAAK,CAAC;IAC/B,IAAI,gBAAgB,GAA4B,IAAI,CAAC;IAErD,IAAM,WAAW,GAAG,cAAM,OAAA,YAAY,EAAE,EAAd,CAAc,CAAC;IAEzC,IAAM,gBAAgB,GAAG;QACvB,YAAY,EAAE,CAAC;QAEf,IAAI,kBAAkB,EAAE;YACtB,OAAO;SACR;QAED,kBAAkB,GAAG,IAAI,CAAC;QAE1B,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,WAAW,CAAC,CAAC;QAErD,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;YAC7C,UAAU,EAAE,IAAI;YAChB,SAAS,EAAE,IAAI;YACf,OAAO,EAAE,IAAI;YACb,aAAa,EAAE,IAAI;SACpB,CAAC,CAAC;QAEH,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACjD,CAAC,CAAC;IAEF,IAAM,eAAe,GAAG;QACtB,IAAI,CAAC,kBAAkB,EAAE;YACvB,OAAO;SACR;QAED,kBAAkB,GAAG,KAAK,CAAC;QAE3B,IAAI,gBAAgB,EAAE;YACpB,gBAAgB,CAAC,UAAU,EAAE,CAAC;SAC/B;QAED,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACpD,CAAC,CAAC;IAEF,OAAO,EAAE,YAAY,cAAA,EAAE,gBAAgB,kBAAA,EAAE,eAAe,iBAAA,EAAE,CAAC;AAC7D,CAAC,CAAC;AAEF,MAAM,UAAgB,OAAO,CAC3B,aAAkD;IAAlD,8BAAA,EAAA,kBAAkD;;;;;;oBAGhD,YAAY,GAMV,aAAa,aANH,EACZ,kBAAkB,GAKhB,aAAa,mBALG,EAClB,6BAA6B,GAI3B,aAAa,8BAJc,EAC7B,uBAAuB,GAGrB,aAAa,wBAHQ,EACvB,qBAAqB,GAEnB,aAAa,sBAFM,EACrB,qBAAqB,GACnB,aAAa,sBADM,CACL;oBAGd,QAAQ,GAAwC,IAAI,CAAC;oBAEnD,gBAAgB,GAAG,eAAe,CAAC;wBACvC,OAAO,EAAE;4BACP,UAAU,EAAE,cAAM,OAAA,OAAO,EAAP,CAAO;4BACzB,gBAAgB,EAAE;gCAChB,OAAA,MAAM,CAAC,WAAW,CAChB,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,UAAC,EAAY;wCAAX,GAAG,QAAA,EAAE,KAAK,QAAA;oCAC5C,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE;wCAC/B,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;qCACpB;oCAED,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gCACtB,CAAC,CAAC,CACH;4BARD,CAQC;4BACH,YAAY,cAAA;4BACZ,kBAAkB,oBAAA;4BAClB,6BAA6B,+BAAA;4BAC7B,uBAAuB,yBAAA;4BACvB,qBAAqB,uBAAA;4BACrB,qBAAqB,uBAAA;4BACrB,uBAAuB,EAAE,YAAY,CACnC,aAAa,CAAC,uBAAuB,CACtC;4BACD,iCAAiC,EAAE,YAAY,CAC7C,aAAa,CAAC,iCAAiC,CAChD;4BACD,uCAAuC,EAAE,YAAY,CACnD,aAAa,CAAC,uCAAuC,CACtD;4BACD,8DAA8D;4BAC9D,QAAQ,EAAR,UAAS,WAAgB;gCACvB,IAAI,QAAQ,EAAE;oCACZ,QAAQ,CAAC,WAAW,CAAC,CAAC;iCACvB;4BACH,CAAC;4BACD,sCAAsC,EACpC,aAAa,CAAC,sCAAsC;yBACvD;qBACF,CAAC,CAAC;oBAEoB,qBAAM,gBAAgB,CAAC,OAAO,EAAA;;oBAA/C,MAAM,GAAW,SAA8B;oBAC7B,qBAAM,MAAM,CAAC,WAAW,EAAE,EAAA;;oBAA5C,eAAe,GAAG,SAA0B;oBAElD,IAAI,YAAY,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBACzC,oDAAoD;qBACrD;oBAED,IAAI,cAAc,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGrC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE;gCACzB,OAAO;6BACR;4BAED,aAAa,CAAC,MAAM,uBACf,MAAM,GACN,QAAQ,EACX,CAAC;wBACL,CAAC,CAAC;wBAEF,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,kBAAkB,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGzC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE;gCAC7B,OAAO;6BACR;4BAED,aAAa,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,wBACnC,MAAM,GACN,QAAQ,EACX,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,0BAA0B,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGjD,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,kBAAkB,EAAE;gCACrC,OAAO;6BACR;4BAED,aAAa,CAAC,kBAAkB,gCAC3B,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,mBAAmB,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAG1C,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,WAAW,EAAE;gCAC9B,OAAO;6BACR;4BAED,aAAa,CAAC,WAAW,CAAC,QAAQ,CAAC,OAAO,iCACrC,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,yBAAyB,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGhD,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,iBAAiB,EAAE;gCACpC,OAAO;6BACR;4BAED,aAAa,CAAC,iBAAiB,CAAC,QAAQ,CAAC,aAAa,iCACjD,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,0BAA0B,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGjD,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,0BAA0B,EAAE;gCAC7C,OAAO;6BACR;4BAED,aAAa,CAAC,0BAA0B,CAAC,QAAQ,CAAC,aAAa,iCAC1D,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,4BAA4B,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGnD,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE;gCACvC,OAAO;6BACR;4BAED,aAAa,CAAC,oBAAoB,CAAC,QAAQ,CAAC,gBAAgB,iCACvD,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,4BAA4B,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAGnD,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE;gCACvC,OAAO;6BACR;4BAED,aAAa,CAAC,oBAAoB,CAAC,QAAQ,CAAC,gBAAgB,iCACvD,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;oBAED,IAAI,8CAA8C,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAKrE,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,sCAAsC,EAAE;gCACzD,OAAO;6BACR;4BAED,aAAa,CAAC,sCAAsC,CAClD,QAAQ,CAAC,gBAAgB,iCAEpB,MAAM,GACN,QAAQ,GACR,aAAW,EAEjB,CAAC;wBACJ,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;;;;;CACF"}
|
package/dist/esm/guards.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { RenderItemFormOutletMethods } from '.';
|
|
1
2
|
import { InitMethods, OnBootMethods, RenderPageMethods, RenderFieldExtensionMethods, RenderConfigScreenMethods, RenderManualFieldExtensionConfigScreenMethods, RenderSidebarPanelMethods, RenderModalMethods, RenderAssetSourceMethods } from './types';
|
|
2
3
|
export declare type Parent = {
|
|
3
4
|
getSettings: () => Promise<{
|
|
@@ -19,9 +20,12 @@ export declare const isRenderConfigScreenParent: (parent: Parent, settings: {
|
|
|
19
20
|
export declare const isRenderModalParent: (parent: Parent, settings: {
|
|
20
21
|
mode: string;
|
|
21
22
|
}) => parent is RenderModalMethods;
|
|
22
|
-
export declare const
|
|
23
|
+
export declare const isRenderSidebarPanelParent: (parent: Parent, settings: {
|
|
23
24
|
mode: string;
|
|
24
25
|
}) => parent is RenderSidebarPanelMethods;
|
|
26
|
+
export declare const isRenderItemFormOutletParent: (parent: Parent, settings: {
|
|
27
|
+
mode: string;
|
|
28
|
+
}) => parent is RenderItemFormOutletMethods;
|
|
25
29
|
export declare const isRenderFieldExtensionParent: (parent: Parent, settings: {
|
|
26
30
|
mode: string;
|
|
27
31
|
}) => parent is RenderFieldExtensionMethods;
|
package/dist/esm/guards.js
CHANGED
|
@@ -8,7 +8,8 @@ export var isOnBootParent = buildGuard('onBoot');
|
|
|
8
8
|
export var isRenderPageParent = buildGuard('renderPage');
|
|
9
9
|
export var isRenderConfigScreenParent = buildGuard('renderConfigScreen');
|
|
10
10
|
export var isRenderModalParent = buildGuard('renderModal');
|
|
11
|
-
export var
|
|
11
|
+
export var isRenderSidebarPanelParent = buildGuard('renderItemFormSidebarPanel');
|
|
12
|
+
export var isRenderItemFormOutletParent = buildGuard('renderItemFormOutlet');
|
|
12
13
|
export var isRenderFieldExtensionParent = buildGuard('renderFieldExtension');
|
|
13
14
|
export var isRenderManualFieldExtensionConfigScreenParent = buildGuard('renderManualFieldExtensionConfigScreen');
|
|
14
15
|
export var isRenderAssetSourceParent = buildGuard('renderAssetSource');
|
package/dist/esm/guards.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"guards.js","sourceRoot":"","sources":["../../src/guards.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"guards.js","sourceRoot":"","sources":["../../src/guards.ts"],"names":[],"mappings":"AAeA,SAAS,UAAU,CAAmB,IAAY;IAChD,OAAO,UAAC,MAAc,EAAE,QAA0B;QAChD,OAAA,QAAQ,CAAC,IAAI,KAAK,IAAI;IAAtB,CAAsB,CAAC;AAC3B,CAAC;AAED,MAAM,CAAC,IAAM,YAAY,GAAG,UAAU,CAAc,MAAM,CAAC,CAAC;AAE5D,MAAM,CAAC,IAAM,cAAc,GAAG,UAAU,CAAgB,QAAQ,CAAC,CAAC;AAElE,MAAM,CAAC,IAAM,kBAAkB,GAAG,UAAU,CAAoB,YAAY,CAAC,CAAC;AAE9E,MAAM,CAAC,IAAM,0BAA0B,GAAG,UAAU,CAClD,oBAAoB,CACrB,CAAC;AAEF,MAAM,CAAC,IAAM,mBAAmB,GAAG,UAAU,CAC3C,aAAa,CACd,CAAC;AAEF,MAAM,CAAC,IAAM,0BAA0B,GAAG,UAAU,CAClD,4BAA4B,CAC7B,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAU,CACpD,sBAAsB,CACvB,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAU,CACpD,sBAAsB,CACvB,CAAC;AAEF,MAAM,CAAC,IAAM,8CAA8C,GAAG,UAAU,CACtE,wCAAwC,CACzC,CAAC;AAEF,MAAM,CAAC,IAAM,yBAAyB,GAAG,UAAU,CACjD,mBAAmB,CACpB,CAAC"}
|
package/dist/esm/types.d.ts
CHANGED
|
@@ -78,7 +78,7 @@ export declare type SettingsAreaSidebarItemGroup = {
|
|
|
78
78
|
* will be displayed by ascending `rank`. If you want to specify an explicit
|
|
79
79
|
* value for `rank`, make sure to offer a way for final users to customize it
|
|
80
80
|
* inside the plugin's settings form, otherwise the hardcoded value you choose
|
|
81
|
-
* might clash with the one of another plugin!
|
|
81
|
+
* might clash with the one of another plugin!
|
|
82
82
|
*/
|
|
83
83
|
rank?: number;
|
|
84
84
|
};
|
|
@@ -111,7 +111,7 @@ export declare type ContentAreaSidebarItem = {
|
|
|
111
111
|
* will be displayed by ascending `rank`. If you want to specify an explicit
|
|
112
112
|
* value for `rank`, make sure to offer a way for final users to customize it
|
|
113
113
|
* inside the plugin's settings form, otherwise the hardcoded value you choose
|
|
114
|
-
* might clash with the one of another plugin!
|
|
114
|
+
* might clash with the one of another plugin!
|
|
115
115
|
*/
|
|
116
116
|
rank?: number;
|
|
117
117
|
};
|
|
@@ -192,7 +192,21 @@ export declare type ItemFormSidebarPanel = {
|
|
|
192
192
|
* sorted by ascending `rank`. If you want to specify an explicit value for
|
|
193
193
|
* `rank`, make sure to offer a way for final users to customize it inside the
|
|
194
194
|
* plugin's settings form, otherwise the hardcoded value you choose might
|
|
195
|
-
* clash with the one of another plugin!
|
|
195
|
+
* clash with the one of another plugin!
|
|
196
|
+
*/
|
|
197
|
+
rank?: number;
|
|
198
|
+
/** The initial height to set for the iframe that will render the sidebar panel */
|
|
199
|
+
initialHeight?: number;
|
|
200
|
+
};
|
|
201
|
+
/** An outlet to be shown at the top of a record's editing page */
|
|
202
|
+
export declare type ItemFormOutlet = {
|
|
203
|
+
/** ID of the outlet. Will be the first argument for the `renderItemFormOutlet` function */
|
|
204
|
+
id: string;
|
|
205
|
+
/**
|
|
206
|
+
* Multiple outlets will be sorted by ascending `rank`. If you want to specify
|
|
207
|
+
* an explicit value for `rank`, make sure to offer a way for final users to
|
|
208
|
+
* customize it inside the plugin's settings form, otherwise the hardcoded
|
|
209
|
+
* value you choose might clash with the one of another plugin!
|
|
196
210
|
*/
|
|
197
211
|
rank?: number;
|
|
198
212
|
/** The initial height to set for the iframe that will render the sidebar panel */
|
|
@@ -220,7 +234,7 @@ export declare type EditorOverride = {
|
|
|
220
234
|
* win. If you want to specify an explicit value for `rank`, make sure to
|
|
221
235
|
* offer a way for final users to customize it inside the plugin's settings
|
|
222
236
|
* form, otherwise the hardcoded value you choose might clash with the one of
|
|
223
|
-
* another plugin!
|
|
237
|
+
* another plugin!
|
|
224
238
|
*/
|
|
225
239
|
rank?: number;
|
|
226
240
|
/** The initial height to set for the iframe that will render the field extension */
|
|
@@ -243,7 +257,7 @@ export declare type AddonOverride = {
|
|
|
243
257
|
* ascending `rank`. If you want to specify an explicit value for `rank`, make
|
|
244
258
|
* sure to offer a way for final users to customize it inside the plugin's
|
|
245
259
|
* settings form, otherwise the hardcoded value you choose might clash with
|
|
246
|
-
* the one of another plugin!
|
|
260
|
+
* the one of another plugin!
|
|
247
261
|
*/
|
|
248
262
|
rank?: number;
|
|
249
263
|
/** The initial height to set for the iframe that will render the field extension */
|
|
@@ -1102,7 +1116,19 @@ export declare type RenderSidebarPanelAdditionalMethods = {
|
|
|
1102
1116
|
getSettings: () => Promise<RenderSidebarPanelProperties>;
|
|
1103
1117
|
};
|
|
1104
1118
|
export declare type RenderSidebarPanelMethods = ItemFormMethods & RenderSidebarPanelAdditionalMethods;
|
|
1105
|
-
export declare type
|
|
1119
|
+
export declare type RenderSidebarPanelPropertiesAndMethods = RenderSidebarPanelMethods & RenderSidebarPanelProperties;
|
|
1120
|
+
/** Information regarding the specific outlet that you need to render */
|
|
1121
|
+
export declare type RenderItemFormOutletAdditionalProperties = {
|
|
1122
|
+
mode: 'renderItemFormOutlet';
|
|
1123
|
+
/** The ID of the outlet that needs to be rendered */
|
|
1124
|
+
itemFormOutletId: string;
|
|
1125
|
+
};
|
|
1126
|
+
export declare type RenderItemFormOutletProperties = ItemFormProperties & RenderItemFormOutletAdditionalProperties;
|
|
1127
|
+
export declare type RenderItemFormOutletAdditionalMethods = {
|
|
1128
|
+
getSettings: () => Promise<RenderItemFormOutletProperties>;
|
|
1129
|
+
};
|
|
1130
|
+
export declare type RenderItemFormOutletMethods = ItemFormMethods & RenderItemFormOutletAdditionalMethods;
|
|
1131
|
+
export declare type RenderItemFormOutletPropertiesAndMethods = RenderItemFormOutletMethods & RenderItemFormOutletProperties;
|
|
1106
1132
|
/**
|
|
1107
1133
|
* Information regarding the state of a specific field where you need to render
|
|
1108
1134
|
* the field extension
|
package/dist/types/connect.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Field, ModelBlock } from './SiteApiSchema';
|
|
2
|
-
import { AssetSource, ContentAreaSidebarItem, FieldExtensionOverride, InitPropertiesAndMethods, ItemFormSidebarPanel, MainNavigationTab, ManualFieldExtension, OnBootPropertiesAndMethods, RenderAssetSourcePropertiesAndMethods, RenderConfigScreenPropertiesAndMethods, RenderFieldExtensionPropertiesAndMethods, RenderManualFieldExtensionConfigScreenPropertiesAndMethods, RenderModalPropertiesAndMethods, RenderPagePropertiesAndMethods,
|
|
3
|
-
import { StructuredTextCustomBlockStyle, StructuredTextCustomMark } from '.';
|
|
2
|
+
import { AssetSource, ContentAreaSidebarItem, FieldExtensionOverride, InitPropertiesAndMethods, ItemFormSidebarPanel, MainNavigationTab, ManualFieldExtension, OnBootPropertiesAndMethods, RenderAssetSourcePropertiesAndMethods, RenderConfigScreenPropertiesAndMethods, RenderFieldExtensionPropertiesAndMethods, RenderManualFieldExtensionConfigScreenPropertiesAndMethods, RenderModalPropertiesAndMethods, RenderPagePropertiesAndMethods, RenderSidebarPanelPropertiesAndMethods, SettingsAreaSidebarItemGroup } from './types';
|
|
3
|
+
import { ItemFormOutlet, RenderItemFormOutletPropertiesAndMethods, StructuredTextCustomBlockStyle, StructuredTextCustomMark } from '.';
|
|
4
4
|
export declare type SizingUtilities = {
|
|
5
5
|
/**
|
|
6
6
|
* Listens for DOM changes and automatically calls `setHeight` when it detects
|
|
@@ -26,7 +26,8 @@ export declare type FieldIntentCtx = InitPropertiesAndMethods & {
|
|
|
26
26
|
export declare type RenderPageCtx = RenderPagePropertiesAndMethods;
|
|
27
27
|
export declare type RenderModalCtx = RenderModalPropertiesAndMethods & SizingUtilities;
|
|
28
28
|
export declare type RenderAssetSourceCtx = RenderAssetSourcePropertiesAndMethods & SizingUtilities;
|
|
29
|
-
export declare type RenderItemFormSidebarPanelCtx =
|
|
29
|
+
export declare type RenderItemFormSidebarPanelCtx = RenderSidebarPanelPropertiesAndMethods & SizingUtilities;
|
|
30
|
+
export declare type RenderItemFormOutletCtx = RenderItemFormOutletPropertiesAndMethods & SizingUtilities;
|
|
30
31
|
export declare type RenderFieldExtensionCtx = RenderFieldExtensionPropertiesAndMethods & SizingUtilities;
|
|
31
32
|
export declare type RenderManualFieldExtensionConfigScreenCtx = RenderManualFieldExtensionConfigScreenPropertiesAndMethods & SizingUtilities;
|
|
32
33
|
export declare type RenderConfigScreenCtx = RenderConfigScreenPropertiesAndMethods & SizingUtilities;
|
|
@@ -78,6 +79,13 @@ export declare type FullConnectParameters = {
|
|
|
78
79
|
* @group sidebarPanels
|
|
79
80
|
*/
|
|
80
81
|
itemFormSidebarPanels: (itemType: ModelBlock, ctx: IntentCtx) => ItemFormSidebarPanel[];
|
|
82
|
+
/**
|
|
83
|
+
* Use this function to declare custom outlets to be shown at the top of the
|
|
84
|
+
* record's editing page
|
|
85
|
+
*
|
|
86
|
+
* @group sidebarPanels
|
|
87
|
+
*/
|
|
88
|
+
itemFormOutlets: (itemType: ModelBlock, ctx: IntentCtx) => ItemFormOutlet[];
|
|
81
89
|
/**
|
|
82
90
|
* Use this function to automatically force one or more field extensions to a
|
|
83
91
|
* particular field
|
|
@@ -128,6 +136,13 @@ export declare type FullConnectParameters = {
|
|
|
128
136
|
* @group sidebarPanels
|
|
129
137
|
*/
|
|
130
138
|
renderItemFormSidebarPanel: (sidebarPaneId: string, ctx: RenderItemFormSidebarPanelCtx) => void;
|
|
139
|
+
/**
|
|
140
|
+
* This function will be called when the plugin needs to render an outlet (see
|
|
141
|
+
* the `itemFormOutlets` function)
|
|
142
|
+
*
|
|
143
|
+
* @group sidebarPanels
|
|
144
|
+
*/
|
|
145
|
+
renderItemFormOutlet: (itemFormOutletId: string, ctx: RenderItemFormOutletCtx) => void;
|
|
131
146
|
/**
|
|
132
147
|
* This function will be called when the user selects one of the plugin's
|
|
133
148
|
* asset sources to upload a new media file.
|
package/dist/types/guards.d.ts
CHANGED
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { RenderItemFormOutletMethods } from '.';
|
|
1
2
|
import { InitMethods, OnBootMethods, RenderPageMethods, RenderFieldExtensionMethods, RenderConfigScreenMethods, RenderManualFieldExtensionConfigScreenMethods, RenderSidebarPanelMethods, RenderModalMethods, RenderAssetSourceMethods } from './types';
|
|
2
3
|
export declare type Parent = {
|
|
3
4
|
getSettings: () => Promise<{
|
|
@@ -19,9 +20,12 @@ export declare const isRenderConfigScreenParent: (parent: Parent, settings: {
|
|
|
19
20
|
export declare const isRenderModalParent: (parent: Parent, settings: {
|
|
20
21
|
mode: string;
|
|
21
22
|
}) => parent is RenderModalMethods;
|
|
22
|
-
export declare const
|
|
23
|
+
export declare const isRenderSidebarPanelParent: (parent: Parent, settings: {
|
|
23
24
|
mode: string;
|
|
24
25
|
}) => parent is RenderSidebarPanelMethods;
|
|
26
|
+
export declare const isRenderItemFormOutletParent: (parent: Parent, settings: {
|
|
27
|
+
mode: string;
|
|
28
|
+
}) => parent is RenderItemFormOutletMethods;
|
|
25
29
|
export declare const isRenderFieldExtensionParent: (parent: Parent, settings: {
|
|
26
30
|
mode: string;
|
|
27
31
|
}) => parent is RenderFieldExtensionMethods;
|
package/dist/types/types.d.ts
CHANGED
|
@@ -78,7 +78,7 @@ export declare type SettingsAreaSidebarItemGroup = {
|
|
|
78
78
|
* will be displayed by ascending `rank`. If you want to specify an explicit
|
|
79
79
|
* value for `rank`, make sure to offer a way for final users to customize it
|
|
80
80
|
* inside the plugin's settings form, otherwise the hardcoded value you choose
|
|
81
|
-
* might clash with the one of another plugin!
|
|
81
|
+
* might clash with the one of another plugin!
|
|
82
82
|
*/
|
|
83
83
|
rank?: number;
|
|
84
84
|
};
|
|
@@ -111,7 +111,7 @@ export declare type ContentAreaSidebarItem = {
|
|
|
111
111
|
* will be displayed by ascending `rank`. If you want to specify an explicit
|
|
112
112
|
* value for `rank`, make sure to offer a way for final users to customize it
|
|
113
113
|
* inside the plugin's settings form, otherwise the hardcoded value you choose
|
|
114
|
-
* might clash with the one of another plugin!
|
|
114
|
+
* might clash with the one of another plugin!
|
|
115
115
|
*/
|
|
116
116
|
rank?: number;
|
|
117
117
|
};
|
|
@@ -192,7 +192,21 @@ export declare type ItemFormSidebarPanel = {
|
|
|
192
192
|
* sorted by ascending `rank`. If you want to specify an explicit value for
|
|
193
193
|
* `rank`, make sure to offer a way for final users to customize it inside the
|
|
194
194
|
* plugin's settings form, otherwise the hardcoded value you choose might
|
|
195
|
-
* clash with the one of another plugin!
|
|
195
|
+
* clash with the one of another plugin!
|
|
196
|
+
*/
|
|
197
|
+
rank?: number;
|
|
198
|
+
/** The initial height to set for the iframe that will render the sidebar panel */
|
|
199
|
+
initialHeight?: number;
|
|
200
|
+
};
|
|
201
|
+
/** An outlet to be shown at the top of a record's editing page */
|
|
202
|
+
export declare type ItemFormOutlet = {
|
|
203
|
+
/** ID of the outlet. Will be the first argument for the `renderItemFormOutlet` function */
|
|
204
|
+
id: string;
|
|
205
|
+
/**
|
|
206
|
+
* Multiple outlets will be sorted by ascending `rank`. If you want to specify
|
|
207
|
+
* an explicit value for `rank`, make sure to offer a way for final users to
|
|
208
|
+
* customize it inside the plugin's settings form, otherwise the hardcoded
|
|
209
|
+
* value you choose might clash with the one of another plugin!
|
|
196
210
|
*/
|
|
197
211
|
rank?: number;
|
|
198
212
|
/** The initial height to set for the iframe that will render the sidebar panel */
|
|
@@ -220,7 +234,7 @@ export declare type EditorOverride = {
|
|
|
220
234
|
* win. If you want to specify an explicit value for `rank`, make sure to
|
|
221
235
|
* offer a way for final users to customize it inside the plugin's settings
|
|
222
236
|
* form, otherwise the hardcoded value you choose might clash with the one of
|
|
223
|
-
* another plugin!
|
|
237
|
+
* another plugin!
|
|
224
238
|
*/
|
|
225
239
|
rank?: number;
|
|
226
240
|
/** The initial height to set for the iframe that will render the field extension */
|
|
@@ -243,7 +257,7 @@ export declare type AddonOverride = {
|
|
|
243
257
|
* ascending `rank`. If you want to specify an explicit value for `rank`, make
|
|
244
258
|
* sure to offer a way for final users to customize it inside the plugin's
|
|
245
259
|
* settings form, otherwise the hardcoded value you choose might clash with
|
|
246
|
-
* the one of another plugin!
|
|
260
|
+
* the one of another plugin!
|
|
247
261
|
*/
|
|
248
262
|
rank?: number;
|
|
249
263
|
/** The initial height to set for the iframe that will render the field extension */
|
|
@@ -1102,7 +1116,19 @@ export declare type RenderSidebarPanelAdditionalMethods = {
|
|
|
1102
1116
|
getSettings: () => Promise<RenderSidebarPanelProperties>;
|
|
1103
1117
|
};
|
|
1104
1118
|
export declare type RenderSidebarPanelMethods = ItemFormMethods & RenderSidebarPanelAdditionalMethods;
|
|
1105
|
-
export declare type
|
|
1119
|
+
export declare type RenderSidebarPanelPropertiesAndMethods = RenderSidebarPanelMethods & RenderSidebarPanelProperties;
|
|
1120
|
+
/** Information regarding the specific outlet that you need to render */
|
|
1121
|
+
export declare type RenderItemFormOutletAdditionalProperties = {
|
|
1122
|
+
mode: 'renderItemFormOutlet';
|
|
1123
|
+
/** The ID of the outlet that needs to be rendered */
|
|
1124
|
+
itemFormOutletId: string;
|
|
1125
|
+
};
|
|
1126
|
+
export declare type RenderItemFormOutletProperties = ItemFormProperties & RenderItemFormOutletAdditionalProperties;
|
|
1127
|
+
export declare type RenderItemFormOutletAdditionalMethods = {
|
|
1128
|
+
getSettings: () => Promise<RenderItemFormOutletProperties>;
|
|
1129
|
+
};
|
|
1130
|
+
export declare type RenderItemFormOutletMethods = ItemFormMethods & RenderItemFormOutletAdditionalMethods;
|
|
1131
|
+
export declare type RenderItemFormOutletPropertiesAndMethods = RenderItemFormOutletMethods & RenderItemFormOutletProperties;
|
|
1106
1132
|
/**
|
|
1107
1133
|
* Information regarding the state of a specific field where you need to render
|
|
1108
1134
|
* the field extension
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "datocms-plugin-sdk",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0-alpha.1",
|
|
4
4
|
"description": "DatoCMS Plugin SDK",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"datocms",
|
|
@@ -36,12 +36,12 @@
|
|
|
36
36
|
"url": "https://github.com/datocms/plugins-sdk/issues"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"
|
|
39
|
+
"@types/react": "^17.0.3",
|
|
40
|
+
"datocms-structured-text-utils": "^2.0.0",
|
|
40
41
|
"penpal": "^4.1.1"
|
|
41
42
|
},
|
|
42
43
|
"devDependencies": {
|
|
43
|
-
"@types/react": "^17.0.3",
|
|
44
44
|
"typedoc": "^0.22.8"
|
|
45
45
|
},
|
|
46
|
-
"gitHead": "
|
|
46
|
+
"gitHead": "9bd9b0b3d4aff9d05c155325cd15f5885cd41427"
|
|
47
47
|
}
|