@forge/manifest 3.2.0-next.4 → 3.2.0

package/out/schema/manifest.d.ts

@@ -115,6 +115,15 @@ export interface App {
   runtime?: Runtime;
   licensing?: Licensing;
   connect?: Connect;
+  /**
+   * Options related to hosted storage
+   */
+  storage?: {
+    /**
+     * Labels to classify the type of data stored
+     */
+    classifications: ['ugc' | 'pii' | 'other', ...('ugc' | 'pii' | 'other')[]];
+  };
 }
 /**
  * Options related to the Forge Javascript runtime.
@@ -3036,7 +3045,7 @@ export interface Modules {
       fullPage?: boolean;
       cacheable?: boolean;
       location?: string;
-      conditions?: (SingleCondition | CompositeCondition)[];
+      conditions?: (CompositeCondition | SingleCondition)[];
       params?: {
         [k: string]: unknown;
       };
@@ -3051,7 +3060,7 @@ export interface Modules {
       fullPage?: boolean;
       cacheable?: boolean;
       location?: string;
-      conditions?: (SingleCondition | CompositeCondition)[];
+      conditions?: (CompositeCondition | SingleCondition)[];
       params?: {
         [k: string]: unknown;
       };
@@ -3099,7 +3108,7 @@ export interface Modules {
       filter?: string;
       excludeBody?: boolean;
       event?: string;
-      conditions?: (SingleCondition | CompositeCondition)[];
+      conditions?: (CompositeCondition | SingleCondition)[];
       propertyKeys?: string[];
       url?: string;
       key: ModuleKeySchema;
@@ -3109,7 +3118,7 @@ export interface Modules {
       filter?: string;
       excludeBody?: boolean;
       event?: string;
-      conditions?: (SingleCondition | CompositeCondition)[];
+      conditions?: (CompositeCondition | SingleCondition)[];
       propertyKeys?: string[];
       url?: string;
       key: ModuleKeySchema;
@@ -3248,7 +3257,7 @@ export interface Modules {
       fullPage?: boolean;
       cacheable?: boolean;
       location?: string;
-      conditions?: (SingleCondition | CompositeCondition)[];
+      conditions?: (CompositeCondition | SingleCondition)[];
       params?: {
         [k: string]: unknown;
       };
@@ -3263,7 +3272,7 @@ export interface Modules {
       fullPage?: boolean;
       cacheable?: boolean;
       location?: string;
-      conditions?: (SingleCondition | CompositeCondition)[];
+      conditions?: (CompositeCondition | SingleCondition)[];
       params?: {
         [k: string]: unknown;
       };
@@ -3313,7 +3322,7 @@ export interface Modules {
       name?: I18NProperty63;
       weight?: number;
       location?: string;
-      conditions?: (SingleCondition5 | CompositeCondition7)[];
+      conditions?: (CompositeCondition7 | SingleCondition5)[];
       params?: {
         [k: string]: unknown;
       };
@@ -3325,7 +3334,7 @@ export interface Modules {
       name?: I18NProperty63;
       weight?: number;
       location?: string;
-      conditions?: (SingleCondition5 | CompositeCondition7)[];
+      conditions?: (CompositeCondition7 | SingleCondition5)[];
       params?: {
         [k: string]: unknown;
       };
@@ -3756,7 +3765,7 @@ export interface I18NProperty1 {
  *
  */
 export interface CompositeCondition {
-  conditions?: (ManifestSchema | SingleCondition)[];
+  conditions?: (SingleCondition | ManifestSchema)[];
   type?: 'and' | 'AND' | 'or' | 'OR';
   [k: string]: unknown;
 }
