feat: content store plug-ins use IndiekitStorePlugin

Author: paulrobertlloyd

helpers/store/index.js

@@ -1,4 +1,5 @@
 import { IndiekitError } from "@indiekit/error";
+import { IndiekitStorePlugin } from "@indiekit/plugin";
 
 const defaults = {
   baseUrl: "https://store.example",
@@ -8,17 +9,22 @@ const defaults = {
  * @typedef Response
  * @property {object} response - HTTP response
  */
-export default class TestStore {
+export default class TestStorePlugin extends IndiekitStorePlugin {
+  name = "Test store";
+
+  /**
+   * @param {object} [options] - Plug-in options
+   * @param {string} [options.baseUrl] - Base URL
+   * @param {string} [options.user] - Username
+   */
   constructor(options = {}) {
-    this.name = "Test store";
+    super(options);
+
     this.options = { ...defaults, ...options };
-  }
 
-  get info() {
-    const { baseUrl, user } = this.options;
-    return {
+    this.info = {
       name: "Test store",
-      uid: `${baseUrl}/${user}`,
+      uid: `${this.options.baseUrl}/${this.options.user}`,
     };
   }
 
@@ -102,8 +108,4 @@ export default class TestStore {
     await this.#client(path, "DELETE", { message });
     return true;
   }
-
-  init(Indiekit) {
-    Indiekit.addStore(this);
-  }
 }

packages/store-bitbucket/index.js

@@ -2,6 +2,7 @@ import path from "node:path";
 import process from "node:process";
 
 import { IndiekitError } from "@indiekit/error";
+import { IndiekitStorePlugin } from "@indiekit/plugin";
 // eslint-disable-next-line import/default
 import bitbucket from "bitbucket";
 
@@ -13,7 +14,33 @@ const defaults = {
 /**
  * @typedef {import("bitbucket").APIClient} APIClient
  */
-export default class BitbucketStore {
+export default class BitbucketStorePlugin extends IndiekitStorePlugin {
+  environment = ["BITBUCKET_PASSWORD"];
+
+  name = "Bitbucket store";
+
+  /**
+   * @type {import('prompts').PromptObject[]}
+   */
+  prompts = [
+    {
+      type: "text",
+      name: "user",
+      message: "What is your Bitbucket username?",
+    },
+    {
+      type: "text",
+      name: "repo",
+      message: "Which repository is your publication stored on?",
+    },
+    {
+      type: "text",
+      name: "branch",
+      message: "Which branch are you publishing from?",
+      initial: defaults.branch,
+    },
+  ];
+
   /**
    * @param {object} [options] - Plug-in options
    * @param {string} [options.user] - Username
@@ -22,44 +49,16 @@ export default class BitbucketStore {
    * @param {string} [options.password] - Password
    */
   constructor(options = {}) {
-    this.name = "Bitbucket store";
-    this.options = { ...defaults, ...options };
-  }
-
-  get environment() {
-    return ["BITBUCKET_PASSWORD"];
-  }
+    super(options);
 
-  get info() {
-    const { repo, user } = this.options;
+    this.options = { ...defaults, ...options };
 
-    return {
-      name: `${user}/${repo} on Bitbucket`,
-      uid: `https://bitbucket.org/${user}/${repo}`,
+    this.info = {
+      name: `${this.options.user}/${this.options.repo} on Bitbucket`,
+      uid: `https://bitbucket.org/${this.options.user}/${this.options.repo}`,
     };
   }
 
-  get prompts() {
-    return [
-      {
-        type: "text",
-        name: "user",
-        message: "What is your Bitbucket username?",
-      },
-      {
-        type: "text",
-        name: "repo",
-        message: "Which repository is your publication stored on?",
-      },
-      {
-        type: "text",
-        name: "branch",
-        message: "Which branch are you publishing from?",
-        initial: defaults.branch,
-      },
-    ];
-  }
-
   /**
    * @access private
    * @returns {APIClient} Bitbucket client interface
@@ -228,8 +227,4 @@ export default class BitbucketStore {
       });
     }
   }
-
-  init(Indiekit) {
-    Indiekit.addStore(this);
-  }
 }

packages/store-bitbucket/package.json

@@ -33,6 +33,7 @@
   },
   "dependencies": {
     "@indiekit/error": "^1.0.0-beta.15",
+    "@indiekit/plugin": "^1.0.0-beta.19",
     "bitbucket": "^2.6.2"
   },
   "publishConfig": {

packages/store-file-system/index.js

@@ -4,6 +4,7 @@ import path from "node:path";
 import process from "node:process";
 
 import { IndiekitError } from "@indiekit/error";
+import { IndiekitStorePlugin } from "@indiekit/plugin";
 
 const defaults = {
   directory: process.cwd(),
@@ -13,31 +14,35 @@ const defaults = {
  * @typedef Response
  * @property {object} response - Response
  */
-export default class FileSystemStore {
+export default class FileSystemStorePlugin extends IndiekitStorePlugin {
+  name = "File system store";
+
+  /**
+   * @type {import('prompts').PromptObject[]}
+   */
+  prompts = [
+    {
+      type: "text",
+      name: "directory",
+      message: "Which directory do you want to save files in?",
+    },
+  ];
+
+  /**
+   * @param {object} [options] - Plug-in options
+   * @param {string} [options.directory] - Directory to save files to
+   */
   constructor(options = {}) {
-    this.name = "File system store";
-    this.options = { ...defaults, ...options };
-  }
+    super(options);
 
-  get info() {
-    const { directory } = this.options;
+    this.options = { ...defaults, ...options };
 
-    return {
-      name: directory,
-      uid: `file://${directory}`,
+    this.info = {
+      name: this.options.directory,
+      uid: `file://${this.options.directory}`,
     };
   }
 
-  get prompts() {
-    return [
-      {
-        type: "text",
-        name: "directory",
-        message: "Which directory do you want to save files in?",
-      },
-    ];
-  }
-
   /**
    * Get absolute file path
    * @access private
@@ -133,8 +138,4 @@ export default class FileSystemStore {
       });
     }
   }
-
-  init(Indiekit) {
-    Indiekit.addStore(this);
-  }
 }

packages/store-file-system/package.json

@@ -32,7 +32,8 @@
     "directory": "packages/store-file-system"
   },
   "dependencies": {
-    "@indiekit/error": "^1.0.0-beta.15"
+    "@indiekit/error": "^1.0.0-beta.15",
+    "@indiekit/plugin": "^1.0.0-beta.19"
   },
   "publishConfig": {
     "access": "public"

packages/store-ftp/index.js

@@ -3,6 +3,7 @@ import process from "node:process";
 import { Readable } from "node:stream";
 
 import { IndiekitError } from "@indiekit/error";
+import { IndiekitStorePlugin } from "@indiekit/plugin";
 import Client from "ssh2-sftp-client";
 
 const defaults = {
@@ -12,7 +13,32 @@ const defaults = {
   user: process.env.FTP_USER,
 };
 
-export default class FtpStore {
+export default class FtpStorePlugin extends IndiekitStorePlugin {
+  environment = ["FTP_PASSWORD", "FTP_USER"];
+
+  name = "FTP store";
+
+  /**
+   * @type {import('prompts').PromptObject[]}
+   */
+  prompts = [
+    {
+      type: "text",
+      name: "host",
+      message: "Where is your FTP server hosted?",
+    },
+    {
+      type: "text",
+      name: "user",
+      message: "What is your FTP username?",
+    },
+    {
+      type: "text",
+      name: "directory",
+      message: "Which directory do you want to save files in?",
+    },
+  ];
+
   /**
    * @param {object} [options] - Plug-in options
    * @param {string} [options.host] - FTP hostname
@@ -22,44 +48,16 @@ export default class FtpStore {
    * @param {string} [options.directory] - Directory
    */
   constructor(options = {}) {
-    this.name = "FTP store";
-    this.options = { ...defaults, ...options };
-  }
+    super(options);
 
-  get environment() {
-    return ["FTP_PASSWORD", "FTP_USER"];
-  }
-
-  get info() {
-    const { directory, host, user } = this.options;
+    this.options = { ...defaults, ...options };
 
-    return {
-      name: `${user} on ${host}`,
-      uid: `sftp://${host}/${directory}`,
+    this.info = {
+      name: `${this.options.user} on ${this.options.host}`,
+      uid: `sftp://${this.options.host}/${this.options.directory}`,
     };
   }
 
-  get prompts() {
-    return [
-      {
-        type: "text",
-        name: "host",
-        message: "Where is your FTP server hosted?",
-        description: "i.e. ftp.server.example",
-      },
-      {
-        type: "text",
-        name: "user",
-        message: "What is your FTP username?",
-      },
-      {
-        type: "text",
-        name: "directory",
-        message: "Which directory do you want to save files in?",
-      },
-    ];
-  }
-
   /**
    * Get FTP client interface
    * @access private
@@ -232,8 +230,4 @@ export default class FtpStore {
       await client.end();
     }
   }
-
-  init(Indiekit) {
-    Indiekit.addStore(this);
-  }
 }

packages/store-ftp/package.json

@@ -34,6 +34,7 @@
   },
   "dependencies": {
     "@indiekit/error": "^1.0.0-beta.15",
+    "@indiekit/plugin": "^1.0.0-beta.19",
     "ssh2-sftp-client": "^11.0.0"
   },
   "publishConfig": {