@microsoft/sp-module-interfaces 1.18.2 → 1.20.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.
@@ -16,6 +16,7 @@ export declare type ExtensionType = 'Unknown' | 'ApplicationCustomizer' | 'Field
16
16
  */
17
17
  export declare interface IAdaptiveCardExtensionManifest<TProperties> extends IClientSideComponentManifest {
18
18
  /* Excluded from this release type: connectedTeamsAppId */
19
+ /* Excluded from this release type: isPendingTeamsAppSync */
19
20
  /* Excluded from this release type: connectedSPFXAppId */
20
21
  /**
21
22
  * Definition: An array defining what host types are supported
@@ -707,6 +708,17 @@ export declare interface IClientSideWebPartManifest<TProperties> extends IClient
707
708
  */
708
709
  imagePreviewUrl?: string;
709
710
  /* Excluded from this release type: propertiesMetadata */
711
+ /**
712
+ * Optional JSON schema definition of the web part's properties.
713
+ * If provided, the schema will be provide additional validation for the type safety of the web part's persisted format.
714
+ *
715
+ * @remarks Current support JSON Schema draft v4+ schemas
716
+ *
717
+ * @public
718
+ */
719
+ jsonSchema?: {
720
+ [key: string]: unknown;
721
+ };
710
722
  /**
711
723
  * Definition: If true, notifies that the web part will render an iframe with a page from the same SharePoint tenant (domain).
712
724
  * Example: display a SharePoint Page in an iframe.
@@ -339,6 +339,17 @@ export declare interface IClientSideWebPartManifest<TProperties> extends IClient
339
339
  */
340
340
  imagePreviewUrl?: string;
341
341
  /* Excluded from this release type: propertiesMetadata */
342
+ /**
343
+ * Optional JSON schema definition of the web part's properties.
344
+ * If provided, the schema will be provide additional validation for the type safety of the web part's persisted format.
345
+ *
346
+ * @remarks Current support JSON Schema draft v4+ schemas
347
+ *
348
+ * @public
349
+ */
350
+ jsonSchema?: {
351
+ [key: string]: unknown;
352
+ };
342
353
  /**
343
354
  * Definition: If true, notifies that the web part will render an iframe with a page from the same SharePoint tenant (domain).
344
355
  * Example: display a SharePoint Page in an iframe.
@@ -339,6 +339,17 @@ export declare interface IClientSideWebPartManifest<TProperties> extends IClient
339
339
  */
340
340
  imagePreviewUrl?: string;
341
341
  /* Excluded from this release type: propertiesMetadata */
342
+ /**
343
+ * Optional JSON schema definition of the web part's properties.
344
+ * If provided, the schema will be provide additional validation for the type safety of the web part's persisted format.
345
+ *
346
+ * @remarks Current support JSON Schema draft v4+ schemas
347
+ *
348
+ * @public
349
+ */
350
+ jsonSchema?: {
351
+ [key: string]: unknown;
352
+ };
342
353
  /**
343
354
  * Definition: If true, notifies that the web part will render an iframe with a page from the same SharePoint tenant (domain).
344
355
  * Example: display a SharePoint Page in an iframe.
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.37.2"
8
+ "packageVersion": "7.42.3"
9
9
  }
10
10
  ]
11
11
  }
@@ -10,6 +10,12 @@ export interface IAdaptiveCardExtensionManifest<TProperties> extends IClientSide
10
10
  * @internal
11
11
  */
12
12
  connectedTeamsAppId?: string;
13
+ /**
14
+ * Specifies if the ACE manifest is pending sync with the Teams application
15
+ *
16
+ * @internal
17
+ */
18
+ isPendingTeamsAppSync?: boolean;
13
19
  /**
14
20
  * Id of the SPFx application that the ACE will redirect to when a “full page” experience is required
15
21
  *
@@ -1 +1 @@
1
- {"version":3,"file":"IAdaptiveCardExtensionManifest.d.ts","sourceRoot":"","sources":["../../src/manifestSchemas/IAdaptiveCardExtensionManifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AACrG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,8BAA8B,CAAC,WAAW,CAAE,SAAQ,4BAA4B;IAC/F;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;IAE5C;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IAEH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAE1C;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,cAAc,GAAG,iBAAiB,CAAC;IAE7D;;;;;;;;;;;OAWG;IACH,0CAA0C,CAAC,EAAE,OAAO,CAAC;IAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,oBAAoB,EAAE,mCAAmC,CAAC,WAAW,CAAC,EAAE,CAAC;CAC1E;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mCAAmC,CAAC,WAAW;IAC9D;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,WAAW,EAAE,gBAAgB,CAAC;IAE9B;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;;;;;OAYG;IACH,OAAO,EAAE,eAAe,GAAG,MAAM,CAAC;IAElC;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE1B;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;;OAcG;IACH,UAAU,EAAE,WAAW,CAAC;CACzB"}
1
+ {"version":3,"file":"IAdaptiveCardExtensionManifest.d.ts","sourceRoot":"","sources":["../../src/manifestSchemas/IAdaptiveCardExtensionManifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AACrG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,8BAA8B,CAAC,WAAW,CAAE,SAAQ,4BAA4B;IAC/F;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;IAE5C;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;OAGG;IAEH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAE1C;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,cAAc,GAAG,iBAAiB,CAAC;IAE7D;;;;;;;;;;;OAWG;IACH,0CAA0C,CAAC,EAAE,OAAO,CAAC;IAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,oBAAoB,EAAE,mCAAmC,CAAC,WAAW,CAAC,EAAE,CAAC;CAC1E;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mCAAmC,CAAC,WAAW;IAC9D;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,WAAW,EAAE,gBAAgB,CAAC;IAE9B;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;;;;;OAYG;IACH,OAAO,EAAE,eAAe,GAAG,MAAM,CAAC;IAElC;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE1B;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;;OAcG;IACH,UAAU,EAAE,WAAW,CAAC;CACzB"}
@@ -170,6 +170,17 @@ export interface IClientSideWebPartManifest<TProperties> extends IClientSideComp
170
170
  propertiesMetadata?: {
171
171
  current: any;
172
172
  };
173
+ /**
174
+ * Optional JSON schema definition of the web part's properties.
175
+ * If provided, the schema will be provide additional validation for the type safety of the web part's persisted format.
176
+ *
177
+ * @remarks Current support JSON Schema draft v4+ schemas
178
+ *
179
+ * @public
180
+ */
181
+ jsonSchema?: {
182
+ [key: string]: unknown;
183
+ };
173
184
  /**
174
185
  * Definition: If true, notifies that the web part will render an iframe with a page from the same SharePoint tenant (domain).
175
186
  * Example: display a SharePoint Page in an iframe.
@@ -1 +1 @@
1
- {"version":3,"file":"IClientSideWebPartManifest.d.ts","sourceRoot":"","sources":["../../src/manifestSchemas/IClientSideWebPartManifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAErG;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,0BAA0B,CAAC,WAAW,CAAE,SAAQ,4BAA4B;IAC3F;;;;;;OAMG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;;;;OAOG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAEtC;;;;OAIG;IAEH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAE1C;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;IAE7C;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,cAAc,GAAG,iBAAiB,CAAC;IAE7D;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;;;;;;;;OAYG;IACH,0CAA0C,CAAC,EAAE,OAAO,CAAC;IAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,oBAAoB,EAAE,+BAA+B,CAAC,WAAW,CAAC,EAAE,CAAC;IAErE;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,KAAK,CACpB,oBAAoB,GAAG,mBAAmB,GAAG,UAAU,GAAG,kBAAkB,GAAG,iBAAiB,CACjG,CAAC;IAEF;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE;QAEnB,OAAO,EAAE,GAAG,CAAC;KACd,CAAC;IAEF;;;;;;;OAOG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;;;GAIG;AAEH,MAAM,WAAW,kCAAkC,CAAC,WAAW,CAAE,SAAQ,4BAA4B;CAAG;AAExG;;;;;;GAMG;AACH,MAAM,WAAW,+BAA+B,CAAC,WAAW;IAC1D;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,WAAW,EAAE,gBAAgB,CAAC;IAE9B;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;;;;;OAYG;IACH,OAAO,EAAE,eAAe,GAAG,MAAM,CAAC;IAElC;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAEzB;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE1B;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;;OAcG;IACH,UAAU,EAAE,WAAW,CAAC;IAExB;;;;;;;;;;;;OAYG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;;;GAIG;AACH,0BAAkB,eAAe;IAC/B;;;;;;;OAOG;IACH,mBAAmB,yCAAyC;IAE5D;;;;;;OAMG;IACH,0BAA0B,yCAAyC;IAEnE;;;;;;OAMG;IACH,KAAK,yCAAyC;IAE9C;;;;;;OAMG;IACH,mBAAmB,yCAAyC;IAE5D;;;;;;OAMG;IACH,YAAY,yCAAyC;IAErD;;;;;;OAMG;IACH,mBAAmB,yCAAyC;IAE5D;;;;;;OAMG;IACH,QAAQ,yCAAyC;IAEjD;;;;;;OAMG;IACH,KAAK,yCAAyC;CAC/C;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,WAAW,CAAC,CAAC;CAC5D"}
1
+ {"version":3,"file":"IClientSideWebPartManifest.d.ts","sourceRoot":"","sources":["../../src/manifestSchemas/IClientSideWebPartManifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAErG;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,0BAA0B,CAAC,WAAW,CAAE,SAAQ,4BAA4B;IAC3F;;;;;;OAMG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;;;;OAOG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAEtC;;;;OAIG;IAEH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAE1C;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;IAE7C;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,cAAc,GAAG,iBAAiB,CAAC;IAE7D;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;;;;;;;;OAYG;IACH,0CAA0C,CAAC,EAAE,OAAO,CAAC;IAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,oBAAoB,EAAE,+BAA+B,CAAC,WAAW,CAAC,EAAE,CAAC;IAErE;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,KAAK,CACpB,oBAAoB,GAAG,mBAAmB,GAAG,UAAU,GAAG,kBAAkB,GAAG,iBAAiB,CACjG,CAAC;IAEF;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE;QAEnB,OAAO,EAAE,GAAG,CAAC;KACd,CAAC;IAEF;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAExC;;;;;;;OAOG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;;;GAIG;AAEH,MAAM,WAAW,kCAAkC,CAAC,WAAW,CAAE,SAAQ,4BAA4B;CAAG;AAExG;;;;;;GAMG;AACH,MAAM,WAAW,+BAA+B,CAAC,WAAW;IAC1D;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,WAAW,EAAE,gBAAgB,CAAC;IAE9B;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;;;;;OAYG;IACH,OAAO,EAAE,eAAe,GAAG,MAAM,CAAC;IAElC;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAEzB;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE1B;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;;OAcG;IACH,UAAU,EAAE,WAAW,CAAC;IAExB;;;;;;;;;;;;OAYG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;;;GAIG;AACH,0BAAkB,eAAe;IAC/B;;;;;;;OAOG;IACH,mBAAmB,yCAAyC;IAE5D;;;;;;OAMG;IACH,0BAA0B,yCAAyC;IAEnE;;;;;;OAMG;IACH,KAAK,yCAAyC;IAE9C;;;;;;OAMG;IACH,mBAAmB,yCAAyC;IAE5D;;;;;;OAMG;IACH,YAAY,yCAAyC;IAErD;;;;;;OAMG;IACH,mBAAmB,yCAAyC;IAE5D;;;;;;OAMG;IACH,QAAQ,yCAAyC;IAEjD;;;;;;OAMG;IACH,KAAK,yCAAyC;CAC/C;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,WAAW,CAAC,CAAC;CAC5D"}
@@ -312,6 +312,10 @@
312
312
  "additionalProperties": true
313
313
  }
314
314
  }
315
+ },
316
+ "jsonSchema": {
317
+ "additionalProperties": true,
318
+ "type": "object"
315
319
  }
316
320
  },
317
321
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@microsoft/sp-module-interfaces",
3
- "version": "1.18.2",
3
+ "version": "1.20.1",
4
4
  "description": "SharePoint Framework module interfaces",
5
5
  "license": "https://aka.ms/spfx/license",
6
6
  "homepage": "http://aka.ms/spfx",
@@ -14,11 +14,11 @@
14
14
  "tsdocFlavor": "AEDoc"
15
15
  },
16
16
  "dependencies": {
17
- "@rushstack/node-core-library": "3.61.0",
17
+ "@rushstack/node-core-library": "4.0.2",
18
18
  "z-schema": "4.2.4"
19
19
  },
20
20
  "devDependencies": {
21
- "@rushstack/heft": "0.62.1",
21
+ "@rushstack/heft": "0.66.0",
22
22
  "eslint": "8.7.0",
23
23
  "@odsp-web-tools/internal-node-rig": "0.1.0"
24
24
  },