@@ -6464,7 +6473,7 @@ export interface Icon10 {
  *
  */
 export interface WebItemTarget1 {
-  options?: InlineDialogOptions1 | DialogOptions2 | DialogModuleOptions1;
+  options?: InlineDialogOptions1 | DialogModuleOptions1 | DialogOptions2;
   type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
   [k: string]: unknown;
 }
@@ -6505,6 +6514,33 @@ export interface InlineDialogOptions1 {
   isRelativeToMouse?: boolean;
   [k: string]: unknown;
 }
+/**
+ *
+ *
+ * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
+ *
+ *  <h3>Example</h3>
+ *
+ *
+ *
+ *
+ *
+ *     {
+ *       "target": {
+ *         "type": "dialogmodule",
+ *         "options": {
+ *           "key": "dialog-module-key"
+ *         }
+ *       }
+ *     }
+ *
+ *
+ *
+ */
+export interface DialogModuleOptions1 {
+  key: string;
+  [k: string]: unknown;
+}
 /**
  *
  *
@@ -6603,33 +6639,6 @@ export interface I18NProperty58 {
   i18n?: string;
   [k: string]: unknown;
 }
-/**
- *
- *
- * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
- *
- *  <h3>Example</h3>
- *
- *
- *
- *
- *
- *     {
- *       "target": {
- *         "type": "dialogmodule",
- *         "options": {
- *           "key": "dialog-module-key"
- *         }
- *       }
- *     }
- *
- *
- *
- */
-export interface DialogModuleOptions1 {
-  key: string;
-  [k: string]: unknown;
-}
 /**
  *
  *
@@ -6722,7 +6731,7 @@ export interface SingleCondition4 {
  *
  */
 export interface CompositeCondition6 {
-  conditions?: (SingleCondition | ManifestSchema)[];
+  conditions?: (ManifestSchema | SingleCondition)[];
   type?: 'and' | 'AND' | 'or' | 'OR';
   [k: string]: unknown;
 }
@@ -7080,37 +7089,6 @@ export interface I18NProperty63 {
   i18n?: string;
   [k: string]: unknown;
 }
-/**
- *
- *
- * Single Conditions are either provided by the host application. See the complete documentation of
- *  [Conditions](../../conditions/) for more information.
- *
- *  To invert a condition, add the attribute ``invert="true"`` to the condition element.
- *  This is useful where you want to show the section if a certain condition is not satisfied.
- *
- *  <h3>Example</h3>
- *
- *
- *
- *
- *
- *     {
- *       "condition": "user_is_logged_in",
- *       "invert": false
- *     }
- *
- *
- *
- */
-export interface SingleCondition5 {
-  condition: string;
-  invert?: boolean;
-  params?: {
-    [k: string]: unknown;
-  };
-  [k: string]: unknown;
-}
 /**
  *
  *
@@ -7148,10 +7126,41 @@ export interface SingleCondition5 {
  *
  */
 export interface CompositeCondition7 {
-  conditions?: (ManifestSchema | SingleCondition)[];
+  conditions?: (SingleCondition | ManifestSchema)[];
   type?: 'and' | 'AND' | 'or' | 'OR';
   [k: string]: unknown;
 }
+/**
+ *
+ *
+ * Single Conditions are either provided by the host application. See the complete documentation of
+ *  [Conditions](../../conditions/) for more information.
+ *
+ *  To invert a condition, add the attribute ``invert="true"`` to the condition element.
+ *  This is useful where you want to show the section if a certain condition is not satisfied.
+ *
+ *  <h3>Example</h3>
+ *
+ *
+ *
+ *
+ *
+ *     {
+ *       "condition": "user_is_logged_in",
+ *       "invert": false
+ *     }
+ *
+ *
+ *
+ */
+export interface SingleCondition5 {
+  condition: string;
+  invert?: boolean;
+  params?: {
+    [k: string]: unknown;
+  };
+  [k: string]: unknown;
+}
 /**
  *
  *
@@ -8571,7 +8580,7 @@ export interface I18NProperty74 {
  *
  */
 export interface MacroPropertyPanel {
-  controls?: (TextControl | ControlGroup | ToggleGroup | ButtonControl1)[];
+  controls?: (TextControl | ToggleGroup | ButtonControl | ControlGroup)[];
   cacheable?: boolean;
   url: string;
   [k: string]: unknown;
@@ -8607,7 +8616,7 @@ export interface TextControl {
 /**
  *
  *
- * Defines a ControlGroup which may appear in control extension points such as the property panel
+ * Defines a ToggleGroup which may appear in control extension points such as the property panel
  *
  *  <p><b>Example</b></p>
  *
@@ -8617,21 +8626,24 @@ export interface TextControl {
  *
  *     [
  *       {
- *         "type": "group",
+ *         "type": "togglegroup",
+ *         "macroParameter": "toggleGroupMacroParameter",
  *         "controls": [
  *           {
- *             "type": "button",
+ *             "type": "togglebutton",
+ *             "macroParameterValue": "macroParameterValue 0",
  *             "label": {
  *               "value": "My Custom Control 0"
  *             },
- *             "key": "my-custom-control-0"
+ *             "key": "my-custom-toggle-button-0"
  *           },
  *           {
- *             "type": "button",
+ *             "type": "togglebutton",
+ *             "macroParameterValue": "macroParameterValue 1",
  *             "label": {
  *               "value": "My Custom Control 1"
  *             },
- *             "key": "my-custom-control-1"
+ *             "key": "my-custom-toggle-button-1"
  *           }
  *         ]
  *       }
@@ -8640,15 +8652,16 @@ export interface TextControl {
  *
  *
  */
-export interface ControlGroup {
-  controls: ButtonControl[];
-  type: 'group' | 'GROUP';
+export interface ToggleGroup {
+  controls: ToggleButtonControl[];
+  macroParameter: string;
+  type: 'togglegroup' | 'TOGGLEGROUP';
   [k: string]: unknown;
 }
 /**
  *
  *
- * Defines a button which may appear in control extension points such as the property panel
+ * Defines a toggle button which appears inside a ToggleGroup
  *
  *  <p><b>Example</b></p>
  *
@@ -8657,19 +8670,21 @@ export interface ControlGroup {
  *
  *
  *     {
- *       "type": "button",
+ *       "type": "togglebutton",
+ *       "macroParameterValue": "macroParameterValue 0",
  *       "label": {
  *         "value": "My Custom Control 0"
  *       },
- *       "key": "my-custom-control-0"
+ *       "key": "my-custom-toggle-button-0"
  *     }
  *
  *
  *
  */
-export interface ButtonControl {
+export interface ToggleButtonControl {
+  macroParameterValue: string;
   label: I18NProperty75;
-  type: 'button' | 'BUTTON';
+  type: 'togglebutton' | 'TOGGLEBUTTON';
   key: string;
   [k: string]: unknown;
 }
@@ -8700,7 +8715,7 @@ export interface I18NProperty75 {
 /**
  *
  *
- * Defines a ToggleGroup which may appear in control extension points such as the property panel
+ * Defines a button which may appear in control extension points such as the property panel
  *
  *  <p><b>Example</b></p>
  *
@@ -8708,92 +8723,86 @@ export interface I18NProperty75 {
  *
  *
  *
- *     [
- *       {
- *         "type": "togglegroup",
- *         "macroParameter": "toggleGroupMacroParameter",
- *         "controls": [
- *           {
- *             "type": "togglebutton",
- *             "macroParameterValue": "macroParameterValue 0",
- *             "label": {
- *               "value": "My Custom Control 0"
- *             },
- *             "key": "my-custom-toggle-button-0"
- *           },
- *           {
- *             "type": "togglebutton",
- *             "macroParameterValue": "macroParameterValue 1",
- *             "label": {
- *               "value": "My Custom Control 1"
- *             },
- *             "key": "my-custom-toggle-button-1"
- *           }
- *         ]
- *       }
- *     ]
+ *     {
+ *       "type": "button",
+ *       "label": {
+ *         "value": "My Custom Control 0"
+ *       },
+ *       "key": "my-custom-control-0"
+ *     }
  *
  *
  *
  */
-export interface ToggleGroup {
-  controls: ToggleButtonControl[];
-  macroParameter: string;
-  type: 'togglegroup' | 'TOGGLEGROUP';
+export interface ButtonControl {
+  label: I18NProperty76;
+  type: 'button' | 'BUTTON';
+  key: string;
   [k: string]: unknown;
 }
 /**
  *
  *
- * Defines a toggle button which appears inside a ToggleGroup
+ * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
+ *  and value in multiple places if you like, but identical keys must have identical values.
  *
- *  <p><b>Example</b></p>
+ *  <h3>Example</h3>
  *
  *
  *
  *
  *
  *     {
- *       "type": "togglebutton",
- *       "macroParameterValue": "macroParameterValue 0",
- *       "label": {
- *         "value": "My Custom Control 0"
- *       },
- *       "key": "my-custom-toggle-button-0"
+ *       "value": "My text"
  *     }
  *
  *
  *
  */
-export interface ToggleButtonControl {
-  macroParameterValue: string;
-  label: I18NProperty76;
-  type: 'togglebutton' | 'TOGGLEBUTTON';
-  key: string;
+export interface I18NProperty76 {
+  value: string;
+  i18n?: string;
   [k: string]: unknown;
 }
 /**
  *
  *
- * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
- *  and value in multiple places if you like, but identical keys must have identical values.
+ * Defines a ControlGroup which may appear in control extension points such as the property panel
  *
- *  <h3>Example</h3>
+ *  <p><b>Example</b></p>
  *
  *
  *
  *
  *
- *     {
- *       "value": "My text"
- *     }
+ *     [
+ *       {
+ *         "type": "group",
+ *         "controls": [
+ *           {
+ *             "type": "button",
+ *             "label": {
+ *               "value": "My Custom Control 0"
+ *             },
+ *             "key": "my-custom-control-0"
+ *           },
+ *           {
+ *             "type": "button",
+ *             "label": {
+ *               "value": "My Custom Control 1"
+ *             },
+ *             "key": "my-custom-control-1"
+ *           }
+ *         ]
+ *       }
+ *     ]
  *
  *
  *
  */
-export interface I18NProperty76 {
-  value: string;
-  i18n?: string;
+export interface ControlGroup {
+  controls: ButtonControl1[];
+  type: 'group' | 'GROUP';
   [k: string]: unknown;
 }
 /**
@@ -29816,39 +29825,11 @@ export interface I18NProperty83 {
  *
  */
 export interface MacroPropertyPanel1 {
-  controls?: (TextControl1 | ToggleGroup1 | ControlGroup1 | ButtonControl3)[];
+  controls?: (ToggleGroup1 | TextControl1 | ButtonControl2 | ControlGroup1)[];
   cacheable?: boolean;
   url: string;
   [k: string]: unknown;
 }
-/**
- *
- *
- * Defines a text field which may appear in control extension points such as the property panel
- *
- *  <p><b>Example</b></p>
- *
- *
- *
- *
- *
- *     {
- *       "type": "button",
- *       "label": {
- *         "value": "My Custom Control 0"
- *       },
- *       "key": "my-custom-control-0"
- *     }
- *
- *
- *
- */
-export interface TextControl1 {
-  macroParameter: string;
-  type: 'text' | 'TEXT';
-  key: string;
-  [k: string]: unknown;
-}
 /**
  *
  *
@@ -29951,7 +29932,7 @@ export interface I18NProperty84 {
 /**
  *
  *
- * Defines a ControlGroup which may appear in control extension points such as the property panel
+ * Defines a text field which may appear in control extension points such as the property panel
  *
  *  <p><b>Example</b></p>
  *
@@ -29959,34 +29940,21 @@ export interface I18NProperty84 {
  *
  *
  *
- *     [
- *       {
- *         "type": "group",
- *         "controls": [
- *           {
- *             "type": "button",
- *             "label": {
- *               "value": "My Custom Control 0"
- *             },
- *             "key": "my-custom-control-0"
- *           },
- *           {
- *             "type": "button",
- *             "label": {
- *               "value": "My Custom Control 1"
- *             },
- *             "key": "my-custom-control-1"
- *           }
- *         ]
- *       }
- *     ]
+ *     {
+ *       "type": "button",
+ *       "label": {
+ *         "value": "My Custom Control 0"
+ *       },
+ *       "key": "my-custom-control-0"
+ *     }
  *
  *
  *
  */
-export interface ControlGroup1 {
-  controls: ButtonControl2[];
-  type: 'group' | 'GROUP';
+export interface TextControl1 {
+  macroParameter: string;
+  type: 'text' | 'TEXT';
+  key: string;
   [k: string]: unknown;
 }
 /**
@@ -30041,6 +30009,47 @@ export interface I18NProperty85 {
   i18n?: string;
   [k: string]: unknown;
 }
+/**
+ *
+ *
+ * Defines a ControlGroup which may appear in control extension points such as the property panel
+ *
+ *  <p><b>Example</b></p>
+ *
+ *
+ *
+ *
+ *
+ *     [
+ *       {
+ *         "type": "group",
+ *         "controls": [
+ *           {
+ *             "type": "button",
+ *             "label": {
+ *               "value": "My Custom Control 0"
+ *             },
+ *             "key": "my-custom-control-0"
+ *           },
+ *           {
+ *             "type": "button",
+ *             "label": {
+ *               "value": "My Custom Control 1"
+ *             },
+ *             "key": "my-custom-control-1"
+ *           }
+ *         ]
+ *       }
+ *     ]
+ *
+ *
+ *
+ */
+export interface ControlGroup1 {
+  controls: ButtonControl3[];
+  type: 'group' | 'GROUP';
+  [k: string]: unknown;
+}
 /**
  *
  *
@@ -50942,7 +50951,7 @@ export interface I18NProperty91 {
  *
  */
 export interface WebItemTarget2 {
-  options?: DialogOptions4 | InlineDialogOptions2 | DialogModuleOptions2;
+  options?: DialogOptions4 | DialogModuleOptions2 | InlineDialogOptions2;
   type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
   [k: string]: unknown;
 }
@@ -51047,7 +51056,7 @@ export interface I18NProperty92 {
 /**
  *
  *
- * Options for an inline dialog target
+ * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
  *
  *  <h3>Example</h3>
  *
@@ -51057,11 +51066,9 @@ export interface I18NProperty92 {
  *
  *     {
  *       "target": {
- *         "type": "inlinedialog",
+ *         "type": "dialogmodule",
  *         "options": {
- *           "onHover": true,
- *           "offsetX": "30px",
- *           "offsetY": "20px"
+ *           "key": "dialog-module-key"
  *         }
  *       }
  *     }
@@ -51069,22 +51076,14 @@ export interface I18NProperty92 {
  *
  *
  */
-export interface InlineDialogOptions2 {
-  offsetX?: string;
-  offsetY?: string;
-  width?: string;
-  onTop?: boolean;
-  showDelay?: number;
-  closeOthers?: boolean;
-  persistent?: boolean;
-  onHover?: boolean;
-  isRelativeToMouse?: boolean;
+export interface DialogModuleOptions2 {
+  key: string;
   [k: string]: unknown;
 }
 /**
  *
  *
- * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
+ * Options for an inline dialog target
  *
  *  <h3>Example</h3>
  *
@@ -51094,9 +51093,11 @@ export interface InlineDialogOptions2 {
  *
  *     {
  *       "target": {
- *         "type": "dialogmodule",
+ *         "type": "inlinedialog",
  *         "options": {
- *           "key": "dialog-module-key"
+ *           "onHover": true,
+ *           "offsetX": "30px",
+ *           "offsetY": "20px"
  *         }
  *       }
  *     }
@@ -51104,8 +51105,16 @@ export interface InlineDialogOptions2 {
  *
  *
  */
-export interface DialogModuleOptions2 {
-  key: string;
+export interface InlineDialogOptions2 {
+  offsetX?: string;
+  offsetY?: string;
+  width?: string;
+  onTop?: boolean;
+  showDelay?: number;
+  closeOthers?: boolean;
+  persistent?: boolean;
+  onHover?: boolean;
+  isRelativeToMouse?: boolean;
   [k: string]: unknown;
 }
 /**
@@ -51916,6 +51925,19 @@ export interface RemotesSchema {
    */
   key: string;
   baseUrl: string;
+  /**
+   * The type of operations done in the remote
+   */
+  operations?: ['storage' | 'other', ...('storage' | 'other')[]];
+  /**
+   * Options related to remote storage
+   */
+  storage?: {
+    /**
+     * Labels to classify the type of data stored
+     */
+    classifications: ['ugc' | 'pii' | 'other', ...('ugc' | 'pii' | 'other')[]];
+  };
 }
 export interface Providers {
   auth: Auth;