@twin.org/blob-storage-models 0.0.1-next.30 → 0.0.1-next.32

package/dist/cjs/index.cjs

@@ -3,6 +3,23 @@
 var dataCore = require('@twin.org/data-core');
 var core = require('@twin.org/core');
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of blob storage data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BlobStorageContexts = {
+    /**
+     * The context root for the blob storage types.
+     */
+    ContextRoot: "https://schema.twindev.org/blob-storage/",
+    /**
+     * The context root for the common types.
+     */
+    ContextRootCommon: "https://schema.twindev.org/common/"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -13,11 +30,7 @@ const BlobStorageTypes = {
     /**
      * Represents blob storage entry.
      */
-    Entry: "BlobStorageEntry",
-    /**
-     * Represents blob storage entry list.
-     */
-    EntryList: "BlobStorageEntryList"
+    Entry: "BlobStorageEntry"
 };
 
 var type = "object";
@@ -110,7 +123,8 @@ class BlobStorageDataTypes {
      * Register all the data types.
      */
     static registerTypes() {
-        dataCore.DataTypeHandlerFactory.register(BlobStorageTypes.Entry, () => ({
+        dataCore.DataTypeHandlerFactory.register(`${BlobStorageContexts.ContextRoot}${BlobStorageTypes.Entry}`, () => ({
+            context: BlobStorageContexts.ContextRoot,
             type: BlobStorageTypes.Entry,
             defaultValue: {},
             jsonSchema: async () => BlobStorageEntrySchema
@@ -126,23 +140,6 @@ class BlobStorageDataTypes {
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const BlobStorageConnectorFactory = core.Factory.createFactory("blob-storage");
 
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The contexts of blob storage data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BlobStorageContexts = {
-    /**
-     * The context root for the blob storage types.
-     */
-    ContextRoot: "https://schema.twindev.org/blob-storage/",
-    /**
-     * The context root for the common types.
-     */
-    ContextRootCommon: "https://schema.twindev.org/common/"
-};
-
 exports.BlobStorageConnectorFactory = BlobStorageConnectorFactory;
 exports.BlobStorageContexts = BlobStorageContexts;
 exports.BlobStorageDataTypes = BlobStorageDataTypes;

package/dist/esm/index.mjs

@@ -1,6 +1,23 @@
 import { DataTypeHandlerFactory } from '@twin.org/data-core';
 import { Factory } from '@twin.org/core';
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The contexts of blob storage data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const BlobStorageContexts = {
+    /**
+     * The context root for the blob storage types.
+     */
+    ContextRoot: "https://schema.twindev.org/blob-storage/",
+    /**
+     * The context root for the common types.
+     */
+    ContextRootCommon: "https://schema.twindev.org/common/"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -11,11 +28,7 @@ const BlobStorageTypes = {
     /**
      * Represents blob storage entry.
      */
-    Entry: "BlobStorageEntry",
-    /**
-     * Represents blob storage entry list.
-     */
-    EntryList: "BlobStorageEntryList"
+    Entry: "BlobStorageEntry"
 };
 
 var type = "object";
@@ -108,7 +121,8 @@ class BlobStorageDataTypes {
      * Register all the data types.
      */
     static registerTypes() {
-        DataTypeHandlerFactory.register(BlobStorageTypes.Entry, () => ({
+        DataTypeHandlerFactory.register(`${BlobStorageContexts.ContextRoot}${BlobStorageTypes.Entry}`, () => ({
+            context: BlobStorageContexts.ContextRoot,
             type: BlobStorageTypes.Entry,
             defaultValue: {},
             jsonSchema: async () => BlobStorageEntrySchema
@@ -124,21 +138,4 @@ class BlobStorageDataTypes {
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const BlobStorageConnectorFactory = Factory.createFactory("blob-storage");
 
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The contexts of blob storage data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BlobStorageContexts = {
-    /**
-     * The context root for the blob storage types.
-     */
-    ContextRoot: "https://schema.twindev.org/blob-storage/",
-    /**
-     * The context root for the common types.
-     */
-    ContextRootCommon: "https://schema.twindev.org/common/"
-};
-
 export { BlobStorageConnectorFactory, BlobStorageContexts, BlobStorageDataTypes, BlobStorageTypes };

package/dist/types/models/IBlobStorageEntryList.d.ts

@@ -1,6 +1,6 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
 import type { BlobStorageContexts } from "./blobStorageContexts";
-import type { BlobStorageTypes } from "./blobStorageTypes";
 import type { IBlobStorageEntry } from "./IBlobStorageEntry";
 /**
  * Interface describing an blob storage entry list.
@@ -10,6 +10,7 @@ export interface IBlobStorageEntryList {
      * JSON-LD Context.
      */
     "@context": [
+        typeof SchemaOrgContexts.ContextRoot,
         typeof BlobStorageContexts.ContextRoot,
         typeof BlobStorageContexts.ContextRootCommon,
         ...IJsonLdContextDefinitionElement[]
@@ -17,13 +18,13 @@ export interface IBlobStorageEntryList {
     /**
      * JSON-LD Type.
      */
-    type: typeof BlobStorageTypes.EntryList;
+    type: typeof SchemaOrgTypes.ItemList;
     /**
      * The list of entries.
      */
-    entries: IBlobStorageEntry[];
+    [SchemaOrgTypes.ItemListElement]: IBlobStorageEntry[];
     /**
      * The cursor to get the next chunk of entries.
      */
-    cursor?: string;
+    [SchemaOrgTypes.NextItem]?: string;
 }

package/dist/types/models/blobStorageTypes.d.ts

@@ -6,10 +6,6 @@ export declare const BlobStorageTypes: {
      * Represents blob storage entry.
      */
     readonly Entry: "BlobStorageEntry";
-    /**
-     * Represents blob storage entry list.
-     */
-    readonly EntryList: "BlobStorageEntryList";
 };
 /**
  * The types of blob storage data.

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/blob-storage-models - Changelog
 
+## [0.0.1-next.32](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.31...blob-storage-models-v0.0.1-next.32) (2025-05-28)
+
+
+### Features
+
+* update to support fully qualified data type names ([3297d69](https://github.com/twinfoundation/blob-storage/commit/3297d69d332058b0f0141002087f56ba230620e1))
+
+## [0.0.1-next.31](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.30...blob-storage-models-v0.0.1-next.31) (2025-05-08)
+
+
+### Features
+
+* use standard list json ld types ([d6bdfd6](https://github.com/twinfoundation/blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
+
 ## [0.0.1-next.30](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.29...blob-storage-models-v0.0.1-next.30) (2025-04-17)
 
 

package/docs/reference/interfaces/IBlobStorageEntryList.md

@@ -6,7 +6,7 @@ Interface describing an blob storage entry list.
 
 ### @context
 
-> **@context**: \[`"https://schema.twindev.org/blob-storage/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+> **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/blob-storage/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
@@ -14,22 +14,22 @@ JSON-LD Context.
 
 ### type
 
-> **type**: `"BlobStorageEntryList"`
+> **type**: `"ItemList"`
 
 JSON-LD Type.
 
 ***
 
-### entries
+### itemListElement
 
-> **entries**: [`IBlobStorageEntry`](IBlobStorageEntry.md)[]
+> **itemListElement**: [`IBlobStorageEntry`](IBlobStorageEntry.md)[]
 
 The list of entries.
 
 ***
 
-### cursor?
+### nextItem?
 
-> `optional` **cursor**: `string`
+> `optional` **nextItem**: `string`
 
 The cursor to get the next chunk of entries.

package/docs/reference/variables/BlobStorageTypes.md

@@ -11,9 +11,3 @@ The types of blob storage data.
 > `readonly` **Entry**: `"BlobStorageEntry"` = `"BlobStorageEntry"`
 
 Represents blob storage entry.
-
-### EntryList
-
-> `readonly` **EntryList**: `"BlobStorageEntryList"` = `"BlobStorageEntryList"`
-
-Represents blob storage entry list.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-models",
-	"version": "0.0.1-next.30",
+	"version": "0.0.1-next.32",
 	"description": "Models which define the structure of the blob storage contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -19,6 +19,7 @@
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
+		"@twin.org/standards-schema-org": "next",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",