@ez4/storage 0.35.0 → 0.37.0

package/README.md

@@ -1,15 +1,113 @@
 # EZ4: Storage
 
-It uses the power of [reflection](../reflection/) to provide an API which determines how to build and connect storage components.
+It uses the power of [reflection](../../foundation/reflection/) to provide a contract that determines how to build and connect storage components.
 
 ## Getting started
 
 #### Install
 
 ```sh
-npm install @ez4/storage -D
+npm install @ez4/storage @ez4/local-storage @ez4/aws-bucket -D
 ```
 
+#### Create storage
+
+```ts
+// file: storage.ts
+import type { Environment, Service } from '@ez4/common';
+import type { Bucket } from '@ez4/storage';
+
+// MyStorage declaration
+export declare class MyStorage extends Bucket.Service {
+  autoExpireDays: 1;
+
+  events: Bucket.UseEvents<{
+    handler: typeof eventHandler;
+  }>;
+
+  variables: {
+    myVariable: Environment.Variable<'MY_VARIABLE'>;
+  };
+
+  services: {
+    otherService: Environment.Service<OtherService>;
+    variables: Environment.ServiceVariables;
+  };
+}
+
+// MyStorage event handler
+export function eventHandler(request: Bucket.Event, context: Service.Context<MyStorage>): void {
+  const { otherService, variables } = context;
+
+  // Access event contents
+  request.eventType;
+
+  // Access injected services
+  otherService.call();
+
+  // Access injected variables
+  variables.myVariable;
+}
+```
+
+> Listening to bucket events is optional, so `events`, `services`, and `variables` can be omitted.
+
+#### Use storage
+
+```ts
+// file: handler.ts
+import type { Service } from '@ez4/common';
+import type { MyStorage } from './storage';
+
+// Any other handler that has injected MyStorage service
+export async function anyHandler(_request: any, context: Service.Context<DummyService>) {
+  const { myStorage } = context;
+
+  // Write a file
+  await myStorage.write('dummy.txt', 'Hello storage');
+
+  // Read a file
+  const content = myStorage.read('dummy.txt');
+}
+```
+
+## Storage properties
+
+#### Service
+
+| Name           | Type               | Description                                                  |
+| -------------- | ------------------ | ------------------------------------------------------------ |
+| events         | Bucket.UseEvents<> | Entry-point handler for bucket events.                       |
+| cors           | Bucket.UseCors<>   | CORS configuration for the bucket.                           |
+| globalName     | string             | Overwrite the global bucket name.                            |
+| localPath      | string             | Specify a local path to synchronize with the storage.        |
+| autoExpireDays | integer            | Amount of days an object is stored before its auto-deletion. |
+| variables      | object             | Environment variables associated to the event handler.       |
+| services       | object             | Injected services associated to handler function.            |
+
+> Use type helpers for `events`, `cors` properties.
+
+#### Events
+
+| Name         | Type     | Description                                          |
+| ------------ | -------- | ---------------------------------------------------- |
+| listener     | function | Life-cycle listener function for the event.          |
+| handler      | function | Entry-point handler function for the event.          |
+| path         | string   | Path associated to the event.                        |
+| variables    | object   | Environment variables associated to handler.         |
+| logRetention | integer  | Log retention (in days) for the handler.             |
+| timeout      | integer  | Maximum execution time (in seconds) for the handler. |
+| memory       | integer  | Memory available (in megabytes) for the handler.     |
+
+## Examples
+
+- [Storage manager](../../examples/aws-storage-manager)
+
+## Providers
+
+- [Local provider](../../providers/local/local-storage)
+- [AWS provider](../../providers/aws/aws-bucket)
+
 ## License
 
 MIT License

package/dist/errors/handler.d.ts

@@ -1,4 +1,4 @@
 import { IncompleteTypeError } from '@ez4/common/library';
 export declare class IncompleteHandlerError extends IncompleteTypeError {
-    constructor(properties: string[], fileName?: string);
+    constructor(fileName?: string);
 }

package/dist/library.cjs

