@empathyco/x-adapter-platform 1.0.0-alpha.9 → 1.0.0

package/dist/types/types/requests/recommendations-request.model.d.ts

@@ -0,0 +1,8 @@
+import { PlatformExtraParamsRequest, PlatformPageableRequest, PlatformTrackableRequest } from './request.types';
+/**
+ * Request for `recommendations` endpoint with `extra params`.
+ *
+ * @public
+ */
+export interface PlatformRecommendationsRequest extends PlatformExtraParamsRequest, PlatformPageableRequest, PlatformTrackableRequest {
+}

package/dist/types/types/requests/related-tags-request.model.d.ts

@@ -0,0 +1,8 @@
+import { PlatformExtraParamsRequest, PlatformQueryableRequest } from './request.types';
+/**
+ * Request for the `related tags` endpoint with `extra params`.
+ *
+ * @public
+ */
+export interface PlatformRelatedTagsRequest extends PlatformQueryableRequest, PlatformExtraParamsRequest {
+}

package/dist/types/types/requests/request.types.d.ts

@@ -4,7 +4,7 @@
  * @public
  */
 export interface PlatformExtraParamsRequest {
-    extraParams: {
+    extraParams?: {
         [key: string]: unknown;
     };
 }
@@ -17,3 +17,35 @@ export interface PlatformPageableRequest {
     rows?: number;
     start?: number;
 }
+/**
+ * Interface for any `request` with a `query` parameter.
+ *
+ * @public
+ */
+export interface PlatformQueryableRequest {
+    query: string;
+}
+/**
+ * Interface for any `request` with `sorting`.
+ *
+ * @public
+ */
+export declare interface PlatformSortableRequest {
+    sort?: string;
+}
+/**
+ * Interface for any `request` with `tagging`.
+ *
+ * @public
+ */
+export interface PlatformTrackableRequest {
+    origin?: string;
+}
+/**
+ * Interface for any `request` with `filters`.
+ *
+ * @public
+ */
+export interface PlatformFilterableRequest {
+    filter?: string[];
+}

package/dist/types/types/requests/search-request.model.d.ts

@@ -0,0 +1,8 @@
+import { PlatformExtraParamsRequest, PlatformFilterableRequest, PlatformPageableRequest, PlatformQueryableRequest, PlatformSortableRequest, PlatformTrackableRequest } from './request.types';
+/**
+ * Request for the `search` endpoint.
+ *
+ * @public
+ */
+export interface PlatformSearchRequest extends PlatformQueryableRequest, PlatformPageableRequest, PlatformFilterableRequest, PlatformTrackableRequest, PlatformSortableRequest, PlatformExtraParamsRequest {
+}

package/dist/types/types/requests/semantic-queries-request.model.d.ts

@@ -0,0 +1,10 @@
+import { PlatformExtraParamsRequest } from './request.types';
+/**
+ * Request for the `semantic queries` endpoint.
+ * In this endpoint the `q` param is used to send the query.
+ *
+ * @public
+ */
+export interface PlatformSemanticQueriesRequest extends PlatformExtraParamsRequest {
+    q: string;
+}

package/dist/types/types/responses/experience-controls-response.model.d.ts

@@ -0,0 +1,8 @@
+import { Dictionary } from '@empathyco/x-utils';
+/**
+ * Response for the `experience controls` endpoint.
+ *
+ * @public
+ */
+export interface PlatformExperienceControlsResponse extends Dictionary<unknown> {
+}

package/dist/types/types/responses/identifier-results-response.model.d.ts

@@ -0,0 +1,14 @@
+import { PlatformResult } from '../models/result.model';
+/**
+ * Response for the `identifier results` endpoint.
+ *
+ * @public
+ */
+export interface PlatformIdentifierResultsResponse {
+    catalog: {
+        content: PlatformResult[];
+        tagging: {
+            query: string;
+        };
+    };
+}

package/dist/types/types/responses/index.d.ts

@@ -1 +1,9 @@
+export * from './identifier-results-response.model';
+export * from './query-suggestions-response.model';
+export * from './next-queries-response.model';
 export * from './popular-searches-response.model';
+export * from './related-tags-response.model';
+export * from './recommendations-response.model';
+export * from './search-response.model';
+export * from './semantic-queries-response.model';
+export * from './experience-controls-response.model';

package/dist/types/types/responses/next-queries-response.model.d.ts

@@ -0,0 +1,11 @@
+import { PlatformNextQuery } from '../models/next-query.model';
+/**
+ * Response for the `next queries` endpoint.
+ *
+ * @public
+ */
+export interface PlatformNextQueriesResponse {
+    data: {
+        nextqueries: PlatformNextQuery[];
+    };
+}

package/dist/types/types/responses/query-suggestions-response.model.d.ts

@@ -0,0 +1,11 @@
+import { PlatformSuggestion } from '../models/suggestion.model';
+/**
+ * Response for the `query suggestions` endpoint.
+ *
+ * @public
+ */
+export interface PlatformQuerySuggestionsResponse {
+    topTrends: {
+        content: PlatformSuggestion[];
+    };
+}

package/dist/types/types/responses/recommendations-response.model.d.ts

@@ -0,0 +1,12 @@
+import { PlatformResult } from '../models/result.model';
+/**
+ * Response for the `recommendations` endpoint.
+ *
+ * @public
+ */
+export interface PlatformRecommendationsResponse {
+    topclicked: {
+        content: PlatformResult[];
+        numFound: number;
+    };
+}

package/dist/types/types/responses/related-tags-response.model.d.ts

@@ -0,0 +1,12 @@
+import { PlatformRelatedTag } from '../models/related-tag.model';
+/**
+ * Response for the `related tags` endpoint.
+ *
+ * @public
+ */
+export interface PlatformRelatedTagsResponse {
+    data: {
+        relatedtags: PlatformRelatedTag[];
+    };
+    status: number;
+}

package/dist/types/types/responses/search-response.model.d.ts

@@ -0,0 +1,32 @@
+import { PlatformResult } from '../models/result.model';
+import { PlatformBanner } from '../models/banner.model';
+import { PlatformFacet } from '../models/facet.model';
+import { PlatformPromoted } from '../models/promoted.model';
+import { PlatformRedirection } from '../models/redirection.model';
+import { PlatformPartialResult } from '../models/partials.model';
+/**
+ * Response for the `search` endpoint.
+ *
+ * @public
+ */
+export interface PlatformSearchResponse {
+    banner: {
+        content: PlatformBanner[];
+    };
+    catalog: {
+        content: PlatformResult[];
+        facets: PlatformFacet[];
+        numFound: number;
+        spellchecked: string;
+        partials: PlatformPartialResult[];
+        tagging: {
+            query: string;
+        };
+    };
+    direct: {
+        content: PlatformRedirection[];
+    };
+    promoted: {
+        content: PlatformPromoted[];
+    };
+}

package/dist/types/types/responses/semantic-queries-response.model.d.ts

@@ -0,0 +1,11 @@
+import { PlatformSemanticQuery } from '../models';
+/**
+ * Response for the `semantic queries` endoint.
+ *
+ * @public
+ */
+export interface PlatformSemanticQueriesResponse {
+    data: {
+        candidates: PlatformSemanticQuery[];
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empathyco/x-adapter-platform",
-  "version": "1.0.0-alpha.9",
+  "version": "1.0.0",
   "description": "A search client for the Empathy Platform API",
   "author": "Empathy Systems Corporation S.L.",
   "license": "Apache-2.0",
@@ -15,38 +15,49 @@
   "module": "dist/esm/index.js",
   "types": "dist/types/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "report"
   ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/empathyco/x.git",
     "directory": "packages/x-adapter-platform"
   },
+  "engines": {
+    "node": ">=18"
+  },
   "scripts": {
     "prebuild": "rimraf ./dist ./*.tgz",
-    "build": "concurrently \"npm run build:*\"",
+    "build": "concurrently \"pnpm run build:*\" && pnpm run gen:docs",
     "build:cjs": "tsc --project tsconfig.cjs.json",
     "build:esm": "tsc --project tsconfig.esm.json",
+    "postbuild": "pnpm pack",
+    "gen:model-docs": "api-extractor run -l",
+    "gen:typescript-docs": "api-documenter markdown -i report -o docs",
+    "gen:docs": "pnpm run gen:model-docs && pnpm run gen:typescript-docs",
+    "lint": "eslint . --ext .ts",
     "test": "jest",
-    "postbuild": "npm pack",
-    "prepublishOnly": "npm run build"
+    "test:unit": "jest",
+    "prepublishOnly": "pnpm run build"
   },
   "dependencies": {
-    "@empathyco/x-adapter-next": "^0.2.0-alpha.30",
-    "@empathyco/x-types": "^10.0.0-alpha.24",
-    "@empathyco/x-utils": "^1.0.0-alpha.3",
-    "tslib": "~2.3.0"
+    "@empathyco/x-adapter": "^8.0.0",
+    "@empathyco/x-types": "^10.0.0",
+    "@empathyco/x-utils": "^1.0.0",
+    "tslib": "~2.5.0"
   },
   "devDependencies": {
-    "@types/jest": "~27.0.3",
-    "concurrently": "~7.0.0",
-    "jest": "~27.3.1",
+    "@microsoft/api-documenter": "~7.22.0",
+    "@microsoft/api-extractor": "~7.35.0",
+    "@types/jest": "~27.5.0",
+    "concurrently": "~8.1.0",
+    "jest": "~27.5.0",
     "rimraf": "~3.0.2",
-    "ts-jest": "~27.0.7",
-    "typescript": "~4.6.2"
+    "ts-jest": "~27.1.0",
+    "typescript": "~4.9.4"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6fb40d4c573bfc57110ed9790afe991ae45f74e4"
+  "gitHead": "b8ff7113a91e5a8f05228fc7994faa6dd91c44f3"
 }

package/report/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.35.0"
+    }
+  ]
+}