@forge/dashboards-bridge 2.0.2-next.1 → 2.0.2

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 (6) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/out/widgets/index.d.ts +1 -1
  3. package/out/widgets/index.d.ts.map +1 -1
  4. package/out/widgets/types.d.ts +38 -8
  5. package/out/widgets/types.d.ts.map +1 -1
  6. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # @forge/dashboards-bridge
2
2
 
3
+ ## 2.0.2
4
+
5
+ ### Patch Changes
6
+
7
+ - 9b09d60: Update migration types
8
+ - 3454106: Added draft support for dashboard module migration declarations and transformer types.
9
+ - Updated dependencies [5a91774]
10
+ - Updated dependencies [8b9c106]
11
+ - Updated dependencies [dfa6f4a]
12
+ - @forge/bridge@7.2.1
13
+
14
+ ## 2.0.2-next.2
15
+
16
+ ### Patch Changes
17
+
18
+ - 9b09d60: Update migration types
19
+
3
20
  ## 2.0.2-next.1
4
21
 
5
22
  ### Patch Changes
package/out/widgets/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
1
  export { widgetEdit } from './edit';
2
2
  export { widget } from './view';
3
- export type { WidgetConfig, Layout, WidgetContext, WidgetPlacement, FilterDimension, FilterExpression, AppStoredFilter, AvpStoredFilter, Filter, FilterGroup, OnSave, OnProductSave, OnSaveError, GadgetConfiguration, DashboardMigrationPayload, DashboardMigrationTransformer, ForgeAiContextCell, ForgeAiContextColumn, ForgeAiContextRow, ForgeAiContextResponse } from './types';
3
+ export type { WidgetConfig, Layout, WidgetContext, WidgetPlacement, FilterDimension, FilterExpression, AppStoredFilter, AvpStoredFilter, Filter, FilterGroup, OnSave, OnProductSave, OnSaveError, GadgetPosition, UserPreference, DashboardItemProperties, DashboardMigrationPayload, DashboardMigrationTransformer, ForgeAiContextCell, ForgeAiContextColumn, ForgeAiContextRow, ForgeAiContextResponse } from './types';
4
4
  //# sourceMappingURL=index.d.ts.map
