piral-tracker 0.15.8-beta.5168

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 - 2023 smapiot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+[![Piral Logo](https://github.com/smapiot/piral/raw/main/docs/assets/logo.png)](https://piral.io)
+
+# [Piral Tracker](https://piral.io) · [![GitHub License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/smapiot/piral/blob/main/LICENSE) [![npm version](https://img.shields.io/npm/v/piral-tracker.svg?style=flat)](https://www.npmjs.com/package/piral-tracker) [![tested with jest](https://img.shields.io/badge/tested_with-jest-99424f.svg)](https://jestjs.io) [![Gitter Chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/piral-io/community)
+
+This is plugin that only has a peer dependency to `piral-core`. What `piral-tracker` brings to the table is a set of Pilet API extensions that can be used with `piral` or `piral-core`.
+
+## Why and When
+
+Sometimes you want to register components that should always be active, e.g., for reporting purposes, to show up periodically, or to make certain validations. Either way, out of the box you could do that via some extension, but a more convenient way to integrate such a component could be via a dedicated API.
+
+This plugin gives you such an API and a ready-to-use component that you can integrate on all pages (or maybe even in your layout) where these registered trackers should be active.
+
+## Documentation
+
+The following functions are brought to the Pilet API.
+
+### `registerTracker()`
+
+Adds the definition of a tracker to the app shell.
+
+If the first argument is a string a named tracker is registered. A named tracker can also be removed.
+
+### `unregisterTracker()`
+
+Removes a tracker from the app shell. This requires a named tracker.
+
+## Usage
+
+::: summary: For pilet authors
+
+You can use the `registerTracker` function from the Pilet API to add a new tracker in the app shell.
+
+**Note**: When the first argument is a string we call it a *named* tracker.
+
+Example use:
+
+```ts
+import { PiletApi } from '<name-of-piral-instance>';
+
+const MyTracker = () => {
+  return null;
+};
+
+export function setup(piral: PiletApi) {
+  // 👇 Registers a named tracker called "my-tracker"
+  piral.registerTracker('my-tracker', MyTracker);
+
+  // 👇 Registers an anonymous tracker
+  piral.registerTracker(MyTracker);
+}
+```
+
+You can use the `unregisterTracker` function from the Pilet API to remove a previously added tracker from the app shell.
+
+**Note**: You'll need to have added a *named* tracker in order to be able to remove it.
+
+Example use:
+
+```ts
+import { PiletApi } from '<name-of-piral-instance>';
+import { MyTracker } from './MyTracker';
+
+export function setup(piral: PiletApi) {
+  // register with a name
+  piral.registerTracker('first', MyTracker);
+  // and unregister; maybe some time later?
+  piral.unregisterTracker('first');
+}
+```
+
+:::
+
+::: summary: For Piral instance developers
+
+The provided library only brings API extensions for pilets to a Piral instance.
+
+For the setup of the library itself you'll need to import `createTrackerApi` from the `piral-tracker` package.
+
+```ts
+import { createTrackerApi } from 'piral-tracker';
+```
+
+The integration looks like:
+
+```ts
+const instance = createInstance({
+  // important part
+  plugins: [createTrackerApi()],
+  // ...
+});
+```
+
+:::
+
+## License
+
+Piral is released using the MIT license. For more information see the [license file](./LICENSE).

package/esm/Tracker.d.ts

@@ -0,0 +1,8 @@
+import * as React from 'react';
+export interface TrackerProps {
+}
+/**
+ * The tracker component. Integrate this in a layout
+ * where all the registered trackers should be active / running.
+ */
+export declare const Tracker: React.FC<TrackerProps>;

package/esm/Tracker.js

@@ -0,0 +1,15 @@
+import * as React from 'react';
+import { useGlobalState } from 'piral-core';
+/**
+ * The tracker component. Integrate this in a layout
+ * where all the registered trackers should be active / running.
+ */
+export const Tracker = () => {
+    const trackers = useGlobalState((m) => m.registry.trackers);
+    return (React.createElement(React.Fragment, null, Object.keys(trackers).map((m) => {
+        const Tracker = trackers[m].component;
+        return React.createElement(Tracker, { key: m });
+    })));
+};
+Tracker.displayName = 'Tracker';
+//# sourceMappingURL=Tracker.js.map

package/esm/Tracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tracker.js","sourceRoot":"","sources":["../src/Tracker.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAI5C;;;GAGG;AACH,MAAM,CAAC,MAAM,OAAO,GAA2B,GAAG,EAAE;IAClD,MAAM,QAAQ,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE5D,OAAO,CACL,0CACG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC/B,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtC,OAAO,oBAAC,OAAO,IAAC,GAAG,EAAE,CAAC,GAAI,CAAC;IAC7B,CAAC,CAAC,CACD,CACJ,CAAC;AACJ,CAAC,CAAC;AACF,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC"}

package/esm/actions.d.ts

@@ -0,0 +1,4 @@
+import { GlobalStateContext } from 'piral-core';
+import { TrackerRegistration } from './types';
+export declare function registerTracker(ctx: GlobalStateContext, name: string, value: TrackerRegistration): void;
+export declare function unregisterTracker(ctx: GlobalStateContext, name: string): void;

package/esm/actions.js

@@ -0,0 +1,8 @@
+import { withKey, withoutKey } from 'piral-core';
+export function registerTracker(ctx, name, value) {
+    ctx.dispatch((state) => (Object.assign(Object.assign({}, state), { registry: Object.assign(Object.assign({}, state.registry), { trackers: withKey(state.registry.trackers, name, value) }) })));
+}
+export function unregisterTracker(ctx, name) {
+    ctx.dispatch((state) => (Object.assign(Object.assign({}, state), { registry: Object.assign(Object.assign({}, state.registry), { trackers: withoutKey(state.registry.trackers, name) }) })));
+}
+//# sourceMappingURL=actions.js.map

package/esm/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,UAAU,EAAsB,MAAM,YAAY,CAAC;AAGrE,MAAM,UAAU,eAAe,CAAC,GAAuB,EAAE,IAAY,EAAE,KAA0B;IAC/F,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iCACnB,KAAK,KACR,QAAQ,kCACH,KAAK,CAAC,QAAQ,KACjB,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,OAEzD,CAAC,CAAC;AACN,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,GAAuB,EAAE,IAAY;IACrE,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iCACnB,KAAK,KACR,QAAQ,kCACH,KAAK,CAAC,QAAQ,KACjB,QAAQ,EAAE,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,OAErD,CAAC,CAAC;AACN,CAAC"}

package/esm/create.d.ts

@@ -0,0 +1,11 @@
+import { PiralPlugin } from 'piral-core';
+import { PiletTrackerApi } from './types';
+/**
+ * Available configuration options for the tracker plugin.
+ */
+export interface TrackerConfig {
+}
+/**
+ * Creates the Pilet API extension for activating tracker support.
+ */
+export declare function createTrackerApi(config?: TrackerConfig): PiralPlugin<PiletTrackerApi>;

package/esm/create.js

@@ -0,0 +1,33 @@
+import * as actions from './actions';
+import { buildName, withApi } from 'piral-core';
+/**
+ * Creates the Pilet API extension for activating tracker support.
+ */
+export function createTrackerApi(config = {}) {
+    return (context) => {
+        context.defineActions(actions);
+        return (api, target) => {
+            const pilet = target.name;
+            let next = 0;
+            return {
+                registerTracker(name, arg) {
+                    if (typeof name !== 'string') {
+                        arg = name;
+                        name = next++;
+                    }
+                    const id = buildName(pilet, name);
+                    context.registerTracker(id, {
+                        pilet,
+                        component: withApi(context, arg, api, 'tracker'),
+                    });
+                    return () => api.unregisterTracker(name);
+                },
+                unregisterTracker(name) {
+                    const id = buildName(pilet, name);
+                    context.unregisterTracker(id);
+                },
+            };
+        };
+    };
+}
+//# sourceMappingURL=create.js.map

package/esm/create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../src/create.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,OAAO,EAAe,MAAM,YAAY,CAAC;AAQ7D;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAAC,SAAwB,EAAE;IACzD,OAAO,CAAC,OAAO,EAAE,EAAE;QACjB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAE/B,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YACrB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC;YAC1B,IAAI,IAAI,GAAG,CAAC,CAAC;YAEb,OAAO;gBACL,eAAe,CAAC,IAAI,EAAE,GAAI;oBACxB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;wBAC5B,GAAG,GAAG,IAAI,CAAC;wBACX,IAAI,GAAG,IAAI,EAAE,CAAC;qBACf;oBAED,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,eAAe,CAAC,EAAE,EAAE;wBAC1B,KAAK;wBACL,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,SAAS,CAAC;qBACjD,CAAC,CAAC;oBACH,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBAC3C,CAAC;gBACD,iBAAiB,CAAC,IAAI;oBACpB,MAAM,EAAE,GAAG,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;gBAChC,CAAC;aACF,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC"}

package/esm/index.d.ts

@@ -0,0 +1,3 @@
+export * from './create';
+export * from './Tracker';
+export * from './types';

package/esm/index.js

@@ -0,0 +1,4 @@
+export * from './create';
+export * from './Tracker';
+export * from './types';
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC"}

package/esm/types.d.ts

@@ -0,0 +1,64 @@
+import type { Dict, WrappedComponent, BaseComponentProps, AnyComponent, BaseRegistration, RegistrationDisposer } from 'piral-core';
+declare module 'piral-core/lib/types/custom' {
+    interface PiletCustomApi extends PiletTrackerApi {
+    }
+    interface PiralCustomActions {
+        /**
+         * Registers a new tracker.
+         * @param name The name of the tracker.
+         * @param value The registration data.
+         */
+        registerTracker(name: string, value: TrackerRegistration): void;
+        /**
+         * Unregisters an existing tracker.
+         * @param name The name of the tracker to be removed.
+         */
+        unregisterTracker(name: string): void;
+    }
+    interface PiralCustomRegistryState {
+        /**
+         * The registered trackers.
+         */
+        trackers: Dict<TrackerRegistration>;
+    }
+    interface PiralCustomErrors {
+        tracker: TrackerErrorInfoProps;
+    }
+}
+export interface TrackerErrorInfoProps {
+    /**
+     * The type of the error.
+     */
+    type: 'tracker';
+    /**
+     * The provided error details.
+     */
+    error: any;
+    /**
+     * The name of the pilet emitting the error.
+     */
+    pilet?: string;
+}
+export interface TrackerRegistration extends BaseRegistration {
+    component: WrappedComponent<BaseComponentProps>;
+}
+export interface PiletTrackerApi {
+    /**
+     * Registers a tracker component.
+     * The name has to be unique within the current pilet.
+     * @param name The name of the tracker.
+     * @param Component The component to be mounted permanently.
+     */
+    registerTracker(name: string, Component: AnyComponent<BaseComponentProps>): RegistrationDisposer;
+    /**
+     * Registers a tracker component.
+     * @param Component The component to be mounted permamently.
+     */
+    registerTracker(Component: AnyComponent<BaseComponentProps>): RegistrationDisposer;
+    /**
+     * Unregisters a tracker known by the given name.
+     * Only previously registered trackers can be unregistered.
+     * @param name The name of the tracker to unregister.
+     */
+    unregisterTracker(name: string): void;
+}

package/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/lib/Tracker.d.ts

@@ -0,0 +1,8 @@
+import * as React from 'react';
+export interface TrackerProps {
+}
+/**
+ * The tracker component. Integrate this in a layout
+ * where all the registered trackers should be active / running.
+ */
+export declare const Tracker: React.FC<TrackerProps>;

package/lib/Tracker.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tracker = void 0;
+const React = require("react");
+const piral_core_1 = require("piral-core");
+/**
+ * The tracker component. Integrate this in a layout
+ * where all the registered trackers should be active / running.
+ */
+const Tracker = () => {
+    const trackers = (0, piral_core_1.useGlobalState)((m) => m.registry.trackers);
+    return (React.createElement(React.Fragment, null, Object.keys(trackers).map((m) => {
+        const Tracker = trackers[m].component;
+        return React.createElement(Tracker, { key: m });
+    })));
+};
+exports.Tracker = Tracker;
+exports.Tracker.displayName = 'Tracker';
+//# sourceMappingURL=Tracker.js.map

package/lib/Tracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tracker.js","sourceRoot":"","sources":["../src/Tracker.tsx"],"names":[],"mappings":";;;AAAA,+BAA+B;AAC/B,2CAA4C;AAI5C;;;GAGG;AACI,MAAM,OAAO,GAA2B,GAAG,EAAE;IAClD,MAAM,QAAQ,GAAG,IAAA,2BAAc,EAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE5D,OAAO,CACL,0CACG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC/B,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACtC,OAAO,oBAAC,OAAO,IAAC,GAAG,EAAE,CAAC,GAAI,CAAC;IAC7B,CAAC,CAAC,CACD,CACJ,CAAC;AACJ,CAAC,CAAC;AAXW,QAAA,OAAO,WAWlB;AACF,eAAO,CAAC,WAAW,GAAG,SAAS,CAAC"}

package/lib/actions.d.ts

@@ -0,0 +1,4 @@
+import { GlobalStateContext } from 'piral-core';
+import { TrackerRegistration } from './types';
+export declare function registerTracker(ctx: GlobalStateContext, name: string, value: TrackerRegistration): void;
+export declare function unregisterTracker(ctx: GlobalStateContext, name: string): void;

package/lib/actions.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unregisterTracker = exports.registerTracker = void 0;
+const piral_core_1 = require("piral-core");
+function registerTracker(ctx, name, value) {
+    ctx.dispatch((state) => (Object.assign(Object.assign({}, state), { registry: Object.assign(Object.assign({}, state.registry), { trackers: (0, piral_core_1.withKey)(state.registry.trackers, name, value) }) })));
+}
+exports.registerTracker = registerTracker;
+function unregisterTracker(ctx, name) {
+    ctx.dispatch((state) => (Object.assign(Object.assign({}, state), { registry: Object.assign(Object.assign({}, state.registry), { trackers: (0, piral_core_1.withoutKey)(state.registry.trackers, name) }) })));
+}
+exports.unregisterTracker = unregisterTracker;
+//# sourceMappingURL=actions.js.map

package/lib/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":";;;AAAA,2CAAqE;AAGrE,SAAgB,eAAe,CAAC,GAAuB,EAAE,IAAY,EAAE,KAA0B;IAC/F,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iCACnB,KAAK,KACR,QAAQ,kCACH,KAAK,CAAC,QAAQ,KACjB,QAAQ,EAAE,IAAA,oBAAO,EAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,EAAE,KAAK,CAAC,OAEzD,CAAC,CAAC;AACN,CAAC;AARD,0CAQC;AAED,SAAgB,iBAAiB,CAAC,GAAuB,EAAE,IAAY;IACrE,GAAG,CAAC,QAAQ,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,iCACnB,KAAK,KACR,QAAQ,kCACH,KAAK,CAAC,QAAQ,KACjB,QAAQ,EAAE,IAAA,uBAAU,EAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,OAErD,CAAC,CAAC;AACN,CAAC;AARD,8CAQC"}

package/lib/create.d.ts

@@ -0,0 +1,11 @@
+import { PiralPlugin } from 'piral-core';
+import { PiletTrackerApi } from './types';
+/**
+ * Available configuration options for the tracker plugin.
+ */
+export interface TrackerConfig {
+}
+/**
+ * Creates the Pilet API extension for activating tracker support.
+ */
+export declare function createTrackerApi(config?: TrackerConfig): PiralPlugin<PiletTrackerApi>;

package/lib/create.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTrackerApi = void 0;
+const actions = require("./actions");
+const piral_core_1 = require("piral-core");
+/**
+ * Creates the Pilet API extension for activating tracker support.
+ */
+function createTrackerApi(config = {}) {
+    return (context) => {
+        context.defineActions(actions);
+        return (api, target) => {
+            const pilet = target.name;
+            let next = 0;
+            return {
+                registerTracker(name, arg) {
+                    if (typeof name !== 'string') {
+                        arg = name;
+                        name = next++;
+                    }
+                    const id = (0, piral_core_1.buildName)(pilet, name);
+                    context.registerTracker(id, {
+                        pilet,
+                        component: (0, piral_core_1.withApi)(context, arg, api, 'tracker'),
+                    });
+                    return () => api.unregisterTracker(name);
+                },
+                unregisterTracker(name) {
+                    const id = (0, piral_core_1.buildName)(pilet, name);
+                    context.unregisterTracker(id);
+                },
+            };
+        };
+    };
+}
+exports.createTrackerApi = createTrackerApi;
+//# sourceMappingURL=create.js.map

package/lib/create.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create.js","sourceRoot":"","sources":["../src/create.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AACrC,2CAA6D;AAQ7D;;GAEG;AACH,SAAgB,gBAAgB,CAAC,SAAwB,EAAE;IACzD,OAAO,CAAC,OAAO,EAAE,EAAE;QACjB,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;QAE/B,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;YACrB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC;YAC1B,IAAI,IAAI,GAAG,CAAC,CAAC;YAEb,OAAO;gBACL,eAAe,CAAC,IAAI,EAAE,GAAI;oBACxB,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;wBAC5B,GAAG,GAAG,IAAI,CAAC;wBACX,IAAI,GAAG,IAAI,EAAE,CAAC;qBACf;oBAED,MAAM,EAAE,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,eAAe,CAAC,EAAE,EAAE;wBAC1B,KAAK;wBACL,SAAS,EAAE,IAAA,oBAAO,EAAC,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,SAAS,CAAC;qBACjD,CAAC,CAAC;oBACH,OAAO,GAAG,EAAE,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;gBAC3C,CAAC;gBACD,iBAAiB,CAAC,IAAI;oBACpB,MAAM,EAAE,GAAG,IAAA,sBAAS,EAAC,KAAK,EAAE,IAAI,CAAC,CAAC;oBAClC,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;gBAChC,CAAC;aACF,CAAC;QACJ,CAAC,CAAC;IACJ,CAAC,CAAC;AACJ,CAAC;AA7BD,4CA6BC"}

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export * from './create';
+export * from './Tracker';
+export * from './types';

package/lib/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./create"), exports);
+tslib_1.__exportStar(require("./Tracker"), exports);
+tslib_1.__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mDAAyB;AACzB,oDAA0B;AAC1B,kDAAwB"}

package/lib/types.d.ts

@@ -0,0 +1,64 @@
+import type { Dict, WrappedComponent, BaseComponentProps, AnyComponent, BaseRegistration, RegistrationDisposer } from 'piral-core';
+declare module 'piral-core/lib/types/custom' {
+    interface PiletCustomApi extends PiletTrackerApi {
+    }
+    interface PiralCustomActions {
+        /**
+         * Registers a new tracker.
+         * @param name The name of the tracker.
+         * @param value The registration data.
+         */
+        registerTracker(name: string, value: TrackerRegistration): void;
+        /**
+         * Unregisters an existing tracker.
+         * @param name The name of the tracker to be removed.
+         */
+        unregisterTracker(name: string): void;
+    }
+    interface PiralCustomRegistryState {
+        /**
+         * The registered trackers.
+         */
+        trackers: Dict<TrackerRegistration>;
+    }
+    interface PiralCustomErrors {
+        tracker: TrackerErrorInfoProps;
+    }
+}
+export interface TrackerErrorInfoProps {
+    /**
+     * The type of the error.
+     */
+    type: 'tracker';
+    /**
+     * The provided error details.
+     */
+    error: any;
+    /**
+     * The name of the pilet emitting the error.
+     */
+    pilet?: string;
+}
+export interface TrackerRegistration extends BaseRegistration {
+    component: WrappedComponent<BaseComponentProps>;
+}
+export interface PiletTrackerApi {
+    /**
+     * Registers a tracker component.
+     * The name has to be unique within the current pilet.
+     * @param name The name of the tracker.
+     * @param Component The component to be mounted permanently.
+     */
+    registerTracker(name: string, Component: AnyComponent<BaseComponentProps>): RegistrationDisposer;
+    /**
+     * Registers a tracker component.
+     * @param Component The component to be mounted permamently.
+     */
+    registerTracker(Component: AnyComponent<BaseComponentProps>): RegistrationDisposer;
+    /**
+     * Unregisters a tracker known by the given name.
+     * Only previously registered trackers can be unregistered.
+     * @param name The name of the tracker to unregister.
+     */
+    unregisterTracker(name: string): void;
+}

package/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "piral-tracker",
+  "version": "0.15.8-beta.5168",
+  "description": "Plugin for registering always-on components in Piral.",
+  "keywords": [
+    "piral",
+    "pilet-api",
+    "smapiot",
+    "portal",
+    "modules",
+    "api",
+    "plugin",
+    "plugin-component",
+    "always-on",
+    "tracking"
+  ],
+  "author": "smapiot",
+  "homepage": "https://piral.io",
+  "license": "MIT",
+  "module": "esm/index.js",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./esm/index.js",
+      "require": "./lib/index.js"
+    },
+    "./esm/*": {
+      "import": "./esm/*"
+    },
+    "./lib/*": {
+      "require": "./lib/*"
+    },
+    "./_/*": {
+      "import": "./esm/*.js",
+      "require": "./lib/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "sideEffects": false,
+  "files": [
+    "esm",
+    "lib",
+    "src",
+    "piral-tracker.min.js"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/smapiot/piral.git"
+  },
+  "bugs": {
+    "url": "https://github.com/smapiot/piral/issues"
+  },
+  "scripts": {
+    "cleanup": "rimraf esm lib piral-tracker.min.js",
+    "build": "yarn build:bundle && yarn build:commonjs && yarn build:esnext",
+    "build:bundle": "esbuild src/index.ts --outfile=piral-tracker.min.js --bundle --external:piral-core --external:react --minify --global-name=piralTracker",
+    "build:commonjs": "tsc --project tsconfig.json --outDir lib --module commonjs",
+    "build:esnext": "tsc --project tsconfig.json --outDir esm --module esnext",
+    "typedoc": "typedoc --json ../../../docs/types/piral-tracker.json src --exclude \"src/**/*.test.*\"",
+    "test": "echo \"Error: run tests from root\" && exit 1"
+  },
+  "devDependencies": {
+    "@types/react": "^18.0.0",
+    "@types/react-router-dom": "^5.1.6",
+    "piral-core": "0.15.8-beta.5168",
+    "react": "^18.0.0"
+  },
+  "peerDependencies": {
+    "piral-core": "0.15.x",
+    "react": ">=16.8.0"
+  },
+  "gitHead": "43b50df63d9d3f75b2c07911d8275786157ffabf"
+}

package/piral-tracker.min.js

@@ -0,0 +1 @@
+var piralTracker=(()=>{var G=Object.create;var c=Object.defineProperty,R=Object.defineProperties,S=Object.getOwnPropertyDescriptor,w=Object.getOwnPropertyDescriptors,K=Object.getOwnPropertyNames,u=Object.getOwnPropertySymbols,N=Object.getPrototypeOf,y=Object.prototype.hasOwnProperty,j=Object.prototype.propertyIsEnumerable;var x=(r,e,t)=>e in r?c(r,e,{enumerable:!0,configurable:!0,writable:!0,value:t}):r[e]=t,a=(r,e)=>{for(var t in e||(e={}))y.call(e,t)&&x(r,t,e[t]);if(u)for(var t of u(e))j.call(e,t)&&x(r,t,e[t]);return r},s=(r,e)=>R(r,w(e)),P=r=>c(r,"__esModule",{value:!0});var g=(r=>typeof require!="undefined"?require:typeof Proxy!="undefined"?new Proxy(r,{get:(e,t)=>(typeof require!="undefined"?require:e)[t]}):r)(function(r){if(typeof require!="undefined")return require.apply(this,arguments);throw new Error('Dynamic require of "'+r+'" is not supported')});var d=(r,e)=>{P(r);for(var t in e)c(r,t,{get:e[t],enumerable:!0})},F=(r,e,t)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of K(e))!y.call(r,i)&&i!=="default"&&c(r,i,{get:()=>e[i],enumerable:!(t=S(e,i))||t.enumerable});return r},f=r=>F(P(c(r!=null?G(N(r)):{},"default",r&&r.__esModule&&"default"in r?{get:()=>r.default,enumerable:!0}:{value:r,enumerable:!0})),r);var z={};d(z,{Tracker:()=>C,createTrackerApi:()=>v});var m={};d(m,{registerTracker:()=>O,unregisterTracker:()=>q});var l=f(g("piral-core"));function O(r,e,t){r.dispatch(i=>s(a({},i),{registry:s(a({},i.registry),{trackers:(0,l.withKey)(i.registry.trackers,e,t)})}))}function q(r,e){r.dispatch(t=>s(a({},t),{registry:s(a({},t.registry),{trackers:(0,l.withoutKey)(t.registry.trackers,e)})}))}var n=f(g("piral-core"));function v(r={}){return e=>(e.defineActions(m),(t,i)=>{let T=i.name,h=0;return{registerTracker(o,k){typeof o!="string"&&(k=o,o=h++);let A=(0,n.buildName)(T,o);return e.registerTracker(A,{pilet:T,component:(0,n.withApi)(e,k,t,"tracker")}),()=>t.unregisterTracker(o)},unregisterTracker(o){let k=(0,n.buildName)(T,o);e.unregisterTracker(k)}}})}var p=f(g("react")),b=f(g("piral-core")),C=()=>{let r=(0,b.useGlobalState)(e=>e.registry.trackers);return p.createElement(p.Fragment,null,Object.keys(r).map(e=>{let t=r[e].component;return p.createElement(t,{key:e})}))};C.displayName="Tracker";return z;})();

