@forge/manifest 10.2.1-next.1 → 10.2.2-next.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.
Files changed (5) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/out/schema/manifest-schema.json +141 -26
  3. package/out/schema/manifest.d.ts +84 -22
  4. package/out/scopes/shipyard-scopes.json +6 -3
  5. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @forge/manifest
2
2
 
3
+ ## 10.2.2-next.0
4
+
5
+ ### Patch Changes
6
+
7
+ - a614f0b: Update manifest definitions
8
+
9
+ ## 10.2.1
10
+
11
+ ### Patch Changes
12
+
13
+ - 10c0bc6: Add egress support for custom URL schemes. Allow custom custom URL schemes as autoconvert patterns.
14
+ - 6447811: Update manifest definitions
15
+ - 2f446cf: Update manifest definitions
16
+
3
17
  ## 10.2.1-next.1
4
18
 
5
19
  ### Patch Changes
package/out/schema/manifest-schema.json CHANGED
@@ -27087,9 +27087,9 @@
27087
27087
  "dark"
27088
27088
  ]
27089
27089
  },
27090
- "entityTypes": {
27090
+ "objectTypes": {
27091
27091
  "type": "array",
27092
- "description": "Entities that the connector can provide.",
27092
+ "description": "Objects that the connector can provide.",
27093
27093
  "minItems": 1,
27094
27094
  "items": {
27095
27095
  "type": "string",
@@ -27121,44 +27121,101 @@
27121
27121
  "maxLength": 255
27122
27122
  }
27123
27123
  },
27124
- "validateConnection": {
27124
+ "orchestration": {
27125
27125
  "type": "object",
27126
27126
  "properties": {
27127
- "function": {
27128
- "$ref": "#/definitions/ExtensionKey",
27129
- "description": "The key of the function that should be invoked on connection creation to validate configuration.",
27130
- "title": "validateConnection"
27127
+ "taskRunner": {
27128
+ "type": "object",
27129
+ "properties": {
27130
+ "function": {
27131
+ "$ref": "#/definitions/ExtensionKey",
27132
+ "description": "The key of the function that the Orchestrator will invoke to execute a Task. When using Task Management.",
27133
+ "title": "taskRunner"
27134
+ }
27135
+ },
27136
+ "required": [
27137
+ "function"
27138
+ ],
27139
+ "additionalProperties": false
27131
27140
  }
27132
27141
  },
27133
27142
  "required": [
27134
- "function"
27135
- ]
27143
+ "taskRunner"
27144
+ ],
27145
+ "additionalProperties": false
27136
27146
  },
27137
- "onConnectionChange": {
27147
+ "auth": {
27138
27148
  "type": "object",
27139
27149
  "properties": {
27140
- "function": {
27141
- "$ref": "#/definitions/ExtensionKey",
27142
- "description": "The key of the function that should be invoked on connection change (Created, updated, deleted).",
27143
- "title": "onConnectionChange"
27150
+ "provider": {
27151
+ "$ref": "#/definitions/ExternalAuthProvider",
27152
+ "description": "A key referencing authentication provider. This will be utilised to authenticate end-users and match with external users.",
27153
+ "title": "User Auth Provider"
27144
27154
  }
27145
27155
  },
27146
- "required": [
27147
- "function"
27148
- ]
27156
+ "additionalProperties": false
27149
27157
  },
27150
- "taskRunner": {
27158
+ "datasource": {
27151
27159
  "type": "object",
27152
27160
  "properties": {
27153
- "function": {
27154
- "$ref": "#/definitions/ExtensionKey",
27155
- "description": "The key of the function that the Orchestrator will invoke to execute a Task. When using Task Management.",
27156
- "title": "taskRunner"
27161
+ "formConfiguration": {
27162
+ "type": "object",
27163
+ "properties": {
27164
+ "properties": {
27165
+ "type": "array",
27166
+ "minItems": 1,
27167
+ "items": {
27168
+ "$ref": "#/definitions/ConnectionProperty"
27169
+ }
27170
+ },
27171
+ "validateConnection": {
27172
+ "type": "object",
27173
+ "properties": {
27174
+ "function": {
27175
+ "$ref": "#/definitions/ExtensionKey",
27176
+ "description": "The key of the function that should be invoked on connection creation to validate configuration captured in the form.",
27177
+ "title": "validateConnection"
27178
+ }
27179
+ },
27180
+ "required": [
27181
+ "function"
27182
+ ]
27183
+ },
27184
+ "getFormData": {
27185
+ "type": "object",
27186
+ "properties": {
27187
+ "function": {
27188
+ "$ref": "#/definitions/ExtensionKey",
27189
+ "description": "If the form has drop-down boxes this function is called to provide the values dynamically.",
27190
+ "title": "getFormData"
27191
+ }
27192
+ },
27193
+ "required": [
27194
+ "function"
27195
+ ]
27196
+ }
27197
+ },
27198
+ "additionalProperties": false,
27199
+ "required": [
27200
+ "properties",
27201
+ "validateConnection"
27202
+ ]
27203
+ },
27204
+ "onConnectionChange": {
27205
+ "type": "object",
27206
+ "properties": {
27207
+ "function": {
27208
+ "$ref": "#/definitions/ExtensionKey",
27209
+ "description": "The key of the function that should be invoked on connection change (Created, updated, deleted).",
27210
+ "title": "onConnectionChange"
27211
+ }
27212
+ },
27213
+ "required": [
27214
+ "function"
27215
+ ]
27157
27216
  }
27158
27217
  },
27159
- "required": [
27160
- "function"
27161
- ]
27218
+ "additionalProperties": false
27162
27219
  },
27163
27220
  "key": {
27164
27221
  "$ref": "#/definitions/ModuleKeySchema"
@@ -27167,7 +27224,7 @@
27167
27224
  "required": [
27168
27225
  "name",
27169
27226
  "icons",
27170
- "entityTypes",
27227
+ "objectTypes",
27171
27228
  "key"
27172
27229
  ],
27173
27230
  "additionalProperties": false,
@@ -31118,6 +31175,64 @@
31118
31175
  "type": "object",
31119
31176
  "title": "Body",
31120
31177
  "description": "\n\n<p>\n Defines styles to be applied on the body of content view.\n </p>\n <p>\n The supported properties include <i>background</i> shorthand property and all CSS background element properties.\n The keys are the camelCased versions of corresponding CSS properties, like <i>backgroundImage</i>,\n <i>backgroundColor</i>, <i>backgroundSize</i>, <i>backgroundPosition</i>, <i>backgroundRepeat</i>,\n <i>backgroundClip</i>, <i>backgroundOrigin</i>, <i>backgroundAttachment</i>, and <i>backgroundBlendMode</i>.\n </p>\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"padding\": \"10px\",\n \"borderRadius\": \"0 0 5px 5px\",\n \"background\": \"#FFFFFF\"\n }\n\n\n"
31178
+ },
31179
+ "ExternalAuthProvider": {
31180
+ "type": "string",
31181
+ "description": "A key referencing authentication provider. This will be utilised to authenticate end-users and match with external users.",
31182
+ "maxLength": 255,
31183
+ "minLength": 1,
31184
+ "pattern": "^[a-zA-Z0-9-._]+$"
31185
+ },
31186
+ "ConnectionProperty": {
31187
+ "type": "object",
31188
+ "properties": {
31189
+ "key": {
31190
+ "type": "string",
31191
+ "description": "The key identifying the connection property."
31192
+ },
31193
+ "label": {
31194
+ "type": "object",
31195
+ "properties": {
31196
+ "defaultMessage": {
31197
+ "type": "string",
31198
+ "description": "The default message for the field label."
31199
+ },
31200
+ "description": {
31201
+ "type": "string",
31202
+ "description": "A description of the field label."
31203
+ }
31204
+ },
31205
+ "required": [
31206
+ "defaultMessage",
31207
+ "description"
31208
+ ],
31209
+ "additionalProperties": false
31210
+ },
31211
+ "type": {
31212
+ "type": "string",
31213
+ "enum": [
31214
+ "string",
31215
+ "number",
31216
+ "boolean",
31217
+ "textArea"
31218
+ ],
31219
+ "description": "The type of the connection property."
31220
+ },
31221
+ "isRequired": {
31222
+ "type": "boolean",
31223
+ "description": "Whether the property is required. (default: false)"
31224
+ },
31225
+ "isSensitive": {
31226
+ "type": "boolean",
31227
+ "description": "Whether the property is sensitive. (default: false)"
31228
+ }
31229
+ },
31230
+ "required": [
31231
+ "key",
31232
+ "label",
31233
+ "type"
31234
+ ],
31235
+ "additionalProperties": false
31121
31236
  }
31122
31237
  },
31123
31238
  "additionalProperties": false,
package/out/schema/manifest.d.ts CHANGED
@@ -680,6 +680,10 @@ export type Patterns =
680
680
  * The key for an extension in CaaS. That means that this is a reference to another extension in your descriptor / manifest.
681
681
  */
682
682
  export type ExtensionKey10 = string;
683
+ /**
684
+ * A key referencing authentication provider. This will be utilised to authenticate end-users and match with external users.
685
+ */
686
+ export type UserAuthProvider = string;
683
687
  /**
684
688
  * The key for an extension in CaaS. That means that this is a reference to another extension in your descriptor / manifest.
685
689
  */
@@ -688,6 +692,10 @@ export type ExtensionKey11 = string;
688
692
  * The key for an extension in CaaS. That means that this is a reference to another extension in your descriptor / manifest.
689
693
  */
690
694
  export type ExtensionKey12 = string;
695
+ /**
696
+ * The key for an extension in CaaS. That means that this is a reference to another extension in your descriptor / manifest.
697
+ */
698
+ export type ExtensionKey13 = string;
691
699
  export type Scopes =
692
700
  | string[]
693
701
  | {
@@ -23261,9 +23269,9 @@ export interface Modules {
23261
23269
  [k: string]: unknown;
23262
23270
  };
23263
23271
  /**
23264
- * Entities that the connector can provide.
23272
+ * Objects that the connector can provide.
23265
23273
  */
23266
- entityTypes: [
23274
+ objectTypes: [
23267
23275
  (
23268
23276
  | 'atlassian:document'
23269
23277
  | 'atlassian:branch'
@@ -23313,17 +23321,30 @@ export interface Modules {
23313
23321
  | 'atlassian:worker'
23314
23322
  )[]
23315
23323
  ];
23316
- validateConnection?: {
23317
- function: ExtensionKey10;
23318
- [k: string]: unknown;
23324
+ orchestration?: {
23325
+ taskRunner: {
23326
+ function: ExtensionKey10;
23327
+ };
23319
23328
  };
23320
- onConnectionChange?: {
23321
- function: ExtensionKey11;
23322
- [k: string]: unknown;
23329
+ auth?: {
23330
+ provider?: UserAuthProvider;
23323
23331
  };
23324
- taskRunner?: {
23325
- function: ExtensionKey12;
23326
- [k: string]: unknown;
23332
+ datasource?: {
23333
+ formConfiguration?: {
23334
+ properties: [ConnectionProperty, ...ConnectionProperty[]];
23335
+ validateConnection: {
23336
+ function: ExtensionKey11;
23337
+ [k: string]: unknown;
23338
+ };
23339
+ getFormData?: {
23340
+ function: ExtensionKey12;
23341
+ [k: string]: unknown;
23342
+ };
23343
+ };
23344
+ onConnectionChange?: {
23345
+ function: ExtensionKey13;
23346
+ [k: string]: unknown;
23347
+ };
23327
23348
  };
23328
23349
  key: ModuleKeySchema;
23329
23350
  },
@@ -23344,9 +23365,9 @@ export interface Modules {
23344
23365
  [k: string]: unknown;
23345
23366
  };
23346
23367
  /**
23347
- * Entities that the connector can provide.
23368
+ * Objects that the connector can provide.
23348
23369
  */
23349
- entityTypes: [
23370
+ objectTypes: [
23350
23371
  (
23351
23372
  | 'atlassian:document'
23352
23373
  | 'atlassian:branch'
@@ -23396,17 +23417,30 @@ export interface Modules {
23396
23417
  | 'atlassian:worker'
23397
23418
  )[]
23398
23419
  ];
23399
- validateConnection?: {
23400
- function: ExtensionKey10;
23401
- [k: string]: unknown;
23420
+ orchestration?: {
23421
+ taskRunner: {
23422
+ function: ExtensionKey10;
23423
+ };
23402
23424
  };
23403
- onConnectionChange?: {
23404
- function: ExtensionKey11;
23405
- [k: string]: unknown;
23425
+ auth?: {
23426
+ provider?: UserAuthProvider;
23406
23427
  };
23407
- taskRunner?: {
23408
- function: ExtensionKey12;
23409
- [k: string]: unknown;
23428
+ datasource?: {
23429
+ formConfiguration?: {
23430
+ properties: [ConnectionProperty, ...ConnectionProperty[]];
23431
+ validateConnection: {
23432
+ function: ExtensionKey11;
23433
+ [k: string]: unknown;
23434
+ };
23435
+ getFormData?: {
23436
+ function: ExtensionKey12;
23437
+ [k: string]: unknown;
23438
+ };
23439
+ };
23440
+ onConnectionChange?: {
23441
+ function: ExtensionKey13;
23442
+ [k: string]: unknown;
23443
+ };
23410
23444
  };
23411
23445
  key: ModuleKeySchema;
23412
23446
  }[]
@@ -72582,6 +72616,34 @@ export interface I18NProperty105 {
72582
72616
  i18n?: string;
72583
72617
  [k: string]: unknown;
72584
72618
  }
72619
+ export interface ConnectionProperty {
72620
+ /**
72621
+ * The key identifying the connection property.
72622
+ */
72623
+ key: string;
72624
+ label: {
72625
+ /**
72626
+ * The default message for the field label.
72627
+ */
72628
+ defaultMessage: string;
72629
+ /**
72630
+ * A description of the field label.
72631
+ */
72632
+ description: string;
72633
+ };
72634
+ /**
72635
+ * The type of the connection property.
72636
+ */
72637
+ type: 'string' | 'number' | 'boolean' | 'textArea';
72638
+ /**
72639
+ * Whether the property is required. (default: false)
72640
+ */
72641
+ isRequired?: boolean;
72642
+ /**
72643
+ * Whether the property is sensitive. (default: false)
72644
+ */
72645
+ isSensitive?: boolean;
72646
+ }
72585
72647
  export interface Permissions {
72586
72648
  scopes?: Scopes;
72587
72649
  content?: Content1;
package/out/scopes/shipyard-scopes.json CHANGED
@@ -45,7 +45,6 @@
45
45
  "delete:embed:confluence",
46
46
  "delete:entitlement:jira-service-management",
47
47
  "delete:entitlement.detail-field:jira-service-management",
48
- "delete:entity:graph",
49
48
  "delete:feature-flag-info:jira",
50
49
  "delete:field-configuration-scheme:jira",
51
50
  "delete:field-configuration:jira",
@@ -68,6 +67,8 @@
68
67
  "delete:issue.property:jira",
69
68
  "delete:issue.remote-link:jira",
70
69
  "delete:notes:customer-notes",
70
+ "delete:object:jira",
71
+ "delete:object:jira",
71
72
  "delete:operations-info:jira",
72
73
  "delete:ops-alert:jira-service-management",
73
74
  "delete:ops-config:jira-service-management",
@@ -200,7 +201,6 @@
200
201
  "read:entitlement.detail:jira-service-management",
201
202
  "read:entitlements:ccg",
202
203
  "read:entitlements:fsag",
203
- "read:entity:graph",
204
204
  "read:epic:jira-software",
205
205
  "read:event:compass",
206
206
  "read:feature-flag-info:jira",
@@ -266,6 +266,8 @@
266
266
  "read:metric:compass",
267
267
  "read:notes:customer-notes",
268
268
  "read:notification-scheme:jira",
269
+ "read:object:jira",
270
+ "read:object:jira",
269
271
  "read:operations-info:jira",
270
272
  "read:ops-alert:jira-service-management",
271
273
  "read:ops-config:jira-service-management",
@@ -425,7 +427,6 @@
425
427
  "write:entitlement:jira-service-management",
426
428
  "write:entitlement.detail-field:jira-service-management",
427
429
  "write:entitlement.detail:jira-service-management",
428
- "write:entity:graph",
429
430
  "write:epic:jira-software",
430
431
  "write:event:compass",
431
432
  "write:feature-flag-info:jira",
@@ -467,6 +468,8 @@
467
468
  "write:membership:teams",
468
469
  "write:metric:compass",
469
470
  "write:notes:customer-notes",
471
+ "write:object:jira",
472
+ "write:object:jira",
470
473
  "write:operations-info:jira",
471
474
  "write:ops-alert:jira-service-management",
472
475
  "write:ops-config:jira-service-management",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forge/manifest",
3
- "version": "10.2.1-next.1",
3
+ "version": "10.2.2-next.0",
4
4
  "description": "Definitions and validations of the Forge manifest",
5
5
  "main": "out/index.js",
6
6
  "scripts": {