@twin.org/blob-storage-models 0.0.1-next.9 → 0.0.2-next.1

package/docs/reference/interfaces/IBlobStorageConnector.md

@@ -16,7 +16,9 @@ Set the blob.
 
 #### Parameters
 
-• **blob**: `Uint8Array`
+##### blob
+
+`Uint8Array`
 
 The data for the blob.
 
@@ -30,19 +32,21 @@ The id of the stored blob in urn format.
 
 ### get()
 
-> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\>
+> **get**(`id`): `Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
 
 Get the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to get in urn format.
 
 #### Returns
 
-`Promise`\<`undefined` \| `Uint8Array`\>
+`Promise`\<`undefined` \| `Uint8Array`\<`ArrayBufferLike`\>\>
 
 The data for the blob if it can be found or undefined.
 
@@ -56,7 +60,9 @@ Remove the blob.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the blob to remove in urn format.
 

package/docs/reference/interfaces/IBlobStorageCreateRequest.md

@@ -16,15 +16,15 @@ The body parameters.
 
 The data to store in base64 encoding.
 
-#### mimeType?
+#### encodingFormat?
 
-> `optional` **mimeType**: `string`
+> `optional` **encodingFormat**: `string`
 
 The mime type of the blob, will be detected if left undefined.
 
-#### extension?
+#### fileExtension?
 
-> `optional` **extension**: `string`
+> `optional` **fileExtension**: `string`
 
 The extension of the blob, will be detected if left undefined.
 
@@ -34,6 +34,36 @@ The extension of the blob, will be detected if left undefined.
 
 Custom metadata to associate with the blob as JSON-LD.
 
+#### disableEncryption?
+
+> `optional` **disableEncryption**: `boolean`
+
+Disables encryption if enabled by default.
+
+##### Default
+
+```ts
+false
+```
+
+#### compress?
+
+> `optional` **compress**: [`BlobStorageCompressionType`](../type-aliases/BlobStorageCompressionType.md)
+
+Optional compression type to use for the blob, defaults to no compression.
+
+#### overrideVaultKeyId?
+
+> `optional` **overrideVaultKeyId**: `string`
+
+Use a different vault key id for encryption, if not provided the default vault key id will be used.
+
+##### Default
+
+```ts
+undefined
+```
+
 #### namespace?
 
 > `optional` **namespace**: `string`

package/docs/reference/interfaces/IBlobStorageEntry.md

@@ -0,0 +1,107 @@
+# Interface: IBlobStorageEntry
+
+Interface describing a blob storage entry.
+
+## Properties
+
+### @context
+
+> **@context**: \[`"https://schema.twindev.org/blob-storage/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"BlobStorageEntry"`
+
+JSON-LD Type.
+
+***
+
+### id
+
+> **id**: `string`
+
+The id for the blob.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time when the entry was created.
+
+***
+
+### dateModified?
+
+> `optional` **dateModified**: `string`
+
+The date/time when the entry was modified.
+
+***
+
+### blobSize
+
+> **blobSize**: `number`
+
+The size of the data in the blob.
+
+***
+
+### blobHash
+
+> **blobHash**: `string`
+
+The hash of the data in the blob.
+
+***
+
+### encodingFormat?
+
+> `optional` **encodingFormat**: `string`
+
+The mime type for the blob.
+
+***
+
+### isEncrypted?
+
+> `optional` **isEncrypted**: `boolean`
+
+Indicates if the blob is encrypted.
+
+***
+
+### compression?
+
+> `optional` **compression**: [`BlobStorageCompressionType`](../type-aliases/BlobStorageCompressionType.md)
+
+The type of compression used for the blob, if not set it is not stored with compression.
+
+***
+
+### fileExtension?
+
+> `optional` **fileExtension**: `string`
+
+The extension.
+
+***
+
+### metadata?
+
+> `optional` **metadata**: `IJsonLdNodeObject`
+
+The metadata for the blob as JSON-LD.
+
+***
+
+### blob?
+
+> `optional` **blob**: `string`
+
+The blob in base64 format, included if the includeContent flag was set in the request.

package/docs/reference/interfaces/IBlobStorageEntryList.md

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

package/docs/reference/interfaces/IBlobStorageGetContentRequest.md

@@ -24,9 +24,33 @@ The id of the blob to get in urn format.
 
 The query parameters.
 
+#### decompress?
+
+> `optional` **decompress**: `string` \| `boolean`
+
+If the content should be decompressed, if it was compressed when stored, defaults to true.
+
+##### Default
+
+```ts
+true
+```
+
+#### overrideVaultKeyId?
+
+> `optional` **overrideVaultKeyId**: `string`
+
+Use a different vault key id for decryption, if not provided the default vault key id will be used.
+
+##### Default
+
+```ts
+undefined
+```
+
 #### download?
 
-> `optional` **download**: `boolean`
+> `optional` **download**: `string` \| `boolean`
 
 Set the download flag which should prompt the browser to save the file.
 Otherwise the browser should show the content inside the page.

package/docs/reference/interfaces/IBlobStorageGetRequest.md

@@ -4,6 +4,18 @@ Request to get an entry from blob storage.
 
 ## Properties
 
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
 ### pathParams
 
 > **pathParams**: `object`
