@ez4/aws-bucket 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Silas B.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,15 @@
+# EZ4: AWS Bucket
+
+It provides all the components to manage buckets and objects on AWS.
+
+## Getting started
+
+#### Install
+
+```sh
+npm install @ez4/aws-bucket -D
+```
+
+## License
+
+MIT License

package/dist/bucket/client.d.ts

@@ -0,0 +1,11 @@
+import type { ResourceTags } from '@ez4/aws-common';
+export type CreateRequest = {
+    bucketName: string;
+};
+export type CreateResponse = {
+    bucketName: string;
+    location: string;
+};
+export declare const createBucket: (request: CreateRequest) => Promise<CreateResponse>;
+export declare const tagBucket: (bucketName: string, tags: ResourceTags) => Promise<void>;
+export declare const deleteBucket: (bucketName: string) => Promise<void>;

package/dist/bucket/handler.d.ts

@@ -0,0 +1,3 @@
+import type { StepHandler } from '@ez4/stateful';
+import type { BucketState } from './types.js';
+export declare const getBucketHandler: () => StepHandler<BucketState>;

package/dist/bucket/service.d.ts

@@ -0,0 +1,4 @@
+import type { EntryState, EntryStates } from '@ez4/stateful';
+import type { BucketParameters, BucketState } from './types.js';
+export declare const isBucket: (resource: EntryState) => resource is BucketState;
+export declare const createBucket: <E extends EntryState>(state: EntryStates<E>, parameters: BucketParameters) => BucketState;

package/dist/bucket/types.d.ts

@@ -0,0 +1,16 @@
+import type { EntryState } from '@ez4/stateful';
+import type { ResourceTags } from '@ez4/aws-common';
+import type { CreateRequest, CreateResponse } from './client.js';
+export declare const BucketServiceName = "AWS:S3/Bucket";
+export declare const BucketServiceType = "aws:s3.bucket";
+export type BucketParameters = CreateRequest & {
+    tags?: ResourceTags;
+};
+export type BucketResult = CreateResponse & {
+    bucketName: string;
+};
+export type BucketState = EntryState & {
+    type: typeof BucketServiceType;
+    parameters: BucketParameters;
+    result?: BucketResult;
+};

package/dist/main.cjs

