@geolonia/geonicdb-sdk 0.16.0 → 0.18.0

package/geonicdb.mjs

@@ -260,13 +260,20 @@ var GeonicDBError = class extends Error {
     super(message);
     /** HTTP status code (if applicable) */
     __publicField(this, "statusCode");
+    /** The request that failed, when the SDK knows it. */
+    __publicField(this, "request");
     this.name = "GeonicDBError";
     this.statusCode = statusCode;
   }
 };
+function withRequest(error, request) {
+  error.request = request;
+  error.message = `[${request.method} ${request.path}] ${error.message}`;
+  return error;
+}
 var AuthenticationError = class extends GeonicDBError {
-  constructor(message = "Authentication failed") {
-    super(message, 401);
+  constructor(message = "Authentication failed", statusCode = 401) {
+    super(message, statusCode);
     this.name = "AuthenticationError";
   }
 };
@@ -290,16 +297,14 @@ var ConflictError = class extends GeonicDBError {
 };
 var PasswordResetRequiredError = class extends AuthenticationError {
   constructor(message = "Password reset required: set a new password to complete login") {
-    super(message);
+    super(message, 409);
     this.name = "PasswordResetRequiredError";
-    this.statusCode = 409;
   }
 };
 var TemporaryPasswordExpiredError = class extends AuthenticationError {
   constructor(message = "Temporary password expired: ask an administrator to re-issue it") {
-    super(message);
+    super(message, 403);
     this.name = "TemporaryPasswordExpiredError";
-    this.statusCode = 403;
   }
 };
 var ValidationError = class extends GeonicDBError {
@@ -704,12 +709,21 @@ var _AuthManager = class _AuthManager {
       const message = e.detail || e.description || "Login failed: " + res.status;
       const code = e.error || e.type || e.title || "";
       if (res.status === 409 && code.includes("PasswordResetRequired")) {
-        throw new PasswordResetRequiredError(message);
+        throw withRequest(new PasswordResetRequiredError(message), {
+          method: "POST",
+          path: "/auth/login"
+        });
       }
       if (res.status === 403 && code.includes("TemporaryPasswordExpired")) {
-        throw new TemporaryPasswordExpiredError(message);
+        throw withRequest(new TemporaryPasswordExpiredError(message), {
+          method: "POST",
+          path: "/auth/login"
+        });
       }
-      throw new AuthenticationError(message);
+      throw withRequest(new AuthenticationError(message, res.status), {
+        method: "POST",
+        path: "/auth/login"
+      });
     }
     const data = await res.json();
     this._anonymous = false;
@@ -812,8 +826,12 @@ var _AuthManager = class _AuthManager {
     }
     if (!res.ok) {
       const e = await res.json().catch(() => ({}));
-      throw new AuthenticationError(
-        e.detail || e.description || "DPoP bind failed: " + res.status
+      throw withRequest(
+        new AuthenticationError(
+          e.detail || e.description || "DPoP bind failed: " + res.status,
+          res.status
+        ),
+        { method: "POST", path: "/auth/dpop-bind" }
       );
     }
     return await res.json();
@@ -985,7 +1003,7 @@ var _AuthManager = class _AuthManager {
         this._refreshToken = null;
         this._token = null;
         this._tokenPromise = null;
-        throw new AuthenticationError("Token refresh failed: " + res.status);
+        throw new AuthenticationError("Token refresh failed: " + res.status, res.status);
       }
       const data = await res.json();
       this._token = data.accessToken;
@@ -1053,7 +1071,7 @@ var _AuthManager = class _AuthManager {
         body: JSON.stringify({ api_key: this._apiKey })
       });
       if (!nonceRes.ok)
-        throw new AuthenticationError("Nonce request failed: " + nonceRes.status);
+        throw new AuthenticationError("Nonce request failed: " + nonceRes.status, nonceRes.status);
       const nonceData = await nonceRes.json();
       if (nonceData.dpop_nonce) this._dpopNonce = nonceData.dpop_nonce;
       const proof = await solvePoW(nonceData.challenge, nonceData.difficulty);
@@ -1066,7 +1084,7 @@ var _AuthManager = class _AuthManager {
       });
       const res = await this._doTokenExchange(tokenUrl, tokenBody, this._dpopNonce);
       if (!res.ok)
-        throw new AuthenticationError("Token request failed: " + res.status);
+        throw new AuthenticationError("Token request failed: " + res.status, res.status);
       const newNonce = res.headers.get("DPoP-Nonce");
       if (newNonce) this._dpopNonce = newNonce;
       const data = await res.json();
@@ -1108,8 +1126,8 @@ var _AuthManager = class _AuthManager {
           return this._doTokenExchange(tokenUrl, tokenBody, serverNonce, retryCount + 1);
         }
       }
-      throw new GeonicDBError(
-        "Token request failed: " + (errBody.error_description || errBody.error),
+      throw new AuthenticationError(
+        "Token request failed: " + (errBody.error_description || errBody.error || "400"),
         400
       );
     }
@@ -1210,13 +1228,12 @@ var _AuthManager = class _AuthManager {
     }
     const url = this._baseUrl + path;
     const isDPoP = this._tokenType === "DPoP" && !!this._dpopKeyPair && token !== null;
