10 implement feed

package.json

@@ -36,11 +36,9 @@
     "@types/mocha": "^9.0.0",
     "@types/node": "^16.18.29",
     "chai": "^4",
-    "eslint": "^7.32.0",
-    "eslint-config-oclif": "^4",
-    "eslint-config-oclif-typescript": "^1.0.3",
     "mocha": "^9",
     "oclif": "^3",
+    "prettier": "^3.0.0",
     "shx": "^0.3.3",
     "ts-node": "^10.9.1",
     "tslib": "^2.5.0",
@@ -63,7 +61,8 @@
   },
   "scripts": {
     "build": "shx rm -rf dist && tsc -b",
-    "lint": "eslint . --ext .ts --config .eslintrc",
+    "lint": "prettier --check src",
+    "lint-fix": "prettier --write src",
     "postpack": "shx rm -f oclif.manifest.json",
     "posttest": "yarn lint",
     "prepack": "yarn build && oclif manifest && oclif readme",

src/commands/feed/add.ts

@@ -0,0 +1,57 @@
+import { Command, Flags } from "@oclif/core";
+import { startOrbitDB } from "../../services/start-OrbitDB";
+import { stopOrbitDB } from "../../services/stop-OrbitDB";
+import { doesDBExists } from "../../utils/does-DBExists";
+import { openDB } from "../../utils/open-DB";
+import { resolveDBIdByName } from "../../utils/resolve-DBIdByName";
+import { saveDB } from "../../utils/save-DB";
+
+export default class FeedAdd extends Command {
+  static description = "Add a file to a feed type database";
+
+  static examples: Command.Example[] = [
+    "<%= config.bin %> <%= command.id %> --name=myFeedDbName --file=myFile",
+  ];
+
+  static flags = {
+    // flag with a value (-n VALUE, --name=VALUE)
+    dbName: Flags.string({
+      char: "n",
+      description: "name of the database",
+      required: true,
+    }),
+    // flag with a value (-n VALUE, --name=VALUE)
+    data: Flags.string({
+      char: "f",
+      description: "file to add into db",
+      required: true,
+      multiple: true,
+    }),
+  };
+
+  public async run(): Promise<void> {
+    const { flags } = await this.parse(FeedAdd);
+    const orbitdb = await startOrbitDB(true);
+    const dbAdress = await resolveDBIdByName(orbitdb, flags.dbName, "feed");
+    const DBExists = await doesDBExists(orbitdb, dbAdress);
+
+    if (!DBExists) {
+      this.error(
+        `database '${flags.dbName}' (or '${dbAdress}') does not exist`,
+      );
+    }
+
+    const db = await openDB(orbitdb, dbAdress, "feed");
+    flags.data.forEach(async (data) => {
+      try {
+        const hash = await db.add(data);
+        this.log(`added data: '${data}' to feed '${flags.dbName}' database : ${hash}`);
+      } catch (error) {
+        this.log(`Error occured while adding entry: ${error}`);
+      }
+    });
+    await saveDB(db);
+    await db.close();
+    await stopOrbitDB(orbitdb);
+  }
+}

src/commands/feed/create.ts

@@ -1,30 +1,38 @@
-import { startOrbitDB } from '../../services/start-OrbitDB';
-import { stopOrbitDB } from '../../services/stop-OrbitDB';
-import { createDB } from '../../utils/create-DB';
-import { Command, Flags } from '@oclif/core';
+import { Command, Flags } from "@oclif/core";
+import { startOrbitDB } from "../../services/start-OrbitDB";
+import { stopOrbitDB } from "../../services/stop-OrbitDB";
+import { createDB } from "../../utils/create-DB";
 
-
-export default class Create extends Command {
-  static description = 'Create a feed type database'
+export default class FeedCreate extends Command {
+  static description = "Create a feed type database";
 
   static examples = [
-    '<%= config.bin %> <%= command.id %> --name=myFeedDbLOL',
-    '<%= config.bin %> <%= command.id %> --name=myFeedDbLOL --force',
-  ]
+    "<%= config.bin %> <%= command.id %> --name=myFeedDbLOL",
+    "<%= config.bin %> <%= command.id %> --name=myFeedDbLOL --force",
+  ];
 
   static flags = {
     // flag with a value (-n VALUE, --name=VALUE)
-    name: Flags.string({ char: 'n', description: 'name of the database', required: true }),
+    name: Flags.string({
+      char: "n",
+      description: "name of the database",
+      required: true,
+    }),
     // flag with no value (-f, --force)
-    force: Flags.boolean({ char: 'f', description: 'force overwrite if DB already exists' }),
-  }
+    force: Flags.boolean({
+      char: "f",
+      description: "force overwrite if DB already exists",
+    }),
+  };
 
   public async run(): Promise<void> {
-    const { flags } = await this.parse(Create);
+    const { flags } = await this.parse(FeedCreate);
     const orbitdb = await startOrbitDB(true);
 
     this.log(`creating database name: ${flags.name} ...`);
-    const db = await createDB(orbitdb, flags.name, 'feed', flags.force);
+    const db = await createDB(orbitdb, flags.name, "feed", {
+      overwrite: flags.force,
+    });
     this.log(`created database: ${db.address}`);
     await stopOrbitDB(orbitdb);
   }

src/commands/feed/del.ts

@@ -0,0 +1,55 @@
+import { Command, Flags } from "@oclif/core";
+import { startOrbitDB } from "../../services/start-OrbitDB";
+import { stopOrbitDB } from "../../services/stop-OrbitDB";
+import { doesDBExists } from "../../utils/does-DBExists";
+import { openDB } from "../../utils/open-DB";
+import { resolveDBIdByName } from "../../utils/resolve-DBIdByName";
+import { saveDB } from "../../utils/save-DB";
+
+export default class FeedDel extends Command {
+  static description = "Delete a file to a feed type database";
+
+  static examples: Command.Example[] = [
+    "<%= config.bin %> <%= command.id %> --name=myFeedDbName --file=myFile",
+  ];
+
+  static flags = {
+    // flag with a value (-n VALUE, --name=VALUE)
+    dbName: Flags.string({
+      char: "n",
+      description: "name of the database",
+      required: true,
+    }),
+    // flag with a value (-n VALUE, --name=VALUE)
+    entries: Flags.integer({
+      char: "e",
+      description: "sequence number of the entry you want to delete",
+      required: true,
+      multiple: true,
+    }),
+  };
+
+  public async run(): Promise<void> {
+    const { flags } = await this.parse(FeedDel);
+    const orbitdb = await startOrbitDB(true);
+    const dbAdress = await resolveDBIdByName(orbitdb, flags.dbName, "feed");
+    const DBExists = await doesDBExists(orbitdb, dbAdress);
+
+    if (!DBExists) {
+      this.error(
+        `database '${flags.dbName}' (or '${dbAdress}') does not exist`,
+      );
+    }
+
+    const db = await openDB(orbitdb, dbAdress, "feed");
+    flags.entries.forEach(async (entry) => {
+      await db.del(entry);
+      this.log(
+        `deleted entry number ${entry} from feed '${flags.dbName}' database`,
+      );
+    });
+    await saveDB(db);
+    await db.close();
+    await stopOrbitDB(orbitdb);
+  }
+}

src/commands/feed/drop.ts

@@ -0,0 +1,73 @@
+import { Command, Flags, ux } from "@oclif/core";
+import { rm } from "node:fs/promises";
+import * as path from "node:path";
+import { startOrbitDB } from "../..//services/start-OrbitDB";
+import { stopOrbitDB } from "../../services/stop-OrbitDB";
+import { doesDBExists } from "../../utils/does-DBExists";
+import { openDB } from "../../utils/open-DB";
+import { resolveDBIdByName } from "../../utils/resolve-DBIdByName";
+
+export default class FeedDrop extends Command {
+  static description =
+    "Delete a feed type database locally (This doesn't remove data on other nodes that have the removed database replicated.)";
+
+  static examples = [
+    "<%= config.bin %> <%= command.id %> --name=myFeedDbLOL",
+    "<%= config.bin %> <%= command.id %> --name=myFeedDbLOL -y",
+  ];
+
+  static flags = {
+    // flag with a value (-n VALUE, --name=VALUE)
+    name: Flags.string({
+      char: "n",
+      description: "name of the database",
+      required: true,
+    }),
+    // flag with no value (-y, --yes)
+    yes: Flags.boolean({
+      char: "y",
+      description:
+        "confirm drop (without this option you will be asked to confirm)",
+    }),
+  };
+
+  public async run(): Promise<void> {
+    const { flags } = await this.parse(FeedDrop);
+    const orbitdb = await startOrbitDB(true);
+    const name = await resolveDBIdByName(orbitdb, flags.name, "feed");
+    const DBExists = await doesDBExists(orbitdb, name);
+
+    if (!DBExists) {
+      this.error(`database '${flags.name}' (or '${name}') does not exist`);
+    }
+
+    const db = await openDB(orbitdb, name, "feed");
+
+    if (!flags.yes) {
+      const confirm = await ux.prompt(
+        `Are you sure you want to drop the database '${name}' (y/n)?`,
+      );
+      if (confirm !== "y") {
+        this.log('aborting (response was not "y")');
+        await stopOrbitDB(orbitdb);
+        return;
+      }
+    }
+
+    // this was in https://github.com/orbitdb/orbit-db-cli/blob/f70880de90e8d1005a936bea93736ef762f25321/src/commands/drop.js#L35C5-L36C1
+    const dbCachePath = path.join(
+      "./",
+      db._cache.path +
+        "/" +
+        db.address.toString().replace("/orbitdb/", "") +
+        ".orbitdb",
+    );
+
+    this.log(`droping database name: ${name} ...`);
+    await db.drop();
+    await db.close();
+    await rm(dbCachePath, { recursive: true, force: true });
+    this.log(`droped database: ${name}`);
+    await stopOrbitDB(orbitdb);
+  }
+}

src/commands/feed/index.ts

@@ -1,24 +1,15 @@
-import { Command } from '@oclif/core'
+import { Command } from "@oclif/core";
 
 export default class Feed extends Command {
-  static description = 'feed related commands'
+  static description = "feed related commands (see examples below)";
 
-  static examples = [
-    '$ orbitdb feed --help',
-  ]
+  static examples = ["<%= config.bin %> <%= command.id %> --help"];
 
-  static flags = {
-    // flag with a value (-n, --name=VALUE)
-    // name: Flags.string({char: 'n', description: 'name to print'}),
-    // flag with no value (-f, --force)
-    // force: Flags.boolean({char: 'f'}),
-  }
+  static flags = {};
 
-  static args = {
-    // databaseName: Args.string({description: 'name of the database to create'}),
-  }
+  static args = {};
 
   public async run(): Promise<void> {
-    this.log(`feed basic command`)
+    this.error("try 'feed --help' for more information");
   }
 }

src/commands/feed/info.ts

@@ -0,0 +1,51 @@
+import { Command, Flags } from "@oclif/core";
+import { startOrbitDB } from "../../services/start-OrbitDB";
+import { stopOrbitDB } from "../../services/stop-OrbitDB";
+import { doesDBExists } from "../../utils/does-DBExists";
+import { openDB } from "../../utils/open-DB";
+import { resolveDBIdByName } from "../../utils/resolve-DBIdByName";
+import { saveDB } from "../../utils/save-DB";
+
+export default class FeedInfo extends Command {
+  static description = "Show informations about a feed type database";
+
+  static examples: Command.Example[] = [
+    "<%= config.bin %> <%= command.id %> --name=myFeedDbName --file=myFile",
+  ];
+
+  static flags = {
+    // flag with a value (-n VALUE, --name=VALUE)
+    dbName: Flags.string({
+      char: "n",
+      description: "name of the database",
+      required: true,
+    }),
+  };
+
+  public async run(): Promise<void> {
+    const { flags } = await this.parse(FeedInfo);
+    const orbitdb = await startOrbitDB(true);
+    const dbAdress = await resolveDBIdByName(orbitdb, flags.dbName, "feed");
+    const DBExists = await doesDBExists(orbitdb, dbAdress);
+
+    if (!DBExists) {
+      this.error(
+        `database '${flags.dbName}' (or '${dbAdress}') does not exist`,
+      );
+    }
+
+    const db = await openDB(orbitdb, dbAdress, "feed")
+    this.log('--- Database informations ---\n')
+    this.log(`Name: ${db.dbname}`)
+    this.log(`Type: ${db._type}`)
+    this.log(`Adress: ${db.address.toString()}`)
+    this.log(`Owner: ${db.id}`)
+    this.log(`Data file: ./${db._cache.path}`)
+    this.log(`Entries: ${db._oplog.length}`)
+    this.log(`Write-Access: ${db.access.write}`)
+
+    await saveDB(db);
+    await db.close();
+    await stopOrbitDB(orbitdb);
+  }
+}