timered-counter 1.0.0 → 1.1.0

package/custom-elements.json

@@ -4,13 +4,94 @@
   "modules": [
     {
       "kind": "javascript-module",
-      "path": "src/counter-adapter.ts",
+      "path": "src/index.ts",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "TimeredCounter",
+          "declaration": {
+            "name": "TimeredCounter",
+            "module": "src/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "TimeredCounterDatetimeDuration",
+          "declaration": {
+            "name": "TimeredCounterDatetimeDuration",
+            "module": "src/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "TimeredCounterNumber",
+          "declaration": {
+            "name": "TimeredCounterNumber",
+            "module": "src/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "TimeredCounterString",
+          "declaration": {
+            "name": "TimeredCounterString",
+            "module": "src/index.ts"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./easing/index.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./types/index.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./timered-counter-adapter.js"
+          }
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "src/timered-counter-adapter.ts",
       "declarations": [
         {
           "kind": "class",
           "description": "",
-          "name": "CounterAdapter",
+          "name": "TimeredCounterAdapter",
           "members": [
+            {
+              "kind": "field",
+              "name": "AVAILABLE_NUMBER_ADAPTERS",
+              "type": {
+                "text": "Map<string[], () => NumberAdapter>"
+              },
+              "static": true,
+              "default": "new Map([ [['number'], BuildInNumberAdapter], // [['decimal.js', 'decimaljs'], DecimalJsAdapter()], ])"
+            },
+            {
+              "kind": "field",
+              "name": "AVAILABLE_STRING_ADAPTERS",
+              "type": {
+                "text": "Map<string[], () => StringAdapter>"
+              },
+              "static": true,
+              "default": "new Map([ [['string'], BuildInStringAdapter], [['intl-segmenter'], BuildInIntlSegmenterAdapter], // [['grapheme-splitter'], GraphemeSplitterAdapter()], ])"
+            },
             {
               "kind": "field",
               "name": "NUMBER_ADAPTER",
@@ -38,7 +119,7 @@
                 "text": "object"
               },
               "static": true,
-              "default": "{ fromAttribute(value: string | null) { return value; }, toAttribute(value: unknown) { return isNullish(value) ? value : CounterAdapter.NUMBER_ADAPTER.toString(value); }, }",
+              "default": "{ fromAttribute(value: string | null) { return value; }, toAttribute(value: unknown) { return isNullish(value) ? value : TimeredCounterAdapter.NUMBER_ADAPTER.toString(value); }, }",
               "description": "将 value 及其相关的属性, 在 attribute 和 property 上的互相转换.",
               "privacy": "protected"
             },
@@ -50,76 +131,124 @@
                 {
                   "name": "adapterOrType",
                   "type": {
-                    "text": "NumberAdapter | 'number' | 'decimal.js'"
+                    "text": "NumberAdapter | 'number' | string"
+                  }
+                }
+              ],
+              "description": "设置要使用的数字适配器. 仅对设置完之后的 TimeredCounter 实例生效.\n\n接受的关键字除了内置的 `number` 以外, 还可以通过 registerNumberAdapter 注册的 `keyword`."
+            },
+            {
+              "kind": "method",
+              "name": "setStringAdapter",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "adapterOrType",
+                  "type": {
+                    "text": "StringAdapter | 'string' | 'intl-segmenter' | string"
+                  }
+                }
+              ],
+              "description": "与 setNumberAdapter 类似, 用于设置字符串适配器."
+            },
+            {
+              "kind": "method",
+              "name": "registerNumberAdapter",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "keyword",
+                  "type": {
+                    "text": "string[]"
                   }
                 },
                 {
-                  "name": "config",
-                  "optional": true,
+                  "name": "adapter",
                   "type": {
-                    "text": "Decimal.Config"
+                    "text": "() => NumberAdapter"
                   }
                 }
               ]
             },
             {
               "kind": "method",
-              "name": "setStringAdapter",
+              "name": "registerStringAdapter",
               "static": true,
               "parameters": [
                 {
-                  "name": "adapterOrType",
+                  "name": "keyword",
                   "type": {
-                    "text": "| StringAdapter\n      | 'string'\n      | 'intl-segmenter'\n      | 'grapheme-splitter'"
+                    "text": "string[]"
+                  }
+                },
+                {
+                  "name": "adapter",
+                  "type": {
+                    "text": "() => StringAdapter"
                   }
                 }
               ]
+            },
+            {
+              "kind": "method",
+              "name": "registryAdapter",
+              "static": true,
+              "parameters": [
+                {
+                  "name": "adapter",
+                  "type": {
+                    "text": "{\n    register: (counterAdapter: typeof TimeredCounterAdapter) => void;\n  }"
+                  }
+                }
+              ],
+              "description": "可以直接使用 adapter 文件的导出进行注册.\n\nadapter 文件需要导出一个名为 register 的函数, 该函数接受一个 TimeredCounterAdapter 类型的参数.\n\n具体示例请查看 GraphemeSplitterAdapter or DecimalJsAdapter."
             }
           ]
