Skip to content

Commit a012f16

Browse files
author
Daniel Spitzer
committed
refactor: Renamed to ts.io
Renamed all mentions of `ts.talk` to `ts.io` BREAKING CHANGE: New namespace
1 parent e11f0d8 commit a012f16

24 files changed

+89
-195
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A clear and concise description of what the bug is.
1010
**To Reproduce**
1111
Code or link to code to reproduce the behavior:
1212
```
13-
const app = ts.talk();
13+
const app = ts.io();
1414
app.doSomething();
1515
```
1616

.github/ts.talk.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

LICENSE.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,73 @@
11
**TL;DR**
22

33
- You can always create forks on GitHub, submit Issues and Pull Requests.
4-
- You can only use ts.talk to make apps on a Tradeshift platform, e.g. tradeshift.com.
4+
- You can only use ts.io to make apps on a Tradeshift platform, e.g. tradeshift.com.
55
- You can fix a bug until the bugfix is deployed by Tradeshift.
6-
- You can host ts.talk yourself.
6+
- You can host ts.io yourself.
77
- If you want to make a bigger change or just want to talk with us, reach out to our team here on GitHub.
88

99
_Disclaimer: This is only a short summary of the license agreement, it is not legal advice._
1010

1111
---
1212

13-
### LICENCE AGREEMENT FOR USE OF TRADESHIFT’S APP MESSAGING LIBRARY (TALK) SOURCE CODE
13+
### LICENCE AGREEMENT FOR USE OF TRADESHIFT’S APP MESSAGING LIBRARY (ts.io) SOURCE CODE
1414

1515
#### `1.` SCOPE
1616

17-
`1.1` These licence terms are related to your use of Porta Holdings Ltd.’ (hereinafter “Tradeshift”) App Messaging Library (hereinafter “ts.talk”) and apply with regard to all conditions concerning your use of ts.talk.
17+
`1.1` These licence terms are related to your use of Porta Holdings Ltd.’ (hereinafter “Tradeshift”) App Messaging Library (hereinafter “ts.io”) and apply with regard to all conditions concerning your use of ts.io.
1818

19-
`1.2` If you use ts.talk, you are obligated to accept these licence terms. In return, the use is free of charge. If you cannot accept these licence terms, you are not entitled to use ts.talk.
19+
`1.2` If you use ts.io, you are obligated to accept these licence terms. In return, the use is free of charge. If you cannot accept these licence terms, you are not entitled to use ts.io.
2020

2121
#### `2.` YOUR USE
2222

23-
`2.1` By accepting these licence terms, Tradeshift provides you a right of use to ts.talk for an indefinite period of time. The right of use is free of charge.
23+
`2.1` By accepting these licence terms, Tradeshift provides you a right of use to ts.io for an indefinite period of time. The right of use is free of charge.
2424

25-
`2.2` Tradeshift is an e-invoice network that offers solutions for procurement, spend management and business travel. The purpose of licensing ts.talk is to disseminate the User Interface of Tradeshift in order to enable and invite third parties to develop Tradeshift based commercial and non-commercial apps through usage of the strong and recognisable user interface, beneficial for all parties involved.
25+
`2.2` Tradeshift is an e-invoice network that offers solutions for procurement, spend management and business travel. The purpose of licensing ts.io is to disseminate the User Interface of Tradeshift in order to enable and invite third parties to develop Tradeshift based commercial and non-commercial apps through usage of the strong and recognisable user interface, beneficial for all parties involved.
2626

27-
`2.3` The right of use consists of a worldwide, non-exclusive, non-licensable, non-transferable, royalty-free, revocable right to use ts.talk in connection with developing Tradeshift Apps for a commercial or non-commercial purpose. The use cannot be for any other commercial or non-commercial purpose.
27+
`2.3` The right of use consists of a worldwide, non-exclusive, non-licensable, non-transferable, royalty-free, revocable right to use ts.io in connection with developing Tradeshift Apps for a commercial or non-commercial purpose. The use cannot be for any other commercial or non-commercial purpose.
2828

