@instructure/ui-decorator 8.9.1-snapshot.0 → 8.9.2-snapshot.12

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.9.1](https://github.com/instructure/instructure-ui/compare/v8.9.0...v8.9.1) (2021-09-16)
+
+**Note:** Version bump only for package @instructure/ui-decorator
+
 # [8.9.0](https://github.com/instructure/instructure-ui/compare/v8.8.0...v8.9.0) (2021-09-15)
 
 **Note:** Version bump only for package @instructure/ui-decorator

package/README.md

@@ -5,7 +5,6 @@ category: packages
 ## ui-decorator
 
 [![npm][npm]][npm-url] 
-[![build-status][build-status]][build-status-url] 
 [![MIT License][license-badge]][license] 
 [![Code of Conduct][coc-badge]][coc]
 

package/es/decorator.js

@@ -29,11 +29,12 @@
  * Wraps (decorates) a React component to add additional functionality
  *
  * @module decorator
- * @param {Function} decorator a function that returns a decorated component
- * @returns {Class} a decorated component class
+ * @param {Function} decorate a function that returns a decorated component
+ * @returns {Class} A decorated component class
  */
 function decorator(decorate) {
   return (...args) => {
+    // parameters when the decorator is used
     return ComposedComponent => {
       if (typeof decorate === 'function') {
         const displayName = ComposedComponent.displayName || ComposedComponent.name;

package/lib/decorator.js

@@ -37,11 +37,12 @@ exports.default = void 0;
  * Wraps (decorates) a React component to add additional functionality
  *
  * @module decorator
- * @param {Function} decorator a function that returns a decorated component
- * @returns {Class} a decorated component class
+ * @param {Function} decorate a function that returns a decorated component
+ * @returns {Class} A decorated component class
  */
 function decorator(decorate) {
   return (...args) => {
+    // parameters when the decorator is used
     return ComposedComponent => {
       if (typeof decorate === 'function') {
         const displayName = ComposedComponent.displayName || ComposedComponent.name;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-decorator",
-  "version": "8.9.1-snapshot.0+000c779bb",
+  "version": "8.9.2-snapshot.12+6231ada93",
   "description": "A utility to wrap (decorates) a React component class adding functionality.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "type": "commonjs",
@@ -23,7 +23,7 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.9.1-snapshot.0+000c779bb"
+    "@instructure/ui-babel-preset": "8.9.2-snapshot.12+6231ada93"
   },
   "dependencies": {
     "@babel/runtime": "^7.13.10"
@@ -31,5 +31,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "000c779bb16c575bcfeb4a6c71d8cef1d768db01"
+  "gitHead": "6231ada93bd4299d640b5d39d7e44b0f54852b2a"
 }

package/src/decorator.ts

@@ -22,6 +22,8 @@
  * SOFTWARE.
  */
 
+import type { ComponentClass } from 'react'
+
 /**
  * ---
  * category: utilities
@@ -29,12 +31,15 @@
  * Wraps (decorates) a React component to add additional functionality
  *
  * @module decorator
- * @param {Function} decorator a function that returns a decorated component
- * @returns {Class} a decorated component class
+ * @param {Function} decorate a function that returns a decorated component
+ * @returns {Class} A decorated component class
  */
-function decorator(decorate: any) {
-  return (...args: any[]) => {
-    return (ComposedComponent: any) => {
+function decorator(
+  decorate: (toDecorate: ComponentClass<any>, ...args: any[]) => any
+) {
+  return (...args: unknown[]) => {
+    // parameters when the decorator is used
+    return (ComposedComponent: ComponentClass<any>) => {
       if (typeof decorate === 'function') {
         const displayName =
           ComposedComponent.displayName || ComposedComponent.name

package/types/decorator.d.ts

@@ -1,3 +1,4 @@
+import type { ComponentClass } from 'react';
 /**
  * ---
  * category: utilities
@@ -5,10 +6,10 @@
  * Wraps (decorates) a React component to add additional functionality
  *
  * @module decorator
- * @param {Function} decorator a function that returns a decorated component
- * @returns {Class} a decorated component class
+ * @param {Function} decorate a function that returns a decorated component
+ * @returns {Class} A decorated component class
  */
-declare function decorator(decorate: any): (...args: any[]) => (ComposedComponent: any) => any;
+declare function decorator(decorate: (toDecorate: ComponentClass<any>, ...args: any[]) => any): (...args: unknown[]) => (ComposedComponent: ComponentClass<any>) => any;
 export default decorator;
 export { decorator };
 //# sourceMappingURL=decorator.d.ts.map

package/types/decorator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../src/decorator.ts"],"names":[],"mappings":"AAwBA;;;;;;;;;GASG;AACH,iBAAS,SAAS,CAAC,QAAQ,EAAE,GAAG,aACb,GAAG,EAAE,yBACO,GAAG,SAYjC;AACD,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,EAAE,CAAA"}
+{"version":3,"file":"decorator.d.ts","sourceRoot":"","sources":["../src/decorator.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AAE3C;;;;;;;;;GASG;AACH,iBAAS,SAAS,CAChB,QAAQ,EAAE,CAAC,UAAU,EAAE,cAAc,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,aAEjD,OAAO,EAAE,yBAEG,eAAe,GAAG,CAAC,SAYjD;AACD,eAAe,SAAS,CAAA;AACxB,OAAO,EAAE,SAAS,EAAE,CAAA"}