@twin.org/blob-storage-service 0.0.1-next.13 → 0.0.1-next.15

package/dist/cjs/index.cjs

@@ -371,7 +371,7 @@ async function blobStorageCreate(httpRequestContext, componentName, request) {
     core.Guards.object(ROUTES_SOURCE, "request.body", request.body);
     core.Guards.stringBase64(ROUTES_SOURCE, "request.body.blob", request.body.blob);
     const component = core.ComponentFactory.get(componentName);
-    const id = await component.create(request.body.blob, request.body.encodingFormat, request.body.fileExtension, request.body.metadata, request.body.namespace, httpRequestContext.nodeIdentity);
+    const id = await component.create(request.body.blob, request.body.encodingFormat, request.body.fileExtension, request.body.metadata, request.body.namespace, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         statusCode: web.HttpStatusCode.created,
         headers: {
@@ -472,7 +472,7 @@ async function blobStorageList(httpRequestContext, componentName, request) {
     core.Guards.object(ROUTES_SOURCE, "request", request);
     const mimeType = request.headers?.[web.HeaderTypes.Accept] === web.MimeTypes.JsonLd ? "jsonld" : "json";
     const component = core.ComponentFactory.get(componentName);
-    const result = await component.query(apiModels.HttpParameterHelper.objectFromString(request.query?.conditions), apiModels.HttpParameterHelper.objectFromString(request.query?.sortProperties), request.query?.cursor, core.Coerce.number(request.query?.pageSize), httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    const result = await component.query(apiModels.HttpParameterHelper.objectFromString(request.query?.conditions), request.query?.orderBy, request.query?.orderByDirection, request.query?.cursor, core.Coerce.number(request.query?.pageSize), httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         headers: {
             [web.HeaderTypes.ContentType]: mimeType === "json" ? web.MimeTypes.Json : web.MimeTypes.JsonLd
@@ -759,7 +759,8 @@ class BlobStorageService {
     /**
      * Query all the blob storage entries which match the conditions.
      * @param conditions The conditions to match for the entries.
-     * @param sortProperties The optional sort order.
+     * @param orderBy The order for the results, defaults to created.
+     * @param orderByDirection The direction for the order, defaults to descending.
      * @param cursor The cursor to request the next page of entries.
      * @param pageSize The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
      * @param userIdentity The user identity to use with storage operations.
@@ -767,7 +768,7 @@ class BlobStorageService {
      * @returns All the entries for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(conditions, sortProperties, cursor, pageSize, userIdentity, nodeIdentity) {
+    async query(conditions, orderBy, orderByDirection, cursor, pageSize, userIdentity, nodeIdentity) {
         const finalConditions = {
             conditions: [],
             logicalOperator: entity.LogicalOperator.And
@@ -791,7 +792,14 @@ class BlobStorageService {
         if (!core.Is.empty(conditions)) {
             finalConditions.conditions.push(conditions);
         }
-        const result = await this._entryEntityStorage.query(finalConditions.conditions.length > 0 ? finalConditions : undefined, sortProperties, undefined, cursor, pageSize);
+        const orderProperty = orderBy ?? "dateCreated";
+        const orderDirection = orderByDirection ?? entity.SortDirection.Descending;
+        const result = await this._entryEntityStorage.query(finalConditions.conditions.length > 0 ? finalConditions : undefined, [
+            {
+                property: orderProperty,
+                sortDirection: orderDirection
+            }
+        ], undefined, cursor, pageSize);
         for (const entity of result.entities) {
             core.ObjectHelper.propertyDelete(entity, "nodeIdentity");
             core.ObjectHelper.propertyDelete(entity, "userIdentity");
@@ -943,11 +951,11 @@ __decorate([
     __metadata("design:type", String)
 ], exports.BlobStorageEntry.prototype, "id", void 0);
 __decorate([
-    entity.property({ type: "string", format: "date-time", sortDirection: "desc" }),
+    entity.property({ type: "string", format: "date-time", sortDirection: entity.SortDirection.Descending }),
     __metadata("design:type", String)
 ], exports.BlobStorageEntry.prototype, "dateCreated", void 0);
 __decorate([
-    entity.property({ type: "string", format: "date-time", sortDirection: "desc" }),
+    entity.property({ type: "string", format: "date-time", sortDirection: entity.SortDirection.Descending }),
     __metadata("design:type", String)
 ], exports.BlobStorageEntry.prototype, "dateModified", void 0);
 __decorate([

package/dist/esm/index.mjs

@@ -4,7 +4,7 @@ import { StringHelper, Guards, ComponentFactory, Is, Converter, Coerce, GeneralE
 import { SchemaOrgTypes, SchemaOrgDataTypes } from '@twin.org/data-schema-org';
 import { HttpStatusCode, HeaderTypes, MimeTypes, MimeTypeHelper } from '@twin.org/web';
 import { JsonLdHelper, JsonLdProcessor } from '@twin.org/data-json-ld';
-import { ComparisonOperator, LogicalOperator, EntitySchemaHelper, property, entity, EntitySchemaFactory } from '@twin.org/entity';
+import { ComparisonOperator, LogicalOperator, SortDirection, EntitySchemaHelper, property, entity, EntitySchemaFactory } from '@twin.org/entity';
 import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
 import { VaultConnectorFactory, VaultEncryptionType } from '@twin.org/vault-models';
 
@@ -369,7 +369,7 @@ async function blobStorageCreate(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request.body", request.body);
     Guards.stringBase64(ROUTES_SOURCE, "request.body.blob", request.body.blob);
     const component = ComponentFactory.get(componentName);
-    const id = await component.create(request.body.blob, request.body.encodingFormat, request.body.fileExtension, request.body.metadata, request.body.namespace, httpRequestContext.nodeIdentity);
+    const id = await component.create(request.body.blob, request.body.encodingFormat, request.body.fileExtension, request.body.metadata, request.body.namespace, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         statusCode: HttpStatusCode.created,
         headers: {
@@ -470,7 +470,7 @@ async function blobStorageList(httpRequestContext, componentName, request) {
     Guards.object(ROUTES_SOURCE, "request", request);
     const mimeType = request.headers?.[HeaderTypes.Accept] === MimeTypes.JsonLd ? "jsonld" : "json";
     const component = ComponentFactory.get(componentName);
-    const result = await component.query(HttpParameterHelper.objectFromString(request.query?.conditions), HttpParameterHelper.objectFromString(request.query?.sortProperties), request.query?.cursor, Coerce.number(request.query?.pageSize), httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    const result = await component.query(HttpParameterHelper.objectFromString(request.query?.conditions), request.query?.orderBy, request.query?.orderByDirection, request.query?.cursor, Coerce.number(request.query?.pageSize), httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         headers: {
             [HeaderTypes.ContentType]: mimeType === "json" ? MimeTypes.Json : MimeTypes.JsonLd
@@ -757,7 +757,8 @@ class BlobStorageService {
     /**
      * Query all the blob storage entries which match the conditions.
      * @param conditions The conditions to match for the entries.
-     * @param sortProperties The optional sort order.
+     * @param orderBy The order for the results, defaults to created.
+     * @param orderByDirection The direction for the order, defaults to descending.
      * @param cursor The cursor to request the next page of entries.
      * @param pageSize The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
      * @param userIdentity The user identity to use with storage operations.
@@ -765,7 +766,7 @@ class BlobStorageService {
      * @returns All the entries for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    async query(conditions, sortProperties, cursor, pageSize, userIdentity, nodeIdentity) {
+    async query(conditions, orderBy, orderByDirection, cursor, pageSize, userIdentity, nodeIdentity) {
         const finalConditions = {
             conditions: [],
             logicalOperator: LogicalOperator.And
@@ -789,7 +790,14 @@ class BlobStorageService {
         if (!Is.empty(conditions)) {
             finalConditions.conditions.push(conditions);
         }
-        const result = await this._entryEntityStorage.query(finalConditions.conditions.length > 0 ? finalConditions : undefined, sortProperties, undefined, cursor, pageSize);
+        const orderProperty = orderBy ?? "dateCreated";
+        const orderDirection = orderByDirection ?? SortDirection.Descending;
+        const result = await this._entryEntityStorage.query(finalConditions.conditions.length > 0 ? finalConditions : undefined, [
+            {
+                property: orderProperty,
+                sortDirection: orderDirection
+            }
+        ], undefined, cursor, pageSize);
         for (const entity of result.entities) {
             ObjectHelper.propertyDelete(entity, "nodeIdentity");
             ObjectHelper.propertyDelete(entity, "userIdentity");
@@ -941,11 +949,11 @@ __decorate([
     __metadata("design:type", String)
 ], BlobStorageEntry.prototype, "id", void 0);
 __decorate([
-    property({ type: "string", format: "date-time", sortDirection: "desc" }),
+    property({ type: "string", format: "date-time", sortDirection: SortDirection.Descending }),
     __metadata("design:type", String)
 ], BlobStorageEntry.prototype, "dateCreated", void 0);
 __decorate([
-    property({ type: "string", format: "date-time", sortDirection: "desc" }),
+    property({ type: "string", format: "date-time", sortDirection: SortDirection.Descending }),
     __metadata("design:type", String)
 ], BlobStorageEntry.prototype, "dateModified", void 0);
 __decorate([

package/dist/types/blobStorageService.d.ts

@@ -1,6 +1,6 @@
 import { type IBlobStorageEntry, type IBlobStorageComponent, type IBlobStorageEntryList } from "@twin.org/blob-storage-models";
 import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import { type EntityCondition, type SortDirection } from "@twin.org/entity";
+import { type EntityCondition, SortDirection } from "@twin.org/entity";
 import type { IBlobStorageServiceConfig } from "./models/IBlobStorageServiceConfig";
 /**
  * Service for performing blob storage operations to a connector.
@@ -71,7 +71,8 @@ export declare class BlobStorageService implements IBlobStorageComponent {
     /**
      * Query all the blob storage entries which match the conditions.
      * @param conditions The conditions to match for the entries.
-     * @param sortProperties The optional sort order.
+     * @param orderBy The order for the results, defaults to created.
+     * @param orderByDirection The direction for the order, defaults to descending.
      * @param cursor The cursor to request the next page of entries.
      * @param pageSize The suggested number of entries to return in each chunk, in some scenarios can return a different amount.
      * @param userIdentity The user identity to use with storage operations.
@@ -79,8 +80,5 @@ export declare class BlobStorageService implements IBlobStorageComponent {
      * @returns All the entries for the storage matching the conditions,
      * and a cursor which can be used to request more entities.
      */
-    query(conditions?: EntityCondition<IBlobStorageEntry>, sortProperties?: {
-        property: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">;
-        sortDirection: SortDirection;
-    }[], cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntryList>;
+    query(conditions?: EntityCondition<IBlobStorageEntry>, orderBy?: keyof Pick<IBlobStorageEntry, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IBlobStorageEntryList>;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/blob-storage-service - Changelog
 
-## v0.0.1-next.13
+## v0.0.1-next.15
 
 - Initial Release

package/docs/open-api/spec.json

@@ -144,12 +144,25 @@
                         }
                     },
                     {
-                        "name": "sortProperties",
-                        "description": "The sort property array as JSON serialization of property,direction.",
+                        "name": "orderBy",
+                        "description": "The order for the results, default to created.",
                         "in": "query",
                         "required": false,
                         "schema": {
-                            "type": "string"
+                            "type": "string",
+                            "enum": [
+                                "dateCreated",
+                                "dateModified"
+                            ]
+                        }
+                    },
+                    {
+                        "name": "orderByDirection",
+                        "description": "The direction for the order, defaults to desc.",
+                        "in": "query",
+                        "required": false,
+                        "schema": {
+                            "$ref": "#/components/schemas/SortDirection"
                         }
                     },
                     {
@@ -2172,6 +2185,21 @@
                 ],
                 "description": "The body which contains the error."
             },
+            "SortDirection": {
+                "anyOf": [
+                    {
+                        "type": "string",
+                        "const": "asc",
+                        "description": "Ascending."
+                    },
+                    {
+                        "type": "string",
+                        "const": "desc",
+                        "description": "Descending."
+                    }
+                ],
+                "description": "The sort directions."
+            },
             "Uint8Array": {
                 "type": "object",
                 "properties": {

package/docs/reference/classes/BlobStorageService.md

@@ -228,7 +228,7 @@ Nothing.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`IBlobStorageEntryList`\>
+> **query**(`conditions`?, `orderBy`?, `orderByDirection`?, `cursor`?, `pageSize`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`IBlobStorageEntryList`\>
 
 Query all the blob storage entries which match the conditions.
 
@@ -238,9 +238,13 @@ Query all the blob storage entries which match the conditions.
 
 The conditions to match for the entries.
 
-• **sortProperties?**: `object`[]
+• **orderBy?**: `"dateCreated"` \| `"dateModified"`
 
-The optional sort order.
+The order for the results, defaults to created.
+
+• **orderByDirection?**: `SortDirection`
+
+The direction for the order, defaults to descending.
 
 • **cursor?**: `string`
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/blob-storage-service",
-	"version": "0.0.1-next.13",
+	"version": "0.0.1-next.15",
 	"description": "Blob storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -15,7 +15,7 @@
 	},
 	"dependencies": {
 		"@twin.org/api-models": "next",
-		"@twin.org/blob-storage-models": "0.0.1-next.13",
+		"@twin.org/blob-storage-models": "0.0.1-next.15",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/data-schema-org": "next",