@kano/kbc-challenges - npm Package Compare versions

Comparing version 4.21.4-alpha.0 to 4.21.5-alpha.0

lib/footer.d.ts

@@ -1,9 +0,4 @@
-import React from 'react';
-export declare const FooterAppCard: ({ app, link }: {
-    app: "kano-code" | "make-art" | "kano-world" | "artopia";
-    link: string;
-}) => JSX.Element;
-export declare const Footer: ({ appCards }: {
-    appCards?: () => React.ReactNode;
-}) => JSX.Element;
+export declare const FooterAppCard: any;
+export declare const Footer: any;
+export default Footer;
 //# sourceMappingURL=footer.d.ts.map

lib/footer.js

@@ -7,4 +7,5 @@ "use strict";
 const react_1 = __importDefault(require("react"));
+const kbc_telemetry_1 = require("@kano/kbc-telemetry");
 const custom_1 = require("@kano/kbc-icons/lib/custom");
-exports.FooterAppCard = ({ app, link }) => {
+const FooterAppCardComp = ({ app, link, tracking }) => {
     let icon = null;
@@ -35,5 +36,8 @@ let title = null;
     }
+    const handleAppClick = () => {
+        tracking.trackEvent({ event: 'app_card_launch', action: 'click', data: { app } });
+    };
     return (react_1.default.createElement("div", { className: "col" },
         react_1.default.createElement("div", { className: "app-card" },
-            react_1.default.createElement("a", { href: link, target: "_blank" },
+            react_1.default.createElement("a", { href: link, target: "_blank", onClick: handleAppClick },
                 react_1.default.createElement("div", { className: "app-card__icon" }, icon),
@@ -44,3 +48,4 @@ react_1.default.createElement("div", { className: "app-card__info" },
 };
-exports.Footer = ({ appCards }) => {
+exports.FooterAppCard = kbc_telemetry_1.track({})(FooterAppCardComp);
+const FooterComp = ({ appCards }) => {
     const date = new Date();
@@ -70,2 +75,6 @@ return (react_1.default.createElement("div", { className: "footer" },
 };
+exports.Footer = kbc_telemetry_1.track({
+    module: 'footer',
+})(FooterComp);
+exports.default = exports.Footer;
 //# sourceMappingURL=footer.js.map

package.json

 {
   "name": "@kano/kbc-challenges",
-  "version": "4.21.4-alpha.0",
+  "version": "4.21.5-alpha.0",
   "description": "",
@@ -40,3 +40,3 @@ "author": "Kano Computing",
   },
-  "gitHead": "2badce9a4fd276295856eac05ef4592482ad97b7"
+  "gitHead": "aba1986c55e3bf2c51ed25b26a571aa57a5040c5"
 }

README.md

 # `@kano/kbc-challenges`
 
-> TODO: description
+All components relation to app challenge packs and challenges cards and views.
 
@@ -8,7 +8,24 @@ ## Usage
 ```
-const kbcChallenges = require('@kano/kbc-challenges');
-
-// TODO: DEMONSTRATE API
+render() {
+    const { data, progress } = this.state;
+    const { match, config } = this.props;
+    
+    return (
+        <Route path={'/challenges'} render={() => <ChallengePacksList progress={progress} challenges={data.challenges} match={match} footerAppCards={() => (
+            <>
+                <FooterAppCard app="kano-world" link={config.KB_KANO_WORLD_URL} />
+                <FooterAppCard app="kano-code" link={config.KB_KANO_CODE_URL} />
+                <FooterAppCard app="artopia" link={config.KB_ARTOPIA_URL} />
+            </>
+        )} />} />
+    );
+}
 ```
 
+### Props
+* __progress__: the gamification progress of the current user
+* __challenges__: challenge data from kit-app-ui-cms
+* __match__: the match object from react routing
+* __footerAppCards__: any app cards to be displayed in the footers of challenge pages
+
 ## Tracking
@@ -18,5 +35,6 @@
 
-| Component (location) | Name                              |
-| -------------------- | --------------------------------- |
-| ChallengesPacksList  | `challenge-packs-list`            |
-| ChallengesList       | `challenges-list`                 |
+| Component (location) | Function                          | Event / Error Name            | Extra Info                                           |
+| -------------------- | --------------------------------- | ----------------------------- | ---------------------------------------------------- |
+| ChallengesPacksList  | `export`                          | `page_view`                   | page: `challenge-packs-list`                         |
+| ChallengesList       | `export`                          | `page_view`                   | page: `challenges-list`                              |
+| Footer               | `handleAppClick`                  | `app_card_launch`             | module: `footer`, data: `{ app }`                    |

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

65940

increased by3.23%

Lines of code

424

increased by0.95%

Number of lines in readme file

38

increased by90%

No dependency changes