@microsoft/sp-module-interfaces 1.20.2 → 1.21.0-beta.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/index-internal-beta.d.ts +47 -1
- package/dist/index-internal-public.d.ts +8 -1
- package/dist/index-internal.d.ts +748 -15
- package/dist/tsdoc-metadata.json +1 -1
- package/lib-commonjs/index.d.ts +1 -0
- package/lib-commonjs/index.d.ts.map +1 -1
- package/lib-commonjs/index.js +1 -0
- package/lib-commonjs/manifestSchemaValidator.d.ts +3 -0
- package/lib-commonjs/manifestSchemaValidator.d.ts.map +1 -1
- package/lib-commonjs/manifestSchemaValidator.js +52 -1
- package/lib-commonjs/manifestSchemas/IAdaptiveCardExtensionManifest.d.ts +6 -0
- package/lib-commonjs/manifestSchemas/IAdaptiveCardExtensionManifest.d.ts.map +1 -1
- package/lib-commonjs/manifestSchemas/IClientSideComponentManifest.d.ts +1 -1
- package/lib-commonjs/manifestSchemas/IClientSideComponentManifest.d.ts.map +1 -1
- package/lib-commonjs/manifestSchemas/IClientSideWebPartManifest.d.ts +35 -0
- package/lib-commonjs/manifestSchemas/IClientSideWebPartManifest.d.ts.map +1 -1
- package/lib-commonjs/manifestSchemas/IPrefabAppManifest.d.ts +76 -0
- package/lib-commonjs/manifestSchemas/IPrefabAppManifest.d.ts.map +1 -0
- package/lib-commonjs/manifestSchemas/IPrefabAppManifest.js +3 -0
- package/lib-commonjs/manifestSchemas/examples/prefab_1.manifest.d.ts +4 -0
- package/lib-commonjs/manifestSchemas/examples/prefab_1.manifest.d.ts.map +1 -0
- package/lib-commonjs/manifestSchemas/examples/prefab_1.manifest.js +334 -0
- package/lib-commonjs/manifestSchemas/examples/prefab_2.manifest.d.ts +4 -0
- package/lib-commonjs/manifestSchemas/examples/prefab_2.manifest.d.ts.map +1 -0
- package/lib-commonjs/manifestSchemas/examples/prefab_2.manifest.js +339 -0
- package/lib-commonjs/manifestSchemas/examples/prefabapp.manifest.json +345 -0
- package/lib-commonjs/manifestSchemas/jsonSchemas/adaptive-card-extension-manifest.schema.json +8 -0
- package/lib-commonjs/manifestSchemas/jsonSchemas/client-side-component-manifest.schema.json +5 -2
- package/lib-commonjs/manifestSchemas/jsonSchemas/client-side-web-part-manifest.schema.json +23 -0
- package/lib-commonjs/manifestSchemas/jsonSchemas/prefab-app-manifest.schema.json +72 -0
- package/lib-commonjs/manifestSchemas/remote/draft-04.schema.json +137 -0
- package/lib-commonjs/manifestSchemas/remote/site-design-script-actions.schema.json +1158 -0
- package/package.json +8 -7
package/dist/tsdoc-metadata.json
CHANGED
package/lib-commonjs/index.d.ts
CHANGED
|
@@ -10,4 +10,5 @@ export * from './manifestSchemas/IClientSideWebPartManifest';
|
|
|
10
10
|
export * from './manifestSchemas/ICommandSetExtensionManifest';
|
|
11
11
|
export * from './manifestSchemas/ManifestType';
|
|
12
12
|
export * from './manifestSchemas/IAdaptiveCardExtensionManifest';
|
|
13
|
+
export * from './manifestSchemas/IPrefabAppManifest';
|
|
13
14
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kDAAkD,CAAC;AACjE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2DAA2D,CAAC;AAC1E,cAAc,gDAAgD,CAAC;AAC/D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,mDAAmD,CAAC;AAClE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kDAAkD,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kDAAkD,CAAC;AACjE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2DAA2D,CAAC;AAC1E,cAAc,gDAAgD,CAAC;AAC/D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,8CAA8C,CAAC;AAC7D,cAAc,2CAA2C,CAAC;AAC1D,cAAc,mDAAmD,CAAC;AAClE,cAAc,8CAA8C,CAAC;AAC7D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kDAAkD,CAAC;AACjE,cAAc,sCAAsC,CAAC"}
|
package/lib-commonjs/index.js
CHANGED
|
@@ -26,4 +26,5 @@ __exportStar(require("./manifestSchemas/IClientSideWebPartManifest"), exports);
|
|
|
26
26
|
__exportStar(require("./manifestSchemas/ICommandSetExtensionManifest"), exports);
|
|
27
27
|
__exportStar(require("./manifestSchemas/ManifestType"), exports);
|
|
28
28
|
__exportStar(require("./manifestSchemas/IAdaptiveCardExtensionManifest"), exports);
|
|
29
|
+
__exportStar(require("./manifestSchemas/IPrefabAppManifest"), exports);
|
|
29
30
|
//# sourceMappingURL=index.js.map
|
|
@@ -7,13 +7,16 @@ import type { IClientSideLibraryManifest } from './manifestSchemas/IClientSideLi
|
|
|
7
7
|
import type { IClientSideMultiVersionManifest } from './manifestSchemas/IClientSideMultiVersionManifest';
|
|
8
8
|
import type { IClientSideWebPartManifest } from './manifestSchemas/IClientSideWebPartManifest';
|
|
9
9
|
import type { ICommandSetExtensionManifest } from './manifestSchemas/ICommandSetExtensionManifest';
|
|
10
|
+
import type { IPrefabAppManifest } from './manifestSchemas/IPrefabAppManifest';
|
|
10
11
|
export declare const zSchemaOptions: ZSchema.Options;
|
|
11
12
|
export interface IManifestValidatorResult {
|
|
12
13
|
result: boolean;
|
|
13
14
|
errors: ZSchema.SchemaErrorDetail[];
|
|
14
15
|
}
|
|
15
16
|
export default class ManifestValidator {
|
|
17
|
+
static registerRemoteSchemaReferences(): Promise<void>;
|
|
16
18
|
static validateApplicationManifest(manifest: string | IClientSideApplicationManifest): IManifestValidatorResult;
|
|
19
|
+
static validatePrefabAppManifest(manifest: string | IPrefabAppManifest): IManifestValidatorResult;
|
|
17
20
|
static validateCommandSetManifest(manifest: string | ICommandSetExtensionManifest): IManifestValidatorResult;
|
|
18
21
|
static validateExtensionManifest(manifest: string | IClientSideExtensionManifest): IManifestValidatorResult;
|
|
19
22
|
static validateWebPartManifest(manifest: string | IClientSideWebPartManifest<any>): IManifestValidatorResult;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifestSchemaValidator.d.ts","sourceRoot":"","sources":["../src/manifestSchemaValidator.ts"],"names":[],"mappings":"AAAA,MAAM,QAAQ,OAAO,GAAG,QAAQ,UAAU,CAAC,CAAC;AAO5C,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,kDAAkD,CAAC;AACvG,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+CAA+C,CAAC;AACjG,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gDAAgD,CAAC;AACnG,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gDAAgD,CAAC;AACnG,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8CAA8C,CAAC;AAC/F,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,mDAAmD,CAAC;AACzG,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8CAA8C,CAAC;AAC/F,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gDAAgD,CAAC;
|
|
1
|
+
{"version":3,"file":"manifestSchemaValidator.d.ts","sourceRoot":"","sources":["../src/manifestSchemaValidator.ts"],"names":[],"mappings":"AAAA,MAAM,QAAQ,OAAO,GAAG,QAAQ,UAAU,CAAC,CAAC;AAO5C,OAAO,KAAK,EAAE,8BAA8B,EAAE,MAAM,kDAAkD,CAAC;AACvG,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+CAA+C,CAAC;AACjG,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gDAAgD,CAAC;AACnG,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gDAAgD,CAAC;AACnG,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8CAA8C,CAAC;AAC/F,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,mDAAmD,CAAC;AACzG,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8CAA8C,CAAC;AAC/F,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gDAAgD,CAAC;AACnG,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sCAAsC,CAAC;AAsC/E,eAAO,MAAM,cAAc,EAAE,OAAO,CAAC,OAUpC,CAAC;AA+BF,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,OAAO,CAAC,iBAAiB,EAAE,CAAC;CACrC;AAED,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACtB,8BAA8B,IAAI,OAAO,CAAC,IAAI,CAAC;WAU/C,2BAA2B,CACvC,QAAQ,EAAE,MAAM,GAAG,8BAA8B,GAChD,wBAAwB;WAIb,yBAAyB,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB,GAAG,wBAAwB;WAI1F,0BAA0B,CACtC,QAAQ,EAAE,MAAM,GAAG,4BAA4B,GAC9C,wBAAwB;WAIb,yBAAyB,CACrC,QAAQ,EAAE,MAAM,GAAG,4BAA4B,GAC9C,wBAAwB;WAIb,uBAAuB,CAEnC,QAAQ,EAAE,MAAM,GAAG,0BAA0B,CAAC,GAAG,CAAC,GACjD,wBAAwB;WAIb,uBAAuB,CACnC,QAAQ,EAAE,MAAM,GAAG,0BAA0B,GAC5C,wBAAwB;WAIb,wBAAwB,CACpC,QAAQ,EAAE,MAAM,GAAG,2BAA2B,GAC7C,wBAAwB;WAIb,4BAA4B,CAExC,QAAQ,EAAE,MAAM,GAAG,+BAA+B,CAAC,GAAG,CAAC,GACtD,wBAAwB;WAIb,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,4BAA4B,GAAG,wBAAwB;WAI3F,yBAAyB,CAAC,MAAM,EAAE,OAAO,CAAC,iBAAiB,EAAE,GAAG,MAAM,EAAE;WAmBxE,wBAAwB,CAAC,MAAM,EAAE,OAAO,CAAC,iBAAiB,EAAE,GAAG,MAAM;IAInF,OAAO,CAAC,MAAM,CAAC,iBAAiB;CAoBjC"}
|
|
@@ -35,12 +35,28 @@ const schemaFiles = fs.readdirSync(schemasDirectory);
|
|
|
35
35
|
const schemas = schemaFiles.map((schemaFile) => require(path.join(schemasDirectory, schemaFile)));
|
|
36
36
|
const manifestSchema = require('./manifestSchemas/jsonSchemas/client-side-component-manifest.schema.json');
|
|
37
37
|
const applicationSchema = require('./manifestSchemas/jsonSchemas/client-side-application-manifest.schema.json');
|
|
38
|
+
const prefabAppSchema = require('./manifestSchemas/jsonSchemas/prefab-app-manifest.schema.json');
|
|
38
39
|
const webPartSchema = require('./manifestSchemas/jsonSchemas/client-side-web-part-manifest.schema.json');
|
|
39
40
|
const commandSetSchema = require('./manifestSchemas/jsonSchemas/command-set-extension-manifest.schema.json');
|
|
40
41
|
const extensionSchema = require('./manifestSchemas/jsonSchemas/client-side-extension-manifest.schema.json');
|
|
41
42
|
const librarySchema = require('./manifestSchemas/jsonSchemas/client-side-library-manifest.schema.json');
|
|
42
43
|
const assemblySchema = require('./manifestSchemas/jsonSchemas/client-side-assembly-manifest.schema.json');
|
|
43
44
|
const multiVersionSchema = require('./manifestSchemas/jsonSchemas/client-side-multi-version-manifest.schema.json');
|
|
45
|
+
// local copy of site scripts schema and draft-07 schema
|
|
46
|
+
const siteScriptsSchema = require('./manifestSchemas/remote/site-design-script-actions.schema.json');
|
|
47
|
+
const draft04Schema = require('./manifestSchemas/remote/draft-04.schema.json');
|
|
48
|
+
const SITE_SCRIPTS_SCHEMA_URL = 'https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json';
|
|
49
|
+
const DRAFT_07_SCHEMA_URL = 'http://json-schema.org/draft-07/schema#';
|
|
50
|
+
const siteScriptsSchemaPromise = fetch(SITE_SCRIPTS_SCHEMA_URL)
|
|
51
|
+
.then((response) => {
|
|
52
|
+
return response.text();
|
|
53
|
+
})
|
|
54
|
+
.catch((error) => {
|
|
55
|
+
// eslint-disable-next-line no-console
|
|
56
|
+
console.error(`Failed to fetch remote schema: ${error}`);
|
|
57
|
+
// fallback to local copy
|
|
58
|
+
return JSON.stringify(siteScriptsSchema);
|
|
59
|
+
});
|
|
44
60
|
exports.zSchemaOptions = {
|
|
45
61
|
breakOnFirstError: true,
|
|
46
62
|
forceAdditional: true,
|
|
@@ -52,11 +68,46 @@ exports.zSchemaOptions = {
|
|
|
52
68
|
noEmptyStrings: true
|
|
53
69
|
};
|
|
54
70
|
const schemaValidator = new exports.ZSchema(exports.zSchemaOptions);
|
|
55
|
-
|
|
71
|
+
const draft07ValidationOptions = {
|
|
72
|
+
strictMode: false,
|
|
73
|
+
ignoreUnresolvableReferences: true,
|
|
74
|
+
ignoreUnknownFormats: true
|
|
75
|
+
};
|
|
76
|
+
//
|
|
77
|
+
// this one is needed for the site scripts reference.
|
|
78
|
+
// We're faking draft-07 schema with draft-04 schema as z-schema doesn't support draft-07
|
|
79
|
+
//
|
|
80
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
81
|
+
schemaValidator.setRemoteReference(DRAFT_07_SCHEMA_URL, draft04Schema, draft07ValidationOptions);
|
|
82
|
+
siteScriptsSchemaPromise
|
|
83
|
+
.then((remoteSchema) => {
|
|
84
|
+
// ZSchema typedef doesn't contain setRemoteReference method. But it does exist in the implementation and referenced in the documentation.
|
|
85
|
+
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
86
|
+
schemaValidator.setRemoteReference(SITE_SCRIPTS_SCHEMA_URL, JSON.parse(remoteSchema), {
|
|
87
|
+
strictMode: false,
|
|
88
|
+
ignoreUnresolvableReferences: true
|
|
89
|
+
});
|
|
90
|
+
schemaValidator.validateSchema(schemas);
|
|
91
|
+
})
|
|
92
|
+
.catch((error) => {
|
|
93
|
+
// swallowing the error here
|
|
94
|
+
});
|
|
56
95
|
class ManifestValidator {
|
|
96
|
+
static registerRemoteSchemaReferences() {
|
|
97
|
+
return siteScriptsSchemaPromise
|
|
98
|
+
.then(() => {
|
|
99
|
+
// no-op;
|
|
100
|
+
})
|
|
101
|
+
.catch(() => {
|
|
102
|
+
// no-op;
|
|
103
|
+
});
|
|
104
|
+
}
|
|
57
105
|
static validateApplicationManifest(manifest) {
|
|
58
106
|
return ManifestValidator._validateManifest(manifest, applicationSchema);
|
|
59
107
|
}
|
|
108
|
+
static validatePrefabAppManifest(manifest) {
|
|
109
|
+
return ManifestValidator._validateManifest(manifest, prefabAppSchema);
|
|
110
|
+
}
|
|
60
111
|
static validateCommandSetManifest(manifest) {
|
|
61
112
|
return ManifestValidator._validateManifest(manifest, commandSetSchema);
|
|
62
113
|
}
|
|
@@ -70,6 +70,12 @@ export interface IAdaptiveCardExtensionManifest<TProperties> extends IClientSide
|
|
|
70
70
|
* @internal
|
|
71
71
|
*/
|
|
72
72
|
isolationLevel?: 'None' | 'DOMIsolation' | 'DomainIsolation';
|
|
73
|
+
/**
|
|
74
|
+
* The scope of the personalization on how an AdaptiveCardExtension can be personalized by an end user.
|
|
75
|
+
*
|
|
76
|
+
* @beta
|
|
77
|
+
*/
|
|
78
|
+
personalization?: 'Disallow' | 'Allow';
|
|
73
79
|
/**
|
|
74
80
|
* Definition:
|
|
75
81
|
* - If true, the AdaptiveCardExtension will be disposed and reloaded when the AdaptiveCardExtension data is updated by an external source.
|
|
@@ -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,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"}
|
|
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;;;;OAIG;IACH,eAAe,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC;IAEvC;;;;;;;;;;;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"}
|
|
@@ -49,7 +49,7 @@ export interface ILocalizedString {
|
|
|
49
49
|
* Type of client-side component.
|
|
50
50
|
* @public
|
|
51
51
|
*/
|
|
52
|
-
export type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension' | 'AdaptiveCardExtension';
|
|
52
|
+
export type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension' | 'AdaptiveCardExtension' | 'Prefab';
|
|
53
53
|
/**
|
|
54
54
|
* All client-side components built on the SharePoint framework need a valid component manifest. This interface
|
|
55
55
|
* represents properties that are required by all types of client-side components like Applications and Web Parts.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IClientSideComponentManifest.d.ts","sourceRoot":"","sources":["../../src/manifestSchemas/IClientSideComponentManifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AACzG,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,
|
|
1
|
+
{"version":3,"file":"IClientSideComponentManifest.d.ts","sourceRoot":"","sources":["../../src/manifestSchemas/IClientSideComponentManifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AACzG,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GACrB,aAAa,GACb,SAAS,GACT,SAAS,GACT,WAAW,GACX,uBAAuB,GACvB,QAAQ,CAAC;AAEb;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,4BAA6B,SAAQ,uBAAuB;IAC3E;;;;;;;;;;;;OAYG;IACH,aAAa,EAAE,aAAa,CAAC;IAE7B;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;;;;;;;;;;OAWG;IACH,YAAY,EAAE,uCAAuC,CAAC;IAEtD;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;;;;;;;;OAUG;IAEH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAEpC;;;;;;;;;;OAUG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;;OAIG;IAEH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CAC3C"}
|
|
@@ -190,6 +190,41 @@ export interface IClientSideWebPartManifest<TProperties> extends IClientSideComp
|
|
|
190
190
|
* and will be hosted as a Teams application (supportedHosts contains any of Teams hosts).
|
|
191
191
|
*/
|
|
192
192
|
supportsSelfFramingInTeams?: boolean;
|
|
193
|
+
/**
|
|
194
|
+
* Definition: Defines the default sizing of webpart in flexible sections, as well as if it supports dynamic resizing.
|
|
195
|
+
* Example:
|
|
196
|
+
* ```
|
|
197
|
+
* flexibleLayoutSizing: {
|
|
198
|
+
* supportsDynamicResizing: false,
|
|
199
|
+
* defaultColumnWidth: 22,
|
|
200
|
+
* defaultRowHeight: 21
|
|
201
|
+
* }
|
|
202
|
+
* ```
|
|
203
|
+
* @remarks
|
|
204
|
+
* Ensure this remains up to date with IFlexibleControlSizingData in FlexibleControl.types.ts
|
|
205
|
+
*
|
|
206
|
+
* @beta
|
|
207
|
+
*/
|
|
208
|
+
flexibleLayoutSizing?: IFlexibleLayoutSizing;
|
|
209
|
+
}
|
|
210
|
+
/**
|
|
211
|
+
* Flexible layout sizing data
|
|
212
|
+
* @beta
|
|
213
|
+
*/
|
|
214
|
+
export interface IFlexibleLayoutSizing {
|
|
215
|
+
/**
|
|
216
|
+
* If true webpart can resize to any width between minimum and 70 columns
|
|
217
|
+
* Otherwise webpart is slot resized to 22, 34, 48, or 70 columns
|
|
218
|
+
*/
|
|
219
|
+
supportsDynamicResizing?: boolean;
|
|
220
|
+
/**
|
|
221
|
+
* Default column width for the webpart, used by drop hint
|
|
222
|
+
*/
|
|
223
|
+
defaultColumnWidth?: number;
|
|
224
|
+
/**
|
|
225
|
+
* Default row height for the webpart, used by drop hint
|
|
226
|
+
*/
|
|
227
|
+
defaultRowHeight?: number;
|
|
193
228
|
}
|
|
194
229
|
/**
|
|
195
230
|
* Manifest that is relevant to a Web Part instance.
|
|
@@ -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,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAExC;;;;;;;OAOG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;
|
|
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;IAErC;;;;;;;;;;;;;;OAcG;IACH,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;CAC9C;AAED;;;GAGG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;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"}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import type { IClientSideComponentManifest, ILocalizedString } from './IClientSideComponentManifest';
|
|
2
|
+
/**
|
|
3
|
+
* This is the manifest for a PREFAB application.
|
|
4
|
+
*
|
|
5
|
+
* @alpha
|
|
6
|
+
*/
|
|
7
|
+
export interface IPrefabAppManifest extends IClientSideComponentManifest {
|
|
8
|
+
/**
|
|
9
|
+
* Title of the application as a dictionary of locale keys to title values. This value will be
|
|
10
|
+
* displayed to the user in the (page creation) interface.
|
|
11
|
+
*
|
|
12
|
+
* @remarks
|
|
13
|
+
*
|
|
14
|
+
* Supported values: a dictionary of locale keys to strings. Should always have a 'default' key.
|
|
15
|
+
*
|
|
16
|
+
* Example: `"My Application"`
|
|
17
|
+
*
|
|
18
|
+
* ```
|
|
19
|
+
* {
|
|
20
|
+
* "default": "My Application"
|
|
21
|
+
* "en-us": "My Application",
|
|
22
|
+
* "fr-fr": "Ma demande",
|
|
23
|
+
* "zh": "我的應用程式"
|
|
24
|
+
* }
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
title: ILocalizedString;
|
|
28
|
+
/**
|
|
29
|
+
* Description of the application represented as a dictionary of locale keys to description values.
|
|
30
|
+
* This value will be displayed to the user in the (page creation) interface.
|
|
31
|
+
*
|
|
32
|
+
* @remarks
|
|
33
|
+
*
|
|
34
|
+
* Supported values: a dictionary of locale keys to strings. Should always have a 'default' key.
|
|
35
|
+
*
|
|
36
|
+
* Examples:
|
|
37
|
+
*
|
|
38
|
+
* ```
|
|
39
|
+
* "An application for searching for things."
|
|
40
|
+
* ```
|
|
41
|
+
* or
|
|
42
|
+
* ```
|
|
43
|
+
* {
|
|
44
|
+
* "default": "An application for searching for things.",
|
|
45
|
+
* "en-us": "An application for searching for things.",
|
|
46
|
+
* "fr-fr": "Une demande pour la recherche de choses.",
|
|
47
|
+
* "zh": "申請尋找的東西。"
|
|
48
|
+
* }
|
|
49
|
+
* ```
|
|
50
|
+
*/
|
|
51
|
+
description: ILocalizedString;
|
|
52
|
+
/**
|
|
53
|
+
* Specifies if there is a FCE (Finish Configuration Experience) available for the app. True if no FCE is available.
|
|
54
|
+
*/
|
|
55
|
+
isConfigured: boolean;
|
|
56
|
+
/**
|
|
57
|
+
* Describes how the PREFAB app can be installed: NewSite or ExistingSite. If omitted the app supports both.
|
|
58
|
+
*/
|
|
59
|
+
appInstallationTypes?: Array<'NewSite' | 'ExistingSite'>;
|
|
60
|
+
/**
|
|
61
|
+
* Site script actions.
|
|
62
|
+
*
|
|
63
|
+
* @remarks - See https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json
|
|
64
|
+
*/
|
|
65
|
+
actions?: ISiteScriptActionBase[];
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Base definition for Site Script action.
|
|
69
|
+
*
|
|
70
|
+
* @alpha
|
|
71
|
+
*/
|
|
72
|
+
export interface ISiteScriptActionBase {
|
|
73
|
+
verb: string;
|
|
74
|
+
[key: string]: any;
|
|
75
|
+
}
|
|
76
|
+
//# sourceMappingURL=IPrefabAppManifest.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"IPrefabAppManifest.d.ts","sourceRoot":"","sources":["../../src/manifestSchemas/IPrefabAppManifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,4BAA4B,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAErG;;;;GAIG;AACH,MAAM,WAAW,kBAAmB,SAAQ,4BAA4B;IACtE;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,WAAW,EAAE,gBAAgB,CAAC;IAE9B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,oBAAoB,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,cAAc,CAAC,CAAC;IAEzD;;;;OAIG;IAEH,OAAO,CAAC,EAAE,qBAAqB,EAAE,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IAEb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefab_1.manifest.d.ts","sourceRoot":"","sources":["../../../src/manifestSchemas/examples/prefab_1.manifest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAQhE,QAAA,MAAM,cAAc,EAAE,kBAoXrB,CAAC;AAEF,SAAS,cAAc,CAAC"}
|