Split packages

Use monorepo structure for app, core, and plugin projects.

.gitignore

@@ -1,19 +1,19 @@
 # See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
 # dependencies
-/node_modules
-/.pnp
+node_modules/
+.pnp/
 .pnp.js
 
 # testing
-/coverage
+coverage/
 
 # next.js
-/.next/
-/out/
+.next/
+out/
 
 # production
-/build
+build/
 
 # misc
 .DS_Store

package.json → packages/app/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "note.modal.sh",
+  "name": "zeichen-app",
   "version": "0.1.0",
   "private": true,
   "scripts": {

zeichen.config.ts → packages/app/zeichen.config.ts

@@ -1,5 +1,5 @@
-import LocalStorage from './src/plugins/local-storage'
-import RemoteStorage from './src/plugins/remote-storage'
+import LocalStorage from '../plugin-local-storage'
+import RemoteStorage from '../plugin-remote-storage'
 
 export default {
   plugins: [

packages/core/plugin.ts

@@ -0,0 +1,5 @@
+export type State = {
+  currentUserId: string,
+}
+
+export type Plugin<T = {}> = (config: T) => (state: State) => void

src/services/storages/Storage.ts → packages/core/storage.ts

@@ -4,7 +4,7 @@ export default interface Storage<T> {
   deleteItem(item: T): Promise<boolean>
 }
 
-export interface StorageMeta<T> {
+export interface Collection<T> {
   items: T[],
   lastModifiedBy: string,
   lastModifiedAt: Date,

src/plugins/local-storage/Storage.ts → packages/plugin-local-storage/Storage.ts

@@ -1,15 +1,15 @@
-import Storage, { StorageMeta, OutOfSyncError } from '../../services/storages/Storage'
+import Storage, { Collection, OutOfSyncError } from '../core/storage'
 import Engine from './Engine'
 
 export default class LocalStorage<T> implements Storage<T> {
-  private readonly engine: Engine<StorageMeta<T>>
+  private readonly engine: Engine<Collection<T>>
 
   constructor(
     private readonly ownerId: string,
     private readonly storageId: string,
     private readonly getItemId = item => item['id'],
   ) {
-    this.engine = new Engine<StorageMeta<T>>(window.localStorage)
+    this.engine = new Engine<Collection<T>>(window.localStorage)
   }
 
   private getMeta() {
@@ -31,7 +31,7 @@ export default class LocalStorage<T> implements Storage<T> {
   async saveItem(newItem: T) {
     const oldMeta = this.getMeta()
     const isExistingItem = oldMeta.items.some(this.existenceCheck(newItem))
-    const newMeta: StorageMeta<T> = {
+    const newMeta: Collection<T> = {
       items: isExistingItem
         ? oldMeta.items.map(oldItem => this.existenceCheck(newItem)(oldItem) ? newItem : oldItem)
         : [...oldMeta.items, newItem],
@@ -44,7 +44,7 @@ export default class LocalStorage<T> implements Storage<T> {
   async deleteItem(newItem: T) {
     const oldMeta = this.getMeta()
     const newItems = oldMeta.items.filter(oldItem => !this.existenceCheck(newItem)(oldItem))
-    const newMeta: StorageMeta<T> = {
+    const newMeta: Collection<T> = {
       items: newItems,
       lastModifiedBy: this.ownerId,
       lastModifiedAt: new Date(),

packages/plugin-local-storage/index.ts

@@ -0,0 +1,13 @@
+import { Plugin } from '../core/plugin'
+import Storage from './Storage'
+
+type PluginConfig = {}
+
+const LocalStoragePlugin: Plugin<PluginConfig> = config => ({
+  currentUserId,
+}) => {
+  new Storage(currentUserId, 'notes')
+  new Storage(currentUserId, 'folders')
+}
+
+export default LocalStoragePlugin

packages/plugin-local-storage/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "zeichen-plugin-local-storage",
+  "author": "TheoryOfNekomata <allan.crisostomo@outlook.com>",
+  "version": "0.1.0",
+  "description": "Save and load notes using the browser's local storage.",
+  "keywords": [
+    "zeichen",
+    "plugin",
+    "storage",
+    "local"
+  ]
+}

packages/plugin-local-storage/tsconfig.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "preserve",
+    "declaration": true,
+    "declarationDir": "./dist",
+    "sourceMap": true,
+    "strict": false
+  },
+  "exclude": [
+    "node_modules",
+    "**/*.test.ts",
+    "**/*.test.tsx"
+  ],
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx"
+  ]
+}

src/plugins/remote-storage/Engine.ts → packages/plugin-remote-storage/Engine.ts

@@ -1,4 +1,4 @@
-import { Deserializer, Serializer } from '../../services/storages/Storage'
+import { Deserializer, Serializer } from '../core/storage'
 
 const CREATED = 201
 const NO_CONTENT = 204

src/plugins/remote-storage/Storage.ts → packages/plugin-remote-storage/Storage.ts

@@ -1,8 +1,8 @@
-import Storage, { StorageMeta } from '../../services/storages/Storage'
+import Storage, { Collection } from '../core/storage'
 import Engine from './Engine'
 
 export default class RemoteStorage<T> implements Storage<T> {
-  private readonly engine: Engine<T, StorageMeta<T>>
+  private readonly engine: Engine<T, Collection<T>>
 
   constructor(
     private ownerId: string,
@@ -17,7 +17,7 @@ export default class RemoteStorage<T> implements Storage<T> {
   }
 
   async queryItems() {
-    const response = await this.engine.getCollection(this.collectionId) as StorageMeta<T>;
+    const response = await this.engine.getCollection(this.collectionId) as Collection<T>;
     return response.items;
   }
 

src/plugins/remote-storage/index.ts → packages/plugin-remote-storage/index.ts

@@ -1,18 +1,15 @@
+import { Plugin } from '../core/plugin'
 import Storage from './Storage'
 
 type PluginConfig = {
   baseUrl: string,
 }
 
-type State = {
-  currentUserId: string,
-}
-
-type Plugin = (config: PluginConfig) => (state: State) => void
-
-const RemoteStoragePlugin: Plugin = config => ({
+const RemoteStoragePlugin: Plugin<PluginConfig> = config => ({
   currentUserId,
 }) => {
   new Storage(currentUserId, config.baseUrl, 'notes')
   new Storage(currentUserId, config.baseUrl, 'folders')
 }
+
+export default RemoteStoragePlugin

packages/plugin-remote-storage/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "zeichen-plugin-remote-storage",
+  "author": "TheoryOfNekomata <allan.crisostomo@outlook.com>",
+  "version": "0.1.0",
+  "description": "Save and load notes using an external API.",
+  "keywords": [
+    "zeichen",
+    "plugin",
+    "storage",
+    "API"
+  ]
+}

packages/plugin-remote-storage/tsconfig.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "esnext",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "preserve",
+    "declaration": true,
+    "declarationDir": "./dist",
+    "sourceMap": true,
+    "strict": false
+  },
+  "exclude": [
+    "node_modules",
+    "**/*.test.ts",
+    "**/*.test.tsx"
+  ],
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx"
+  ]
+}

src/plugins/local-storage/index.ts

@@ -1,18 +0,0 @@
-import Storage from './Storage'
-
-type PluginConfig = {
-
-}
-
-type State = {
-  currentUserId: string,
-}
-
-type Plugin = (config: PluginConfig) => (state: State) => void
-
-const LocalStoragePlugin: Plugin = config => ({
-  currentUserId,
-}) => {
-  new Storage(currentUserId, 'notes')
-  new Storage(currentUserId, 'folders')
-}