@geolonia/geonicdb-sdk 0.15.0 → 0.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geolonia/geonicdb-sdk",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "GeonicDB JavaScript SDK — NGSI-LD Context Broker client for browser and Node.js",
   "main": "geonicdb.cjs",
   "module": "geonicdb.mjs",

package/react/index.d.ts

@@ -283,6 +283,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;
@@ -404,12 +428,24 @@ 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. */
@@ -484,7 +520,7 @@ export interface LdGeoProperty {
 /** NGSI-LD Relationship */
 export interface LdRelationship {
 	type: "Relationship";
-	object: string;
+	object: string | string[];
 	observedAt?: string;
 }
 export type LdAttribute = LdProperty | LdGeoProperty | LdRelationship;