@ez4/storage 0.33.0 → 0.35.0

package/dist/main.cjs

@@ -1,4 +1,4 @@
-"use strict";var o=Object.defineProperty;var s=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var u=Object.prototype.hasOwnProperty;var v=(t,e)=>{for(var r in e)o(t,r,{get:e[r],enumerable:!0})},a=(t,e,r,c)=>{if(e&&
-typeof e=="object"||typeof e=="function")for(let n of p(e))!u.call(t,n)&&n!==r&&
-o(t,n,{get:()=>e[n],enumerable:!(c=s(e,n))||c.enumerable});return t};var l=t=>a(o({},"__esModule",{value:!0}),t);var k={};v(k,{Bucket:()=>m,BucketEventType:()=>i});module.exports=l(k);var i=(r=>(r.Create="create",r.Delete="delete",r))(i||{});var m;(t=>{})(m||={});0&&(module.exports={Bucket,BucketEventType});
+"use strict";var n=Object.defineProperty;var p=Object.getOwnPropertyDescriptor;var s=Object.getOwnPropertyNames;var v=Object.prototype.hasOwnProperty;var u=(t,e)=>{for(var r in e)n(t,r,{get:e[r],enumerable:!0})},a=(t,e,r,i)=>{if(e&&
+typeof e=="object"||typeof e=="function")for(let o of s(e))!v.call(t,o)&&o!==r&&
+n(t,o,{get:()=>e[o],enumerable:!(i=p(e,o))||i.enumerable});return t};var y=t=>a(n({},"__esModule",{value:!0}),t);var d={};u(d,{Bucket:()=>m,BucketEventType:()=>c});module.exports=y(d);var c=(r=>(r.Create="create",r.Delete="delete",r))(c||{});var m;(t=>{})(m||={});0&&(module.exports={Bucket,BucketEventType});
 //# sourceMappingURL=main.cjs.map

package/dist/main.mjs

@@ -1,2 +1,2 @@
-var t=(e=>(e.Create="create",e.Delete="delete",e))(t||{});var r;(n=>{})(r||={});export{r as Bucket,t as BucketEventType};
+var t=(e=>(e.Create="create",e.Delete="delete",e))(t||{});var r;(o=>{})(r||={});export{r as Bucket,t as BucketEventType};
 //# sourceMappingURL=main.mjs.map

package/dist/services/client.d.ts

@@ -6,23 +6,23 @@ export type SignOptions = {
     /**
      * Define an expiration time (in seconds) for the signed URL.
      */
-    expiresIn: number;
+    readonly expiresIn: number;
 };
 export type WriteOptions = {
     /**
      * Define the expected content type.
      */
-    contentType: string;
+    readonly contentType: string;
 };
 export type ObjectStats = {
     /**
      * MIME type associated to the object.
      */
-    type?: string;
+    readonly type?: string;
     /**
      * Object size.
      */
-    size: number;
+    readonly size: number;
 };
 /**
  * Bucket client.

package/dist/services/common.d.ts

@@ -14,45 +14,20 @@ export type BucketEvent = {
     /**
      * Type of event.
      */
-    eventType: BucketEventType;
+    readonly eventType: BucketEventType;
     /**
      * Bucket from the event.
      */
-    bucketName: string;
+    readonly bucketName: string;
     /**
      * Object key in the bucket.
      */
-    objectKey: string;
+    readonly objectKey: string;
     /**
      * Size of the created object.
      */
-    objectSize?: number;
+    readonly objectSize?: number;
 };
-/**
- * Bucket CORS configuration.
- */
-export interface BucketCors {
-    /**
-     * List of allowed origins.
-     */
-    allowOrigins: string[];
-    /**
-     * List of allowed methods.
-     */
-    allowMethods?: string[];
-    /**
-     * List of allowed headers.
-     */
-    allowHeaders?: string[];
-    /**
-     * List of exposed headers.
-     */
-    exposeHeaders?: string[];
-    /**
-     * Determines how long the preflight result can be cached.
-     */
-    maxAge?: number;
-}
 /**
  * Incoming event.
  */
@@ -64,13 +39,13 @@ export type BucketRequest = {
     /**
      * Request tracking Id.
      */
-    requestId: string;
+    readonly requestId: string;
 };
 /**
- * Message listener.
+ * Bucket event listener.
  */
 export type BucketListener<T extends BucketEvent> = (event: Service.AnyEvent<BucketIncoming<T>>, context: Service.Context<Bucket.Service>) => Promise<void> | void;
 /**
- * Event handler.
+ * Bucket event handler.
  */
 export type BucketHandler<T extends BucketEvent> = (request: BucketIncoming<T> | T, context: Service.Context<Bucket.Service>) => Promise<void> | void;

package/dist/services/contract.d.ts

@@ -1,7 +1,9 @@
 import type { Service as CommonService } from '@ez4/common';
 import type { LinkedVariables } from '@ez4/project/library';
