@studiocms/devapps 0.1.0-beta.10

package/dist/utils/wp-api/utils.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Removes all HTML tags from a given string.
+ *
+ * @param string - The input string containing HTML tags.
+ * @returns The input string with all HTML tags removed.
+ */
+export declare function stripHtml(string: string): string;
+/**
+ * Cleans up the provided HTML string by removing certain attributes from images
+ * and modifying specific elements related to WordPress polls.
+ *
+ * @param html - The HTML string to be cleaned up.
+ * @returns The cleaned-up HTML string.
+ */
+export declare const cleanUpHtml: (html: string) => string;
+/**
+ * Downloads an image from the specified URL and saves it to the given destination.
+ *
+ * @param {string | URL} imageUrl - The URL of the image to download.
+ * @param {string | URL} destination - The file path where the image should be saved.
+ * @returns {Promise<boolean>} - A promise that resolves to true if the image was successfully downloaded,
+ *                               or false if the download failed or the file already exists.
+ *
+ * @throws {Error} - Throws an error if there is an issue with the fetch request or file writing.
+ */
+export declare function downloadImage(imageUrl: string | URL, destination: string | URL): Promise<boolean>;
+/**
+ * Downloads an image from the given source URL and saves it to the specified folder.
+ *
+ * @param src - The URL of the image to download.
+ * @param pathToFolder - The path to the folder where the image should be saved.
+ * @returns The file name of the downloaded image if successful, otherwise `undefined`.
+ *
+ * @remarks
+ * - If the `src` or `pathToFolder` parameters are not provided, the function will return immediately.
+ * - If the specified folder does not exist, it will be created recursively.
+ * - If the image already exists in the specified folder, the function will log a message and skip the download.
+ * - If the image download fails, the source URL will be added to the `imagesNotDownloaded` array.
+ */
+export declare const downloadPostImage: (src: string, pathToFolder: string) => Promise<string | undefined>;
+/**
+ * Downloads and updates the image sources in the provided HTML string.
+ *
+ * This function parses the given HTML string, finds all image elements,
+ * downloads the images to the specified folder, and updates the image
+ * sources to point to the downloaded images.
+ *
+ * @param html - The HTML string containing image elements to be processed.
+ * @param pathToFolder - The path to the folder where images should be downloaded.
+ * @returns A promise that resolves to the updated HTML string with new image sources.
+ */
+export declare const downloadAndUpdateImages: (html: string, pathToFolder: string) => Promise<string>;
+/**
+ * Constructs a WordPress API endpoint URL based on the provided parameters.
+ *
+ * @param endpoint - The base URL of the WordPress website.
+ * @param type - The type of resource to access. Can be 'posts', 'pages', 'media', 'categories', 'tags', or 'settings'.
+ * @param path - An optional path to append to the endpoint.
+ * @returns The constructed URL object pointing to the desired API endpoint.
+ * @throws {AstroError} If the `endpoint` argument is missing.
+ */
+export declare const apiEndpoint: (endpoint: string, type: "posts" | "pages" | "media" | "categories" | "tags" | "settings", path?: string) => URL;
+/**
+ * Fetch all pages for a paginated WP endpoint.
+ */
+export declare function fetchAll(url: URL, page?: number, results?: any[]): Promise<any[]>;

package/dist/utils/wp-api/utils.js