package/out/widgets/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/widgets/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,YAAY,EACV,YAAY,EACZ,MAAM,EACN,aAAa,EACb,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,MAAM,EACN,WAAW,EACX,MAAM,EACN,aAAa,EACb,WAAW,EACX,mBAAmB,EACnB,yBAAyB,EACzB,6BAA6B,EAC7B,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/widgets/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,YAAY,EACV,YAAY,EACZ,MAAM,EACN,aAAa,EACb,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,MAAM,EACN,WAAW,EACX,MAAM,EACN,aAAa,EACb,WAAW,EACX,cAAc,EACd,cAAc,EACd,uBAAuB,EACvB,yBAAyB,EACzB,6BAA6B,EAC7B,kBAAkB,EAClB,oBAAoB,EACpB,iBAAiB,EACjB,sBAAsB,EACvB,MAAM,SAAS,CAAC"}
package/out/widgets/types.d.ts CHANGED
@@ -41,15 +41,45 @@ export type OnSave = (config: WidgetConfig, widgetContext: Omit<WidgetContext, '
41
41
  export type OnSaveBridge = (config: WidgetConfig, widgetId: string, context: Context) => Promise<void>;
42
42
  export type OnProductSave = (config: WidgetConfig, widgetContext: WidgetContext, context: Context) => Promise<WidgetConfig | null | undefined>;
43
43
  export type OnProductSaveBridge = (config: WidgetConfig) => Promise<WidgetConfig | null | undefined>;
44
- export type GadgetConfiguration = Record<string, string | boolean | number>;
45
- export type DashboardMigrationPayload<GadgetConfig extends GadgetConfiguration = GadgetConfiguration> = {
46
- dashboardId: string;
47
- gadgets: {
48
- gadgetId: string;
49
- gadgetConfiguration?: GadgetConfig;
50
- }[];
44
+ export type DashboardItemProperties = Record<string, string | boolean | number>;
45
+ export type UserPreference = {
46
+ name: string;
47
+ value: string;
48
+ type: string;
49
+ required: boolean;
50
+ displayName?: string;
51
+ options: string[];
52
+ };
53
+ export type GadgetPosition = {
54
+ layout: string;
55
+ column: number;
56
+ row: number;
57
+ width: number;
58
+ height: number;
59
+ };
60
+ export type DashboardMigrationPayload = {
61
+ tenant: {
62
+ cloudId: string;
63
+ activationId: string;
64
+ };
65
+ source: {
66
+ dashboardId: string;
67
+ gadget: {
68
+ id: string;
69
+ forgeExtensionId: string;
70
+ gadgetConfiguration: UserPreference[] | null;
71
+ position: GadgetPosition;
72
+ };
73
+ dashboardItem: {
74
+ id: string;
75
+ properties: DashboardItemProperties;
76
+ };
77
+ };
78
+ target: {
79
+ widgetExtensionId: string;
80
+ };
51
81
  };
52
- export type DashboardMigrationTransformer<GadgetConfig extends GadgetConfiguration = GadgetConfiguration> = (payload: DashboardMigrationPayload<GadgetConfig>) => WidgetConfig | Promise<WidgetConfig | void> | void;
82
+ export type DashboardMigrationTransformer = (payload: DashboardMigrationPayload) => WidgetConfig | Promise<WidgetConfig | void> | void;
53
83
  export type OnSaveError = (error: Error, widgetContext: WidgetContext, context: Context) => void;
54
84
  export type OnSaveErrorBridge = (error: Error) => void;
55
85
  export type ForgeAiContextCell = string | number | boolean | null;
package/out/widgets/types.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/widgets/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEnD,MAAM,MAAM,MAAM,GAAG;IAInB,KAAK,EAAE,MAAM,CAAC;IAId,MAAM,EAAE,MAAM,CAAC;IAIf,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;IAIlD,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;CACjC,CAAC;AAKF,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,MAAM,CAAC;AAEpD,MAAM,MAAM,WAAW,GAAG;IAIxB,EAAE,EAAE,MAAM,CAAC;IAIX,QAAQ,EAAE,KAAK,GAAG,IAAI,CAAC;IAIvB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B,CAAC;AAEF,KAAK,gBAAgB,GAAG;IAItB,EAAE,EAAE,MAAM,CAAC;IAIX,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG;IAI/C,UAAU,EAAE,MAAM,CAAC;IAInB,aAAa,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAIpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAIlB,UAAU,EAAE,eAAe,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,gBAAgB,CAAC;AAE/C,MAAM,MAAM,MAAM,GAAG,eAAe,GAAG,eAAe,CAAC;AAEvD,MAAM,MAAM,eAAe,GAAG;IAI5B,IAAI,EAAE,MAAM,CAAC;IAIb,OAAO,CAAC,EAAE,MAAM,CAAC;IAIjB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAI3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAK1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAIlB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAWF,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,aAAa,GAAG,eAAe,GAAG,gBAAgB,CAAC;AAEvH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE9C,MAAM,MAAM,MAAM,GAAG,CACnB,MAAM,EAAE,YAAY,EACpB,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,EACrE,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,IAAI,CAAC,CAAC;AACnB,MAAM,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvG,MAAM,MAAM,aAAa,GAAG,CAC1B,MAAM,EAAE,YAAY,EACpB,aAAa,EAAE,aAAa,EAC5B,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,YAAY,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;AAC9C,MAAM,MAAM,mBAAmB,GAAG,CAAC,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,YAAY,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;AAErG,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC,CAAC;AAE5E,MAAM,MAAM,yBAAyB,CAAC,YAAY,SAAS,mBAAmB,GAAG,mBAAmB,IAAI;IACtG,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,mBAAmB,CAAC,EAAE,YAAY,CAAA;KAAE,EAAE,CAAC;CACrE,CAAC;AAEF,MAAM,MAAM,6BAA6B,CAAC,YAAY,SAAS,mBAAmB,GAAG,mBAAmB,IAAI,CAC1G,OAAO,EAAE,yBAAyB,CAAC,YAAY,CAAC,KAC7C,YAAY,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;AAExD,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AACjG,MAAM,MAAM,iBAAiB,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;AAEvD,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAElE,MAAM,MAAM,oBAAoB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAAI;IAEpE,GAAG,EAAE,SAAS,CAAC;IAEf,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAC3D,kBAAkB,EAAE,GACpB,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC,CAAC;AAQnD,MAAM,MAAM,sBAAsB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAAI;IAEtE,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,CAAC,EAAE,MAAM,CAAC;IAKd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,KAAK,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,CAAC;IAChD,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;CAC3C,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/widgets/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEnD,MAAM,MAAM,MAAM,GAAG;IAInB,KAAK,EAAE,MAAM,CAAC;IAId,MAAM,EAAE,MAAM,CAAC;IAIf,OAAO,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;IAIlD,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;CACjC,CAAC;AAKF,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,MAAM,CAAC;AAEpD,MAAM,MAAM,WAAW,GAAG;IAIxB,EAAE,EAAE,MAAM,CAAC;IAIX,QAAQ,EAAE,KAAK,GAAG,IAAI,CAAC;IAIvB,MAAM,EAAE,gBAAgB,EAAE,CAAC;CAC5B,CAAC;AAEF,KAAK,gBAAgB,GAAG;IAItB,EAAE,EAAE,MAAM,CAAC;IAIX,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG;IAI/C,UAAU,EAAE,MAAM,CAAC;IAInB,aAAa,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAIpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAIlB,UAAU,EAAE,eAAe,EAAE,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,gBAAgB,CAAC;AAE/C,MAAM,MAAM,MAAM,GAAG,eAAe,GAAG,eAAe,CAAC;AAEvD,MAAM,MAAM,eAAe,GAAG;IAI5B,IAAI,EAAE,MAAM,CAAC;IAIb,OAAO,CAAC,EAAE,MAAM,CAAC;IAIjB,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAI3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAK1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAIlB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAWF,MAAM,MAAM,eAAe,GAAG,gBAAgB,GAAG,gBAAgB,GAAG,aAAa,GAAG,eAAe,GAAG,gBAAgB,CAAC;AAEvH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAE9C,MAAM,MAAM,MAAM,GAAG,CACnB,MAAM,EAAE,YAAY,EACpB,aAAa,EAAE,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,EACrE,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,IAAI,CAAC,CAAC;AACnB,MAAM,MAAM,YAAY,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvG,MAAM,MAAM,aAAa,GAAG,CAC1B,MAAM,EAAE,YAAY,EACpB,aAAa,EAAE,aAAa,EAC5B,OAAO,EAAE,OAAO,KACb,OAAO,CAAC,YAAY,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;AAC9C,MAAM,MAAM,mBAAmB,GAAG,CAAC,MAAM,EAAE,YAAY,KAAK,OAAO,CAAC,YAAY,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC;AAErG,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC,CAAC;AAEhF,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG;IACtC,MAAM,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,MAAM,EAAE;QACN,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE;YACN,EAAE,EAAE,MAAM,CAAC;YACX,gBAAgB,EAAE,MAAM,CAAC;YACzB,mBAAmB,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC;YAC7C,QAAQ,EAAE,cAAc,CAAC;SAC1B,CAAC;QACF,aAAa,EAAE;YACb,EAAE,EAAE,MAAM,CAAC;YACX,UAAU,EAAE,uBAAuB,CAAC;SACrC,CAAC;KACH,CAAC;IACF,MAAM,EAAE;QACN,iBAAiB,EAAE,MAAM,CAAC;KAC3B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG,CAC1C,OAAO,EAAE,yBAAyB,KAC/B,YAAY,GAAG,OAAO,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;AAExD,MAAM,MAAM,WAAW,GAAG,CAAC,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;AACjG,MAAM,MAAM,iBAAiB,GAAG,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;AAEvD,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;AAElE,MAAM,MAAM,oBAAoB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAAI;IAEpE,GAAG,EAAE,SAAS,CAAC;IAEf,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAC3D,kBAAkB,EAAE,GACpB,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC,CAAC;AAQnD,MAAM,MAAM,sBAAsB,CAAC,SAAS,SAAS,MAAM,GAAG,MAAM,IAAI;IAEtE,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,CAAC,EAAE,MAAM,CAAC;IAKd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,KAAK,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,CAAC;IAChD,IAAI,EAAE,KAAK,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAC;CAC3C,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forge/dashboards-bridge",
3
- "version": "2.0.2-next.1",
3
+ "version": "2.0.2",
4
4
  "description": "Forge Dashboards custom bridge API",
5
5
  "author": "Atlassian",
6
6
  "license": "SEE LICENSE IN LICENSE.txt",
@@ -15,7 +15,7 @@
15
15
  "registry": "https://packages.atlassian.com/api/npm/npm-public/"
16
16
  },
17
17
  "dependencies": {
18
- "@forge/bridge": "^7.2.1-next.2"
18
+ "@forge/bridge": "^7.2.1"
19
19
  },
20
20
  "peerDependencies": {
21
21
  "typescript": ">=5.0.0"