@microsoft/teamsfx-react 3.0.0 → 3.0.1-alpha.09fb224aa.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.
@@ -47,11 +47,13 @@ export declare class BaseDashboard<P, S> extends Component<P, S & BaseDashboardS
47
47
  /**
48
48
  * Override this method to define the layout of the widget in the dashboard.
49
49
  * @returns The layout of the widget in the dashboard.
50
+ * @public
50
51
  */
51
52
  protected layout(): JSX.Element | undefined;
52
53
  /**
53
54
  * Override this method to customize the dashboard style.
54
55
  * @returns The className for customizing the dashboard style.
56
+ * @public
55
57
  */
56
58
  protected styling(): string;
57
59
  }
@@ -1 +1 @@
1
- {"version":3,"file":"BaseDashboard.d.ts","sourceRoot":"","sources":["../../src/BaseDashboard.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAoBzC;;GAEG;AACH,UAAU,kBAAkB;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;;;GAIG;AACH,qBAAa,aAAa,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC;IAC3E;;OAEG;IACH,OAAO,CAAC,GAAG,CAAkC;IAE7C;;;OAGG;gBACgB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IAUrC;;OAEG;IACU,iBAAiB;IAa9B;;OAEG;IACI,oBAAoB,IAAI,IAAI;IAOnC;;OAEG;IACI,MAAM;IAWb;;;OAGG;IACH,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI3C;;;OAGG;IACH,SAAS,CAAC,OAAO,IAAI,MAAM;CAG5B"}
1
+ {"version":3,"file":"BaseDashboard.d.ts","sourceRoot":"","sources":["../../src/BaseDashboard.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAoBzC;;GAEG;AACH,UAAU,kBAAkB;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;;;GAIG;AACH,qBAAa,aAAa,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC;IAC3E;;OAEG;IACH,OAAO,CAAC,GAAG,CAAkC;IAE7C;;;OAGG;gBACgB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IAUrC;;OAEG;IACU,iBAAiB;IAa9B;;OAEG;IACI,oBAAoB,IAAI,IAAI;IAOnC;;OAEG;IACI,MAAM;IAWb;;;;OAIG;IACH,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI3C;;;;OAIG;IACH,SAAS,CAAC,OAAO,IAAI,MAAM;CAG5B"}
@@ -73,6 +73,7 @@ var BaseDashboard = /** @class */ (function (_super) {
73
73
  /**
74
74
  * Override this method to define the layout of the widget in the dashboard.
75
75
  * @returns The layout of the widget in the dashboard.
76
+ * @public
76
77
  */
77
78
  BaseDashboard.prototype.layout = function () {
78
79
  return undefined;
@@ -80,6 +81,7 @@ var BaseDashboard = /** @class */ (function (_super) {
80
81
  /**
81
82
  * Override this method to customize the dashboard style.
82
83
  * @returns The className for customizing the dashboard style.
84
+ * @public
83
85
  */
84
86
  BaseDashboard.prototype.styling = function () {
85
87
  return null;
@@ -47,7 +47,8 @@ export declare class BaseWidget<P, S> extends Component<P, S & BaseWidgetState>
47
47
  render(): JSX.Element;
48
48
  /**
49
49
  * Get data required by the widget
50
- * @returns data for the widget
50
+ * @returns Data for the widget
51
+ * @public
51
52
  */
52
53
  protected getData(): Promise<S>;
53
54
  /**
@@ -55,6 +56,7 @@ export declare class BaseWidget<P, S> extends Component<P, S & BaseWidgetState>
55
56
  * By overriding this method, you can add additional functionality or styling to the widget's header.
56
57
  * If the method is not overridden, the widget will return undefined as the default value for the header, indicating that no custom header content has been defined.
57
58
  * @returns An optional JSX.Element representing the header of the widget.
59
+ * @public
58
60
  */
59
61
  protected header(): JSX.Element | undefined;
60
62
  /**
@@ -62,6 +64,7 @@ export declare class BaseWidget<P, S> extends Component<P, S & BaseWidgetState>
62
64
  * By overriding this method, you can add additional functionality or styling to the widget's body.
63
65
  * If the method is not overridden, the widget will return undefined as the default value for the body, indicating that no custom body content has been defined.
64
66
  * @returns An optional JSX.Element representing the body of the widget.
67
+ * @public
65
68
  */
66
69
  protected body(): JSX.Element | undefined;
67
70
  /**
@@ -69,6 +72,7 @@ export declare class BaseWidget<P, S> extends Component<P, S & BaseWidgetState>
69
72
  * By overriding this method, you can add additional functionality or styling to the widget's footer.
70
73
  * If the method is not overridden, the widget will return undefined as the default value for the footer, indicating that no custom footer content has been defined.
71
74
  * @returns An optional JSX.Element representing the footer of the widget.
75
+ * @public
72
76
  */
73
77
  protected footer(): JSX.Element | undefined;
74
78
  /**
@@ -76,12 +80,14 @@ export declare class BaseWidget<P, S> extends Component<P, S & BaseWidgetState>
76
80
  * The `undefined` return value is used to indicate that no loading indicator is required.
77
81
  * If a loading indicator is required, the method can return a `JSX.Element` containing the necessary components to render the loading indicator.
78
82
  * @returns A JSX element or `undefined` if no loading indicator is required.
83
+ * @public
79
84
  */
80
85
  protected loading(): JSX.Element | undefined;
81
86
  /**
82
87
  * Override this method to returns an object that defines the class names for the different parts of the widget.
83
88
  * The returned object conforms to the {@link IWidgetClassNames} interface which defines the possible keys and values for the class names.
84
89
  * @returns An object that defines the class names for the different parts of the widget.
90
+ * @public
85
91
  */
86
92
  protected styling(): IWidgetClassNames;
87
93
  }
@@ -1 +1 @@
1
- {"version":3,"file":"BaseWidget.d.ts","sourceRoot":"","sources":["../../src/BaseWidget.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAKzC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AA2CD;;GAEG;AACH,UAAU,eAAe;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,qBAAa,UAAU,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC;IACrE;;;OAGG;gBACgB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IAKrC;;OAEG;IACU,iBAAiB;IAI9B;;OAEG;IACI,MAAM;IAsBb;;;OAGG;cACa,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC;IAIrC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI3C;;;;;OAKG;IACH,SAAS,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAIzC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI3C;;;;;OAKG;IACH,SAAS,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI5C;;;;OAIG;IACH,SAAS,CAAC,OAAO,IAAI,iBAAiB;CAGvC"}
1
+ {"version":3,"file":"BaseWidget.d.ts","sourceRoot":"","sources":["../../src/BaseWidget.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAKzC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AA2CD;;GAEG;AACH,UAAU,eAAe;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,qBAAa,UAAU,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC;IACrE;;;OAGG;gBACgB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IAKrC;;OAEG;IACU,iBAAiB;IAI9B;;OAEG;IACI,MAAM;IAsBb;;;;OAIG;cACa,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC;IAIrC;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI3C;;;;;;OAMG;IACH,SAAS,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAIzC;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI3C;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI5C;;;;;OAKG;IACH,SAAS,CAAC,OAAO,IAAI,iBAAiB;CAGvC"}
@@ -94,7 +94,8 @@ var BaseWidget = /** @class */ (function (_super) {
94
94
  };
95
95
  /**
96
96
  * Get data required by the widget
97
- * @returns data for the widget
97
+ * @returns Data for the widget
98
+ * @public
98
99
  */
99
100
  BaseWidget.prototype.getData = function () {
100
101
  return tslib_1.__awaiter(this, void 0, void 0, function () {
@@ -108,6 +109,7 @@ var BaseWidget = /** @class */ (function (_super) {
108
109
  * By overriding this method, you can add additional functionality or styling to the widget's header.
109
110
  * If the method is not overridden, the widget will return undefined as the default value for the header, indicating that no custom header content has been defined.
110
111
  * @returns An optional JSX.Element representing the header of the widget.
112
+ * @public
111
113
  */
112
114
  BaseWidget.prototype.header = function () {
113
115
  return undefined;
@@ -117,6 +119,7 @@ var BaseWidget = /** @class */ (function (_super) {
117
119
  * By overriding this method, you can add additional functionality or styling to the widget's body.
118
120
  * If the method is not overridden, the widget will return undefined as the default value for the body, indicating that no custom body content has been defined.
119
121
  * @returns An optional JSX.Element representing the body of the widget.
122
+ * @public
120
123
  */
121
124
  BaseWidget.prototype.body = function () {
122
125
  return undefined;
@@ -126,6 +129,7 @@ var BaseWidget = /** @class */ (function (_super) {
126
129
  * By overriding this method, you can add additional functionality or styling to the widget's footer.
127
130
  * If the method is not overridden, the widget will return undefined as the default value for the footer, indicating that no custom footer content has been defined.
128
131
  * @returns An optional JSX.Element representing the footer of the widget.
132
+ * @public
129
133
  */
130
134
  BaseWidget.prototype.footer = function () {
131
135
  return undefined;
@@ -135,6 +139,7 @@ var BaseWidget = /** @class */ (function (_super) {
135
139
  * The `undefined` return value is used to indicate that no loading indicator is required.
136
140
  * If a loading indicator is required, the method can return a `JSX.Element` containing the necessary components to render the loading indicator.
137
141
  * @returns A JSX element or `undefined` if no loading indicator is required.
142
+ * @public
138
143
  */
139
144
  BaseWidget.prototype.loading = function () {
140
145
  return undefined;
@@ -143,6 +148,7 @@ var BaseWidget = /** @class */ (function (_super) {
143
148
  * Override this method to returns an object that defines the class names for the different parts of the widget.
144
149
  * The returned object conforms to the {@link IWidgetClassNames} interface which defines the possible keys and values for the class names.
145
150
  * @returns An object that defines the class names for the different parts of the widget.
151
+ * @public
146
152
  */
147
153
  BaseWidget.prototype.styling = function () {
148
154
  return {};
@@ -25,7 +25,7 @@ export type Data<T> = State<T> & {
25
25
  * @param options - if autoLoad is true, reload data immediately
26
26
  * @returns data, loading status, error and reload function
27
27
  *
28
- * @beta
28
+ * @public
29
29
  */
30
30
  export declare function useData<T>(fetchDataAsync: () => Promise<T>, options?: {
31
31
  autoLoad: boolean;
@@ -23,7 +23,7 @@ var createReducer = function () {
23
23
  * @param options - if autoLoad is true, reload data immediately
24
24
  * @returns data, loading status, error and reload function
25
25
  *
26
- * @beta
26
+ * @public
27
27
  */
28
28
  function useData(fetchDataAsync, options) {
29
29
  var _a;
@@ -16,7 +16,7 @@ type GraphOptionWithCredential = {
16
16
  * @param options - teamsfx instance and OAuth resource scope.
17
17
  * @returns data, loading status, error and reload function
18
18
  *
19
- * @beta
19
+ * @public
20
20
  */
21
21
  export declare function useGraph<T>(fetchGraphDataAsync: (graph: Client, teamsfx: TeamsFx, scope: string[]) => Promise<T>, options?: GraphOption): Data<T>;
22
22
  /**
@@ -26,7 +26,7 @@ export declare function useGraph<T>(fetchGraphDataAsync: (graph: Client, teamsfx
26
26
  * @param options - Authentication configuration and OAuth resource scope.
27
27
  * @returns data, loading status, error and reload function
28
28
  *
29
- * @beta
29
+ * @public
30
30
  */
31
31
  export declare function useGraphWithCredential<T>(fetchGraphDataAsync: (graph: Client, credential: TeamsUserCredential, scope: string[]) => Promise<T>, options?: GraphOptionWithCredential): Data<T>;
32
32
  export {};
@@ -15,7 +15,7 @@ var react_1 = require("react");
15
15
  * @param options - teamsfx instance and OAuth resource scope.
16
16
  * @returns data, loading status, error and reload function
17
17
  *
18
- * @beta
18
+ * @public
19
19
  */
20
20
  function useGraph(fetchGraphDataAsync, options) {
21
21
  var _this = this;
@@ -77,7 +77,7 @@ exports.useGraph = useGraph;
77
77
  * @param options - Authentication configuration and OAuth resource scope.
78
78
  * @returns data, loading status, error and reload function
79
79
  *
80
- * @beta
80
+ * @public
81
81
  */
82
82
  function useGraphWithCredential(fetchGraphDataAsync, options) {
83
83
  var _this = this;
@@ -36,7 +36,7 @@ export type TeamsFxContext = {
36
36
  * @param teamsfxConfig - custom configuration to override default ones.
37
37
  * @returns TeamsFxContext object
38
38
  *
39
- * @beta
39
+ * @public
40
40
  */
41
41
  export declare function useTeamsFx(teamsfxConfig?: Record<string, string>): TeamsFxContext;
42
42
  //# sourceMappingURL=useTeamsFx.d.ts.map
@@ -13,7 +13,7 @@ var useData_1 = require("./useData");
13
13
  * @param teamsfxConfig - custom configuration to override default ones.
14
14
  * @returns TeamsFxContext object
15
15
  *
16
- * @beta
16
+ * @public
17
17
  */
18
18
  function useTeamsFx(teamsfxConfig) {
19
19
  var _this = this;
@@ -36,7 +36,7 @@ export type TeamsContextWithCredential = {
36
36
  * @param authConfig - custom configuration to override default ones.
37
37
  * @returns TeamsContextWithCredential object
38
38
  *
39
- * @beta
39
+ * @public
40
40
  */
41
41
  export declare function useTeamsUserCredential(authConfig: TeamsUserCredentialAuthConfig): TeamsContextWithCredential;
42
42
  //# sourceMappingURL=useTeamsUserCredential.d.ts.map
@@ -13,7 +13,7 @@ var useData_1 = require("./useData");
13
13
  * @param authConfig - custom configuration to override default ones.
14
14
  * @returns TeamsContextWithCredential object
15
15
  *
16
- * @beta
16
+ * @public
17
17
  */
18
18
  function useTeamsUserCredential(authConfig) {
19
19
  var _this = this;
@@ -47,11 +47,13 @@ export declare class BaseDashboard<P, S> extends Component<P, S & BaseDashboardS
47
47
  /**
48
48
  * Override this method to define the layout of the widget in the dashboard.
49
49
  * @returns The layout of the widget in the dashboard.
50
+ * @public
50
51
  */
51
52
  protected layout(): JSX.Element | undefined;
52
53
  /**
53
54
  * Override this method to customize the dashboard style.
54
55
  * @returns The className for customizing the dashboard style.
56
+ * @public
55
57
  */
56
58
  protected styling(): string;
57
59
  }
@@ -1 +1 @@
1
- {"version":3,"file":"BaseDashboard.d.ts","sourceRoot":"","sources":["../../src/BaseDashboard.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAoBzC;;GAEG;AACH,UAAU,kBAAkB;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;;;GAIG;AACH,qBAAa,aAAa,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC;IAC3E;;OAEG;IACH,OAAO,CAAC,GAAG,CAAkC;IAE7C;;;OAGG;gBACgB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IAUrC;;OAEG;IACU,iBAAiB;IAa9B;;OAEG;IACI,oBAAoB,IAAI,IAAI;IAOnC;;OAEG;IACI,MAAM;IAWb;;;OAGG;IACH,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI3C;;;OAGG;IACH,SAAS,CAAC,OAAO,IAAI,MAAM;CAG5B"}
1
+ {"version":3,"file":"BaseDashboard.d.ts","sourceRoot":"","sources":["../../src/BaseDashboard.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAoBzC;;GAEG;AACH,UAAU,kBAAkB;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED;;;;GAIG;AACH,qBAAa,aAAa,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC;IAC3E;;OAEG;IACH,OAAO,CAAC,GAAG,CAAkC;IAE7C;;;OAGG;gBACgB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IAUrC;;OAEG;IACU,iBAAiB;IAa9B;;OAEG;IACI,oBAAoB,IAAI,IAAI;IAOnC;;OAEG;IACI,MAAM;IAWb;;;;OAIG;IACH,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI3C;;;;OAIG;IACH,SAAS,CAAC,OAAO,IAAI,MAAM;CAG5B"}
@@ -70,6 +70,7 @@ var BaseDashboard = /** @class */ (function (_super) {
70
70
  /**
71
71
  * Override this method to define the layout of the widget in the dashboard.
72
72
  * @returns The layout of the widget in the dashboard.
73
+ * @public
73
74
  */
74
75
  BaseDashboard.prototype.layout = function () {
75
76
  return undefined;
@@ -77,6 +78,7 @@ var BaseDashboard = /** @class */ (function (_super) {
77
78
  /**
78
79
  * Override this method to customize the dashboard style.
79
80
  * @returns The className for customizing the dashboard style.
81
+ * @public
80
82
  */
81
83
  BaseDashboard.prototype.styling = function () {
82
84
  return null;
@@ -47,7 +47,8 @@ export declare class BaseWidget<P, S> extends Component<P, S & BaseWidgetState>
47
47
  render(): JSX.Element;
48
48
  /**
49
49
  * Get data required by the widget
50
- * @returns data for the widget
50
+ * @returns Data for the widget
51
+ * @public
51
52
  */
52
53
  protected getData(): Promise<S>;
53
54
  /**
@@ -55,6 +56,7 @@ export declare class BaseWidget<P, S> extends Component<P, S & BaseWidgetState>
55
56
  * By overriding this method, you can add additional functionality or styling to the widget's header.
56
57
  * If the method is not overridden, the widget will return undefined as the default value for the header, indicating that no custom header content has been defined.
57
58
  * @returns An optional JSX.Element representing the header of the widget.
59
+ * @public
58
60
  */
59
61
  protected header(): JSX.Element | undefined;
60
62
  /**
@@ -62,6 +64,7 @@ export declare class BaseWidget<P, S> extends Component<P, S & BaseWidgetState>
62
64
  * By overriding this method, you can add additional functionality or styling to the widget's body.
63
65
  * If the method is not overridden, the widget will return undefined as the default value for the body, indicating that no custom body content has been defined.
64
66
  * @returns An optional JSX.Element representing the body of the widget.
67
+ * @public
65
68
  */
66
69
  protected body(): JSX.Element | undefined;
67
70
  /**
@@ -69,6 +72,7 @@ export declare class BaseWidget<P, S> extends Component<P, S & BaseWidgetState>
69
72
  * By overriding this method, you can add additional functionality or styling to the widget's footer.
70
73
  * If the method is not overridden, the widget will return undefined as the default value for the footer, indicating that no custom footer content has been defined.
71
74
  * @returns An optional JSX.Element representing the footer of the widget.
75
+ * @public
72
76
  */
73
77
  protected footer(): JSX.Element | undefined;
74
78
  /**
@@ -76,12 +80,14 @@ export declare class BaseWidget<P, S> extends Component<P, S & BaseWidgetState>
76
80
  * The `undefined` return value is used to indicate that no loading indicator is required.
77
81
  * If a loading indicator is required, the method can return a `JSX.Element` containing the necessary components to render the loading indicator.
78
82
  * @returns A JSX element or `undefined` if no loading indicator is required.
83
+ * @public
79
84
  */
80
85
  protected loading(): JSX.Element | undefined;
81
86
  /**
82
87
  * Override this method to returns an object that defines the class names for the different parts of the widget.
83
88
  * The returned object conforms to the {@link IWidgetClassNames} interface which defines the possible keys and values for the class names.
84
89
  * @returns An object that defines the class names for the different parts of the widget.
90
+ * @public
85
91
  */
86
92
  protected styling(): IWidgetClassNames;
87
93
  }
@@ -1 +1 @@
1
- {"version":3,"file":"BaseWidget.d.ts","sourceRoot":"","sources":["../../src/BaseWidget.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAKzC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AA2CD;;GAEG;AACH,UAAU,eAAe;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,qBAAa,UAAU,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC;IACrE;;;OAGG;gBACgB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IAKrC;;OAEG;IACU,iBAAiB;IAI9B;;OAEG;IACI,MAAM;IAsBb;;;OAGG;cACa,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC;IAIrC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI3C;;;;;OAKG;IACH,SAAS,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAIzC;;;;;OAKG;IACH,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI3C;;;;;OAKG;IACH,SAAS,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI5C;;;;OAIG;IACH,SAAS,CAAC,OAAO,IAAI,iBAAiB;CAGvC"}
1
+ {"version":3,"file":"BaseWidget.d.ts","sourceRoot":"","sources":["../../src/BaseWidget.tsx"],"names":[],"mappings":"AAAA,OAAc,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAKzC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AA2CD;;GAEG;AACH,UAAU,eAAe;IACvB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,qBAAa,UAAU,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC;IACrE;;;OAGG;gBACgB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC;IAKrC;;OAEG;IACU,iBAAiB;IAI9B;;OAEG;IACI,MAAM;IAsBb;;;;OAIG;cACa,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC;IAIrC;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI3C;;;;;;OAMG;IACH,SAAS,CAAC,IAAI,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAIzC;;;;;;OAMG;IACH,SAAS,CAAC,MAAM,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI3C;;;;;;OAMG;IACH,SAAS,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,GAAG,SAAS;IAI5C;;;;;OAKG;IACH,SAAS,CAAC,OAAO,IAAI,iBAAiB;CAGvC"}
@@ -91,7 +91,8 @@ var BaseWidget = /** @class */ (function (_super) {
91
91
  };
92
92
  /**
93
93
  * Get data required by the widget
94
- * @returns data for the widget
94
+ * @returns Data for the widget
95
+ * @public
95
96
  */
96
97
  BaseWidget.prototype.getData = function () {
97
98
  return __awaiter(this, void 0, void 0, function () {
@@ -105,6 +106,7 @@ var BaseWidget = /** @class */ (function (_super) {
105
106
  * By overriding this method, you can add additional functionality or styling to the widget's header.
106
107
  * If the method is not overridden, the widget will return undefined as the default value for the header, indicating that no custom header content has been defined.
107
108
  * @returns An optional JSX.Element representing the header of the widget.
109
+ * @public
108
110
  */
109
111
  BaseWidget.prototype.header = function () {
110
112
  return undefined;
@@ -114,6 +116,7 @@ var BaseWidget = /** @class */ (function (_super) {
114
116
  * By overriding this method, you can add additional functionality or styling to the widget's body.
115
117
  * If the method is not overridden, the widget will return undefined as the default value for the body, indicating that no custom body content has been defined.
116
118
  * @returns An optional JSX.Element representing the body of the widget.
119
+ * @public
117
120
  */
118
121
  BaseWidget.prototype.body = function () {
119
122
  return undefined;
@@ -123,6 +126,7 @@ var BaseWidget = /** @class */ (function (_super) {
123
126
  * By overriding this method, you can add additional functionality or styling to the widget's footer.
124
127
  * If the method is not overridden, the widget will return undefined as the default value for the footer, indicating that no custom footer content has been defined.
125
128
  * @returns An optional JSX.Element representing the footer of the widget.
129
+ * @public
126
130
  */
127
131
  BaseWidget.prototype.footer = function () {
128
132
  return undefined;
@@ -132,6 +136,7 @@ var BaseWidget = /** @class */ (function (_super) {
132
136
  * The `undefined` return value is used to indicate that no loading indicator is required.
133
137
  * If a loading indicator is required, the method can return a `JSX.Element` containing the necessary components to render the loading indicator.
134
138
  * @returns A JSX element or `undefined` if no loading indicator is required.
139
+ * @public
135
140
  */
136
141
  BaseWidget.prototype.loading = function () {
137
142
  return undefined;
@@ -140,6 +145,7 @@ var BaseWidget = /** @class */ (function (_super) {
140
145
  * Override this method to returns an object that defines the class names for the different parts of the widget.
141
146
  * The returned object conforms to the {@link IWidgetClassNames} interface which defines the possible keys and values for the class names.
142
147
  * @returns An object that defines the class names for the different parts of the widget.
148
+ * @public
143
149
  */
144
150
  BaseWidget.prototype.styling = function () {
145
151
  return {};
@@ -25,7 +25,7 @@ export type Data<T> = State<T> & {
25
25
  * @param options - if autoLoad is true, reload data immediately
26
26
  * @returns data, loading status, error and reload function
27
27
  *
28
- * @beta
28
+ * @public
29
29
  */
30
30
  export declare function useData<T>(fetchDataAsync: () => Promise<T>, options?: {
31
31
  autoLoad: boolean;
@@ -20,7 +20,7 @@ var createReducer = function () {
20
20
  * @param options - if autoLoad is true, reload data immediately
21
21
  * @returns data, loading status, error and reload function
22
22
  *
23
- * @beta
23
+ * @public
24
24
  */
25
25
  export function useData(fetchDataAsync, options) {
26
26
  var _a;
@@ -16,7 +16,7 @@ type GraphOptionWithCredential = {
16
16
  * @param options - teamsfx instance and OAuth resource scope.
17
17
  * @returns data, loading status, error and reload function
18
18
  *
19
- * @beta
19
+ * @public
20
20
  */
21
21
  export declare function useGraph<T>(fetchGraphDataAsync: (graph: Client, teamsfx: TeamsFx, scope: string[]) => Promise<T>, options?: GraphOption): Data<T>;
22
22
  /**
@@ -26,7 +26,7 @@ export declare function useGraph<T>(fetchGraphDataAsync: (graph: Client, teamsfx
26
26
  * @param options - Authentication configuration and OAuth resource scope.
27
27
  * @returns data, loading status, error and reload function
28
28
  *
29
- * @beta
29
+ * @public
30
30
  */
31
31
  export declare function useGraphWithCredential<T>(fetchGraphDataAsync: (graph: Client, credential: TeamsUserCredential, scope: string[]) => Promise<T>, options?: GraphOptionWithCredential): Data<T>;
32
32
  export {};
@@ -12,7 +12,7 @@ import { useState } from "react";
12
12
  * @param options - teamsfx instance and OAuth resource scope.
13
13
  * @returns data, loading status, error and reload function
14
14
  *
15
- * @beta
15
+ * @public
16
16
  */
17
17
  export function useGraph(fetchGraphDataAsync, options) {
18
18
  var _this = this;
@@ -73,7 +73,7 @@ export function useGraph(fetchGraphDataAsync, options) {
73
73
  * @param options - Authentication configuration and OAuth resource scope.
74
74
  * @returns data, loading status, error and reload function
75
75
  *
76
- * @beta
76
+ * @public
77
77
  */
78
78
  export function useGraphWithCredential(fetchGraphDataAsync, options) {
79
79
  var _this = this;
@@ -36,7 +36,7 @@ export type TeamsFxContext = {
36
36
  * @param teamsfxConfig - custom configuration to override default ones.
37
37
  * @returns TeamsFxContext object
38
38
  *
39
- * @beta
39
+ * @public
40
40
  */
41
41
  export declare function useTeamsFx(teamsfxConfig?: Record<string, string>): TeamsFxContext;
42
42
  //# sourceMappingURL=useTeamsFx.d.ts.map
@@ -10,7 +10,7 @@ import { useData } from "./useData";
10
10
  * @param teamsfxConfig - custom configuration to override default ones.
11
11
  * @returns TeamsFxContext object
12
12
  *
13
- * @beta
13
+ * @public
14
14
  */
15
15
  export function useTeamsFx(teamsfxConfig) {
16
16
  var _this = this;
@@ -36,7 +36,7 @@ export type TeamsContextWithCredential = {
36
36
  * @param authConfig - custom configuration to override default ones.
37
37
  * @returns TeamsContextWithCredential object
38
38
  *
39
- * @beta
39
+ * @public
40
40
  */
41
41
  export declare function useTeamsUserCredential(authConfig: TeamsUserCredentialAuthConfig): TeamsContextWithCredential;
42
42
  //# sourceMappingURL=useTeamsUserCredential.d.ts.map
@@ -10,7 +10,7 @@ import { useData } from "./useData";
10
10
  * @param authConfig - custom configuration to override default ones.
11
11
  * @returns TeamsContextWithCredential object
12
12
  *
13
- * @beta
13
+ * @public
14
14
  */
15
15
  export function useTeamsUserCredential(authConfig) {
16
16
  var _this = this;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@microsoft/teamsfx-react",
3
- "version": "3.0.0",
3
+ "version": "3.0.1-alpha.09fb224aa.0",
4
4
  "description": "React helper functions for Microsoft TeamsFx",
5
5
  "main": "build/cjs/index.js",
6
6
  "module": "build/esm/index.js",
@@ -30,10 +30,10 @@
30
30
  "devDependencies": {
31
31
  "@fluentui/react-components": "^9.15.0",
32
32
  "@istanbuljs/nyc-config-typescript": "^1.0.2",
33
- "@microsoft/eslint-plugin-teamsfx": "^0.0.2",
34
- "@microsoft/microsoft-graph-client": "^3.0.1",
35
- "@microsoft/teams-js": "^2.0.0",
36
- "@microsoft/teamsfx": "^2.2.1",
33
+ "@microsoft/eslint-plugin-teamsfx": "0.0.4-alpha.09fb224aa.0",
34
+ "@microsoft/microsoft-graph-client": "^3.0.5",
35
+ "@microsoft/teams-js": "^2.12.0",
36
+ "@microsoft/teamsfx": "2.2.2-alpha.09fb224aa.0",
37
37
  "@testing-library/react": "^13.4.0",
38
38
  "@types/enzyme": "^3.10.10",
39
39
  "@types/jest": "^29.4.0",
@@ -71,8 +71,8 @@
71
71
  },
72
72
  "peerDependencies": {
73
73
  "@fluentui/react-components": "^9.15.0",
74
- "@microsoft/microsoft-graph-client": "^3.0.1",
75
- "@microsoft/teams-js": "^2.0.0",
74
+ "@microsoft/microsoft-graph-client": "^3.0.5",
75
+ "@microsoft/teams-js": "^2.12.0",
76
76
  "@microsoft/teamsfx": "^2.0.0",
77
77
  "react": ">=16.8.0 <19.0.0",
78
78
  "react-dom": ">=16.8.0 <19.0.0"
@@ -88,5 +88,5 @@
88
88
  "npx eslint --cache --fix --quiet"
89
89
  ]
90
90
  },
91
- "gitHead": "71ef71df56a246236007628327f8df5397fbb4f3"
91
+ "gitHead": "50db14f29a6502ab79dbb897cf14f34da9a5e251"
92
92
  }