@blackbaud/sky-addin-client 1.2.2 → 1.4.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 (31) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +18 -0
  3. package/bundles/sky-addin-client.global-es2015.js +80 -29
  4. package/bundles/sky-addin-client.global-es2015.min.js +1 -1
  5. package/bundles/sky-addin-client.global.js +81 -30
  6. package/bundles/sky-addin-client.global.min.js +1 -1
  7. package/bundles/sky-addin-client.umd-es2015.js +80 -29
  8. package/bundles/sky-addin-client.umd-es2015.min.js +1 -1
  9. package/bundles/sky-addin-client.umd.js +81 -30
  10. package/bundles/sky-addin-client.umd.min.js +1 -1
  11. package/package.json +2 -2
  12. package/src/addin/addin-client.d.ts +5 -0
  13. package/src/addin/addin-client.js +28 -4
  14. package/src/addin/addin-client.js.map +1 -1
  15. package/src/addin/addin-client.spec.js +80 -2
  16. package/src/addin/addin-client.spec.js.map +1 -1
  17. package/src/addin/client-interfaces/addin-box-config.d.ts +14 -0
  18. package/src/addin/client-interfaces/addin-box-config.js +3 -0
  19. package/src/addin/client-interfaces/addin-box-config.js.map +1 -0
  20. package/src/addin/client-interfaces/addin-box-control.d.ts +13 -0
  21. package/src/addin/client-interfaces/addin-box-control.js +3 -0
  22. package/src/addin/client-interfaces/addin-box-control.js.map +1 -0
  23. package/src/addin/client-interfaces/addin-client-args.d.ts +5 -0
  24. package/src/addin/client-interfaces/addin-client-callbacks.d.ts +4 -0
  25. package/src/addin/client-interfaces/addin-client-config.d.ts +9 -0
  26. package/src/addin/client-interfaces/addin-client-config.js +3 -0
  27. package/src/addin/client-interfaces/addin-client-config.js.map +1 -0
  28. package/src/addin/client-interfaces/addin-client-ready-args.d.ts +5 -0
  29. package/src/addin/client-interfaces/index.d.ts +3 -0
  30. package/src/addin/client-interfaces/index.js +3 -0
  31. package/src/addin/client-interfaces/index.js.map +1 -1
@@ -1,4 +1,5 @@
1
1
  import { AddinClientCallbacks } from './addin-client-callbacks';
2
+ import { AddinClientConfig } from './addin-client-config';
2
3
  /**
3
4
  * Interface for constructing an AddinClient.
4
5
  */
@@ -7,4 +8,8 @@ export interface AddinClientArgs {
7
8
  * Callback functions to subscribe to various callbacks that may be raised from the AddinClient.
8
9
  */
9
10
  callbacks: AddinClientCallbacks;
11
+ /**
12
+ * Optional configuration for an AddinClient.
13
+ */
14
+ config?: AddinClientConfig;
10
15
  }
@@ -8,6 +8,10 @@ export interface AddinClientCallbacks {
8
8
  * Callback raised for the add-in to initialize, passing in contextual information.
9
9
  */
10
10
  init: (args: AddinClientInitArgs) => void;
11
+ /**
12
+ * Callback raised for box add-ins indicating that a control action was clicked.
13
+ */
14
+ actionClick?: (action: string) => void;
11
15
  /**
12
16
  * Callback raised for button add-ins indicating that the button was clicked.
13
17
  */
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Configuration properties for an AddinClient.
3
+ */
4
+ export interface AddinClientConfig {
5
+ /**
6
+ * Optional list of allowed origins, as RegExp, to trust as add-in hosts for this add-in client.
7
+ */
8
+ allowedOrigins?: RegExp[];
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=addin-client-config.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"addin-client-config.js","sourceRoot":"","sources":["../../../../src/addin/client-interfaces/addin-client-config.ts"],"names":[],"mappings":""}
@@ -1,4 +1,5 @@
1
1
  import { AddinActionButtonConfig } from './addin-action-button-config';
2
+ import { AddinBoxConfig } from './addin-box-config';
2
3
  import { AddinButtonConfig } from './addin-button-config';
3
4
  import { AddinModalConfig } from './addin-modal-config';
4
5
  import { AddinTabConfig } from './addin-tab-config';
@@ -36,4 +37,8 @@ export interface AddinClientReadyArgs {
36
37
  * Provides additional configuration for Tab add-ins
37
38
  */
38
39
  tabConfig?: AddinTabConfig;
40
+ /**
41
+ * Provides additional configuration for Box add-ins
42
+ */
43
+ boxConfig?: AddinBoxConfig;
39
44
  }
@@ -1,8 +1,11 @@
1
+ export * from './addin-box-config';
2
+ export * from './addin-box-control';
1
3
  export * from './addin-button-config';
2
4
  export * from './addin-button-style';
3
5
  export * from './addin-client-args';
4
6
  export * from './addin-client-callbacks';
5
7
  export * from './addin-client-close-modal-args';
8
+ export * from './addin-client-config';
6
9
  export * from './addin-client-event-args';
7
10
  export * from './addin-client-flyout-permalink';
8
11
  export * from './addin-client-init-args';
@@ -14,11 +14,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./addin-box-config"), exports);
18
+ __exportStar(require("./addin-box-control"), exports);
17
19
  __exportStar(require("./addin-button-config"), exports);
18
20
  __exportStar(require("./addin-button-style"), exports);
19
21
  __exportStar(require("./addin-client-args"), exports);
20
22
  __exportStar(require("./addin-client-callbacks"), exports);
21
23
  __exportStar(require("./addin-client-close-modal-args"), exports);
24
+ __exportStar(require("./addin-client-config"), exports);
22
25
  __exportStar(require("./addin-client-event-args"), exports);
23
26
  __exportStar(require("./addin-client-flyout-permalink"), exports);
24
27
  __exportStar(require("./addin-client-init-args"), exports);
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/addin/client-interfaces/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,uDAAqC;AACrC,sDAAoC;AACpC,2DAAyC;AACzC,kEAAgD;AAChD,4DAA0C;AAC1C,kEAAgD;AAChD,2DAAyC;AACzC,+DAA6C;AAC7C,gEAA8C;AAC9C,4DAA0C;AAC1C,qEAAmD;AACnD,mEAAiD;AACjD,iEAA+C;AAC/C,kEAAgD;AAChD,oEAAkD;AAClD,iEAA+C;AAC/C,mEAAiD;AACjD,iEAA+C;AAC/C,gEAA8C;AAC9C,yDAAuC;AACvC,+DAA6C;AAC7C,uDAAqC;AACrC,4DAA0C;AAC1C,sDAAoC;AACpC,6DAA2C;AAC3C,sDAAoC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/addin/client-interfaces/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AACnC,sDAAoC;AACpC,wDAAsC;AACtC,uDAAqC;AACrC,sDAAoC;AACpC,2DAAyC;AACzC,kEAAgD;AAChD,wDAAsC;AACtC,4DAA0C;AAC1C,kEAAgD;AAChD,2DAAyC;AACzC,+DAA6C;AAC7C,gEAA8C;AAC9C,4DAA0C;AAC1C,qEAAmD;AACnD,mEAAiD;AACjD,iEAA+C;AAC/C,kEAAgD;AAChD,oEAAkD;AAClD,iEAA+C;AAC/C,mEAAiD;AACjD,iEAA+C;AAC/C,gEAA8C;AAC9C,yDAAuC;AACvC,+DAA6C;AAC7C,uDAAqC;AACrC,4DAA0C;AAC1C,sDAAoC;AACpC,6DAA2C;AAC3C,sDAAoC"}