29-
`2.4` The permitted use is including creation of forks, submission of issues and pulling of requests on GitHub. The right of use also includes hosting ts.talk yourself.
29+
`2.4` The permitted use is including creation of forks, submission of issues and pulling of requests on GitHub. The right of use also includes hosting ts.io yourself.
3030

3131
#### `3.` ALTERATIONS
3232

33-
`3.1` You may not modify or fork ts.talk unless it is necessary to fix a bug.
33+
`3.1` You may not modify or fork ts.io unless it is necessary to fix a bug.
3434

35-
`3.2` If you modify ts.talk in order to fix a bug, you must notify Tradeshift through GitHub.
35+
`3.2` If you modify ts.io in order to fix a bug, you must notify Tradeshift through GitHub.
3636

37-
`3.3` If you modify ts.talk in order to fix bug(s), you are allowed to use open source code(s) to fix the bug as long as the licence of the used open source code(s) does not conflict with this licence agreement, including, but not limited to limiting the intellectual property rights of the open source code(s).
37+
`3.3` If you modify ts.io in order to fix bug(s), you are allowed to use open source code(s) to fix the bug as long as the licence of the used open source code(s) does not conflict with this licence agreement, including, but not limited to limiting the intellectual property rights of the open source code(s).
3838

39-
`3.4` You may never modify ts.talk in such a way that the recognisability disappears; this includes, without limitation, removal of logo.
39+
`3.4` You may never modify ts.io in such a way that the recognisability disappears; this includes, without limitation, removal of logo.
4040

41-
`3.5` You may use the modified ts.talk only as long as Tradeshift explicitly recognises this as a bug and has not yet provided a fix or workaround. Once the bug in ts.talk has been fixed by Tradeshift or a workaround in ts.talk has been made by Tradeshift, you are obligated to use the fixed ts.talk and refrain from using any other modified versions of ts.talk that are not deployed by Tradeshift.
41+
`3.5` You may use the modified ts.io only as long as Tradeshift explicitly recognises this as a bug and has not yet provided a fix or workaround. Once the bug in ts.io has been fixed by Tradeshift or a workaround in ts.io has been made by Tradeshift, you are obligated to use the fixed ts.io and refrain from using any other modified versions of ts.io that are not deployed by Tradeshift.
4242

4343
#### `4.` INTELLECTUAL PROPERTY RIGHTS
4444

45-
`4.1` Tradeshift retains ownership of ts.talk and all the hereto related intellectual property rights, including but not limited to copyrights and trademark rights. However, this licence is granted to you to enable the permitted use of ts.talk, according to this agreement.
45+
`4.1` Tradeshift retains ownership of ts.io and all the hereto related intellectual property rights, including but not limited to copyrights and trademark rights. However, this licence is granted to you to enable the permitted use of ts.io, according to this agreement.
4646

4747
`4.2` Intellectual property rights related to your alterations, see section 3 above, are also retained by and/or transferred to Tradeshift and you do not acquire any intellectual property rights in these instances, apart from necessary licence to enable the permitted use of the altered UI Code according to this agreement.
4848

4949
#### `5.` VIOLATION OF THIRD PARTY RIGHTS
5050

51-
`5.1` You are liable for your use of ts.talk in relations to violation of any third party rights. In relation to you, Tradeshift is liable to the extent that ts.talk itself, apart from the alterations, does not infringe any intellectual property rights of a third party. You are liable for ensuring that your alterations do not violate any third party rights, including but not limited to third party intellectual property rights.
51+
`5.1` You are liable for your use of ts.io in relations to violation of any third party rights. In relation to you, Tradeshift is liable to the extent that ts.io itself, apart from the alterations, does not infringe any intellectual property rights of a third party. You are liable for ensuring that your alterations do not violate any third party rights, including but not limited to third party intellectual property rights.
5252

