feat(plugin): store plug-in

Author: paulrobertlloyd

packages/plugin/index.js

@@ -2,4 +2,5 @@ export { IndiekitPlugin } from "./lib/base.js";
 export { IndiekitEndpointPlugin } from "./lib/endpoint.js";
 export { IndiekitPostTypePlugin } from "./lib/post-type.js";
 export { IndiekitPresetPlugin } from "./lib/preset.js";
+export { IndiekitStorePlugin } from "./lib/store.js";
 export { IndiekitSyndicatorPlugin } from "./lib/syndicator.js";

packages/plugin/lib/store.js

@@ -0,0 +1,75 @@
+import makeDebug from "debug";
+
+import { IndiekitPlugin } from "./base.js";
+
+const debug = makeDebug(`indiekit:plugin`);
+
+/**
+ * @typedef StoreInformation
+ * @property {string} name - Name of content store
+ * @property {string} uid - Unique identifier
+ */
+
+/**
+ * Content store plug-in
+ * @class
+ * @augments {IndiekitPlugin}
+ */
+export class IndiekitStorePlugin extends IndiekitPlugin {
+  /**
+   * Content store information
+   * @type {StoreInformation}
+   */
+  info = undefined;
+
+  /**
+   * Create file
+   * @param {string} filePath - Path to file
+   * @returns {Promise<string>} Created file URL
+   */
+  async createFile(filePath) {
+    debug(`Creating ${filePath} to ${this.name}`);
+    return;
+  }
+
+  /**
+   * Read file
+   * @param {string} filePath - Path to file
+   * @returns {Promise<string>} File content
+   */
+  async readFile(filePath) {
+    debug(`Reading ${filePath} at ${this.name}`);
+    return;
+  }
+
+  /**
+   * Update file
+   * @param {string} filePath - Path to file
+   * @returns {Promise<string>} Updated file URL
+   */
+  async updateFile(filePath) {
+    debug(`Updating ${filePath} at ${this.name}`);
+    return;
+  }
+
+  /**
+   * Delete file
+   * @param {string} filePath - Path to file
+   * @returns {Promise<boolean>} File deleted
+   */
+  async deleteFile(filePath) {
+    debug(`Creating ${filePath} to ${this.name}`);
+    return;
+  }
+
+  #addStore() {
+    debug(`Adding content store: ${this.name}`);
+    this.indiekit.stores.add(this);
+  }
+
+  async init() {
+    await super.init();
+
+    this.#addStore();
+  }
+}