@googleapis/kgsearch - npm Package Compare versions

Comparing version 2.0.1 to 3.0.1

build/v1.d.ts

@@ -96,3 +96,63 @@ /// <reference types="node" />
          * Searches Knowledge Graph for entities that match the constraints. A list of matched entities will be returned in response, which will be in JSON-LD format and compatible with http://schema.org
+         * @example
+         * ```js
+         * // Before running the sample:
+         * // - Enable the API at:
+         * //   https://console.developers.google.com/apis/api/kgsearch.googleapis.com
+         * // - Login into gcloud by running:
+         * //   ```sh
+         * //   $ gcloud auth application-default login
+         * //   ```
+         * // - Install the npm module by running:
+         * //   ```sh
+         * //   $ npm install googleapis
+         * //   ```
          *
+         * const {google} = require('googleapis');
+         * const kgsearch = google.kgsearch('v1');
+         *
+         * async function main() {
+         *   const auth = new google.auth.GoogleAuth({
+         *     // Scopes can be specified either as an array or as a single, space-delimited string.
+         *     scopes: [],
+         *   });
+         *
+         *   // Acquire an auth client, and bind it to all future calls
+         *   const authClient = await auth.getClient();
+         *   google.options({auth: authClient});
+         *
+         *   // Do the magic
+         *   const res = await kgsearch.entities.search({
+         *     // The list of entity id to be used for search instead of query string. To specify multiple ids in the HTTP request, repeat the parameter in the URL as in ...?ids=A&ids=B
+         *     ids: 'placeholder-value',
+         *     // Enables indenting of json results.
+         *     indent: 'placeholder-value',
+         *     // The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
+         *     languages: 'placeholder-value',
+         *     // Limits the number of entities to be returned.
+         *     limit: 'placeholder-value',
+         *     // Enables prefix match against names and aliases of entities
+         *     prefix: 'placeholder-value',
+         *     // The literal query string for search.
+         *     query: 'placeholder-value',
+         *     // Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.
+         *     types: 'placeholder-value',
+         *   });
+         *   console.log(res.data);
+         *
+         *   // Example response
+         *   // {
+         *   //   "@context": {},
+         *   //   "@type": {},
+         *   //   "itemListElement": []
+         *   // }
+         * }
+         *
+         * main().catch(e => {
+         *   console.error(e);
+         *   throw e;
+         * });
+         *
+         * ```
+         *
          * @param params - Parameters for request
@@ -99,0 +159,0 @@ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.

build/v1.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"v1.js","sourceRoot":"","sources":["../v1.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,gDAAgD;AAChD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,uDAAuD;AACvD,sDAAsD;AACtD,0DAA0D;AAC1D,oDAAoD;AACpD,4CAA4C;AAE5C,yDAe2B;AAG3B,IAAiB,WAAW,CA0O3B;AA1OD,WAAiB,WAAW;IAgE1B;;;;;;;;;;OAUG;IACH,MAAa,QAAQ;QAInB,YAAY,OAAsB,EAAE,MAA2B;YAC7D,IAAI,CAAC,OAAO,GAAG;gBACb,QAAQ,EAAE,OAAO,IAAI,EAAE;gBACvB,MAAM;aACP,CAAC;YAEF,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtD,CAAC;KACF;IAZY,oBAAQ,WAYpB,CAAA;IAoBD,MAAa,iBAAiB;QAE5B,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QAiCD,MAAM,CACJ,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAoC,CAAC;YACzE,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE;gBAC1C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAAqC,CAAC;gBAC/C,OAAO,GAAG,EAAE,CAAC;aACd;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;gBAC3C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;aACd;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,kCAAkC,CAAC;YACtE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,qBAAqB,CAAC,CAAC,OAAO,CAC5C,cAAc,EACd,IAAI,CACL;oBACD,MAAM,EAAE,KAAK;oBACb,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,EAAE;gBAClB,UAAU,EAAE,EAAE;gBACd,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE;gBACZ,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;aACH;iBAAM;gBACL,OAAO,IAAA,oCAAgB,EAAwB,UAAU,CAAC,CAAC;aAC5D;QACH,CAAC;KACF;IA/FY,6BAAiB,oBA+F7B,CAAA;AAgCH,CAAC,EA1OgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QA0O3B"}
+{"version":3,"file":"v1.js","sourceRoot":"","sources":["../v1.ts"],"names":[],"mappings":";AAAA,4BAA4B;AAC5B,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,gDAAgD;AAChD,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;;;AAEjC,uDAAuD;AACvD,sDAAsD;AACtD,0DAA0D;AAC1D,oDAAoD;AACpD,4CAA4C;AAE5C,yDAe2B;AAG3B,IAAiB,WAAW,CAsS3B;AAtSD,WAAiB,WAAW;IAgE1B;;;;;;;;;;OAUG;IACH,MAAa,QAAQ;QAInB,YAAY,OAAsB,EAAE,MAA2B;YAC7D,IAAI,CAAC,OAAO,GAAG;gBACb,QAAQ,EAAE,OAAO,IAAI,EAAE;gBACvB,MAAM;aACP,CAAC;YAEF,IAAI,CAAC,QAAQ,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtD,CAAC;KACF;IAZY,oBAAQ,WAYpB,CAAA;IAoBD,MAAa,iBAAiB;QAE5B,YAAY,OAA0B;YACpC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QA6FD,MAAM,CACJ,gBAGkC,EAClC,iBAIkC,EAClC,QAEkC;YAKlC,IAAI,MAAM,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAoC,CAAC;YACzE,IAAI,OAAO,GAAG,CAAC,iBAAiB,IAAI,EAAE,CAAkB,CAAC;YAEzD,IAAI,OAAO,gBAAgB,KAAK,UAAU,EAAE;gBAC1C,QAAQ,GAAG,gBAAgB,CAAC;gBAC5B,MAAM,GAAG,EAAqC,CAAC;gBAC/C,OAAO,GAAG,EAAE,CAAC;aACd;YAED,IAAI,OAAO,iBAAiB,KAAK,UAAU,EAAE;gBAC3C,QAAQ,GAAG,iBAAiB,CAAC;gBAC7B,OAAO,GAAG,EAAE,CAAC;aACd;YAED,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,kCAAkC,CAAC;YACtE,MAAM,UAAU,GAAG;gBACjB,OAAO,EAAE,MAAM,CAAC,MAAM,CACpB;oBACE,GAAG,EAAE,CAAC,OAAO,GAAG,qBAAqB,CAAC,CAAC,OAAO,CAC5C,cAAc,EACd,IAAI,CACL;oBACD,MAAM,EAAE,KAAK;oBACb,UAAU,EAAE,EAAE;iBACf,EACD,OAAO,CACR;gBACD,MAAM;gBACN,cAAc,EAAE,EAAE;gBAClB,UAAU,EAAE,EAAE;gBACd,OAAO,EAAE,IAAI,CAAC,OAAO;aACtB,CAAC;YACF,IAAI,QAAQ,EAAE;gBACZ,IAAA,oCAAgB,EACd,UAAU,EACV,QAAyC,CAC1C,CAAC;aACH;iBAAM;gBACL,OAAO,IAAA,oCAAgB,EAAwB,UAAU,CAAC,CAAC;aAC5D;QACH,CAAC;KACF;IA3JY,6BAAiB,oBA2J7B,CAAA;AAgCH,CAAC,EAtSgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAsS3B"}

CHANGELOG.md

 # Changelog
 
+## [3.0.1](https://github.com/googleapis/google-api-nodejs-client/compare/kgsearch-v3.0.0...kgsearch-v3.0.1) (2025-07-08)
+
+
+### Bug Fixes
+
+* **kgsearch:** update the API ([8126349](https://github.com/googleapis/google-api-nodejs-client/commit/812634977925c7086ef2fba2eee9e51acf48de1d))
+* **kgsearch:** update the API ([186ff31](https://github.com/googleapis/google-api-nodejs-client/commit/186ff31e9dacbb1194d10075c9f0be4f53c53165))
+
+## [3.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/kgsearch-v2.0.1...kgsearch-v3.0.0) (2025-06-30)
+
+
+### ⚠ BREAKING CHANGES
+
+* upgrade to node 18
+
+### Features
+
+* upgrade to node 18 ([682fbb8](https://github.com/googleapis/google-api-nodejs-client/commit/682fbb869189ae92b3e9a194d37d0548af0c1f92))
+
+
+### Bug Fixes
+
+* **deps:** upgrade googleapis-common to 8.0.2-rc ([f4b0990](https://github.com/googleapis/google-api-nodejs-client/commit/f4b099071040cfbcfe4a2e7d487d45ee93b369e0))
+* **kgsearch:** update the API ([186ff31](https://github.com/googleapis/google-api-nodejs-client/commit/186ff31e9dacbb1194d10075c9f0be4f53c53165))
+
 ## [2.0.1](https://github.com/googleapis/google-api-nodejs-client/compare/kgsearch-v2.0.0...kgsearch-v2.0.1) (2025-06-04)
@@ -4,0 +29,0 @@

package.json

 {
   "name": "@googleapis/kgsearch",
-  "version": "2.0.1",
+  "version": "3.0.1",
   "description": "kgsearch",
@@ -5,0 +5,0 @@ "main": "build/index.js",

v1.ts

@@ -153,3 +153,63 @@ // Copyright 2020 Google LLC
      * Searches Knowledge Graph for entities that match the constraints. A list of matched entities will be returned in response, which will be in JSON-LD format and compatible with http://schema.org
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/kgsearch.googleapis.com
+     * // - Login into gcloud by running:
+     * //   ```sh
+     * //   $ gcloud auth application-default login
+     * //   ```
+     * // - Install the npm module by running:
+     * //   ```sh
+     * //   $ npm install googleapis
+     * //   ```
      *
