@twin.org/blob-storage-models 0.0.1-next.3 → 0.0.1-next.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/index.cjs +132 -0
- package/dist/esm/index.mjs +130 -1
- package/dist/types/dataTypes/blobStorageDataTypes.d.ts +9 -0
- package/dist/types/index.d.ts +7 -0
- package/dist/types/models/IBlobStorageComponent.d.ts +32 -15
- package/dist/types/models/IBlobStorageEntry.d.ts +56 -0
- package/dist/types/models/IBlobStorageEntryList.d.ts +30 -0
- package/dist/types/models/api/IBlobStorageCreateRequest.d.ts +2 -2
- package/dist/types/models/api/IBlobStorageGetRequest.d.ts +7 -0
- package/dist/types/models/api/IBlobStorageGetResponse.d.ts +9 -19
- package/dist/types/models/api/IBlobStorageListRequest.d.ts +39 -0
- package/dist/types/models/api/IBlobStorageListResponse.d.ts +17 -0
- package/dist/types/models/api/IBlobStorageUpdateRequest.d.ts +2 -2
- package/dist/types/models/blobStorageContexts.d.ts +17 -0
- package/dist/types/models/blobStorageTypes.d.ts +13 -0
- package/docs/changelog.md +22 -1
- package/docs/reference/classes/BlobStorageDataTypes.md +25 -0
- package/docs/reference/index.md +15 -0
- package/docs/reference/interfaces/IBlobStorageComponent.md +142 -35
- package/docs/reference/interfaces/IBlobStorageConnector.md +11 -5
- package/docs/reference/interfaces/IBlobStorageCreateRequest.md +4 -4
- package/docs/reference/interfaces/IBlobStorageEntry.md +91 -0
- package/docs/reference/interfaces/IBlobStorageEntryList.md +35 -0
- package/docs/reference/interfaces/IBlobStorageGetRequest.md +12 -0
- package/docs/reference/interfaces/IBlobStorageGetResponse.md +9 -21
- package/docs/reference/interfaces/IBlobStorageListRequest.md +53 -0
- package/docs/reference/interfaces/IBlobStorageListResponse.md +23 -0
- package/docs/reference/interfaces/IBlobStorageUpdateRequest.md +4 -4
- package/docs/reference/type-aliases/BlobStorageContexts.md +5 -0
- package/docs/reference/type-aliases/BlobStorageTypes.md +5 -0
- package/docs/reference/variables/BlobStorageContexts.md +19 -0
- package/docs/reference/variables/BlobStorageTypes.md +13 -0
- package/package.json +9 -31
|
@@ -24,15 +24,15 @@ The id of the blob to get in urn format.
|
|
|
24
24
|
|
|
25
25
|
The body parameters.
|
|
26
26
|
|
|
27
|
-
####
|
|
27
|
+
#### encodingFormat?
|
|
28
28
|
|
|
29
|
-
> `optional` **
|
|
29
|
+
> `optional` **encodingFormat**: `string`
|
|
30
30
|
|
|
31
31
|
The mime type of the blob, will be detected if left undefined.
|
|
32
32
|
|
|
33
|
-
####
|
|
33
|
+
#### fileExtension?
|
|
34
34
|
|
|
35
|
-
> `optional` **
|
|
35
|
+
> `optional` **fileExtension**: `string`
|
|
36
36
|
|
|
37
37
|
The extension of the blob, will be detected if left undefined.
|
|
38
38
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Variable: BlobStorageContexts
|
|
2
|
+
|
|
3
|
+
> `const` **BlobStorageContexts**: `object`
|
|
4
|
+
|
|
5
|
+
The contexts of blob storage data.
|
|
6
|
+
|
|
7
|
+
## Type declaration
|
|
8
|
+
|
|
9
|
+
### ContextRoot
|
|
10
|
+
|
|
11
|
+
> `readonly` **ContextRoot**: `"https://schema.twindev.org/blob-storage/"` = `"https://schema.twindev.org/blob-storage/"`
|
|
12
|
+
|
|
13
|
+
The context root for the blob storage types.
|
|
14
|
+
|
|
15
|
+
### ContextRootCommon
|
|
16
|
+
|
|
17
|
+
> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
|
|
18
|
+
|
|
19
|
+
The context root for the common types.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Variable: BlobStorageTypes
|
|
2
|
+
|
|
3
|
+
> `const` **BlobStorageTypes**: `object`
|
|
4
|
+
|
|
5
|
+
The types of blob storage data.
|
|
6
|
+
|
|
7
|
+
## Type declaration
|
|
8
|
+
|
|
9
|
+
### Entry
|
|
10
|
+
|
|
11
|
+
> `readonly` **Entry**: `"BlobStorageEntry"` = `"BlobStorageEntry"`
|
|
12
|
+
|
|
13
|
+
Represents blob storage entry.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/blob-storage-models",
|
|
3
|
-
"version": "0.0.1-next.
|
|
3
|
+
"version": "0.0.1-next.31",
|
|
4
4
|
"description": "Models which define the structure of the blob storage contracts and connectors",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -13,47 +13,25 @@
|
|
|
13
13
|
"engines": {
|
|
14
14
|
"node": ">=20.0.0"
|
|
15
15
|
},
|
|
16
|
-
"scripts": {
|
|
17
|
-
"clean": "rimraf dist coverage docs/reference",
|
|
18
|
-
"build": "tspc",
|
|
19
|
-
"test": "vitest --run --config ./vitest.config.ts --no-cache",
|
|
20
|
-
"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
|
|
21
|
-
"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
|
|
22
|
-
"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
|
|
23
|
-
"bundle": "npm run bundle:esm && npm run bundle:cjs",
|
|
24
|
-
"docs:clean": "rimraf docs/reference",
|
|
25
|
-
"docs:generate": "typedoc",
|
|
26
|
-
"docs": "npm run docs:clean && npm run docs:generate",
|
|
27
|
-
"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
|
|
28
|
-
},
|
|
29
16
|
"dependencies": {
|
|
30
17
|
"@twin.org/core": "next",
|
|
18
|
+
"@twin.org/data-core": "next",
|
|
19
|
+
"@twin.org/data-json-ld": "next",
|
|
20
|
+
"@twin.org/entity": "next",
|
|
31
21
|
"@twin.org/nameof": "next",
|
|
32
|
-
"@twin.org/
|
|
33
|
-
|
|
34
|
-
"devDependencies": {
|
|
35
|
-
"@twin.org/nameof-transformer": "next",
|
|
36
|
-
"@vitest/coverage-v8": "2.1.1",
|
|
37
|
-
"copyfiles": "2.4.1",
|
|
38
|
-
"rimraf": "6.0.1",
|
|
39
|
-
"rollup": "4.22.0",
|
|
40
|
-
"rollup-plugin-typescript2": "0.36.0",
|
|
41
|
-
"ts-patch": "3.2.1",
|
|
42
|
-
"typedoc": "0.26.7",
|
|
43
|
-
"typedoc-plugin-markdown": "4.2.7",
|
|
44
|
-
"typescript": "5.6.2",
|
|
45
|
-
"vitest": "2.1.1"
|
|
22
|
+
"@twin.org/standards-schema-org": "next",
|
|
23
|
+
"@twin.org/web": "next"
|
|
46
24
|
},
|
|
47
25
|
"main": "./dist/cjs/index.cjs",
|
|
48
26
|
"module": "./dist/esm/index.mjs",
|
|
49
27
|
"types": "./dist/types/index.d.ts",
|
|
50
28
|
"exports": {
|
|
51
29
|
".": {
|
|
30
|
+
"types": "./dist/types/index.d.ts",
|
|
52
31
|
"require": "./dist/cjs/index.cjs",
|
|
53
|
-
"import": "./dist/esm/index.mjs"
|
|
54
|
-
"types": "./dist/types/index.d.ts"
|
|
32
|
+
"import": "./dist/esm/index.mjs"
|
|
55
33
|
},
|
|
56
|
-
"./locales": "./locales"
|
|
34
|
+
"./locales/*.json": "./locales/*.json"
|
|
57
35
|
},
|
|
58
36
|
"files": [
|
|
59
37
|
"dist/cjs",
|