@wordpress/abilities 0.2.1-next.8b30e05b0.0 → 0.3.0

package/src/store/tests/reducer.test.ts

@@ -7,10 +7,8 @@
  */
 import reducer from '../reducer';
 import {
-	RECEIVE_ABILITIES,
 	REGISTER_ABILITY,
 	UNREGISTER_ABILITY,
-	RECEIVE_CATEGORIES,
 	REGISTER_ABILITY_CATEGORY,
 	UNREGISTER_ABILITY_CATEGORY,
 } from '../constants';
@@ -19,158 +17,6 @@ describe( 'Store Reducer', () => {
 	describe( 'abilitiesByName', () => {
 		const defaultState = {};
 
-		describe( 'RECEIVE_ABILITIES', () => {
-			it( 'should add abilities to the state', () => {
-				const abilities = [
-					{
-						name: 'test/ability1',
-						label: 'Test Ability 1',
-						description: 'First test ability',
-						input_schema: { type: 'object' },
-					},
-					{
-						name: 'test/ability2',
-						label: 'Test Ability 2',
-						description: 'Second test ability',
-						output_schema: { type: 'object' },
-					},
-				];
-
-				const action = {
-					type: RECEIVE_ABILITIES,
-					abilities,
-				};
-
-				const state = reducer(
-					{ abilitiesByName: defaultState },
-					action
-				);
-
-				expect( state.abilitiesByName ).toHaveProperty(
-					'test/ability1'
-				);
-				expect( state.abilitiesByName ).toHaveProperty(
-					'test/ability2'
-				);
-				expect( state.abilitiesByName[ 'test/ability1' ].label ).toBe(
-					'Test Ability 1'
-				);
-				expect( state.abilitiesByName[ 'test/ability2' ].label ).toBe(
-					'Test Ability 2'
-				);
-			} );
-
-			it( 'should filter out _links from server responses', () => {
-				const abilities = [
-					{
-						name: 'test/ability',
-						label: 'Test Ability',
-						description: 'Test ability with links',
-						_links: {
-							self: {
-								href: '/wp-abilities/v1/abilities/test/ability',
-							},
-							collection: { href: '/wp-abilities/v1/abilities' },
-						},
-					},
-				];
-
-				const action = {
-					type: RECEIVE_ABILITIES,
-					abilities,
-				};
-
-				const state = reducer(
-					{ abilitiesByName: defaultState },
-					action
-				);
-
-				expect(
-					state.abilitiesByName[ 'test/ability' ]
-				).not.toHaveProperty( '_links' );
-				expect( state.abilitiesByName[ 'test/ability' ].name ).toBe(
-					'test/ability'
-				);
-				expect( state.abilitiesByName[ 'test/ability' ].label ).toBe(
-					'Test Ability'
-				);
-			} );
-
-			it( 'should filter out _embedded from server responses', () => {
-				const abilities = [
-					{
-						name: 'test/ability',
-						label: 'Test Ability',
-						description: 'Test ability with embedded',
-						_embedded: {
-							author: { id: 1, name: 'Admin' },
-						},
-					},
-				];
-
-				const action = {
-					type: RECEIVE_ABILITIES,
-					abilities,
-				};
-
-				const state = reducer(
-					{ abilitiesByName: defaultState },
-					action
-				);
-
-				expect(
-					state.abilitiesByName[ 'test/ability' ]
-				).not.toHaveProperty( '_embedded' );
-			} );
-
-			it( 'should preserve all valid ability properties', () => {
-				const abilities = [
-					{
-						name: 'test/ability',
-						label: 'Test Ability',
-						description: 'Full test ability.',
-						input_schema: { type: 'object' },
-						output_schema: { type: 'object' },
-						meta: {
-							category: 'test',
-						},
-						callback: () => Promise.resolve( {} ),
-						permissionCallback: () => true,
-						// Extra properties that should be filtered out
-						_links: { self: { href: '/test' } },
-						_embedded: { test: 'value' },
-						extra_field: 'should be removed',
-					},
-				];
-
-				const action = {
-					type: RECEIVE_ABILITIES,
-					abilities,
-				};
-
-				const state = reducer(
-					{ abilitiesByName: defaultState },
-					action
-				);
-				const ability = state.abilitiesByName[ 'test/ability' ];
-
-				// Should have valid properties
-				expect( ability.name ).toBe( 'test/ability' );
-				expect( ability.label ).toBe( 'Test Ability' );
-				expect( ability.description ).toBe( 'Full test ability.' );
-				expect( ability.input_schema ).toEqual( { type: 'object' } );
-				expect( ability.output_schema ).toEqual( { type: 'object' } );
-				expect( ability.meta ).toEqual( { category: 'test' } );
-				expect( ability.callback ).toBeDefined();
-				expect( ability.permissionCallback ).toBeDefined();
-
-				// Should NOT have invalid properties
-				expect( ability ).not.toHaveProperty( '_links' );
-				expect( ability ).not.toHaveProperty( '_embedded' );
-				expect( ability ).not.toHaveProperty( 'extra_field' );
-			} );
-		} );
-
 		describe( 'REGISTER_ABILITY', () => {
 			it( 'should add ability to the state', () => {
 				const ability = {
@@ -327,20 +173,6 @@ describe( 'Store Reducer', () => {
 				expect( state.abilitiesByName ).toEqual( initialState );
 			} );
 
-			it( 'should handle undefined abilities in RECEIVE_ABILITIES', () => {
-				const action = {
-					type: RECEIVE_ABILITIES,
-					abilities: undefined,
-				};
-
-				const state = reducer(
-					{ abilitiesByName: defaultState },
-					action
-				);
-
-				expect( state.abilitiesByName ).toEqual( defaultState );
-			} );
-
 			it( 'should handle undefined ability in REGISTER_ABILITY', () => {
 				const action = {
 					type: REGISTER_ABILITY,
@@ -354,295 +186,12 @@ describe( 'Store Reducer', () => {
 
 				expect( state.abilitiesByName ).toEqual( defaultState );
 			} );
-
-			it( 'should handle undefined properties gracefully', () => {
-				const abilities = [
-					{
-						name: 'test/minimal',
-						label: 'Minimal',
-						description:
-							'Minimal ability with undefined properties',
-						input_schema: undefined,
-						output_schema: undefined,
-						meta: undefined,
-						callback: undefined,
-						permissionCallback: undefined,
-					},
-				];
-
-				const action = {
-					type: RECEIVE_ABILITIES,
-					abilities,
-				};
-
-				const state = reducer(
-					{ abilitiesByName: defaultState },
-					action
-				);
-				const ability = state.abilitiesByName[ 'test/minimal' ];
-
-				expect( ability.name ).toBe( 'test/minimal' );
-				expect( ability.label ).toBe( 'Minimal' );
-				expect( ability.description ).toBe(
-					'Minimal ability with undefined properties'
-				);
-				// Undefined properties should not be present
-				expect( ability ).not.toHaveProperty( 'input_schema' );
-				expect( ability ).not.toHaveProperty( 'output_schema' );
-				expect( ability ).not.toHaveProperty( 'meta' );
-				expect( ability ).not.toHaveProperty( 'callback' );
-				expect( ability ).not.toHaveProperty( 'permissionCallback' );
-			} );
 		} );
 	} );
 
 	describe( 'categoriesBySlug', () => {
 		const defaultState = {};
 
-		describe( 'RECEIVE_CATEGORIES', () => {
-			it( 'should add categories to the state', () => {
-				const categories = [
-					{
-						slug: 'data-retrieval',
-						label: 'Data Retrieval',
-						description: 'Abilities that retrieve data',
-					},
-					{
-						slug: 'user-management',
-						label: 'User Management',
-						description: 'Abilities for managing users',
-					},
-				];
-
-				const action = {
-					type: RECEIVE_CATEGORIES,
-					categories,
-				};
-
-				const state = reducer(
-					{ categoriesBySlug: defaultState, abilitiesByName: {} },
-					action
-				);
-
-				expect( state.categoriesBySlug ).toHaveProperty(
-					'data-retrieval'
-				);
-				expect( state.categoriesBySlug ).toHaveProperty(
-					'user-management'
-				);
-				expect( state.categoriesBySlug[ 'data-retrieval' ].label ).toBe(
-					'Data Retrieval'
-				);
-				expect(
-					state.categoriesBySlug[ 'user-management' ].label
-				).toBe( 'User Management' );
-			} );
-
-			it( 'should filter out _links from server responses', () => {
-				const categories = [
-					{
-						slug: 'data-retrieval',
-						label: 'Data Retrieval',
-						description: 'Test category with links',
-						_links: {
-							self: {
-								href: '/wp-abilities/v1/categories/data-retrieval',
-							},
-							collection: {
-								href: '/wp-abilities/v1/categories',
-							},
-						},
-					},
-				];
-
-				const action = {
-					type: RECEIVE_CATEGORIES,
-					categories,
-				};
-
-				const state = reducer(
-					{ categoriesBySlug: defaultState, abilitiesByName: {} },
-					action
-				);
-
-				expect(
-					state.categoriesBySlug[ 'data-retrieval' ]
-				).not.toHaveProperty( '_links' );
-				expect( state.categoriesBySlug[ 'data-retrieval' ].slug ).toBe(
-					'data-retrieval'
-				);
-				expect( state.categoriesBySlug[ 'data-retrieval' ].label ).toBe(
-					'Data Retrieval'
-				);
-			} );
-
-			it( 'should filter out _embedded from server responses', () => {
-				const categories = [
-					{
-						slug: 'data-retrieval',
-						label: 'Data Retrieval',
-						description: 'Test category with embedded',
-						_embedded: {
-							author: { id: 1, name: 'Admin' },
-						},
-					},
-				];
-
-				const action = {
-					type: RECEIVE_CATEGORIES,
-					categories,
-				};
-
-				const state = reducer(
-					{ categoriesBySlug: defaultState, abilitiesByName: {} },
-					action
-				);
-
-				expect(
-					state.categoriesBySlug[ 'data-retrieval' ]
-				).not.toHaveProperty( '_embedded' );
-			} );
-
-			it( 'should preserve all valid category properties', () => {
-				const categories = [
-					{
-						slug: 'data-retrieval',
-						label: 'Data Retrieval',
-						description: 'Full test category.',
-						meta: {
-							priority: 'high',
-							color: 'blue',
-						},
-						// Extra properties that should be filtered out
-						_links: { self: { href: '/test' } },
-						_embedded: { test: 'value' },
-						extra_field: 'should be removed',
-					},
-				];
-
-				const action = {
-					type: RECEIVE_CATEGORIES,
-					categories,
-				};
-
-				const state = reducer(
-					{ categoriesBySlug: defaultState, abilitiesByName: {} },
-					action
-				);
-				const category = state.categoriesBySlug[ 'data-retrieval' ];
-
-				// Should have valid properties
-				expect( category.slug ).toBe( 'data-retrieval' );
-				expect( category.label ).toBe( 'Data Retrieval' );
-				expect( category.description ).toBe( 'Full test category.' );
-				expect( category.meta ).toEqual( {
-					priority: 'high',
-					color: 'blue',
-				} );
-
-				// Should NOT have invalid properties
-				expect( category ).not.toHaveProperty( '_links' );
-				expect( category ).not.toHaveProperty( '_embedded' );
-				expect( category ).not.toHaveProperty( 'extra_field' );
-			} );
-
-			it( 'should overwrite existing categories', () => {
-				const initialState = {
-					'existing-category': {
-						slug: 'existing-category',
-						label: 'Existing Category',
-						description: 'Already in store',
-					},
-				};
-
-				const categories = [
-					{
-						slug: 'data-retrieval',
-						label: 'Data Retrieval',
-						description: 'New category',
-					},
-				];
-
-				const action = {
-					type: RECEIVE_CATEGORIES,
-					categories,
-				};
-
-				const state = reducer(
-					{ categoriesBySlug: initialState, abilitiesByName: {} },
-					action
-				);
-
-				// Should only have new categories, old ones are replaced
-				expect( state.categoriesBySlug ).not.toHaveProperty(
-					'existing-category'
-				);
-				expect( state.categoriesBySlug ).toHaveProperty(
-					'data-retrieval'
-				);
-			} );
-		} );
-
-		describe( 'Edge cases', () => {
-			it( 'should handle undefined categories in RECEIVE_CATEGORIES', () => {
-				const action = {
-					type: RECEIVE_CATEGORIES,
-					categories: undefined,
-				};
-
-				const state = reducer(
-					{ categoriesBySlug: defaultState, abilitiesByName: {} },
-					action
-				);
-
-				expect( state.categoriesBySlug ).toEqual( defaultState );
-			} );
-
-			it( 'should handle empty categories array', () => {
-				const action = {
-					type: RECEIVE_CATEGORIES,
-					categories: [],
-				};
-
-				const state = reducer(
-					{ categoriesBySlug: defaultState, abilitiesByName: {} },
-					action
-				);
-
-				expect( state.categoriesBySlug ).toEqual( defaultState );
-			} );
-
-			it( 'should handle undefined properties gracefully', () => {
-				const categories = [
-					{
-						slug: 'minimal',
-						label: 'Minimal',
-						description: 'Minimal category with undefined meta',
-						meta: undefined,
-					},
-				];
-
-				const action = {
-					type: RECEIVE_CATEGORIES,
-					categories,
-				};
-
-				const state = reducer(
-					{ categoriesBySlug: defaultState, abilitiesByName: {} },
-					action
-				);
-				const category = state.categoriesBySlug.minimal;
-
-				expect( category.slug ).toBe( 'minimal' );
-				expect( category.label ).toBe( 'Minimal' );
-				expect( category.description ).toBe(
-					'Minimal category with undefined meta'
-				);
-				// Undefined properties should not be present
-				expect( category ).not.toHaveProperty( 'meta' );
-			} );
-		} );
-
 		describe( 'REGISTER_ABILITY_CATEGORY', () => {
 			it( 'should add category to the state', () => {
 				const category = {

package/src/store/tests/selectors.test.ts

@@ -11,7 +11,7 @@ import {
 	getAbilityCategories,
 	getAbilityCategory,
 } from '../selectors';
-import type { AbilitiesState } from '../../types';
+import type { AbilitiesState } from '../types';
 
 describe( 'Store Selectors', () => {
 	describe( 'getAbilities', () => {

package/src/store/types.ts

@@ -0,0 +1,19 @@
+/**
+ * Internal dependencies
+ */
+import type { Ability, AbilityCategory } from '../types';
+
+/**
+ * The state shape for the abilities store.
+ */
+export interface AbilitiesState {
+	/**
+	 * Map of ability names to ability objects.
+	 */
+	abilitiesByName: Record< string, Ability >;
+
+	/**
+	 * Map of category slugs to category objects.
+	 */
+	categoriesBySlug: Record< string, AbilityCategory >;
+}