Merge remote-tracking branch 'upstream/main' into feat/repo-select

.cspell.json

@@ -8,5 +8,5 @@
   "dictionaries": ["typescript", "node", "software-terms"],
   "import": ["@cspell/dict-typescript/cspell-ext.json", "@cspell/dict-node/cspell-ext.json", "@cspell/dict-software-terms"],
   "ignoreRegExpList": ["[0-9a-fA-F]{6}"],
-  "ignoreWords": ["ubiquibot", "Supabase", "supabase", "SUPABASE", "sonarjs", "mischeck"]
+  "ignoreWords": ["ubiquibot", "Supabase", "supabase", "SUPABASE", "sonarjs", "mischeck", "Typebox"]
 }

.github/knip.ts

@@ -6,7 +6,19 @@ const config: KnipConfig = {
   ignore: ["src/types/config.ts", "**/__mocks__/**", "**/__fixtures__/**"],
   ignoreExportsUsedInFile: true,
   // eslint can also be safely ignored as per the docs: https://knip.dev/guides/handling-issues#eslint--jest
-  ignoreDependencies: ["@mswjs/data", "@supabase/supabase-js", "@ubiquity-os/ubiquity-os-kernel", "ajv", "yaml", "simple-git", "@actions/core", "esbuild"],
+  ignoreDependencies: [
+    "@mswjs/data",
+    "@supabase/supabase-js",
+    "@ubiquity-os/ubiquity-os-kernel",
+    "ajv",
+    "yaml",
+    "simple-git",
+    "@actions/core",
+    "esbuild",
+    "@ubiquity-os/plugin-sdk",
+    "markdown-it",
+    "@types/markdown-it",
+  ],
   eslint: true,
 };
 

README.md