-        }
-      ],
-      "exports": [
-        {
-          "kind": "js",
-          "name": "CounterAdapter",
-          "declaration": {
-            "name": "CounterAdapter",
-            "module": "src/counter-adapter.ts"
-          }
-        }
-      ]
-    },
-    {
-      "kind": "javascript-module",
-      "path": "src/index.ts",
-      "declarations": [
+        },
         {
           "kind": "function",
           "name": "setNumberAdapter",
           "parameters": [
             {
-              "name": "adapterOrType",
+              "name": "args",
               "type": {
-                "text": "NumberAdapter | 'number' | 'decimal.js'"
+                "text": "Parameters<(typeof TimeredCounterAdapter)['setNumberAdapter']>"
               }
-            },
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "setStringAdapter",
+          "parameters": [
             {
-              "name": "config",
-              "optional": true,
+              "name": "args",
               "type": {
-                "text": "Decimal.Config"
+                "text": "Parameters<(typeof TimeredCounterAdapter)['setStringAdapter']>"
               }
             }
           ]
         },
         {
           "kind": "function",
-          "name": "setStringAdapter",
+          "name": "registerNumberAdapter",
           "parameters": [
             {
-              "name": "adapterOrType",
+              "name": "args",
               "type": {
-                "text": "| StringAdapter\n    | 'string'\n    | 'intl-segmenter'\n    | 'grapheme-splitter'"
+                "text": "Parameters<(typeof TimeredCounterAdapter)['registerNumberAdapter']>"
+              }
+            }
+          ]
+        },
+        {
+          "kind": "function",
+          "name": "registerStringAdapter",
+          "parameters": [
+            {
+              "name": "args",
+              "type": {
+                "text": "Parameters<(typeof TimeredCounterAdapter)['registerStringAdapter']>"
               }
             }
           ]
@@ -128,66 +257,42 @@
       "exports": [
         {
           "kind": "js",
-          "name": "setNumberAdapter",
-          "declaration": {
-            "name": "setNumberAdapter",
-            "module": "src/index.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "setStringAdapter",
+          "name": "TimeredCounterAdapter",
           "declaration": {
-            "name": "setStringAdapter",
-            "module": "src/index.ts"
+            "name": "TimeredCounterAdapter",
+            "module": "src/timered-counter-adapter.ts"
           }
         },
         {
           "kind": "js",
-          "name": "TimeredCounter",
-          "declaration": {
-            "name": "TimeredCounter",
-            "module": "src/index.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "TimeredCounterDatetimeDuration",
-          "declaration": {
-            "name": "TimeredCounterDatetimeDuration",
-            "module": "src/index.ts"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "TimeredCounterNumber",
+          "name": "setNumberAdapter",
           "declaration": {
-            "name": "TimeredCounterNumber",
-            "module": "src/index.ts"
+            "name": "setNumberAdapter",
+            "module": "src/timered-counter-adapter.ts"
           }
         },
         {
           "kind": "js",
-          "name": "TimeredCounterString",
+          "name": "setStringAdapter",
           "declaration": {
-            "name": "TimeredCounterString",
-            "module": "src/index.ts"
+            "name": "setStringAdapter",
+            "module": "src/timered-counter-adapter.ts"
           }
         },
         {
           "kind": "js",
-          "name": "*",
+          "name": "registerNumberAdapter",
           "declaration": {
-            "name": "*",
-            "package": "./easing/index.js"
+            "name": "registerNumberAdapter",
+            "module": "src/timered-counter-adapter.ts"
           }
         },
         {
           "kind": "js",
-          "name": "*",
+          "name": "registerStringAdapter",
           "declaration": {
-            "name": "*",
-            "package": "./types/index.js"
+            "name": "registerStringAdapter",
+            "module": "src/timered-counter-adapter.ts"
           }
         }
       ]
@@ -5454,9 +5559,36 @@
               "default": "{ precision: 1e3 }"
             }
           ]
+        },
+        {
+          "kind": "function",
+          "name": "register",
+          "parameters": [
+            {
+              "name": "counterAdapter",
+              "type": {
+                "text": "typeof TimeredCounterAdapter"
+              }
+            },
+            {
+              "name": "config",
+              "optional": true,
+              "type": {
+                "text": "Decimal.Config"
+              }
+            }
+          ]
         }
       ],
       "exports": [
+        {
+          "kind": "js",
+          "name": "register",
+          "declaration": {
+            "name": "register",
+            "module": "src/number-adapter/decimal-js.ts"
+          }
+        },
         {
           "kind": "js",
           "name": "DecimalJsAdapter",
@@ -5464,6 +5596,13 @@
             "name": "DecimalJsAdapter",
             "module": "src/number-adapter/decimal-js.ts"
           }
+        },
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "module": "src/number-adapter/decimal-js.ts"
+          }
         }
       ]
     },
