@twin.org/blob-storage-service 0.0.1-next.30 → 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.
Files changed (5) hide show
  1. package/dist/cjs/index.cjs +11 -9
  2. package/dist/esm/index.mjs +12 -10
  3. package/docs/changelog.md +16 -0
  4. package/docs/open-api/spec.json +15 -9
  5. package/package.json +2 -2
package/dist/cjs/index.cjs CHANGED
@@ -301,11 +301,12 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName, options) {
301
301
  response: {
302
302
  body: {
303
303
  "@context": [
304
+ standardsSchemaOrg.SchemaOrgContexts.ContextRoot,
304
305
  blobStorageModels.BlobStorageContexts.ContextRoot,
305
306
  blobStorageModels.BlobStorageContexts.ContextRootCommon
306
307
  ],
307
- type: blobStorageModels.BlobStorageTypes.EntryList,
308
- entries: [
308
+ type: standardsSchemaOrg.SchemaOrgTypes.ItemList,
309
+ [standardsSchemaOrg.SchemaOrgTypes.ItemListElement]: [
309
310
  {
310
311
  "@context": [
311
312
  blobStorageModels.BlobStorageContexts.ContextRoot,
@@ -341,11 +342,12 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName, options) {
341
342
  response: {
342
343
  body: {
343
344
  "@context": [
345
+ standardsSchemaOrg.SchemaOrgContexts.ContextRoot,
344
346
  blobStorageModels.BlobStorageContexts.ContextRoot,
345
347
  blobStorageModels.BlobStorageContexts.ContextRootCommon
346
348
  ],
347
- type: blobStorageModels.BlobStorageTypes.EntryList,
348
- entries: [
349
+ type: standardsSchemaOrg.SchemaOrgTypes.ItemList,
350
+ [standardsSchemaOrg.SchemaOrgTypes.ItemListElement]: [
349
351
  {
350
352
  "@context": [
351
353
  blobStorageModels.BlobStorageContexts.ContextRoot,
@@ -831,9 +833,9 @@ class BlobStorageService {
831
833
  core.ObjectHelper.propertyDelete(entity, "userIdentity");
832
834
  }
833
835
  let context = [
836
+ standardsSchemaOrg.SchemaOrgContexts.ContextRoot,
834
837
  blobStorageModels.BlobStorageContexts.ContextRoot,
835
- blobStorageModels.BlobStorageContexts.ContextRootCommon,
836
- standardsSchemaOrg.SchemaOrgContexts.ContextRoot
838
+ blobStorageModels.BlobStorageContexts.ContextRootCommon
837
839
  ];
838
840
  const entriesJsonLd = [];
839
841
  for (const entry of result.entities) {
@@ -843,9 +845,9 @@ class BlobStorageService {
843
845
  }
844
846
  const jsonLd = {
845
847
  "@context": context,
846
- type: blobStorageModels.BlobStorageTypes.EntryList,
847
- entries: entriesJsonLd,
848
- cursor: result.cursor
848
+ type: standardsSchemaOrg.SchemaOrgTypes.ItemList,
849
+ [standardsSchemaOrg.SchemaOrgTypes.ItemListElement]: entriesJsonLd,
850
+ [standardsSchemaOrg.SchemaOrgTypes.NextItem]: result.cursor
849
851
  };
850
852
  return dataJsonLd.JsonLdProcessor.compact(jsonLd, jsonLd["@context"]);
851
853
  }
package/dist/esm/index.mjs CHANGED
@@ -1,7 +1,7 @@
1
1
  import { HttpParameterHelper } from '@twin.org/api-models';
2
2
  import { BlobStorageTypes, BlobStorageContexts, BlobStorageConnectorFactory } from '@twin.org/blob-storage-models';
3
3
  import { StringHelper, Guards, ComponentFactory, Is, Converter, Coerce, GeneralError, Validation, ObjectHelper, Urn, NotFoundError } from '@twin.org/core';
4
- import { SchemaOrgContexts, SchemaOrgDataTypes } from '@twin.org/standards-schema-org';
4
+ import { SchemaOrgContexts, SchemaOrgTypes, SchemaOrgDataTypes } from '@twin.org/standards-schema-org';
5
5
  import { HttpStatusCode, HeaderTypes, MimeTypes, MimeTypeHelper } from '@twin.org/web';
6
6
  import { Sha256 } from '@twin.org/crypto';
7
7
  import { JsonLdHelper, JsonLdProcessor } from '@twin.org/data-json-ld';
@@ -299,11 +299,12 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName, options) {
299
299
  response: {
300
300
  body: {
301
301
  "@context": [
302
+ SchemaOrgContexts.ContextRoot,
302
303
  BlobStorageContexts.ContextRoot,
303
304
  BlobStorageContexts.ContextRootCommon
304
305
  ],
305
- type: BlobStorageTypes.EntryList,
306
- entries: [
306
+ type: SchemaOrgTypes.ItemList,
307
+ [SchemaOrgTypes.ItemListElement]: [
307
308
  {
308
309
  "@context": [
309
310
  BlobStorageContexts.ContextRoot,
@@ -339,11 +340,12 @@ function generateRestRoutesBlobStorage(baseRouteName, componentName, options) {
339
340
  response: {
340
341
  body: {
341
342
  "@context": [
343
+ SchemaOrgContexts.ContextRoot,
342
344
  BlobStorageContexts.ContextRoot,
343
345
  BlobStorageContexts.ContextRootCommon
344
346
  ],
345
- type: BlobStorageTypes.EntryList,
346
- entries: [
347
+ type: SchemaOrgTypes.ItemList,
348
+ [SchemaOrgTypes.ItemListElement]: [
347
349
  {
348
350
  "@context": [
349
351
  BlobStorageContexts.ContextRoot,
@@ -829,9 +831,9 @@ class BlobStorageService {
829
831
  ObjectHelper.propertyDelete(entity, "userIdentity");
830
832
  }
831
833
  let context = [
834
+ SchemaOrgContexts.ContextRoot,
832
835
  BlobStorageContexts.ContextRoot,
833
- BlobStorageContexts.ContextRootCommon,
834
- SchemaOrgContexts.ContextRoot
836
+ BlobStorageContexts.ContextRootCommon
835
837
  ];
836
838
  const entriesJsonLd = [];
837
839
  for (const entry of result.entities) {
@@ -841,9 +843,9 @@ class BlobStorageService {
841
843
  }
842
844
  const jsonLd = {
843
845
  "@context": context,
844
- type: BlobStorageTypes.EntryList,
845
- entries: entriesJsonLd,
846
- cursor: result.cursor
846
+ type: SchemaOrgTypes.ItemList,
847
+ [SchemaOrgTypes.ItemListElement]: entriesJsonLd,
848
+ [SchemaOrgTypes.NextItem]: result.cursor
847
849
  };
848
850
  return JsonLdProcessor.compact(jsonLd, jsonLd["@context"]);
849
851
  }
package/docs/changelog.md CHANGED
@@ -1,5 +1,21 @@
1
1
  # @twin.org/blob-storage-service - Changelog
2
2
 
3
+ ## [0.0.1-next.31](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.30...blob-storage-service-v0.0.1-next.31) (2025-05-08)
4
+
5
+
6
+ ### Features
7
+
8
+ * use standard list json ld types ([d6bdfd6](https://github.com/twinfoundation/blob-storage/commit/d6bdfd68af47f70f3cc53658b4a12543497e1f48))
9
+
10
+
11
+ ### Dependencies
12
+
13
+ * The following workspace dependencies were updated
14
+ * dependencies
15
+ * @twin.org/blob-storage-models bumped from 0.0.1-next.30 to 0.0.1-next.31
16
+ * devDependencies
17
+ * @twin.org/blob-storage-connector-memory bumped from 0.0.1-next.30 to 0.0.1-next.31
18
+
3
19
  ## [0.0.1-next.30](https://github.com/twinfoundation/blob-storage/compare/blob-storage-service-v0.0.1-next.29...blob-storage-service-v0.0.1-next.30) (2025-04-17)
4
20
 
5
21
 
package/docs/open-api/spec.json CHANGED
@@ -210,11 +210,12 @@
210
210
  "blobStorageListResponseExample": {
211
211
  "value": {
212
212
  "@context": [
213
+ "https://schema.org",
213
214
  "https://schema.twindev.org/blob-storage/",
214
215
  "https://schema.twindev.org/common/"
215
216
  ],
216
- "type": "BlobStorageEntryList",
217
- "entries": [
217
+ "type": "ItemList",
218
+ "itemListElement": [
218
219
  {
219
220
  "@context": [
220
221
  "https://schema.twindev.org/blob-storage/",
@@ -248,11 +249,12 @@
248
249
  "blobStorageListResponseJsonLdExample": {
249
250
  "value": {
250
251
  "@context": [
252
+ "https://schema.org",
251
253
  "https://schema.twindev.org/blob-storage/",
252
254
  "https://schema.twindev.org/common/"
253
255
  ],
254
- "type": "BlobStorageEntryList",
255
- "entries": [
256
+ "type": "ItemList",
257
+ "itemListElement": [
256
258
  {
257
259
  "@context": [
258
260
  "https://schema.twindev.org/blob-storage/",
@@ -1013,8 +1015,12 @@
1013
1015
  "properties": {
1014
1016
  "@context": {
1015
1017
  "type": "array",
1016
- "minItems": 2,
1018
+ "minItems": 3,
1017
1019
  "items": [
1020
+ {
1021
+ "type": "string",
1022
+ "const": "https://schema.org"
1023
+ },
1018
1024
  {
1019
1025
  "type": "string",
1020
1026
  "const": "https://schema.twindev.org/blob-storage/"
@@ -1031,17 +1037,17 @@
1031
1037
  },
1032
1038
  "type": {
1033
1039
  "type": "string",
1034
- "const": "BlobStorageEntryList",
1040
+ "const": "ItemList",
1035
1041
  "description": "JSON-LD Type."
1036
1042
  },
1037
- "entries": {
1043
+ "itemListElement": {
1038
1044
  "type": "array",
1039
1045
  "items": {
1040
1046
  "$ref": "#/components/schemas/BlobStorageEntry"
1041
1047
  },
1042
1048
  "description": "The list of entries."
1043
1049
  },
1044
- "cursor": {
1050
+ "nextItem": {
1045
1051
  "type": "string",
1046
1052
  "description": "The cursor to get the next chunk of entries."
1047
1053
  }
@@ -1049,7 +1055,7 @@
1049
1055
  "required": [
1050
1056
  "@context",
1051
1057
  "type",
1052
- "entries"
1058
+ "itemListElement"
1053
1059
  ],
1054
1060
  "additionalProperties": false,
1055
1061
  "description": "Interface describing an blob storage entry list."
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/blob-storage-service",
3
- "version": "0.0.1-next.30",
3
+ "version": "0.0.1-next.31",
4
4
  "description": "Blob storage contract implementation and REST endpoint definitions",
5
5
  "repository": {
6
6
  "type": "git",
@@ -15,7 +15,7 @@
15
15
  },
16
16
  "dependencies": {
17
17
  "@twin.org/api-models": "next",
18
- "@twin.org/blob-storage-models": "0.0.1-next.30",
18
+ "@twin.org/blob-storage-models": "0.0.1-next.31",
19
19
  "@twin.org/core": "next",
20
20
  "@twin.org/crypto": "next",
21
21
  "@twin.org/data-json-ld": "next",