`Indiekit.addStore`

A content store plug-in interfaces with CRUD (create, read, update, delete) methods provided by a file system, server, database or API.

Constructor

Property	Type	Description
`id`	`String`	Kebab-cased plug-in ID. Required.
`meta`	`import.meta`	Required.
`name`	`String`	Human readable plug-in name. Required.
`options`	`Object`	Plug-in options. Optional.

Properties

Property	Type	Description
`info`	`Object`	Information about the content store. Required.

`info`

Indiekit’s web interface expects a content store plugin to provide some information about the content store it supports. This is provided by the info property:

get info() {
  return {
    name: "Example content store",
    uid: "https://store.example"
  };
}

get info() {
  return {
    name: "Example content store",
    uid: "https://store.example"
  };
}

The info property returns the following values:

Property	Type	Description
`name`	`String`	The name of the content store the preset supports. Required.
`uid`	`String`	URL or path to content store. Required.

Methods

Method	Type	Description
`createFile()`	`async function`	Create a file on the content store.
`readFile()`	`async function`	Read a file from the content store.
`updateFile()`	`async function`	Update a file on the content store.
`deleteFile()`	`async function`	Delete a file on the content store.

`createFile()`

Parameters	Type	Description
`filePath`	`String`	Path to file. Required.
`content`	`String`	File content. Required.
`options.message`	`String`	Commit message. Optional.

Returns a String containing the file’s URL if successful, else returns IndiekitError. For example:

async createFile(filePath, content, { message }) {
  try {
    await exampleClient.create(filePath, content, message);
    return true;
  } catch (error) {
    throw new IndiekitError(error.message);
  }
}

async createFile(filePath, content, { message }) {
  try {
    await exampleClient.create(filePath, content, message);
    return true;
  } catch (error) {
    throw new IndiekitError(error.message);
  }
}

`readFile()`

Parameters	Type	Description
`filePath`	`String`	Path to file. Required.

Returns content as a String containing the file’s content if successful, else returns IndiekitError. For example:

async readFile(filePath) {
  try {
    await exampleClient.read(filePath);
    return true;
  } catch (error) {
    throw new IndiekitError(error.message);
  }
}

async readFile(filePath) {
  try {
    await exampleClient.read(filePath);
    return true;
  } catch (error) {
    throw new IndiekitError(error.message);
  }
}

`updateFile()`

Parameters	Type	Description
`filePath`	`String`	Path to file. Required.
`content`	`String`	File content. Required.
`options.message`	`String`	Commit message. Optional.
`options.newPath`	`String`	New path to file. Optional.

Returns a String containing the file’s updated URL if successful, else returns IndiekitError. For example:

async updateFile(filePath, content, { message, newPath }) {
  try {
    await exampleClient.update(filePath, content, message, newPath);
    return true;
  } catch (error) {
    throw new IndiekitError(error.message);
  }
}

async updateFile(filePath, content, { message, newPath }) {
  try {
    await exampleClient.update(filePath, content, message, newPath);
    return true;
  } catch (error) {
    throw new IndiekitError(error.message);
  }
}

`deleteFile()`

Parameters	Type	Description
`filePath`	`String`	Path to file. Required.
`options.message`	`String`	Commit message. Optional.

Returns a Boolean true if successful, else returns IndiekitError. For example:

async deleteFile(filePath, { message }) {
  try {
    await exampleClient.delete(filePath, message);
    return true;
  } catch (error) {
    throw new IndiekitError(error.message);
  }
}

async deleteFile(filePath, { message }) {
  try {
    await exampleClient.delete(filePath, message);
    return true;
  } catch (error) {
    throw new IndiekitError(error.message);
  }
}

Example

import { IndiekitError } from "@indiekit/error";
import exampleClient from 'example-client';

export default class ExampleStore {
  constructor() {
    this.id = "example-store";
    this.meta = import.meta;
    this.name = "Example store";
  }

  get info() {
    return {
      name: "Example application",
      uid: "https://store.example"
    };
  }

  async createFile(filePath, content, message) {
    try {
      await exampleClient.create(filePath, content, message);
      return true;
    } catch (error) {
      throw new IndiekitError(error.message);
    }
  }

  async readFile(filePath) {
    try {
      await exampleClient.read(filePath);
      return true;
    } catch (error) {
      throw new IndiekitError(error.message);
    }
  }

  async updateFile(filePath, content, message) {
    try {
      await exampleClient.update(filePath, content, message);
      return true;
    } catch (error) {
      throw new IndiekitError(error.message);
    }
  }

  async deleteFile(filePath, message) {
    try {
      await exampleClient.delete(filePath, content, message);
      return true;
    } catch (error) {
      throw new IndiekitError(error.message);
    }
  }

  init(Indiekit) {
    Indiekit.addStore(this);
  }
}

import { IndiekitError } from "@indiekit/error";
import exampleClient from 'example-client';

export default class ExampleStore {
  constructor() {
    this.id = "example-store";
    this.meta = import.meta;
    this.name = "Example store";
  }

  get info() {
    return {
      name: "Example application",
      uid: "https://store.example"
    };
  }

  async createFile(filePath, content, message) {
    try {
      await exampleClient.create(filePath, content, message);
      return true;
    } catch (error) {
      throw new IndiekitError(error.message);
    }
  }

  async readFile(filePath) {
    try {
      await exampleClient.read(filePath);
      return true;
    } catch (error) {
      throw new IndiekitError(error.message);
    }
  }

  async updateFile(filePath, content, message) {
    try {
      await exampleClient.update(filePath, content, message);
      return true;
    } catch (error) {
      throw new IndiekitError(error.message);
    }
  }

  async deleteFile(filePath, message) {
    try {
      await exampleClient.delete(filePath, content, message);
      return true;
    } catch (error) {
      throw new IndiekitError(error.message);
    }
  }

  init(Indiekit) {
    Indiekit.addStore(this);
  }
}

Example content store plug-ins:

@indiekit/store-github saves content to a GitHub repository.
@indiekit/store-file-system saves content to a directory on a local file system.