@@ -0,0 +1,38 @@
+"use strict";var k=Object.defineProperty;var Z=Object.getOwnPropertyDescriptor;var $=Object.getOwnPropertyNames;var _=Object.prototype.hasOwnProperty;var F=(e,t)=>{for(var r in t)k(e,r,{get:t[r],enumerable:!0})},G=(e,t,r,o)=>{if(t&&
+typeof t=="object"||typeof t=="function")for(let c of $(t))!_.call(e,c)&&c!==r&&
+k(e,c,{get:()=>t[c],enumerable:!(o=Z(t,c))||o.enumerable});return e};var J=e=>G(k({},"__esModule",{value:!0}),e);var ie={};F(ie,{BucketServiceName:()=>m,BucketServiceType:()=>a,ObjectServiceName:()=>s,
+ObjectServiceType:()=>u,createBucket:()=>pe,createBucketObject:()=>ue,isBucket:()=>ne,
+isBucketObject:()=>me});module.exports=J(ie);var d=require("@ez4/aws-common");var C=require("@ez4/aws-common"),E=require("@ez4/utils");var i=require("@ez4/aws-common"),n=require("@aws-sdk/client-s3");var m="AWS:S3/Bucket",a="aws:s3.bucket";var l=new n.S3Client({}),R=async e=>{i.Logger.logCreate(m,e.bucketName);let t=await l.
+send(new n.CreateBucketCommand({Bucket:e.bucketName}));return{bucketName:e.bucketName,
+location:t.Location}},x=async(e,t)=>{i.Logger.logTag(m,e),await l.send(new n.PutBucketTaggingCommand(
+{Bucket:e,Tagging:{TagSet:(0,i.getTagList)({...t,ManagedBy:"EZ4"})}}))},w=async e=>{
+i.Logger.logDelete(m,e),await l.send(new n.DeleteBucketCommand({Bucket:e}))};var T=()=>({equals:Q,create:P,replace:X,preview:V,update:Y,delete:ee}),Q=(e,t)=>!!e.
+result&&e.result.bucketName===t.result?.bucketName,V=async(e,t)=>{let r={...e.parameters,
+dependencies:e.dependencies},o={...t.parameters,dependencies:t.dependencies},c=(0,E.deepCompare)(
+r,o);if(c.counts)return{...c,name:r.bucketName}},X=async(e,t)=>{if(t.result)throw new C.ReplaceResourceError(
+m,e.entryId,t.entryId);return P(e)},P=async e=>{let t=e.parameters,r=await R(t);
+return await N(r.bucketName,t),{bucketName:r.bucketName,location:r.location}},Y=async(e,t)=>{
+let r=e.result;r&&await N(r.bucketName,e.parameters)},ee=async e=>{let t=e.result;
+t&&await w(t.bucketName)},N=async(e,t)=>{await x(e,t.tags??{})};var D=require("@ez4/aws-common"),H=require("@ez4/utils");var z=require("node:fs"),b=require("@ez4/aws-common"),p=require("@aws-sdk/client-s3");var s="AWS:S3/Object",u="aws:s3.object";var K=require("node:path"),v=require("@ez4/aws-common");var y=e=>e.objectKey??(0,K.basename)(e.filePath),g=(e,t)=>`${e}/${t}`,h=(e,t)=>{
+let r=t.getDependencies(a).at(0)?.result;if(!r?.bucketName)throw new v.IncompleteResourceError(
+s,e,"bucketName");return r.bucketName};var S=new p.S3Client({}),f=async(e,t)=>{b.Logger.logCreate(s,g(e,t.objectKey));let r=await S.
+send(new p.PutObjectCommand({Bucket:e,Key:t.objectKey,Body:(0,z.createReadStream)(
+t.filePath),Expires:t.expires}));return{objectKey:t.objectKey,etag:r.ETag}},I=async(e,t,r)=>{
+b.Logger.logTag(s,g(e,t)),await S.send(new p.PutObjectTaggingCommand({Bucket:e,Key:t,
+Tagging:{TagSet:(0,b.getTagList)({...r,ManagedBy:"EZ4"})}}))},B=async(e,t)=>{b.Logger.
+logDelete(s,g(e,t)),await S.send(new p.DeleteObjectCommand({Bucket:e,Key:t}))};var q=()=>({equals:te,create:L,replace:ce,preview:re,update:oe,delete:ae}),te=(e,t)=>!!e.
+result&&e.result.objectKey===t.result?.objectKey,re=async(e,t)=>{let r={...e.parameters,
+dependencies:e.dependencies},o={...t.parameters,dependencies:t.dependencies},c=(0,H.deepCompare)(
+r,o);if(c.counts)return{...c,name:y(r)}},ce=async(e,t,r)=>{if(t.result)throw new D.ReplaceResourceError(
+s,e.entryId,t.entryId);return L(e,r)},L=async(e,t)=>{let r=e.parameters,o=h("buc\
+ket",t),c=y(r),O=await f(o,{...r,objectKey:c});return await U(o,c,r),{bucketName:o,
+objectKey:O.objectKey,etag:O.etag}},oe=async(e,t)=>{let r=e.result;if(!r)return;
+let o=y(e.parameters),c=r.bucketName;return t.result?await se(c,o,e.parameters,t.
+result):(await U(c,o,e.parameters),r)},ae=async e=>{let t=e.result;t&&await B(t.
+bucketName,t.objectKey)},se=async(e,t,r,o)=>{if(t===o.objectKey)return;await B(e,
+o.objectKey);let c=await f(e,{...r,objectKey:t});return{bucketName:e,objectKey:c.
+objectKey,etag:c.etag}},U=async(e,t,r)=>{await I(e,t,r.tags??{})};var j=require("@ez4/utils"),A=require("@ez4/stateful");var ne=e=>e.type===a,pe=(e,t)=>{let r=(0,j.toKebabCase)(t.bucketName),o=(0,j.hashData)(
+a,r);return(0,A.attachEntry)(e,{type:a,entryId:o,dependencies:[],parameters:{...t,
+bucketName:r}})};var M=require("@ez4/stateful"),W=require("@ez4/utils");var me=e=>e.type===u,ue=(e,t,r)=>{let o=y(r),c=(0,W.hashData)(u,t.entryId,o);return(0,M.attachEntry)(
+e,{type:u,entryId:c,dependencies:[t.entryId],parameters:r})};(0,d.registerProvider)(a,T());(0,d.registerProvider)(u,q());0&&(module.exports={BucketServiceName,BucketServiceType,ObjectServiceName,ObjectServiceType,
+createBucket,createBucketObject,isBucket,isBucketObject});

package/dist/main.d.ts

@@ -0,0 +1,4 @@
+export * from './bucket/service.js';
+export * from './bucket/types.js';
+export * from './object/service.js';
+export * from './object/types.js';

package/dist/main.mjs

