@geolonia/geonicdb-sdk 0.14.0 → 0.16.0

package/geonicdb.d.ts

@@ -195,6 +195,13 @@ export interface LoginOptions {
 	 * be sender-constrained, so it is not persisted.
 	 */
 	rememberSession?: boolean;
+	/**
+	 * #1532: 管理者発行の一時パスワードで初回ログインする際に、設定する新パスワードを同梱する。
+	 * 一時パスワードでのログインは、これを付けないとサーバが `PasswordResetRequired` (409) を
+	 * 返す。付けると、その場で新パスワードを設定して本トークンを発行する (単発型、再ログイン不要)。
+	 * 通常のログインでは指定しない。
+	 */
+	newPassword?: string;
 }
 /** Response from the login endpoint. */
 export interface LoginResponse {
@@ -274,6 +281,30 @@ export interface GetTemporalEntitiesParams {
 	 */
 	options?: string;
 }
+/**
+ * `GET /ngsi-ld/v1/types`（`details` 未指定）のレスポンス。
+ * ETSI GS CIM 009 / OpenAPI v1.8.1 の `EntityTypeList`（5.2.24）。
+ * `details=true` の場合は代わりに `EntityType` の配列が返る（本 SDK では未対応）。
+ */
+export interface EntityTypeList {
+	id: string;
+	type: "EntityTypeList";
+	/** 利用可能なエンティティ型名の配列 */
+	typeList: string[];
+	"@context"?: string | string[];
+}
+/**
+ * `GET /ngsi-ld/v1/attributes`（`details` 未指定）のレスポンス。
+ * ETSI GS CIM 009 / OpenAPI v1.8.1 の `AttributeList`（5.2.27）。
+ * `details=true` の場合は代わりに `Attribute` の配列が返る（本 SDK では未対応）。
+ */
+export interface AttributeList {
+	id: string;
+	type: "AttributeList";
+	/** 利用可能な属性名の配列 */
+	attributeList: string[];
+	"@context"?: string | string[];
+}
 export type Listener<T> = (data: T) => void;
 declare class EventEmitter {
 	private _listeners;
@@ -313,6 +344,20 @@ export declare class NotFoundError extends GeonicDBError {
 export declare class ConflictError extends GeonicDBError {
 	constructor(message?: string);
 }
+/**
+ * 409 — 一時パスワードでの初回ログインで、新パスワードの設定が必要 (#1532)。
+ * `login(email, tempPassword)` がこれを投げたら、新パスワードを集めて
+ * `login(email, tempPassword, { newPassword })` を呼び直す。
+ */
+export declare class PasswordResetRequiredError extends AuthenticationError {
+	constructor(message?: string);
+}
+/**
+ * 403 — 一時パスワードの有効期限切れ (#1532)。管理者に再発行を依頼する。
+ */
+export declare class TemporaryPasswordExpiredError extends AuthenticationError {
+	constructor(message?: string);
+}
 /** 422 — Validation error (bad request payload). */
 export declare class ValidationError extends GeonicDBError {
 	constructor(message?: string);
@@ -457,12 +502,24 @@ export declare class GeonicDB extends EventEmitter {
 	deleteEntity(entityId: string): Promise<{
 		deleted: true;
 	}>;
-	/** List all entity types. */
-	getTypes(): Promise<Record<string, unknown>[]>;
+	/**
+	 * List all entity types.
+	 *
+	 * `details` 未指定の `GET /types` は ETSI OpenAPI v1.8.1 準拠の
+	 * `EntityTypeList` オブジェクト（`{ id, type: 'EntityTypeList', typeList }`）を返す。
+	 * 型名の一覧は `typeList` から取得する。
+	 */
+	getTypes(): Promise<EntityTypeList>;
 	/** Get details for a specific entity type. */
 	getType(typeName: string): Promise<Record<string, unknown>>;
-	/** List all attributes. */
-	getAttributes(): Promise<Record<string, unknown>[]>;
+	/**
+	 * List all attributes.
+	 *
+	 * `details` 未指定の `GET /attributes` は ETSI OpenAPI v1.8.1 準拠の
+	 * `AttributeList` オブジェクト（`{ id, type: 'AttributeList', attributeList }`）を返す。
+	 * 属性名の一覧は `attributeList` から取得する。
+	 */
+	getAttributes(): Promise<AttributeList>;
 	/** Get details for a specific attribute. */
 	getAttribute(attrName: string): Promise<Record<string, unknown>>;
 	/** Query temporal entities. */

package/geonicdb.iife.js

@@ -30,7 +30,9 @@ var GeonicDBModule = (() => {
     GeonicDBError: () => GeonicDBError,
     NetworkError: () => NetworkError,
     NotFoundError: () => NotFoundError,
+    PasswordResetRequiredError: () => PasswordResetRequiredError,
     RateLimitError: () => RateLimitError,
+    TemporaryPasswordExpiredError: () => TemporaryPasswordExpiredError,
     ValidationError: () => ValidationError,
     buildPathWithParams: () => buildPathWithParams,
     default: () => index_default
@@ -80,6 +82,7 @@ var GeonicDBModule = (() => {
   var RECONNECT_BASE_MS = 1e3;
   var RECONNECT_MAX_DELAY_MS = 3e4;
   var SUB_PROTOCOL = "access_token";
+  var NGSI_LD_CORE_CONTEXT = "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context-v1.9.jsonld";
   var SDK_CACHE_MAX_ENTRIES_DEFAULT = 1e3;
   var SDK_POLL_INTERVAL_MS_DEFAULT = 5e3;
   var DPOP_IDB_NAME = "geonicdb-sdk";
@@ -321,6 +324,20 @@ var GeonicDBModule = (() => {
       this.name = "ConflictError";
     }
   };
+  var PasswordResetRequiredError = class extends AuthenticationError {
+    constructor(message = "Password reset required: set a new password to complete login") {
+      super(message);
+      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);
+      this.name = "TemporaryPasswordExpiredError";
+      this.statusCode = 403;
+    }
+  };
   var ValidationError = class extends GeonicDBError {
     constructor(message = "Validation failed") {
       super(message, 422);
@@ -711,16 +728,24 @@ var GeonicDBModule = (() => {
         "Content-Type": "application/json"
       };
       if (this._tenant) headers["NGSILD-Tenant"] = this._tenant;
+      const loginBody = { email, password };
+      if (options?.newPassword !== void 0) loginBody.newPassword = options.newPassword;
       const res = await fetch(this._baseUrl + "/auth/login", {
         method: "POST",
         headers,
-        body: JSON.stringify({ email, password })
+        body: JSON.stringify(loginBody)
       });
       if (!res.ok) {
         const e = await res.json().catch(() => ({}));
-        throw new AuthenticationError(
-          e.detail || e.description || "Login failed: " + res.status
-        );
+        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);
+        }
+        if (res.status === 403 && code.includes("TemporaryPasswordExpired")) {
+          throw new TemporaryPasswordExpiredError(message);
+        }
+        throw new AuthenticationError(message);
       }
       const data = await res.json();
       this._anonymous = false;
@@ -1221,7 +1246,15 @@ var GeonicDBModule = (() => {
       }
       const url = this._baseUrl + path;
       const isDPoP = this._tokenType === "DPoP" && !!this._dpopKeyPair && token !== null;
-      const bodyStr = body !== void 0 ? JSON.stringify(body) : void 0;
+      const isEntityWrite = path.split("?")[0].startsWith("/ngsi-ld/v1/entities");
+      let effectiveBody = body;
+      if (isEntityWrite && effectiveBody !== null && typeof effectiveBody === "object" && !Array.isArray(effectiveBody) && !("@context" in effectiveBody)) {
+        effectiveBody = {
+          ...effectiveBody,
+          "@context": NGSI_LD_CORE_CONTEXT
+        };
+      }
+      const bodyStr = effectiveBody !== void 0 ? JSON.stringify(effectiveBody) : void 0;
       const doRequest = async (reqToken, dpopNonce) => {
         const reqIsDPoP = this._tokenType === "DPoP" && !!this._dpopKeyPair && reqToken !== null;
         const dpopProof = reqIsDPoP ? await createDPoPProof(
@@ -1934,7 +1967,13 @@ var GeonicDBModule = (() => {
       return { deleted: true };
     }
     // --- Types / Attributes Discovery ---
-    /** List all entity types. */
+    /**
+     * List all entity types.
+     *
+     * `details` 未指定の `GET /types` は ETSI OpenAPI v1.8.1 準拠の
+     * `EntityTypeList` オブジェクト（`{ id, type: 'EntityTypeList', typeList }`）を返す。
+     * 型名の一覧は `typeList` から取得する。
+     */
     async getTypes() {
       return this._jsonGet("/ngsi-ld/v1/types", "Types query failed");
     }
@@ -1945,7 +1984,13 @@ var GeonicDBModule = (() => {
         "Type not found"
       );
     }
-    /** List all attributes. */
+    /**
+     * List all attributes.
+     *
+     * `details` 未指定の `GET /attributes` は ETSI OpenAPI v1.8.1 準拠の
+     * `AttributeList` オブジェクト（`{ id, type: 'AttributeList', attributeList }`）を返す。
+     * 属性名の一覧は `attributeList` から取得する。
+     */
     async getAttributes() {
       return this._jsonGet("/ngsi-ld/v1/attributes", "Attributes query failed");
     }