datocms-plugin-sdk 0.5.1 → 0.6.0
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.map +1 -1
- package/dist/esm/SiteApiSchema.d.ts +2424 -971
- package/dist/esm/connect.d.ts +7 -7
- package/dist/esm/connect.js.map +1 -1
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/types.d.ts +5 -5
- package/dist/types/SiteApiSchema.d.ts +2424 -971
- package/dist/types/connect.d.ts +7 -7
- package/dist/types/index.d.ts +2 -2
- package/dist/types/types.d.ts +5 -5
- package/package.json +2 -2
- package/src/SiteApiSchema.ts +2819 -977
- package/src/connect.ts +8 -8
- package/src/index.ts +2 -2
- package/src/types.ts +4 -4
- package/types.json +1227 -1208
package/dist/esm/connect.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Field,
|
|
1
|
+
import { Field, ItemType } from './SiteApiSchema';
|
|
2
2
|
import { AssetSource, ContentAreaSidebarItem, FieldExtensionOverride, InitPropertiesAndMethods, ItemFormSidebarPanel, MainNavigationTab, ManualFieldExtension, OnBootPropertiesAndMethods, RenderAssetSourcePropertiesAndMethods, RenderConfigScreenPropertiesAndMethods, RenderFieldExtensionPropertiesAndMethods, RenderManualFieldExtensionConfigScreenPropertiesAndMethods, RenderModalPropertiesAndMethods, RenderPagePropertiesAndMethods, RenderSidebarPanelPropertiesAndMethods, SettingsAreaSidebarItemGroup } from './types';
|
|
3
3
|
import { ItemFormOutlet, RenderItemFormOutletPropertiesAndMethods, StructuredTextCustomBlockStyle, StructuredTextCustomMark } from '.';
|
|
4
4
|
export declare type SizingUtilities = {
|
|
@@ -17,11 +17,11 @@ export declare type SizingUtilities = {
|
|
|
17
17
|
*/
|
|
18
18
|
updateHeight: (newHeight?: number) => void;
|
|
19
19
|
};
|
|
20
|
-
export type { Field,
|
|
20
|
+
export type { Field, ItemType };
|
|
21
21
|
export declare type IntentCtx = InitPropertiesAndMethods;
|
|
22
22
|
export declare type OnBootCtx = OnBootPropertiesAndMethods;
|
|
23
23
|
export declare type FieldIntentCtx = InitPropertiesAndMethods & {
|
|
24
|
-
itemType:
|
|
24
|
+
itemType: ItemType;
|
|
25
25
|
};
|
|
26
26
|
export declare type RenderPageCtx = RenderPagePropertiesAndMethods;
|
|
27
27
|
export declare type RenderModalCtx = RenderModalPropertiesAndMethods & SizingUtilities;
|
|
@@ -78,14 +78,14 @@ export declare type FullConnectParameters = {
|
|
|
78
78
|
*
|
|
79
79
|
* @group sidebarPanels
|
|
80
80
|
*/
|
|
81
|
-
itemFormSidebarPanels: (itemType:
|
|
81
|
+
itemFormSidebarPanels: (itemType: ItemType, ctx: IntentCtx) => ItemFormSidebarPanel[];
|
|
82
82
|
/**
|
|
83
83
|
* Use this function to declare custom outlets to be shown at the top of the
|
|
84
84
|
* record's editing page
|
|
85
85
|
*
|
|
86
|
-
* @group
|
|
86
|
+
* @group itemFormOutlets
|
|
87
87
|
*/
|
|
88
|
-
itemFormOutlets: (itemType:
|
|
88
|
+
itemFormOutlets: (itemType: ItemType, ctx: IntentCtx) => ItemFormOutlet[];
|
|
89
89
|
/**
|
|
90
90
|
* Use this function to automatically force one or more field extensions to a
|
|
91
91
|
* particular field
|
|
@@ -140,7 +140,7 @@ export declare type FullConnectParameters = {
|
|
|
140
140
|
* This function will be called when the plugin needs to render an outlet (see
|
|
141
141
|
* the `itemFormOutlets` function)
|
|
142
142
|
*
|
|
143
|
-
* @group
|
|
143
|
+
* @group itemFormOutlets
|
|
144
144
|
*/
|
|
145
145
|
renderItemFormOutlet: (itemFormOutletId: string, ctx: RenderItemFormOutletCtx) => void;
|
|
146
146
|
/**
|
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,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,
|
|
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,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;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,GAOV,aAAa,aAPH,EACZ,kBAAkB,GAMhB,aAAa,mBANG,EAClB,6BAA6B,GAK3B,aAAa,8BALc,EAC7B,uBAAuB,GAIrB,aAAa,wBAJQ,EACvB,qBAAqB,GAGnB,aAAa,sBAHM,EACrB,qBAAqB,GAEnB,aAAa,sBAFM,EACrB,eAAe,GACb,aAAa,gBADA,CACC;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,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,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/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Account, Field, Item,
|
|
2
|
-
export type { Account, Field, Item,
|
|
1
|
+
import { Account, Field, Item, ItemType, Plugin, Site, SsoUser, Upload, User, Role } from './SiteApiSchema';
|
|
2
|
+
export type { Account, Field, Item, ItemType, Plugin, Site, SsoUser, Upload, User, Role, };
|
|
3
3
|
export * from './connect';
|
|
4
4
|
export * from './types';
|
package/dist/esm/types.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import { BlockNodeTypeWithCustomStyle } from 'datocms-structured-text-utils';
|
|
3
|
-
import { Account, Field, Fieldset, Item,
|
|
3
|
+
import { Account, Field, Fieldset, Item, ItemType, Plugin, Role, Site, SsoUser, Upload, User } from './SiteApiSchema';
|
|
4
4
|
export declare type Icon = string | {
|
|
5
5
|
type: 'svg';
|
|
6
6
|
viewBox: string;
|
|
@@ -209,7 +209,7 @@ export declare type ItemFormOutlet = {
|
|
|
209
209
|
* value you choose might clash with the one of another plugin!
|
|
210
210
|
*/
|
|
211
211
|
rank?: number;
|
|
212
|
-
/** The initial height to set for the iframe that will render the
|
|
212
|
+
/** The initial height to set for the iframe that will render the outlet */
|
|
213
213
|
initialHeight?: number;
|
|
214
214
|
};
|
|
215
215
|
/** A field editor/sidebar forced on a field */
|
|
@@ -454,7 +454,7 @@ export declare type CommonProperties = {
|
|
|
454
454
|
/** The ID of the current environment */
|
|
455
455
|
environment: string;
|
|
456
456
|
/** All the models of the current DatoCMS project, indexed by ID */
|
|
457
|
-
itemTypes: Partial<Record<string,
|
|
457
|
+
itemTypes: Partial<Record<string, ItemType>>;
|
|
458
458
|
/**
|
|
459
459
|
* The current DatoCMS user. It can either be the owner or one of the
|
|
460
460
|
* collaborators (regular or SSO).
|
|
@@ -1011,7 +1011,7 @@ export declare type ItemFormAdditionalProperties = {
|
|
|
1011
1011
|
/** If an already persisted record is being edited, returns the full record entity */
|
|
1012
1012
|
item: Item | null;
|
|
1013
1013
|
/** The model for the record being edited */
|
|
1014
|
-
itemType:
|
|
1014
|
+
itemType: ItemType;
|
|
1015
1015
|
/** The complete internal form state */
|
|
1016
1016
|
formValues: Record<string, unknown>;
|
|
1017
1017
|
/** The current status of the record being edited */
|
|
@@ -1331,7 +1331,7 @@ export declare type RenderManualFieldExtensionConfigScreenAdditionalProperties =
|
|
|
1331
1331
|
/** The field entity that is being edited in the form */
|
|
1332
1332
|
pendingField: PendingField;
|
|
1333
1333
|
/** The model for the field being edited */
|
|
1334
|
-
itemType:
|
|
1334
|
+
itemType: ItemType;
|
|
1335
1335
|
};
|
|
1336
1336
|
export declare type RenderManualFieldExtensionConfigScreenProperties = RenderProperties & RenderManualFieldExtensionConfigScreenAdditionalProperties;
|
|
1337
1337
|
/**
|