Skip to content

Commit

Permalink
client to source
Browse files Browse the repository at this point in the history
  • Loading branch information
alexanderkirtzel committed Nov 20, 2024
1 parent c4125b3 commit 2718018
Show file tree
Hide file tree
Showing 10 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion packages/destinations/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ data collection with the actual integration of external tools.

Destinations in walkerOS act as connections, channeling data to appropriate
tools and platforms. They ensure data is mapped and shared effectively,
functioning in tandem with walkerOS clients.
functioning in tandem with walkerOS sources.

## Types of Destinations

Expand Down
2 changes: 1 addition & 1 deletion packages/destinations/node/bigquery/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ for companies looking to centralize their data collection and analysis efforts.

Before using the BigQuery destination, ensure you have:

- walkerOS node client
- walkerOS source node
- Google Cloud Platform account
- BigQuery dataset and table
- GCP service account with permissions to write to the events table
2 changes: 1 addition & 1 deletion packages/destinations/node/etag/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# etag node destination for walkerOS

Made to be used with
[node client](https://www.npmjs.com/package/@elbwalker/source-node) from
[source node](https://www.npmjs.com/package/@elbwalker/source-node) from
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
Expand Down
2 changes: 1 addition & 1 deletion packages/destinations/node/meta/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Meta Conversion API (CAPI) destination for walkerOS

Made to be used with
[node-client](https://www.npmjs.com/package/@elbwalker/source-node) from
[source node](https://www.npmjs.com/package/@elbwalker/source-node) from
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
Expand Down
16 changes: 8 additions & 8 deletions packages/sources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,16 @@
</a>
</p>

# walkerOS Clients - Event Collection
# walkerOS Sources - Event Collection

The walkerOS clients serve as the **data creation** and **state management**
The walkerOS sources serve as the **data creation** and **state management**
layer of your walkerOS infrastructure. Whether you're working on a server-side
application with Node.js or a client-side web application, walkerOS clients have
application with Node.js or a client-side web application, walkerOS sources have
got you covered.

## What Are Clients?
## What Are Sources?

Clients work at the beginning of your data collection journey. They:
Sources work at the beginning of your data collection journey. They:

- **Event Creation**: Easily create and format user events.
- **State Management**: Maintain user and session states across events.
Expand All @@ -22,11 +22,11 @@ Clients work at the beginning of your data collection journey. They:
- **Dynamic Destinations**: Add or remove data destinations dynamically.

> Learn more in the
> [Clients documentation](https://www.elbwalker.com/docs/clients/)
> [Sources documentation](https://www.elbwalker.com/docs/sources/)
A **previous step** is the
[tagging](https://www.elbwalker.com/docs/clients/walkerjs/tagging/) of a page in
the web or [pushing](https://www.elbwalker.com/docs/clients/node#push) in you
[tagging](https://www.elbwalker.com/docs/sources/walkerjs/tagging/) of a page in
the web or [pushing](https://www.elbwalker.com/docs/sources/node#push) in you
app.

The **next step** is to push events to a
Expand Down
2 changes: 1 addition & 1 deletion packages/sources/gcp/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# GCP source for walkerOS

Made to be used with
[node client](https://www.npmjs.com/package/@elbwalker/source-node) from
[source node](https://www.npmjs.com/package/@elbwalker/source-node) from
[walkerOS](https://github.com/elbwalker/walkerOS).

More detailed information and examples can be found in the
Expand Down
2 changes: 1 addition & 1 deletion packages/stacks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ infrastructure, giving you complete control over data ingestion and processing.

Stacks are essentially the backbones of your data collection journey. They:

- **Receive Events**: Capture incoming data from clients.
- **Receive Events**: Capture incoming data from sources.
- **Validate Data**: Ensure the data conforms to your specified formats.
- **Process Events**: Enrich, transform, or filter the data as needed.
- **Route Data**: Send the processed data to its final destination.
Expand Down
10 changes: 5 additions & 5 deletions packages/stacks/firebase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ maintain.
## Features

- **Event Reception**: Receives incoming events from walkerOS
[clients](../../clients/).
[sources](../../sources/).
- **Data Validation**: Ensures incoming data meets your predefined schemas.
- **Event Processing**: Enriches and transforms data before sending it to its
final destination.
Expand Down Expand Up @@ -56,13 +56,13 @@ The config is optional and supports the following settings:
```ts
// See type FirebaseStack.PartialConfig
const customConfig = {
client: {}, // See SourceNode.PartialConfig from node-client
client: {}, // See SourceNode.PartialConfig from source-node
firebase: {}, // See AppOptions from firebase-admin
};
```

The `client` object configures the in-built node-client where you can define a
name, destination settings, globals, contracs, etc.
The `client` object configures the in-built node source where you can define a
name, destination settings, globals, contracts, etc.

The `firebase` object are the original `AppOptions` from the official firebase
SDK. Specify credentials, a projectId, or other setting.
Expand All @@ -83,5 +83,5 @@ Start sending events to the endpoint.
## Requirements

- Firebase project
- walkerOS [client](../../clients/) with an
- walkerOS [sources](../../sources/) with an
[API destination](../../destinations/)
2 changes: 1 addition & 1 deletion packages/stacks/firebase/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ const pushFn: SourceNode.PrependInstance<FirebaseStack.Push> = (
options = {},
) => {
return onRequest(options, async (req, res) => {
// ATTENTION! Never process unknown data from the client
// ATTENTION! Never process unknown data from sources

// @TODO add a custom response handler
// @TODO move validation to the client
Expand Down
2 changes: 1 addition & 1 deletion packages/stacks/gtm/tag_template.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ ___TEMPLATE_PARAMETERS___
}
],
"newRowButtonText": "Add Hook",
"help": "Hooks can be used to customize the default behavior of the walker.js. Three hooks are available: Push, DestinationInit, and DestinationPush. Hooks allows for validation, manipulation, or even eventual cancellation of default behavior. \u003ca href\u003d\"https://www.elbwalker.com/docs/clients/walkerjs/commands#hooks\"\u003eRead more about hooks\u003c/a\u003e."
"help": "Hooks can be used to customize the default behavior of the walker.js. Three hooks are available: Push, DestinationInit, and DestinationPush. Hooks allows for validation, manipulation, or even eventual cancellation of default behavior. \u003ca href\u003d\"https://www.elbwalker.com/docs/sources/walkerjs/commands#hooks\"\u003eRead more about hooks\u003c/a\u003e."
}
]
}
Expand Down

0 comments on commit 2718018

Please sign in to comment.