53-
`5.2` If a lawsuit is filed against you concerning your use of ts.talk, where it is claimed that your use violates third party rights, you shall immediately inform Tradeshift of this. Tradeshift will at its own discretion and within reasonable time hereafter inform you, whether Tradeshift will take over the case. In case Tradeshift chooses to take over the case, you will give Tradeshift an irrevocable power of attorney, at Tradeshift’s own account, to conduct the case and/or enter into a settlement concerned the alleged violations.
53+
`5.2` If a lawsuit is filed against you concerning your use of ts.io, where it is claimed that your use violates third party rights, you shall immediately inform Tradeshift of this. Tradeshift will at its own discretion and within reasonable time hereafter inform you, whether Tradeshift will take over the case. In case Tradeshift chooses to take over the case, you will give Tradeshift an irrevocable power of attorney, at Tradeshift’s own account, to conduct the case and/or enter into a settlement concerned the alleged violations.
5454

55-
`5.3` In case a judgment is passed in accordance with the claim of the third party in question, Tradeshift is entitled to at its own choice either 1) to provide you with a right to use ts.talk continuously, 2) to put an end to the violation by changing or replacing the Code by new code, which in essence has the same functionality as ts.talk, or 3) to cancel this licence agreement with immediate effect and without reimbursement. No matter which of the above measures Tradeshift chooses to take, you cannot raise other or further claims against Tradeshift.
55+
`5.3` In case a judgment is passed in accordance with the claim of the third party in question, Tradeshift is entitled to at its own choice either 1) to provide you with a right to use ts.io continuously, 2) to put an end to the violation by changing or replacing the Code by new code, which in essence has the same functionality as ts.io, or 3) to cancel this licence agreement with immediate effect and without reimbursement. No matter which of the above measures Tradeshift chooses to take, you cannot raise other or further claims against Tradeshift.
5656

5757
#### `6.` LIABILITY AND LIMITATION OF LIABILITY
5858

59-
`6.1` As this agreement concerns a product under development and has been offered to you free of charge, compared to the development and production costs, Tradeshift disclaims any liability for direct as well as indirect loss and consequential damage in connection with your use of ts.talk or loss as a consequence of irregularities or lack of functions in ts.talk, regardless of whether Tradeshift has been informed about the possibility for such a loss and regardless of whether Tradeshift is approached for the loss due to negligence or similar.
59+
`6.1` As this agreement concerns a product under development and has been offered to you free of charge, compared to the development and production costs, Tradeshift disclaims any liability for direct as well as indirect loss and consequential damage in connection with your use of ts.io or loss as a consequence of irregularities or lack of functions in ts.io, regardless of whether Tradeshift has been informed about the possibility for such a loss and regardless of whether Tradeshift is approached for the loss due to negligence or similar.
6060

61-
`6.2` You are liable, without limitation, for your use of ts.talk, including any use of alterations in ts.talk, see further section 7.
61+
`6.2` You are liable, without limitation, for your use of ts.io, including any use of alterations in ts.io, see further section 7.
6262

63-
`6.3` In case Tradeshift irrespective of the above might become liable, Tradeshift’s total liability for loss or damage is limited to DKK 5,000. In addition to this, Tradeshift can never be liable for faults or defects which are unrelated to ts.talk.
63+
`6.3` In case Tradeshift irrespective of the above might become liable, Tradeshift’s total liability for loss or damage is limited to DKK 5,000. In addition to this, Tradeshift can never be liable for faults or defects which are unrelated to ts.io.
6464

6565
#### `7.` BREACH
6666

67-
`7.1` If you do not comply with the present licence terms and thereby are in breach of your obligations in accordance with these licence terms, your rights in accordance with these licence terms are terminated with immediate effect and you are obligated, without any right of reimbursement, to stop usage of ts.talk, including any back-ups with related documentation. In addition to this, the general rules of Danish law will apply.
67+
`7.1` If you do not comply with the present licence terms and thereby are in breach of your obligations in accordance with these licence terms, your rights in accordance with these licence terms are terminated with immediate effect and you are obligated, without any right of reimbursement, to stop usage of ts.io, including any back-ups with related documentation. In addition to this, the general rules of Danish law will apply.
6868

