document-model 1.0.1 → 1.0.3

package/dist/{node/src → browser}/document/types.d.ts

@@ -1,10 +1,12 @@
 import type { Draft } from 'immer';
-import type { DocumentModelState } from '../document-model';
+import type { FC } from 'react';
+import type { DocumentModelState } from '../document-model/';
 import type { BaseAction } from './actions/types';
 import { BaseDocument } from './object';
 import { FileInput } from './utils';
 export { z } from './schema';
 export type * from './schema/types';
+export type { FileInput } from './utils';
 /**
  * Defines the basic structure of an action.
  *
@@ -152,3 +154,20 @@ export type DocumentModel<S = unknown, A extends Action = Action, C extends Base
     utils: DocumentModelUtils<S, A>;
     documentModel: DocumentModelState;
 };
+export type EditorContext = {
+    theme: 'light' | 'dark';
+    debug?: boolean;
+};
+export type EditorProps<S, A extends Action> = {
+    document: Document<S, A>;
+    dispatch: (action: A | BaseAction) => void;
+    editorContext: EditorContext;
+};
+export type Editor<S = unknown, A extends Action = Action> = {
+    Component: FC<EditorProps<S, A>>;
+    documentTypes: string[];
+};
+export type DocumentModelLib = {
+    documentModels: DocumentModel[];
+    editors: Editor[];
+};

package/dist/{node/src → browser}/document-model/index.d.ts

@@ -14,7 +14,7 @@ declare const utils: {
     createExtendedState: (extendedState?: Partial<import("../document").ExtendedState<Partial<DocumentModelState>>> | undefined, createState?: ((state?: Partial<DocumentModelState> | undefined) => DocumentModelState) | undefined) => import("../document").ExtendedState<DocumentModelState>;
     createDocument: (document?: Partial<import("../document").ExtendedState<Partial<DocumentModelState>>> | undefined, createState?: ((state?: Partial<DocumentModelState> | undefined) => DocumentModelState) | undefined) => import("../document").Document<DocumentModelState, DocumentModelAction>;
     loadFromFile: (path: string) => Promise<import("../document").Document<DocumentModelState, DocumentModelAction>>;
-    loadFromInput: (input: import("../document/utils").FileInput) => Promise<import("../document").Document<DocumentModelState, DocumentModelAction>>;
+    loadFromInput: (input: import("../document").FileInput) => Promise<import("../document").Document<DocumentModelState, DocumentModelAction>>;
     saveToFile: (document: import("../document").Document<DocumentModelState, DocumentModelAction>, path: string, name?: string | undefined) => Promise<string>;
     saveToFileHandle: (document: import("../document").Document<DocumentModelState, DocumentModelAction>, input: FileSystemFileHandle) => Promise<void>;
 };

package/dist/browser/document-model.d.ts

@@ -1 +1 @@
-export * from './src/document-model/index'
+export * from './document-model/index'

package/dist/browser/document.d.ts

@@ -1 +1 @@
-export * from './src/document/index'
+export * from './document/index'

package/dist/browser/index.d.ts

@@ -1,3 +1,25 @@
-export * from './src/index'
-import _default from './src/index'
-export default _default
+import * as Document from './document';
+import * as DocumentModel from './document-model';
+/**
+ * This module exports all the public types, functions, and objects
+ * from the document module. It provides an easy-to-use interface
+ * for managing documents, and can be used in any Redux-based
+ * application. This module exports:
+ * - All action creators for the base document actions.
+ * - The Document object, which is used to for creating and
+ * manipulating documents in an object-oriented way.
+ * - The baseReducer function, which is a reducer for managing
+ * documents
+ * - Various utility functions to be used by Document Models.
+ */
+export { Document };
+export { DocumentModel };
+export declare const DocumentModels: {
+    'powerhouse/document': typeof Document;
+    'powerhouse/document-model': typeof DocumentModel;
+};
+declare const _default: {
+    Document: typeof Document;
+    DocumentModel: typeof DocumentModel;
+};
+export default _default;

package/dist/{browser/src → node}/document/types.d.ts

@@ -1,10 +1,12 @@
 import type { Draft } from 'immer';