@@ -0,0 +1,33 @@
+import{registerProvider as P}from"@ez4/aws-common";import{ReplaceResourceError as I}from"@ez4/aws-common";import{deepCompare as D}from"@ez4/utils";import{getTagList as N,Logger as i}from"@ez4/aws-common";import{CreateBucketCommand as K,
+DeleteBucketCommand as v,PutBucketTaggingCommand as h,S3Client as z}from"@aws-sdk/client-s3";var n="AWS:S3/Bucket",a="aws:s3.bucket";var y=new z({}),S=async e=>{i.logCreate(n,e.bucketName);let t=await y.send(new K(
+{Bucket:e.bucketName}));return{bucketName:e.bucketName,location:t.Location}},f=async(e,t)=>{
+i.logTag(n,e),await y.send(new h({Bucket:e,Tagging:{TagSet:N({...t,ManagedBy:"EZ\
+4"})}}))},B=async e=>{i.logDelete(n,e),await y.send(new v({Bucket:e}))};var d=()=>({equals:H,create:O,replace:L,preview:q,update:U,delete:A}),H=(e,t)=>!!e.
+result&&e.result.bucketName===t.result?.bucketName,q=async(e,t)=>{let r={...e.parameters,
+dependencies:e.dependencies},c={...t.parameters,dependencies:t.dependencies},o=D(
+r,c);if(o.counts)return{...o,name:r.bucketName}},L=async(e,t)=>{if(t.result)throw new I(
+n,e.entryId,t.entryId);return O(e)},O=async e=>{let t=e.parameters,r=await S(t);
+return await R(r.bucketName,t),{bucketName:r.bucketName,location:r.location}},U=async(e,t)=>{
+let r=e.result;r&&await R(r.bucketName,e.parameters)},A=async e=>{let t=e.result;
+t&&await B(t.bucketName)},R=async(e,t)=>{await f(e,t.tags??{})};import{ReplaceResourceError as Q}from"@ez4/aws-common";import{deepCompare as V}from"@ez4/utils";import{createReadStream as Z}from"node:fs";import{getTagList as $,Logger as b}from"@ez4/aws-common";
+import{DeleteObjectCommand as _,PutObjectCommand as F,PutObjectTaggingCommand as G,
+S3Client as J}from"@aws-sdk/client-s3";var s="AWS:S3/Object",p="aws:s3.object";import{basename as M}from"node:path";import{IncompleteResourceError as W}from"@ez4/aws-common";var m=e=>e.objectKey??M(e.filePath),u=(e,t)=>`${e}/${t}`,x=(e,t)=>{let r=t.getDependencies(
+a).at(0)?.result;if(!r?.bucketName)throw new W(s,e,"bucketName");return r.bucketName};var g=new J({}),j=async(e,t)=>{b.logCreate(s,u(e,t.objectKey));let r=await g.send(
+new F({Bucket:e,Key:t.objectKey,Body:Z(t.filePath),Expires:t.expires}));return{objectKey:t.
+objectKey,etag:r.ETag}},w=async(e,t,r)=>{b.logTag(s,u(e,t)),await g.send(new G({
+Bucket:e,Key:t,Tagging:{TagSet:$({...r,ManagedBy:"EZ4"})}}))},k=async(e,t)=>{b.logDelete(
+s,u(e,t)),await g.send(new _({Bucket:e,Key:t}))};var C=()=>({equals:X,create:E,replace:ee,preview:Y,update:te,delete:re}),X=(e,t)=>!!e.
+result&&e.result.objectKey===t.result?.objectKey,Y=async(e,t)=>{let r={...e.parameters,
+dependencies:e.dependencies},c={...t.parameters,dependencies:t.dependencies},o=V(
+r,c);if(o.counts)return{...o,name:m(r)}},ee=async(e,t,r)=>{if(t.result)throw new Q(
+s,e.entryId,t.entryId);return E(e,r)},E=async(e,t)=>{let r=e.parameters,c=x("buc\
+ket",t),o=m(r),l=await j(c,{...r,objectKey:o});return await T(c,o,r),{bucketName:c,
+objectKey:l.objectKey,etag:l.etag}},te=async(e,t)=>{let r=e.result;if(!r)return;
+let c=m(e.parameters),o=r.bucketName;return t.result?await ce(o,c,e.parameters,t.
+result):(await T(o,c,e.parameters),r)},re=async e=>{let t=e.result;t&&await k(t.
+bucketName,t.objectKey)},ce=async(e,t,r,c)=>{if(t===c.objectKey)return;await k(e,
+c.objectKey);let o=await j(e,{...r,objectKey:t});return{bucketName:e,objectKey:o.
+objectKey,etag:o.etag}},T=async(e,t,r)=>{await w(e,t,r.tags??{})};import{toKebabCase as oe,hashData as ae}from"@ez4/utils";import{attachEntry as se}from"@ez4/stateful";var Ae=e=>e.type===a,Me=(e,t)=>{let r=oe(t.bucketName),c=ae(a,r);return se(e,{type:a,
+entryId:c,dependencies:[],parameters:{...t,bucketName:r}})};import{attachEntry as ne}from"@ez4/stateful";import{hashData as pe}from"@ez4/utils";var Ge=e=>e.type===p,Je=(e,t,r)=>{let c=m(r),o=pe(p,t.entryId,c);return ne(e,{type:p,
+entryId:o,dependencies:[t.entryId],parameters:r})};P(a,d());P(p,C());export{n as BucketServiceName,a as BucketServiceType,s as ObjectServiceName,p as ObjectServiceType,
+Me as createBucket,Je as createBucketObject,Ae as isBucket,Ge as isBucketObject};

