@burger-editor/frozen-patty 0.11.0 → 3.5.0-alpha.1

package/README.md

@@ -1,6 +1,6 @@
 # frozen-patty
 
-[![npm version](https://badge.fury.io/js/%burger-editor%2Ffrozen-patty.svg)](https://badge.fury.io/js/%burger-editor%2Ffrozen-patty) [![Build Status](https://travis-ci.org/YusukeHirao/frozen-patty.svg?branch=master)](https://travis-ci.org/YusukeHirao/frozen-patty) [![Coverage Status](https://coveralls.io/repos/github/YusukeHirao/frozen-patty/badge.svg?branch=master)](https://coveralls.io/github/YusukeHirao/frozen-patty?branch=master)
+[![npm version](https://badge.fury.io/js/@burger-editor%2Ffrozen-patty.svg)](https://badge.fury.io/js/@burger-editor%2Ffrozen-patty)
 
 Pure HTML to JSON converter that not use template engine.
 
@@ -15,52 +15,52 @@ $ npm install -D @burger-editor/frozen-patty
 ### Extraction
 
 ```js
-import FrozenPatty from 'frozen-patty';
+import frozenPatty from '@burger-editor/frozen-patty';
 
-FrozenPatty('<div data-field="text">value</div>').toJSON(); // => { text: 'value' }
-FrozenPatty('<div data-field="field-name">value</div>').toJSON(); // => { 'field-name': 'value' }
-FrozenPatty('<a href="http://localhost" data-field="href:href">link</a>').toJSON(); // => { 'href': 'http://localhost' }
+frozenPatty('<div data-field="text">value</div>').toJSON(); // => { text: 'value' }
+frozenPatty('<div data-field="field-name">value</div>').toJSON(); // => { 'field-name': 'value' }
+frozenPatty('<a href="http://localhost" data-field="href:href">link</a>').toJSON(); // => { 'href': 'http://localhost' }
 
-FrozenPatty('<div data-bge="text">value</div>', { attr: 'bge' }).toJSON(); // => { text: 'value' }
+frozenPatty('<div data-bge="text">value</div>', { attr: 'bge' }).toJSON(); // => { text: 'value' }
 ```
 
 ### Data merge
 
 ```js
-FrozenPatty('<div data-field="text">value</div>').merge({ text: 'merged' }).toHTML(); // => "<div data-field="text">merged</div>";
+frozenPatty('<div data-field="text">value</div>').merge({ text: 'merged' }).toHTML(); // => "<div data-field="text">merged</div>";
 ```
 
 ## API
 
-### FrozenPatty (html[, options])
+### `frozenPatty(html[, options])`
 
 Extraction data from HTML.
 
-#### arguments
+#### Parameters
 
-| args    | type     | required | descriptions  |
-| ------- | -------- | -------- | ------------- |
-| html    | `string` | required | Original HTML |
-| options | `Object` | optional | †             |
+| parameter | type     | required | descriptions  |
+| --------- | -------- | -------- | ------------- |
+| html      | `string` | required | Original HTML |
+| options   | `Object` | optional | †             |
 
-#### options†
+#### Options†
 
 | options | type   | default   | descriptions                                                                         |
 | ------- | ------ | --------- | ------------------------------------------------------------------------------------ |
 | attr    | string | `"field"` | **Data attribute** name for specifying the node that FrozenPatty treats as a _field_ |
 
-### merge (data)
+### `merge(data)`
 
-Data merge
+Merge data.
 
 | args | type     | required | descriptions |
 | ---- | -------- | -------- | ------------ |
 | data | `Object` | required | New data     |
 
-### toJSON
+### `toJSON`
 
-Data to plain Object.
+Convert to JSON.
 
-### toHTML
+### `toHTML`
 
-Render to HTML as string.
+Convert to HTML string.

package/dist/frozen-patty.d.ts

@@ -15,7 +15,6 @@ export default class FrozenPatty {
 export interface FrozenPattyOptions {
     /**
      * **Data attribute** name for specifying the node that FrozenPatty treats as a _field_
-     *
      * @default `"field"`
      */
     attr?: string;
@@ -28,7 +27,6 @@ export interface FrozenPattyOptions {
      * - `"1"` => `1`
      * - `"1.0"` => `1`
      * - `"0.1"` => `0.1`
-     *
      * @default `false`
      */
     typeConvert?: boolean;

package/dist/get-value.d.ts

@@ -1,10 +1,10 @@
 import type { Filter, PrimitiveDatum } from './types.js';
 /**
  * Get value from an element
- *
  * @param el A target element
  * @param name A label name
  * @param typeConvert Auto covert type of value
  * @param attr Data attribute name for specifying the node that FrozenPatty treats as a field
+ * @param filter
  */
 export declare function getValue(el: Element, name: string, typeConvert?: boolean, attr?: string, filter?: Filter): PrimitiveDatum | PrimitiveDatum[];

package/dist/get-value.js

@@ -2,11 +2,11 @@ import { getValues } from './get-values.js';
 import { arrayToHash } from './utils.js';
 /**
  * Get value from an element
- *
  * @param el A target element
  * @param name A label name
  * @param typeConvert Auto covert type of value
  * @param attr Data attribute name for specifying the node that FrozenPatty treats as a field
+ * @param filter
  */
 export function getValue(el, name, typeConvert = false, attr = 'field', filter) {
     const value = getValues(el, typeConvert, attr, filter);

package/dist/get-values.d.ts

@@ -1,10 +1,10 @@
 import type { Filter, PrimitiveDatum } from './types.js';
 /**
  * Get value from an element
- *
  * @param el A target element
  * @param name A label name
  * @param typeConvert Auto covert type of value
  * @param attr Data attribute name for specifying the node that FrozenPatty treats as a field
+ * @param filter
  */
 export declare function getValues(el: Element, typeConvert?: boolean, attr?: string, filter?: Filter): [string | number, PrimitiveDatum, boolean][];

package/dist/get-values.js

@@ -1,10 +1,10 @@
 /**
  * Get value from an element
- *
  * @param el A target element
  * @param name A label name
  * @param typeConvert Auto covert type of value
  * @param attr Data attribute name for specifying the node that FrozenPatty treats as a field
+ * @param filter
  */
 export function getValues(el, typeConvert = false, attr = 'field', filter) {
     /**
@@ -75,6 +75,12 @@ export function getValues(el, typeConvert = false, attr = 'field', filter) {
     // console.log({result});
     return result;
 }
+/**
+ *
+ * @param el
+ * @param keyAttr
+ * @param typeConvert
+ */
 function getAttribute(el, keyAttr, typeConvert) {
     switch (keyAttr) {
         case 'contenteditable': {
@@ -112,6 +118,10 @@ function getAttribute(el, keyAttr, typeConvert) {
         }
     }
 }
+/**
+ *
+ * @param value
+ */
 function cast(value) {
     if (value == null || value === '') {
         return '';
@@ -132,7 +142,7 @@ function cast(value) {
 }
 /**
  * Get path from value of "background-image"
- *
+ * @param value
  */
 function getBackgroundImagePath(value) {
     const origin = `${location.protocol}//${location.hostname}${location.port ? `:${location.port}` : ''}`;

package/dist/get.d.ts

@@ -1,2 +1,9 @@
 import type { Filter, FrozenPattyData } from './types.js';
+/**
+ *
+ * @param el
+ * @param attr
+ * @param typeConvert
+ * @param filter
+ */
 export default function (el: Element, attr: string, typeConvert: boolean, filter?: Filter): FrozenPattyData;

package/dist/get.js

@@ -1,5 +1,12 @@
 import { getValues } from './get-values.js';
 import { arrayToHash } from './utils.js';
+/**
+ *
+ * @param el
+ * @param attr
+ * @param typeConvert
+ * @param filter
+ */
 export default function (el, attr, typeConvert, filter) {
     // eslint-disable-next-line unicorn/prefer-spread
     const filedElements = Array.from(el.querySelectorAll(`[data-${attr}]`));

package/dist/index.d.ts

@@ -2,8 +2,12 @@ import type { FrozenPattyOptions } from './frozen-patty.js';
 import FrozenPatty from './frozen-patty.js';
 /**
  * Pure HTML to JSON converter that not use template engine.
- *
  * @param html Original HTML
  * @param options Options
  */
+/**
+ *
+ * @param html
+ * @param options
+ */
 export default function frozenPatty(html: string, options?: FrozenPattyOptions): FrozenPatty;

package/dist/index.js

@@ -1,10 +1,14 @@
 import FrozenPatty from './frozen-patty.js';
 /**
  * Pure HTML to JSON converter that not use template engine.
- *
  * @param html Original HTML
  * @param options Options
  */
+/**
+ *
+ * @param html
+ * @param options
+ */
 export default function frozenPatty(html, options) {
     return new FrozenPatty(html, options);
 }

package/dist/set-value.d.ts

@@ -5,10 +5,10 @@ import type { Filter, PrimitiveDatum } from './types.js';
  * ```html
  * <div [target-attribute] data-[attr]="[name]:[target-attribute]"></div>
  * ```
- *
  * @param el A target element
  * @param name A label name
  * @param datum A datum of value
  * @param attr Data attribute name for specifying the node that FrozenPatty treats as a field
+ * @param filter
  */
 export declare function setValue(el: Element, name: string, datum: PrimitiveDatum, attr?: string, filter?: Filter): void;

package/dist/set-value.js

@@ -4,11 +4,11 @@
  * ```html
  * <div [target-attribute] data-[attr]="[name]:[target-attribute]"></div>
  * ```
- *
  * @param el A target element
  * @param name A label name
  * @param datum A datum of value
  * @param attr Data attribute name for specifying the node that FrozenPatty treats as a field
+ * @param filter
  */
 export function setValue(el, name, datum, attr = 'field', filter) {
     const bindingFormats = el.getAttribute(`data-${attr}`) || '';
@@ -107,11 +107,9 @@ export function setValue(el, name, datum, attr = 'field', filter) {
 }
 /**
  * Set attribute
- *
  * @param el Target HTML element
  * @param attr Attribute name
  * @param datum Datum
- *
  */
 function setAttribute(el, attr, datum) {
     if (datum == null) {
@@ -673,6 +671,10 @@ function setAttribute(el, attr, datum) {
         }
     }
 }
+/**
+ *
+ * @param datum
+ */
 function toNum(datum) {
     let i;
     if (typeof datum === 'boolean') {
@@ -686,6 +688,10 @@ function toNum(datum) {
     }
     return i;
 }
+/**
+ *
+ * @param datum
+ */
 function toInt(datum) {
     return Math.floor(toNum(datum));
 }

package/dist/set.d.ts

@@ -1,2 +1,9 @@
 import type { Filter, FrozenPattyData } from './types.js';
+/**
+ *
+ * @param el
+ * @param data
+ * @param attr
+ * @param filter
+ */
 export default function (el: Element, data: FrozenPattyData, attr: string, filter?: Filter): Element;

package/dist/set.js

@@ -1,4 +1,11 @@
 import { setValue } from './set-value.js';
+/**
+ *
+ * @param el
+ * @param data
+ * @param attr
+ * @param filter
+ */
 export default function (el, data, attr, filter) {
     el = el.cloneNode(true);
     for (const dataKeyName in data) {

package/dist/utils.d.ts

@@ -1,4 +1,8 @@
 import type { FrozenPattyData, PrimitiveDatum } from './types.js';
+/**
+ *
+ * @param kvs
+ */
 export declare function arrayToHash(kvs: [keyof FrozenPattyData, PrimitiveDatum, boolean][]): {
     [index: string]: PrimitiveDatum | PrimitiveDatum[];
 };

package/dist/utils.js

@@ -1,3 +1,7 @@
+/**
+ *
+ * @param kvs
+ */
 export function arrayToHash(kvs) {
     const result = {};
     for (const kv of kvs) {

package/package.json

@@ -1,13 +1,12 @@
 {
 	"name": "@burger-editor/frozen-patty",
-	"version": "0.11.0",
+	"version": "3.5.0-alpha.1",
 	"description": "Pure HTML to JSON converter that not use template engine.",
 	"author": "D-ZERO",
 	"license": "MIT",
 	"repository": {
-		"url": "https://github.com/d-zero-dev/burger-editor.git"
+		"url": "https://github.com/d-zero-dev/BurgerEditor.git"
 	},
-	"private": false,
 	"publishConfig": {
 		"access": "public"
 	},
@@ -37,8 +36,9 @@
 		"dist"
 	],
 	"scripts": {
-		"build": "tsc",
+		"build": "tsc --project tsconfig.build.json",
+		"dev": "tsc --watch --project tsconfig.build.json",
 		"clean": "tsc --build --clean"
 	},
-	"gitHead": "3cc9deb4a7316211f6d75cc14c346775bdb4f907"
+	"gitHead": "e1d2b12f5819a0670fe91b843865d5edb943619f"
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2017-2024 D-ZERO Co., Ltd.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.