Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,6 @@ markdown-help/**

## downloaded assets models

*.mdsp.assetmodel/**
*.mdsp.assetmodel/**

url-migration-review.md
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## 4.0.0 - (unreleased)

- BREAKING CHANGE: Insights Hub URLs are migrating from the `mindsphere.io` domain to the new `siemens.app` scheme (work in progress on this branch). Version 4.0.0+ only works with the new `siemens.app` URLs - use the `3.x` release line if your tenant/gateway still uses `mindsphere.io` URLs.
- Bumped in-range dependencies and fixed resulting TypeScript strictness issues

## 3.24.2 - Coconut Vienna - June 2024

- Restored previous behavior for Billboard URLs in Event Management and Asset Management Client
Expand Down
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,14 @@

</p>

> [!WARNING]
> ### Breaking change starting with version 4.0.0
>
> Insights Hub URLs are migrating from the `mindsphere.io` domain to the new `siemens.app` scheme. **Version 4.0.0 and above only work with the new `siemens.app` URLs** and are **not compatible** with tenants/gateways still using the old `mindsphere.io` URLs.
>
> - If your tenant/gateway already uses the new `siemens.app` URLs, install `@mindconnect/mindconnect-nodejs@^4.0.0`.
> - If your tenant/gateway still uses the old `mindsphere.io` URLs, keep using `@mindconnect/mindconnect-nodejs@^3.0.0` (the `3.x` line will continue to work with the old URL scheme).

## Full documentation

The full documentation can be found at [https://developer.siemens.com/industrial-iot-open-source/mindconnect-nodejs/index.html](https://developer.siemens.com/industrial-iot-open-source/mindconnect-nodejs/index.html)
Expand All @@ -36,10 +44,12 @@ The full documentation can be found at [https://developer.siemens.com/industrial
There are several ways to install the library. The most common one is via npm registry:

```bash
# install the latest stable library from the npm registry
# install the latest stable library from the npm registry (v4+, requires the new siemens.app URL scheme)
npm install @mindconnect/mindconnect-nodejs --save
# install the latest alpha library from the npm registry
npm install @mindconnect/mindconnect-nodejs@alpha --save
# if your tenant/gateway still uses the old mindsphere.io URLs, install the 3.x line instead
npm install @mindconnect/mindconnect-nodejs@^3.0.0 --save
```

## Getting started
Expand Down Expand Up @@ -462,11 +472,11 @@ Linux, macOS: Rename the file to `mc` and make sure that the file is marked as e

### Configuring CLI

First step is to configure the CLI. For this you will need a session cookie from Insights Hub, service credentials (which have been deprecated) or application credentials from your developer cockpit.
First step is to configure the CLI. For this you will need a session cookie from Insights Hub, technical user credentials or application credentials from your developer cockpit.

- [SESSION and XSRF-TOKEN cookie](https://developer.mindsphere.io/howto/howto-local-development.html#generate-user-credentials)
- [Application Credentials](https://documentation.mindsphere.io/resources/html/developer-cockpit/en-US/124342231819.html)
- [Service Credentials](https://developer.mindsphere.io/howto/howto-selfhosted-api-access.html#creating-service-credentials)
- [Technical User Credentials](https://developer.mindsphere.io/howto/howto-selfhosted-api-access.html#creating-service-credentials)

First start the credentials configuration. This will start a web server on your local computer where you can enter the credentials.

Expand Down Expand Up @@ -585,7 +595,7 @@ Commands:

Documentation:

the magenta colored commands * use app or service credentials or borrowed mindsphere cookies
the magenta colored commands * use app or technical user credentials or borrowed mindsphere cookies
the cyan colored commands require mindconnectlib (agent) credentials
the blue colored commands @ use analytical functions of Insights Hub
the green colored commands # are used as setup and utility commands
Expand All @@ -601,7 +611,7 @@ at your local machine at

[http://localhost:7707](http://localhost:7707)

which will authenticate all requests using either [a borrowed SESSION and XSRF-TOKEN cookie from Insights Hub](https://developer.mindsphere.io/howto/howto-local-development.html#generate-user-credentials) or the the configured app credentials or service credentials.
which will authenticate all requests using either [a borrowed SESSION and XSRF-TOKEN cookie from Insights Hub](https://developer.mindsphere.io/howto/howto-local-development.html#generate-user-credentials) or the the configured app credentials or technical user credentials.

The command below will start your development proxy without any installation and configuration (you just need the cookies from an existing app):

Expand Down Expand Up @@ -636,7 +646,7 @@ Options:
Examples:

mc dev-proxy runs on default port (7707) using cookies
mc dev-proxy --port 7777 --passkey passkey runs on port 7777 using app/service credentials
mc dev-proxy --port 7777 --passkey passkey runs on port 7777 using app/technical user credentials

Configuration:

Expand Down
Loading