-import type { DocumentModelState } from '../document-model';
+import type { FC } from 'react';
+import type { DocumentModelState } from '../document-model/';
 import type { BaseAction } from './actions/types';
 import { BaseDocument } from './object';
 import { FileInput } from './utils';
 export { z } from './schema';
 export type * from './schema/types';
+export type { FileInput } from './utils';
 /**
  * Defines the basic structure of an action.
  *
@@ -152,3 +154,20 @@ export type DocumentModel<S = unknown, A extends Action = Action, C extends Base
     utils: DocumentModelUtils<S, A>;
     documentModel: DocumentModelState;
 };
+export type EditorContext = {
+    theme: 'light' | 'dark';
+    debug?: boolean;
+};
+export type EditorProps<S, A extends Action> = {
+    document: Document<S, A>;
+    dispatch: (action: A | BaseAction) => void;
+    editorContext: EditorContext;
+};
+export type Editor<S = unknown, A extends Action = Action> = {
+    Component: FC<EditorProps<S, A>>;
+    documentTypes: string[];
+};
+export type DocumentModelLib = {
+    documentModels: DocumentModel[];
+    editors: Editor[];
+};

package/dist/{browser/src → node}/document-model/index.d.ts

@@ -14,7 +14,7 @@ declare const utils: {
     createExtendedState: (extendedState?: Partial<import("../document").ExtendedState<Partial<DocumentModelState>>> | undefined, createState?: ((state?: Partial<DocumentModelState> | undefined) => DocumentModelState) | undefined) => import("../document").ExtendedState<DocumentModelState>;
     createDocument: (document?: Partial<import("../document").ExtendedState<Partial<DocumentModelState>>> | undefined, createState?: ((state?: Partial<DocumentModelState> | undefined) => DocumentModelState) | undefined) => import("../document").Document<DocumentModelState, DocumentModelAction>;
     loadFromFile: (path: string) => Promise<import("../document").Document<DocumentModelState, DocumentModelAction>>;
-    loadFromInput: (input: import("../document/utils").FileInput) => Promise<import("../document").Document<DocumentModelState, DocumentModelAction>>;
+    loadFromInput: (input: import("../document").FileInput) => Promise<import("../document").Document<DocumentModelState, DocumentModelAction>>;
     saveToFile: (document: import("../document").Document<DocumentModelState, DocumentModelAction>, path: string, name?: string | undefined) => Promise<string>;
     saveToFileHandle: (document: import("../document").Document<DocumentModelState, DocumentModelAction>, input: FileSystemFileHandle) => Promise<void>;
 };

package/dist/node/document-model.d.ts

@@ -1 +1 @@
-export * from './src/document-model/index'
+export * from './document-model/index'

package/dist/node/document.d.ts

@@ -1 +1 @@
-export * from './src/document/index'
+export * from './document/index'

package/dist/node/index.d.ts

@@ -1,3 +1,25 @@
-export * from './src/index'
-import _default from './src/index'
-export default _default
+import * as Document from './document';
+import * as DocumentModel from './document-model';
+/**
+ * This module exports all the public types, functions, and objects
+ * from the document module. It provides an easy-to-use interface
+ * for managing documents, and can be used in any Redux-based
+ * application. This module exports:
+ * - All action creators for the base document actions.
+ * - The Document object, which is used to for creating and
+ * manipulating documents in an object-oriented way.
+ * - The baseReducer function, which is a reducer for managing
+ * documents
+ * - Various utility functions to be used by Document Models.
+ */
+export { Document };
+export { DocumentModel };
+export declare const DocumentModels: {
+    'powerhouse/document': typeof Document;
+    'powerhouse/document-model': typeof DocumentModel;
+};
+declare const _default: {
+    Document: typeof Document;
+    DocumentModel: typeof DocumentModel;
+};
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "document-model",
-    "version": "1.0.1",
+    "version": "1.0.3",
     "license": "AGPL-3.0-only",
     "private": false,
     "files": [
@@ -20,49 +20,40 @@
     "exports": {
         ".": {
             "import": "./dist/node/index.js",
-            "require": "./dist/node/index.cjs"
+            "require": "./dist/node/index.cjs",
+            "types": "./dist/node/index.d.ts"
         },
         "./browser": {
             "import": "./dist/browser/index.js",
-            "require": "./dist/browser/index.cjs"
+            "require": "./dist/browser/index.cjs",
+            "types": "./dist/browser/index.d.ts"
         },
         "./document": {
             "import": "./dist/node/document.js",
-            "require": "./dist/node/document.cjs"
+            "require": "./dist/node/document.cjs",
+            "types": "./dist/node/document.d.ts"
         },
         "./browser/document": {
             "import": "./dist/browser/document.js",
-            "require": "./dist/browser/document.cjs"
+            "require": "./dist/browser/document.cjs",
+            "types": "./dist/browser/document.d.ts"
         },
         "./document-model": {
             "import": "./dist/node/document-model.js",
-            "require": "./dist/node/document-model.cjs"
+            "require": "./dist/node/document-model.cjs",
+            "types": "./dist/node/document-model.d.ts"
         },
         "./browser/document-model": {
             "import": "./dist/node/document-model.js",
-            "require": "./dist/node/document-model.cjs"
-        }
-    },
-    "typesVersions": {
-        "*": {
-            "document": [
-                "dist/node/document"
-            ],
-            "browser/document": [
-                "dist/browser/document"
-            ],
-            "document-model": [
-                "dist/node/document-model"
-            ],
-            "browser/document-model": [
-                "dist/browser/document-model"
-            ]
+            "require": "./dist/node/document-model.cjs",
+            "types": "./dist/node/document-model.d.ts"
         }
     },
     "devDependencies": {
         "@rollup/plugin-node-resolve": "^15.2.1",
         "@types/jest": "^29.5.4",
         "@types/mime": "^3.0.1",
+        "@types/react": "^18.2.21",
         "@typescript-eslint/eslint-plugin": "^6.4.1",
         "@typescript-eslint/parser": "^6.4.1",
         "eslint": "^8.48.0",
@@ -70,6 +61,7 @@
         "jest": "^29.6.4",
         "prettier": "^3.0.2",
         "prettier-plugin-organize-imports": "^3.2.3",
+        "react": "^18.2.0",
         "rollup-plugin-polyfill-node": "^0.12.0",
         "ts-jest": "^29.1.1",
         "ts-node": "^10.9.1",

package/dist/browser/src/index.d.ts

@@ -1,25 +0,0 @@
-import * as Document from './document';
-import * as DocumentModel from './document-model';
-/**
- * This module exports all the public types, functions, and objects
- * from the document module. It provides an easy-to-use interface
- * for managing documents, and can be used in any Redux-based
- * application. This module exports:
- * - All action creators for the base document actions.
- * - The Document object, which is used to for creating and
- * manipulating documents in an object-oriented way.
- * - The baseReducer function, which is a reducer for managing
- * documents
- * - Various utility functions to be used by Document Models.
- */
-export { Document };
-export { DocumentModel };
-export declare const DocumentModels: {
-    'powerhouse/document': typeof Document;
-    'powerhouse/document-model': typeof DocumentModel;
-};
-declare const _default: {
-    Document: typeof Document;
-    DocumentModel: typeof DocumentModel;
-};
-export default _default;

package/dist/browser/vite.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vite").UserConfigFnObject;
-export default _default;

package/dist/node/src/index.d.ts

@@ -1,25 +0,0 @@
-import * as Document from './document';
-import * as DocumentModel from './document-model';
-/**
- * This module exports all the public types, functions, and objects
- * from the document module. It provides an easy-to-use interface
- * for managing documents, and can be used in any Redux-based
- * application. This module exports:
- * - All action creators for the base document actions.
- * - The Document object, which is used to for creating and
- * manipulating documents in an object-oriented way.
- * - The baseReducer function, which is a reducer for managing
- * documents
- * - Various utility functions to be used by Document Models.
- */
-export { Document };
-export { DocumentModel };
-export declare const DocumentModels: {
-    'powerhouse/document': typeof Document;
-    'powerhouse/document-model': typeof DocumentModel;
-};
-declare const _default: {
-    Document: typeof Document;
-    DocumentModel: typeof DocumentModel;
-};
-export default _default;

package/dist/node/vite.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vite").UserConfigFnObject;
-export default _default;