t1c-sdk-js

Trust1Connector JavaScript SDK

The Trust1Connector SDK (t1c-sdk-js), is a javascript library to facilitate the integration with the Trust1Connector. The library simplifies the execution to the connector and works asynchronously. This is version 3 of the library, and is intended to be used with Trust1Connector v3+. For previous versions (v1 and v2), please refer to: t1c-lib-js (v1/v2)

When the Trust1Connector isn’t installed the library will return an uninitialised client which can be used to download a client installer.

DOCUMENTATION

Documentation is available on gitbook.

Backward compatibility

The library will detect the installed version of Trust1Connector and will only function with version 3.0.0 and higher.

If you have version 1/2.x.x installed you have two options:

• Upgrade to version 3+ (recommended)
• Use an older version of the library by running:

$ npm i trust1connector@2.4.3

For security reasons v1 and v2 are deprecated

Community

We're present on Gitter in the following room: Trust1Connector-gitter

Development

Verify the dependencies, actual vs new versions

npm outdated

To build the library locally

yarn build-dev

This will create a T1CSdk.js in the dist folder

Installation - OSX Only

Make sure you have NodeJS installed on your machine. Use of Yarn is recommended but not required.

Webpack

Webpack is needed to build the Javascript library

$ npm install --global webpack

Dependencies

Navigate to the root directory and use Yarn to download and the necessary dependencies

$ yarn

OR

Use npm install

$ npm install

Run tests

Use npm run the test suite of the project

$ npm run test

Release

Prerequisite

• Have gren installed and add the token to your profile (https://github.com/github-tools/github-release-notes)

npm install github-release-notes

• Have the .npmrc file

Preparation

1. Create milestone on github with the name "Release x.y.z"
2. Create issues with the changes assigned to the milestone and close them
3. Create a release branch with the name "vx.y.z" with x.y.z being the version, starting from your feature branch
4. Merge the develop branch into the release branch
5. Increase version in package.json to x.y.z
6. Build TypeScript and JavaScript library
7. Finish the release branch and back-merge into develop and master
8. Push the branches
9. execute command "gren r -o" this will generate the changelog
10. publish to npm

Build and package

To build the TypeScript and JavaScript library, compressed:

$ yarn build-ts
$ yarn build-prod

Publish to NPM

To publish to NPM (public!), run the following NPM command:

$ npm publish

Note: This requires the correct .npmrc to be set. See documentation here.

License

This file is part of the Trust1Team(R) sarl project.
Copyright (c) 2020 Trust1Team sarl
Authors: Trust1Team development


This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License version 3
as published by the Free Software Foundation with the addition of the
following permission added to Section 15 as permitted in Section 7(a):
FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY Trust1T,
Trust1T DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.

This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program; if not, see http://www.gnu.org/licenses or write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA, 02110-1301 USA.

The interactive user interfaces in modified source and object code versions
of this program must display Appropriate Legal Notices, as required under
Section 5 of the GNU Affero General Public License.


You can be released from the requirements of the Affero General Public
License by purchasing a commercial license. Buying such a license is
mandatory if you wish to develop commercial activities involving the Trust1T
software without disclosing the source code of your own applications.
Examples of such activities include: offering paid services to customers as
an ASP, signing PDFs on the fly in a web application, shipping OCS with a
closed source product...
Irrespective of your choice of license, the T1T logo as depicted below may
not be removed from this file, or from any software or other product or
service to which it is applied, without the express prior written permission
of Trust1Team sarl.
The T1T logo is an EU Registered Trademark (n° 12943131).