package/src/Tracker.test.tsx

@@ -0,0 +1,62 @@
+import * as React from 'react';
+import create from 'zustand';
+import { render } from '@testing-library/react';
+import { StateContext } from 'piral-core';
+import { Tracker } from './Tracker';
+
+function createMockContainer(trackers = {}) {
+  const state = create(() => ({
+    registry: {
+      trackers,
+    },
+  }));
+  return {
+    context: {
+      on: jest.fn(),
+      off: jest.fn(),
+      emit: jest.fn(),
+      defineActions() {},
+      state,
+      readState(read) {
+        return read(state.getState());
+      },
+      dispatch(update) {
+        state.setState(update(state.getState()));
+      },
+    } as any,
+    api: {} as any,
+  };
+}
+
+describe('Piral-Tracker Tracker component', () => {
+  it('uses container for connected trackers', () => {
+    const fake: any = {};
+    const { context } = createMockContainer();
+    const node = render(
+      <StateContext.Provider value={context}>
+        <Tracker {...fake} />
+      </StateContext.Provider>,
+    );
+    expect(node.queryAllByRole('list').length).toBe(0);
+  });
+
+  it('uses container and tracker of connected trackers', () => {
+    const fake: any = {};
+    const { context } = createMockContainer({
+      foo: {
+        component: () => <ul />,
+        preferences: {},
+      },
+      bar: {
+        component: () => <ol />,
+        preferences: {},
+      },
+    });
+    const node = render(
+      <StateContext.Provider value={context}>
+        <Tracker {...fake} />
+      </StateContext.Provider>,
+    );
+    expect(node.getAllByRole('list').length).toBe(2);
+  });
+});

