Merge pull request #712 from uploadcare/feat/rename-export-methods

feat: rename export methods

Author: nd0ut

Diff for: README.md

@@ -71,9 +71,9 @@ We use [JSDoc type annotations](https://www.typescriptlang.org/docs/handbook/int
 
 ```html
 <script type="module">
-  import * as UC from 'https://cdn.jsdelivr.net/npm/@uploadcare/file-uploader@1/web/blocks.min.js';
+  import * as UC from 'https://cdn.jsdelivr.net/npm/@uploadcare/file-uploader@1/web/file-uploader.min.js';
 
-  UC.registerBlocks(UC);
+  UC.defineComponents(UC);
 </script>
 ```
 
@@ -98,7 +98,7 @@ We use [JSDoc type annotations](https://www.typescriptlang.org/docs/handbook/int
 ```js
 import * as UC from '@uploadcare/file-uploader';
 
-UC.registerBlocks(UC);
+UC.defineComponents(UC);
 ```
 
 3. Start using Uploadcare File Uploader in your application markup:

Diff for: abstract/registerBlocks.js renamed to abstract/defineComponents.js

@@ -1,5 +1,5 @@
 /** @param {Object<string, any>} blockExports */
-export function registerBlocks(blockExports) {
+export function defineComponents(blockExports) {
   for (let blockName in blockExports) {
     let tagName = [...blockName].reduce((name, char) => {
       if (char.toUpperCase() === char) {

Diff for: abstract/connectBlocksFrom.js renamed to abstract/loadFileUploaderFrom.js

@@ -1,13 +1,13 @@
-import { registerBlocks } from './registerBlocks.js';
+import { defineComponents } from './defineComponents.js';
 
 export const UC_WINDOW_KEY = 'UC';
 
 /**
- * @param {String} url Blocks pack url
+ * @param {String} url File Uploader pack url
  * @param {Boolean} [register] Register connected package, if it not registered yet
  * @returns {Promise<import('../index.js')>}
  */
-export async function connectBlocksFrom(url, register = false) {
+export async function loadFileUploaderFrom(url, register = false) {
   return new Promise((resolve, reject) => {
     if (typeof document !== 'object') {
       resolve(null);
@@ -26,7 +26,7 @@ export async function connectBlocksFrom(url, register = false) {
     script.onload = () => {
       /** @type {import('../index.js')} */
       let blocks = window[UC_WINDOW_KEY];
-      register && registerBlocks(blocks);
+      register && defineComponents(blocks);
       resolve(blocks);
     };
     document.head.appendChild(script);

Diff for: blocks/CloudImageEditorActivity/test.js

@@ -2,7 +2,7 @@ import { ifRef } from '../../utils/ifRef.js';
 import * as blocks from '../../index.js';
 
 ifRef(() => {
-  blocks.registerBlocks(blocks);
+  blocks.defineComponents(blocks);
   document.querySelector(blocks.CloudImageEditorBlock.is)?.addEventListener('apply', (e) => {
     console.log(e);
   });

Diff for: build-items.js

@@ -7,13 +7,13 @@ export const buildItems = [
   // uc-blocks
   {
     in: './index.js',
-    out: './web/blocks.min.js',
+    out: './web/file-uploader.min.js',
     minify: true,
     minifyHtml: true,
   },
   {
     in: './index.js',
-    out: './web/blocks.iife.min.js',
+    out: './web/file-uploader.iife.min.js',
     minify: true,
     minifyHtml: true,
     iife: true,

Diff for: demo/cloud-image-editor.html

@@ -20,7 +20,7 @@
   </script>
   <script type="module">
     import * as UC from './index.js';
-    UC.registerBlocks(UC);
+    UC.defineComponents(UC);
 
     UC.defineLocale('ru', () => import('./locales/file-uploader/ru.js').then((m) => m.default));
   </script>

Diff for: demo/form.html

@@ -20,7 +20,7 @@
   <script type="module">
     import * as UC from './index.js';
 
-    UC.registerBlocks(UC);
+    UC.defineComponents(UC);
 
     const form = document.querySelector('form');
     form.addEventListener('submit', (e) => {

Diff for: demo/icons.html

@@ -20,7 +20,7 @@
   <script type="module">
     import * as UC from './index.js';
 
-    UC.registerBlocks(UC);
+    UC.defineComponents(UC);
 
     const config = document.querySelector('uc-config');
     config.iconHrefResolver = (iconId) => {

Diff for: demo/locales.html

@@ -100,7 +100,7 @@
         UC.defineLocale(key, definition);
       }
 
-      UC.registerBlocks(UC);
+      UC.defineComponents(UC);
 
       const config = document.querySelector('uc-config');
 

Diff for: demo/preview-proxy/secure-delivery-proxy-url-resolver.html

@@ -21,7 +21,7 @@
   <script type="module">
     import * as UC from './index.js';
 
-    UC.registerBlocks(UC);
+    UC.defineComponents(UC);
 
     const config = document.querySelector('uc-config');
     config.secureDeliveryProxyUrlResolver = (previewUrl) => {

Diff for: demo/preview-proxy/secure-delivery-proxy-url-template.html

@@ -21,7 +21,7 @@
   <script type="module">
     import * as UC from './index.js';
 
-    UC.registerBlocks(UC);
+    UC.defineComponents(UC);
   </script>
 </head>
 

Diff for: demo/raw-inline.html

@@ -29,7 +29,7 @@
   <script type="module">
     import * as UC from './index.js';
 
-    UC.registerBlocks(UC);
+    UC.defineComponents(UC);
   </script>
 </head>
 

Diff for: demo/raw-minimal.html

@@ -29,7 +29,7 @@
   <script type="module">
     import * as UC from './index.js';
 
-    UC.registerBlocks(UC);
+    UC.defineComponents(UC);
   </script>
 </head>
 

Diff for: demo/raw-regular.html

@@ -29,7 +29,7 @@
   <script type="module">
     import * as UC from './index.js';
 
-    UC.registerBlocks(UC);
+    UC.defineComponents(UC);
   </script>
 </head>
 

Diff for: demo/secure-uploads.html

@@ -21,7 +21,7 @@
   <script type="module">
     import * as UC from './index.js';
 
-    UC.registerBlocks(UC);
+    UC.defineComponents(UC);
 
     const msToUnixTimestamp = (ms) => Math.floor(ms / 1000).toString();
 

Diff for: demo/validators.html

@@ -31,7 +31,7 @@
 			}
 		})
 
-		UC.registerBlocks(UC);
+		UC.defineComponents(UC);
 	</script>
 </head>
 

Diff for: index.js

@@ -40,9 +40,9 @@ export { FileUploaderInline } from './solutions/file-uploader/inline/FileUploade
 export { CloudImageEditor } from './solutions/cloud-image-editor/CloudImageEditor.js';
 
 // Utils:
-export { registerBlocks } from './abstract/registerBlocks.js';
+export { defineComponents } from './abstract/defineComponents.js';
 export { defineLocale } from './abstract/localeRegistry.js';
-export { connectBlocksFrom } from './abstract/connectBlocksFrom.js';
+export { loadFileUploaderFrom } from './abstract/loadFileUploaderFrom.js';
 export { toKebabCase } from './utils/toKebabCase.js';
 
 export * from './env.js';

Diff for: package.json

@@ -43,7 +43,7 @@
       "browser": "./index.js",
       "default": "./index.js"
     },
-    "./abstract/connectBlocksFrom.js": "./abstract/connectBlocksFrom.js",
+    "./abstract/loadFileUploaderFrom.js": "./abstract/loadFileUploaderFrom.js",
     "./env": "./env.js",
     "./web/*": "./web/*",
     "./types/*": "./types/*",

Diff for: solutions/cloud-image-editor/index.js

@@ -7,5 +7,5 @@ Then we can check whether the dependent tag is registered in the CustomElementRe
 If not, register it from default ones or just log the warning */
 
 export { Icon } from '../../blocks/Icon/Icon.js';
-export { registerBlocks } from '../../abstract/registerBlocks.js';
+export { defineComponents } from '../../abstract/defineComponents.js';
 export { Config } from '../../blocks/Config/Config.js';

Diff for: solutions/file-uploader/minimal/index.js

@@ -1,4 +1,4 @@
-export { registerBlocks } from '../../../abstract/registerBlocks.js';
+export { defineComponents } from '../../../abstract/defineComponents.js';
 export { defineLocale } from '../../../abstract/localeRegistry.js';
 export { FileUploaderMinimal } from './FileUploaderMinimal.js';
 export { StartFrom } from '../../../blocks/StartFrom/StartFrom.js';

Diff for: types/global.d.ts

@@ -1,4 +1,4 @@
-import { UC_WINDOW_KEY } from '../abstract/connectBlocksFrom.js';
+import { UC_WINDOW_KEY } from '../abstract/loadFileUploaderFrom.js';
 import * as blocks from '../index.js';
 
 declare global {