@elementor/locations 0.6.2 → 0.6.3

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.6.3](https://github.com/elementor/elementor-packages/compare/@elementor/locations@0.6.2...@elementor/locations@0.6.3) (2023-08-02)
+
+**Note:** Version bump only for package @elementor/locations
+
+
+
+
+
 ## [0.6.2](https://github.com/elementor/elementor-packages/compare/@elementor/locations@0.6.1...@elementor/locations@0.6.2) (2023-07-17)
 
 **Note:** Version bump only for package @elementor/locations

package/dist/index.d.mts

@@ -5,20 +5,48 @@ type InjectedComponent<TProps extends object = AnyProps> = ComponentType<TProps>
 type Id = string;
 type Priority = number;
 type Injection<TProps extends object = AnyProps> = {
+    /**
+     * A unique id (per location) of the injected component.
+     */
     id: Id;
+    /**
+     * The injected component.
+     */
     component: InjectedComponent<TProps>;
+    /**
+     * Priority of the injected component inside the location. Lower value means higher priority.
+     */
     priority: Priority;
 };
 type InjectArgs<TProps extends object = AnyProps> = {
+    /**
+     * A unique id (per location) of the component to be injected.
+     */
     id: Id;
+    /**
+     * The component to be injected.
+     */
     component: InjectedComponent<TProps>;
     options?: {
+        /**
+         * Priority of the injected component inside the location. Lower value means higher priority.
+         */
         priority?: Priority;
+        /**
+         * When true, if an injected component with the same id already exists it will be overridden with this one. Otherwise, this injection will be ignored. Default is false.
+         */
         overwrite?: boolean;
     };
 };
 type Location<TProps extends object = AnyProps> = {
+    /**
+     * Inject a component into the location.
+     */
     inject: (args: InjectArgs<TProps>) => void;
+    /**
+     *
+     * @return All the injections in the location.
+     */
     getInjections: () => Injection<TProps>[];
     useInjections: () => Injection<TProps>[];
     Slot: ComponentType<TProps>;

package/dist/index.d.ts

@@ -5,20 +5,48 @@ type InjectedComponent<TProps extends object = AnyProps> = ComponentType<TProps>
 type Id = string;
 type Priority = number;
 type Injection<TProps extends object = AnyProps> = {
+    /**
+     * A unique id (per location) of the injected component.
+     */
     id: Id;
+    /**
+     * The injected component.
+     */
     component: InjectedComponent<TProps>;
+    /**
+     * Priority of the injected component inside the location. Lower value means higher priority.
+     */
     priority: Priority;
 };
 type InjectArgs<TProps extends object = AnyProps> = {
+    /**
+     * A unique id (per location) of the component to be injected.
+     */
     id: Id;
+    /**
+     * The component to be injected.
+     */
     component: InjectedComponent<TProps>;
     options?: {
+        /**
+         * Priority of the injected component inside the location. Lower value means higher priority.
+         */
         priority?: Priority;
+        /**
+         * When true, if an injected component with the same id already exists it will be overridden with this one. Otherwise, this injection will be ignored. Default is false.
+         */
         overwrite?: boolean;
     };
 };
 type Location<TProps extends object = AnyProps> = {
+    /**
+     * Inject a component into the location.
+     */
     inject: (args: InjectArgs<TProps>) => void;
+    /**
+     *
+     * @return All the injections in the location.
+     */
     getInjections: () => Injection<TProps>[];
     useInjections: () => Injection<TProps>[];
     Slot: ComponentType<TProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@elementor/locations",
-	"version": "0.6.2",
+	"version": "0.6.3",
 	"private": false,
 	"author": "Elementor Team",
 	"homepage": "https://elementor.com/",
@@ -34,5 +34,5 @@
 	"peerDependencies": {
 		"react": "18.x"
 	},
-	"gitHead": "e27c0b852121946fcc32d5ce8a5a1551c93d87a6"
+	"gitHead": "43abed846a5beaf6b0c6c5a8420c81a5bea33152"
 }

package/src/__tests__/index.test.tsx

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { render } from '@testing-library/react';
+import { render, screen } from '@testing-library/react';
 import { lazy } from 'react';
 import { createLocation } from '../api';
 
@@ -25,10 +25,10 @@ describe( '@elementor/locations', () => {
 		} );
 
 		// Act.
-		const { getAllByTestId } = render( <TestSlot /> );
+		render( <TestSlot /> );
 
 		// Assert.
-		const elements = getAllByTestId( 'element' );
+		const elements = screen.getAllByTestId( 'element' );
 
 		expect( elements ).toHaveLength( 2 );
 		expect( elements[ 0 ].innerHTML ).toBe( 'First div' );
@@ -58,10 +58,10 @@ describe( '@elementor/locations', () => {
 		} );
 
 		// Act.
-		const { getAllByTestId } = render( <Slot /> );
+		render( <Slot /> );
 
 		// Assert.
-		const elements = getAllByTestId( 'element' );
+		const elements = screen.getAllByTestId( 'element' );
 
 		expect( elements ).toHaveLength( 3 );
 		expect( elements[ 0 ].innerHTML ).toBe( 'First div' );
@@ -77,7 +77,7 @@ describe( '@elementor/locations', () => {
 		const { container } = render( <Slot /> );
 
 		// Assert.
-		expect( container.innerHTML ).toBe( '' );
+		expect( container ).toBeEmptyDOMElement( );
 	} );
 
 	it( 'should render lazy components', async () => {
@@ -97,17 +97,17 @@ describe( '@elementor/locations', () => {
 		} );
 
 		// Act.
-		const { queryByText, findByText } = render( <Slot /> );
+		render( <Slot /> );
 
 		// Assert.
-		expect( queryByText( 'First div' ) ).toBeTruthy();
-		expect( queryByText( 'Second div' ) ).toBeNull();
+		expect( screen.getByText( 'First div' ) ).toBeInTheDocument();
+		expect( screen.queryByText( 'Second div' ) ).not.toBeInTheDocument();
 
 		// Waits for the lazy component to be loaded.
-		await findByText( 'Second div' );
+		await screen.findByText( 'Second div' );
 
-		expect( queryByText( 'First div' ) ).toBeTruthy();
-		expect( queryByText( 'Second div' ) ).toBeTruthy();
+		expect( screen.getByText( 'First div' ) ).toBeInTheDocument();
+		expect( screen.getByText( 'Second div' ) ).toBeInTheDocument();
 	} );
 
 	it( 'should error when injecting a component with the same name (without overwrite option)', async () => {
@@ -125,11 +125,11 @@ describe( '@elementor/locations', () => {
 		} );
 
 		// Act
-		const { queryByText } = render( <Slot /> );
+		render( <Slot /> );
 
 		// Assert.
-		expect( queryByText( 'First div' ) ).toBeTruthy();
-		expect( queryByText( 'Second div' ) ).toBeNull();
+		expect( screen.getByText( 'First div' ) ).toBeInTheDocument();
+		expect( screen.queryByText( 'Second div' ) ).not.toBeInTheDocument();
 		expect( console ).toHaveWarned();
 	} );
 
@@ -155,12 +155,12 @@ describe( '@elementor/locations', () => {
 		} );
 
 		// Act
-		const { queryByText } = render( <Slot /> );
+		render( <Slot /> );
 
 		// Assert.
-		expect( queryByText( 'First div' ) ).toBeNull();
-		expect( queryByText( 'Second div' ) ).toBeTruthy();
-		expect( queryByText( 'Third div' ) ).toBeTruthy();
+		expect( screen.queryByText( 'First div' ) ).not.toBeInTheDocument();
+		expect( screen.getByText( 'Second div' ) ).toBeInTheDocument();
+		expect( screen.getByText( 'Third div' ) ).toBeInTheDocument();
 	} );
 
 	it( 'should overwrite the injection priority', () => {
@@ -206,11 +206,11 @@ describe( '@elementor/locations', () => {
 		} );
 
 		// Act.
-		const { queryByText } = render( <Slot /> );
+		render( <Slot /> );
 
 		// Assert.
-		expect( queryByText( 'Test 1' ) ).toBeTruthy();
-		expect( queryByText( 'Test 3' ) ).toBeTruthy();
+		expect( screen.getByText( 'Test 1' ) ).toBeInTheDocument();
+		expect( screen.getByText( 'Test 3' ) ).toBeInTheDocument();
 		expect( console ).toHaveErrored();
 	} );
 