package/src/Tracker.tsx

@@ -0,0 +1,22 @@
+import * as React from 'react';
+import { useGlobalState } from 'piral-core';
+
+export interface TrackerProps {}
+
+/**
+ * The tracker component. Integrate this in a layout
+ * where all the registered trackers should be active / running.
+ */
+export const Tracker: React.FC<TrackerProps> = () => {
+  const trackers = useGlobalState((m) => m.registry.trackers);
+
+  return (
+    <>
+      {Object.keys(trackers).map((m) => {
+        const Tracker = trackers[m].component;
+        return <Tracker key={m} />;
+      })}
+    </>
+  );
+};
+Tracker.displayName = 'Tracker';

package/src/actions.test.ts

@@ -0,0 +1,35 @@
+import create from 'zustand';
+import { createListener } from 'piral-base';
+import { createActions } from 'piral-core';
+import { registerTracker, unregisterTracker } from './actions';
+
+describe('Tracker Actions Module', () => {
+  it('registerTracker and unregisterTracker', () => {
+    const state: any = create(() => ({
+      foo: 5,
+      registry: {
+        foo: 5,
+        trackers: {},
+      },
+    }));
+    const ctx = createActions(state, createListener({}));
+    registerTracker(ctx, 'foo', 10 as any);
+    expect((state.getState())).toEqual({
+      foo: 5,
+      registry: {
+        foo: 5,
+        trackers: {
+          foo: 10,
+        },
+      },
+    });
+    unregisterTracker(ctx, 'foo');
+    expect((state.getState())).toEqual({
+      foo: 5,
+      registry: {
+        foo: 5,
+        trackers: {},
+      },
+    });
+  });
+});

