djedi-json - npm Package Compare versions

Comparing version 0.5.11 to 0.6.0

build/CMSType/defaults.d.ts

 import { EditConfig } from '../types';
 export declare const DEFAULT_EDIT_MAP: EditConfig;
 export default DEFAULT_EDIT_MAP;

build/CMSType/edits/Children/index.d.ts

@@ -0,0 +0,0 @@ import { ChildrenProps } from './type';

build/CMSType/edits/Children/type.d.ts

@@ -0,0 +0,0 @@ import { CMSConfigSettings } from '../../types';

build/CMSType/edits/Custom/index.d.ts

@@ -0,0 +0,0 @@ import { CustomProps, IsomorphicCustom } from './type';

build/CMSType/edits/Custom/type.d.ts

@@ -0,0 +0,0 @@ import { CMSConfigSettings } from '../../types';

build/CMSType/edits/Select/index.d.ts

@@ -0,0 +0,0 @@ import React from 'react';

build/CMSType/edits/Select/type.d.ts

@@ -0,0 +0,0 @@ import { CMSConfigSettings } from '../../types';

build/CMSType/edits/String/index.d.ts

@@ -0,0 +0,0 @@ import React from 'react';

build/CMSType/edits/String/type.d.ts

@@ -0,0 +0,0 @@ /// <reference types="react" />

build/CMSType/index.d.ts

@@ -0,0 +0,0 @@ /// <reference types="react" />

build/CMSType/types.d.ts