6969
#### `8.` CHOICE OF LAW AND VENUE
7070

71-
`8.1` Your use of ts.talk and these licence terms are subject to Danish law. Any dispute which may originate from these licence terms or your use of ts.talk shall be subject to the Danish courts with venue at Tradeshift’s registered office in Denmark.
71+
`8.1` Your use of ts.io and these licence terms are subject to Danish law. Any dispute which may originate from these licence terms or your use of ts.io shall be subject to the Danish courts with venue at Tradeshift’s registered office in Denmark.
7272

7373
_Copenhagen, July 2018_

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
[![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url]
22

3-
[travis-image]: https://travis-ci.org/Tradeshift/talk.svg?branch=master
4-
[travis-url]: https://travis-ci.org/Tradeshift/talk
5-
[npm-image]: https://img.shields.io/npm/v/@tradeshift/talk.svg
6-
[npm-url]: https://npmjs.org/package/@tradeshift/talk
3+
[travis-image]: https://travis-ci.org/Tradeshift/io.svg?branch=master
4+
[travis-url]: https://travis-ci.org/Tradeshift/io
5+
[npm-image]: https://img.shields.io/npm/v/@tradeshift/io.svg
6+
[npm-url]: https://npmjs.org/package/@tradeshift/io
77

8-
<div align="center"><img src="https://raw.githubusercontent.com/Tradeshift/talk/master/.github/ts.talk.svg?sanitize=true" width="50%" alt="ts.talk" /></div>
9-
10-
# `ts.talk`
8+
# `ts.io`
119

1210
## Tradeshift App Messaging Library
1311

@@ -25,16 +23,16 @@ This is the standard way for apps on the client-side of the Tradeshift Platform
2523
- The Tradeshift® Chrome™ keeps track of all apps and decides which ones have access to which ones.
2624
- Spawned iframes can only communicate with their spawner and their own spawnees and `Tradeshift.Chrome`.
2725

28-
## `ts.talk` API reference (quick overview)
26+
## `ts.io` API reference (quick overview)
2927

3028
### In the frame/window of Tradeshift® Apps™
3129

3230
```js
3331
const ts = ts || {};
34-
ts.talk = require('@tradeshift/tradeshift-app');
32+
ts.io = require('@tradeshift/io');
3533

3634
// Create App (a client) and connect to Hub (The Broker)
37-
const app = ts.talk();
35+
const app = ts.io();
3836

3937
// Listen to incoming messages
4038
/*
@@ -97,10 +95,10 @@ try {
9795

9896
```js
9997
// Create App (a client) and connect to Hub (The Broker)
100-
const spawnedClient = ts.talk();
98+
const spawnedClient = ts.io();
10199
spawnedClient.on((msg, resolve, reject) => {
102100
// Listen to incoming messages
103-
if (msg.topic === ts.talk.TOPIC_SPAWN) {
101+
if (msg.topic === ts.io.TOPIC_SPAWN) {
104102
// Do stuff here to open the panel with some fancy animation
105103
// ...
106104
// Wait for user input
@@ -113,7 +111,7 @@ spawnedClient.on((msg, resolve, reject) => {
113111
// Either close the window automatically here
114112
// or...
115113
}
116-
if (msg.topic === ts.talk.TOPIC_UNSPAWN) {
114+
if (msg.topic === ts.io.TOPIC_UNSPAWN) {
117115
// Wait for this message to close the window.
118116
/**
119117
* NOTE!
@@ -130,10 +128,10 @@ spawnedClient.on((msg, resolve, reject) => {
130128

131129
```js
132130
const ts = ts || {};
133-
ts.talk = require('@tradeshift/talk');
131+
ts.io = require('@tradeshift/io');
134132

135133
// Create Hub (The Broker)
136-
const hub = ts.talk({
134+
const hub = ts.io({
137135
appIdByWindow: win => {
138136
// Return appId based on a Window object.
139137
// Used for identifying new Apps (clients).
Lines changed: 7 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/ts.io-cjs.js.map

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)