@mediaviz/sdk 1.2.0 → 1.4.0

package/dist/sdk.cjs

@@ -91,8 +91,15 @@ function requireErrors () {
 	   * @returns {OAuthError}
 	   */
 	  static fromResponse(status, body) {
-	    if (body && typeof body === 'object' && typeof body.error === 'string') {
-	      return new OAuthError(body.error, body.error_description ?? '', status, body);
+	    // FastAPI wraps HTTPException payloads in a `detail` envelope, so an OAuth
+	    // error arrives as { detail: { error, error_description } }. Unwrap it
+	    // before falling back, or every server-side OAuth error reads as server_error.
+	    const payload =
+	      body && typeof body === 'object' && typeof body.error !== 'string' && body.detail
+	        ? body.detail
+	        : body;
+	    if (payload && typeof payload === 'object' && typeof payload.error === 'string') {
+	      return new OAuthError(payload.error, payload.error_description ?? '', status, body);
 	    }
 	    return new OAuthError('server_error', 'Unexpected server response', status, body);
 	  }
@@ -173,6 +180,9 @@ function requireClient () {
 	const { postForm, postJson } = requireHttp();
 	const { OAuthError } = requireErrors();
 
+	// In-flight dedup key for client_credentials re-mints (no refresh_token to key on).
+	const CLIENT_CREDENTIALS_KEY = Symbol('client_credentials');
+
 	class OAuthClient {
 	  /**
 	   * @param {import('./types').OAuthClientConfig} config
@@ -188,12 +198,22 @@ function requireClient () {
 	   */
 	  static async registerClient(params) {
 	    const baseUrl = params.baseUrl.replace(/\/+$/, '');
-	    return postJson(`${baseUrl}/oauth/clients`, {
+	    const body = {
 	      client_name: params.clientName,
 	      client_type: params.clientType,
 	      redirect_uris: params.redirectUris,
 	      is_first_party: params.isFirstParty,
-	    });
+	    };
+	    // grant_types/company_id are required to provision a confidential
+	    // client_credentials (machine-to-machine) client; omitted bodies keep the
+	    // legacy public/authorization_code shape. The endpoint is admin-gated, so a
+	    // bearer token must be supplied for the request to authenticate.
+	    if (params.grantTypes !== undefined) body.grant_types = params.grantTypes;
+	    if (params.companyId !== undefined) body.company_id = params.companyId;
+	    const headers = params.accessToken
+	      ? { Authorization: `Bearer ${params.accessToken}` }
+	      : {};
+	    return postJson(`${baseUrl}/oauth/clients`, body, headers);
 	  }
 
 	  /**
@@ -311,15 +331,27 @@ function requireClient () {
 	      return { data: json, updatedTokens: null };
 	    }
 
-	    // 401: attempt refresh — propagate OAuthError if refresh fails.
-	    // Concurrent request() callers with the same refresh_token share one in-flight
-	    // call so the server only sees one rotation (the second would get invalid_grant).
-	    let pending = this._inFlightRefreshes.get(refreshToken);
+	    // 401: re-authenticate, then retry once.
+	    // - User sessions (refresh_token present) use the refresh_token grant. The server
+	    //   rotates the token one-time, so concurrent callers share one in-flight call
+	    //   (a second rotation would get invalid_grant).
+	    // - Machine-to-machine sessions (no refresh_token, client_secret configured) re-mint
+	    //   via client_credentials, which issues no refresh token to rotate (RFC 6749 §4.4).
+	    // - With neither a refresh_token nor a client_secret there is nothing to retry with.
+	    if (!refreshToken && !this._config.clientSecret) {
+	      throw OAuthError.fromResponse(401, await firstResponse.json());
+	    }
+
+	    const reauthKey = refreshToken || CLIENT_CREDENTIALS_KEY;
+	    let pending = this._inFlightRefreshes.get(reauthKey);
 	    if (!pending) {
-	      pending = this.refreshAccessToken(refreshToken).finally(() => {
-	        this._inFlightRefreshes.delete(refreshToken);
+	      const reauth = refreshToken
+	        ? this.refreshAccessToken(refreshToken)
+	        : this.getClientCredentialsToken();
+	      pending = reauth.finally(() => {
+	        this._inFlightRefreshes.delete(reauthKey);
 	      });
-	      this._inFlightRefreshes.set(refreshToken, pending);
+	      this._inFlightRefreshes.set(reauthKey, pending);
 	    }
 	    const newTokens = await pending;
 
@@ -401,6 +433,9 @@ function requireTypes () {
 	 * @property {string} clientType - "public" or "confidential"
 	 * @property {string[]} redirectUris - HTTPS redirect URIs
 	 * @property {boolean} isFirstParty - Whether this is a first-party client
+	 * @property {string[]} [grantTypes] - Allowed grants, e.g. ["client_credentials"]; required for machine-to-machine clients
+	 * @property {number} [companyId] - Company to bind the client to; required for the client_credentials grant
+	 * @property {string} [accessToken] - Admin bearer token; the registration endpoint is authorization-gated
 	 */
 
 	/**
@@ -458,6 +493,17 @@ class AiModelCredits {
   }
 }
 
+class Admin {
+  constructor(ctx) { this._ctx = ctx; }
+
+  async getCategoryLabels(category) {
+    this._ctx.requireTokens();
+    const path = `/api/v1/admin/category_labels/${encodeURIComponent(category)}`;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+}
+
 class Company {
   constructor(ctx) { this._ctx = ctx; }
 
@@ -901,6 +947,17 @@ class Keywords {
     return data;
   }
 
+  async addCompanyToKeywordFilteringList(keywordListId, { companyId } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/keyword/${encodeURIComponent(keywordListId)}/company`;
+    const query = new URLSearchParams();
+    if (companyId !== undefined) (Array.isArray(companyId) ? companyId : [companyId]).forEach(v => query.append('company_id', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'POST', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
   async requestKeywordListExport(keywordListId) {
     this._ctx.requireTokens();
     const path = `/api/v1/keyword/export/${encodeURIComponent(keywordListId)}`;
@@ -933,6 +990,17 @@ class Keywords {
     return data;
   }
 
+  async removeCompanyFromKeywordFilteringList(keywordListId, { companyId } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/keyword/${encodeURIComponent(keywordListId)}/company`;
+    const query = new URLSearchParams();
+    if (companyId !== undefined) (Array.isArray(companyId) ? companyId : [companyId]).forEach(v => query.append('company_id', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'DELETE', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
   async deleteKeywordFilteringListById(keywordListId) {
     this._ctx.requireTokens();
     const path = `/api/v1/keyword/${encodeURIComponent(keywordListId)}`;
@@ -1092,6 +1160,17 @@ class Person {
     return data;
   }
 
+  async getPhotoIdsByPersons(projectTableName, { personId } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/person/${encodeURIComponent(projectTableName)}/photos`;
+    const query = new URLSearchParams();
+    if (personId !== undefined) (Array.isArray(personId) ? personId : [personId]).forEach(v => query.append('person_id', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
+
   async getAllPersonsFromPhoto(projectTableName, photoId) {
     this._ctx.requireTokens();
     const path = `/api/v1/person/${encodeURIComponent(projectTableName)}/photo/${encodeURIComponent(photoId)}`;
@@ -1392,13 +1471,6 @@ class Photos {
     return data;
   }
 
-  async getProjectThumbnail(tableName) {
-    this._ctx.requireTokens();
-    const path = `/api/v1/photos_project/${encodeURIComponent(tableName)}`;
-    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
-    return data;
-  }
-
   async updatePhotoInProject({ tableName, photoId, photoData } = {}) {
     this._ctx.requireTokens();
     let path = `/api/v1/photos_update`;
@@ -1461,50 +1533,56 @@ class Search {
     return data;
   }
 
-  async searchProjectPhotosText(projectTableName, searchText, size = undefined) {
+  async searchProjectPhotosParametrized(projectTableName, { andSearchText, orSearchText, notSearchText, city, country, state, albums, dateMin, dateMax, dateNullAnd, dateNullOr, ascOrDesc, bestOfSimilarSetsOnly, splitByTier, lastId, limit } = {}) {
     this._ctx.requireTokens();
-    const path = `/api/v1/search/text/${encodeURIComponent(projectTableName)}/`;
-    const body = stripUndef$1({
-      search_text: searchText,
-      size: size,
-    });
-    const { data } = await this._ctx.client.request(path, 'POST', this._ctx.accessToken, this._ctx.refreshToken, body);
-    return data;
-  }
-
-  async searchProjectPhotosNaturalLanguage(projectTableName, searchText, size = undefined) {
-    this._ctx.requireTokens();
-    const path = `/api/v1/search/nl/${encodeURIComponent(projectTableName)}/`;
-    const body = stripUndef$1({
-      search_text: searchText,
-      size: size,
-    });
-    const { data } = await this._ctx.client.request(path, 'POST', this._ctx.accessToken, this._ctx.refreshToken, body);
+    let path = `/api/v1/search/parametrized/${encodeURIComponent(projectTableName)}/`;
+    const query = new URLSearchParams();
+    if (andSearchText !== undefined) (Array.isArray(andSearchText) ? andSearchText : [andSearchText]).forEach(v => query.append('and_search_text', v));
+    if (orSearchText !== undefined) (Array.isArray(orSearchText) ? orSearchText : [orSearchText]).forEach(v => query.append('or_search_text', v));
+    if (notSearchText !== undefined) (Array.isArray(notSearchText) ? notSearchText : [notSearchText]).forEach(v => query.append('not_search_text', v));
+    if (city !== undefined) (Array.isArray(city) ? city : [city]).forEach(v => query.append('city', v));
+    if (country !== undefined) (Array.isArray(country) ? country : [country]).forEach(v => query.append('country', v));
+    if (state !== undefined) (Array.isArray(state) ? state : [state]).forEach(v => query.append('state', v));
+    if (albums !== undefined) (Array.isArray(albums) ? albums : [albums]).forEach(v => query.append('albums', v));
+    if (dateMin !== undefined) (Array.isArray(dateMin) ? dateMin : [dateMin]).forEach(v => query.append('date_min', v));
+    if (dateMax !== undefined) (Array.isArray(dateMax) ? dateMax : [dateMax]).forEach(v => query.append('date_max', v));
+    if (dateNullAnd !== undefined) (Array.isArray(dateNullAnd) ? dateNullAnd : [dateNullAnd]).forEach(v => query.append('date_null_and', v));
+    if (dateNullOr !== undefined) (Array.isArray(dateNullOr) ? dateNullOr : [dateNullOr]).forEach(v => query.append('date_null_or', v));
+    if (ascOrDesc !== undefined) (Array.isArray(ascOrDesc) ? ascOrDesc : [ascOrDesc]).forEach(v => query.append('asc_or_desc', v));
+    if (bestOfSimilarSetsOnly !== undefined) (Array.isArray(bestOfSimilarSetsOnly) ? bestOfSimilarSetsOnly : [bestOfSimilarSetsOnly]).forEach(v => query.append('best_of_similar_sets_only', v));
+    if (splitByTier !== undefined) (Array.isArray(splitByTier) ? splitByTier : [splitByTier]).forEach(v => query.append('split_by_tier', v));
+    if (lastId !== undefined) (Array.isArray(lastId) ? lastId : [lastId]).forEach(v => query.append('last_id', v));
+    if (limit !== undefined) (Array.isArray(limit) ? limit : [limit]).forEach(v => query.append('limit', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
     return data;
   }
 
-  async searchProjectPhotosNaturalLanguageHybrid(projectTableName, searchText, size = undefined, { blend, minCosine } = {}) {
+  async recallProjectPhotoIds(projectTableName, { ascOrDesc, bestOfSimilarSetsOnly, lastId, limit } = {}) {
     this._ctx.requireTokens();
-    let path = `/api/v1/search/nl_hybrid/${encodeURIComponent(projectTableName)}/`;
+    let path = `/api/v1/search/recall/${encodeURIComponent(projectTableName)}/`;
     const query = new URLSearchParams();
-    if (blend !== undefined) (Array.isArray(blend) ? blend : [blend]).forEach(v => query.append('blend', v));
-    if (minCosine !== undefined) (Array.isArray(minCosine) ? minCosine : [minCosine]).forEach(v => query.append('min_cosine', v));
+    if (ascOrDesc !== undefined) (Array.isArray(ascOrDesc) ? ascOrDesc : [ascOrDesc]).forEach(v => query.append('asc_or_desc', v));
+    if (bestOfSimilarSetsOnly !== undefined) (Array.isArray(bestOfSimilarSetsOnly) ? bestOfSimilarSetsOnly : [bestOfSimilarSetsOnly]).forEach(v => query.append('best_of_similar_sets_only', v));
+    if (lastId !== undefined) (Array.isArray(lastId) ? lastId : [lastId]).forEach(v => query.append('last_id', v));
+    if (limit !== undefined) (Array.isArray(limit) ? limit : [limit]).forEach(v => query.append('limit', v));
     const qs = query.toString();
     if (qs) path += '?' + qs;
-    const body = stripUndef$1({
-      search_text: searchText,
-      size: size,
-    });
-    const { data } = await this._ctx.client.request(path, 'POST', this._ctx.accessToken, this._ctx.refreshToken, body);
+    const { data } = await this._ctx.client.request(path, 'GET', this._ctx.accessToken, this._ctx.refreshToken);
     return data;
   }
 
-  async searchProjectPhotosNaturalLanguageAuto(projectTableName, searchText, size = undefined, { blend, minCosine } = {}) {
+  async searchProjectPhotosNaturalLanguage(projectTableName, searchText, size = undefined, { minCosine, labelMinCosine, labelTopK, labelDelta, bestOfSimilarSetsOnly, splitByTier } = {}) {
     this._ctx.requireTokens();
-    let path = `/api/v1/search/auto/${encodeURIComponent(projectTableName)}/`;
+    let path = `/api/v1/search/natural_language/${encodeURIComponent(projectTableName)}/`;
     const query = new URLSearchParams();
-    if (blend !== undefined) (Array.isArray(blend) ? blend : [blend]).forEach(v => query.append('blend', v));
     if (minCosine !== undefined) (Array.isArray(minCosine) ? minCosine : [minCosine]).forEach(v => query.append('min_cosine', v));
+    if (labelMinCosine !== undefined) (Array.isArray(labelMinCosine) ? labelMinCosine : [labelMinCosine]).forEach(v => query.append('label_min_cosine', v));
+    if (labelTopK !== undefined) (Array.isArray(labelTopK) ? labelTopK : [labelTopK]).forEach(v => query.append('label_top_k', v));
+    if (labelDelta !== undefined) (Array.isArray(labelDelta) ? labelDelta : [labelDelta]).forEach(v => query.append('label_delta', v));
+    if (bestOfSimilarSetsOnly !== undefined) (Array.isArray(bestOfSimilarSetsOnly) ? bestOfSimilarSetsOnly : [bestOfSimilarSetsOnly]).forEach(v => query.append('best_of_similar_sets_only', v));
+    if (splitByTier !== undefined) (Array.isArray(splitByTier) ? splitByTier : [splitByTier]).forEach(v => query.append('split_by_tier', v));
     const qs = query.toString();
     if (qs) path += '?' + qs;
     const body = stripUndef$1({
@@ -1656,6 +1734,17 @@ class Users {
     const { data } = await this._ctx.client.request(path, 'PUT', this._ctx.accessToken, this._ctx.refreshToken, body);
     return data;
   }
+
+  async deleteUser(userId, { newCompanyOwnerId } = {}) {
+    this._ctx.requireTokens();
+    let path = `/api/v1/users/delete/${encodeURIComponent(userId)}`;
+    const query = new URLSearchParams();
+    if (newCompanyOwnerId !== undefined) (Array.isArray(newCompanyOwnerId) ? newCompanyOwnerId : [newCompanyOwnerId]).forEach(v => query.append('new_company_owner_id', v));
+    const qs = query.toString();
+    if (qs) path += '?' + qs;
+    const { data } = await this._ctx.client.request(path, 'DELETE', this._ctx.accessToken, this._ctx.refreshToken);
+    return data;
+  }
 }
 
 // Auto-generated — do not edit
@@ -1720,6 +1809,7 @@ class MediaViz {
 
     const _ctx = new _Context(this);
     this.aiModelCredits = new AiModelCredits(_ctx);
+    this.admin = new Admin(_ctx);
     this.company = new Company(_ctx);
     this.curatedAlbums = new CuratedAlbums(_ctx);
     this.customAlbums = new CustomAlbums(_ctx);
@@ -1764,6 +1854,7 @@ class MediaViz {
   get refreshToken() { return this._refreshToken; }
 }
 
+exports.Admin = Admin;
 exports.AiModelCredits = AiModelCredits;
 exports.ApiError = ApiError;
 exports.Company = Company;