-    const isEntityWrite = path.split("?")[0].startsWith("/ngsi-ld/v1/entities");
+    const pathname = path.split("?")[0];
+    const isNgsiLdWrite = pathname.startsWith("/ngsi-ld/v1/") && pathname !== "/ngsi-ld/v1/jsonldContexts";
+    const withCoreContext = (value) => value !== null && typeof value === "object" && !Array.isArray(value) && !("@context" in value) ? { ...value, "@context": NGSI_LD_CORE_CONTEXT } : value;
     let effectiveBody = body;
-    if (isEntityWrite && effectiveBody !== null && typeof effectiveBody === "object" && !Array.isArray(effectiveBody) && !("@context" in effectiveBody)) {
-      effectiveBody = {
-        ...effectiveBody,
-        "@context": NGSI_LD_CORE_CONTEXT
-      };
+    if (isNgsiLdWrite && effectiveBody !== void 0) {
+      effectiveBody = Array.isArray(effectiveBody) ? effectiveBody.map(withCoreContext) : withCoreContext(effectiveBody);
     }
     const bodyStr = effectiveBody !== void 0 ? JSON.stringify(effectiveBody) : void 0;
     const doRequest = async (reqToken, dpopNonce) => {
@@ -1290,6 +1307,7 @@ var WebSocketManager = class {
     __publicField(this, "_emit");
     __publicField(this, "_ws", null);
     __publicField(this, "_wsEndpoint", null);
+    __publicField(this, "_deploymentHostname", null);
     __publicField(this, "_wsIntentionalClose", false);
     __publicField(this, "_reconnectAttempts", 0);
     __publicField(this, "_tokenRefreshTimer", null);
@@ -1362,6 +1380,7 @@ var WebSocketManager = class {
       if (options.entityTypes) msg.entityTypes = options.entityTypes;
       if (options.idPattern) msg.idPattern = options.idPattern;
       if (options.scopeQ) msg.scopeQ = options.scopeQ;
+      if (options["@context"]) msg["@context"] = options["@context"];
     }
     this._subscription = msg;
     if (this._pendingSubscription) return;
@@ -1378,6 +1397,9 @@ var WebSocketManager = class {
         const info = await res.json();
         if (info.enabled && info.endpoint) {
           this._wsEndpoint = info.endpoint;
+          if (info.deployment) {
+            this._deploymentHostname = info.deployment;
+          }
           return this._wsEndpoint;
         }
       }
@@ -1389,7 +1411,11 @@ var WebSocketManager = class {
   async _openWebSocket(token) {
     const endpoint = await this._discoverWsEndpoint();
     return new Promise((resolve, reject) => {
-      const wsUrl = endpoint + (endpoint.indexOf("?") === -1 ? "?" : "&") + "tenant=" + encodeURIComponent(this._tenant);
+      const params = new URLSearchParams({ tenant: this._tenant });
+      if (this._deploymentHostname) {
+        params.set("deployment", this._deploymentHostname);
+      }
+      const wsUrl = endpoint + (endpoint.indexOf("?") === -1 ? "?" : "&") + params.toString();
       this._log("connecting", wsUrl);
       const ws = new WebSocket(wsUrl, [SUB_PROTOCOL, token]);
       this._ws = ws;
@@ -1429,6 +1455,10 @@ var WebSocketManager = class {
           return;
         }
         if (msg.type === "pong") return;
+        if (msg.type === "subscribed") {
+          this._emit("subscribed", void 0);
+          return;
+        }
         if (msg.type === "dpop_verified") {
           this._pendingSubscription = false;
           if (this._subscription) {
@@ -1684,6 +1714,7 @@ var GeonicDB = class extends EventEmitter {
       if (!tenant) tenant = script?.getAttribute?.("data-tenant") || "";
       if (!baseUrl) baseUrl = script?.getAttribute?.("data-base-url") || "";
     }
+    baseUrl = baseUrl.replace(/\/+$/, "");
     this._auth = new AuthManager(baseUrl, apiKey, tenant, opts.debug, opts.anonymous);
     this._auth.onTokenRefresh = (creds) => {
       this.onTokenRefresh?.(creds);
@@ -1895,7 +1926,9 @@ var GeonicDB = class extends EventEmitter {
       limit: 0,
       type: params?.type,
       q: params?.q,
-      scopeQ: params?.scopeQ
+      scopeQ: params?.scopeQ,
+      // #2278: clause 5.7.2.4 の "too wide query" 免除条件 (e) local scope。
+      local: params?.local
     });
     const res = await this._auth.request("GET", path);
     if (!res.ok) {
@@ -1992,7 +2025,21 @@ var GeonicDB = class extends EventEmitter {
       "Batch create failed"
     );
   }
-  /** Upsert multiple entities in a single request. */
+  /**
+   * Upsert multiple entities in a single request.
+   *
+   * #1742: the server follows ETSI GS CIM 009 clause 5.6.8.5 / Table 6.15.3.1-1:
+   *  - **201** with a `string[]` of the **created** entity IDs, when at least one entity
+   *    was newly created and none failed (merely updated entities are not listed);
+   *  - **204** with no body, when every entity already existed and was updated
+   *    (`_jsonPost` maps this to `{}`);
+   *  - **207** with a `BatchOperationResult` (`{ created, updated, errors }`), on partial
+   *    or total failure.
+   *
+   * The return type reflects all three shapes. Narrow with `Array.isArray(result)` to
+   * detect the "something was created" case.
+   * https://cim.etsi.org/NGSI-LD/official/clause-6.html
+   */
   async batchUpsert(entities) {
     return this._jsonPost(
       "/ngsi-ld/v1/entityOperations/upsert",