package/src/actions.ts

@@ -0,0 +1,22 @@
+import { withKey, withoutKey, GlobalStateContext } from 'piral-core';
+import { TrackerRegistration } from './types';
+
+export function registerTracker(ctx: GlobalStateContext, name: string, value: TrackerRegistration) {
+  ctx.dispatch((state) => ({
+    ...state,
+    registry: {
+      ...state.registry,
+      trackers: withKey(state.registry.trackers, name, value),
+    },
+  }));
+}
+
+export function unregisterTracker(ctx: GlobalStateContext, name: string) {
+  ctx.dispatch((state) => ({
+    ...state,
+    registry: {
+      ...state.registry,
+      trackers: withoutKey(state.registry.trackers, name),
+    },
+  }));
+}

package/src/create.test.ts

@@ -0,0 +1,91 @@
+import create from 'zustand';
+import { createElement, FC } from 'react';
+import { createTrackerApi } from './create';
+
+const StubComponent: FC = (props) => createElement('div', props);
+StubComponent.displayName = 'StubComponent';
+
+function createMockContainer() {
+  const state = create(() => ({
+    registry: {
+      extensions: {},
+    },
+  }));
+  return {
+    context: {
+      on: jest.fn(),
+      off: jest.fn(),
+      emit: jest.fn(),
+      defineActions() {},
+      converters: {},
+      readState() {
+        return undefined;
+      },
+      state,
+      dispatch(update) {
+        state.setState(update(state.getState()));
+      },
+    } as any,
+    api: {} as any,
+  };
+}
+
+function createApi(container) {
+  Object.assign(container.api, (createTrackerApi()(container.context) as any)(container.api, moduleMetadata));
+  return container.api;
+}
+
+const moduleMetadata = {
+  name: 'my-module',
+  version: '1.0.0',
+  link: undefined,
+  custom: undefined,
+  hash: '123',
+};
+
+describe('Create Tracker API Extensions', () => {
+  it('createTrackerApi can register and unregister a tracker', () => {
+    const container = createMockContainer();
+    container.context.registerTracker = jest.fn();
+    container.context.unregisterTracker = jest.fn();
+    const api = createApi(container);
+    api.registerTracker('my-tracker', StubComponent);
+    expect(container.context.registerTracker).toHaveBeenCalledTimes(1);
+    expect(container.context.unregisterTracker).toHaveBeenCalledTimes(0);
+    api.unregisterTracker('my-tracker');
+    expect(container.context.unregisterTracker).toHaveBeenCalledTimes(1);
+    expect(container.context.unregisterTracker.mock.calls[0][0]).toBe(
+      container.context.registerTracker.mock.calls[0][0],
+    );
+  });
+
+  it('createTrackerApi can dispose a registered tracker', () => {
+    const container = createMockContainer();
+    container.context.registerTracker = jest.fn();
+    container.context.unregisterTracker = jest.fn();
+    const api = createApi(container);
+    const dispose = api.registerTracker('my-tracker', StubComponent);
+    expect(container.context.registerTracker).toHaveBeenCalledTimes(1);
+    expect(container.context.unregisterTracker).toHaveBeenCalledTimes(0);
+    dispose();
+    expect(container.context.unregisterTracker).toHaveBeenCalledTimes(1);
+    expect(container.context.unregisterTracker.mock.calls[0][0]).toBe(
+      container.context.registerTracker.mock.calls[0][0],
+    );
+  });
+
+  it('createTrackerApi can dispose an anonymous tracker', () => {
+    const container = createMockContainer();
+    container.context.registerTracker = jest.fn();
+    container.context.unregisterTracker = jest.fn();
+    const api = createApi(container);
+    const dispose = api.registerTracker(StubComponent);
+    expect(container.context.registerTracker).toHaveBeenCalledTimes(1);
+    expect(container.context.unregisterTracker).toHaveBeenCalledTimes(0);
+    dispose();
+    expect(container.context.unregisterTracker).toHaveBeenCalledTimes(1);
+    expect(container.context.unregisterTracker.mock.calls[0][0]).toBe(
+      container.context.registerTracker.mock.calls[0][0],
+    );
+  });
+});

