Feat/readme

.gitignore

@@ -2,4 +2,5 @@ node_modules/
 .mesh/
 .vscode/
 .env
-dist/
+dist/
+*.tgz

.meshrc.yml

@@ -2,14 +2,17 @@ sources:
   - name: GatewaySDK
     handler:
       graphql:
-        endpoint: https://develop.protocol.mygateway.xyz/v1/graphql
+        endpoint: https://develop.protocol.mygateway.xyz/graphql
     transforms:
-      - filterSchema:
+      - rename:
           mode: bare
-          filters:
-            - Query.!transaction
-            - Query.!transactions
-            - Query.!myTransactions
+          renames:
+            - from:
+                type: PDAMetadata
+                field: status
+              to:
+                type: PDAMetadata
+                field: pdametadastatus
 
 customFetch: ./custom-fetch.ts
 

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+support@mygateway.xyz.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Gateway-DAO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,10 +1,156 @@
-![](https://raw.githubusercontent.com/Gateway-DAO/ui/main/apps/website/public/social.png)
+![](https://github.com/Gateway-DAO/network-ui/blob/develop/public/social.png)
 
-# ⚙️ Gateway Javascript SDK
+# Gateway Javascript SDK
 
-POC made using graphql mesh
+<!-- [![NPM version][npm-image]][npm-url]
+[![NPM downloads][downloads-image]][downloads-url]
+[![Build status][travis-image]][travis-url]
+[![Coverage Status][coveralls-image]][coveralls-url] -->
 
-## 🔧 Installation
+## Introduction
+
+A TypeScript SDK for the Gateway API. This library is built with TypeScript developers in mind, but it also works with JavaScript.
+
+**Note: This SDK is in beta and is not ready for production**
+
+### Features
+
+- Full type information for methods and responses.
+- Bearer Token Support
+- Supports Node.js 14+.
+
+## Installing
+
+```
+pnpm add @Gateway-dao-js-sdk
+```
+
+## Gateway Client
+
+To setup the gateway client we will authenticate with a bearer-token and a Api key as follows
+
+```typescript
+import { Gateway } from '@Gateway-dao-js-sdk';
+
+const gateway = new Gateway({
+  apiKey: 'your-api-key',
+  token: 'your-token',
+  url: '',
+});
+```
+
+This library supports Bearer Token along with Api Key. Do not share your authentication token with people you don’t trust. This gives the user control over your account and they will be able to manage PDAs (and more) with it. Use environment variables to keep it safe.
+
+## Examples
+
+Make sure to add try catch blocks around methods to catch all the validation and protocol based errors.
+
+### Creating a PDA
+
+```typescript
+import { Gateway, UserIdentifierType } from '@Gateway-dao-js-sdk';
+
+const gateway = new Gateway({ apiKey: 'your-api-key', token: 'your-token' });
+
+async function main() {
+  try {
+    let obj = {
+      dataModelId: 'uuid-here',
+      description: 'test',
+      title: 'test',
+      claim: {
+        gatewayUse: 'test',
+      },
+      owner: {
+        type: UserIdentifierType.GATEWAY_ID,
+        value: 'test',
+      },
+    };
+    const { createPDA } = await gateway.pda.createPDA(obj);
+  } catch (error) {
+    console.log(error); // Can log it for degugging
+  }
+}
+
+main();
+```
+
+### Getting a Organization
+
+```typescript
+import { Gateway } from '@Gateway-dao-js-sdk';
+
+const gateway = new Gateway({ apiKey: 'your-api-key', token: 'your-token' });
+
+async function main() {
+  try {
+    let obj = {
+      username: 'test_for_sdk_2',
+      name: 'test org sdk 2',
+      description: 'test organization',
+    };
+    const { createOrganization } =
+      await gateway.organization.createOrganization(obj);
+  } catch (error) {
+    console.log(error); // Can log it for degugging
+  }
+}
+
+main();
+```
+
+### Create a Data request template
+
+```typescript
+import { Gateway } from '@Gateway-dao-js-sdk';
+
+const gateway = new Gateway({ apiKey: 'your-api-key', token: 'your-token' });
+
+async function main() {
+  try {
+    const { createDataRequestTemplate } =
+      await gateway.dataRequestTemplate.createDataRequestTemplate({
+        title: 'Create Data Request Template Example',
+        description: 'Lorem ipsum dolor sit amet.',
+        dataModels: [
+          {
+            id: 'uuid-here',
+            required: true,
+            claimValidations: {
+              type: 'object',
+              properties: {
+                gatewayUse: {
+                  type: 'string',
+                },
+              },
+              required: ['gatewayUse'],
+            },
+          },
+        ],
+      });
+  } catch (error) {
+    console.log(error); // Can log it for degugging
+  }
+}
+
+main();
+```
+
+
+## Error Handling
+
+All the methods throw a validation error if the validation does not match for example:- invalid wallet, invalid uuid for all ids,
+Incase of any protocol errors we will throw a custom message which is a string which has all neccessary info regarding error.
+
+## License
+
+The Gateway Javascript SDK is licensed under the [MIT License](https://github.com/Gateway-DAO/javascript-sdk/blob/master/LICENSE).
+
+## Contributing
+
+If you want to support the active development of the SDK [Please talk to us on Discord](https://discord.gg/tgt3KjcHGs).Before contributing!.
+
+### 🔧 Installation
 
 1. Clone this repo
 
@@ -24,15 +170,16 @@ POC made using graphql mesh
    pnpm mesh build
    ```
 
-4. Replace the bearer token with yours in custom-fetch file
+4. Run test command to test sdk using jest
 
    ```sh
-   init.headers["Authorization"] =
-    "Bearer your-token";
+   pnpm test
    ```
 
-5. Run dev command to test sdk
-
-   ```sh
-   pnpm dev
-   ```
+[npm-image]: https://img.shields.io/npm/v/docusign-esign.svg?style=flat
+[npm-url]: https://npmjs.org/package/@Gateway-dao-js-sdk
+[downloads-image]: https://img.shields.io/npm/dm/docusign-esign.svg?style=flat
+[downloads-url]: https://npmjs.org/package/docusign-esign
+[coveralls-image]: https://coveralls.io/repos/github/docusign/@Gateway-dao-js-sdk/badge.svg?branch=master
+[coveralls-url]: https://coveralls.io/github/docusign/@Gateway-dao-js-sdk?branch=master
+[github-url]: https://github.com/Gateway-DAO/javascript-sdk

custom-fetch.ts

@@ -4,6 +4,7 @@ import { MeshContext } from '@graphql-mesh/runtime';
 type ContextModified = MeshContext & {
   token: string;
   apiKey: string;
+  url: string;
 };
 
 export default function patchedFetch(
@@ -20,5 +21,5 @@ export default function patchedFetch(
   headers.set('Authorization', `Bearer ${context?.token}`);
   headers.set('X-Api-Key', context?.apiKey);
   init.headers = headers;
-  return fetch(url, init);
+  return fetch(context?.url || url, init);
 }