@@ -26,7 +38,7 @@ The query parameters.
 
 #### includeContent?
 
-> `optional` **includeContent**: `boolean`
+> `optional` **includeContent**: `string` \| `boolean`
 
 Include the content in the response, otherwise only metadata is returned.
 
@@ -35,3 +47,27 @@ Include the content in the response, otherwise only metadata is returned.
 ```ts
 false
 ```
+
+#### decompress?
+
+> `optional` **decompress**: `string` \| `boolean`
+
+If the content should be decompressed, if it was compressed when stored, defaults to true.
+
+##### Default
+
+```ts
+true
+```
+
+#### overrideVaultKeyId?
+
+> `optional` **overrideVaultKeyId**: `string`
+
+Use a different vault key id for decryption, if not provided the default vault key id will be used.
+
+##### Default
+
+```ts
+undefined
+```

package/docs/reference/interfaces/IBlobStorageGetResponse.md

@@ -4,32 +4,20 @@ Response to get an entry from blob storage.
 
 ## Properties
 
-### body
-
-> **body**: `object`
-
-The body parameters.
-
-#### mimeType?
+### headers?
 
-> `optional` **mimeType**: `string`
+> `optional` **headers**: `object`
 
-The mime type of the blob.
+The headers which can be used to determine the response data type.
 
-#### extension?
+#### content-type
 
-> `optional` **extension**: `string`
+> **content-type**: `"application/json"` \| `"application/ld+json"`
 
-The extension of the blob.
+***
 
-#### metadata?
-
-> `optional` **metadata**: `IJsonLdNodeObject`
-
-Custom metadata to associate with the blob as JSON-LD.
-
-#### blob?
+### body
 
-> `optional` **blob**: `string`
+> **body**: [`IBlobStorageEntry`](IBlobStorageEntry.md)
 
-The blob in base64 format, if the includeContent flag was set in the request.
+The body parameters.

package/docs/reference/interfaces/IBlobStorageListRequest.md

@@ -0,0 +1,53 @@
+# Interface: IBlobStorageListRequest
+
+Query the entries from blob storage.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The parameters from the query.
+
+#### conditions?
+
+> `optional` **conditions**: `string`
+
+The condition for the query as JSON version of EntityCondition type.
+
+#### orderBy?
+
+> `optional` **orderBy**: `"dateCreated"` \| `"dateModified"`
+
+The order for the results, default to created.
+
+#### orderByDirection?
+
+> `optional` **orderByDirection**: `SortDirection`
+
+The direction for the order, defaults to desc.
+
+#### pageSize?
+
+> `optional` **pageSize**: `string` \| `number`
+
+The number of entries to return per page.
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor to get next chunk of data, returned in previous response.

package/docs/reference/interfaces/IBlobStorageListResponse.md

@@ -0,0 +1,23 @@
+# Interface: IBlobStorageListResponse
+
+Response to getting the list of entries from a query.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body
+
+> **body**: [`IBlobStorageEntryList`](IBlobStorageEntryList.md)
+
+The list of entries from the query.

package/docs/reference/interfaces/IBlobStorageUpdateRequest.md

@@ -24,15 +24,15 @@ The id of the blob to get in urn format.
 
 The body parameters.
 
-#### mimeType?
+#### encodingFormat?
 
-> `optional` **mimeType**: `string`
+> `optional` **encodingFormat**: `string`
 
 The mime type of the blob, will be detected if left undefined.
 
-#### extension?
+#### fileExtension?
 
-> `optional` **extension**: `string`
+> `optional` **fileExtension**: `string`
 
 The extension of the blob, will be detected if left undefined.
 

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

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

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/type-aliases/BlobStorageTypes.md

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

package/docs/reference/variables/BlobStorageCompressionType.md

@@ -0,0 +1,19 @@
+# Variable: BlobStorageCompressionType
+
+> `const` **BlobStorageCompressionType**: `object`
+
+The types of compression for blob storage data.
+
+## Type declaration
+
+### Gzip
+
+> `readonly` **Gzip**: `"gzip"` = `"gzip"`
+
+Gzip.
+
+### Deflate
+
+> `readonly` **Deflate**: `"deflate"` = `"deflate"`
+
+Deflate.

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

@@ -0,0 +1,19 @@
+# Variable: BlobStorageTypes
+
+> `const` **BlobStorageTypes**: `object`
+
+The types of blob storage data.
+
+## Type declaration
+
+### Entry
+
+> `readonly` **Entry**: `"BlobStorageEntry"` = `"BlobStorageEntry"`
+
+Represents blob storage entry.
+
+### CompressionType
+
+> `readonly` **CompressionType**: `"BlobStorageCompressionType"` = `"BlobStorageCompressionType"`
+
+Represents blob storage entry compression.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-models",
-	"version": "0.0.1-next.9",
+	"version": "0.0.2-next.1",
 	"description": "Models which define the structure of the blob storage contracts and connectors",
 	"repository": {
 		"type": "git",
@@ -15,19 +15,23 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
+		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/nameof": "next"
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-schema-org": "next",
+		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",