+     * const {google} = require('googleapis');
+     * const kgsearch = google.kgsearch('v1');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: [],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await kgsearch.entities.search({
+     *     // The list of entity id to be used for search instead of query string. To specify multiple ids in the HTTP request, repeat the parameter in the URL as in ...?ids=A&ids=B
+     *     ids: 'placeholder-value',
+     *     // Enables indenting of json results.
+     *     indent: 'placeholder-value',
+     *     // The list of language codes (defined in ISO 693) to run the query with, e.g. 'en'.
+     *     languages: 'placeholder-value',
+     *     // Limits the number of entities to be returned.
+     *     limit: 'placeholder-value',
+     *     // Enables prefix match against names and aliases of entities
+     *     prefix: 'placeholder-value',
+     *     // The literal query string for search.
+     *     query: 'placeholder-value',
+     *     // Restricts returned entities with these types, e.g. Person (as defined in http://schema.org/Person). If multiple types are specified, returned entities will contain one or more of these types.
+     *     types: 'placeholder-value',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "@context": {},
+     *   //   "@type": {},
+     *   //   "itemListElement": []
+     *   // }
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
+     *
      * @param params - Parameters for request
@@ -156,0 +216,0 @@ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Fixed alerts

URL strings

Supply chain risk

Package contains fragments of external URLs or IP addresses, which the package may be accessing at runtime.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

39016

18.06%

Lines of code

765

18.6%

Worsened metrics

Number of low supply chain risk alerts

3

200%

No dependency changes