@@ -0,0 +0,0 @@ export interface CMSEditProps<T> {

build/components/Button/index.d.ts

 import React from 'react';
-export declare type ButtonProps = React.DetailedHTMLProps<React.HTMLAttributes<HTMLButtonElement>, HTMLButtonElement>;
+export type ButtonProps = React.DetailedHTMLProps<React.HTMLAttributes<HTMLButtonElement>, HTMLButtonElement>;
 declare const Button: React.FC<ButtonProps>;
 export default Button;

build/components/Modal/index.d.ts

@@ -0,0 +0,0 @@ import React from 'react';

build/contexts/cms.d.ts

 import React from 'react';
 import { TreeReducerAction } from '../core/Tree/types';
 import { Config, NodeTreeItem } from '../types';
-export declare type CMSContextType = {
+export type CMSContextType = {
+    /** Entire CMS configuration, includes all child components. */
     config: Config;
+    /** If the tree has been modified. */
+    dirty: boolean;
+    /** The tree of nodes. */
     tree?: NodeTreeItem;
+    /**
+     * Reducer dispatch, changes the tree of nodes.
+     * When possible, prefer node-local actions from `useEdit`.
+     */
     setTree: (r: TreeReducerAction) => void;
@@ -8,0 +16,0 @@ };

build/contexts/editcontext.d.ts

 import React, { RefObject } from 'react';
 import { Path } from '../core/Tree/types';
-import { NodeContentType, NodeTreeItem } from '../types';
-export declare type EditContextType = {
+import { ComponentConfig, NodeContentType, NodeTreeItem } from '../types';
+export type EditContextType = {
+    /** Ref of the outermost element of the rendered component. */
     ref: RefObject<HTMLSpanElement> | null;
+    /** The path to this component in the entirte tree. */
     path: string[];
+    /** The type of this component. */
+    config: ComponentConfig;
+    /** The type of the parent of this component, `null` if at root. */
+    parentType: NodeTreeItem['type'] | null;
+    /** The local sub-tree for this component. */
     tree: NodeTreeItem;
-    append: (t: string, o?: Record<string, any>) => void;
+    /** Append a new component at the end of the current tree/arry of children. */
+    append: (type: NodeTreeItem['type'], content?: Record<string, any>) => void;
+    /**
+     * Insert a new component in an arbitrary `index` along its siblings.
+     * Defaults to the `index` below the inserting component.
+     */
+    insert: (type: NodeTreeItem['type'], opts?: {
+        index?: number;
+        content?: Record<string, any>;
+    }) => void;
+    /** Remove the current component from the tree. */
     remove: () => void;
-    patch: (p: NodeContentType) => void;
-    setEdit: (v: boolean) => void;
+    /** Patch the current tree with new content. */
+    patch: (content: NodeContentType) => void;
+    /** Set `editing`. */
+    setEdit: (isEditing: boolean) => void;
+    /**
+     * Whether the current component is being edited.
+     * Can be repurposed if `editable: false` or `isomorphic: true` in the component config.
+     */
     editing: boolean;
+    /** Shift the current component up or down in the tree. */
     shift: (steps: number) => void;
+    /** Move the current component to a new location in the tree. */
     move: (to: Path) => void;
@@ -15,0 +40,0 @@ };

build/core/Append/index.d.ts

 import React from 'react';
 import { ComponentConfig } from '../../types';
-declare type AppendProps = {
+type AppendProps = {
     onClick: (type: string) => void;
@@ -5,0 +5,0 @@ config: ComponentConfig;

build/core/CMS/index.d.ts

@@ -9,7 +9,7 @@ import React, { ReactNode } from 'react';
 /**
- *
- TODO
- * Add nice error messages for config faults
+ * The root of the CMS and the node tree.
+ * Provides the CMSContext to all children, accessed with `useCMS`.
+ * There should only be one CMS component in the tree.
  */
 declare const CMS: React.FC<CMSProps>;
 export default CMS;

build/core/config/index.d.ts

@@ -0,0 +0,0 @@ /// <reference types="react" />

build/core/Editable/index.d.ts

@@ -0,0 +0,0 @@ import React, { ReactNode } from 'react';

build/core/EditGroup/index.d.ts

 import React from 'react';
-export declare type EditGroupProps = {
+export type EditGroupProps = {
     content: Record<string, any>;
@@ -4,0 +4,0 @@ };

build/core/Node/index.d.ts

@@ -1,2 +0,2 @@
-import { NodeTreeItem } from "../../types";
-export declare const createEmpty: (type: string, o?: Record<string, any>) => NodeTreeItem;
+import { NodeTreeItem } from '../../types';
+export declare const createEmpty: (type: string, content?: Record<string, any>) => NodeTreeItem;

build/core/Renderer/EditorTree.d.ts

 import React, { ReactNode } from 'react';
 import { NodeTreeItem } from '../../types';
 /**
- *
+ * Renders a tree of components.
  * @param config Config to use for resolving the components to be rendered
@@ -6,0 +6,0 @@ * @param tree a NodeTree to be walked

build/core/Renderer/IsolateStyles.d.ts

@@ -0,0 +0,0 @@ import React from 'react';

build/core/Renderer/Preview.d.ts

 import React from 'react';
 declare const Preview: React.FC;
 export default Preview;

build/core/Tree/index.d.ts

 import reducer from './reducer';
 export { reducer };

build/core/Tree/reducer.d.ts

@@ -0,0 +0,0 @@ import { NodeTreeItem } from '../../types';

build/core/Tree/types.d.ts

@@ -1,11 +0,11 @@
-import { NodeTreeItem } from "../../types";
-export declare type Path = string[] | string;
-export declare type ReplaceAction = {
+import { NodeTreeItem } from '../../types';
+export type Path = string[] | string;
+export type ReplaceAction = {
     type: 'replace';
     payload: NodeTreeItem;
 };
-export declare type EmptyAction = {
+export type EmptyAction = {
     type: 'empty';
 };
-export declare type PatchAction = {
+export type PatchAction = {
     type: 'patch';
@@ -15,3 +15,3 @@ payload: NodeTreeItem;
 };
-export declare type AddAction = {
+export type AddAction = {
     type: 'add';
@@ -21,7 +21,12 @@ payload: NodeTreeItem;
 };
-export declare type DeleteAction = {
+export type InsertAction = {
+    type: 'insert';
+    at: Path;
+    payload: NodeTreeItem;
+};
+export type DeleteAction = {
     type: 'delete';
     path: Path;
 };
-export declare type MoveAction = {
+export type MoveAction = {
     type: 'move';
@@ -31,2 +36,2 @@ from: Path;
 };
-export declare type TreeReducerAction = ReplaceAction | EmptyAction | PatchAction | DeleteAction | AddAction | MoveAction;
+export type TreeReducerAction = ReplaceAction | EmptyAction | PatchAction | DeleteAction | AddAction | InsertAction | MoveAction;

build/core/Tree/utils.d.ts

@@ -1,4 +0,5 @@
-import { NodeTreeItem } from "../../types";
-/** clean the tree from faulty nodes */
-export declare const cleanTree: (t: NodeTreeItem) => NodeTreeItem;
-export declare function lossyDeepClone<T>(o: T): any;
+import { NodeTreeItem } from '../../types';
+/** Clean the tree from faulty nodes. */
+export declare const cleanTree: (node: NodeTreeItem) => NodeTreeItem;
+/** Clean the tree from faulty nodes. */
+export declare const addRefsToTree: (node: NodeTreeItem) => NodeTreeItem;

build/index.d.ts

@@ -0,0 +0,0 @@ import CMSType from './CMSType';

build/Renderer.d.ts

@@ -0,0 +0,0 @@ import React from 'react';

build/types/index.d.ts

@@ -25,10 +25,10 @@ /// <reference types="react" />
 }
-export declare type EditConfigEntry = {
+export type EditConfigEntry = {
     Component: any;
 };
-export declare type EditConfig = Record<string, EditConfigEntry>;
+export type EditConfig = Record<string, EditConfigEntry>;
 export interface NodeContentType extends Record<string, any> {
     children?: NodeTreeItem[] | string;
 }
-export declare type NodeTreeItem = {
+export interface NodeTreeItem {
     content: NodeContentType;
@@ -38,2 +38,3 @@ type: string;
     __uri?: string;
-};
+    __ref?: ReturnType<typeof crypto.randomUUID>;
+}

package.json

 {
   "name": "djedi-json",
-  "version": "0.5.11",
+  "version": "0.6.0",
   "main": "build/index.js",
@@ -57,4 +57,4 @@ "module": "build/index.esm.js",
   "homepage": "https://github.com/5monkeys/djedi-json.js#readme",
-  "author": "",
+  "author": "5 Monkeys",
   "license": "ISC"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

Improved metrics

Lines of code

4268

increased by3.37%

Number of low maintenance alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

393764

decreased by-4.65%

Number of medium supply chain risk alerts

3

increased by50%

No dependency changes