@@ -0,0 +1,138 @@
+import fs from "node:fs";
+import path from "node:path";
+import { AstroError } from "astro/errors";
+import * as cheerio from "cheerio";
+const imagesNotDownloaded = [];
+function stripHtml(string) {
+  return string.replace(/<[^>]*>/g, "");
+}
+const cleanUpHtml = (html) => {
+  const $ = cheerio.load(html);
+  const images = $("img");
+  for (const image of images) {
+    $(image).removeAttr("class width height data-recalc-dims sizes srcset");
+  }
+  $(".wp-polls").html(
+    "<em>Polls have been temporarily removed while we migrate to a new platform.</em>"
+  );
+  $(".wp-polls-loading").remove();
+  return $.html();
+};
+async function downloadImage(imageUrl, destination) {
+  if (fs.existsSync(destination)) {
+    console.error("File already exists:", destination);
+    return true;
+  }
+  try {
+    const response = await fetch(imageUrl);
+    if (response.ok && response.body) {
+      const reader = response.body.getReader();
+      const chunks = [];
+      let done = false;
+      while (!done) {
+        const { done: readerDone, value } = await reader.read();
+        if (value) {
+          chunks.push(value);
+        }
+        done = readerDone;
+      }
+      const fileBuffer = Buffer.concat(chunks);
+      fs.writeFileSync(destination, fileBuffer, { flag: "wx" });
+      console.log("Downloaded image:", imageUrl);
+      return true;
+    }
+    console.error("Failed to download image:", imageUrl);
+    return false;
+  } catch (error) {
+    console.error("Failed to download image:", imageUrl, error);
+    return false;
+  }
+}
+const downloadPostImage = async (src, pathToFolder) => {
+  if (!src || !pathToFolder) {
+    return;
+  }
+  if (!fs.existsSync(pathToFolder)) {
+    fs.mkdirSync(pathToFolder, { recursive: true });
+  }
+  const fileName = path.basename(src).split("?")[0];
+  const destinationFile = path.resolve(pathToFolder, fileName);
+  if (fs.existsSync(destinationFile)) {
+    console.log(`Post/Page image "${destinationFile}" already exists, skipping...`);
+    return fileName;
+  }
+  const imageDownloaded = await downloadImage(src, destinationFile);
+  if (!imageDownloaded) {
+    imagesNotDownloaded.push(src);
+  }
+  return imageDownloaded ? fileName : void 0;
+};
+const downloadAndUpdateImages = async (html, pathToFolder) => {
+  const $ = cheerio.load(html);
+  const images = $("img");
+  for (const image of images) {
+    const src = $(image).attr("src");
+    if (src) {
+      const newSrc = await downloadPostImage(src, pathToFolder);
+      $(image).attr("src", newSrc);
+    }
+  }
+  return $.html();
+};
+const apiEndpoint = (endpoint, type, path2) => {
+  if (!endpoint) {
+    throw new AstroError(
+      "Missing `endpoint` argument.",
+      "Please pass a URL to your WordPress website as the `endpoint` option to the WordPress importer. Most commonly this looks something like `https://example.com/`"
+    );
+  }
+  let newEndpoint = endpoint;
+  if (!newEndpoint.endsWith("/")) newEndpoint += "/";
+  const apiBase = new URL(newEndpoint);
+  if (type === "settings") {
+    apiBase.pathname = "wp-json/";
+    return apiBase;
+  }
+  apiBase.pathname = `wp-json/wp/v2/${type}/${path2 ? `${path2}/` : ""}`;
+  return apiBase;
+};
+async function fetchAll(url, page = 1, results = []) {
+  url.searchParams.set("per_page", "100");
+  url.searchParams.set("page", String(page));
+  const response = await fetch(url);
+  let data = await response.json();
+  if (!Array.isArray(data)) {
+    if (typeof data === "object") {
+      data = Object.entries(data).map(([id, val]) => {
+        if (typeof val === "object") return { id, ...val };
+        return { id };
+      });
+    } else {
+      throw new AstroError(
+        "Expected WordPress API to return an array of items.",
+        `Received ${typeof data}:
+
+\`\`\`json
+${JSON.stringify(data, null, 2)}
+\`\`\``
+      );
+    }
+  }
+  results.push(...data);
+  const totalPages = Number.parseInt(response.headers.get("X-WP-TotalPages") || "1");
+  console.log("Fetched page", page, "of", totalPages);
+  if (page < totalPages) {
+    console.log("Fetching next page...");
+    return fetchAll(url, page + 1, results);
+  }
+  return results;
+}
+export {
+  apiEndpoint,
+  cleanUpHtml,
+  downloadAndUpdateImages,
+  downloadImage,
+  downloadPostImage,
+  fetchAll,
+  stripHtml
+};

package/dist/virt.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="@astrojs/db" />
+
+declare module 'virtual:studiocms-devapps/endpoints' {
+	export const wpAPIEndpoint: string;
+}
+
+declare module 'virtual:studiocms-devapps/config' {
+	export const userProjectRoot: string;
+	export const dbEnv: {
+		remoteUrl: string;
+		token: string;
+	};
+}

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@studiocms/devapps",
+  "version": "0.1.0-beta.10",
+  "description": "A dedicated CMS for Astro DB. Built from the ground up by the Astro community.",
+  "author": {
+    "name": "Adam Matthiesen | Jacob Jenkins | Paul Valladares",
+    "url": "https://studiocms.dev"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/withstudiocms/studiocms.git",
+    "directory": "packages/studiocms_devapps"
+  },
+  "contributors": [
+    "Adammatthiesen",
+    "jdtjenkins",
+    "dreyfus92"
+  ],
+  "license": "MIT",
+  "keywords": [
+    "astro",
+    "astrodb",
+    "astrolicious",
+    "astro-integration",
+    "studiocms",
+    "withastro",
+    "wordpress",
+    "wordpress-import",
+    "wordpress-importer",
+    "libsql",
+    "libsql-viewer",
+    "libsql-client",
+    "libsqlstudio",
+    "devapp",
+    "astro-devapp",
+    "astro-devtoolbarapp"
+  ],
+  "homepage": "https://studiocms.dev",
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "assets"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "type": "module",
+  "dependencies": {
+    "astro-integration-kit": "^0.18",
+    "@libsql/client": "^0.14.0",
+    "cheerio": "^1.0.0",
+    "turndown": "^7.2.0",
+    "html-entities": "^2.5.2",
+    "@outerbase/sdk-transform": "^1.0.5"
+  },
+  "devDependencies": {
+    "@types/cheerio": "^0.22.35",
+    "@types/turndown": "^5.0.5",
+    "typescript": "^5.7"
+  },
+  "peerDependencies": {
+    "@astrojs/db": "^0.14.7",
+    "astro": "^5.4.0",
+    "vite": "^6.2.0",
+    "studiocms": "0.1.0-beta.10"
+  },
+  "peerDependenciesMeta": {
+    "studiocms": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "build-scripts build 'src/**/*.ts'",
+    "dev": "build-scripts dev 'src/**/*.ts'"
+  }
+}