@blockquote-web-components/blockquote-base-meta 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 blockquote-base-meta
+
+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.

package/README.md

@@ -0,0 +1,79 @@
+# blockquote-base-meta
+
+![Lit](https://img.shields.io/badge/lit-2.0.0-blue)
+
+`BlockquoteBaseMeta` is based on Polymer's `iron-meta`, and it is a generic class that you can use
+for sharing information across the DOM tree.
+It uses [monostate pattern](http://c2.com/cgi/wiki?MonostatePattern) pattern such that any instance
+of it has access to the shared information. You can use `BlockquoteBaseMeta` to share whatever you
+want.
+The `BlockquoteBaseMeta` instances contain your actual data. The only requirement is that you
+create them before you try to access them.
+
+`BlockquoteBaseMeta` uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map).
+
+Map is a collection of keyed data items, just like an Object.
+But the main difference is that Map allows keys of any type.
+
+## Usage
+
+```js
+import { BlockquoteBaseMeta } from '@blockquote-web-components/blockquote-base-meta';
+
+const myDefault = new BlockquoteBaseMeta({
+  key: 'basic',
+  value: 'foo/bar',
+});
+
+console.log(myDefault.value); // foo/bar
+```
+
+## Keys string - Object
+
+```js
+import { BlockquoteBaseMeta } from '@blockquote-web-components/blockquote-base-meta';
+
+const myDefault = new BlockquoteBaseMeta({
+  type: 'one',
+  key: 'basic',
+  value: 'foo/bar',
+});
+
+console.log(myDefault.objectList); // {basic: 'foo/bar'}
+```
+
+## Keys any type - Map
+
+```js
+import { BlockquoteBaseMeta } from '@blockquote-web-components/blockquote-base-meta';
+
+const keyInfo = { id: 'dsfaskj0' };
+const myDefault = new BlockquoteBaseMeta({
+  type: 'two',
+  key: keyInfo,
+  value: 'foo/bar',
+});
+
+console.log(myDefault.mapList); // {{ id: 'dsfaskj0' }: 'foo/bar'}
+```
+
+## Properties
+
+| Property     | Modifiers | Description                                                   |
+| ------------ | --------- | ------------------------------------------------------------- |
+| `key`        |           | Key for Meta                                                  |
+| `list`       | readonly  | Returns a list (Array) of the values for that instance `type` |
+| `mapList`    | readonly  | Returns a list (Map) for that instance `type`                 |
+| `objectList` | readonly  | Returns a list (Object) for that instance `type`              |
+| `type`       |           | Type of Meta                                                  |
+| `value`      |           | Returns value of instance key and type                        |
+
+## Methods
+
+| Method  | Type          | Description                                                    |
+| ------- | ------------- | -------------------------------------------------------------- |
+| `byKey` | `(key: *): *` | Returns the value of the provided key for that instance `type` |
+
+## Exports
+
+- BlockquoteBaseMeta

package/index.js

@@ -0,0 +1 @@
+export { BlockquoteBaseMeta } from './src/BlockquoteBaseMeta.js';

package/package.json

@@ -0,0 +1,131 @@
+{
+  "name": "@blockquote-web-components/blockquote-base-meta",
+  "version": "1.0.0",
+  "description": "Webcomponent blockquote-base-meta following open-wc recommendations",
+  "keywords": [
+    "lit",
+    "web-component",
+    "lit-element"
+  ],
+  "license": "MIT",
+  "author": "blockquote-base-meta",
+  "main": "index.js",
+  "module": "index.js",
+  "files": [
+    "/define/",
+    "/src/",
+    "index.js",
+    "!/**/*.scss"
+  ],
+  "scripts": {
+    "analyze": "cem analyze --litelement --globs \"{src,define}/**/*.{js,ts}\" \"index.js\"",
+    "analyze:doc": "npm run analyze && npx web-component-analyzer \"{src,define}/**/*.{js,ts}\" \"index.js\" --outFile README.md",
+    "build": "echo \"This is not a TypeScript project, so no need to build.\"",
+    "dev:vite": "vite build",
+    "format": "npm run format:eslint && npm run format:prettier && npm run format:stylelint",
+    "format:eslint": "eslint \"**/*.{js,ts,html}\" --fix --ignore-path .eslintignore",
+    "format:prettier": "prettier \"**/*.{js,ts,json,html,md}\" --write --ignore-path .eslintignore",
+    "format:stylelint": "stylelint \"**/*.{scss,css}\" --fix --allow-empty-input --ignore-path .eslintignore",
+    "postinstall": "npm run sort:package",
+    "lint": "npm run lint:eslint && npm run lint:prettier && npm run lint:stylelint",
+    "lint:eslint": "eslint \"**/*.{js,ts,html}\" --ignore-path .eslintignore",
+    "lint:prettier": "prettier \"**/*.{js,ts,json,html,md}\" --check --ignore-path .eslintignore",
+    "lint:stylelint": "stylelint \"**/*.{scss,css}\" --allow-empty-input --ignore-path .eslintignore",
+    "preview:vite": "vite preview",
+    "sass:watch": "sass-style-template",
+    "sort:package": "npx sort-package-json",
+    "start": "concurrently -k -r \"npm:sass:watch\" \"npm:vite\"",
+    "start:wds": "concurrently -k -r \"npm:sass:watch\" \"npm:wds\"",
+    "test": "wtr --coverage",
+    "test:watch": "wtr --watch",
+    "vite": "vite",
+    "wds": "web-dev-server"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "**/*.{js,ts,html}": [
+      "npm run format:eslint"
+    ],
+    "**/*.{js,ts,json,html,md}": [
+      "npm run format:prettier"
+    ],
+    "**/*.{scss,css}": [
+      "npm run format:stylelint"
+    ]
+  },
+  "prettier": {
+    "arrowParens": "avoid",
+    "printWidth": 100,
+    "singleQuote": true,
+    "trailingComma": "all",
+    "overrides": [
+      {
+        "files": "*.{scss,css}",
+        "options": {
+          "singleQuote": false
+        }
+      }
+    ]
+  },
+  "eslintConfig": {
+    "parserOptions": {
+      "ecmaVersion": "latest"
+    },
+    "plugins": [
+      "log-filenames"
+    ],
+    "extends": [
+      "prettier",
+      "@open-wc"
+    ],
+    "rules": {
+      "arrow-parens": "off",
+      "class-methods-use-this": "off",
+      "object-curly-newline": "off",
+      "operator-linebreak": [
+        "error",
+        "after"
+      ],
+      "import/extensions": [
+        "error",
+        "always",
+        {
+          "ignorePackages": true
+        }
+      ],
+      "import/no-extraneous-dependencies": [
+        "error",
+        {
+          "devDependencies": [
+            "**/test/**/*.{js,ts}",
+            "**/*.config.{js,mjs,cjs}",
+            "**/*.conf.{js,mjs,cjs}"
+          ]
+        }
+      ],
+      "import/no-unresolved": "off",
+      "import/prefer-default-export": "off"
+    }
+  },
+  "stylelint": {
+    "extends": "stylelint-config-standard-scss",
+    "rules": {
+      "custom-property-pattern": null,
+      "max-line-length": null
+    }
+  },
+  "dependencies": {
+    "lit": "^2.0.0"
+  },
+  "devDependencies": {
+    "@blockquote-web-components/blockquote-base-common-dev-dependencies": "^1.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "customElements": "custom-elements.json"
+}

package/src/BlockquoteBaseMeta.js

@@ -0,0 +1,216 @@
+/**
+@license
+Copyright (c) 2015 The Polymer Project Authors. All rights reserved.
+This code may only be used under the BSD style license found at
+http://polymer.github.io/LICENSE.txt The complete set of authors may be found at
+http://polymer.github.io/AUTHORS.txt The complete set of contributors may be
+found at http://polymer.github.io/CONTRIBUTORS.txt Code distributed by Google as
+part of the polymer project is also subject to an additional IP rights grant
+found at http://polymer.github.io/PATENTS.txt
+*/
+
+window[Symbol.for('BLOCKQUOTE')] = window[Symbol.for('BLOCKQUOTE')] || Object.create(null);
+
+window[Symbol.for('BLOCKQUOTE')][Symbol.for('blockquoteBaseMeta')] =
+  window[Symbol.for('BLOCKQUOTE')][Symbol.for('blockquoteBaseMeta')] || Object.create(null);
+
+const symbolBaseMeta = window[Symbol.for('BLOCKQUOTE')][Symbol.for('blockquoteBaseMeta')];
+
+symbolBaseMeta[Symbol.for('types')] = symbolBaseMeta[Symbol.for('types')] || new Map();
+
+symbolBaseMeta[Symbol.for('uuid')] =
+  symbolBaseMeta[Symbol.for('uuid')] || Math.random().toString(36).substr(2, 10);
+
+// https://www.oreilly.com/library/view/learning-javascript-design/9781449334840/ch13s15.html
+// https://www.keithcirkel.co.uk/metaprogramming-in-es6-symbols/
+
+/**
+![Lit](https://img.shields.io/badge/lit-2.0.0-blue)
+
+`BlockquoteBaseMeta` is based on Polymer's `iron-meta`, and it is a generic class that you can use
+for sharing information across the DOM tree.
+It uses [monostate pattern](http://c2.com/cgi/wiki?MonostatePattern) pattern such that any instance
+of it has access to the shared information. You can use `BlockquoteBaseMeta` to share whatever you
+want.
+The `BlockquoteBaseMeta` instances contain your actual data. The only requirement is that you
+create them before you try to access them.
+
+`BlockquoteBaseMeta` uses [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map).
+
+Map is a collection of keyed data items, just like an Object.
+But the main difference is that Map allows keys of any type.
+
+## Usage
+
+```js
+import { BlockquoteBaseMeta } from '@blockquote-web-components/blockquote-base-meta';
+
+  const myDefault = new BlockquoteBaseMeta({
+    key: 'basic',
+    value: 'foo/bar',
+  });
+
+console.log(myDefault.value); // foo/bar
+```
+
+## Keys string - Object
+
+```js
+import { BlockquoteBaseMeta } from '@blockquote-web-components/blockquote-base-meta';
+
+  const myDefault = new BlockquoteBaseMeta({
+    type: 'one',
+    key: 'basic',
+    value: 'foo/bar',
+  });
+
+  console.log(myDefault.objectList); // {basic: 'foo/bar'}
+```
+
+## Keys any type - Map
+
+```js
+import { BlockquoteBaseMeta } from '@blockquote-web-components/blockquote-base-meta';
+
+  const keyInfo = { id: 'dsfaskj0' };
+  const myDefault = new BlockquoteBaseMeta({
+    type: 'two',
+    key: keyInfo,
+    value: 'foo/bar',
+  });
+
+console.log(myDefault.mapList); // {{ id: 'dsfaskj0' }: 'foo/bar'}
+```
+
+## Properties
+
+| Property     | Modifiers | Description                                      |
+|--------------|-----------|--------------------------------------------------|
+| `key`        |           | Key for Meta                                     |
+| `list`       | readonly  | Returns a list of the values for that instance `type` |
+| `mapList`    | readonly  | Returns a Map list for that instance `type`      |
+| `objectList` | readonly  | Returns a Object list for that instance `type`   |
+| `type`       |           | Type of Meta                                     |
+| `value`      |           | Returns value of instance key and type           |
+
+## Methods
+
+| Method  | Type          | Description                                      |
+|---------|---------------|--------------------------------------------------|
+| `byKey` | `(key: *): *` | Returns the value of the provided key for that instance `type` |
+
+  ## Exports
+
+  - BlockquoteBaseMeta
+
+*/
+export class BlockquoteBaseMeta {
+  /**
+   * @param {{
+   *   type: *,
+   *   key: *,
+   *   value: *,
+   * }=} options
+   */
+  constructor(options) {
+    /**
+     * Type of Meta
+     */
+    this.type = (options && options.type) || 'default';
+
+    /**
+     * Key for Meta
+     */
+    this.key = options && options.key;
+    if (options && 'value' in options) {
+      this.value = options.value;
+    }
+  }
+
+  static get types() {
+    return symbolBaseMeta[Symbol.for('types')];
+  }
+
+  static get uuid() {
+    return symbolBaseMeta[Symbol.for('uuid')];
+  }
+
+  /**
+   * Returns value of instance key and type
+   * @return {*}
+   */
+  get value() {
+    const { type } = this;
+    const key = this.__key || this.key;
+    this.__key = undefined;
+    if (type && key) {
+      return BlockquoteBaseMeta.types.get(type) && BlockquoteBaseMeta.types.get(type).get(key);
+    }
+    return undefined;
+  }
+
+  /**
+   * Sets value to instance type and key
+   * @param {*} value
+   */
+  set value(value) {
+    const { type } = this;
+    const { key } = this;
+    let __type;
+    if (type && key) {
+      if (BlockquoteBaseMeta.types.get(type) === undefined) {
+        BlockquoteBaseMeta.types.set(type, new Map());
+      }
+      __type = BlockquoteBaseMeta.types.get(type);
+      if (value === null) {
+        __type.delete(key);
+      } else {
+        __type.set(key, value);
+      }
+    }
+  }
+
+  /**
+   * Returns a list (Array) of the values for that instance `type`
+   * @return {Array}
+   */
+  get list() {
+    const { type } = this;
+    const itemsType = BlockquoteBaseMeta.types.get(type);
+    if (itemsType) {
+      return Array.from(itemsType.values());
+    }
+    return [];
+  }
+
+  /**
+   * Returns a list (Map) for that instance `type`
+   * @return {Map}
+   */
+  get mapList() {
+    const { type } = this;
+    const itemsType = BlockquoteBaseMeta.types.get(type);
+    if (itemsType) {
+      return itemsType;
+    }
+    return new Map();
+  }
+
+  /**
+   * Returns a list (Object) for that instance `type`
+   * @return {Object}
+   */
+  get objectList() {
+    return Object.fromEntries(this.mapList);
+  }
+
+  /**
+   * Returns the value of the provided key for that instance `type`
+   * @param {*} key
+   * @return {*}
+   */
+  byKey(key) {
+    this.__key = key;
+    return this.value;
+  }
+}