docs: FTL-18392 add READMEs and CONTRIBUTING (#4)

* fix: update .gitignore

* docs: add README and CONTRIBUTING

* docs: add README for AuthProvider

* fix: typo

.gitignore

@@ -1 +1,40 @@
-/vendor/
+# compiled output
+dist
+tmp
+/out-tsc
+
+# dependencies
+node_modules
+vendor
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# misc
+/.sass-cache
+/connect.lock
+/coverage
+/libpeerconnection.log
+npm-debug.log
+yarn-error.log
+testem.log
+/typings
+
+# System Files
+.DS_Store
+Thumbs.db
+
+.vscode

CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contributing to Affinidi TDK
+
+When contributing to this repository, please first discuss the change you wish to make by creating a new [GitHub issue](https://github.com/affinidi/affinidi-tdk-php/issues/new).
+
+Clients are generated intenally by Affinidi based on our API's. So, please don't update the client code and instead create an issue.
+
+## Contributing to libraries and packages
+
+### Requirements
+
+TBD
+
+### Creating a new library or package
+
+TBD
+
+Remember to update the [root README.md](/README.md) with the newly added module.
+
+### Building locally
+
+TBD
+
+### Code quality expectations
+
+1. Ensure the pipeline checks are finished successfully.
+2. Ensure the pull request doesn't contain redundant comments, logs, etc.
+3. Ensure your code is covered with unit and integration tests (NOTE: no mocks/stubs in integration tests).
+4. Avoid adding comments to explain what code does, code should be self-explanatory and clean.
+5. Avoid using variable names like `i` or abbreviations - names should be simple and unambiguous.
+
+## Auto update of versions and changelogs
+
+After merging PR, the GitHub actions publish all libs that have increased versions.
+The flow is:
+
+- if libs without internal dependencies were updated - process them first
+- if libs with internal dependencies were updated - update libs they depend on and update them
+- if TDK should be updated - update all libs TDK depends on and then update TDK
+
+More details in the code.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+- Avoiding obvious comments about things like code styling and indentation.
+  ** If you see yourself wanting to do that more than once - open an issue with a repo to update the ESLint/Prettier rules to address this concern once and for all. **Code reviews should be about logic, not indenting or adding more newlines**
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting

README.md

@@ -1 +1,131 @@
-# affinidi-tdk-php
+# Affinidi Trust Development Kit (Affinidi TDK)
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+The Affinidi Trust Development Kit (Affinidi TDK) is a modern interface that allows you to easily manage and integrate [Affinidi Elements](https://www.affinidi.com/product/affinidi-elements) and [Frameworks](https://www.affinidi.com/developer#lota-framework) into your application. It minimises dependencies and enables developers seamless entry into the [Affinidi Trust Network (ATN)](https://www.affinidi.com/get-started).
+
+## How do I use Affinidi TDK?
+
+The Affinidi TDK provides three type of modules:
+
+- [Clients](clients), which offer methods to access Affinidi Elements services like Credential Issuance, Credential Verification, and Login Configurations, among others.
+- [Packages](packages), which are commonly used utilities/helpers that are self-contained and composable.
+- [Libraries](libs), which are high-level abstractions that combine logic and data to perform necessary business logic functionalities.
+
+Each module has its own README that you can check to better understand how to integrate it into your application.
+
+## Documentation
+
+Head over to our [Documentation site](https://docs.affinidi.com/dev-tools/affinidi-tdk) to know how to get started with Affinidi TDK.
+
+Use [this document](https://docs.affinidi.com/dev-tools/affinidi-tdk/#working-with-the-affinidi-tdk) to learn more about how to work with Affinidi TDK, including generating the Authorisation Token and calling the methods.
+
+To learn how to integrate Affinidi TDK and use the different modules into your application, you can explore the following:
+
+- [Affinidi TDK Clients](https://docs.affinidi.com/dev-tools/affinidi-tdk/clients/)
+- [Affinidi TDK Libraries](https://docs.affinidi.com/dev-tools/affinidi-tdk/libraries/)
+- [Affinidi TDK Packages](https://docs.affinidi.com/dev-tools/affinidi-tdk/packages/)
+
+## Support & feedback
+
+If you face any issues or have suggestions, please don't hesitate to contact us using [this link](https://share.hsforms.com/1i-4HKZRXSsmENzXtPdIG4g8oa2v).
+
+### Reporting technical issues
+
+If you have a technical issue with the Affinidi TDK's codebase, you can also create an issue directly in GitHub.
+
+1. Ensure the bug was not already reported by searching on GitHub under
+   [Issues](https://github.com/affinidi/affinidi-tdk-php/issues).
+
+2. If you're unable to find an open issue addressing the problem,
+   [open a new one](https://github.com/affinidi/affinidi-tdk-php/issues/new).
+   Be sure to include a **title and clear description**, as much relevant information as possible,
+   and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+## Contributing
+
+Want to contribute?
+
+Head over to our [CONTRIBUTING](CONTRIBUTING.md) guidelines.
+
+## FAQ
+
+### What can I develop?
+
+You are only limited by your imagination! Affinidi TDK is a toolbox with which you can build software applications for personal or commercial use.
+
+### Is there anything I should not develop?
+
+We only provide the tools - how you use them is largely up to you. We have no control over what you develop with our tools - but please use our tools responsibly!
+
+We hope that you will not develop anything that contravenes any applicable laws or regulations. Your projects should also not infringe on Affinidi's or any third party's intellectual property (for instance, misusing other parties' data, code, logos, etc).
+
+### What responsibilities do I have to my end-users?
+
+Please ensure that you have in place your terms and conditions, privacy policies, and other safeguards to ensure that the projects you build are secure for your end users.
+
+If you are processing personal data, please protect the privacy and other legal rights of your end-users and store their personal or sensitive information securely.
+
+Some of our components would also require you to incorporate our end-user notices into your terms and conditions.
+
+### Is Affinidi TDK free for use?
+
+Affinidi TDK itself is free, so come onboard and experiment with our tools and see what you can build! We may bill for certain components in the future, but we will inform you beforehand.
+
+### Is there any limit or cap to my usage of the Affinidi TDK?
+
+We may from time to time impose limits on your use of the Affinidi TDK, such as limiting the number of API requests that you may make in a given duration. This is to ensure the smooth operation of the Affinidi TDK so that you and all our other users can have a pleasant experience as we continue to scale and improve the Affinidi TDK.
+
+### Do I need to provide you with anything?
+
+From time to time, we may request certain information from you to ensure that you are complying with the [Terms and Conditions](https://www.affinidi.com/terms-conditions).
+
+### Can I share my developer's account with others?
+
+When you create a developer's account with us, we will issue you your private login credentials. Please do not share this with anyone else, as you would be responsible for activities that happen under your account. If you have interested friends, ask them to sign up – let's build together!
+
+### Telemetry
+
+Affinidi collects usage data to improve our products and services. For information on what data we collect and how we use your data, please refer to our [Privacy Notice](https://www.affinidi.com/privacy-notice).
+
+_Disclaimer:
+Please note that this FAQ is provided for informational purposes only and is not to be considered a legal document. For the legal terms and conditions governing your use of the Affinidi Services, please refer to our [Terms and Conditions](https://www.affinidi.com/terms-conditions)._
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/maratsh"><img src="https://avatars.githubusercontent.com/u/533533?v=4?s=100" width="100px;" alt="maratsh"/><br /><sub><b>maratsh</b></sub></a><br /><a href="https://github.com/affinidi/affinidi-tdk/commits?author=maratsh" title="Code">💻</a> <a href="https://github.com/affinidi/affinidi-tdk/commits?author=maratsh" title="Documentation">📖</a> <a href="#example-maratsh" title="Examples">💡</a> <a href="#ideas-maratsh" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-maratsh" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#platform-maratsh" title="Packaging/porting to new platform">📦</a> <a href="#security-maratsh" title="Security">🛡️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/aeffinidi"><img src="https://avatars.githubusercontent.com/u/86773100?v=4?s=100" width="100px;" alt="aeffinidi"/><br /><sub><b>aeffinidi</b></sub></a><br /><a href="https://github.com/affinidi/affinidi-tdk/commits?author=aeffinidi" title="Code">💻</a> <a href="https://github.com/affinidi/affinidi-tdk/commits?author=aeffinidi" title="Documentation">📖</a> <a href="#example-aeffinidi" title="Examples">💡</a> <a href="#ideas-aeffinidi" title="Ideas, Planning, & Feedback">🤔</a> <a href="#tool-aeffinidi" title="Tools">🔧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/rbrazhnyk"><img src="https://avatars.githubusercontent.com/u/4462680?v=4?s=100" width="100px;" alt="Roman Brazhnyk"/><br /><sub><b>Roman Brazhnyk</b></sub></a><br /><a href="https://github.com/affinidi/affinidi-tdk/commits?author=rbrazhnyk" title="Code">💻</a> <a href="https://github.com/affinidi/affinidi-tdk/commits?author=rbrazhnyk" title="Documentation">📖</a> <a href="#ideas-rbrazhnyk" title="Ideas, Planning, & Feedback">🤔</a> <a href="#research-rbrazhnyk" title="Research">🔬</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/carlos-affinidi"><img src="https://avatars.githubusercontent.com/u/86779651?v=4?s=100" width="100px;" alt="Carlos Rincon"/><br /><sub><b>Carlos Rincon</b></sub></a><br /><a href="https://github.com/affinidi/affinidi-tdk/commits?author=carlos-affinidi" title="Code">💻</a> <a href="https://github.com/affinidi/affinidi-tdk/commits?author=carlos-affinidi" title="Documentation">📖</a> <a href="#ideas-carlos-affinidi" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-carlos-affinidi" title="Maintenance">🚧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Bergmam"><img src="https://avatars.githubusercontent.com/u/4987930?v=4?s=100" width="100px;" alt="Anton Bergman"/><br /><sub><b>Anton Bergman</b></sub></a><br /><a href="https://github.com/affinidi/affinidi-tdk/commits?author=Bergmam" title="Code">💻</a> <a href="https://github.com/affinidi/affinidi-tdk/commits?author=Bergmam" title="Documentation">📖</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/sureshaff"><img src="https://avatars.githubusercontent.com/u/170073177?v=4?s=100" width="100px;" alt="sureshaff"/><br /><sub><b>sureshaff</b></sub></a><br /><a href="#security-sureshaff" title="Security">🛡️</a></td>
+    </tr>
+  </tbody>
+  <tfoot>
+    <tr>
+      <td align="center" size="13px" colspan="7">
+        <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
+          <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
+        </img>
+      </td>
+    </tr>
+  </tfoot>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

src/AuthProvider/README.md

@@ -0,0 +1,52 @@
+# Affinidi TDK Internal module for managing access tokens.
+
+## Install
+
+```bash
+composer install affinidi-tdk/affinidi-tdk-php affinidi-tdk/wallets-client
+```
+
+## Usage
+
+```php
+<?php
+
+require_once 'vendor/autoload.php';
+
+use AuthProvider\AuthProvider;
+use AffinidiTdk\Clients\Wallets as WalletsClient;
+
+$params = [
+  'privateKey' => "",
+  // 'apiGatewayUrl' => 'https://apse1.api.affinidi.io',
+  // 'tokenEndpoint' => 'https://apse1.auth.developer.affinidi.io/auth/oauth2/token',
+  'keyId' => '',
+  'passphrase' => '',
+  'projectId' => '',
+  'tokenId' => ''
+];
+
+$authProvider = new AuthProvider($params);
+
+try {
+  $tokenCallback = [$authProvider, 'fetchProjectScopedToken'];
+
+  $configCwe = WalletsClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', '', $tokenCallback);
+
+  $apiInstanceCwe = new WalletsClient\Api\WalletApi(
+    new GuzzleHttp\Client(),
+    $configCwe
+  );
+
+  $apiInstanceCwe->listWallets();
+
+  $resultCwe = $apiInstanceCwe->listWallets();
+
+  $resultCweJson = json_decode($resultCwe, true);
+
+  print_r(count($resultCweJson['wallets']));
+
+} catch (Exception $e) {
+  print_r($e->getMessage());
+}
+```

src/libs/.gitkeep

@@ -0,0 +1 @@
+.gitkeep