@microsoft/sp-module-interfaces 1.21.0-beta.0 → 1.21.0-beta.2

package/lib-esm/manifestSchemas/jsonSchemas/prefab-app-manifest.schema.json

@@ -0,0 +1,176 @@
+{
+  "id": "prefab-app-manifest.schema.json",
+  "title": "PREFAB application manifest",
+  "description": "A PREFAB application is the architectural component that allows developers to declaratively specify behavior of a full page application.",
+
+  "definitions": {
+    "prefabAppSiteScript": {
+      "title": "PREFAB Application Site Script",
+      "type": "object",
+      "additionalProperties": {
+        "oneOf": [
+          {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": ["onInstall", "onDemand"]
+              },
+              "actions": {
+                "$ref": "https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json#/properties/actions"
+              }
+            },
+            "required": ["type", "actions"],
+            "additionalProperties": false
+          }
+        ]
+      }
+    }
+  },
+
+  "type": "object",
+  "allOf": [
+    {
+      "type": "object",
+
+      "properties": {
+        "$schema": { "type": "string" },
+
+        "manifestVersion": { "$ref": "any-value.schema.json" },
+        "id": { "$ref": "any-value.schema.json" },
+        "alias": { "$ref": "any-value.schema.json" },
+        "version": { "$ref": "any-value.schema.json" },
+        "loaderConfig": { "$ref": "any-value.schema.json" },
+        "componentType": { "$ref": "any-value.schema.json" },
+        "preloadComponents": { "$ref": "any-value.schema.json" },
+        "title": { "$ref": "any-value.schema.json" },
+        "description": { "$ref": "any-value.schema.json" },
+        "isConfigured": { "$ref": "any-value.schema.json" },
+        "siteSettingsLinks": { "$ref": "any-value.schema.json" },
+        "toolboxEntries": { "$ref": "any-value.schema.json" },
+        "appInstallationTypes": {
+          "description": "Describes how the PREFAB app can be installed: NewSite or ExistingSite. If omitted the app supports both.",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["NewSite", "ExistingSite"]
+          }
+        },
+        "actions": { "$ref": "any-value.schema.json" }
+      },
+      "additionalProperties": false
+    },
+    {
+      "$ref": "client-side-component-manifest.schema.json#/definitions/clientSideComponentManifest"
+    },
+    {
+      "type": "object",
+      "required": ["componentType", "title", "description", "isConfigured"],
+      "properties": {
+        "componentType": {
+          "type": "string",
+          "enum": ["Prefab"]
+        },
+
+        "title": {
+          "title": "Title",
+          "description": "Title of the application as a dictionary of locale keys to title values. This value will be displayed to the user in the (page creation) interface. A dictionary must contain a \"default\" key.",
+          "$ref": "localized-string.schema.json"
+        },
+
+        "description": {
+          "title": "Description",
+          "description": "Description of the application represented as a dictionary of locale keys to description values. This value will be displayed to the user in the (page creation) interface. A dictionary must contain a \"default\" key.",
+          "$ref": "localized-string.schema.json"
+        },
+
+        "isConfigured": {
+          "title": "Is configured",
+          "description": "True if the application is configured and not need a FRC (First Run Configuration) step.",
+          "type": "boolean"
+        },
+
+        "siteSettingsLinks": {
+          "title": "Site settings links",
+          "description": "Links to be rendered in the suite nav site settings menu for the PREFAB App.",
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "description": "Represents an item that should be rendered in the suite nav site settings menu.",
+            "type": "object",
+            "properties": {
+              "viewId": {
+                "title": "Route ID",
+                "description": "The unique identifier of the route to be rendered when the settings link is selected.",
+                "type": "string"
+              },
+              "text": {
+                "title": "Text",
+                "description": "Text of the link represented as a dictionary of locale keys to title values. This value will be displayed to the user in the suite nav site settings menu.",
+                "$ref": "localized-string.schema.json"
+              }
+            },
+            "required": ["viewId", "text"],
+            "additionalProperties": false
+          }
+        },
+
+        "toolboxEntries": {
+          "title": "Toolbox entries",
+          "description": "Toolbox entries for the PREFAB app.",
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "description": "This interface specifies the set of that can be provided by a PREFAB developer if the application should be available in the modern SharePoint toolbox.",
+            "type": "object",
+            "properties": {
+              "viewId": {
+                "title": "Route ID",
+                "description": "The unique identifier of the route to be rendered if the entry is added to the page.",
+                "type": "string"
+              },
+              "title": {
+                "title": "Title",
+                "description": "Title of the PREFAB entry represented as a single a dictionary of locale keys to title values. This value will be displayed to the user in the toolbox.",
+                "$ref": "localized-string.schema.json"
+              },
+              "description": {
+                "title": "Description",
+                "description": "Description of the PREFAB entry represented as a dictionary of locale keys to description values. This value will be displayed to the user in the toolbox.",
+                "$ref": "localized-string.schema.json"
+              },
+              "officeFabricIconFontName": {
+                "title": "Office Fabric Icon Name",
+                "description": "The icon for the PREFAB entry, to be displayed in the toolbox, represented as a character name in the Office 365 icon font file. The icon font is specified here: https://aka.ms/uifabric-icons. If this field has a value, the 'iconImageUrl' field will be ignored.",
+                "type": "string",
+                "minLength": 1
+              },
+
+              "iconImageUrl": {
+                "title": "Icon Image URL",
+                "description": "The icon for the PREFAB app, to be displayed in the toolbox, represented an image URL. The image at the URL must be exactly 38x38 px. If the 'officeFabricIconName' field does not have a value, this field must have a value.",
+                "type": "string",
+                "minLength": 10
+              }
+            },
+            "anyOf": [
+              {
+                "required": ["viewId", "title", "description", "officeFabricIconFontName"]
+              },
+              {
+                "required": ["viewId", "title", "description", "iconImageUrl"]
+              }
+            ],
+            "additionalProperties": false
+          }
+        },
+
+        "actions": {
+          "$ref": "#/definitions/prefabAppSiteScript"
+        }
+      },
+
+      "additionalProperties": true
+    }
+  ]
+}