package/src/create.ts

@@ -0,0 +1,42 @@
+import * as actions from './actions';
+import { buildName, withApi, PiralPlugin } from 'piral-core';
+import { PiletTrackerApi } from './types';
+
+/**
+ * Available configuration options for the tracker plugin.
+ */
+export interface TrackerConfig {}
+
+/**
+ * Creates the Pilet API extension for activating tracker support.
+ */
+export function createTrackerApi(config: TrackerConfig = {}): PiralPlugin<PiletTrackerApi> {
+  return (context) => {
+    context.defineActions(actions);
+
+    return (api, target) => {
+      const pilet = target.name;
+      let next = 0;
+
+      return {
+        registerTracker(name, arg?) {
+          if (typeof name !== 'string') {
+            arg = name;
+            name = next++;
+          }
+
+          const id = buildName(pilet, name);
+          context.registerTracker(id, {
+            pilet,
+            component: withApi(context, arg, api, 'tracker'),
+          });
+          return () => api.unregisterTracker(name);
+        },
+        unregisterTracker(name) {
+          const id = buildName(pilet, name);
+          context.unregisterTracker(id);
+        },
+      };
+    };
+  };
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './create';
+export * from './Tracker';
+export * from './types';

package/src/types.ts

@@ -0,0 +1,77 @@
+import type {
+  Dict,
+  WrappedComponent,
+  BaseComponentProps,
+  AnyComponent,
+  BaseRegistration,
+  RegistrationDisposer,
+} from 'piral-core';
+
+declare module 'piral-core/lib/types/custom' {
+  interface PiletCustomApi extends PiletTrackerApi {}
+
+  interface PiralCustomActions {
+    /**
+     * Registers a new tracker.
+     * @param name The name of the tracker.
+     * @param value The registration data.
+     */
+    registerTracker(name: string, value: TrackerRegistration): void;
+    /**
+     * Unregisters an existing tracker.
+     * @param name The name of the tracker to be removed.
+     */
+    unregisterTracker(name: string): void;
+  }
+
+  interface PiralCustomRegistryState {
+    /**
+     * The registered trackers.
+     */
+    trackers: Dict<TrackerRegistration>;
+  }
+
+  interface PiralCustomErrors {
+    tracker: TrackerErrorInfoProps;
+  }
+}
+
+export interface TrackerErrorInfoProps {
+  /**
+   * The type of the error.
+   */
+  type: 'tracker';
+  /**
+   * The provided error details.
+   */
+  error: any;
+  /**
+   * The name of the pilet emitting the error.
+   */
+  pilet?: string;
+}
+
+export interface TrackerRegistration extends BaseRegistration {
+  component: WrappedComponent<BaseComponentProps>;
+}
+
+export interface PiletTrackerApi {
+  /**
+   * Registers a tracker component.
+   * The name has to be unique within the current pilet.
+   * @param name The name of the tracker.
+   * @param Component The component to be mounted permanently.
+   */
+  registerTracker(name: string, Component: AnyComponent<BaseComponentProps>): RegistrationDisposer;
+  /**
+   * Registers a tracker component.
+   * @param Component The component to be mounted permamently.
+   */
+  registerTracker(Component: AnyComponent<BaseComponentProps>): RegistrationDisposer;
+  /**
+   * Unregisters a tracker known by the given name.
+   * Only previously registered trackers can be unregistered.
+   * @param name The name of the tracker to unregister.
+   */
+  unregisterTracker(name: string): void;
+}