ts-ag 1.0.25 → 1.0.26

package/dist/s3/object.d.ts

@@ -14,4 +14,14 @@ export declare const getObject: (bucketName: string, key: string) => ResultAsync
  * Convenience function to get an object from S3 and return it as a string.
  */
 export declare function getObjectString(bucketName: string, key: string): ResultAsync<string, typeof error_s3_get>;
+/**
+ * Checks if an object exists in an s3 bucket by retrieving the HEAD data
+ *
+ * @param {string} bucketName - The name of the S3 bucket.
+ * @param {string} key - The key of the object to retrieve.
+ * @returns {Promise<Buffer>} A promise that resolves to a boolean.
+ */
+export declare const objectExists: (bucketName: string, key: string) => ResultAsync<boolean, {
+    type: "s3_get";
+}>;
 //# sourceMappingURL=object.d.ts.map

package/dist/s3/object.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/s3/object.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,SAAS;;EAiBrB,CAAC;AAEF;;GAEG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,EAAE,OAAO,YAAY,CAAC,CAEzG"}
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../src/s3/object.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAGzC,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAE3C;;;;;;GAMG;AACH,eAAO,MAAM,SAAS;;EAiBrB,CAAC;AAEF;;GAEG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,EAAE,OAAO,YAAY,CAAC,CAEzG;AAED;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;;EAkBxB,CAAC"}

package/dist/s3/object.js

@@ -1,4 +1,4 @@
-import { GetObjectCommand } from '@aws-sdk/client-s3';
+import { HeadObjectCommand, GetObjectCommand } from '@aws-sdk/client-s3';
 import { ResultAsync } from 'neverthrow';
 import { getS3 } from './client.js';
 import { error_s3_get } from './errors.js';
@@ -30,3 +30,28 @@ export const getObject = ResultAsync.fromThrowable(async (bucketName, key) => {
 export function getObjectString(bucketName, key) {
     return getObject(bucketName, key).map((buffer) => buffer.toString('utf-8'));
 }
+/**
+ * Checks if an object exists in an s3 bucket by retrieving the HEAD data
+ *
+ * @param {string} bucketName - The name of the S3 bucket.
+ * @param {string} key - The key of the object to retrieve.
+ * @returns {Promise<Buffer>} A promise that resolves to a boolean.
+ */
+export const objectExists = ResultAsync.fromThrowable(async (bucketName, key) => {
+    const s3 = getS3();
+    try {
+        const cmd = new HeadObjectCommand({ Bucket: bucketName, Key: key });
+        const res = await s3.send(cmd);
+        return res.$metadata.httpStatusCode === 200;
+    }
+    catch (e) {
+        if (e.$metadata.httpStatusCode === 404) {
+            return false;
+        }
+        else
+            throw e;
+    }
+}, (e) => {
+    console.error(`Error getting object head from S3: ${e}`);
+    return error_s3_get;
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-ag",
-  "version": "1.0.25",
+  "version": "1.0.26",
   "description": "Useful TS stuff",
   "bugs": "https://github.com/ageorgeh/ts-ag/issues",
   "author": "Alexander Hornung",

package/src/s3/object.ts

@@ -1,4 +1,4 @@
-import { GetObjectCommand } from '@aws-sdk/client-s3';
+import { HeadObjectCommand, GetObjectCommand } from '@aws-sdk/client-s3';
 import { ResultAsync } from 'neverthrow';
 
 import { getS3 } from './client.js';
@@ -36,3 +36,30 @@ export const getObject = ResultAsync.fromThrowable(
 export function getObjectString(bucketName: string, key: string): ResultAsync<string, typeof error_s3_get> {
   return getObject(bucketName, key).map((buffer) => buffer.toString('utf-8'));
 }
+
+/**
+ * Checks if an object exists in an s3 bucket by retrieving the HEAD data
+ *
+ * @param {string} bucketName - The name of the S3 bucket.
+ * @param {string} key - The key of the object to retrieve.
+ * @returns {Promise<Buffer>} A promise that resolves to a boolean.
+ */
+export const objectExists = ResultAsync.fromThrowable(
+  async (bucketName: string, key: string) => {
+    const s3 = getS3();
+
+    try {
+      const cmd = new HeadObjectCommand({ Bucket: bucketName, Key: key });
+      const res = await s3.send(cmd);
+      return res.$metadata.httpStatusCode === 200;
+    } catch (e) {
+      if ((e as any).$metadata.httpStatusCode === 404) {
+        return false;
+      } else throw e;
+    }
+  },
+  (e) => {
+    console.error(`Error getting object head from S3: ${e}`);
+    return error_s3_get;
+  }
+);