@twin.org/blob-storage-service 0.0.1-next.3 → 0.0.1-next.30

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.
Files changed (27) hide show
  1. package/dist/cjs/index.cjs +563 -101
  2. package/dist/esm/index.mjs +565 -104
  3. package/dist/types/blobStorageRoutes.d.ts +17 -3
  4. package/dist/types/blobStorageService.d.ts +37 -29
  5. package/dist/types/entities/blobStorageEntry.d.ts +46 -0
  6. package/dist/types/index.d.ts +2 -1
  7. package/dist/types/models/IBlobStorageServiceConfig.d.ts +8 -0
  8. package/dist/types/models/IBlobStorageServiceConstructorOptions.d.ts +19 -0
  9. package/dist/types/restEntryPoints.d.ts +5 -0
  10. package/docs/changelog.md +33 -1
  11. package/docs/open-api/spec.json +2241 -1906
  12. package/docs/reference/classes/BlobStorageEntry.md +93 -0
  13. package/docs/reference/classes/BlobStorageService.md +154 -53
  14. package/docs/reference/functions/blobStorageCreate.md +9 -3
  15. package/docs/reference/functions/blobStorageGet.md +9 -3
  16. package/docs/reference/functions/blobStorageGetContent.md +9 -3
  17. package/docs/reference/functions/blobStorageList.md +31 -0
  18. package/docs/reference/functions/blobStorageRemove.md +9 -3
  19. package/docs/reference/functions/blobStorageUpdate.md +9 -3
  20. package/docs/reference/functions/generateRestRoutesBlobStorage.md +24 -4
  21. package/docs/reference/index.md +3 -1
  22. package/docs/reference/interfaces/IBlobStorageServiceConfig.md +16 -0
  23. package/docs/reference/interfaces/IBlobStorageServiceConstructorOptions.md +33 -0
  24. package/docs/reference/variables/restEntryPoints.md +4 -0
  25. package/package.json +7 -33
  26. package/dist/types/entities/blobMetadata.d.ts +0 -22
  27. package/docs/reference/classes/BlobMetadata.md +0 -45
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/blob-storage-service",
3
- "version": "0.0.1-next.3",
3
+ "version": "0.0.1-next.30",
4
4
  "description": "Blob storage contract implementation and REST endpoint definitions",
5
5
  "repository": {
6
6
  "type": "git",
@@ -13,55 +13,29 @@
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:api": "ts-to-openapi ./ts-to-openapi.json ./docs/open-api/spec.json",
27
- "docs": "npm run docs:clean && npm run docs:generate && npm run docs:api",
28
- "dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
29
- },
30
16
  "dependencies": {
31
17
  "@twin.org/api-models": "next",
32
- "@twin.org/blob-storage-models": "0.0.1-next.3",
18
+ "@twin.org/blob-storage-models": "0.0.1-next.30",
33
19
  "@twin.org/core": "next",
20
+ "@twin.org/crypto": "next",
34
21
  "@twin.org/data-json-ld": "next",
35
22
  "@twin.org/entity": "next",
36
23
  "@twin.org/entity-storage-models": "next",
37
24
  "@twin.org/nameof": "next",
25
+ "@twin.org/standards-schema-org": "next",
38
26
  "@twin.org/vault-models": "next",
39
27
  "@twin.org/web": "next"
40
28
  },
41
- "devDependencies": {
42
- "@twin.org/nameof-transformer": "next",
43
- "@twin.org/ts-to-openapi": "next",
44
- "@vitest/coverage-v8": "2.1.1",
45
- "copyfiles": "2.4.1",
46
- "rimraf": "6.0.1",
47
- "rollup": "4.22.0",
48
- "rollup-plugin-typescript2": "0.36.0",
49
- "ts-patch": "3.2.1",
50
- "typedoc": "0.26.7",
51
- "typedoc-plugin-markdown": "4.2.7",
52
- "typescript": "5.6.2",
53
- "vitest": "2.1.1"
54
- },
55
29
  "main": "./dist/cjs/index.cjs",
56
30
  "module": "./dist/esm/index.mjs",
57
31
  "types": "./dist/types/index.d.ts",
58
32
  "exports": {
59
33
  ".": {
34
+ "types": "./dist/types/index.d.ts",
60
35
  "require": "./dist/cjs/index.cjs",
61
- "import": "./dist/esm/index.mjs",
62
- "types": "./dist/types/index.d.ts"
36
+ "import": "./dist/esm/index.mjs"
63
37
  },
64
- "./locales": "./locales"
38
+ "./locales/*.json": "./locales/*.json"
65
39
  },
66
40
  "files": [
67
41
  "dist/cjs",
package/dist/types/entities/blobMetadata.d.ts DELETED
@@ -1,22 +0,0 @@
1
- import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
2
- /**
3
- * Class representing metadata for the blob storage.
4
- */
5
- export declare class BlobMetadata {
6
- /**
7
- * The id for the blob.
8
- */
9
- id: string;
10
- /**
11
- * The mime type for the blob.
12
- */
13
- mimeType?: string;
14
- /**
15
- * The extension.
16
- */
17
- extension?: string;
18
- /**
19
- * The metadata for the blob as JSON-LD.
20
- */
21
- metadata?: IJsonLdNodeObject;
22
- }
package/docs/reference/classes/BlobMetadata.md DELETED
@@ -1,45 +0,0 @@
1
- # Class: BlobMetadata
2
-
3
- Class representing metadata for the blob storage.
4
-
5
- ## Constructors
6
-
7
- ### new BlobMetadata()
8
-
9
- > **new BlobMetadata**(): [`BlobMetadata`](BlobMetadata.md)
10
-
11
- #### Returns
12
-
13
- [`BlobMetadata`](BlobMetadata.md)
14
-
15
- ## Properties
16
-
17
- ### id
18
-
19
- > **id**: `string`
20
-
21
- The id for the blob.
22
-
23
- ***
24
-
25
- ### mimeType?
26
-
27
- > `optional` **mimeType**: `string`
28
-
29
- The mime type for the blob.
30
-
31
- ***
32
-
33
- ### extension?
34
-
35
- > `optional` **extension**: `string`
36
-
37
- The extension.
38
-
39
- ***
40
-
41
- ### metadata?
42
-
43
- > `optional` **metadata**: `IJsonLdNodeObject`
44
-
45
- The metadata for the blob as JSON-LD.