@twin.org/blob-storage-models 0.0.1-next.27 → 0.0.1-next.29

package/dist/cjs/index.cjs

@@ -10,14 +10,6 @@ var core = require('@twin.org/core');
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const BlobStorageTypes = {
-    /**
-     * 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/",
     /**
      * Represents blob storage entry.
      */
@@ -134,6 +126,24 @@ 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;
 exports.BlobStorageTypes = BlobStorageTypes;

package/dist/esm/index.mjs

@@ -8,14 +8,6 @@ import { Factory } from '@twin.org/core';
  */
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const BlobStorageTypes = {
-    /**
-     * 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/",
     /**
      * Represents blob storage entry.
      */
@@ -132,4 +124,21 @@ class BlobStorageDataTypes {
 // eslint-disable-next-line @typescript-eslint/naming-convention
 const BlobStorageConnectorFactory = Factory.createFactory("blob-storage");
 
-export { BlobStorageConnectorFactory, BlobStorageDataTypes, BlobStorageTypes };
+// 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/index.d.ts

@@ -9,6 +9,7 @@ export * from "./models/api/IBlobStorageListRequest";
 export * from "./models/api/IBlobStorageListResponse";
 export * from "./models/api/IBlobStorageRemoveRequest";
 export * from "./models/api/IBlobStorageUpdateRequest";
+export * from "./models/blobStorageContexts";
 export * from "./models/blobStorageTypes";
 export * from "./models/IBlobStorageComponent";
 export * from "./models/IBlobStorageConnector";

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

@@ -1,4 +1,5 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { BlobStorageContexts } from "./blobStorageContexts";
 import type { BlobStorageTypes } from "./blobStorageTypes";
 /**
  * Interface describing a blob storage entry.
@@ -8,8 +9,8 @@ export interface IBlobStorageEntry {
      * JSON-LD Context.
      */
     "@context": [
-        typeof BlobStorageTypes.ContextRoot,
-        typeof BlobStorageTypes.ContextRootCommon,
+        typeof BlobStorageContexts.ContextRoot,
+        typeof BlobStorageContexts.ContextRootCommon,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**

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

@@ -1,4 +1,5 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { BlobStorageContexts } from "./blobStorageContexts";
 import type { BlobStorageTypes } from "./blobStorageTypes";
 import type { IBlobStorageEntry } from "./IBlobStorageEntry";
 /**
@@ -9,8 +10,8 @@ export interface IBlobStorageEntryList {
      * JSON-LD Context.
      */
     "@context": [
-        typeof BlobStorageTypes.ContextRoot,
-        typeof BlobStorageTypes.ContextRootCommon,
+        typeof BlobStorageContexts.ContextRoot,
+        typeof BlobStorageContexts.ContextRootCommon,
         ...IJsonLdContextDefinitionElement[]
     ];
     /**

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

@@ -0,0 +1,17 @@
+/**
+ * The contexts of blob storage data.
+ */
+export declare const BlobStorageContexts: {
+    /**
+     * The context root for the blob storage types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/blob-storage/";
+    /**
+     * The context root for the common types.
+     */
+    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+};
+/**
+ * The contexts of blob storage data.
+ */
+export type BlobStorageContexts = (typeof BlobStorageContexts)[keyof typeof BlobStorageContexts];

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

@@ -2,14 +2,6 @@
  * The types of blob storage data.
  */
 export declare const BlobStorageTypes: {
-    /**
-     * The context root for the blob storage types.
-     */
-    readonly ContextRoot: "https://schema.twindev.org/blob-storage/";
-    /**
-     * The context root for the common types.
-     */
-    readonly ContextRootCommon: "https://schema.twindev.org/common/";
     /**
      * Represents blob storage entry.
      */

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # @twin.org/blob-storage-models - Changelog
 
-## v0.0.1-next.27
+## [0.0.1-next.29](https://github.com/twinfoundation/blob-storage/compare/blob-storage-models-v0.0.1-next.28...blob-storage-models-v0.0.1-next.29) (2025-03-28)
+
+
+### Bug Fixes
+
+* Adding the optional flag to the entity ([#10](https://github.com/twinfoundation/blob-storage/issues/10)) ([626677e](https://github.com/twinfoundation/blob-storage/commit/626677e5730d23535a0eb1f36f8394d941ff2447))
+
+## v0.0.1-next.28
 
 - Initial Release

package/docs/reference/index.md

@@ -22,9 +22,11 @@
 
 ## Type Aliases
 
+- [BlobStorageContexts](type-aliases/BlobStorageContexts.md)
 - [BlobStorageTypes](type-aliases/BlobStorageTypes.md)
 
 ## Variables
 
 - [BlobStorageConnectorFactory](variables/BlobStorageConnectorFactory.md)
+- [BlobStorageContexts](variables/BlobStorageContexts.md)
 - [BlobStorageTypes](variables/BlobStorageTypes.md)

package/docs/reference/type-aliases/BlobStorageContexts.md

@@ -0,0 +1,5 @@
+# Type Alias: BlobStorageContexts
+
+> **BlobStorageContexts**: *typeof* [`BlobStorageContexts`](../variables/BlobStorageContexts.md)\[keyof *typeof* [`BlobStorageContexts`](../variables/BlobStorageContexts.md)\]
+
+The contexts of blob storage data.

package/docs/reference/variables/BlobStorageContexts.md

@@ -0,0 +1,19 @@
+# Variable: BlobStorageContexts
+
+> `const` **BlobStorageContexts**: `object`
+
+The contexts of blob storage data.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/blob-storage/"` = `"https://schema.twindev.org/blob-storage/"`
+
+The context root for the blob storage types.
+
+### ContextRootCommon
+
+> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+
+The context root for the common types.

package/docs/reference/variables/BlobStorageTypes.md

@@ -6,18 +6,6 @@ The types of blob storage data.
 
 ## Type declaration
 
-### ContextRoot
-
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/blob-storage/"` = `"https://schema.twindev.org/blob-storage/"`
-
-The context root for the blob storage types.
-
-### ContextRootCommon
-
-> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
-
-The context root for the common types.
-
 ### Entry
 
 > `readonly` **Entry**: `"BlobStorageEntry"` = `"BlobStorageEntry"`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-models",
-	"version": "0.0.1-next.27",
+	"version": "0.0.1-next.29",
 	"description": "Models which define the structure of the blob storage contracts and connectors",
 	"repository": {
 		"type": "git",