@useparagon/connect 1.0.1 → 1.0.3-experimental.2

package/.github/pull_request_template.md

@@ -0,0 +1,43 @@
+<!--
+How to use this template:
+
+1. Fill out sections that make sense.
+2. Delete sections that are not relevant.
+ -->
+
+### Issues Closed
+
+- <!-- issue_number -->
+
+### Summary
+
+<!--
+WHAT did you do? WHY did you do it?
+-->
+
+### Changes
+
+<!--
+- change #1
+- change #2
+-->
+
+### Unrelated Changes
+
+<!-- did anything not detailed in the related issues get updated? -->
+
+### Configuration Changes
+
+<!-- do we need to update any configs? -->
+
+### Future Work
+
+<!-- how can this be improved? -->
+
+### Steps to Test
+
+<!-- how do we test this? -->
+
+### Screenshots
+
+<!-- show your work -->

package/.github/workflows/build.yaml

@@ -0,0 +1,133 @@
+## ---------------------------------------------------
+##     |\---/|                                       
+##     | ,_, |               !! DO NOT MODIFY !!      
+##      \_`_/-..----.    file managed by `whiskers`  
+##   ___/ `   ' ,""+ \                              
+##  (__...'   __\    |`.___.';                       
+##    (_,...'(_,.`__)/'.....+                         
+## ---------------------------------------------------
+
+name: build
+
+on:
+  pull_request: {}
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: build
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: git > checkout
+        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c
+        with:
+          clean: true
+          fetch-depth: 1
+
+      - name: node > setup
+        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c
+        with:
+          node-version-file: .nvmrc
+          cache: yarn
+
+      - name: yarn > install
+        run: yarn install --frozen-lockfile
+
+      - name: yarn > build
+        run: yarn build
+
+      - name: ci > upload artifacts
+        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: git > checkout
+        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c
+        with:
+          clean: true
+          fetch-depth: 1
+
+      - name: node > setup
+        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c
+        with:
+          node-version-file: .nvmrc
+          cache: yarn
+
+      - name: yarn > install
+        run: yarn install --frozen-lockfile
+
+      - name: yarn > lint
+        run: yarn lint
+  test:
+    name: test
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: git > checkout
+        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c
+        with:
+          clean: true
+          fetch-depth: 1
+
+      - name: node > setup
+        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c
+        with:
+          node-version-file: .nvmrc
+          cache: yarn
+
+      - name: yarn > install
+        run: yarn install --frozen-lockfile
+
+      - name: yarn > test
+        run: yarn test
+  verify_workflow:
+    name: verify workflow
+    runs-on: ubuntu-latest
+    if: always()
+    needs:
+      - build
+      - lint
+      - test
+    steps:
+
+      - name: verify workflow success
+        if: always()
+        run: |-
+          # resolve statuses
+          BUILD_AGGREGATE=(${{ needs['build'].result }})
+          BUILD=unknown
+          BUILD=$(if [[ " ${BUILD_AGGREGATE[@]} " == *"success"* ]]; then echo "success"; else echo "$BUILD"; fi)
+          BUILD=$(if [[ " ${BUILD_AGGREGATE[@]} " == *"skipped"* ]]; then echo "skipped"; else echo "$BUILD"; fi)
+          BUILD=$(if [[ " ${BUILD_AGGREGATE[@]} " == *"cancelled"* ]]; then echo "cancelled"; else echo "$BUILD"; fi)
+          BUILD=$(if [[ " ${BUILD_AGGREGATE[@]} " == *"failure"* ]]; then echo "failure"; else echo "$BUILD"; fi)
+          LINT_AGGREGATE=(${{ needs['lint'].result }})
+          LINT=unknown
+          LINT=$(if [[ " ${LINT_AGGREGATE[@]} " == *"success"* ]]; then echo "success"; else echo "$LINT"; fi)
+          LINT=$(if [[ " ${LINT_AGGREGATE[@]} " == *"skipped"* ]]; then echo "skipped"; else echo "$LINT"; fi)
+          LINT=$(if [[ " ${LINT_AGGREGATE[@]} " == *"cancelled"* ]]; then echo "cancelled"; else echo "$LINT"; fi)
+          LINT=$(if [[ " ${LINT_AGGREGATE[@]} " == *"failure"* ]]; then echo "failure"; else echo "$LINT"; fi)
+          TEST_AGGREGATE=(${{ needs['test'].result }})
+          TEST=unknown
+          TEST=$(if [[ " ${TEST_AGGREGATE[@]} " == *"success"* ]]; then echo "success"; else echo "$TEST"; fi)
+          TEST=$(if [[ " ${TEST_AGGREGATE[@]} " == *"skipped"* ]]; then echo "skipped"; else echo "$TEST"; fi)
+          TEST=$(if [[ " ${TEST_AGGREGATE[@]} " == *"cancelled"* ]]; then echo "cancelled"; else echo "$TEST"; fi)
+          TEST=$(if [[ " ${TEST_AGGREGATE[@]} " == *"failure"* ]]; then echo "failure"; else echo "$TEST"; fi)
+
+          # echo the results of each job
+          echo "BUILD: $BUILD"
+          echo "LINT: $LINT"
+          echo "TEST: $TEST"
+
+          # assert success
+          if [[ "$BUILD" != "success" ]]; then exit 1; fi
+          if [[ "$LINT" != "success" ]]; then exit 1; fi
+          if [[ "$TEST" != "success" ]]; then exit 1; fi

