Initial commit with squashed history

Author: karissarjacobsen

Containerfile

@@ -0,0 +1,70 @@
+# Global arguments
+ARG BASE_IMAGE=node:lts-alpine
+ARG APP_DIR=/usr/src/app
+ARG UID=1000
+ARG GID=1000
+ARG PORT=3000
+
+# Base stage
+FROM ${BASE_IMAGE} AS base
+ARG APP_DIR
+ARG UID
+ARG GID
+ARG PORT
+
+RUN mkdir -p ${APP_DIR} && \
+    chown -R ${UID}:${GID} ${APP_DIR}
+
+USER ${UID}:${GID}
+
+WORKDIR ${APP_DIR}
+
+ENV PORT=${PORT}
+EXPOSE ${PORT}
+
+COPY --chown=${UID}:${GID} package.json .
+
+# Dependencies stage
+FROM base AS dependencies
+ARG APP_DIR
+
+RUN npm install && \
+    npm cache clean --force && \
+    touch ${APP_DIR}/production.env && \
+    touch ${APP_DIR}/development.env
+
+ENV PATH=${APP_DIR}/node_modules/.bin:$PATH
+
+# Development stage
+FROM dependencies AS development
+ARG UID
+ARG GID
+
+ENV NODE_ENV=development
+
+COPY --chown=${UID}:${GID} . .
+
+CMD ["npm", "run", "dev"]
+
+# Build stage
+FROM dependencies AS build
+ARG UID
+ARG GID
+
+COPY --chown=${UID}:${GID} . .
+
+RUN npm run build
+
+# Production stage
+FROM dependencies AS production
+ARG UID
+ARG GID
+ARG APP_DIR
+
+ENV NODE_ENV=production
+
+COPY --chown=${UID}:${GID} ./public ./public
+COPY --chown=${UID}:${GID} ./views ./views
+COPY --chown=${UID}:${GID} --from=build ${APP_DIR}/dist ./dist
+
+CMD ["node", "./dist", "--env=production"]

Dockerfile