package/dist/object/client.d.ts

@@ -0,0 +1,13 @@
+import type { ResourceTags } from '@ez4/aws-common';
+export type CreateRequest = {
+    filePath: string;
+    objectKey: string;
+    expires?: Date;
+};
+export type CreateResponse = {
+    objectKey: string;
+    etag: string;
+};
+export declare const putObject: (bucketName: string, request: CreateRequest) => Promise<CreateResponse>;
+export declare const tagObject: (bucketName: string, objectKey: string, tags: ResourceTags) => Promise<void>;
+export declare const deleteObject: (bucketName: string, objectKey: string) => Promise<void>;

package/dist/object/handler.d.ts

@@ -0,0 +1,3 @@
+import type { StepHandler } from '@ez4/stateful';
+import type { ObjectState } from './types.js';
+export declare const getObjectHandler: () => StepHandler<ObjectState>;

package/dist/object/service.d.ts

@@ -0,0 +1,5 @@
+import type { EntryState, EntryStates } from '@ez4/stateful';
+import type { BucketState } from '../bucket/types.js';
+import type { ObjectParameters, ObjectState } from './types.js';
+export declare const isBucketObject: (resource: EntryState) => resource is ObjectState;
+export declare const createBucketObject: <E extends EntryState>(state: EntryStates<E>, bucketState: BucketState, parameters: ObjectParameters) => ObjectState;

package/dist/object/types.d.ts

@@ -0,0 +1,17 @@
+import type { EntryState } from '@ez4/stateful';
+import type { ResourceTags } from '@ez4/aws-common';
+import type { CreateRequest, CreateResponse } from './client.js';
+export declare const ObjectServiceName = "AWS:S3/Object";
+export declare const ObjectServiceType = "aws:s3.object";
+export type ObjectParameters = Omit<CreateRequest, 'objectKey'> & {
+    objectKey?: string;
+    tags?: ResourceTags;
+};
+export type ObjectResult = CreateResponse & {
+    bucketName: string;
+};
+export type ObjectState = EntryState & {
+    type: typeof ObjectServiceType;
+    parameters: ObjectParameters;
+    result?: ObjectResult;
+};

package/dist/object/utils.d.ts

@@ -0,0 +1,6 @@
+import type { EntryState, StepContext } from '@ez4/stateful';
+import type { ObjectParameters } from './types.js';
+import { BucketState } from '../bucket/types.js';
+export declare const getObjectKey: (parameters: ObjectParameters) => string;
+export declare const getObjectPath: (bucketName: string, objectKey: string) => string;
+export declare const getBucketName: <E extends EntryState>(resourceId: string, context: StepContext<E | BucketState>) => any;

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@ez4/aws-bucket",
+  "description": "EZ4: Self-managed AWS S3 buckets",
+  "version": "0.4.0",
+  "author": "Silas B.",
+  "license": "MIT",
+  "type": "module",
+  "engines": {
+    "node": ">=20.15.0"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/main.d.ts",
+      "require": "./dist/main.cjs",
+      "import": "./dist/main.mjs"
+    }
+  },
+  "workspaces": [
+    "packages/*"
+  ],
+  "scripts": {
+    "clean": "rm -f *.tsbuildinfo && rm -rf dist/*",
+    "build": "tsc -p tsconfig.json && node tools/bundler.mjs",
+    "test": "npm run test:types && node --env-file ../../local.env --test --import ../../tools/tsnode.mjs test/*.spec.ts",
+    "test:only": "npm run test:types && node --env-file ../../local.env --test-only --test --import ../../tools/tsnode.mjs test/*.spec.ts",
+    "test:types": "npm run build && tsc -p tsconfig.test.json",
+    "local:publish": "npm run build && npm run clean:registry && npm publish --registry http://localhost:4873",
+    "clean:registry": "rm -rf ../../.registry/@ez4/aws-bucket",
+    "live:publish": "npm run test && npm publish --access public"
+  },
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.614.0",
+    "@ez4/aws-common": "^0.4.0",
+    "@ez4/stateful": "^0.4.0",
+    "@ez4/utils": "^0.4.0"
+  }
+}