Pull Prism config from prism config files in order to be Windows-compatible (#2)

* Pull Prism config from prism config files in order to be Windows-compatible

* Make note about installing Prism

Author: taylorreece

README.md

@@ -20,7 +20,14 @@ You have two options for deploying white-labeled documentation:
 ## Generating private connector documentation
 
 If you have private connectors that you offer to your customers and you want documentation for them to live alongside the public connectors, you can generate documentation for them.
+
 After installing node dependencies locally, ensure that you are logged in to the Prismatic CLI with `prism login`.
+If you do not have the Prismatic CLI installed, you can install it with:
+
+```bash
+npm install -g @prismatic-io/prism
+```
+
 Then, identify the key of the private connector you want to generate documentation for by running:
 
 ```bash
@@ -33,4 +40,6 @@ Using the `key` of the connector you want to generate documentation for, run:
 npm run generate-private-connector-docs YOUR-COMPONENT-KEY
 ```
 
+**Note**: Make sure you can successfully run `prism me` before running the above command, as it relies on your Prismatic CLI being configured correctly.
+
 This will generate a markdown file in the `docs/connectors/` directory, and pull down the connector's icon into `docs/connectors/assets/`.

package-lock.json

@@ -18,11 +18,11 @@
     "format-js": "biome format --write",
     "format-markdown": "prettier --log-level warn --write \"docs/**/*.md\"",
     "generate-branded-markdown": "docusaurus generate-branded-markdown",
-    "generate-public-connector-docs": "PRISMATIC_API_KEY=$(prism me:token) docusaurus generate-connector-docs --public-connectors",
+    "generate-public-connector-docs": "docusaurus generate-connector-docs --public-connectors",
     "postgenerate-public-connector-docs": "npm run format-markdown",
-    "generate-public-connector-docs-from-manifest": "PRISMATIC_API_KEY=$(prism me:token) docusaurus generate-connector-docs --public-connectors --from-manifest",
+    "generate-public-connector-docs-from-manifest": "docusaurus generate-connector-docs --public-connectors --from-manifest",
     "postgenerate-public-connector-docs-from-manifest": "npm run format-markdown",
-    "generate-private-connector-docs": "PRISMATIC_API_KEY=$(prism me:token) docusaurus generate-connector-docs --private-connector",
+    "generate-private-connector-docs": "docusaurus generate-connector-docs --private-connector",
     "postgenerate-private-connector-docs": "npm run format-markdown",
     "resize-screenshots": "docusaurus resize-screenshots",
     "typecheck": "tsc"
@@ -50,6 +50,7 @@
     "graphql": "^16.11.0",
     "handlebars": "^4.7.8",
     "jimp": "^1.6.0",
+    "js-yaml": "^4.1.0",
     "markdownlint-cli": "^0.45.0",
     "netlify-cli": "^22.1.6",
     "prettier": "^3.6.1",

package.json

@@ -0,0 +1,24 @@
+import { load } from "js-yaml";
+import fs from "node:fs";
+import { homedir } from "node:os";
+import path from "node:path";
+
+export interface Configuration {
+  accessToken: string;
+  expiresIn: number;
+  refreshToken: string;
+  scope: string;
+  tokenType: string;
+}
+
+const configDirectory = path.join(homedir(), ".config", "prism");
+const configFilePath = path.join(configDirectory, "config.yml");
+
+export const configFileExists = () => fs.existsSync(configFilePath);
+
+export const readConfig = (): Configuration => {
+  if (!configFileExists()) return null;
+  const contents = fs.readFileSync(configFilePath, { encoding: "utf-8" });
+  const config = load(contents.toString()) as Configuration;
+  return config;
+};

src/plugins/connectors/auth.ts

@@ -3,6 +3,7 @@
  * in order to pull metadata about existing connectors
  */
 import { Graffle } from "graffle";
+import { readConfig } from "./auth";
 
 export const getPrismaticConnection = () => {
   const { PRISMATIC_API_KEY, PRISMATIC_URL } = process.env;
@@ -11,12 +12,19 @@ export const getPrismaticConnection = () => {
     ? `${PRISMATIC_URL}/api`
     : "https://app.prismatic.io/api";
 
-  if (!PRISMATIC_API_KEY) {
-    throw new Error("You must set a PRISMATIC_API_KEY environment variable.");
+  // If the environment variable is set, use it to create the client
+  if (PRISMATIC_API_KEY) {
+    return {
+      PRISMATIC_API_KEY,
+      PRISMATIC_URL: PRISMATIC_URL || "https://app.prismatic.io",
+      API_ENDPOINT,
+    };
   }
 
+  // Otherwise, read the access token from the prism config file
+  const { accessToken } = readConfig();
   return {
-    PRISMATIC_API_KEY,
+    PRISMATIC_API_KEY: accessToken,
     PRISMATIC_URL: PRISMATIC_URL || "https://app.prismatic.io",
     API_ENDPOINT,
   };