scrubbing for InkRegistry

Author: cblanquera

packages/ink-web/src/components/api/types.json

@@ -1413,13 +1413,13 @@
       "example": "this.render(); //--> '<p>...</p>'"
     }
   },
-  "InkRegistry": {
+  "ClientRegistry": {
     "elements": {
       "kind": "property",
       "list": false,
       "type": "Map<Element, InkElement>",
       "description": "Returns a map of elements used in the DOM.",
-      "example": "InkAPI.InkRegistry.elements.get(component);"
+      "example": "InkAPI.ClientRegistry.elements.get(component);"
     },
     "createComponent": {
       "kind": "function",
@@ -1455,7 +1455,7 @@
         "type": "InkElement"
       },
       "description": "Creates a InkElement from a web component class.",
-      "example": "InkAPI.InkRegistry.createComponent('fancy-button', InkComponent, { title: 'Hello' }, children);"
+      "example": "InkAPI.ClientRegistry.createComponent('fancy-button', InkComponent, { title: 'Hello' }, children);"
     },
     "createElement": {
       "kind": "function",
@@ -1485,7 +1485,7 @@
         "type": "InkElement"
       },
       "description": "Creates a InkElement from a string tag name.",
-      "example": "InkAPI.InkRegistry.createElement('a', { href: '/' }, children);"
+      "example": "InkAPI.ClientRegistry.createElement('a', { href: '/' }, children);"
     },
     "createText": {
       "kind": "function",
@@ -1503,7 +1503,7 @@
         "type": "TextNode"
       },
       "description": "Creates a TextNode from a raw string.",
-      "example": "InkAPI.InkRegistry.createText('foo');"
+      "example": "InkAPI.ClientRegistry.createText('foo');"
     },
     "get": {
       "kind": "function",
@@ -1521,7 +1521,7 @@
         "type": "InkElement"
       },
       "description": "Returns a InkElement given a DOM element.",
-      "example": "InkAPI.InkRegistry.get(element)"
+      "example": "InkAPI.ClientRegistry.get(element)"
     },
     "has": {
       "kind": "function",
@@ -1539,7 +1539,7 @@
         "type": "boolean"
       },
       "description": "Returns true if the given element exists in the registry",
-      "example": "InkAPI.InkRegistry.has(element)"
+      "example": "InkAPI.ClientRegistry.has(element)"
     },
     "map": {
       "kind": "function",
@@ -1557,7 +1557,7 @@
         "type": "T"
       },
       "description": "Like array map for registry returns an array of whatever the callback returns.",
-      "example": "InkAPI.InkRegistry.map((ink, element) => [ink, element]);"
+      "example": "InkAPI.ClientRegistry.map((ink, element) => [ink, element]);"
     },
     "register": {
       "kind": "function",
@@ -1581,7 +1581,7 @@
         "type": "InkElement"
       },
       "description": "Registers a InkElement to the registry.",
-      "example": "InkAPI.InkRegistry.register(element, { foo: 'bar' });"
+      "example": "InkAPI.ClientRegistry.register(element, { foo: 'bar' });"
     }
   },
   "InkElement": {
@@ -1830,12 +1830,12 @@
       "description": "The Ink exception class used to create custom errors.",
       "example": "throw InkAPI.InkException.for('error message');"
     },