+import type { BucketEvent, BucketHandler, BucketIncoming, BucketListener, BucketRequest } from './common';
+import type { BucketEvents } from './events';
+import type { BucketCors } from './cors';
 import type { Client } from './client';
-import type { BucketCors, BucketEvent, BucketHandler, BucketIncoming, BucketListener, BucketRequest } from './common';
 /**
  * Provide all contracts for a self-managed Bucket service.
  */
@@ -12,40 +14,16 @@ export declare namespace Bucket {
     type Request = BucketRequest;
     type Listener = BucketListener<Event>;
     type Handler = BucketHandler<Event>;
+    type Events = BucketEvents;
     type ServiceEvent = CommonService.BeginEvent<Request> | CommonService.ReadyEvent<Incoming> | CommonService.DoneEvent<Incoming> | CommonService.ErrorEvent<Request | Incoming> | CommonService.EndEvent<Request>;
     /**
-     * Bucket events.
+     * Bucket Events definition.
      */
-    interface Events {
-        /**
-         * Event listener.
-         */
-        listener?: Listener;
-        /**
-         * Event handler.
-         */
-        handler: Handler;
-        /**
-         * Path associated to the event.
-         */
-        path?: string;
-        /**
-         * Variables associated to the handler.
-         */
-        variables?: LinkedVariables;
-        /**
-         * Log retention (in days) for the handler.
-         */
-        logRetention?: number;
-        /**
-         * Max execution time (in seconds) for the handler.
-         */
-        timeout?: number;
-        /**
-         * Amount of memory available for the handler.
-         */
-        memory?: number;
-    }
+    type UseEvents<T extends Events> = T;
+    /**
+     * Bucket CORS definition.
+     */
+    type UseCors<T extends Cors> = T;
     /**
      * Bucket service.
      */
@@ -53,30 +31,30 @@ export declare namespace Bucket {
         /**
          * Overwrite the global bucket name.
          */
-        globalName?: string;
+        readonly globalName?: string;
         /**
          * Specify a local path to synchronize with the storage.
          */
-        localPath?: string;
+        readonly localPath?: string;
         /**
          * Maximum amount of days an object is stored before its auto-deletion.
          */
-        autoExpireDays?: number;
+        readonly autoExpireDays?: number;
         /**
          * Bucket events.
          */
-        events?: Events;
+        readonly events?: Events;
         /**
          * CORS configuration.
          */
-        cors?: Cors;
+        readonly cors?: Cors;
         /**
          * Variables associated to all events.
          */
-        variables?: LinkedVariables;
+        readonly variables?: LinkedVariables;
         /**
          * Service client.
          */
-        client: Client;
+        readonly client: Client;
     }
 }

package/dist/services/cors.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Bucket CORS configuration.
+ */
+export interface BucketCors {
+    /**
+     * List of allowed origins.
+     */
+    readonly allowOrigins: string[];
+    /**
+     * List of allowed methods.
+     */
+    readonly allowMethods?: string[];
+    /**
+     * List of allowed headers.
+     */
+    readonly allowHeaders?: string[];
+    /**
+     * List of exposed headers.
+     */
+    readonly exposeHeaders?: string[];
+    /**
+     * Determines how long the preflight result can be cached.
+     */
+    readonly maxAge?: number;
+}

package/dist/services/events.d.ts

@@ -0,0 +1,35 @@
+import type { LinkedVariables } from '@ez4/project/library';
+import type { BucketEvent, BucketHandler, BucketListener } from './common';
+/**
+ * Bucket events.
+ */
+export interface BucketEvents {
+    /**
+     * Event listener.
+     */
+    readonly listener?: BucketListener<BucketEvent>;
+    /**
+     * Event handler.
+     */
+    readonly handler: BucketHandler<BucketEvent>;
+    /**
+     * Path associated to the event.
+     */
+    readonly path?: string;
+    /**
+     * Variables associated to the handler.
+     */
+    readonly variables?: LinkedVariables;
+    /**
+     * Log retention (in days) for the handler.
+     */
+    readonly logRetention?: number;
+    /**
+     * Max execution time (in seconds) for the handler.
+     */
+    readonly timeout?: number;
+    /**
+     * Amount of memory available for the handler.
+     */
+    readonly memory?: number;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ez4/storage",
   "description": "EZ4: Components to build storage services",
-  "version": "0.33.0",
+  "version": "0.35.0",
   "author": "Silas B.",
   "license": "MIT",
   "type": "module",
@@ -46,9 +46,9 @@
     "live:publish": "npm run build && npm publish --access public"
   },
   "dependencies": {
-    "@ez4/common": "^0.33.0",
-    "@ez4/project": "^0.33.0",
-    "@ez4/reflection": "^0.33.0",
-    "@ez4/utils": "^0.33.0"
+    "@ez4/common": "^0.35.0",
+    "@ez4/project": "^0.35.0",
+    "@ez4/reflection": "^0.35.0",
+    "@ez4/utils": "^0.35.0"
   }
 }