@walkeros/web-destination-plausible 0.0.0-next-20251219153324

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 elbWalker GmbH
+
+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,65 @@
+<p align="left">
+  <a href="https://www.walkeros.io">
+    <img title="elbwalker" src="https://www.walkeros.io/img/elbwalker_logo.png" width="256px"/>
+  </a>
+</p>
+
+# Plausible Destination for walkerOS
+
+[Source Code](https://github.com/elbwalker/walkerOS/tree/main/packages/web/destinations/plausible)
+&bull;
+[NPM Package](https://www.npmjs.com/package/@walkeros/web-destination-plausible)
+
+This package provides a [Plausible Analytics](https://plausible.io/) destination
+for walkerOS. Plausible is a simple, and privacy-friendly Google Analytics
+Alternative.
+
+walkerOS follows a **source → collector → destination** architecture. This
+Plausible destination receives processed events from the walkerOS collector and
+transforms them into Plausible Analytics format, providing lightweight,
+privacy-focused web analytics without cookies or personal data collection.
+
+## Installation
+
+```sh
+npm install @walkeros/web-destination-plausible
+```
+
+## Usage
+
+Here's a basic example of how to use the Plausible destination:
+
+```typescript
+import { startFlow } from '@walkeros/collector';
+import { destinationPlausible } from '@walkeros/web-destination-plausible';
+
+await startFlow({
+  destinations: {
+    plausible: {
+      code: destinationPlausible,
+      config: {
+        settings: {
+          domain: 'walkeros.io', // Optional, domain of your site as registered
+        },
+      },
+    },
+  },
+});
+```
+
+## Configuration
+
+| Name     | Type     | Description                                        | Required | Example         |
+| -------- | -------- | -------------------------------------------------- | -------- | --------------- |
+| `domain` | `string` | The domain of your site as registered in Plausible | No       | `'walkeros.io'` |
+
+## Contribute
+
+Feel free to contribute by submitting an
+[issue](https://github.com/elbwalker/walkerOS/issues), starting a
+[discussion](https://github.com/elbwalker/walkerOS/discussions), or getting in
+[contact](https://calendly.com/elb-alexander/30min).
+
+## License
+
+This project is licensed under the MIT License.

package/dist/dev.d.mts

@@ -0,0 +1,94 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { z } from '@walkeros/core/dev';
+import { WalkerOS, Mapping as Mapping$2 } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+
+declare const SettingsSchema: z.ZodObject<{
+    domain: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type Settings = z.infer<typeof SettingsSchema>;
+
+/**
+ * Plausible Mapping Schema
+ * Plausible has no event-level mapping configuration
+ */
+declare const MappingSchema: z.ZodObject<{}, z.core.$strip>;
+/**
+ * Type inference from MappingSchema
+ */
+type Mapping$1 = z.infer<typeof MappingSchema>;
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping$1: _walkeros_core_dev.JSONSchema;
+
+declare const index$1_MappingSchema: typeof MappingSchema;
+type index$1_Settings = Settings;
+declare const index$1_SettingsSchema: typeof SettingsSchema;
+declare const index$1_settings: typeof settings;
+declare namespace index$1 {
+  export { type Mapping$1 as Mapping, index$1_MappingSchema as MappingSchema, type index$1_Settings as Settings, index$1_SettingsSchema as SettingsSchema, mapping$1 as mapping, index$1_settings as settings };
+}
+
+declare global {
+    interface Window {
+        plausible?: Plausible & {
+            q?: IArguments[];
+        };
+    }
+}
+type Plausible = (event: string, options?: {
+    props?: WalkerOS.AnyObject;
+}) => void;
+interface Mapping {
+}
+interface Env extends DestinationWeb.Env {
+    window: {
+        plausible: Plausible & {
+            q?: IArguments[];
+        };
+    };
+}
+type Rule = Mapping$2.Rule<Mapping>;
+
+declare const init: Env | undefined;
+declare const push: Env;
+
+declare const env_init: typeof init;
+declare const env_push: typeof push;
+declare namespace env {
+  export { env_init as init, env_push as push };
+}
+
+declare function purchase$1(): unknown[];
+declare function customEvent$1(): unknown[];
+
+declare namespace events {
+  export { customEvent$1 as customEvent, purchase$1 as purchase };
+}
+
+declare const customEvent: Rule;
+declare const purchase: Rule;
+declare const config: {
+    entity: {
+        action: Rule;
+    };
+    order: {
+        complete: Rule;
+    };
+};
+
+declare const mapping_config: typeof config;
+declare const mapping_customEvent: typeof customEvent;
+declare const mapping_purchase: typeof purchase;
+declare namespace mapping {
+  export { mapping_config as config, mapping_customEvent as customEvent, mapping_purchase as purchase };
+}
+
+declare const index_env: typeof env;
+declare const index_events: typeof events;
+declare const index_mapping: typeof mapping;
+declare namespace index {
+  export { index_env as env, index_events as events, index_mapping as mapping };
+}
+
+export { index as examples, index$1 as schemas };

package/dist/dev.d.ts

@@ -0,0 +1,94 @@
+import * as _walkeros_core_dev from '@walkeros/core/dev';
+import { z } from '@walkeros/core/dev';
+import { WalkerOS, Mapping as Mapping$2 } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+
+declare const SettingsSchema: z.ZodObject<{
+    domain: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type Settings = z.infer<typeof SettingsSchema>;
+
+/**
+ * Plausible Mapping Schema
+ * Plausible has no event-level mapping configuration
+ */
+declare const MappingSchema: z.ZodObject<{}, z.core.$strip>;
+/**
+ * Type inference from MappingSchema
+ */
+type Mapping$1 = z.infer<typeof MappingSchema>;
+
+declare const settings: _walkeros_core_dev.JSONSchema;
+declare const mapping$1: _walkeros_core_dev.JSONSchema;
+
+declare const index$1_MappingSchema: typeof MappingSchema;
+type index$1_Settings = Settings;
+declare const index$1_SettingsSchema: typeof SettingsSchema;
+declare const index$1_settings: typeof settings;
+declare namespace index$1 {
+  export { type Mapping$1 as Mapping, index$1_MappingSchema as MappingSchema, type index$1_Settings as Settings, index$1_SettingsSchema as SettingsSchema, mapping$1 as mapping, index$1_settings as settings };
+}
+
+declare global {
+    interface Window {
+        plausible?: Plausible & {
+            q?: IArguments[];
+        };
+    }
+}
+type Plausible = (event: string, options?: {
+    props?: WalkerOS.AnyObject;
+}) => void;
+interface Mapping {
+}
+interface Env extends DestinationWeb.Env {
+    window: {
+        plausible: Plausible & {
+            q?: IArguments[];
+        };
+    };
+}
+type Rule = Mapping$2.Rule<Mapping>;
+
+declare const init: Env | undefined;
+declare const push: Env;
+
+declare const env_init: typeof init;
+declare const env_push: typeof push;
+declare namespace env {
+  export { env_init as init, env_push as push };
+}
+
+declare function purchase$1(): unknown[];
+declare function customEvent$1(): unknown[];
+
+declare namespace events {
+  export { customEvent$1 as customEvent, purchase$1 as purchase };
+}
+
+declare const customEvent: Rule;
+declare const purchase: Rule;
+declare const config: {
+    entity: {
+        action: Rule;
+    };
+    order: {
+        complete: Rule;
+    };
+};
+
+declare const mapping_config: typeof config;
+declare const mapping_customEvent: typeof customEvent;
+declare const mapping_purchase: typeof purchase;
+declare namespace mapping {
+  export { mapping_config as config, mapping_customEvent as customEvent, mapping_purchase as purchase };
+}
+
+declare const index_env: typeof env;
+declare const index_events: typeof events;
+declare const index_mapping: typeof mapping;
+declare namespace index {
+  export { index_env as env, index_events as events, index_mapping as mapping };
+}
+
+export { index as examples, index$1 as schemas };