datocms-plugin-sdk 0.2.0-alpha.66 → 0.3.3
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/README.md +1 -1
- package/dist/cjs/connect.js.map +1 -1
- package/dist/cjs/guards.js.map +1 -1
- package/dist/esm/SiteApiSchema.d.ts +643 -1391
- package/dist/esm/connect.d.ts +22 -26
- package/dist/esm/connect.js.map +1 -1
- package/dist/esm/guards.js.map +1 -1
- package/dist/esm/types.d.ts +284 -264
- package/dist/types/SiteApiSchema.d.ts +643 -1391
- package/dist/types/connect.d.ts +22 -26
- package/dist/types/types.d.ts +284 -264
- package/package.json +2 -2
- package/types.json +598 -535
package/dist/esm/connect.d.ts
CHANGED
|
@@ -6,9 +6,8 @@ export declare type SizingUtilities = {
|
|
|
6
6
|
/** Stops resizing the iframe automatically */
|
|
7
7
|
stopAutoResizer: () => void;
|
|
8
8
|
/**
|
|
9
|
-
* Triggers a change in the size of the iframe. If you don't explicitely pass
|
|
10
|
-
*
|
|
11
|
-
* at the moment
|
|
9
|
+
* Triggers a change in the size of the iframe. If you don't explicitely pass a
|
|
10
|
+
* `newHeight` it will be automatically calculated using the iframe content at the moment
|
|
12
11
|
*/
|
|
13
12
|
updateHeight: (newHeight?: number) => void;
|
|
14
13
|
};
|
|
@@ -27,8 +26,8 @@ export declare type RenderConfigScreenCtx = RenderConfigScreenPropertiesAndMetho
|
|
|
27
26
|
/** The full options you can pass to the `connect` function */
|
|
28
27
|
export declare type FullConnectParameters = {
|
|
29
28
|
/**
|
|
30
|
-
* This function will be called once at boot time and can be used to perform
|
|
31
|
-
*
|
|
29
|
+
* This function will be called once at boot time and can be used to perform ie. some
|
|
30
|
+
* initial integrity checks on the configuration.
|
|
32
31
|
*
|
|
33
32
|
* @group boot
|
|
34
33
|
*/
|
|
@@ -52,72 +51,69 @@ export declare type FullConnectParameters = {
|
|
|
52
51
|
*/
|
|
53
52
|
contentAreaSidebarItems: (ctx: IntentCtx) => ContentAreaSidebarItem[];
|
|
54
53
|
/**
|
|
55
|
-
* Use this function to declare new field extensions that users will be able
|
|
56
|
-
*
|
|
54
|
+
* Use this function to declare new field extensions that users will be able to install
|
|
55
|
+
* manually in some field
|
|
57
56
|
*
|
|
58
57
|
* @group manualFieldExtensions
|
|
59
58
|
*/
|
|
60
59
|
manualFieldExtensions: (ctx: IntentCtx) => ManualFieldExtension[];
|
|
61
60
|
/**
|
|
62
|
-
* Use this function to declare new sidebar panels to be shown when the user
|
|
63
|
-
*
|
|
61
|
+
* Use this function to declare new sidebar panels to be shown when the user edits
|
|
62
|
+
* records of a particular model
|
|
64
63
|
*
|
|
65
64
|
* @group sidebarPanels
|
|
66
65
|
*/
|
|
67
66
|
itemFormSidebarPanels: (itemType: ModelBlock, ctx: IntentCtx) => ItemFormSidebarPanel[];
|
|
68
67
|
/**
|
|
69
|
-
* Use this function to automatically force one or more field extensions to a
|
|
70
|
-
* particular field
|
|
68
|
+
* Use this function to automatically force one or more field extensions to a particular field
|
|
71
69
|
*
|
|
72
70
|
* @group forcedFieldExtensions
|
|
73
71
|
*/
|
|
74
72
|
overrideFieldExtensions: (field: Field, ctx: FieldIntentCtx) => FieldExtensionOverride | void;
|
|
75
73
|
/**
|
|
76
|
-
* This function will be called when the plugin needs to render the plugin's
|
|
77
|
-
* configuration form
|
|
74
|
+
* This function will be called when the plugin needs to render the plugin's configuration form
|
|
78
75
|
*
|
|
79
76
|
* @group configScreen
|
|
80
77
|
*/
|
|
81
78
|
renderConfigScreen: (ctx: RenderConfigScreenCtx) => void;
|
|
82
79
|
/**
|
|
83
|
-
* This function will be called when the plugin needs to render a specific
|
|
84
|
-
*
|
|
85
|
-
* `contentAreaSidebarItems` functions)
|
|
80
|
+
* This function will be called when the plugin needs to render a specific page (see the
|
|
81
|
+
* `mainNavigationTabs`, `settingsAreaSidebarItemGroups` and `contentAreaSidebarItems` functions)
|
|
86
82
|
*
|
|
87
83
|
* @group pages
|
|
88
84
|
*/
|
|
89
85
|
renderPage: (pageId: string, ctx: RenderPageCtx) => void;
|
|
90
86
|
/**
|
|
91
|
-
* This function will be called when the plugin requested to open a modal (see
|
|
92
|
-
*
|
|
87
|
+
* This function will be called when the plugin requested to open a modal (see the
|
|
88
|
+
* `openModal` function)
|
|
93
89
|
*
|
|
94
90
|
* @group modals
|
|
95
91
|
*/
|
|
96
92
|
renderModal: (modalId: string, ctx: RenderModalCtx) => void;
|
|
97
93
|
/**
|
|
98
|
-
* This function will be called when the plugin needs to render a sidebar
|
|
99
|
-
*
|
|
94
|
+
* This function will be called when the plugin needs to render a sidebar panel (see the
|
|
95
|
+
* `itemFormSidebarPanels` function)
|
|
100
96
|
*
|
|
101
97
|
* @group sidebarPanels
|
|
102
98
|
*/
|
|
103
99
|
renderItemFormSidebarPanel: (sidebarPaneId: string, ctx: RenderItemFormSidebarPanelCtx) => void;
|
|
104
100
|
/**
|
|
105
|
-
* This function will be called when the plugin needs to render a field
|
|
106
|
-
*
|
|
101
|
+
* This function will be called when the plugin needs to render a field extension (see
|
|
102
|
+
* the `manualFieldExtensions` and `overrideFieldExtensions` functions)
|
|
107
103
|
*
|
|
108
104
|
* @group forcedFieldExtensions
|
|
109
105
|
*/
|
|
110
106
|
renderFieldExtension: (fieldExtensionId: string, ctx: RenderFieldExtensionCtx) => void;
|
|
111
107
|
/**
|
|
112
|
-
* This function will be called when the plugin needs to render the
|
|
113
|
-
*
|
|
108
|
+
* This function will be called when the plugin needs to render the configuration form
|
|
109
|
+
* for installing a field extension inside a particular field
|
|
114
110
|
*
|
|
115
111
|
* @group manualFieldExtensions
|
|
116
112
|
*/
|
|
117
113
|
renderManualFieldExtensionConfigScreen: (fieldExtensionId: string, ctx: RenderManualFieldExtensionConfigScreenCtx) => void;
|
|
118
114
|
/**
|
|
119
|
-
* This function will be called each time the configuration object changes. It
|
|
120
|
-
*
|
|
115
|
+
* This function will be called each time the configuration object changes. It must
|
|
116
|
+
* return an object containing possible validation errors
|
|
121
117
|
*
|
|
122
118
|
* @group manualFieldExtensions
|
|
123
119
|
*/
|
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;AAyBzD,OAAO,EACL,YAAY,EACZ,cAAc,EACd,0BAA0B,EAC1B,4BAA4B,EAC5B,8CAA8C,EAC9C,mBAAmB,EACnB,kBAAkB,EAClB,yBAAyB,GAE1B,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"connect.js","sourceRoot":"","sources":["../../src/connect.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,OAAO,eAAe,MAAM,4BAA4B,CAAC;AAyBzD,OAAO,EACL,YAAY,EACZ,cAAc,EACd,0BAA0B,EAC1B,4BAA4B,EAC5B,8CAA8C,EAC9C,mBAAmB,EACnB,kBAAkB,EAClB,yBAAyB,GAE1B,MAAM,UAAU,CAAC;AA6IlB,SAAS,YAAY,CACnB,EAA+D;IAE/D,OAAO,UAAC,MAAe,EAAE,GAA6B;QACpD,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,CAAC,KAAK,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAe,CAAC;YACpF,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,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,kBAAkB,oBAAA;4BAClB,6BAA6B,+BAAA;4BAC7B,uBAAuB,yBAAA;4BACvB,qBAAqB,uBAAA;4BACrB,qBAAqB,uBAAA;4BACrB,uBAAuB,EAAE,YAAY,CAAC,aAAa,CAAC,uBAAuB,CAAC;4BAC5E,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,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,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,CAAC,QAAQ,CAAC,gBAAgB,iCACzE,MAAM,GACN,QAAQ,GACR,aAAW,EACd,CAAC;wBACL,CAAC,CAAC;wBAEF,QAAQ,GAAG,MAAM,CAAC;wBAClB,MAAM,CAAC,eAA2B,CAAC,CAAC;qBACrC;;;;;CACF"}
|
package/dist/esm/guards.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"guards.js","sourceRoot":"","sources":["../../src/guards.ts"],"names":[],"mappings":"AAaA,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,
|
|
1
|
+
{"version":3,"file":"guards.js","sourceRoot":"","sources":["../../src/guards.ts"],"names":[],"mappings":"AAaA,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,CAAqB,aAAa,CAAC,CAAC;AAEjF,MAAM,CAAC,IAAM,yBAAyB,GAAG,UAAU,CACjD,4BAA4B,CAC7B,CAAC;AAEF,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAU,CACpD,sBAAsB,CACvB,CAAC;AAEF,MAAM,CAAC,IAAM,8CAA8C,GAAG,UAAU,CACtE,wCAAwC,CACzC,CAAC"}
|