package/lib-esm/manifestSchemas/jsonSchemas/semver.schema.json

@@ -0,0 +1,8 @@
+{
+  "id": "semver.schema.json",
+
+  "type": "string",
+  "minLength": 5,
+  "maxLength": 14,
+  "pattern": "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$"
+}

package/lib-esm/manifestSchemas/remote/draft-04.schema.json

@@ -0,0 +1,137 @@
+{
+  "id": "http://json-schema.org/draft-04/schema#",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Core schema meta-schema",
+  "definitions": {
+    "schemaArray": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "#" }
+    },
+    "positiveInteger": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "positiveIntegerDefault0": {
+      "allOf": [{ "$ref": "#/definitions/positiveInteger" }, { "default": 0 }]
+    },
+    "simpleTypes": {
+      "enum": ["array", "boolean", "integer", "null", "number", "object", "string"]
+    },
+    "stringArray": {
+      "type": "array",
+      "items": { "type": "string" },
+      "minItems": 1,
+      "uniqueItems": true
+    }
+  },
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "$schema": {
+      "type": "string"
+    },
+    "title": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "default": {},
+    "multipleOf": {
+      "type": "number",
+      "minimum": 0,
+      "exclusiveMinimum": true
+    },
+    "maximum": {
+      "type": "number"
+    },
+    "exclusiveMaximum": {
+      "type": "boolean",
+      "default": false
+    },
+    "minimum": {
+      "type": "number"
+    },
+    "exclusiveMinimum": {
+      "type": "boolean",
+      "default": false
+    },
+    "maxLength": { "$ref": "#/definitions/positiveInteger" },
+    "minLength": { "$ref": "#/definitions/positiveIntegerDefault0" },
+    "pattern": {
+      "type": "string",
+      "format": "regex"
+    },
+    "additionalItems": {
+      "anyOf": [{ "type": "boolean" }, { "$ref": "#" }],
+      "default": {}
+    },
+    "items": {
+      "anyOf": [{ "$ref": "#" }, { "$ref": "#/definitions/schemaArray" }],
+      "default": {}
+    },
+    "maxItems": { "$ref": "#/definitions/positiveInteger" },
+    "minItems": { "$ref": "#/definitions/positiveIntegerDefault0" },
+    "uniqueItems": {
+      "type": "boolean",
+      "default": false
+    },
+    "maxProperties": { "$ref": "#/definitions/positiveInteger" },
+    "minProperties": { "$ref": "#/definitions/positiveIntegerDefault0" },
+    "required": { "$ref": "#/definitions/stringArray" },
+    "additionalProperties": {
+      "anyOf": [{ "type": "boolean" }, { "$ref": "#" }],
+      "default": {}
+    },
+    "definitions": {
+      "type": "object",
+      "additionalProperties": { "$ref": "#" },
+      "default": {}
+    },
+    "properties": {
+      "type": "object",
+      "additionalProperties": { "$ref": "#" },
+      "default": {}
+    },
+    "patternProperties": {
+      "type": "object",
+      "additionalProperties": { "$ref": "#" },
+      "default": {}
+    },
+    "dependencies": {
+      "type": "object",
+      "additionalProperties": {
+        "anyOf": [{ "$ref": "#" }, { "$ref": "#/definitions/stringArray" }]
+      }
+    },
+    "enum": {
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true
+    },
+    "type": {
+      "anyOf": [
+        { "$ref": "#/definitions/simpleTypes" },
+        {
+          "type": "array",
+          "items": { "$ref": "#/definitions/simpleTypes" },
+          "minItems": 1,
+          "uniqueItems": true
+        }
+      ]
+    },
+    "format": { "type": "string" },
+    "allOf": { "$ref": "#/definitions/schemaArray" },
+    "anyOf": { "$ref": "#/definitions/schemaArray" },
+    "oneOf": { "$ref": "#/definitions/schemaArray" },
+    "not": { "$ref": "#" }
+  },
+  "dependencies": {
+    "exclusiveMaximum": ["maximum"],
+    "exclusiveMinimum": ["minimum"]
+  },
+  "default": {}
+}