@@ -5477,7 +5616,7 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "\"./types.js\""
+            "package": "./types.js"
           }
         },
         {
@@ -5485,7 +5624,7 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "\"./build-in-number.js\""
+            "package": "./build-in-number.js"
           }
         },
         {
@@ -5493,15 +5632,7 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "\"./build-in-bigint.js\""
-          }
-        },
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "\"./decimal-js.js\""
+            "package": "./build-in-bigint.js"
           }
         }
       ]
@@ -5568,9 +5699,29 @@
           "kind": "function",
           "name": "GraphemeSplitterAdapter",
           "description": "使用 `grapheme-splitter` 库的字符串适配器. 该适配器使用 `grapheme-splitter` 库将字符串转换为字符数组.\n\n要使用 GraphemeSplitterAdapter 需要安装 `grapheme-splitter`."
+        },
+        {
+          "kind": "function",
+          "name": "register",
+          "parameters": [
+            {
+              "name": "counterAdapter",
+              "type": {
+                "text": "typeof TimeredCounterAdapter"
+              }
+            }
+          ]
         }
       ],
       "exports": [
+        {
+          "kind": "js",
+          "name": "register",
+          "declaration": {
+            "name": "register",
+            "module": "src/string-adapter/grapheme-splitter.ts"
+          }
+        },
         {
           "kind": "js",
           "name": "GraphemeSplitterAdapter",
@@ -5578,6 +5729,13 @@
             "name": "GraphemeSplitterAdapter",
             "module": "src/string-adapter/grapheme-splitter.ts"
           }
+        },
+        {
+          "kind": "js",
+          "name": "default",
+          "declaration": {
+            "module": "src/string-adapter/grapheme-splitter.ts"
+          }
         }
       ]
     },
@@ -5591,15 +5749,7 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "\"./types.js\""
-          }
-        },
-        {
-          "kind": "js",
-          "name": "*",
-          "declaration": {
-            "name": "*",
-            "package": "\"./build-in-string.js\""
+            "package": "./types.js"
           }
         },
         {
@@ -5607,7 +5757,7 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "\"./build-in-intl-segmenter.js\""
+            "package": "./build-in-string.js"
           }
         },
         {
@@ -5615,7 +5765,7 @@
           "name": "*",
           "declaration": {
             "name": "*",
-            "package": "\"./grapheme-splitter.js\""
+            "package": "./build-in-intl-segmenter.js"
           }
         }
       ]
@@ -6862,7 +7012,7 @@
           "type": {
             "text": "Meta"
           },