@@ -0,0 +1,69 @@
+# Global arguments
+ARG BASE_IMAGE=node:lts-alpine
+ARG APP_DIR=/usr/src/app
+ARG UID=1000
+ARG GID=1000
+ARG PORT=3000
+
+# Base stage
+FROM ${BASE_IMAGE} AS base
+ARG APP_DIR
+ARG UID
+ARG GID
+ARG PORT
+
+RUN mkdir -p ${APP_DIR} && \
+    chown -R ${UID}:${GID} ${APP_DIR}
+
+USER ${UID}:${GID}
+
+WORKDIR ${APP_DIR}
+
+ENV PORT=${PORT}
+EXPOSE ${PORT}
+
+# Dependencies stage
+FROM base AS dependencies
+ARG APP_DIR
+
+RUN --mount=type=bind,source=./package.json,target=${APP_DIR}/package.json \
+    --mount=type=cache,target=${APP_DIR}/.npm,uid=$UID,gid=$GID,mode=0755,sharing=locked \
+    npm install && \
+    touch ${APP_DIR}/production.env && \
+    touch ${APP_DIR}/development.env
+
+ENV PATH=${APP_DIR}/node_modules/.bin:$PATH
+
+# Development stage
+FROM dependencies AS development
+ARG UID
+ARG GID
+
+ENV NODE_ENV=development
+
+COPY --chown=${UID}:${GID} . .
+
+CMD ["npm", "run", "dev"]
+
+# Build stage
+FROM dependencies AS build
+ARG UID
+ARG GID
+
+COPY --chown=${UID}:${GID} . .
+
+RUN npm run build
+
+# Production stage
+FROM dependencies AS production
+ARG UID
+ARG GID
+ARG APP_DIR
+
+ENV NODE_ENV=production
+
+COPY --chown=${UID}:${GID} package.json .
+COPY --chown=${UID}:${GID} ./views ./views
+COPY --chown=${UID}:${GID} --from=build ${APP_DIR}/dist ./dist
+
+CMD ["node", "./dist", "--env=production"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 DocuSign Inc.
+
+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

@@ -0,0 +1,137 @@
+# File Input Cloud Storage Extension App Reference Implementation
+## Introduction
+This reference implementation simulates an external service that imports files from cloud storage to [Docusign Navigator](https://www.docusign.com/products/platform/navigator). This reference implementation is useful for:
+
+- Reviewing the format of requests to and responses from an external service that implements the file input cloud storage extension
+- Seeing how the extension functions when invoked from Navigator
+
+## Authentication
+This reference implementation supports two [authentication](https://developers.docusign.com/extension-apps/build-an-extension-app/it-infrastructure/authorization/) flows:
+* [Authorization Code Grant](https://developers.docusign.com/extension-apps/build-an-extension-app/it-infrastructure/authorization/#authorization-code-grant) – required for public extension apps
+* [Client Credentials Grant](https://developers.docusign.com/extension-apps/build-an-extension-app/it-infrastructure/authorization/#client-credentials-grant) – available to private extension apps. See [Choosing private distribution instead of public](https://developers.docusign.com/extension-apps/extension-apps-101/choosing-private-distribution/).
+
+*Private extension apps can use either authentication method, but public extension apps must use Authorization Code Grant.*
+
+**Note:** In the current release, only Client Credentials Grant is supported.
+
+## Hosted version (no setup required)
+You can use the hosted version of this reference implementation by directly uploading the appropriate manifest file located in the [manifests/hosted/](manifests/hosted) folder to the Docusign Developer Console. See [Upload your manifest and create the extension app](#3-upload-your-manifest-and-create-the-extension-app).
+
+**Note:** The provided manifest includes `clientId` and `clientSecret` values used in the sample authentication connection. These do not authenticate to a real system, but the hosted reference implementation requires these exact values.
+
+## Choose your setup: Local or cloud deployment
+If you want to run the app locally using Node.js and ngrok, follow the [local setup instructions](#local-setup-instructions) below.
+
+If you want to deploy the app to the cloud using Docker and Terraform, see the [Terraform deployment guide](terraform/README.md). This includes cloud-specific setup instructions for the following cloud providers:
+- [Amazon Web Services](https://aws.amazon.com/)
+- [Microsoft Azure](https://azure.microsoft.com/)
+- [Google Cloud Platform](https://cloud.google.com/)
+
+## Local setup instructions
+
+### Video walkthrough
+[![Reference implementation videos](https://img.youtube.com/vi/_4p7GWK5aoA/0.jpg)](https://youtube.com/playlist?list=PLXpRTgmbu4oq4VDLJBA2BO6psxf8vkVoq&feature=shared)
+
+### 1. Clone the repository
+Run the following command to clone the repository:
+```bash
+git clone https://github.com/docusign/extension-app-file-input-cloud-storage-reference-implementation.git
+```
+
+### 2. Generate secret values
+If you already have values for `JWT_SECRET_KEY`, `OAUTH_CLIENT_ID`, `OAUTH_CLIENT_SECRET`, and `AUTHORIZATION_CODE`, you may skip this step.
+
+The easiest way to generate a secret value is to run the following command:
+```bash
+node -e "console.log(require('crypto').randomBytes(64).toString('hex'));"
+```
+
+You will need values for `JWT_SECRET_KEY`, `OAUTH_CLIENT_ID`, `OAUTH_CLIENT_SECRET`, and `AUTHORIZATION_CODE`.
+
+### 3. Set the environment variables for the cloned repository
+- If you're running this in a development environment, create a copy of `example.development.env` and save it as `development.env`.
+- If you're running this in a production environment, create a copy of `example.production.env` and save it as `production.env`.
+- Replace `JWT_SECRET_KEY`, `OAUTH_CLIENT_ID`, `OAUTH_CLIENT_SECRET`, and `AUTHORIZATION_CODE` in `development.env` or `production.env` with your generated values. These values will be used to configure the sample proxy's mock authentication server.
+- Set the `clientId` value in the manifest.json file to the same value as `OAUTH_CLIENT_ID`.
+- Set the `clientSecret` value in the manifest.json file to the same value as `OAUTH_CLIENT_SECRET`.
+### 4. [Install and configure Node.js and npm on your machine](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+### 5. Install dependencies
+Run the following command to install the necessary dependencies:
+```bash
+npm install
+```
+### 6. Run the proxy server
+#### Development mode:
+Start the proxy server in development mode by running the command:
+```bash
+npm run dev
+```
+
+This will create a local server on the port in the `development.env` file (port 3000 by default) that listens for local changes that trigger a rebuild.
+
+#### Production mode:
+Start the proxy server in production mode by running the commands:
+```bash
+npm run build
+npm run start
+```
+
+This will start a production build on the port in the `production.env` file (port 3000 by default).
+## Set up ngrok
+### 1. [Install and configure ngrok for your machine](https://ngrok.com/docs/getting-started/)
+### 2. Start ngrok
+Run the following command to create a publicly accessible tunnel to your localhost:
+
+```bash
+ngrok http <PORT>
+```
+
+Replace `<PORT>` with the port number in the `development.env` or `production.env` file.
+
+### 3. Save the forwarding address
+Copy the `Forwarding` address from the response. You’ll need this address in your `manifest.json` file.
+
+```bash
+ngrok
+
+Send your ngrok traffic logs to Datadog: https://ngrok.com/blog-post/datadog-log
+
+Session Status                online
+Account                       email@domain.com (Plan: Free)
+Update                        update available (version 3.3.1, Ctrl-U to update)
+Version                       3.3.0
+Region                        United States (us)
+Latency                       60ms
+Web Interface                 http://127.0.0.1:4040
+Forwarding                    https://bbd7-12-202-171-35.ngrok-free.app -> http:
+
+Connections                   ttl     opn     rt1     rt5     p50     p90
+                              0       0       0.00    0.00    0.00    0.00
+```
+
+In this example, the `Forwarding` address to copy is `https://bbd7-12-202-171-35.ngrok-free.app`.
+## Create an extension app
+### 1. Prepare your app manifest
+Choose a manifest from the [manifests](manifests/) folder based on the appropriate [authentication](#authentication) use case. Replace `<PROXY_BASE_URL>` in your manifest.json file with the ngrok forwarding address in the following sections:
+- `connections.params.customConfig.tokenUrl`
+- `connections.params.customConfig.authorizationUrl`
+- `actions.params.uri` Replace this value for all of the actions.
+### 2. Navigate to the [Developer Console](https://devconsole.docusign.com/apps)
+Log in with your Docusign developer credentials. You can sign up for a free developer account [here](https://www.docusign.com/developers/sandbox).
+### 3. Upload your manifest and create the extension app
+To [create your extension app](https://developers.docusign.com/extension-apps/build-an-extension-app/create/), select **Create App > By editing the manifest**. In the app manifest editor that opens, upload your manifest file or paste into the editor itself; then select **Validate**. Once the editor validates your manifest, select **Create App.**
+### 4. Test the extension app
+This reference implementation simulates an external cloud storage service. After you have created an extension app in the Developer Console that connects to the reference implementation, you can run tests that send requests to it. Requests from the calling application are saved to the [logs](logs/) folder. The reference implementation sends responses to the calling application. This reference implementation processes the file input cloud storage extension's actions and capability as follows:
+- Get File: Uploads files from the reference implementation's [agreements](agreements/) folder to Navigator.
+- List Drives: Returns mock data.
+- List Directory Contents: Returns the folders and files from the reference implementation's [agreements](agreements/) folder.
+- Search: Returns folders and files from the reference implementation's [agreements](agreements/) folder where the folder or file name matches the supplied search string.
+#### [Integration tests](https://developers.docusign.com/extension-apps/build-an-extension-app/test/integration-tests/)
+You can run these tests from the Developer Console to test each supported action and capability for the extension. These tests allow you to construct the request body and see the response.
+#### [Functional tests](https://developers.docusign.com/extension-apps/build-an-extension-app/test/functional-tests/)
+This type of test shows how the extension functions when invoked from an [extension point](https://developers.docusign.com/extension-apps/extension-apps-101/concepts/extensions-and-extension-points/#extension-points). For file input cloud storage, the extension point is [Navigator](https://support.docusign.com/s/document-item?bundleId=pqz1702943441912&topicId=adf1702945446135.html).
+
+
+
+
+