@@ -224,9 +224,9 @@ describe( '@elementor/locations', () => {
 		} );
 
 		// Act.
-		const { queryByText } = render( <Slot text="The number is" number={ 1 } /> );
+		render( <Slot text="The number is" number={ 1 } /> );
 
 		// Assert.
-		expect( queryByText( 'The number is: 1' ) ).toBeTruthy();
+		expect( screen.getByText( 'The number is: 1' ) ).toBeInTheDocument();
 	} );
 } );

package/src/types.ts

@@ -8,22 +8,51 @@ export type Id = string;
 export type Priority = number;
 
 export type Injection<TProps extends object = AnyProps> = {
+	/**
+	 * A unique id (per location) of the injected component.
+	 */
 	id: Id;
+	/**
+	 * The injected component.
+	 */
 	component: InjectedComponent<TProps>;
+	/**
+	 * Priority of the injected component inside the location. Lower value means higher priority.
+	 */
 	priority: Priority;
 }
 
 export type InjectArgs<TProps extends object = AnyProps> = {
+	/**
+	 * A unique id (per location) of the component to be injected.
+	 */
 	id: Id;
+	/**
+	 * The component to be injected.
+	 */
 	component: InjectedComponent<TProps>;
+
 	options?: {
+		/**
+		 * Priority of the injected component inside the location. Lower value means higher priority.
+		 */
 		priority?: Priority;
+		/**
+		 * When true, if an injected component with the same id already exists it will be overridden with this one. Otherwise, this injection will be ignored. Default is false.
+		 */
 		overwrite?: boolean;
 	};
 }
 
 export type Location<TProps extends object = AnyProps> = {
+	/**
+	 * Inject a component into the location.
+	 */
 	inject: ( args: InjectArgs<TProps> ) => void;
+	/**
+	 *
+	 * @return All the injections in the location.
+	 */
 	getInjections: () => Injection<TProps>[];
 	useInjections: () => Injection<TProps>[];
 	Slot: ComponentType<TProps>;