datocms-plugin-sdk 0.7.9 → 0.7.10
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 +20 -8
- package/dist/cjs/connect.js.map +1 -1
- package/dist/cjs/guards.js +2 -1
- package/dist/cjs/guards.js.map +1 -1
- package/dist/esm/connect.d.ts +16 -1
- package/dist/esm/connect.js +21 -9
- package/dist/esm/connect.js.map +1 -1
- package/dist/esm/guards.d.ts +4 -1
- package/dist/esm/guards.js +1 -0
- package/dist/esm/guards.js.map +1 -1
- package/dist/esm/types.d.ts +42 -0
- package/dist/types/connect.d.ts +16 -1
- package/dist/types/guards.d.ts +4 -1
- package/dist/types/types.d.ts +42 -0
- package/package.json +2 -2
- package/src/connect.ts +47 -0
- package/src/guards.ts +5 -0
- package/src/types.ts +51 -0
- package/types.json +3256 -2426
package/dist/cjs/connect.js
CHANGED
|
@@ -121,11 +121,11 @@ var buildRenderUtils = function (parent) {
|
|
|
121
121
|
function connect(configuration) {
|
|
122
122
|
if (configuration === void 0) { configuration = {}; }
|
|
123
123
|
return __awaiter(this, void 0, void 0, function () {
|
|
124
|
-
var assetSources, mainNavigationTabs, settingsAreaSidebarItemGroups, contentAreaSidebarItems, manualFieldExtensions, itemFormSidebarPanels, itemFormOutlets, listener, callMethodMergingBootCtxExecutor, penpalConnection, parent, initialSettings, currentSettings_1, render, renderUtils_1, render, renderUtils_2, render, renderUtils_3, render, renderUtils_4, render, renderUtils_5, render, renderUtils_6, render, renderUtils_7, render;
|
|
124
|
+
var assetSources, mainNavigationTabs, settingsAreaSidebarItemGroups, contentAreaSidebarItems, manualFieldExtensions, itemFormSidebarPanels, itemFormSidebars, itemFormOutlets, listener, callMethodMergingBootCtxExecutor, penpalConnection, parent, initialSettings, currentSettings_1, render, renderUtils_1, render, renderUtils_2, render, renderUtils_3, render, renderUtils_4, render, renderUtils_5, render, renderUtils_6, render, renderUtils_7, render, renderUtils_8, render;
|
|
125
125
|
return __generator(this, function (_a) {
|
|
126
126
|
switch (_a.label) {
|
|
127
127
|
case 0:
|
|
128
|
-
assetSources = configuration.assetSources, mainNavigationTabs = configuration.mainNavigationTabs, settingsAreaSidebarItemGroups = configuration.settingsAreaSidebarItemGroups, contentAreaSidebarItems = configuration.contentAreaSidebarItems, manualFieldExtensions = configuration.manualFieldExtensions, itemFormSidebarPanels = configuration.itemFormSidebarPanels, itemFormOutlets = configuration.itemFormOutlets;
|
|
128
|
+
assetSources = configuration.assetSources, mainNavigationTabs = configuration.mainNavigationTabs, settingsAreaSidebarItemGroups = configuration.settingsAreaSidebarItemGroups, contentAreaSidebarItems = configuration.contentAreaSidebarItems, manualFieldExtensions = configuration.manualFieldExtensions, itemFormSidebarPanels = configuration.itemFormSidebarPanels, itemFormSidebars = configuration.itemFormSidebars, itemFormOutlets = configuration.itemFormOutlets;
|
|
129
129
|
listener = null;
|
|
130
130
|
callMethodMergingBootCtxExecutor = null;
|
|
131
131
|
penpalConnection = (0, connectToParent_1.default)({
|
|
@@ -146,6 +146,7 @@ function connect(configuration) {
|
|
|
146
146
|
contentAreaSidebarItems: contentAreaSidebarItems,
|
|
147
147
|
manualFieldExtensions: manualFieldExtensions,
|
|
148
148
|
itemFormSidebarPanels: itemFormSidebarPanels,
|
|
149
|
+
itemFormSidebars: itemFormSidebars,
|
|
149
150
|
itemFormOutlets: itemFormOutlets,
|
|
150
151
|
overrideFieldExtensions: toMultifield(configuration.overrideFieldExtensions),
|
|
151
152
|
customMarksForStructuredTextField: toMultifield(configuration.customMarksForStructuredTextField),
|
|
@@ -240,35 +241,46 @@ function connect(configuration) {
|
|
|
240
241
|
listener = render;
|
|
241
242
|
render(initialSettings);
|
|
242
243
|
}
|
|
243
|
-
if ((0, guards_1.
|
|
244
|
+
if ((0, guards_1.isRenderSidebarParent)(parent, initialSettings)) {
|
|
244
245
|
renderUtils_5 = buildRenderUtils(parent);
|
|
246
|
+
render = function (settings) {
|
|
247
|
+
if (!configuration.renderItemFormSidebar) {
|
|
248
|
+
return;
|
|
249
|
+
}
|
|
250
|
+
configuration.renderItemFormSidebar(settings.sidebarId, __assign(__assign(__assign({}, parent), settings), renderUtils_5));
|
|
251
|
+
};
|
|
252
|
+
listener = render;
|
|
253
|
+
render(initialSettings);
|
|
254
|
+
}
|
|
255
|
+
if ((0, guards_1.isRenderItemFormOutletParent)(parent, initialSettings)) {
|
|
256
|
+
renderUtils_6 = buildRenderUtils(parent);
|
|
245
257
|
render = function (settings) {
|
|
246
258
|
if (!configuration.renderItemFormOutlet) {
|
|
247
259
|
return;
|
|
248
260
|
}
|
|
249
|
-
configuration.renderItemFormOutlet(settings.itemFormOutletId, __assign(__assign(__assign({}, parent), settings),
|
|
261
|
+
configuration.renderItemFormOutlet(settings.itemFormOutletId, __assign(__assign(__assign({}, parent), settings), renderUtils_6));
|
|
250
262
|
};
|
|
251
263
|
listener = render;
|
|
252
264
|
render(initialSettings);
|
|
253
265
|
}
|
|
254
266
|
if ((0, guards_1.isRenderFieldExtensionParent)(parent, initialSettings)) {
|
|
255
|
-
|
|
267
|
+
renderUtils_7 = buildRenderUtils(parent);
|
|
256
268
|
render = function (settings) {
|
|
257
269
|
if (!configuration.renderFieldExtension) {
|
|
258
270
|
return;
|
|
259
271
|
}
|
|
260
|
-
configuration.renderFieldExtension(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings),
|
|
272
|
+
configuration.renderFieldExtension(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings), renderUtils_7));
|
|
261
273
|
};
|
|
262
274
|
listener = render;
|
|
263
275
|
render(initialSettings);
|
|
264
276
|
}
|
|
265
277
|
if ((0, guards_1.isRenderManualFieldExtensionConfigScreenParent)(parent, initialSettings)) {
|
|
266
|
-
|
|
278
|
+
renderUtils_8 = buildRenderUtils(parent);
|
|
267
279
|
render = function (settings) {
|
|
268
280
|
if (!configuration.renderManualFieldExtensionConfigScreen) {
|
|
269
281
|
return;
|
|
270
282
|
}
|
|
271
|
-
configuration.renderManualFieldExtensionConfigScreen(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings),
|
|
283
|
+
configuration.renderManualFieldExtensionConfigScreen(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings), renderUtils_8));
|
|
272
284
|
};
|
|
273
285
|
listener = render;
|
|
274
286
|
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;
|
|
1
|
+
{"version":3,"file":"connect.js","sourceRoot":"","sources":["../../src/connect.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+EAAyD;AAuCzD,mCAYkB;AA+TlB,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,CAC1B,CAAC;YACd,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;AAOD,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,GAAG,CACN,QAAQ,CAAC,IAAI,CAAC,YAAY,EAC1B,QAAQ,CAAC,IAAI,CAAC,YAAY,EAC1B,QAAQ,CAAC,eAAe,CAAC,qBAAqB,EAAE,CAAC,MAAM,CACxD;YACH,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,cAAc,GAA0B,IAAI,CAAC;IACjD,IAAI,gBAAgB,GAA4B,IAAI,CAAC;IACrD,IAAM,UAAU,GAAG,cAAM,OAAA,YAAY,EAAE,EAAd,CAAc,CAAC;IAExC,IAAM,gBAAgB,GAAG;QACvB,YAAY,EAAE,CAAC;QAEf,IAAI,CAAC,cAAc,EAAE;YACnB,cAAc,GAAG,IAAI,cAAc,CAAC,UAAU,CAAC,CAAC;YAChD,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;SAClD;QAED,IAAI,CAAC,gBAAgB,EAAE;YACrB,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAEpD,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC7C,UAAU,EAAE,IAAI;gBAChB,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,IAAI;gBACb,aAAa,EAAE,IAAI;aACpB,CAAC,CAAC;SACJ;IACH,CAAC,CAAC;IAEF,IAAM,eAAe,GAAG;QACtB,IAAI,cAAc,EAAE;YAClB,cAAc,CAAC,UAAU,EAAE,CAAC;YAC5B,cAAc,GAAG,IAAI,CAAC;SACvB;QAED,IAAI,gBAAgB,EAAE;YACpB,gBAAgB,CAAC,UAAU,EAAE,CAAC;YAC9B,gBAAgB,GAAG,IAAI,CAAC;SACzB;IACH,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,GAQV,aAAa,aARH,EACZ,kBAAkB,GAOhB,aAAa,mBAPG,EAClB,6BAA6B,GAM3B,aAAa,8BANc,EAC7B,uBAAuB,GAKrB,aAAa,wBALQ,EACvB,qBAAqB,GAInB,aAAa,sBAJM,EACrB,qBAAqB,GAGnB,aAAa,sBAHM,EACrB,gBAAgB,GAEd,aAAa,iBAFC,EAChB,eAAe,GACb,aAAa,gBADA,CACC;oBAEd,QAAQ,GAAwC,IAAI,CAAC;oBACrD,gCAAgC,GAMzB,IAAI,CAAC;oBAEV,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,gBAAgB,kBAAA;4BAChB,eAAe,iBAAA;4BACf,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,QAAQ,YAAC,WAAoB;gCAC3B,IAAI,QAAQ,EAAE;oCACZ,QAAQ,CAAC,WAAW,CAAC,CAAC;iCACvB;4BACH,CAAC;4BACD,wBAAwB,YACtB,UAAkB,EAClB,UAAqB,EACrB,QAAiC;gCAEjC,IAAI,CAAC,gCAAgC,EAAE;oCACrC,OAAO,IAAI,CAAC;iCACb;gCACD,OAAO,gCAAgC,CACrC,UAAU,EACV,UAAU,EACV,QAAQ,CACT,CAAC;4BACJ,CAAC;yBACF;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,uBAAc,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAEvC,oBAAkB,eAA2B,CAAC;wBAElD,QAAQ,GAAG,UAAC,WAAqB;4BAC/B,iBAAe,GAAG,WAAW,CAAC;wBAChC,CAAC,CAAC;wBAEF,gCAAgC,GAAG,UACjC,UAAkB,EAClB,UAAqB,EACrB,QAAiC;;4BAEjC,IAAI,CAAC,CAAC,UAAU,IAAI,aAAa,CAAC,EAAE;gCAClC,OAAO,SAAS,CAAC;6BAClB;4BAED,2DAA2D;4BAC3D,OAAO,CAAA,KAAC,aAAqB,CAAA,CAAC,UAAU,CAAC,2CAAI,UAAU,0CAClD,MAAM,GACN,iBAAe,GACf,QAAQ,YACV;wBACL,CAAC,CAAC;wBAEF,IAAI,aAAa,CAAC,MAAM,EAAE;4BACxB,aAAa,CAAC,MAAM,uBACf,MAAM,GACN,iBAAe,EAClB,CAAC;yBACJ;qBACF;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,8BAAqB,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAG5C,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,qBAAqB,EAAE;gCACxC,OAAO;6BACR;4BAED,aAAa,CAAC,qBAAqB,CAAC,QAAQ,CAAC,SAAS,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,qCAA4B,EAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAKnD,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;wBAKnD,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;AAjTD,0BAiTC"}
|
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.isRenderItemFormOutletParent = exports.isRenderSidebarPanelParent = exports.isRenderModalParent = exports.isRenderConfigScreenParent = exports.isRenderPageParent = exports.isOnBootParent = void 0;
|
|
3
|
+
exports.isRenderAssetSourceParent = exports.isRenderManualFieldExtensionConfigScreenParent = exports.isRenderFieldExtensionParent = exports.isRenderItemFormOutletParent = exports.isRenderSidebarParent = exports.isRenderSidebarPanelParent = exports.isRenderModalParent = exports.isRenderConfigScreenParent = exports.isRenderPageParent = exports.isOnBootParent = void 0;
|
|
4
4
|
function buildGuard(mode) {
|
|
5
5
|
return function (parent, settings) {
|
|
6
6
|
return settings.mode === mode;
|
|
@@ -11,6 +11,7 @@ exports.isRenderPageParent = buildGuard('renderPage');
|
|
|
11
11
|
exports.isRenderConfigScreenParent = buildGuard('renderConfigScreen');
|
|
12
12
|
exports.isRenderModalParent = buildGuard('renderModal');
|
|
13
13
|
exports.isRenderSidebarPanelParent = buildGuard('renderItemFormSidebarPanel');
|
|
14
|
+
exports.isRenderSidebarParent = buildGuard('renderItemFormSidebar');
|
|
14
15
|
exports.isRenderItemFormOutletParent = buildGuard('renderItemFormOutlet');
|
|
15
16
|
exports.isRenderFieldExtensionParent = buildGuard('renderFieldExtension');
|
|
16
17
|
exports.isRenderManualFieldExtensionConfigScreenParent = buildGuard('renderManualFieldExtensionConfigScreen');
|
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,cAAc,GAAG,UAAU,CAAgB,QAAQ,CAAC,CAAC;AAErD,QAAA,kBAAkB,GAAG,UAAU,CAAoB,YAAY,CAAC,CAAC;AAEjE,QAAA,0BAA0B,GACrC,UAAU,CAA4B,oBAAoB,CAAC,CAAC;AAEjD,QAAA,mBAAmB,GAC9B,UAAU,CAAqB,aAAa,CAAC,CAAC;AAEnC,QAAA,0BAA0B,GAAG,UAAU,CAClD,4BAA4B,CAC7B,CAAC;AAEW,QAAA,qBAAqB,GAAG,UAAU,CAC7C,uBAAuB,CACxB,CAAC;AAEW,QAAA,4BAA4B,GACvC,UAAU,CAA8B,sBAAsB,CAAC,CAAC;AAErD,QAAA,4BAA4B,GACvC,UAAU,CAA8B,sBAAsB,CAAC,CAAC;AAErD,QAAA,8CAA8C,GACzD,UAAU,CACR,wCAAwC,CACzC,CAAC;AAES,QAAA,yBAAyB,GACpC,UAAU,CAA2B,mBAAmB,CAAC,CAAC"}
|
package/dist/esm/connect.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Field, Item, ItemCreateSchema, ItemType, ItemUpdateSchema } from './SiteApiSchema';
|
|
2
|
-
import { AssetSource, ContentAreaSidebarItem, FieldExtensionOverride, InitialLocationQueryForItemSelector, InitPropertiesAndMethods, ItemFormSidebarPanel, ItemPresentationInfo, MainNavigationTab, ManualFieldExtension, OnBootPropertiesAndMethods, RenderAssetSourcePropertiesAndMethods, RenderConfigScreenPropertiesAndMethods, RenderFieldExtensionPropertiesAndMethods, RenderManualFieldExtensionConfigScreenPropertiesAndMethods, RenderModalPropertiesAndMethods, RenderPagePropertiesAndMethods, RenderSidebarPanelPropertiesAndMethods, SettingsAreaSidebarItemGroup } from './types';
|
|
2
|
+
import { AssetSource, ContentAreaSidebarItem, FieldExtensionOverride, InitialLocationQueryForItemSelector, InitPropertiesAndMethods, ItemFormSidebar, ItemFormSidebarPanel, ItemPresentationInfo, MainNavigationTab, ManualFieldExtension, OnBootPropertiesAndMethods, RenderAssetSourcePropertiesAndMethods, RenderConfigScreenPropertiesAndMethods, RenderFieldExtensionPropertiesAndMethods, RenderManualFieldExtensionConfigScreenPropertiesAndMethods, RenderModalPropertiesAndMethods, RenderPagePropertiesAndMethods, RenderSidebarPanelPropertiesAndMethods, RenderSidebarPropertiesAndMethods, SettingsAreaSidebarItemGroup } from './types';
|
|
3
3
|
import { ItemFormOutlet, RenderItemFormOutletPropertiesAndMethods, StructuredTextCustomBlockStyle, StructuredTextCustomMark } from '.';
|
|
4
4
|
export declare type SizingUtilities = {
|
|
5
5
|
/**
|
|
@@ -27,6 +27,7 @@ export declare type RenderPageCtx = RenderPagePropertiesAndMethods;
|
|
|
27
27
|
export declare type RenderModalCtx = RenderModalPropertiesAndMethods & SizingUtilities;
|
|
28
28
|
export declare type RenderAssetSourceCtx = RenderAssetSourcePropertiesAndMethods & SizingUtilities;
|
|
29
29
|
export declare type RenderItemFormSidebarPanelCtx = RenderSidebarPanelPropertiesAndMethods & SizingUtilities;
|
|
30
|
+
export declare type RenderItemFormSidebarCtx = RenderSidebarPropertiesAndMethods & SizingUtilities;
|
|
30
31
|
export declare type RenderItemFormOutletCtx = RenderItemFormOutletPropertiesAndMethods & SizingUtilities;
|
|
31
32
|
export declare type RenderFieldExtensionCtx = RenderFieldExtensionPropertiesAndMethods & SizingUtilities;
|
|
32
33
|
export declare type RenderManualFieldExtensionConfigScreenCtx = RenderManualFieldExtensionConfigScreenPropertiesAndMethods & SizingUtilities;
|
|
@@ -125,6 +126,13 @@ export declare type FullConnectParameters = {
|
|
|
125
126
|
* @tag sidebarPanels
|
|
126
127
|
*/
|
|
127
128
|
itemFormSidebarPanels: (itemType: ItemType, ctx: IntentCtx) => ItemFormSidebarPanel[];
|
|
129
|
+
/**
|
|
130
|
+
* Use this function to declare new sidebar to be shown when the user edits
|
|
131
|
+
* records of a particular model
|
|
132
|
+
*
|
|
133
|
+
* @tag sidebarPanels
|
|
134
|
+
*/
|
|
135
|
+
itemFormSidebars: (itemType: ItemType, ctx: IntentCtx) => ItemFormSidebar[];
|
|
128
136
|
/**
|
|
129
137
|
* Use this function to declare custom outlets to be shown at the top of the
|
|
130
138
|
* record's editing page
|
|
@@ -182,6 +190,13 @@ export declare type FullConnectParameters = {
|
|
|
182
190
|
* @tag sidebarPanels
|
|
183
191
|
*/
|
|
184
192
|
renderItemFormSidebarPanel: (sidebarPaneId: string, ctx: RenderItemFormSidebarPanelCtx) => void;
|
|
193
|
+
/**
|
|
194
|
+
* This function will be called when the plugin needs to render a sidebar (see
|
|
195
|
+
* the `itemFormSidebars` function)
|
|
196
|
+
*
|
|
197
|
+
* @tag sidebars
|
|
198
|
+
*/
|
|
199
|
+
renderItemFormSidebar: (sidebarId: string, ctx: RenderItemFormSidebarCtx) => void;
|
|
185
200
|
/**
|
|
186
201
|
* This function will be called when the plugin needs to render an outlet (see
|
|
187
202
|
* the `itemFormOutlets` function)
|
package/dist/esm/connect.js
CHANGED
|
@@ -55,7 +55,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
|
|
|
55
55
|
return to.concat(ar || Array.prototype.slice.call(from));
|
|
56
56
|
};
|
|
57
57
|
import connectToParent from 'penpal/lib/connectToParent';
|
|
58
|
-
import { isOnBootParent, isRenderAssetSourceParent, isRenderConfigScreenParent, isRenderFieldExtensionParent, isRenderItemFormOutletParent, isRenderManualFieldExtensionConfigScreenParent, isRenderModalParent, isRenderPageParent, isRenderSidebarPanelParent, } from './guards';
|
|
58
|
+
import { isOnBootParent, isRenderAssetSourceParent, isRenderConfigScreenParent, isRenderFieldExtensionParent, isRenderItemFormOutletParent, isRenderManualFieldExtensionConfigScreenParent, isRenderModalParent, isRenderPageParent, isRenderSidebarPanelParent, isRenderSidebarParent, } from './guards';
|
|
59
59
|
function toMultifield(fn) {
|
|
60
60
|
return function (fields, ctx) {
|
|
61
61
|
if (!fn) {
|
|
@@ -115,11 +115,11 @@ var buildRenderUtils = function (parent) {
|
|
|
115
115
|
export function connect(configuration) {
|
|
116
116
|
if (configuration === void 0) { configuration = {}; }
|
|
117
117
|
return __awaiter(this, void 0, void 0, function () {
|
|
118
|
-
var assetSources, mainNavigationTabs, settingsAreaSidebarItemGroups, contentAreaSidebarItems, manualFieldExtensions, itemFormSidebarPanels, itemFormOutlets, listener, callMethodMergingBootCtxExecutor, penpalConnection, parent, initialSettings, currentSettings_1, render, renderUtils_1, render, renderUtils_2, render, renderUtils_3, render, renderUtils_4, render, renderUtils_5, render, renderUtils_6, render, renderUtils_7, render;
|
|
118
|
+
var assetSources, mainNavigationTabs, settingsAreaSidebarItemGroups, contentAreaSidebarItems, manualFieldExtensions, itemFormSidebarPanels, itemFormSidebars, itemFormOutlets, listener, callMethodMergingBootCtxExecutor, penpalConnection, parent, initialSettings, currentSettings_1, render, renderUtils_1, render, renderUtils_2, render, renderUtils_3, render, renderUtils_4, render, renderUtils_5, render, renderUtils_6, render, renderUtils_7, render, renderUtils_8, render;
|
|
119
119
|
return __generator(this, function (_a) {
|
|
120
120
|
switch (_a.label) {
|
|
121
121
|
case 0:
|
|
122
|
-
assetSources = configuration.assetSources, mainNavigationTabs = configuration.mainNavigationTabs, settingsAreaSidebarItemGroups = configuration.settingsAreaSidebarItemGroups, contentAreaSidebarItems = configuration.contentAreaSidebarItems, manualFieldExtensions = configuration.manualFieldExtensions, itemFormSidebarPanels = configuration.itemFormSidebarPanels, itemFormOutlets = configuration.itemFormOutlets;
|
|
122
|
+
assetSources = configuration.assetSources, mainNavigationTabs = configuration.mainNavigationTabs, settingsAreaSidebarItemGroups = configuration.settingsAreaSidebarItemGroups, contentAreaSidebarItems = configuration.contentAreaSidebarItems, manualFieldExtensions = configuration.manualFieldExtensions, itemFormSidebarPanels = configuration.itemFormSidebarPanels, itemFormSidebars = configuration.itemFormSidebars, itemFormOutlets = configuration.itemFormOutlets;
|
|
123
123
|
listener = null;
|
|
124
124
|
callMethodMergingBootCtxExecutor = null;
|
|
125
125
|
penpalConnection = connectToParent({
|
|
@@ -140,6 +140,7 @@ export function connect(configuration) {
|
|
|
140
140
|
contentAreaSidebarItems: contentAreaSidebarItems,
|
|
141
141
|
manualFieldExtensions: manualFieldExtensions,
|
|
142
142
|
itemFormSidebarPanels: itemFormSidebarPanels,
|
|
143
|
+
itemFormSidebars: itemFormSidebars,
|
|
143
144
|
itemFormOutlets: itemFormOutlets,
|
|
144
145
|
overrideFieldExtensions: toMultifield(configuration.overrideFieldExtensions),
|
|
145
146
|
customMarksForStructuredTextField: toMultifield(configuration.customMarksForStructuredTextField),
|
|
@@ -234,35 +235,46 @@ export function connect(configuration) {
|
|
|
234
235
|
listener = render;
|
|
235
236
|
render(initialSettings);
|
|
236
237
|
}
|
|
237
|
-
if (
|
|
238
|
+
if (isRenderSidebarParent(parent, initialSettings)) {
|
|
238
239
|
renderUtils_5 = buildRenderUtils(parent);
|
|
240
|
+
render = function (settings) {
|
|
241
|
+
if (!configuration.renderItemFormSidebar) {
|
|
242
|
+
return;
|
|
243
|
+
}
|
|
244
|
+
configuration.renderItemFormSidebar(settings.sidebarId, __assign(__assign(__assign({}, parent), settings), renderUtils_5));
|
|
245
|
+
};
|
|
246
|
+
listener = render;
|
|
247
|
+
render(initialSettings);
|
|
248
|
+
}
|
|
249
|
+
if (isRenderItemFormOutletParent(parent, initialSettings)) {
|
|
250
|
+
renderUtils_6 = buildRenderUtils(parent);
|
|
239
251
|
render = function (settings) {
|
|
240
252
|
if (!configuration.renderItemFormOutlet) {
|
|
241
253
|
return;
|
|
242
254
|
}
|
|
243
|
-
configuration.renderItemFormOutlet(settings.itemFormOutletId, __assign(__assign(__assign({}, parent), settings),
|
|
255
|
+
configuration.renderItemFormOutlet(settings.itemFormOutletId, __assign(__assign(__assign({}, parent), settings), renderUtils_6));
|
|
244
256
|
};
|
|
245
257
|
listener = render;
|
|
246
258
|
render(initialSettings);
|
|
247
259
|
}
|
|
248
260
|
if (isRenderFieldExtensionParent(parent, initialSettings)) {
|
|
249
|
-
|
|
261
|
+
renderUtils_7 = buildRenderUtils(parent);
|
|
250
262
|
render = function (settings) {
|
|
251
263
|
if (!configuration.renderFieldExtension) {
|
|
252
264
|
return;
|
|
253
265
|
}
|
|
254
|
-
configuration.renderFieldExtension(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings),
|
|
266
|
+
configuration.renderFieldExtension(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings), renderUtils_7));
|
|
255
267
|
};
|
|
256
268
|
listener = render;
|
|
257
269
|
render(initialSettings);
|
|
258
270
|
}
|
|
259
271
|
if (isRenderManualFieldExtensionConfigScreenParent(parent, initialSettings)) {
|
|
260
|
-
|
|
272
|
+
renderUtils_8 = buildRenderUtils(parent);
|
|
261
273
|
render = function (settings) {
|
|
262
274
|
if (!configuration.renderManualFieldExtensionConfigScreen) {
|
|
263
275
|
return;
|
|
264
276
|
}
|
|
265
|
-
configuration.renderManualFieldExtensionConfigScreen(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings),
|
|
277
|
+
configuration.renderManualFieldExtensionConfigScreen(settings.fieldExtensionId, __assign(__assign(__assign({}, parent), settings), renderUtils_8));
|
|
266
278
|
};
|
|
267
279
|
listener = render;
|
|
268
280
|
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;
|
|
1
|
+
{"version":3,"file":"connect.js","sourceRoot":"","sources":["../../src/connect.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,eAAe,MAAM,4BAA4B,CAAC;AAuCzD,OAAO,EACL,cAAc,EACd,yBAAyB,EACzB,0BAA0B,EAC1B,4BAA4B,EAC5B,4BAA4B,EAC5B,8CAA8C,EAC9C,mBAAmB,EACnB,kBAAkB,EAClB,0BAA0B,EAC1B,qBAAqB,GAEtB,MAAM,UAAU,CAAC;AA+TlB,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,CAC1B,CAAC;YACd,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;AAOD,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,GAAG,CACN,QAAQ,CAAC,IAAI,CAAC,YAAY,EAC1B,QAAQ,CAAC,IAAI,CAAC,YAAY,EAC1B,QAAQ,CAAC,eAAe,CAAC,qBAAqB,EAAE,CAAC,MAAM,CACxD;YACH,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,cAAc,GAA0B,IAAI,CAAC;IACjD,IAAI,gBAAgB,GAA4B,IAAI,CAAC;IACrD,IAAM,UAAU,GAAG,cAAM,OAAA,YAAY,EAAE,EAAd,CAAc,CAAC;IAExC,IAAM,gBAAgB,GAAG;QACvB,YAAY,EAAE,CAAC;QAEf,IAAI,CAAC,cAAc,EAAE;YACnB,cAAc,GAAG,IAAI,cAAc,CAAC,UAAU,CAAC,CAAC;YAChD,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;SAClD;QAED,IAAI,CAAC,gBAAgB,EAAE;YACrB,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAEpD,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE;gBAC7C,UAAU,EAAE,IAAI;gBAChB,SAAS,EAAE,IAAI;gBACf,OAAO,EAAE,IAAI;gBACb,aAAa,EAAE,IAAI;aACpB,CAAC,CAAC;SACJ;IACH,CAAC,CAAC;IAEF,IAAM,eAAe,GAAG;QACtB,IAAI,cAAc,EAAE;YAClB,cAAc,CAAC,UAAU,EAAE,CAAC;YAC5B,cAAc,GAAG,IAAI,CAAC;SACvB;QAED,IAAI,gBAAgB,EAAE;YACpB,gBAAgB,CAAC,UAAU,EAAE,CAAC;YAC9B,gBAAgB,GAAG,IAAI,CAAC;SACzB;IACH,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,GAQV,aAAa,aARH,EACZ,kBAAkB,GAOhB,aAAa,mBAPG,EAClB,6BAA6B,GAM3B,aAAa,8BANc,EAC7B,uBAAuB,GAKrB,aAAa,wBALQ,EACvB,qBAAqB,GAInB,aAAa,sBAJM,EACrB,qBAAqB,GAGnB,aAAa,sBAHM,EACrB,gBAAgB,GAEd,aAAa,iBAFC,EAChB,eAAe,GACb,aAAa,gBADA,CACC;oBAEd,QAAQ,GAAwC,IAAI,CAAC;oBACrD,gCAAgC,GAMzB,IAAI,CAAC;oBAEV,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,gBAAgB,kBAAA;4BAChB,eAAe,iBAAA;4BACf,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,QAAQ,YAAC,WAAoB;gCAC3B,IAAI,QAAQ,EAAE;oCACZ,QAAQ,CAAC,WAAW,CAAC,CAAC;iCACvB;4BACH,CAAC;4BACD,wBAAwB,YACtB,UAAkB,EAClB,UAAqB,EACrB,QAAiC;gCAEjC,IAAI,CAAC,gCAAgC,EAAE;oCACrC,OAAO,IAAI,CAAC;iCACb;gCACD,OAAO,gCAAgC,CACrC,UAAU,EACV,UAAU,EACV,QAAQ,CACT,CAAC;4BACJ,CAAC;yBACF;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,cAAc,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAEvC,oBAAkB,eAA2B,CAAC;wBAElD,QAAQ,GAAG,UAAC,WAAqB;4BAC/B,iBAAe,GAAG,WAAW,CAAC;wBAChC,CAAC,CAAC;wBAEF,gCAAgC,GAAG,UACjC,UAAkB,EAClB,UAAqB,EACrB,QAAiC;;4BAEjC,IAAI,CAAC,CAAC,UAAU,IAAI,aAAa,CAAC,EAAE;gCAClC,OAAO,SAAS,CAAC;6BAClB;4BAED,2DAA2D;4BAC3D,OAAO,CAAA,KAAC,aAAqB,CAAA,CAAC,UAAU,CAAC,2CAAI,UAAU,0CAClD,MAAM,GACN,iBAAe,GACf,QAAQ,YACV;wBACL,CAAC,CAAC;wBAEF,IAAI,aAAa,CAAC,MAAM,EAAE;4BACxB,aAAa,CAAC,MAAM,uBACf,MAAM,GACN,iBAAe,EAClB,CAAC;yBACJ;qBACF;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,qBAAqB,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAG5C,gBAAc,gBAAgB,CAAC,MAAM,CAAC,CAAC;wBAEvC,MAAM,GAAG,UAAC,QAAkB;4BAChC,IAAI,CAAC,aAAa,CAAC,qBAAqB,EAAE;gCACxC,OAAO;6BACR;4BAED,aAAa,CAAC,qBAAqB,CAAC,QAAQ,CAAC,SAAS,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,4BAA4B,CAAC,MAAM,EAAE,eAAe,CAAC,EAAE;wBAKnD,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;wBAKnD,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,5 +1,5 @@
|
|
|
1
1
|
import { RenderItemFormOutletMethods } from '.';
|
|
2
|
-
import { OnBootMethods, RenderPageMethods, RenderFieldExtensionMethods, RenderConfigScreenMethods, RenderManualFieldExtensionConfigScreenMethods, RenderSidebarPanelMethods, RenderModalMethods, RenderAssetSourceMethods } from './types';
|
|
2
|
+
import { OnBootMethods, RenderPageMethods, RenderFieldExtensionMethods, RenderConfigScreenMethods, RenderManualFieldExtensionConfigScreenMethods, RenderSidebarPanelMethods, RenderModalMethods, RenderAssetSourceMethods, RenderSidebarMethods } from './types';
|
|
3
3
|
export declare type Parent = {
|
|
4
4
|
getSettings: () => Promise<{
|
|
5
5
|
mode: string;
|
|
@@ -20,6 +20,9 @@ export declare const isRenderModalParent: (parent: Parent, settings: {
|
|
|
20
20
|
export declare const isRenderSidebarPanelParent: (parent: Parent, settings: {
|
|
21
21
|
mode: string;
|
|
22
22
|
}) => parent is RenderSidebarPanelMethods;
|
|
23
|
+
export declare const isRenderSidebarParent: (parent: Parent, settings: {
|
|
24
|
+
mode: string;
|
|
25
|
+
}) => parent is RenderSidebarMethods;
|
|
23
26
|
export declare const isRenderItemFormOutletParent: (parent: Parent, settings: {
|
|
24
27
|
mode: string;
|
|
25
28
|
}) => parent is RenderItemFormOutletMethods;
|
package/dist/esm/guards.js
CHANGED
|
@@ -8,6 +8,7 @@ export var isRenderPageParent = buildGuard('renderPage');
|
|
|
8
8
|
export var isRenderConfigScreenParent = buildGuard('renderConfigScreen');
|
|
9
9
|
export var isRenderModalParent = buildGuard('renderModal');
|
|
10
10
|
export var isRenderSidebarPanelParent = buildGuard('renderItemFormSidebarPanel');
|
|
11
|
+
export var isRenderSidebarParent = buildGuard('renderItemFormSidebar');
|
|
11
12
|
export var isRenderItemFormOutletParent = buildGuard('renderItemFormOutlet');
|
|
12
13
|
export var isRenderFieldExtensionParent = buildGuard('renderFieldExtension');
|
|
13
14
|
export var isRenderManualFieldExtensionConfigScreenParent = buildGuard('renderManualFieldExtensionConfigScreen');
|
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,cAAc,GAAG,UAAU,CAAgB,QAAQ,CAAC,CAAC;AAElE,MAAM,CAAC,IAAM,kBAAkB,GAAG,UAAU,CAAoB,YAAY,CAAC,CAAC;AAE9E,MAAM,CAAC,IAAM,0BAA0B,GACrC,UAAU,CAA4B,oBAAoB,CAAC,CAAC;AAE9D,MAAM,CAAC,IAAM,mBAAmB,GAC9B,UAAU,CAAqB,aAAa,CAAC,CAAC;AAEhD,MAAM,CAAC,IAAM,0BAA0B,GAAG,UAAU,CAClD,4BAA4B,CAC7B,CAAC;AAEF,MAAM,CAAC,IAAM,qBAAqB,GAAG,UAAU,CAC7C,uBAAuB,CACxB,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GACvC,UAAU,CAA8B,sBAAsB,CAAC,CAAC;AAElE,MAAM,CAAC,IAAM,4BAA4B,GACvC,UAAU,CAA8B,sBAAsB,CAAC,CAAC;AAElE,MAAM,CAAC,IAAM,8CAA8C,GACzD,UAAU,CACR,wCAAwC,CACzC,CAAC;AAEJ,MAAM,CAAC,IAAM,yBAAyB,GACpC,UAAU,CAA2B,mBAAmB,CAAC,CAAC"}
|
package/dist/esm/types.d.ts
CHANGED
|
@@ -235,6 +235,31 @@ export declare type ItemFormSidebarPanel = {
|
|
|
235
235
|
/** The initial height to set for the iframe that will render the sidebar panel */
|
|
236
236
|
initialHeight?: number;
|
|
237
237
|
};
|
|
238
|
+
/** A sidebar to be shown inside the record's editing page */
|
|
239
|
+
export declare type ItemFormSidebar = {
|
|
240
|
+
/**
|
|
241
|
+
* ID of the sidebar. Will be the first argument for the
|
|
242
|
+
* `renderItemFormSidebar` function
|
|
243
|
+
*/
|
|
244
|
+
id: string;
|
|
245
|
+
/** Label to be shown on the collapsible sidebar handle */
|
|
246
|
+
label: string;
|
|
247
|
+
/**
|
|
248
|
+
* An arbitrary configuration object that will be passed as the `parameters`
|
|
249
|
+
* property of the second argument of the `renderItemFormSidebar` function
|
|
250
|
+
*/
|
|
251
|
+
parameters?: Record<string, unknown>;
|
|
252
|
+
/**
|
|
253
|
+
* If multiple sidebars specify the same `placement`, they will be sorted by
|
|
254
|
+
* ascending `rank`. If you want to specify an explicit value for `rank`, make
|
|
255
|
+
* sure to offer a way for final users to customize it inside the plugin's
|
|
256
|
+
* settings form, otherwise the hardcoded value you choose might clash with
|
|
257
|
+
* the one of another plugin!
|
|
258
|
+
*/
|
|
259
|
+
rank?: number;
|
|
260
|
+
/** The preferred width for the sidebar */
|
|
261
|
+
preferredWidth?: number;
|
|
262
|
+
};
|
|
238
263
|
/** An outlet to be shown at the top of a record's editing page */
|
|
239
264
|
export declare type ItemFormOutlet = {
|
|
240
265
|
/**
|
|
@@ -1209,6 +1234,23 @@ export declare type RenderSidebarPanelAdditionalMethods = {
|
|
|
1209
1234
|
};
|
|
1210
1235
|
export declare type RenderSidebarPanelMethods = ItemFormMethods & RenderSidebarPanelAdditionalMethods;
|
|
1211
1236
|
export declare type RenderSidebarPanelPropertiesAndMethods = RenderSidebarPanelMethods & RenderSidebarPanelProperties;
|
|
1237
|
+
/** Information regarding the specific sidebar panel that you need to render */
|
|
1238
|
+
export declare type RenderSidebarAdditionalProperties = {
|
|
1239
|
+
mode: 'renderItemFormSidebar';
|
|
1240
|
+
/** The ID of the sidebar that needs to be rendered */
|
|
1241
|
+
sidebarId: string;
|
|
1242
|
+
/**
|
|
1243
|
+
* The arbitrary `parameters` of the declared in the `itemFormSidebars`
|
|
1244
|
+
* function
|
|
1245
|
+
*/
|
|
1246
|
+
parameters: Record<string, unknown>;
|
|
1247
|
+
};
|
|
1248
|
+
export declare type RenderSidebarProperties = ItemFormProperties & RenderSidebarAdditionalProperties;
|
|
1249
|
+
export declare type RenderSidebarAdditionalMethods = {
|
|
1250
|
+
getSettings: () => Promise<RenderSidebarProperties>;
|
|
1251
|
+
};
|
|
1252
|
+
export declare type RenderSidebarMethods = ItemFormMethods & RenderSidebarAdditionalMethods;
|
|
1253
|
+
export declare type RenderSidebarPropertiesAndMethods = RenderSidebarMethods & RenderSidebarProperties;
|
|
1212
1254
|
/** Information regarding the specific outlet that you need to render */
|
|
1213
1255
|
export declare type RenderItemFormOutletAdditionalProperties = {
|
|
1214
1256
|
mode: 'renderItemFormOutlet';
|
package/dist/types/connect.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { Field, Item, ItemCreateSchema, ItemType, ItemUpdateSchema } from './SiteApiSchema';
|
|
2
|
-
import { AssetSource, ContentAreaSidebarItem, FieldExtensionOverride, InitialLocationQueryForItemSelector, InitPropertiesAndMethods, ItemFormSidebarPanel, ItemPresentationInfo, MainNavigationTab, ManualFieldExtension, OnBootPropertiesAndMethods, RenderAssetSourcePropertiesAndMethods, RenderConfigScreenPropertiesAndMethods, RenderFieldExtensionPropertiesAndMethods, RenderManualFieldExtensionConfigScreenPropertiesAndMethods, RenderModalPropertiesAndMethods, RenderPagePropertiesAndMethods, RenderSidebarPanelPropertiesAndMethods, SettingsAreaSidebarItemGroup } from './types';
|
|
2
|
+
import { AssetSource, ContentAreaSidebarItem, FieldExtensionOverride, InitialLocationQueryForItemSelector, InitPropertiesAndMethods, ItemFormSidebar, ItemFormSidebarPanel, ItemPresentationInfo, MainNavigationTab, ManualFieldExtension, OnBootPropertiesAndMethods, RenderAssetSourcePropertiesAndMethods, RenderConfigScreenPropertiesAndMethods, RenderFieldExtensionPropertiesAndMethods, RenderManualFieldExtensionConfigScreenPropertiesAndMethods, RenderModalPropertiesAndMethods, RenderPagePropertiesAndMethods, RenderSidebarPanelPropertiesAndMethods, RenderSidebarPropertiesAndMethods, SettingsAreaSidebarItemGroup } from './types';
|
|
3
3
|
import { ItemFormOutlet, RenderItemFormOutletPropertiesAndMethods, StructuredTextCustomBlockStyle, StructuredTextCustomMark } from '.';
|
|
4
4
|
export declare type SizingUtilities = {
|
|
5
5
|
/**
|
|
@@ -27,6 +27,7 @@ export declare type RenderPageCtx = RenderPagePropertiesAndMethods;
|
|
|
27
27
|
export declare type RenderModalCtx = RenderModalPropertiesAndMethods & SizingUtilities;
|
|
28
28
|
export declare type RenderAssetSourceCtx = RenderAssetSourcePropertiesAndMethods & SizingUtilities;
|
|
29
29
|
export declare type RenderItemFormSidebarPanelCtx = RenderSidebarPanelPropertiesAndMethods & SizingUtilities;
|
|
30
|
+
export declare type RenderItemFormSidebarCtx = RenderSidebarPropertiesAndMethods & SizingUtilities;
|
|
30
31
|
export declare type RenderItemFormOutletCtx = RenderItemFormOutletPropertiesAndMethods & SizingUtilities;
|
|
31
32
|
export declare type RenderFieldExtensionCtx = RenderFieldExtensionPropertiesAndMethods & SizingUtilities;
|
|
32
33
|
export declare type RenderManualFieldExtensionConfigScreenCtx = RenderManualFieldExtensionConfigScreenPropertiesAndMethods & SizingUtilities;
|
|
@@ -125,6 +126,13 @@ export declare type FullConnectParameters = {
|
|
|
125
126
|
* @tag sidebarPanels
|
|
126
127
|
*/
|
|
127
128
|
itemFormSidebarPanels: (itemType: ItemType, ctx: IntentCtx) => ItemFormSidebarPanel[];
|
|
129
|
+
/**
|
|
130
|
+
* Use this function to declare new sidebar to be shown when the user edits
|
|
131
|
+
* records of a particular model
|
|
132
|
+
*
|
|
133
|
+
* @tag sidebarPanels
|
|
134
|
+
*/
|
|
135
|
+
itemFormSidebars: (itemType: ItemType, ctx: IntentCtx) => ItemFormSidebar[];
|
|
128
136
|
/**
|
|
129
137
|
* Use this function to declare custom outlets to be shown at the top of the
|
|
130
138
|
* record's editing page
|
|
@@ -182,6 +190,13 @@ export declare type FullConnectParameters = {
|
|
|
182
190
|
* @tag sidebarPanels
|
|
183
191
|
*/
|
|
184
192
|
renderItemFormSidebarPanel: (sidebarPaneId: string, ctx: RenderItemFormSidebarPanelCtx) => void;
|
|
193
|
+
/**
|
|
194
|
+
* This function will be called when the plugin needs to render a sidebar (see
|
|
195
|
+
* the `itemFormSidebars` function)
|
|
196
|
+
*
|
|
197
|
+
* @tag sidebars
|
|
198
|
+
*/
|
|
199
|
+
renderItemFormSidebar: (sidebarId: string, ctx: RenderItemFormSidebarCtx) => void;
|
|
185
200
|
/**
|
|
186
201
|
* This function will be called when the plugin needs to render an outlet (see
|
|
187
202
|
* the `itemFormOutlets` function)
|
package/dist/types/guards.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { RenderItemFormOutletMethods } from '.';
|
|
2
|
-
import { OnBootMethods, RenderPageMethods, RenderFieldExtensionMethods, RenderConfigScreenMethods, RenderManualFieldExtensionConfigScreenMethods, RenderSidebarPanelMethods, RenderModalMethods, RenderAssetSourceMethods } from './types';
|
|
2
|
+
import { OnBootMethods, RenderPageMethods, RenderFieldExtensionMethods, RenderConfigScreenMethods, RenderManualFieldExtensionConfigScreenMethods, RenderSidebarPanelMethods, RenderModalMethods, RenderAssetSourceMethods, RenderSidebarMethods } from './types';
|
|
3
3
|
export declare type Parent = {
|
|
4
4
|
getSettings: () => Promise<{
|
|
5
5
|
mode: string;
|
|
@@ -20,6 +20,9 @@ export declare const isRenderModalParent: (parent: Parent, settings: {
|
|
|
20
20
|
export declare const isRenderSidebarPanelParent: (parent: Parent, settings: {
|
|
21
21
|
mode: string;
|
|
22
22
|
}) => parent is RenderSidebarPanelMethods;
|
|
23
|
+
export declare const isRenderSidebarParent: (parent: Parent, settings: {
|
|
24
|
+
mode: string;
|
|
25
|
+
}) => parent is RenderSidebarMethods;
|
|
23
26
|
export declare const isRenderItemFormOutletParent: (parent: Parent, settings: {
|
|
24
27
|
mode: string;
|
|
25
28
|
}) => parent is RenderItemFormOutletMethods;
|
package/dist/types/types.d.ts
CHANGED
|
@@ -235,6 +235,31 @@ export declare type ItemFormSidebarPanel = {
|
|
|
235
235
|
/** The initial height to set for the iframe that will render the sidebar panel */
|
|
236
236
|
initialHeight?: number;
|
|
237
237
|
};
|
|
238
|
+
/** A sidebar to be shown inside the record's editing page */
|
|
239
|
+
export declare type ItemFormSidebar = {
|
|
240
|
+
/**
|
|
241
|
+
* ID of the sidebar. Will be the first argument for the
|
|
242
|
+
* `renderItemFormSidebar` function
|
|
243
|
+
*/
|
|
244
|
+
id: string;
|
|
245
|
+
/** Label to be shown on the collapsible sidebar handle */
|
|
246
|
+
label: string;
|
|
247
|
+
/**
|
|
248
|
+
* An arbitrary configuration object that will be passed as the `parameters`
|
|
249
|
+
* property of the second argument of the `renderItemFormSidebar` function
|
|
250
|
+
*/
|
|
251
|
+
parameters?: Record<string, unknown>;
|
|
252
|
+
/**
|
|
253
|
+
* If multiple sidebars specify the same `placement`, they will be sorted by
|
|
254
|
+
* ascending `rank`. If you want to specify an explicit value for `rank`, make
|
|
255
|
+
* sure to offer a way for final users to customize it inside the plugin's
|
|
256
|
+
* settings form, otherwise the hardcoded value you choose might clash with
|
|
257
|
+
* the one of another plugin!
|
|
258
|
+
*/
|
|
259
|
+
rank?: number;
|
|
260
|
+
/** The preferred width for the sidebar */
|
|
261
|
+
preferredWidth?: number;
|
|
262
|
+
};
|
|
238
263
|
/** An outlet to be shown at the top of a record's editing page */
|
|
239
264
|
export declare type ItemFormOutlet = {
|
|
240
265
|
/**
|
|
@@ -1209,6 +1234,23 @@ export declare type RenderSidebarPanelAdditionalMethods = {
|
|
|
1209
1234
|
};
|
|
1210
1235
|
export declare type RenderSidebarPanelMethods = ItemFormMethods & RenderSidebarPanelAdditionalMethods;
|
|
1211
1236
|
export declare type RenderSidebarPanelPropertiesAndMethods = RenderSidebarPanelMethods & RenderSidebarPanelProperties;
|
|
1237
|
+
/** Information regarding the specific sidebar panel that you need to render */
|
|
1238
|
+
export declare type RenderSidebarAdditionalProperties = {
|
|
1239
|
+
mode: 'renderItemFormSidebar';
|
|
1240
|
+
/** The ID of the sidebar that needs to be rendered */
|
|
1241
|
+
sidebarId: string;
|
|
1242
|
+
/**
|
|
1243
|
+
* The arbitrary `parameters` of the declared in the `itemFormSidebars`
|
|
1244
|
+
* function
|
|
1245
|
+
*/
|
|
1246
|
+
parameters: Record<string, unknown>;
|
|
1247
|
+
};
|
|
1248
|
+
export declare type RenderSidebarProperties = ItemFormProperties & RenderSidebarAdditionalProperties;
|
|
1249
|
+
export declare type RenderSidebarAdditionalMethods = {
|
|
1250
|
+
getSettings: () => Promise<RenderSidebarProperties>;
|
|
1251
|
+
};
|
|
1252
|
+
export declare type RenderSidebarMethods = ItemFormMethods & RenderSidebarAdditionalMethods;
|
|
1253
|
+
export declare type RenderSidebarPropertiesAndMethods = RenderSidebarMethods & RenderSidebarProperties;
|
|
1212
1254
|
/** Information regarding the specific outlet that you need to render */
|
|
1213
1255
|
export declare type RenderItemFormOutletAdditionalProperties = {
|
|
1214
1256
|
mode: 'renderItemFormOutlet';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "datocms-plugin-sdk",
|
|
3
|
-
"version": "0.7.
|
|
3
|
+
"version": "0.7.10",
|
|
4
4
|
"description": "DatoCMS Plugin SDK",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"datocms",
|
|
@@ -43,5 +43,5 @@
|
|
|
43
43
|
"devDependencies": {
|
|
44
44
|
"typedoc": "^0.23.20"
|
|
45
45
|
},
|
|
46
|
-
"gitHead": "
|
|
46
|
+
"gitHead": "856c9b1a41457f94e938e29210405a96c5d7c637"
|
|
47
47
|
}
|
package/src/connect.ts
CHANGED
|
@@ -12,6 +12,7 @@ import {
|
|
|
12
12
|
FieldExtensionOverride,
|
|
13
13
|
InitialLocationQueryForItemSelector,
|
|
14
14
|
InitPropertiesAndMethods,
|
|
15
|
+
ItemFormSidebar,
|
|
15
16
|
ItemFormSidebarPanel,
|
|
16
17
|
ItemPresentationInfo,
|
|
17
18
|
MainNavigationTab,
|
|
@@ -32,6 +33,8 @@ import {
|
|
|
32
33
|
RenderPagePropertiesAndMethods,
|
|
33
34
|
RenderSidebarPanelMethods,
|
|
34
35
|
RenderSidebarPanelPropertiesAndMethods,
|
|
36
|
+
RenderSidebarPropertiesAndMethods,
|
|
37
|
+
RenderSidebarMethods,
|
|
35
38
|
SettingsAreaSidebarItemGroup,
|
|
36
39
|
} from './types';
|
|
37
40
|
import {
|
|
@@ -44,6 +47,7 @@ import {
|
|
|
44
47
|
isRenderModalParent,
|
|
45
48
|
isRenderPageParent,
|
|
46
49
|
isRenderSidebarPanelParent,
|
|
50
|
+
isRenderSidebarParent,
|
|
47
51
|
Parent,
|
|
48
52
|
} from './guards';
|
|
49
53
|
import {
|
|
@@ -84,6 +88,8 @@ export type RenderAssetSourceCtx = RenderAssetSourcePropertiesAndMethods &
|
|
|
84
88
|
SizingUtilities;
|
|
85
89
|
export type RenderItemFormSidebarPanelCtx =
|
|
86
90
|
RenderSidebarPanelPropertiesAndMethods & SizingUtilities;
|
|
91
|
+
export type RenderItemFormSidebarCtx = RenderSidebarPropertiesAndMethods &
|
|
92
|
+
SizingUtilities;
|
|
87
93
|
export type RenderItemFormOutletCtx = RenderItemFormOutletPropertiesAndMethods &
|
|
88
94
|
SizingUtilities;
|
|
89
95
|
export type RenderFieldExtensionCtx = RenderFieldExtensionPropertiesAndMethods &
|
|
@@ -220,6 +226,14 @@ export type FullConnectParameters = {
|
|
|
220
226
|
ctx: IntentCtx,
|
|
221
227
|
) => ItemFormSidebarPanel[];
|
|
222
228
|
|
|
229
|
+
/**
|
|
230
|
+
* Use this function to declare new sidebar to be shown when the user edits
|
|
231
|
+
* records of a particular model
|
|
232
|
+
*
|
|
233
|
+
* @tag sidebarPanels
|
|
234
|
+
*/
|
|
235
|
+
itemFormSidebars: (itemType: ItemType, ctx: IntentCtx) => ItemFormSidebar[];
|
|
236
|
+
|
|
223
237
|
/**
|
|
224
238
|
* Use this function to declare custom outlets to be shown at the top of the
|
|
225
239
|
* record's editing page
|
|
@@ -293,6 +307,16 @@ export type FullConnectParameters = {
|
|
|
293
307
|
sidebarPaneId: string,
|
|
294
308
|
ctx: RenderItemFormSidebarPanelCtx,
|
|
295
309
|
) => void;
|
|
310
|
+
/**
|
|
311
|
+
* This function will be called when the plugin needs to render a sidebar (see
|
|
312
|
+
* the `itemFormSidebars` function)
|
|
313
|
+
*
|
|
314
|
+
* @tag sidebars
|
|
315
|
+
*/
|
|
316
|
+
renderItemFormSidebar: (
|
|
317
|
+
sidebarId: string,
|
|
318
|
+
ctx: RenderItemFormSidebarCtx,
|
|
319
|
+
) => void;
|
|
296
320
|
/**
|
|
297
321
|
* This function will be called when the plugin needs to render an outlet (see
|
|
298
322
|
* the `itemFormOutlets` function)
|
|
@@ -441,6 +465,7 @@ export async function connect(
|
|
|
441
465
|
contentAreaSidebarItems,
|
|
442
466
|
manualFieldExtensions,
|
|
443
467
|
itemFormSidebarPanels,
|
|
468
|
+
itemFormSidebars,
|
|
444
469
|
itemFormOutlets,
|
|
445
470
|
} = configuration;
|
|
446
471
|
// rome-ignore lint/suspicious/noExplicitAny: <explanation>
|
|
@@ -472,6 +497,7 @@ export async function connect(
|
|
|
472
497
|
contentAreaSidebarItems,
|
|
473
498
|
manualFieldExtensions,
|
|
474
499
|
itemFormSidebarPanels,
|
|
500
|
+
itemFormSidebars,
|
|
475
501
|
itemFormOutlets,
|
|
476
502
|
overrideFieldExtensions: toMultifield(
|
|
477
503
|
configuration.overrideFieldExtensions,
|
|
@@ -642,6 +668,27 @@ export async function connect(
|
|
|
642
668
|
render(initialSettings as Settings);
|
|
643
669
|
}
|
|
644
670
|
|
|
671
|
+
if (isRenderSidebarParent(parent, initialSettings)) {
|
|
672
|
+
type Settings = AwaitedReturnType<RenderSidebarMethods['getSettings']>;
|
|
673
|
+
|
|
674
|
+
const renderUtils = buildRenderUtils(parent);
|
|
675
|
+
|
|
676
|
+
const render = (settings: Settings) => {
|
|
677
|
+
if (!configuration.renderItemFormSidebar) {
|
|
678
|
+
return;
|
|
679
|
+
}
|
|
680
|
+
|
|
681
|
+
configuration.renderItemFormSidebar(settings.sidebarId, {
|
|
682
|
+
...parent,
|
|
683
|
+
...settings,
|
|
684
|
+
...renderUtils,
|
|
685
|
+
});
|
|
686
|
+
};
|
|
687
|
+
|
|
688
|
+
listener = render;
|
|
689
|
+
render(initialSettings as Settings);
|
|
690
|
+
}
|
|
691
|
+
|
|
645
692
|
if (isRenderItemFormOutletParent(parent, initialSettings)) {
|
|
646
693
|
type Settings = AwaitedReturnType<
|
|
647
694
|
RenderItemFormOutletMethods['getSettings']
|