Pre release QA Part 2 (#58)

* Storage -> Store

* Export core/messages

.gitignore

@@ -15,7 +15,7 @@ dist
 *.js
 *.d.ts
 docs
-core
+/core
 
 ### ignore typechain types
 /src/types/typechain/*

README.md

@@ -45,7 +45,7 @@ setConfig({
 Amazon S3 is supported when adding the following configuration:
 ```typescript
 import { setConfig } from "@dsnp/sdk";
-import { S3Node } from "@dsnp/sdk/core/storage";
+import { S3Node } from "@dsnp/sdk/core/store";
 
 setConfig({
   ...,
@@ -59,7 +59,7 @@ setConfig({
 ```
 Other storage solutions can be added so as long it contains the following interface.
 ```typescript
-interface StorageInterface {
+interface StoreInterface {
   put: (targetPath: string, content: Content) => Promise<URL>;
   get?: (targetPath: string) => Promise<string>;
 }
@@ -68,7 +68,7 @@ interface StorageInterface {
 ```
 config
   .setConfig({
-    storage: new MyStorage()
+    store: new MyStore()
    });
 ```
 

src/config.ts

@@ -1,8 +1,8 @@
 import { ethers } from "ethers";
 
 import MemoryQueue from "./core/queue/memoryQueue";
-import { QueueInterface } from "./core/queue/queue";
-import { StorageInterface } from "./core/storage/storage";
+import { QueueInterface } from "./core/queue";
+import { StoreInterface } from "./core/store";
 import { HexString } from "./types/Strings";
 
 /**
@@ -16,7 +16,7 @@ export interface Config {
   /** The queue manages Announcements waiting to be batched */
   queue: QueueInterface;
   /** The Storage handles storing batch, content, and other media files at a publicly accessible location */
-  store?: StorageInterface;
+  store?: StoreInterface;
   /** Contracts are different addresses for specific contracts or for running custom tests */
   contracts: {
     /** The Address of the Batch Announce contract */

src/content.ts

@@ -1,5 +1,5 @@
 // import * as config from "../config/config";
-// import * as storage from "../storage/storage";
+// import * as store from "../store";
 import { ActivityPubOpts } from "./core/activityPub/activityPub";
 import { ConfigOpts } from "./config";
 import { NotImplementedError } from "./core/utilities/errors";
@@ -20,7 +20,7 @@ export const broadcast = async (_content: ActivityPubOpts, _opts?: ConfigOpts):
   //
   // const activityPubObject = activityPub.create(activityPubOpts);
   // const activityPubHash = activityPub.hash(activityPubObject);
-  // const uri = storage.store(activityPubObject, opts);
+  // const uri = store.put(activityPubObject, opts);
   //
   // return events.createBroadcastEvent(uri, activityPubHash);
 };
@@ -41,7 +41,7 @@ export const reply = async (_content: ActivityPubOpts, _opts?: ConfigOpts): Prom
   // const inReplyTo = activityPubOpts.inReplyTo;
   // const activityPubObject = activityPub.create(activityPubOpts);
   // const activityPubHash = activityPub.hash(activityPubObject);
-  // const uri = storage.store(activityPubObject, opts);
+  // const uri = store.put(activityPubObject, opts);
   //
   // return events.createReplyEvent(uri, inReplyTo, activityPubHash);
 };
@@ -63,7 +63,7 @@ export const react = async (_emoji: string, _inReplyTo: string, _opts?: ConfigOp
   // const inReplyTo = activityPubOpts.inReplyTo;
   // const activityPubObject = activityPub.create(activityPubOpts);
   // const activityPubHash = activityPub.hash(activityPubObject);
-  // const uri = storage.store(activityPubObject, opts);
+  // const uri = store.put(activityPubObject, opts);
   //
   // return events.createReactionEvent(uri, inReplyTo, activityPubHash);
 };

src/core/index.ts

@@ -18,11 +18,14 @@ export const batch = batchImport;
 import * as contractsImport from "./contracts";
 export const contracts = contractsImport;
 
+import * as messagesImport from "./messages";
+export const messages = messagesImport;
+
 import * as queueImport from "./queue";
 export const queue = queueImport;
 
-import * as storageImport from "./storage";
-export const storage = storageImport;
+import * as storeImport from "./store";
+export const store = storeImport;
 
 import * as utilitiesImport from "./utilities";
 export const utilities = utilitiesImport;

src/core/storage/index.ts → src/core/store/index.ts

@@ -17,5 +17,5 @@
  *   - `import { foo } from "@dsnp/sdk/contracts"; foo.functionInFoo();`
  */
 
-export * from "./storage";
+export * from "./interface";
 export * from "./s3Node";

src/core/storage/storage.test.ts → src/core/store/interface.test.ts

@@ -1,10 +1,10 @@
 import { getConfig } from "../../config";
 import { MissingStoreError, NotImplementedError } from "../utilities";
-import { get, put } from "./storage";
+import { get, put } from "./interface";
 
 jest.mock("../../config");
 
-describe("storage", () => {
+describe("store", () => {
   describe("#get", () => {
     describe("when store configuration is not set", () => {
       beforeEach(() => {

src/core/storage/storage.ts → src/core/store/interface.ts

@@ -5,11 +5,11 @@ export type File = Buffer | string;
 export type Content = string | Buffer;
 
 /**
- * StorageInterface is the interface a storage adapter is expected to implement to
+ * StoreInterface is the interface a storage adapter is expected to implement to
  * be used with high-level methods in this SDK. The require methods consist of
  * an put function, a dequeue function and a get function.
  */
-export interface StorageInterface {
+export interface StoreInterface {
   put: (targetPath: string, content: Content) => Promise<URL>;
   get?: (targetPath: string) => Promise<File>;
 }

src/core/storage/s3Node.ts → src/core/store/s3Node.ts

@@ -1,5 +1,5 @@
 import { S3Client, S3ClientConfig, GetObjectCommand, PutObjectCommand } from "@aws-sdk/client-s3";
-import { StorageInterface } from "./storage";
+import { StoreInterface } from "./interface";
 import { Readable } from "stream";
 
 /**
@@ -16,7 +16,7 @@ export interface S3Credentials extends S3ClientConfig {
  * S3Node provides a storage solution for saving DSNP messages
  * This adapter is provided for convenience can be used in other applications configuration.
  */
-export class S3Node implements StorageInterface {
+export class S3Node implements StoreInterface {
   client: S3Client;
   bucket: string;
   region: string;