@@ -1,62 +1,61 @@
-"use strict";var E=Object.defineProperty;var L=Object.getOwnPropertyDescriptor;var Q=Object.getOwnPropertyNames;var U=Object.prototype.hasOwnProperty;var o=(e,r)=>E(e,"name",{value:r,configurable:!0});var W=(e,r)=>{for(var t in r)E(e,t,{get:r[t],enumerable:!0})},X=(e,r,t,i)=>{if(r&&
-typeof r=="object"||typeof r=="function")for(let n of Q(r))!U.call(e,n)&&n!==t&&
-E(e,n,{get:()=>r[n],enumerable:!(i=L(r,n))||i.enumerable});return e};var Y=e=>X(E({},"__esModule",{value:!0}),e);var ie={};W(ie,{IncompleteCorsError:()=>S,IncompleteEventError:()=>k,IncompleteServiceError:()=>g,
-IncorrectCorsTypeError:()=>M,IncorrectEventTypeError:()=>b,InvalidCorsTypeError:()=>x,
-InvalidEventTypeError:()=>T,ServiceType:()=>B,getBucketCors:()=>P,getBucketEvent:()=>z,
-getBucketServices:()=>O,getEventHandler:()=>w,isBucketService:()=>Z,registerTriggers:()=>ne});
-module.exports=Y(ie);var J=require("@ez4/common/library"),K=require("@ez4/project/library");var l=require("@ez4/common/library"),q=require("@ez4/reflection");var B="@ez4/bucket",Z=o(e=>e.type===B,"isBucketService");var A=require("@ez4/common/library");var g=class extends A.IncompleteTypeError{static{o(this,"IncompleteServiceError")}constructor(r,t){
-super("Incomplete bucket service",r,t)}};var u=require("@ez4/common/library"),h=require("@ez4/reflection");var I=o(e=>(0,u.isClassDeclaration)(e)&&(0,u.hasHeritageType)(e,"Bucket.Service"),
-"isBucketService"),H=o(e=>(0,h.isTypeCallback)(e)||(0,h.isTypeFunction)(e),"isEv\
-entHandler"),j=o(e=>(0,u.hasHeritageType)(e,"Bucket.Event"),"isBucketEvent"),R=o(
-e=>(0,u.hasHeritageType)(e,"Bucket.Cors"),"isBucketCors");var m=require("@ez4/common/library"),d=require("@ez4/reflection");var f=require("@ez4/common/library");var k=class extends f.IncompleteTypeError{static{o(this,"IncompleteEventError")}constructor(r,t){
+"use strict";var B=Object.defineProperty;var Y=Object.getOwnPropertyDescriptor;var Z=Object.getOwnPropertyNames;var _=Object.prototype.hasOwnProperty;var o=(e,r)=>B(e,"name",{value:r,configurable:!0});var $=(e,r)=>{for(var t in r)B(e,t,{get:r[t],enumerable:!0})},ee=(e,r,t,i)=>{if(r&&
+typeof r=="object"||typeof r=="function")for(let n of Z(r))!_.call(e,n)&&n!==t&&
+B(e,n,{get:()=>r[n],enumerable:!(i=Y(r,n))||i.enumerable});return e};var re=e=>ee(B({},"__esModule",{value:!0}),e);var pe={};$(pe,{IncompleteCorsError:()=>x,IncompleteEventError:()=>k,IncompleteServiceError:()=>g,
+IncorrectCorsTypeError:()=>E,IncorrectEventTypeError:()=>b,InvalidCorsTypeError:()=>S,
+InvalidEventTypeError:()=>T,ServiceType:()=>I,createBucketService:()=>w,getBucketCors:()=>R,
+getBucketEvent:()=>O,getBucketServices:()=>z,getEventHandler:()=>P,isBucketService:()=>te,
+registerTriggers:()=>ce});module.exports=re(pe);var U=require("@ez4/common/library"),X=require("@ez4/project/library");var a=require("@ez4/common/library"),K=require("@ez4/reflection"),L=require("@ez4/utils");var A=require("@ez4/project/library");var I="@ez4/bucket",te=o(e=>e.type===I,"isBucketService"),w=o(e=>({...(0,A.createServiceMetadata)(
+I,e),variables:{},services:{}}),"createBucketService");var j=require("@ez4/common/library");var g=class extends j.IncompleteTypeError{static{o(this,"IncompleteServiceError")}constructor(r,t){
+super("Incomplete bucket service",r,t)}};var u=require("@ez4/common/library"),M=require("@ez4/reflection");var h=o(e=>(0,u.isClassDeclaration)(e)&&(0,u.hasHeritageType)(e,"Bucket.Service"),
+"isBucketService"),D=o(e=>(0,M.isTypeCallback)(e)||(0,M.isTypeFunction)(e),"isEv\
+entHandler"),H=o(e=>(0,u.hasHeritageType)(e,"Bucket.Event"),"isBucketEvent"),F=o(
+e=>(0,u.hasHeritageType)(e,"Bucket.Cors"),"isBucketCors");var c=require("@ez4/common/library"),d=require("@ez4/reflection");var f=require("@ez4/common/library");var k=class extends f.IncompleteTypeError{static{o(this,"IncompleteEventError")}constructor(r,t){
 super("Incomplete bucket event",r,t)}},T=class extends f.InvalidTypeError{static{
 o(this,"InvalidEventTypeError")}constructor(r){super("Invalid bucket event type",
 void 0,"Bucket.Event",r)}},b=class extends f.IncorrectTypeError{constructor(t,i){
 super("Incorrect bucket event type",t,"Bucket.Event",i);this.eventType=t}static{
-o(this,"IncorrectEventTypeError")}};var D=require("@ez4/common/library");var C=class extends D.IncompleteTypeError{static{o(this,"IncompleteHandlerError")}constructor(r,t){
-super("Incomplete event handler",r,t)}};var w=o((e,r,t)=>{if(!H(e))return;let{description:i,module:n}=e,c={...i&&{description:i},
-...n&&{module:n}},p=new Set(["name","file"]);if((c.name=e.name)&&p.delete("name"),
-(c.file=e.file)&&p.delete("file"),p.size===0&&$(c))return c;t.push(new C([...p],
-e.file))},"getEventHandler"),$=o(e=>!!e.name&&!!e.file,"isValidHandler");var z=o((e,r,t,i)=>{if(!(0,d.isTypeReference)(e))return V(e,r,t,i);let n=(0,m.getReferenceType)(
-e,t);if(n)return V(n,r,t,i)},"getBucketEvent"),ee=o(e=>!!e.handler,"isValidEvent"),
-V=o((e,r,t,i)=>{if((0,d.isTypeObject)(e))return N(e,r,(0,m.getObjectMembers)(e),
-t,i);if(!(0,m.isModelDeclaration)(e)){i.push(new T(r.file));return}if(!j(e)){i.push(
-new b(e.name,e.file));return}return N(e,r,(0,m.getModelMembers)(e),t,i)},"getTyp\
-eEvent"),N=o((e,r,t,i,n)=>{let c={},p=new Set(["handler"]);for(let s of t)if(!(!(0,d.isModelProperty)(
-s)||s.inherited))switch(s.name){default:n.push(new m.InvalidServicePropertyError(
-r.name,s.name,e.file));break;case"path":c.path=(0,m.getPropertyString)(s);break;case"\
-listener":c.listener=(0,m.getServiceListener)(s.value,n);break;case"handler":c.handler=
-w(s.value,i,n);break;case"memory":case"logRetention":case"timeout":c[s.name]=(0,m.getPropertyNumber)(
-s);break;case"variables":c.variables=(0,m.getLinkedVariableList)(s,n);break}if(ee(
-c))return c;n.push(new k([...p],e.file))},"getTypeFromMembers");var a=require("@ez4/common/library"),v=require("@ez4/reflection");var y=require("@ez4/common/library");var S=class extends y.IncompleteTypeError{static{o(this,"IncompleteCorsError")}constructor(r,t){
-super("Incomplete bucket CORS",r,t)}},x=class extends y.InvalidTypeError{static{
+o(this,"IncorrectEventTypeError")}};var V=require("@ez4/common/library");var N=require("@ez4/common/library");var C=class extends N.IncompleteTypeError{static{o(this,"IncompleteHandlerError")}constructor(r){
+super("Incomplete event handler",[],r)}};var P=o((e,r)=>{if(!D(e))return;let t=(0,V.getFunctionSignature)(e);return t||r.
+push(new C(e.file)),t},"getEventHandler");var O=o((e,r,t,i)=>{if(!(0,d.isTypeReference)(e))return q(e,r,i);let n=(0,c.getReferenceType)(
+e,t);if(n)return q(n,r,i)},"getBucketEvent"),oe=o(e=>!!e.handler,"isValidEvent"),
+q=o((e,r,t)=>{if((0,d.isTypeObject)(e))return W(e,r,(0,c.getObjectMembers)(e),t);
+if(!(0,c.isModelDeclaration)(e)){t.push(new T(r.file));return}if(!H(e)){t.push(new b(
+e.name,e.file));return}return W(e,r,(0,c.getModelMembers)(e),t)},"getTypeEvent"),
+W=o((e,r,t,i)=>{let n={},m=new Set(["handler"]);for(let s of t)if(!(!(0,d.isModelProperty)(
+s)||s.inherited))switch(s.name){default:i.push(new c.InvalidServicePropertyError(
+r.name,s.name,e.file));break;case"path":n.path=(0,c.getPropertyString)(s);break;case"\
+listener":n.listener=(0,c.getServiceListener)(s.value,i);break;case"handler":n.handler=
+P(s.value,i);break;case"memory":case"logRetention":case"timeout":n[s.name]=(0,c.getPropertyNumber)(
+s);break;case"variables":n.variables=(0,c.getLinkedVariableList)(s,i);break}if(oe(
+n))return n;i.push(new k([...m],e.file))},"getTypeFromMembers");var p=require("@ez4/common/library"),v=require("@ez4/reflection");var y=require("@ez4/common/library");var x=class extends y.IncompleteTypeError{static{o(this,"IncompleteCorsError")}constructor(r,t){
+super("Incomplete bucket CORS",r,t)}},S=class extends y.InvalidTypeError{static{
 o(this,"InvalidCorsTypeError")}constructor(r){super("Invalid bucket CORS type",void 0,
-"Bucket.Cors",r)}},M=class extends y.IncorrectTypeError{constructor(t,i){super("\
+"Bucket.Cors",r)}},E=class extends y.IncorrectTypeError{constructor(t,i){super("\
 Incorrect bucket CORS type",t,"Bucket.Cors",i);this.fallbackType=t}static{o(this,
-"IncorrectCorsTypeError")}};var P=o((e,r,t,i)=>{if(!(0,v.isTypeReference)(e))return F(e,r,i);let n=(0,a.getReferenceType)(
-e,t);if(n)return F(n,r,i)},"getBucketCors"),re=o(e=>!!e.allowOrigins?.length,"is\
-ValidCors"),F=o((e,r,t)=>{if((0,v.isTypeObject)(e))return _(e,r,(0,a.getObjectMembers)(
-e),t);if(!(0,a.isModelDeclaration)(e)){t.push(new x(r.file));return}if(!R(e)){t.
-push(new M(e.name,e.file));return}return _(e,r,(0,a.getModelMembers)(e),t)},"get\
-TypeCors"),_=o((e,r,t,i)=>{let n={},c=new Set(["allowOrigins"]);for(let p of t)if(!(!(0,v.isModelProperty)(
-p)||p.inherited))switch(p.name){default:i.push(new a.InvalidServicePropertyError(
-r.name,p.name,e.file));break;case"allowOrigins":case"allowMethods":case"allowHea\
-ders":case"exposeHeaders":n[p.name]=te(p);break;case"maxAge":n.maxAge=(0,a.getPropertyNumber)(
-p);break}if(re(n))return n;i.push(new S([...c],e.file))},"getTypeFromMembers"),te=o(
-e=>{let r=(0,a.getPropertyTuple)(e)??[],t=[];for(let i of r){let n=(0,a.getLiteralString)(
-i);n&&t.push(n)}return t},"getStringValues");var O=o(e=>{let r={},t=[];for(let i in e){let n=e[i];if(!I(n)||(0,l.isExternalDeclaration)(
-n))continue;let c={type:B,context:{}},p=n.file;c.name=n.name;for(let s of(0,l.getModelMembers)(
-n))if(!(!(0,q.isModelProperty)(s)||s.inherited))switch(s.name){default:t.push(new l.InvalidServicePropertyError(
-c.name,s.name,p));break;case"client":break;case"localPath":case"globalName":c[s.
-name]=(0,l.getPropertyString)(s);break;case"autoExpireDays":c.autoExpireDays=(0,l.getPropertyNumber)(
-s);break;case"events":c.events=z(s.value,n,e,t);break;case"cors":c.cors=P(s.value,
-n,e,t);break;case"variables":c.variables=(0,l.getLinkedVariableList)(s,t);break;case"\
-services":c.services=(0,l.getLinkedServiceList)(s,e,t);break}if(!oe(c)){t.push(new g(
-[],p));continue}if(r[n.name]){t.push(new l.DuplicateServiceError(n.name,p));continue}
-r[n.name]=c}return{services:r,errors:t}},"getBucketServices"),oe=o(e=>!!e.name&&
-!!e.context,"isValidService");var G=o(e=>I(e)?e.name:null,"getLinkedService");var ne=o(()=>{(0,J.registerTriggers)(),(0,K.tryCreateTrigger)("@ez4/bucket",{"me\
-tadata:getServices":O,"metadata:getLinkedService":G})},"registerTriggers");0&&(module.exports={IncompleteCorsError,IncompleteEventError,IncompleteServiceError,
+"IncorrectCorsTypeError")}};var R=o((e,r,t,i)=>{if(!(0,v.isTypeReference)(e))return G(e,r,i);let n=(0,p.getReferenceType)(
+e,t);if(n)return G(n,r,i)},"getBucketCors"),ne=o(e=>!!e.allowOrigins?.length,"is\
+ValidCors"),G=o((e,r,t)=>{if((0,v.isTypeObject)(e))return J(e,r,(0,p.getObjectMembers)(
+e),t);if(!(0,p.isModelDeclaration)(e)){t.push(new S(r.file));return}if(!F(e)){t.
+push(new E(e.name,e.file));return}return J(e,r,(0,p.getModelMembers)(e),t)},"get\
+TypeCors"),J=o((e,r,t,i)=>{let n={},m=new Set(["allowOrigins"]);for(let s of t)if(!(!(0,v.isModelProperty)(
+s)||s.inherited))switch(s.name){default:i.push(new p.InvalidServicePropertyError(
+r.name,s.name,e.file));break;case"allowOrigins":case"allowMethods":case"allowHea\
+ders":case"exposeHeaders":n[s.name]=ie(s);break;case"maxAge":n.maxAge=(0,p.getPropertyNumber)(
+s);break}if(ne(n))return n;i.push(new x([...m],e.file))},"getTypeFromMembers"),ie=o(
+e=>{let r=(0,p.getPropertyTuple)(e)??[],t=[];for(let i of r){let n=(0,p.getLiteralString)(
+i);n&&t.push(n)}return t},"getStringValues");var z=o(e=>{let r={},t=[];for(let i in e){let n=e[i];if(!h(n)||(0,a.isExternalDeclaration)(
+n))continue;let m=w(n.name),s=n.file;for(let l of(0,a.getModelMembers)(n))if(!(!(0,K.isModelProperty)(
+l)||l.inherited))switch(l.name){default:t.push(new a.InvalidServicePropertyError(
+m.name,l.name,s));break;case"client":break;case"localPath":case"globalName":m[l.
+name]=(0,a.getPropertyString)(l);break;case"autoExpireDays":m.autoExpireDays=(0,a.getPropertyNumber)(
+l);break;case"events":m.events=O(l.value,n,e,t);break;case"cors":m.cors=R(l.value,
+n,e,t);break;case"variables":m.variables=(0,a.getLinkedVariableList)(l,t);break;case"\
+services":m.services=(0,a.getLinkedServiceList)(l,e,t);break}if(!se(m)){t.push(new g(
+[],s));continue}if(r[n.name]){t.push(new a.DuplicateServiceError(n.name,s));continue}
+r[n.name]=m}return{services:r,errors:t}},"getBucketServices"),se=o(e=>(0,L.isObjectWith)(
+e,["variables","services"]),"isCompleteService");var Q=o(e=>h(e)?e.name:null,"getLinkedService");var ce=o(()=>{(0,U.registerTriggers)(),(0,X.tryCreateTrigger)("@ez4/bucket",{"me\
+tadata:getServices":z,"metadata:getLinkedService":Q})},"registerTriggers");0&&(module.exports={IncompleteCorsError,IncompleteEventError,IncompleteServiceError,
 IncorrectCorsTypeError,IncorrectEventTypeError,InvalidCorsTypeError,InvalidEventTypeError,
-ServiceType,getBucketCors,getBucketEvent,getBucketServices,getEventHandler,isBucketService,
-registerTriggers});
+ServiceType,createBucketService,getBucketCors,getBucketEvent,getBucketServices,getEventHandler,
+isBucketService,registerTriggers});
 //# sourceMappingURL=library.cjs.map