-          "default": "{ title: 'TimeredCounter/with decimal.js', component: 'timered-counter', tags: ['autodocs', 'timered-counter'], parameters: { controls: { expanded: true }, }, beforeEach: () => { setNumberAdapter('decimal.js'); }, }"
+          "default": "{ title: 'TimeredCounter/with decimal.js', component: 'timered-counter', tags: ['autodocs', 'timered-counter'], parameters: { controls: { expanded: true }, }, beforeEach: () => { TimeredCounterAdapter.registryAdapter(DecimalJsNumberAdapter); TimeredCounterAdapter.setNumberAdapter('decimal.js'); }, }"
         },
         {
           "kind": "variable",
@@ -7118,7 +7268,7 @@
           "type": {
             "text": "Meta"
           },
-          "default": "{ title: 'TimeredCounterNumber/with decimal.js', component: 'timered-counter-number', tags: ['autodocs', 'timered-counter-number'], parameters: { controls: { expanded: true }, }, beforeEach: () => { setNumberAdapter('decimal.js'); }, }"
+          "default": "{ title: 'TimeredCounterNumber/with decimal.js', component: 'timered-counter-number', tags: ['autodocs', 'timered-counter-number'], parameters: { controls: { expanded: true }, }, beforeEach: () => { TimeredCounterAdapter.registryAdapter(DecimalJsNumberAdapter); TimeredCounterAdapter.setNumberAdapter('decimal.js'); }, }"
         },
         {
           "kind": "variable",
@@ -7302,7 +7452,7 @@
           "type": {
             "text": "Meta"
           },
-          "default": "{ title: 'TimeredCounterString/with decimal.js', component: 'timered-counter-string', tags: ['autodocs', 'timered-counter-string'], parameters: { controls: { expanded: true }, }, beforeEach: () => { setNumberAdapter('decimal.js'); }, }"
+          "default": "{ title: 'TimeredCounterString/with decimal.js', component: 'timered-counter-string', tags: ['autodocs', 'timered-counter-string'], parameters: { controls: { expanded: true }, }, beforeEach: () => { TimeredCounterAdapter.registryAdapter(DecimalJsNumberAdapter); TimeredCounterAdapter.setNumberAdapter('decimal.js'); }, }"
         },
         {
           "kind": "variable",
@@ -7390,7 +7540,7 @@
           "type": {
             "text": "Meta"
           },
-          "default": "{ title: 'TimeredCounterString/with grapheme-splitter', component: 'timered-counter-string', tags: ['autodocs', 'timered-counter-string'], parameters: { controls: { expanded: true }, }, beforeEach: () => { setNumberAdapter('decimal.js'); setStringAdapter('grapheme-splitter'); }, }"
+          "default": "{ title: 'TimeredCounterString/with grapheme-splitter', component: 'timered-counter-string', tags: ['autodocs', 'timered-counter-string'], parameters: { controls: { expanded: true }, }, beforeEach: () => { TimeredCounterAdapter.registryAdapter(DecimalJsNumberAdapter); TimeredCounterAdapter.registryAdapter(GraphemeSplitterStringAdapter); TimeredCounterAdapter.setNumberAdapter('decimal.js'); TimeredCounterAdapter.setStringAdapter('grapheme-splitter'); }, }"
         },
         {
           "kind": "variable",
@@ -7582,7 +7732,7 @@
           "type": {
             "text": "Meta"
           },
-          "default": "{ title: 'TimeredCounterString/with Intl Segmenter', component: 'timered-counter-string', tags: ['autodocs', 'timered-counter-string'], parameters: { controls: { expanded: true }, }, beforeEach: () => { setNumberAdapter('decimal.js'); setStringAdapter('intl-segmenter'); }, }"
+          "default": "{ title: 'TimeredCounterString/with Intl Segmenter', component: 'timered-counter-string', tags: ['autodocs', 'timered-counter-string'], parameters: { controls: { expanded: true }, }, beforeEach: () => { TimeredCounterAdapter.registryAdapter(DecimalJsNumberAdapter); TimeredCounterAdapter.setNumberAdapter('decimal.js'); TimeredCounterAdapter.setStringAdapter('intl-segmenter'); }, }"
         },
         {
           "kind": "variable",