@eluvio/elv-client-js 4.2.30 → 4.2.31

package/src/AuthorizationClient.js

@@ -3,6 +3,7 @@ const Ethers = require("ethers");
 const Utils = require("./Utils");
 const UrlJoin = require("url-join");
 const {LogMessage} = require("./LogMessage");
+const {ValidateObject, ValidateParameters} = require("./Validation");
 
 /*
 // -- Contract javascript files built using build/BuildContracts.js
@@ -119,6 +120,10 @@ class AuthorizationClient {
   }) {
     if(versionHash) { objectId = this.client.utils.DecodeVersionHash(versionHash).objectId; }
 
+    if(update && !objectId) {
+      throw Error("An objectId or versionHash is required when 'update' is true");
+    }
+
     const isWalletRequest =
       objectId &&
       this.client.signer &&

package/src/ElvClient.js

@@ -131,6 +131,7 @@ class ElvClient {
    * @param {Array<string>} authServiceURIs - A list of full URIs to auth service endpoints
    * @param {Array<string>} fileServiceURIs - A list of full URIs to file service endpoints
    * @param {Array<string>=} searchURIs - A list of full URIs to search service endpoints
+   * @param {Array<string>=} tenantQueryURIs - A list of full URIs to tenant query service endpoints
    * @param {number=} ethereumContractTimeout=10 - Number of seconds to wait for contract calls
    * @param {string=} trustAuthorityId - (OAuth) The ID of the trust authority to use for OAuth authentication
    * @param {string=} staticToken - Static token that will be used for all authorization in place of normal auth. Also known as an anonymous token containing the space
@@ -152,6 +153,7 @@ class ElvClient {
     authServiceURIs,
     fileServiceURIs,
     searchURIs,
+    tenantQueryURIs,
     ethereumContractTimeout = 10,
     trustAuthorityId,
     staticToken,
@@ -179,6 +181,7 @@ class ElvClient {
     this.fileServiceURIs = fileServiceURIs || fabricURIs;
     this.ethereumURIs = ethereumURIs;
     this.searchURIs = searchURIs;
+    this.tenantQueryURIs = tenantQueryURIs || [];
     this.ethereumContractTimeout = ethereumContractTimeout;
 
     this.trustAuthorityId = trustAuthorityId;
@@ -262,6 +265,11 @@ class ElvClient {
 
       const searchURIs = fabricInfo.network.services.search || [];
 
+      let tenantQueryURIs = fabricInfo.network.services.tenant_query || [];
+      if(tenantQueryURIs.find(filterHTTPS)) {
+        tenantQueryURIs = tenantQueryURIs.filter(filterHTTPS);
+      }
+
       const fabricVersion = Math.max(...(fabricInfo.network.api_versions || [2]));
 
       return {
@@ -275,6 +283,7 @@ class ElvClient {
         fileServiceURIs,
         kmsURIs: kmsUrls,
         searchURIs,
+        tenantQueryURIs,
         fabricVersion
       };
     } catch(error) {
@@ -378,6 +387,7 @@ class ElvClient {
       authServiceURIs,
       fileServiceURIs,
       searchURIs,
+      tenantQueryURIs,
       fabricVersion
     } = await ElvClient.Configuration({
       configUrl,
@@ -395,6 +405,7 @@ class ElvClient {
       authServiceURIs,
       fileServiceURIs,
       searchURIs,
+      tenantQueryURIs,
       ethereumContractTimeout,
       trustAuthorityId,
       staticToken,
@@ -427,6 +438,7 @@ class ElvClient {
     this.AuthHttpClient = new HttpClient({uris: this.authServiceURIs, networkName: this.networkName, debug: this.debug});
     this.FileServiceHttpClient = new HttpClient({uris: this.fileServiceURIs, networkName: this.networkName, debug: this.debug});
     this.SearchHttpClient = new HttpClient({uris: this.searchURIs || [], networkName: this.networkName, debug: this.debug});
+    this.TenantQueryHttpClient = new HttpClient({uris: this.tenantQueryURIs || [], networkName: this.networkName, debug: this.debug});
     this.ethClient = new EthClient({client: this, uris: this.ethereumURIs, networkId: this.networkId, debug: this.debug, timeout: this.ethereumContractTimeout});
 
     if(!this.signer) {
@@ -483,7 +495,7 @@ class ElvClient {
       throw Error("Unable to change region: Configuration URL not set");
     }
 
-    const {fabricURIs, ethereumURIs, authServiceURIs, fileServiceURIs, searchURIs} = await ElvClient.Configuration({
+    const {fabricURIs, ethereumURIs, authServiceURIs, fileServiceURIs, searchURIs, tenantQueryURIs} = await ElvClient.Configuration({
       configUrl: this.configUrl,
       region
     });
@@ -495,7 +507,8 @@ class ElvClient {
       ethereumURIs,
       authServiceURIs,
       fileServiceURIs,
-      searchURIs
+      searchURIs,
+      tenantQueryURIs
     });
 
     return {
@@ -503,7 +516,8 @@ class ElvClient {
       ethereumURIs,
       fileServiceURIs,
       authServiceURIs,
-      searchURIs
+      searchURIs,
+      tenantQueryURIs
     };
   }
 
@@ -558,7 +572,8 @@ class ElvClient {
       ethereumURIs: this.ethereumURIs,
       authServiceURIs: this.authServiceURIs,
       fileServiceURIs: this.fileServiceURIs,
-      searchURIs: this.searchURIs
+      searchURIs: this.searchURIs,
+      tenantQueryURIs: this.tenantQueryURIs
     };
   }
 
@@ -571,10 +586,11 @@ class ElvClient {
    * @param {Array<string>=} authServiceURIs - A list of URLs for the auth service, in preference order
    * @param {Array<string>=} fileServiceURIs - A list of URLs for file service jobs, in preference order
    * @param {Array<string>=} searchURIs - A list of URLs for the search nodes, in preference order
+   * @param {Array<string>=} tenantQueryURIs - A list of URLs for the tenant query nodes, in preference order
    *
    * @methodGroup Nodes
    */
