@openfn/language-aws-s3 1.0.0

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@openfn/language-aws-s3",
+  "version": "1.0.0",
+  "description": "OpenFn aws-s3 adaptor",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./types/index.d.ts",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "author": "Open Function Group",
+  "license": "LGPLv3",
+  "files": [
+    "dist/",
+    "types/",
+    "ast.json",
+    "configuration-schema.json"
+  ],
+  "dependencies": {
+    "@openfn/language-common": "3.2.3"
+  },
+  "optionalDependencies": {
+    "@aws-sdk/client-s3": "^3.500.0"
+  },
+  "devDependencies": {
+    "assertion-error": "2.0.0",
+    "chai": "4.3.6",
+    "aws-sdk-client-mock": "^4.1.0",
+    "deep-eql": "4.1.1",
+    "mocha": "^10.7.3",
+    "rimraf": "3.0.2",
+    "undici": "^5.22.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/openfn/adaptors.git"
+  },
+  "types": "types/index.d.ts",
+  "main": "dist/index.cjs",
+  "scripts": {
+    "build": "pnpm clean && build-adaptor aws-s3",
+    "test": "mocha --experimental-specifier-resolution=node --no-warnings",
+    "test:watch": "mocha -w --experimental-specifier-resolution=node --no-warnings",
+    "clean": "rimraf dist types docs",
+    "pack": "pnpm pack --pack-destination ../../dist",
+    "lint": "eslint src"
+  }
+}

package/types/Adaptor.d.ts

@@ -0,0 +1,83 @@
+/**
+ * S3 operation input params used by `put`, `get`, and `list`.
+ * @typedef {Object} S3Params
+ * @property {string} key - Object key for `put`/`get` (required for those ops)
+ * @property {any} [body] - Body for `put` (string, Buffer, or stream)
+ * @property {string} [bucket] - S3 bucket name (overrides configuration value)
+ * @property {string} [contentType] - Optional content type for `put`
+ * @property {string} [prefix] - Prefix for `list` operation
+ * @property {number} [maxKeys] - Max keys for `list`
+ * @property {string} [continuationToken] - Continuation token for `list` pagination
+ */
+/**
+ * Put an object into S3.
+ *
+ * @example
+ * put({ bucket: 'my-bucket', key: 'path/to/file.txt', body: 'hello' });
+ *
+ * @public
+ * @param {S3Params} params - The S3 operation parameters (bucket. key, body, contentType, etc.)
+ * @returns {Operation} - A function that takes the state and performs the put operation.
+ */
+export function put(params: S3Params): Operation;
+/**
+ * List objects in a bucket (by prefix).
+ *
+ * @example
+ * list({ bucket: 'my-bucket', prefix: 'path/to/' });
+ *
+ * @public
+ * @param {S3Params} params - The S3 operation parameters (bucket, prefix, etc.)
+ * @returns {Operation} - A function that takes the state and performs the list operation.
+ * @state {Object} state - On success sets `state.data` to the list of objects and `state.response` to the raw S3 response metadata.
+ */
+export function list(params?: S3Params): Operation;
+/**
+ * Get an object from S3.
+ *
+ * Attempts to parse JSON objects automatically into `state.data`. For binary
+ * objects the adaptor returns base64 in `state.data.base64`.
+ *
+ * @example
+ * get({ bucket: 'my-bucket', key: 'path/to/file.txt' });
+ *
+ * @public
+ * @param {S3Params} params - The S3 operation parameters (bucket, key).
+ * @returns {Operation} - A function that takes the state and performs the get operation.
+ * @state {Object} state - On success sets `state.data` to the parsed body (or `{ base64: '...' }`) and `state.response` to the raw response metadata.
+ */
+export function get(params: S3Params): Operation;
+/**
+ * S3 operation input params used by `put`, `get`, and `list`.
+ */
+export type S3Params = {
+    /**
+     * - Object key for `put`/`get` (required for those ops)
+     */
+    key: string;
+    /**
+     * - Body for `put` (string, Buffer, or stream)
+     */
+    body?: any;
+    /**
+     * - S3 bucket name (overrides configuration value)
+     */
+    bucket?: string;
+    /**
+     * - Optional content type for `put`
+     */
+    contentType?: string;
+    /**
+     * - Prefix for `list` operation
+     */
+    prefix?: string;
+    /**
+     * - Max keys for `list`
+     */
+    maxKeys?: number;
+    /**
+     * - Continuation token for `list` pagination
+     */
+    continuationToken?: string;
+};
+export { as, combine, cursor, dataPath, dataValue, dateFns, each, field, fields, fn, fnIf, group, lastReferenceValue, map, merge, scrubEmojis, sourceValue, util } from "@openfn/language-common";

package/types/Utils.d.ts

@@ -0,0 +1,14 @@
+export function prepareNextState(state: any, response: any): any;
+export function s3ClientFromConfig(configuration?: {}): S3Client;
+export function streamToBuffer(stream: any): Promise<Buffer>;
+export function prepareS3GetResponse(response: any): Promise<any>;
+export function preparePutResponse(response: any, Bucket: any, Key: any): {
+    body: {
+        bucket: any;
+        key: any;
+        etag: any;
+    };
+    headers: any;
+    statusCode: number;
+};
+import { S3Client } from "@aws-sdk/client-s3/dist-types/S3Client";

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export default Adaptor;
+export * from "./Adaptor";
+import * as Adaptor from "./Adaptor";