@twin.org/blob-storage-models 0.0.2-next.5 → 0.0.3-next.2

package/dist/esm/index.mjs

@@ -1,195 +0,0 @@
-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.
-/**
- * The types of blob storage data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BlobStorageTypes = {
-    /**
-     * Represents blob storage entry.
-     */
-    Entry: "BlobStorageEntry",
-    /**
-     * Represents blob storage entry compression.
-     */
-    CompressionType: "BlobStorageCompressionType"
-};
-
-var $schema$1 = "https://json-schema.org/draft/2020-12/schema";
-var $id$1 = "https://schema.twindev.org/blob-storage/BlobStorageCompressionType";
-var description$1 = "The types of compression for blob storage data.";
-var type$1 = "string";
-var BlobStorageCompressionTypeSchema = {
-	$schema: $schema$1,
-	$id: $id$1,
-	description: description$1,
-	type: type$1,
-	"enum": [
-	"gzip",
-	"deflate"
-]
-};
-
-var $schema = "https://json-schema.org/draft/2020-12/schema";
-var $id = "https://schema.twindev.org/blob-storage/BlobStorageEntry";
-var description = "Interface describing a blob storage entry.";
-var type = "object";
-var properties = {
-	"@context": {
-		type: "array",
-		minItems: 2,
-		items: {
-			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-		},
-		description: "JSON-LD Context.",
-		prefixItems: [
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/blob-storage/"
-			},
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/common/"
-			}
-		]
-	},
-	type: {
-		type: "string",
-		"const": "BlobStorageEntry",
-		description: "JSON-LD Type."
-	},
-	id: {
-		type: "string",
-		description: "The id for the blob."
-	},
-	dateCreated: {
-		type: "string",
-		description: "The date/time when the entry was created."
-	},
-	dateModified: {
-		type: "string",
-		description: "The date/time when the entry was modified."
-	},
-	blobSize: {
-		type: "number",
-		description: "The size of the data in the blob."
-	},
-	blobHash: {
-		type: "string",
-		description: "The hash of the data in the blob."
-	},
-	encodingFormat: {
-		type: "string",
-		description: "The mime type for the blob."
-	},
-	isEncrypted: {
-		type: "boolean",
-		description: "Indicates if the blob is encrypted."
-	},
-	compression: {
-		$ref: "https://schema.twindev.org/blob-storage/BlobStorageCompressionType",
-		description: "The type of compression used for the blob, if not set it is not stored with compression."
-	},
-	fileExtension: {
-		type: "string",
-		description: "The extension."
-	},
-	metadata: {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "The metadata for the blob as JSON-LD."
-	},
-	blob: {
-		type: "string",
-		description: "The blob in base64 format, included if the includeContent flag was set in the request."
-	}
-};
-var required = [
-	"@context",
-	"type",
-	"id",
-	"dateCreated",
-	"blobSize",
-	"blobHash"
-];
-var additionalProperties = false;
-var BlobStorageEntrySchema = {
-	$schema: $schema,
-	$id: $id,
-	description: description,
-	type: type,
-	properties: properties,
-	required: required,
-	additionalProperties: additionalProperties
-};
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Handle all the data types for blob storage.
- */
-class BlobStorageDataTypes {
-    /**
-     * Register all the data types.
-     */
-    static registerTypes() {
-        DataTypeHandlerFactory.register(`${BlobStorageContexts.ContextRoot}${BlobStorageTypes.Entry}`, () => ({
-            context: BlobStorageContexts.ContextRoot,
-            type: BlobStorageTypes.Entry,
-            defaultValue: {},
-            jsonSchema: async () => BlobStorageEntrySchema
-        }));
-        DataTypeHandlerFactory.register(`${BlobStorageContexts.ContextRoot}${BlobStorageTypes.CompressionType}`, () => ({
-            context: BlobStorageContexts.ContextRoot,
-            type: BlobStorageTypes.CompressionType,
-            defaultValue: {},
-            jsonSchema: async () => BlobStorageCompressionTypeSchema
-        }));
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Factory for creating blob storage connectors.
- */
-// 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 types of compression for blob storage data.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const BlobStorageCompressionType = {
-    /**
-     * Gzip.
-     */
-    Gzip: "gzip",
-    /**
-     * Deflate.
-     */
-    Deflate: "deflate"
-};
-
-export { BlobStorageCompressionType, BlobStorageConnectorFactory, BlobStorageContexts, BlobStorageDataTypes, BlobStorageTypes };