-  SetNodes({fabricURIs, ethereumURIs, authServiceURIs, fileServiceURIs, searchURIs}) {
+  SetNodes({fabricURIs, ethereumURIs, authServiceURIs, fileServiceURIs, searchURIs, tenantQueryURIs}) {
     if(fabricURIs) {
       this.fabricURIs = fabricURIs;
 
@@ -609,6 +625,13 @@ class ElvClient {
       this.SearchHttpClient.uris = searchURIs;
       this.SearchHttpClient.uriIndex = 0;
     }
+
+    if(tenantQueryURIs) {
+      this.tenantQueryURIs = tenantQueryURIs;
+
+      this.TenantQueryHttpClient.uris = tenantQueryURIs;
+      this.TenantQueryHttpClient.uriIndex = 0;
+    }
   }
 
   /**

package/src/FrameClient.js

@@ -316,6 +316,9 @@ class FrameClient {
       "AddAccessGroupMember",
       "AddContentLibraryGroup",
       "AddContentObjectGroupPermission",
+      "AddContentObjectGroups",
+      "AddContentObjectQueryFields",
+      "AddContentObjectTags",
       "AddLibraryContentType",
       "AssetMetadata",
       "AuditContentObject",
@@ -341,10 +344,13 @@ class FrameClient {
       "ContentObjectAccessComplete",
       "ContentObjectGraph",
       "ContentObjectGroupPermissions",
+      "ContentObjectGroups",
       "ContentObjectImageUrl",
       "ContentObjectLibraryId",
       "ContentObjectMetadata",
       "ContentObjectOwner",
+      "ContentObjectQueryFields",
+      "ContentObjectTags",
       "ContentObjectTenantId",
       "ContentObjectVersions",
       "ContentObjects",
@@ -364,6 +370,7 @@ class FrameClient {
       "CreateAccessGroup",
       "CreateAndFinalizeContentObject",
       "CreateAuthorizationToken",
+      "CreateContentGroup",
       "CreateContentLibrary",
       "CreateContentObject",
       "CreateContentType",
@@ -451,6 +458,7 @@ class FrameClient {
       "OutputsCreate",
       "OutputsDelete",
       "OutputsDeleteBatch",
+      "OutputsHop",
       "OutputsList",
       "OutputsListItem",
       "OutputsModify",
@@ -474,6 +482,9 @@ class FrameClient {
       "RemoveAccessGroupMember",
       "RemoveContentObjectGroupPermission",
       "RemoveContentLibraryGroup",
+      "RemoveContentObjectGroups",
+      "RemoveContentObjectQueryFields",
+      "RemoveContentObjectTags",
       "RemoveLibraryContentType",
       "Rep",
       "ReplaceContractMetadata",
@@ -489,7 +500,10 @@ class FrameClient {
       "SetAuthContext",
       "SetAuthPolicy",
       "SetContentLibraryImage",
+      "SetContentObjectGroups",
       "SetContentObjectImage",
+      "SetContentObjectQueryFields",
+      "SetContentObjectTags",
       "SetCustomContentContract",
       "SetGroupPermission",
       "SetNodes",
@@ -532,6 +546,7 @@ class FrameClient {
       "StreamUnassignProfile",
       "StreamUpdateConfig",
       "SuspendNTPInstance",
+      "TenantContent",
       "TenantContractId",
       "TenantId",
       "UnlinkAccessGroupFromOauth",

package/src/client/ContentAccess.js

@@ -3305,3 +3305,195 @@ exports.QParts = async function({libraryId, objectId, partHash, format="blob"})
     })
   );
 };
+
+/* Content groups */
+
+/**
+ * Retrieve a content object property ("tags", "groups" or "query_fields").
+ *
+ * @private
+ */
+const ContentObjectProperty = async function({objectId, versionHash, writeToken, property}) {
+  if(writeToken && versionHash) {
+    throw Error(`Cannot specify writeToken and versionHash at same time (token:${writeToken}, hash:${versionHash})`);
+  }
+
+  if(writeToken) {
+    ValidateWriteToken(writeToken);
+  } else if(versionHash) {
+    ValidateVersion(versionHash);
+  } else {
+    ValidateObject(objectId);
+  }
+
+  if(writeToken) {
+    objectId = this.utils.DecodeWriteToken(writeToken).objectId;
+  } else if(versionHash) {
+    objectId = this.utils.DecodeVersionHash(versionHash).objectId;
+  }
+
+  const token = await this.GenerateStateChannelToken({
+    objectId,
+    versionHash
+  });
+
+  return this.HttpClient.RequestJsonBody({
+    headers: {Authorization: `Bearer ${token}`},
+    method: "GET",
+    path: UrlJoin("q", writeToken || versionHash || objectId, property)
+  });
+};
+
+/**
+ * Get content tags
+ *
+ * @methodGroup Content Groups
+ * @namedParams
+ * @param {string=} objectId - ID of the object
+ * @param {string=} versionHash - Hash of the object version
+ * @param {string=} writeToken - Write token of the draft
+ *
+ * @returns {Promise<Array<string>>} - The content object tags
+ */
+exports.ContentObjectTags = async function({objectId, versionHash, writeToken}) {
+  this.Log(`Retrieving content tags: ${writeToken || versionHash || objectId}`);
+
+  return ContentObjectProperty.call(this, {objectId, versionHash, writeToken, property: "tags"});
+};
+
+/**
+ * Get content query fields
+ *
+ * @methodGroup Content Groups
+ * @namedParams
+ * @param {string=} objectId - ID of the object
+ * @param {string=} versionHash - Hash of the object version
+ * @param {string=} writeToken - Write token of the draft
+ *
+ * @returns {Promise<Object<string, string>>} - The content object query fields
+ */
+exports.ContentObjectQueryFields = async function({objectId, versionHash, writeToken}) {
+  this.Log(`Retrieving content query fields: ${writeToken || versionHash || objectId}`);
+
+  return ContentObjectProperty.call(this, {objectId, versionHash, writeToken, property: "query_fields"});
+};
+
+/**
+ * Get the groups a content object belongs to
+ *
+ * @methodGroup Content Groups
+ * @namedParams
+ * @param {string=} objectId - ID of the object
+ * @param {string=} versionHash - Hash of the object version
+ * @param {string=} writeToken - Write token of the draft
+ *
+ * @returns {Promise<Array<string>>} - The content groups the object belongs to
+ */
+exports.ContentObjectGroups = async function({objectId, versionHash, writeToken}) {
+  this.Log(`Retrieving content object groups: ${writeToken || versionHash || objectId}`);
+
+  return ContentObjectProperty.call(this, {objectId, versionHash, writeToken, property: "groups"});
+};
+
+/**
+ * Query tenant content.
+ *
+ * The response is based on the fabric index and can use groups, query_fields and tags for filtering and sorting.
+ * The response may include metadata fields as specified in select/remove.
+ *
+ * @methodGroup Tenants
+ * @namedParams
+ * @param {string=} tenantId - ID of the tenant to query. Defaults to the tenant of the current user
+ * @param {Array<string>=} filter - Filter expressions of the form `<field>:<comparator>:<value>`, e.g.
+ *  `tag:eq:elv:media:live_stream` or `qf.date:ge:2026-09-01`. Multiple expressions are combined with AND.
+ *
+ *  Comparators: `::` or `:co:` contains, `:nc:` not contains, `:eq:` equals, `:ne:` not equals,
+ *  `:lt:` less than, `:le:` less than or equal, `:gt:` greater than, `:ge:` greater than or equal.
+ *  Comparisons are lexicographic string comparisons. `:sw:` and `:ew:` are not supported here.
+ *
+ *  Reserved fields:
+ *  - `tag` - matches when *any one* of the object's tags satisfies the expression
+ *  - `group` - ID of a content group the object belongs to
+ *  - `unique_group.id`, `unique_group.type`
+ *  - `lib`, `library` - library ID. Supports `:eq:` only
+ *  - `created_block_time` - when the latest version was created. Comparison operators only
+ *
+ *  Any other field name is treated as a query field name. Prefix with `qf.` to filter on a query field
+ *  whose name collides with a reserved one, e.g. `qf.tag:eq:x`. `created_block_number` is no longer
+ *  supported and is rejected.
+ *
+ * @param {string=} sortBy - Name of a query field to sort by. This is a query field name, not a metadata path,
+ *  and only one may be given. When omitted, results are sorted by the time the latest version was created.
+ *
+ *  Note that sorting by a query field also restricts the results to objects that have that field
+ * @param {boolean=} sortDescending=false - Sort in descending order
+ * @param {(Array<string> | string)=} include - Index data to return alongside each result. Tokens:
+ *  `tags`, `groups`, `uniquegroups`, `fields` (query fields), `type`, `name`, `all`, `none`. May be given
+ *  as an array or as a comma-separated string. The Fabric defaults to query fields only; `none` suppresses
+ *  all index data, including those
+ * @param {Array<string>=} select - Metadata subtree paths to include in each result. If omitted, no metadata
+ *  is retrieved at all and each result contains only its IDs and index data
+ * @param {Array<string>=} remove - Metadata subtree paths to omit from each result. Only has an effect when
+ *  `select` is also specified
+ * @param {number=} start - Index of the first object to retrieve. Defaults to the first
+ * @param {number=} limit - Maximum number of objects to return. Defaults to 100, capped at 998
+ * @param {string=} authorizationToken - Additional authorization token for the request
+ *
+ * @returns {Promise<Object>} - The query result, including `versions` and `paging` information. One entry per
+ *  content object - the index holds only the latest version - carrying `id`, `hash`, `qlib_id`,
+ *  `last_modified_at` and whatever `include` selects - by default the object's query fields
+ */
+exports.TenantContent = async function({
+  tenantId,
+  filter=[],
+  sortBy,
+  sortDescending,
+  include,
+  select=[],
+  remove=[],
+  start,
+  limit,
+  authorizationToken
+}) {
+  tenantId = tenantId || await this.userProfileClient.TenantContractId();
+  ValidatePresence("tenantId", tenantId);
+
+  this.Log(`Querying content for tenant ${tenantId}`);
+
+  const path = UrlJoin("tenants", tenantId, "q", "query");
+
+  // Tenant query works best with plain token - it allows it to return objecte metadata fields.
+  const token = authorizationToken || await this.CreatePlainToken();
+
+  const httpClient =
+    this.TenantQueryHttpClient && this.TenantQueryHttpClient.uris && this.TenantQueryHttpClient.uris.length > 0
+      ? this.TenantQueryHttpClient
+      : this.HttpClient;
+
+  const queryParams = {
+    filter,
+    sort_by: sortBy,
+    sort_descending: sortDescending,
+    include,
+    select,
+    remove,
+    start,
+    limit
+  };
+
+  Object.keys(queryParams).forEach(key => {
+    const value = queryParams[key];
+    if(value === undefined || (Array.isArray(value) && value.length === 0)) {
+      delete queryParams[key];
+    }
+  });
+
+  return this.utils.ResponseToJson(
+    httpClient.Request({
+      headers: { "Authorization": `Bearer ${token}` },
+      method: "GET",
+      path: path,
+      queryParams
+    })
+  );
+};