Merge branch 'main' into typos

Author: widoz

.github/workflows/builld-artifacts.yml

@@ -0,0 +1,30 @@
+name: Build Artifacts
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: ${{ !contains(github.event.head_commit.message, '--skip-assets-artifacts') }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          cache: 'yarn'
+          node-version: '20'
+
+      - name: Install Dependencies
+        run: yarn install
+
+      - name: Build Artifacts
+        uses: widoz/github-artifacts-action@v1
+        env:
+          GIT_USER: ${{ secrets.GIT_USER }}
+          GIT_EMAIL: ${{ secrets.GIT_EMAIL }}
+          HUSKY: 0

.github/workflows/js-qa.yml

@@ -26,7 +26,7 @@ jobs:
         uses: actions/setup-node@v2
         with:
           cache: 'yarn'
-          node-version: '16'
+          node-version: '20'
 
       - name: Install
         run: yarn install

.github/workflows/php-qa.yml

@@ -14,7 +14,7 @@ jobs:
     if: "!contains(github.event.head_commit.message, '--skip ci') && !github.event.pull_request.draft"
     strategy:
       matrix:
-        php-versions: [ '8.0' ]
+        php-versions: [ '8.1', '8.2', '8.3' ]
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -28,7 +28,7 @@ jobs:
         run: find ./src/ ./tests/ -type f -name '*.php' -print0 | xargs -0 -L 1 -P 4 -- php -l
 
       - name: Install dependencies
-        uses: "ramsey/composer-install@v1"
+        uses: ramsey/composer-install@v3
 
       - name: Check code styles
         run: composer cs

.gitignore

@@ -1,4 +1,5 @@
 /.idea/
+/.vscode/
 /build/
 /coverage
 /vendor/

.vscode/settings.json

@@ -1,15 +1,15 @@
 {
-	"core": "./vendor/roots/wordpress-no-content",
-	"plugins": ["."],
-	"env": {
-		"development": {
-			"phpVersion": "8.0",
-			"mappings": {
-				"wp-content/plugins/wp-entities-search": "."
-			}
-		}
-	},
-	"config": {
-		"WP_ENVIRONMENT_TYPE": "local"
-	}
+  "core": "./vendor/roots/wordpress-no-content",
+  "plugins": ["."],
+  "env": {
+    "development": {
+      "phpVersion": "8.1",
+      "mappings": {
+        "wp-content/plugins/wp-entities-search": "."
+      }
+    }
+  },
+  "config": {
+    "WP_ENVIRONMENT_TYPE": "local"
+  }
 }

.wp-env.json

@@ -17,11 +17,12 @@ declare namespace EntitiesSearch {
 	type Options<V> = Set<ControlOption<V>>;
 	type Value = string | number;
 
-	interface QueryArguments<V>
+	// TODO Can we convert QueryArguments to an Immutable Map?
+	interface QueryArguments
 		extends Partial<
 			Readonly<{
-				exclude: Set<V>;
-				include: Set<V>;
+				exclude: Set<string | number>;
+				include: Set<string | number>;
 				fields: EntitiesSearch.SearchQueryFields;
 				[p: string]: unknown;
 			}>
@@ -34,6 +35,8 @@ declare namespace EntitiesSearch {
 			url: string;
 			type: string;
 			subtype: string;
+			post_content: string;
+			post_excerpt: string;
 		}> {}
 
 	type SearchEntitiesFunction<E, K> = (
@@ -42,11 +45,6 @@ declare namespace EntitiesSearch {
 		queryArguments?: EntitiesSearch.QueryArguments<E>
 	) => Promise<Options<E>>;
 
-	type ControlOption<V extends any> = Readonly<{
-		value: V;
-		label: string;
-	}>;
-
 	type SingularControl<V> = {
 		[K in keyof BaseControl<V>]: K extends 'value'
 			? V
@@ -55,6 +53,20 @@ declare namespace EntitiesSearch {
 			: BaseControl<V>[K];
 	};
 
+	interface Record<T> {
+		get<F>(key: string, fallback?: F): T | F | undefined;
+		set(key: string, value: T): Record<T>;
+	}
+
+	interface ControlOption<V extends any> extends Readonly<{
+		value: V;
+		label: string;
+	}> {}
+
+	interface EnrichedControlOption<V extends any> extends ControlOption<V>, Readonly<{
+		readonly extra: Record<string, unknown>;
+	}> {}
+
 	interface BaseControl<V>
 		extends Readonly<{
 			value: Set<V>;
@@ -90,6 +102,7 @@ declare namespace EntitiesSearch {
 	/*
 	 * Api
 	 */
+	// TODO Better to convert the SearchQueryFields to a Set.
 	type SearchQueryFields = ReadonlyArray<
 		keyof EntitiesSearch.SearchEntityFields
 	>;
@@ -104,7 +117,6 @@ declare namespace EntitiesSearch {
 	> extends Readonly<{
 			entities: Entities<E>;
 			kind: Kind<K>;
-			contextualEntitiesOptions: OptionSet;
 			currentEntitiesOptions: OptionSet;
 			selectedEntitiesOptions: OptionSet;
 			searchPhrase: string;
@@ -126,13 +138,6 @@ declare namespace EntitiesSearch {
 					K
 				>['currentEntitiesOptions'];
 		  }
-		| {
-				type: 'UPDATE_CONTEXTUAL_ENTITIES_OPTIONS';
-				contextualEntitiesOptions: EntitiesState<
-					E,
-					K
-				>['contextualEntitiesOptions'];
-		  }
 		| {
 				type: 'UPDATE_SELECTED_ENTITIES_OPTIONS';
 				selectedEntitiesOptions: EntitiesState<

.yarnrc.yml

@@ -1,19 +1,18 @@
-# WordPress Entities Search
+# Wp Entities Search
+
+> A WordPress package to search Entities including Rest API Endpoints and React Components
+
+[![JS Quality Assurance](https://github.com/widoz/wp-entities-search/actions/workflows/js-qa.yml/badge.svg)](https://github.com/widoz/wp-entities-search/actions/workflows/js-qa.yml)
+[![PHP Quality Assurance](https://github.com/widoz/wp-entities-search/actions/workflows/php-qa.yml/badge.svg)](https://github.com/widoz/wp-entities-search/actions/workflows/php-qa.yml)
 
 This package is a library exposing reusable Components and Utilities to help you build Entities searching and storage.
 
 At it's core it permits to build components and reuse the WordPress Rest API to search for Posts associated to one or
 more Post Types but also, to search for Terms belonging to one or more Taxonomies.
 
-## Table of Content
+## Documentation
 
-1. [Installation](./docs/installation.md)
-2. [Development](./docs/development.md)
-3. [Api](./docs/api.md)
-4. [Components](./docs/components.md)
-5. [Hooks](./docs/hooks.md)
-6. [Logging](./docs/logging.md)
-7. [Storage](./docs/storage.md)
+Go to [documentation](./docs) or visit the site [wp-entities-search](https://widoz.github.io/wp-entities-search/).
 
 ## License
 

@types/index.d.ts

@@ -1,38 +1,38 @@
 {
-	"name": "widoz/wp-entities-search",
-	"description": "A WordPress package to search Entities including Rest API Endpoints and React Components",
-	"type": "library",
-	"license": "GPL-v2-or-later",
-	"autoload": {
-		"psr-4": {
-			"Widoz\\Wp\\EntitiesSearch\\": "sources/server/src/"
-		}
-	},
-	"authors": [
-		{
-			"name": "guido scialfa",
-			"email": "[email protected]"
-		}
-	],
-	"minimum-stability": "stable",
-	"require": {
-		"php": ">=8.0"
-	},
-	"require-dev": {
-		"inpsyde/modularity": "^1.5",
-		"inpsyde/php-coding-standards": "^1.0",
-		"roots/wordpress-no-content": "^6.3"
-	},
-	"config": {
-		"platform": {
-			"php": "8.0"
-		},
-		"allow-plugins": {
-			"dealerdirect/phpcodesniffer-composer-installer": true
-		}
-	},
-	"scripts": {
-		"cs": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcs",
-		"cs:fix": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcbf"
-	}
+  "name": "widoz/wp-entities-search",
+  "description": "A WordPress package to search Entities including Rest API Endpoints and React Components",
+  "type": "library",
+  "license": "GPL-2.0-or-later",
+  "autoload": {
+    "psr-4": {
+      "Widoz\\Wp\\EntitiesSearch\\": "sources/server/src/"
+    }
+  },
+  "authors": [
+    {
+      "name": "guido scialfa",
+      "email": "[email protected]"
+    }
+  ],
+  "minimum-stability": "stable",
+  "require": {
+    "php": ">=8.1"
+  },
+  "require-dev": {
+    "inpsyde/modularity": "^1.5",
+    "inpsyde/php-coding-standards": "^1.0",
+    "roots/wordpress-no-content": "^6.3"
+  },
+  "config": {
+    "platform": {
+      "php": "8.1"
+    },
+    "allow-plugins": {
+      "dealerdirect/phpcodesniffer-composer-installer": true
+    }
+  },
+  "scripts": {
+    "cs": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcs",
+    "cs:fix": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcbf"
+  }
 }