package/.github/workflows/publish.yaml

@@ -0,0 +1,106 @@
+## ---------------------------------------------------
+##     |\---/|                                       
+##     | ,_, |               !! DO NOT MODIFY !!      
+##      \_`_/-..----.    file managed by `whiskers`  
+##   ___/ `   ' ,""+ \                              
+##  (__...'   __\    |`.___.';                       
+##    (_,...'(_,.`__)/'.....+                         
+## ---------------------------------------------------
+
+name: publish
+run-name: publish v${{ inputs.version }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      branch:
+        description: The branch of the build. Used to find artifacts and tag.
+        required: true
+      release_type:
+        description: The type of release.
+        required: true
+        type: choice
+        options:
+          - experimental
+          - stable
+        default: experimental
+      version:
+        description: "The version of this release. Omit 'v' prefix. Example: '1.0.1-experimental.1'."
+        required: true
+
+jobs:
+  version_bump:
+    name: version bump
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+
+      - name: git > checkout
+        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c
+        with:
+          clean: true
+          fetch-depth: 1
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          ref: ${{ inputs.branch }}
+
+      - name: node > setup
+        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c
+        with:
+          node-version-file: .nvmrc
+          cache: yarn
+
+      - name: yarn > install
+        run: yarn install --frozen-lockfile
+
+      - name: yarn > bump version
+        run: yarn run release:version:bump ${{ inputs.version }}
+
+      - name: git > commit version bump
+        uses: EndBug/add-and-commit@1bad3abcf0d6ec49a5857d124b0bfb52dc7bb081
+        with:
+          default_author: github_actions
+          message: bump version to ${{ inputs.version }}
+          push: true
+          tag: v${{ inputs.version }}
+  publish:
+    name: publish
+    runs-on: ubuntu-latest
+    needs:
+      - version_bump
+    steps:
+
+      - name: git > checkout
+        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c
+        with:
+          clean: true
+          fetch-depth: 1
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          ref: v${{ inputs.version }}
+
+      - name: node > setup
+        uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c
+        with:
+          node-version-file: .nvmrc
+          cache: yarn
+
+      - name: yarn > install
+        run: yarn install --frozen-lockfile
+
+      - name: ci > download artifacts
+        uses: dawidd6/action-download-artifact@268677152d06ba59fcec7a7f0b5d961b6ccd7e1e
+        with:
+          workflow: build.yaml
+          workflow_conclusion: success
+          branch: ${{ inputs.branch }}
+
+      - name: yarn > publish (experimental)
+        if: inputs.release_type == 'experimental'
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: yarn run release:publish:experimental
+
+      - name: yarn > publish (stable)
+        if: inputs.release_type == 'stable'
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: yarn run release:publish:stable

package/.github/workflows/release.yaml

@@ -0,0 +1,36 @@
+## ---------------------------------------------------
+##     |\---/|                                       
+##     | ,_, |               !! DO NOT MODIFY !!      
+##      \_`_/-..----.    file managed by `whiskers`  
+##   ___/ `   ' ,""+ \                              
+##  (__...'   __\    |`.___.';                       
+##    (_,...'(_,.`__)/'.....+                         
+## ---------------------------------------------------
+
+name: release
+
+on:
+  push:
+    tags:
+      - v*.*.*
+
+jobs:
+  release:
+    name: release
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+
+      - name: git > checkout
+        uses: actions/checkout@ac593985615ec2ede58e132d2e21d2b1cbd6127c
+        with:
+          clean: true
+          fetch-depth: 1
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
+
+      - name: release > create github release
+        uses: softprops/action-gh-release@de2c0eb89ae2a093876385947365aca7b0e5f844
+        with:
+          token: ${{ secrets.BOT_GITHUB_TOKEN }}
+          generate_release_notes: true
+          prerelease: ${{ contains(github.ref, 'experimental') }}

package/.nvmrc

@@ -0,0 +1 @@
+v18.17.1

package/changelog.md

@@ -0,0 +1,15 @@
+### 1.2.0
+
+- add `paragon.completeInstall` method for integration-origin install flows
+
+### 1.1.0
+
+- added multiple auth support
+
+### 1.0.2
+
+- type fixes
+
+### 1.0.1
+
+- connect sdk

package/dist/src/ConnectSDK.d.ts

@@ -2,7 +2,7 @@ import { OauthCallbackResponse } from './entities/credential.interface';
 import { IIntegrationMetadata } from './entities/integration.interface';
 import { PersonaMeta } from './entities/persona.interface';
 import SDKEventEmitter from './SDKEventEmitter';
-import { AuthenticateOptions, AuthenticatedConnectUser, Props as ConnectModalProps, ConnectParams, ConnectUser, EventInfo, IConnectSDK, InstallOptions, TriggerWorkflowRequest } from './types';
+import { AuthenticateOptions, AuthenticatedConnectUser, Props as ConnectModalProps, ConnectParams, ConnectUser, DisableWorkflowOptions, EventInfo, IConnectSDK, InstallOptions, TriggerWorkflowRequest, UninstallOptions } from './types';
 export declare const PARAGON_OVERFLOW_EMPTY_VALUE = "PARAGON_OVERFLOW_EMPTY_VALUE";
 export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     root: HTMLIFrameElement | undefined;
@@ -34,7 +34,6 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * so that we will be able to know whether style is added in body or not
      */
     private originalBodyOverflow;
-    private configs;
     constructor();
     /**
      * post message handler
@@ -43,7 +42,24 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
     private eventMessageHandler;
     private functionInvocationHandler;
     private createReactRoot;
+    /**
+     * checks
+     * - if integartion name is valid
+     * - if integration is setup in project
+     * - if integration is active in project
+     * throws error if any of these is not met
+     * @param action
+     * @param validateIsEnabled boolean
+     */
     private validateAction;
+    /**
+     * checks if the integration is installed.
+     * Assumes that the user is authenticated
+     * @param action
+     * @param userState
+     * @returns boolean value
+     */
+    private isAlreadyInstalled;
     private bootstrapSDKState;
     setModalState(statePartial: Partial<ConnectModalProps>): void;
     /**
@@ -87,10 +103,11 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * Logout the currently authenticated end user from the Paragon SDK.
      */
     logout(): void;
+    connect(action: string, params?: ConnectParams): Promise<void>;
     /**
      * Display the Paragon Connect modal
      */
-    connect(action: string, params?: ConnectParams): Promise<void>;
+    _connect(action: string, params?: ConnectParams & InstallOptions): Promise<void>;
     _oauthCallback(oauthResponse: OauthCallbackResponse, credentialId?: string): Promise<void>;
     _oauthErrorCallback(errorMessage: string | object): Promise<void>;
     /**
@@ -113,6 +130,7 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * @returns api request response
      */
     request<TResponse>(action: string, path: string, init: {
+        selectedCredentialId?: string;
         method: RequestInit['method'];
         body: RequestInit['body'] | object;
         headers: RequestInit['headers'];
@@ -146,7 +164,7 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * @param workflowId
      * @param payload
      */
-    workflow(workflowId: string, { body, query, headers }?: TriggerWorkflowRequest): Promise<object | undefined>;
+    workflow(workflowId: string, { selectedCredentialId, body, query, headers }?: TriggerWorkflowRequest): Promise<object | undefined>;
     /**
      * for programmatically installing an integration
      */
@@ -155,8 +173,9 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      * gates headless feature to pro and enterprise users
      */
     ensureHeadlessIsSupported(): void;
-    uninstallIntegration(action: string): Promise<void>;
-    disableWorkflow(workflowId: string): Promise<void>;
+    uninstallIntegration(action: string, options?: UninstallOptions): Promise<void>;
+    disableWorkflow(workflowId: string, options?: DisableWorkflowOptions): Promise<void>;
+    private getIntegrationForWorkflow;
     private updateLocalState;
     /**
      * also returns false if unable to find workflow in configured workflow property of any integration
@@ -177,13 +196,28 @@ export default class ConnectSDK extends SDKEventEmitter implements IConnectSDK {
      */
     private updateIntegrations;
     setUserMetadata(meta: PersonaMeta): Promise<AuthenticatedConnectUser>;
-    getIntegrationConfigs(actionNames: string[]): Promise<void>;
     /**
      * @param {host: string;} domain
      * sets the domain for making http service request
-     * example: configureGlobal({host: 'myDomain.com'}) would set service urls as `https://service.myDomain.com`
+     * example: `configureGlobal({host: 'myDomain.com'});` would set service urls as `https://service.myDomain.com`
      */
     configureGlobal(param: {
         host: string;
     }): void;
+    /**
+     * some integration required flow in which user recieve authorization code
+     * from marketplace oauth flow , so needed this method see PARA-8385
+     */
+    completeInstall(action: string, options: {
+        authorizationCode: string;
+        showPortalAfterInstall?: boolean;
+        redirectUrl?: string;
+        integrationOptions?: Record<string, unknown>;
+    }): Promise<void>;
+    /**
+     * update credential data in integration
+     * @param newCredential
+     * @param integration
+     */
+    private updateCredentialData;
 }

package/dist/src/entities/integration.interface.d.ts

@@ -30,4 +30,7 @@ export interface IConnectIntegrationWithCredentialInfo extends IConnectIntegrati
     hasCredential: boolean;
     connectedUserLimitOnDevCred: number;
     connectedUserLimitReached: boolean;
+    needPreOauthInputs: boolean;
+    name: string;
+    brandColor: string;
 }

package/dist/src/helpers/index.d.ts

@@ -1,3 +1,4 @@
+import { SDKIntegration } from '../types/connect';
 import { DataType, KeyedSource } from '../types/resolvers';
 import { NonNullUndefinedField } from '../types/sdk';
 /**
@@ -13,3 +14,10 @@ export declare function parseKeyedSource(param: KeyedSource<DataType.ANY>[]): Re
  * @returns
  */
 export declare function stripUndefinedAndNull<T extends object>(obj: T): NonNullUndefinedField<T>;
+/**
+ * provides the action state object after a credential is deleted.
+ * @param `deletedCredentialId` (string): The ID of the credential that was deleted.
+ * @param `deletedActionState` (`SDKIntegration`): The user state for the action whose credential was deleted
+ * @returns an object of type `SDKIntegration`.
+ */
+export declare const getActionStateForCredentialDelete: (deletedCredentialId: string, deletedActionState: SDKIntegration) => SDKIntegration;

package/dist/src/helpers/oauth.d.ts

@@ -1,20 +1,6 @@
-import { AuthenticationScheme } from '../entities/credential.interface';
 import { IConnectIntegrationWithCredentialInfo } from '../entities/integration.interface';
-import { IntegrationConnectInput } from '../types/action';
 import { DataType, KeyedSource } from '../types/resolvers';
 import { IConnectUserContext } from './ConnectUserContext';
-/**
- * this check if inputs needs to be shown before oauth
- * @param integration
- * @returns
- */
-export declare const shouldShowPreAuthInputs: ({ integration, authScheme, endUserSuppliedValues, isAccountTypeSupported, }: {
-    integration: IConnectIntegrationWithCredentialInfo;
-    provider?: string | undefined;
-    authScheme?: AuthenticationScheme | undefined;
-    endUserSuppliedValues?: IntegrationConnectInput[] | undefined;
-    isAccountTypeSupported: boolean;
-}) => boolean;
 /**
  *  start oauth flow with new popup
  * @param param0