From 80bbb55661569f8146d8805acc294c1f501aa158 Mon Sep 17 00:00:00 2001 From: Ruben Izmailyan Date: Thu, 19 Dec 2024 17:47:51 -0600 Subject: [PATCH 1/2] Improve package.json --- packages/core/package.json | 6 ++++++ packages/react-native/package.json | 7 +++++++ packages/react/package.json | 7 +++++++ 3 files changed, 20 insertions(+) diff --git a/packages/core/package.json b/packages/core/package.json index 8bd49f1..547fbfa 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -10,6 +10,9 @@ "directory": "packages/core" }, "license": "MIT", + "bugs": { + "url": "https://github.com/quiltt/quiltt-js/issues" + }, "sideEffects": [], "type": "module", "exports": { @@ -44,6 +47,9 @@ "rimraf": "6.0.1", "typescript": "5.7.2" }, + "tags": [ + "quiltt" + ], "publishConfig": { "access": "public" } diff --git a/packages/react-native/package.json b/packages/react-native/package.json index e047454..6ef7c95 100644 --- a/packages/react-native/package.json +++ b/packages/react-native/package.json @@ -9,6 +9,9 @@ "directory": "packages/react-native" }, "license": "MIT", + "bugs": { + "url": "https://github.com/quiltt/quiltt-js/issues" + }, "type": "module", "exports": { ".": { @@ -55,6 +58,10 @@ "react-native-url-polyfill": "^2.0.0", "react-native-webview": ">=13.0.0" }, + "tags": [ + "quiltt", + "react-native" + ], "publishConfig": { "access": "public" } diff --git a/packages/react/package.json b/packages/react/package.json index f5150da..456ba1a 100644 --- a/packages/react/package.json +++ b/packages/react/package.json @@ -10,6 +10,9 @@ "directory": "packages/react" }, "license": "MIT", + "bugs": { + "url": "https://github.com/quiltt/quiltt-js/issues" + }, "sideEffects": [], "type": "module", "exports": { @@ -46,6 +49,10 @@ "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0", "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0" }, + "tags": [ + "quiltt", + "react" + ], "publishConfig": { "access": "public" } From 8c15d9ee7b7c65fdfb9254ee71001cd10912035d Mon Sep 17 00:00:00 2001 From: Ruben Izmailyan Date: Thu, 19 Dec 2024 17:48:22 -0600 Subject: [PATCH 2/2] Improve READMEs --- packages/core/README.md | 14 ++++++++++-- packages/react-native/README.md | 34 ++++++++++++++++++++++-------- packages/react-native/package.json | 2 +- packages/react/README.md | 24 +++++++++++++++------ packages/react/package.json | 2 +- 5 files changed, 57 insertions(+), 19 deletions(-) diff --git a/packages/core/README.md b/packages/core/README.md index 9d45e8a..5d6237a 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -7,11 +7,21 @@ ## Install +With `npm`: + ```shell $ npm install @quiltt/core -# or +``` + +With `yarn`: + +```shell $ yarn add @quiltt/core -# or +``` + +With `pnpm`: + +```shell $ pnpm add @quiltt/core ``` diff --git a/packages/react-native/README.md b/packages/react-native/README.md index 1f98309..f3a94fb 100644 --- a/packages/react-native/README.md +++ b/packages/react-native/README.md @@ -9,20 +9,31 @@ `@quiltt/react-native` expects `react`, `react-native`,`react-native-webview`, `base-64` and `react-native-url-polyfill` as peer dependencies. +With `npm`: + ```shell $ npm install base-64 react-native-webview react-native-url-polyfill $ npm install @quiltt/react-native -# or +``` + +With `yarn`: + +```shell $ yarn add base-64 react-native-webview react-native-url-polyfill $ yarn add @quiltt/react-native -# or -# Please note that you will need to add `node-linker=hoisted` in `.npmrc` if you are using pnpm in expo app.` +``` + +With `pnpm`: + +```shell +# Make sure to add `node-linker=hoisted` to your `.npmrc` when using pnpm in an Expo app. $ pnpm add base-64 react-native-webview react-native-url-polyfill $ pnpm add @quiltt/react-native ``` ## Documentation -For SDK documentation and more code examples, see the [React Native guide](https://www.quiltt.dev/connector/sdk/react-native). + +For full SDK documentation and more code examples, see the Connector [React Native guide](https://www.quiltt.dev/connector/sdk/react-native). ### QuilttConnector @@ -35,23 +46,28 @@ Launch the [Quiltt Connector](https://www.quiltt.dev/connector) in a webview. ```tsx import { QuilttProvider } from '@quiltt/react' import { QuilttConnector } from '@quiltt/react-native' +import type { ConnectorSDKCallbackMetadata } from '@quiltt/react' export const App = () => { // See: https://www.quiltt.dev/authentication/issuing-session-tokens const sessionToken = '' - const oAuthRedirectUrl = 'quilttexample://open.reactnative.app' - const handleExitSuccess = (metadata) => { - console.log('Successfully created connection!', metadata) + // Use a universal link or deep link to redirect back to your app + const oauthRedirectUrl = 'https://myapp.com/my_universal_link' + + const handleExitSuccess = (metadata: ConnectorSDKCallbackMetadata) => { + console.log('Successfully created connection!', { + connectionId: metadata.connectionId, + }) } return ( diff --git a/packages/react-native/package.json b/packages/react-native/package.json index 6ef7c95..40b198a 100644 --- a/packages/react-native/package.json +++ b/packages/react-native/package.json @@ -1,7 +1,7 @@ { "name": "@quiltt/react-native", "version": "3.9.1", - "description": "React Native components for Quiltt Connector", + "description": "React Native Components for Quiltt Connector", "homepage": "https://github.com/quiltt/quiltt-js/tree/main/packages/react-native#readme", "repository": { "type": "git", diff --git a/packages/react/README.md b/packages/react/README.md index 562e397..5823785 100644 --- a/packages/react/README.md +++ b/packages/react/README.md @@ -9,17 +9,27 @@ See the guides [here](https://www.quiltt.dev/connector/sdks/react). ## Installation +With `npm`: + ```shell $ npm install @quiltt/react -# or +``` + +With `yarn`: + +```shell $ yarn add @quiltt/react -# or +``` + +With `pnpm`: + +```shell $ pnpm add @quiltt/react ``` ## Core Modules and Types -The `@quiltt/react` library ships with `@quiltt/core`, which provides an Auth API and essential functionality for building Javascript-based applications with Quiltt. See the [Core README](../core/README.md) for more information. +The `@quiltt/react` library ships with `@quiltt/core`, which provides an API clients and essential functionality for building Javascript-based applications with Quiltt. See the [Core README](../core/README.md) for more information. ## React Components @@ -38,10 +48,11 @@ By default, the rendered component will be a `