@geolonia/geonicdb-sdk 0.14.0 → 0.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@geolonia/geonicdb-sdk",
3
- "version": "0.14.0",
3
+ "version": "0.16.0",
4
4
  "description": "GeonicDB JavaScript SDK — NGSI-LD Context Broker client for browser and Node.js",
5
5
  "main": "geonicdb.cjs",
6
6
  "module": "geonicdb.mjs",
package/react/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  // Generated by dts-bundle-generator v9.5.1
2
2
 
3
- import { CSSProperties } from 'react';
3
+ /// <reference types="react" />
4
4
 
5
5
  /**
6
6
  * Copyright (c) 2026 Geolonia Inc.
@@ -197,6 +197,13 @@ export interface LoginOptions {
197
197
  * be sender-constrained, so it is not persisted.
198
198
  */
199
199
  rememberSession?: boolean;
200
+ /**
201
+ * #1532: 管理者発行の一時パスワードで初回ログインする際に、設定する新パスワードを同梱する。
202
+ * 一時パスワードでのログインは、これを付けないとサーバが `PasswordResetRequired` (409) を
203
+ * 返す。付けると、その場で新パスワードを設定して本トークンを発行する (単発型、再ログイン不要)。
204
+ * 通常のログインでは指定しない。
205
+ */
206
+ newPassword?: string;
200
207
  }
201
208
  /** Response from the login endpoint. */
202
209
  export interface LoginResponse {
@@ -276,6 +283,30 @@ export interface GetTemporalEntitiesParams {
276
283
  */
277
284
  options?: string;
278
285
  }
286
+ /**
287
+ * `GET /ngsi-ld/v1/types`(`details` 未指定)のレスポンス。
288
+ * ETSI GS CIM 009 / OpenAPI v1.8.1 の `EntityTypeList`(5.2.24)。
289
+ * `details=true` の場合は代わりに `EntityType` の配列が返る(本 SDK では未対応)。
290
+ */
291
+ export interface EntityTypeList {
292
+ id: string;
293
+ type: "EntityTypeList";
294
+ /** 利用可能なエンティティ型名の配列 */
295
+ typeList: string[];
296
+ "@context"?: string | string[];
297
+ }
298
+ /**
299
+ * `GET /ngsi-ld/v1/attributes`(`details` 未指定)のレスポンス。
300
+ * ETSI GS CIM 009 / OpenAPI v1.8.1 の `AttributeList`(5.2.27)。
301
+ * `details=true` の場合は代わりに `Attribute` の配列が返る(本 SDK では未対応)。
302
+ */
303
+ export interface AttributeList {
304
+ id: string;
305
+ type: "AttributeList";
306
+ /** 利用可能な属性名の配列 */
307
+ attributeList: string[];
308
+ "@context"?: string | string[];
309
+ }
279
310
  export type Listener<T> = (data: T) => void;
280
311
  declare class EventEmitter {
281
312
  private _listeners;
@@ -397,12 +428,24 @@ declare class GeonicDB extends EventEmitter {
397
428
  deleteEntity(entityId: string): Promise<{
398
429
  deleted: true;
399
430
  }>;
400
- /** List all entity types. */
401
- getTypes(): Promise<Record<string, unknown>[]>;
431
+ /**
432
+ * List all entity types.
433
+ *
434
+ * `details` 未指定の `GET /types` は ETSI OpenAPI v1.8.1 準拠の
435
+ * `EntityTypeList` オブジェクト(`{ id, type: 'EntityTypeList', typeList }`)を返す。
436
+ * 型名の一覧は `typeList` から取得する。
437
+ */
438
+ getTypes(): Promise<EntityTypeList>;
402
439
  /** Get details for a specific entity type. */
403
440
  getType(typeName: string): Promise<Record<string, unknown>>;
404
- /** List all attributes. */
405
- getAttributes(): Promise<Record<string, unknown>[]>;
441
+ /**
442
+ * List all attributes.
443
+ *
444
+ * `details` 未指定の `GET /attributes` は ETSI OpenAPI v1.8.1 準拠の
445
+ * `AttributeList` オブジェクト(`{ id, type: 'AttributeList', attributeList }`)を返す。
446
+ * 属性名の一覧は `attributeList` から取得する。
447
+ */
448
+ getAttributes(): Promise<AttributeList>;
406
449
  /** Get details for a specific attribute. */
407
450
  getAttribute(attrName: string): Promise<Record<string, unknown>>;
408
451
  /** Query temporal entities. */
@@ -477,7 +520,7 @@ export interface LdGeoProperty {
477
520
  /** NGSI-LD Relationship */
478
521
  export interface LdRelationship {
479
522
  type: "Relationship";
480
- object: string;
523
+ object: string | string[];
481
524
  observedAt?: string;
482
525
  }
483
526
  export type LdAttribute = LdProperty | LdGeoProperty | LdRelationship;