@@ -48,3 +48,15 @@ The browser automatically URI encodes it:
 ```
 
 ###### Example from `command-start-stop/manifest.json`
+
+## How to run
+
+1. Clone the repository
+2. Run `yarn` to install dependencies
+3. OAuth: Obtain your _GitHub OAuth App_ client ID and secret from your OAuth app settings, and set the callback URL to match the one given by Supabase when enabling GitHub provider OAuth.
+4. Replace the hardcoded `SUPABASE_URL` and `SUPABASE_KEY` in `build/esbuild-build.ts` with your Supabase URL and key (Optionally use `.env` and use `process.env` instead.)
+5. Run `yarn start` and visit `localhost:8080` in your browser.
+6. Once logged in you should see the orgs that you own.
+7. Select an org > select a config (dev | prod) > select a plugin > edit/add/remove > push to GitHub.
+
+TODO: Update readme with a better overview of the project.

build/esbuild-build.ts

@@ -19,8 +19,9 @@ export const esbuildOptions: BuildOptions = {
   define: createEnvDefines([], {
     SUPABASE_STORAGE_KEY: generateSupabaseStorageKey(),
     NODE_ENV: process.env.NODE_ENV || "development",
-    SUPABASE_URL: "https://wfzpewmlyiozupulbuur.supabase.co",
+    SUPABASE_URL: process.env.SUPABASE_URL || "https://wfzpewmlyiozupulbuur.supabase.co",
     SUPABASE_ANON_KEY:
+      process.env.SUPABASE_ANON_KEY ||
       /* cspell:disable-next-line */
       "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZSIsInJlZiI6IndmenBld21seWlvenVwdWxidXVyIiwicm9sZSI6ImFub24iLCJpYXQiOjE2OTU2NzQzMzksImV4cCI6MjAxMTI1MDMzOX0.SKIL3Q0NOBaMehH0ekFspwgcu3afp3Dl9EDzPqs1nKs",
   }),
@@ -57,7 +58,7 @@ function createEnvDefines(environmentVariables: string[], generatedAtBuild: Reco
 }
 
 export function generateSupabaseStorageKey(): string | null {
-  const SUPABASE_URL = "https://wfzpewmlyiozupulbuur.supabase.co";
+  const SUPABASE_URL = process.env.SUPABASE_URL || "https://wfzpewmlyiozupulbuur.supabase.co";
   if (!SUPABASE_URL) {
     console.error("SUPABASE_URL environment variable is not set");
     return null;

package.json

@@ -35,9 +35,11 @@
   "dependencies": {
     "@octokit/rest": "^21.0.2",
     "@supabase/supabase-js": "^2.46.1",
+    "@ubiquity-os/plugin-sdk": "^1.0.11",
     "@ubiquity-os/ubiquity-os-kernel": "^2.5.3",
     "ajv": "^8.17.1",
     "dotenv": "^16.4.4",
+    "markdown-it": "^14.1.0",
     "yaml": "^2.6.0"
   },
   "devDependencies": {
@@ -50,6 +52,7 @@
     "@jest/globals": "29.7.0",
     "@mswjs/data": "0.16.1",
     "@types/jest": "^29.5.12",
+    "@types/markdown-it": "^14.1.2",
     "@types/node": "20.14.5",
     "cspell": "8.14.4",
     "cypress": "13.6.6",

static/index.html

@@ -26,7 +26,7 @@
           <tbody id="manifest-gui-body"></tbody>
           <tfoot
             ><tr
-              ><td></td><td><button id="remove"></button><button id="add"></button></td></tr
+              ><td></td><td><button id="reset-to-default"></button><button id="remove"></button><button id="add"></button></td></tr
           ></tfoot>
         </table>
       </section>

static/main.ts

@@ -1,71 +1,39 @@
 import { AuthService } from "./scripts/authentication";
-import { ManifestDecoder } from "./scripts/decode-manifest";
 import { ManifestFetcher } from "./scripts/fetch-manifest";
 import { ManifestRenderer } from "./scripts/render-manifest";
-import { OrgWithInstall } from "./types/github";
+import { renderOrgPicker } from "./scripts/rendering/org-select";
 import { toastNotification } from "./utils/toaster";
 
 async function handleAuth() {
   const auth = new AuthService();
   await auth.renderGithubLoginButton();
-  const token = await auth.getGitHubAccessToken();
-  if (!token) {
-    // await auth.signInWithGithub(); force a login?
-  }
-
   return auth;
 }
 
 export async function mainModule() {
   const auth = await handleAuth();
-  const decoder = new ManifestDecoder();
   const renderer = new ManifestRenderer(auth);
-  const search = window.location.search.substring(1);
-
-  if (search) {
-    const decodedManifest = await decoder.decodeManifestFromSearch(search);
-    return renderer.renderManifest(decodedManifest);
-  }
+  renderer.manifestGuiBody.dataset.loading = "false";
 
   try {
-    /**
-     * "ubiquity-os", "ubiquity-os-marketplace" === dev config
-     * "ubiquity" === prod config
-     */
     const ubiquityOrgsToFetchOfficialConfigFrom = ["ubiquity-os"];
-    const fetcher = new ManifestFetcher(ubiquityOrgsToFetchOfficialConfigFrom, auth.octokit, decoder);
-    const cache = fetcher.checkManifestCache();
-    if (auth.isActiveSession()) {
-      const userOrgs = await auth.getGitHubUserOrgs();
-      localStorage.setItem("userOrgs", JSON.stringify(userOrgs));
+    const fetcher = new ManifestFetcher(ubiquityOrgsToFetchOfficialConfigFrom, auth.octokit);
 
-      const appInstallations = await auth.octokit?.apps.listInstallationsForAuthenticatedUser();
-      const installs = appInstallations?.data.installations;
+    if (auth.isActiveSession()) {
+      renderer.manifestGuiBody.dataset.loading = "true";
+      const killNotification = toastNotification("Fetching manifest data...", { type: "info", shouldAutoDismiss: true });
 
-      const orgsWithInstalls = userOrgs.map((org) => {
-        const orgInstall = installs?.find((install) => {
-          if (install.account && "login" in install.account) {
-            return install.account.login.toLowerCase() === org.toLowerCase();
-          }
-          return false;
-        });
-        return {
-          org,
-          install: orgInstall,
-        };
-      }) as OrgWithInstall[];
-      renderer.renderOrgPicker(orgsWithInstalls.map((org) => org.org));
+      const userOrgs = await auth.getGitHubUserOrgs();
       const userOrgRepos = await auth.getGitHubUserOrgRepos(userOrgs);
       localStorage.setItem("orgRepos", JSON.stringify(userOrgRepos));
+      renderOrgPicker(renderer, userOrgs);
 
-      if (Object.keys(cache).length === 0) {
-        const manifestCache = await fetcher.fetchMarketplaceManifests();
-        localStorage.setItem("manifestCache", JSON.stringify(manifestCache));
-        // this is going to extract URLs from our official config which we'll inject into `- plugin: ...`
-        await fetcher.fetchOfficialPluginConfig();
-      }
+      await fetcher.fetchMarketplaceManifests();
+      await fetcher.fetchOfficialPluginConfig();
+      renderer.manifestGuiBody.dataset.loading = "false";
+      killNotification();
     } else {
-      renderer.renderOrgPicker([]);
+      renderOrgPicker(renderer, []);
     }
   } catch (error) {
     if (error instanceof Error) {
@@ -76,10 +44,4 @@ export async function mainModule() {
   }
 }
 
-mainModule()
-  .then(() => {
-    console.log("mainModule loaded");
-  })
-  .catch((error) => {
-    console.error(error);
-  });
+mainModule().catch(console.error);