-    "InkRegistry": {
+    "ClientRegistry": {
       "kind": "property",
       "list": false,
-      "type": "InkRegistry",
+      "type": "ClientRegistry",
       "description": "The Ink registry class used to store custom elements.",
-      "example": "new InkAPI.InkRegistry.createElement('a', { href: '/' });"
+      "example": "new InkAPI.ClientRegistry.createElement('a', { href: '/' });"
     },
     "children": {
       "kind": "function",

packages/ink-web/src/pages/docs/index.ink

@@ -108,7 +108,7 @@
                   template() {
                     const { name } = props();
                     return () => [
-                      InkRegistry.createElement('h1', null, \`Hello \${name}\`)
+                      Registry.createElement('h1', null, \`Hello \${name}\`)
                     ]
                   }
                 }

packages/ink/src/client/Component.ts

@@ -427,7 +427,7 @@ export default abstract class ClientComponent extends HTMLElement {
   }
 
   /**
-   * This is used in InkRegistry.createComponent() to
+   * This is used in Registry.createComponent() to
    * create a virtual instance of the component. This is
    * used components that are used by other components,
    * but not registered in custom elements.

packages/ink/src/client/Document.ts

@@ -4,7 +4,7 @@ import DOMDocument from '../dom/Document';
 //api
 import data from './api/data';
 //local
-import InkRegistry from './Registry';
+import Registry from './Registry';
 
 export default abstract class ClientDocument {
   /**
@@ -70,14 +70,14 @@ export default abstract class ClientDocument {
         ])
       );
       //determine the id of the element by its index in the registry
-      const id = String(InkRegistry.elements.size);
+      const id = String(Registry.elements.size);
       //if the element has bindings
       if (bindings[id]) {
         //this is where we need to add the bindings to the attributes
         Object.assign(attributes, bindings[id]);
       }
       //finally add the element to the registry
-      InkRegistry.register(element, attributes);
+      Registry.register(element, attributes);
     }
     return bindings;
   }
@@ -101,6 +101,6 @@ export default abstract class ClientDocument {
       }
     }
 
-    return [ InkRegistry.createText(String(value)) ];
+    return [ Registry.createText(String(value)) ];
   }
 }

packages/ink/src/client/Registry.ts

@@ -54,8 +54,8 @@ export default class ClientRegistry {
     }
 
     //NOTE: It's more logical to call this.crateElement()
-    //but InkComponent will error because it's not
-    //registered in InkRegistry yet. 
+    //but Component will error because it's not
+    //registered in Registry yet. 
 
     //change the tagname if the component is registered
     const name = registered || tagname;
@@ -130,7 +130,7 @@ export default class ClientRegistry {
   public static createText(value: string, escape = true) {
     //NOTE: TextNode will escape strings by default
     // if we allow escape to be false, and the string 
-    // contains HTML, then the InkRegistry count
+    // contains HTML, then the Registry count
     // will be off.. there are also some other edge 
     // cases that need to be considered before allowing
     // escape to be false...

packages/ink/tests/CompilerTranspiler.test.ts

@@ -19,11 +19,11 @@ describe('Ink Compiler Transpiler', () => {
     const transpiler = new Transpiler(component, tsconfig);
     const actual = transpiler.transpile();
     // [
-    //   InkRegistry.createElement('div', { }, [
-    //     InkRegistry.createElement('span', { }, [
-    //       InkRegistry.createText(`$`)
+    //   Registry.createElement('div', { }, [
+    //     Registry.createElement('span', { }, [
+    //       Registry.createText(`$`)
     //     ]).element, 
-    //     InkRegistry.createText(`ok`)
+    //     Registry.createText(`ok`)
     //   ]).element
     // ]
     expect(toTS(actual)).to.contain('ClientRegistry.createText(`$`, false)');

packages/ink/tests/DocumentTranspiler.test.ts

@@ -20,11 +20,11 @@ describe('Ink Document Transpiler', () => {
     const server = toTS(transpiler.transpile());
     //console.log('--server--', server);
     // [
-    //   InkRegistry.createElement('div', { }, [
-    //     InkRegistry.createElement('span', { }, [
-    //       InkRegistry.createText(`$`)
+    //   Registry.createElement('div', { }, [
+    //     Registry.createElement('span', { }, [
+    //       Registry.createText(`$`)
     //     ]).element, 
-    //     InkRegistry.createText(`ok`)
+    //     Registry.createText(`ok`)
     //   ]).element
     // ]
     expect(server).to.contain('DOMDocument.createElement(\'div\', { \'title\': title },');