package/dist/library.mjs

@@ -1,56 +1,56 @@
-var O=Object.defineProperty;var o=(e,t)=>O(e,"name",{value:t,configurable:!0});import{registerTriggers as Ie}from"@ez4/common/library";import{tryCreateTrigger as Ce}from"@ez4/project/library";import{DuplicateServiceError as ge,InvalidServicePropertyError as ke,isExternalDeclaration as Te,
-getLinkedVariableList as be,getLinkedServiceList as Se,getModelMembers as xe,getPropertyNumber as Me,
-getPropertyString as Ee}from"@ez4/common/library";import{isModelProperty as Be}from"@ez4/reflection";var k="@ez4/bucket",ze=o(e=>e.type===k,"isBucketService");import{IncompleteTypeError as A}from"@ez4/common/library";var m=class extends A{static{o(this,"IncompleteServiceError")}constructor(t,r){super(
-"Incomplete bucket service",t,r)}};import{hasHeritageType as T,isClassDeclaration as H}from"@ez4/common/library";import{
-isTypeCallback as j,isTypeFunction as R}from"@ez4/reflection";var a=o(e=>H(e)&&T(e,"Bucket.Service"),"isBucketService"),b=o(e=>j(e)||R(e),"isE\
-ventHandler"),S=o(e=>T(e,"Bucket.Event"),"isBucketEvent"),x=o(e=>T(e,"Bucket.Cor\
-s"),"isBucketCors");import{InvalidServicePropertyError as q,isModelDeclaration as G,getLinkedVariableList as J,
-getModelMembers as K,getObjectMembers as L,getPropertyNumber as Q,getPropertyString as U,
-getServiceListener as W,getReferenceType as X}from"@ez4/common/library";import{isModelProperty as Y,
-isTypeObject as Z,isTypeReference as $}from"@ez4/reflection";import{IncompleteTypeError as D,IncorrectTypeError as V,InvalidTypeError as N}from"@ez4/common/library";var l=class extends D{static{o(this,"IncompleteEventError")}constructor(t,r){super(
-"Incomplete bucket event",t,r)}},u=class extends N{static{o(this,"InvalidEventTy\
+var z=Object.defineProperty;var o=(e,t)=>z(e,"name",{value:t,configurable:!0});import{registerTriggers as Pe}from"@ez4/common/library";import{tryCreateTrigger as Oe}from"@ez4/project/library";import{DuplicateServiceError as Te,InvalidServicePropertyError as be,isExternalDeclaration as xe,
+getLinkedVariableList as Se,getLinkedServiceList as Ee,getModelMembers as Be,getPropertyNumber as Me,
+getPropertyString as he}from"@ez4/common/library";import{isModelProperty as Ce}from"@ez4/reflection";
+import{isObjectWith as Ie}from"@ez4/utils";import{createServiceMetadata as A}from"@ez4/project/library";var T="@ez4/bucket",Ae=o(e=>e.type===T,"isBucketService"),b=o(e=>({...A(T,e),variables:{},
+services:{}}),"createBucketService");import{IncompleteTypeError as j}from"@ez4/common/library";var a=class extends j{static{o(this,"IncompleteServiceError")}constructor(t,r){super(
+"Incomplete bucket service",t,r)}};import{hasHeritageType as k,isClassDeclaration as D}from"@ez4/common/library";import{
+isTypeCallback as H,isTypeFunction as F}from"@ez4/reflection";var m=o(e=>D(e)&&k(e,"Bucket.Service"),"isBucketService"),x=o(e=>H(e)||F(e),"isE\
+ventHandler"),S=o(e=>k(e,"Bucket.Event"),"isBucketEvent"),E=o(e=>k(e,"Bucket.Cor\
+s"),"isBucketCors");import{InvalidServicePropertyError as J,isModelDeclaration as K,getLinkedVariableList as L,
+getModelMembers as Q,getObjectMembers as U,getPropertyNumber as X,getPropertyString as Y,
+getServiceListener as Z,getReferenceType as _}from"@ez4/common/library";import{isModelProperty as $,
+isTypeObject as ee,isTypeReference as re}from"@ez4/reflection";import{IncompleteTypeError as N,IncorrectTypeError as V,InvalidTypeError as q}from"@ez4/common/library";var l=class extends N{static{o(this,"IncompleteEventError")}constructor(t,r){super(
+"Incomplete bucket event",t,r)}},u=class extends q{static{o(this,"InvalidEventTy\
 peError")}constructor(t){super("Invalid bucket event type",void 0,"Bucket.Event",
 t)}},f=class extends V{constructor(r,i){super("Incorrect bucket event type",r,"B\
-ucket.Event",i);this.eventType=r}static{o(this,"IncorrectEventTypeError")}};import{IncompleteTypeError as F}from"@ez4/common/library";var d=class extends F{static{o(this,"IncompleteHandlerError")}constructor(t,r){super(
-"Incomplete event handler",t,r)}};var M=o((e,t,r)=>{if(!b(e))return;let{description:i,module:n}=e,c={...i&&{description:i},
-...n&&{module:n}},p=new Set(["name","file"]);if((c.name=e.name)&&p.delete("name"),
-(c.file=e.file)&&p.delete("file"),p.size===0&&_(c))return c;r.push(new d([...p],
-e.file))},"getEventHandler"),_=o(e=>!!e.name&&!!e.file,"isValidHandler");var h=o((e,t,r,i)=>{if(!$(e))return E(e,t,r,i);let n=X(e,r);if(n)return E(n,t,r,
-i)},"getBucketEvent"),ee=o(e=>!!e.handler,"isValidEvent"),E=o((e,t,r,i)=>{if(Z(e))
-return B(e,t,L(e),r,i);if(!G(e)){i.push(new u(t.file));return}if(!S(e)){i.push(new f(
-e.name,e.file));return}return B(e,t,K(e),r,i)},"getTypeEvent"),B=o((e,t,r,i,n)=>{
-let c={},p=new Set(["handler"]);for(let s of r)if(!(!Y(s)||s.inherited))switch(s.
-name){default:n.push(new q(t.name,s.name,e.file));break;case"path":c.path=U(s);break;case"\
-listener":c.listener=W(s.value,n);break;case"handler":c.handler=M(s.value,i,n);break;case"\
-memory":case"logRetention":case"timeout":c[s.name]=Q(s);break;case"variables":c.
-variables=J(s,n);break}if(ee(c))return c;n.push(new l([...p],e.file))},"getTypeF\
-romMembers");import{InvalidServicePropertyError as ne,isModelDeclaration as ie,getLiteralString as ce,
-getModelMembers as se,getObjectMembers as pe,getPropertyNumber as me,getPropertyTuple as ae,
-getReferenceType as le}from"@ez4/common/library";import{isModelProperty as ue,isTypeObject as fe,
-isTypeReference as de}from"@ez4/reflection";import{IncompleteTypeError as re,IncorrectTypeError as te,InvalidTypeError as oe}from"@ez4/common/library";var y=class extends re{static{o(this,"IncompleteCorsError")}constructor(t,r){super(
-"Incomplete bucket CORS",t,r)}},v=class extends oe{static{o(this,"InvalidCorsTyp\
+ucket.Event",i);this.eventType=r}static{o(this,"IncorrectEventTypeError")}};import{getFunctionSignature as G}from"@ez4/common/library";import{IncompleteTypeError as W}from"@ez4/common/library";var d=class extends W{static{o(this,"IncompleteHandlerError")}constructor(t){super(
+"Incomplete event handler",[],t)}};var B=o((e,t)=>{if(!x(e))return;let r=G(e);return r||t.push(new d(e.file)),r},"g\
+etEventHandler");var C=o((e,t,r,i)=>{if(!re(e))return M(e,t,i);let n=_(e,r);if(n)return M(n,t,i)},
+"getBucketEvent"),te=o(e=>!!e.handler,"isValidEvent"),M=o((e,t,r)=>{if(ee(e))return h(
+e,t,U(e),r);if(!K(e)){r.push(new u(t.file));return}if(!S(e)){r.push(new f(e.name,
+e.file));return}return h(e,t,Q(e),r)},"getTypeEvent"),h=o((e,t,r,i)=>{let n={},c=new Set(
+["handler"]);for(let s of r)if(!(!$(s)||s.inherited))switch(s.name){default:i.push(
+new J(t.name,s.name,e.file));break;case"path":n.path=Y(s);break;case"listener":n.
+listener=Z(s.value,i);break;case"handler":n.handler=B(s.value,i);break;case"memo\
+ry":case"logRetention":case"timeout":n[s.name]=X(s);break;case"variables":n.variables=
+L(s,i);break}if(te(n))return n;i.push(new l([...c],e.file))},"getTypeFromMembers");import{InvalidServicePropertyError as se,isModelDeclaration as ce,getLiteralString as pe,
+getModelMembers as ae,getObjectMembers as me,getPropertyNumber as le,getPropertyTuple as ue,
+getReferenceType as fe}from"@ez4/common/library";import{isModelProperty as de,isTypeObject as ye,
+isTypeReference as ve}from"@ez4/reflection";import{IncompleteTypeError as oe,IncorrectTypeError as ne,InvalidTypeError as ie}from"@ez4/common/library";var y=class extends oe{static{o(this,"IncompleteCorsError")}constructor(t,r){super(
+"Incomplete bucket CORS",t,r)}},v=class extends ie{static{o(this,"InvalidCorsTyp\
 eError")}constructor(t){super("Invalid bucket CORS type",void 0,"Bucket.Cors",t)}},
-g=class extends te{constructor(r,i){super("Incorrect bucket CORS type",r,"Bucket\
-.Cors",i);this.fallbackType=r}static{o(this,"IncorrectCorsTypeError")}};var w=o((e,t,r,i)=>{if(!de(e))return I(e,t,i);let n=le(e,r);if(n)return I(n,t,i)},
-"getBucketCors"),ye=o(e=>!!e.allowOrigins?.length,"isValidCors"),I=o((e,t,r)=>{if(fe(
-e))return C(e,t,pe(e),r);if(!ie(e)){r.push(new v(t.file));return}if(!x(e)){r.push(
-new g(e.name,e.file));return}return C(e,t,se(e),r)},"getTypeCors"),C=o((e,t,r,i)=>{
-let n={},c=new Set(["allowOrigins"]);for(let p of r)if(!(!ue(p)||p.inherited))switch(p.
-name){default:i.push(new ne(t.name,p.name,e.file));break;case"allowOrigins":case"\
-allowMethods":case"allowHeaders":case"exposeHeaders":n[p.name]=ve(p);break;case"\
-maxAge":n.maxAge=me(p);break}if(ye(n))return n;i.push(new y([...c],e.file))},"ge\
-tTypeFromMembers"),ve=o(e=>{let t=ae(e)??[],r=[];for(let i of t){let n=ce(i);n&&
-r.push(n)}return r},"getStringValues");var z=o(e=>{let t={},r=[];for(let i in e){let n=e[i];if(!a(n)||Te(n))continue;let c={
-type:k,context:{}},p=n.file;c.name=n.name;for(let s of xe(n))if(!(!Be(s)||s.inherited))
-switch(s.name){default:r.push(new ke(c.name,s.name,p));break;case"client":break;case"\
-localPath":case"globalName":c[s.name]=Ee(s);break;case"autoExpireDays":c.autoExpireDays=
-Me(s);break;case"events":c.events=h(s.value,n,e,r);break;case"cors":c.cors=w(s.value,
-n,e,r);break;case"variables":c.variables=be(s,r);break;case"services":c.services=
-Se(s,e,r);break}if(!he(c)){r.push(new m([],p));continue}if(t[n.name]){r.push(new ge(
-n.name,p));continue}t[n.name]=c}return{services:t,errors:r}},"getBucketServices"),
-he=o(e=>!!e.name&&!!e.context,"isValidService");var P=o(e=>a(e)?e.name:null,"getLinkedService");var Cr=o(()=>{Ie(),Ce("@ez4/bucket",{"metadata:getServices":z,"metadata:getLinke\
-dService":P})},"registerTriggers");export{y as IncompleteCorsError,l as IncompleteEventError,m as IncompleteServiceError,
+g=class extends ne{constructor(r,i){super("Incorrect bucket CORS type",r,"Bucket\
+.Cors",i);this.fallbackType=r}static{o(this,"IncorrectCorsTypeError")}};var P=o((e,t,r,i)=>{if(!ve(e))return I(e,t,i);let n=fe(e,r);if(n)return I(n,t,i)},
+"getBucketCors"),ge=o(e=>!!e.allowOrigins?.length,"isValidCors"),I=o((e,t,r)=>{if(ye(
+e))return w(e,t,me(e),r);if(!ce(e)){r.push(new v(t.file));return}if(!E(e)){r.push(
+new g(e.name,e.file));return}return w(e,t,ae(e),r)},"getTypeCors"),w=o((e,t,r,i)=>{
+let n={},c=new Set(["allowOrigins"]);for(let s of r)if(!(!de(s)||s.inherited))switch(s.
+name){default:i.push(new se(t.name,s.name,e.file));break;case"allowOrigins":case"\
+allowMethods":case"allowHeaders":case"exposeHeaders":n[s.name]=ke(s);break;case"\
+maxAge":n.maxAge=le(s);break}if(ge(n))return n;i.push(new y([...c],e.file))},"ge\
+tTypeFromMembers"),ke=o(e=>{let t=ue(e)??[],r=[];for(let i of t){let n=pe(i);n&&
+r.push(n)}return r},"getStringValues");var O=o(e=>{let t={},r=[];for(let i in e){let n=e[i];if(!m(n)||xe(n))continue;let c=b(
+n.name),s=n.file;for(let p of Be(n))if(!(!Ce(p)||p.inherited))switch(p.name){default:
+r.push(new be(c.name,p.name,s));break;case"client":break;case"localPath":case"gl\
+obalName":c[p.name]=he(p);break;case"autoExpireDays":c.autoExpireDays=Me(p);break;case"\
+events":c.events=C(p.value,n,e,r);break;case"cors":c.cors=P(p.value,n,e,r);break;case"\
+variables":c.variables=Se(p,r);break;case"services":c.services=Ee(p,e,r);break}if(!we(
+c)){r.push(new a([],s));continue}if(t[n.name]){r.push(new Te(n.name,s));continue}
+t[n.name]=c}return{services:t,errors:r}},"getBucketServices"),we=o(e=>Ie(e,["var\
+iables","services"]),"isCompleteService");var R=o(e=>m(e)?e.name:null,"getLinkedService");var Ar=o(()=>{Pe(),Oe("@ez4/bucket",{"metadata:getServices":O,"metadata:getLinke\
+dService":R})},"registerTriggers");export{y as IncompleteCorsError,l as IncompleteEventError,a as IncompleteServiceError,
 g as IncorrectCorsTypeError,f as IncorrectEventTypeError,v as InvalidCorsTypeError,
-u as InvalidEventTypeError,k as ServiceType,w as getBucketCors,h as getBucketEvent,
-z as getBucketServices,M as getEventHandler,ze as isBucketService,Cr as registerTriggers};
+u as InvalidEventTypeError,T as ServiceType,b as createBucketService,P as getBucketCors,
+C as getBucketEvent,O as getBucketServices,B as getEventHandler,Ae as isBucketService,
+Ar as registerTriggers};
 //# sourceMappingURL=library.mjs.map

package/dist/metadata/cors.d.ts

@@ -1,3 +1,3 @@
-import type { AllType, SourceMap, TypeModel } from '@ez4/reflection';
+import type { AllType, ReflectionTypes, TypeModel } from '@ez4/reflection';
 import type { BucketCors } from '../types/common';
-export declare const getBucketCors: (type: AllType, parent: TypeModel, reflection: SourceMap, errorList: Error[]) => BucketCors | undefined;
+export declare const getBucketCors: (type: AllType, parent: TypeModel, reflection: ReflectionTypes, errorList: Error[]) => BucketCors | undefined;

package/dist/metadata/event.d.ts

@@ -1,3 +1,3 @@
-import type { AllType, SourceMap, TypeModel } from '@ez4/reflection';
+import type { AllType, ReflectionTypes, TypeModel } from '@ez4/reflection';
 import type { BucketEvent } from '../types/common';
-export declare const getBucketEvent: (type: AllType, parent: TypeModel, reflection: SourceMap, errorList: Error[]) => BucketEvent | undefined;
+export declare const getBucketEvent: (type: AllType, parent: TypeModel, reflection: ReflectionTypes, errorList: Error[]) => BucketEvent | undefined;

package/dist/metadata/handler.d.ts

@@ -1,3 +1,2 @@
-import type { AllType, SourceMap } from '@ez4/reflection';
-import type { EventHandler } from '../types/common';
-export declare const getEventHandler: (type: AllType, _reflection: SourceMap, errorList: Error[]) => EventHandler | undefined;
+import type { AllType } from '@ez4/reflection';
+export declare const getEventHandler: (type: AllType, errorList: Error[]) => import("@ez4/common/library").FunctionSignature | undefined;

package/dist/metadata/service.d.ts

@@ -1,6 +1,6 @@
-import type { SourceMap } from '@ez4/reflection';
+import type { ReflectionTypes } from '@ez4/reflection';
 import type { BucketService } from '../types/service';
-export declare const getBucketServices: (reflection: SourceMap) => {
+export declare const getBucketServices: (reflection: ReflectionTypes) => {
     services: Record<string, BucketService>;
     errors: Error[];
 };

package/dist/services/events.d.ts

@@ -5,11 +5,11 @@ import type { BucketEvent, BucketHandler, BucketListener } from './common';
  */
 export interface BucketEvents {
     /**
-     * Event listener.
+     * Life-cycle listener function for the event.
      */
     readonly listener?: BucketListener<BucketEvent>;
     /**
-     * Event handler.
+     * Entry-point handler function for the event.
      */
     readonly handler: BucketHandler<BucketEvent>;
     /**
@@ -29,7 +29,7 @@ export interface BucketEvents {
      */
     readonly timeout?: number;
     /**
-     * Amount of memory available for the handler.
+     * Amount of memory available (in megabytes) for the handler.
      */
     readonly memory?: number;
 }

package/dist/types/common.d.ts

@@ -1,5 +1,5 @@
+import type { FunctionSignature, ServiceListener } from '@ez4/common/library';
 import type { LinkedVariables } from '@ez4/project/library';
-import type { ServiceListener } from '@ez4/common/library';
 export type BucketCors = {
     allowOrigins: string[];
     allowMethods?: string[];
@@ -7,12 +7,7 @@ export type BucketCors = {
     allowHeaders?: string[];
     maxAge?: number;
 };
-export type EventHandler = {
-    file: string;
-    module?: string;
-    name: string;
-    description?: string;
-};
+export type EventHandler = FunctionSignature;
 export type BucketEvent = {
     path?: string;
     listener?: ServiceListener;

package/dist/types/service.d.ts

@@ -1,7 +1,7 @@
 import type { ServiceMetadata } from '@ez4/project/library';
 import type { BucketCors, BucketEvent } from './common';
 export declare const ServiceType = "@ez4/bucket";
-export type BucketService = ServiceMetadata & {
+export type BucketService = Omit<ServiceMetadata, 'variables' | 'services'> & Required<Pick<ServiceMetadata, 'variables' | 'services'>> & {
     type: typeof ServiceType;
     name: string;
     localPath?: string;
@@ -11,3 +11,15 @@ export type BucketService = ServiceMetadata & {
     cors?: BucketCors;
 };
 export declare const isBucketService: (service: ServiceMetadata) => service is BucketService;
+export declare const createBucketService: (name: string) => {
+    variables: {};
+    services: {};
+    type: "@ez4/bucket";
+    name: string;
+    context: Record<string, import("@ez4/project/library").LinkedContext>;
+    localPath?: string | null | undefined;
+    globalName?: string | null | undefined;
+    autoExpireDays?: number | null | undefined;
+    events?: BucketEvent | null | undefined;
+    cors?: BucketCors | null | undefined;
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ez4/storage",
   "description": "EZ4: Components to build storage services",
-  "version": "0.35.0",
+  "version": "0.37.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.35.0",
-    "@ez4/project": "^0.35.0",
-    "@ez4/reflection": "^0.35.0",
-    "@ez4/utils": "^0.35.0"
+    "@ez4/common": "^0.37.0",
+    "@ez4/project": "^0.37.0",
+    "@ez4/reflection": "^0.37.0",
+    "@ez4/utils": "^0.37.0"
   }
 }