Upgrade npm dependencies to latest compatible versions.

.github/workflows/release-npm.yml

@@ -7,13 +7,13 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          node-version: '16.x'
+          node-version: '22.x'
           registry-url: 'https://registry.npmjs.org'
       - name: Set up Ruby
-        uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7
       - name: Install ImageMagick

.github/workflows/tests.yml

@@ -15,17 +15,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [16.x]
+        node-version: [20.x, 22.x]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@359bebbc29cbe6c87da6bc9ea3bc930432750108
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7
 

.mocharc.json

@@ -1,2 +1,4 @@
 {
+  "node-option": ["import=tsx"],
+  "spec": ["tests/helpers.ts", "tests/**/*.spec.ts"]
 }

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:16-alpine as builder
+FROM node:20-alpine as builder
 
 WORKDIR /home/app
 

eslint.config.js

@@ -0,0 +1,84 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import globals from 'globals';
+import noOnlyTests from 'eslint-plugin-no-only-tests';
+import chaiFriendly from 'eslint-plugin-chai-friendly';
+
+const consoleLogRule = process.env.NODE_ENV === 'production' ? ['error', { allow: ['warn', 'error'] }] : ['warn'];
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    plugins: {
+      'no-only-tests': noOnlyTests,
+      'chai-friendly': chaiFriendly,
+    },
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.mocha,
+        ...globals.es2021,
+      },
+      parserOptions: {
+        sourceType: 'module',
+      },
+    },
+    rules: {
+      // Rules from @enspirit/eslint-config-node
+      'prefer-template': 'warn',
+      'template-curly-spacing': ['error', 'never'],
+      'curly': 'error',
+      'prefer-arrow-callback': 'warn',
+      'no-useless-escape': 'warn',
+      'eqeqeq': 'error',
+      'no-multi-spaces': ['warn', {
+        exceptions: {
+          'Property': true,
+          'VariableDeclarator': true,
+          'ImportDeclaration': true,
+        },
+      }],
+      'indent': ['error', 2, { SwitchCase: 1 }],
+      'linebreak-style': ['error', 'unix'],
+      'quotes': ['error', 'single', { avoidEscape: true }],
+      'semi': ['error', 'always'],
+      'no-var': ['error'],
+      'prefer-const': ['error'],
+      'no-console': consoleLogRule,
+      'no-debugger': 'error',
+      'no-unused-expressions': 'off',
+      '@typescript-eslint/no-unused-expressions': 'off',
+      'chai-friendly/no-unused-expressions': ['error'],
+      'array-bracket-spacing': ['error', 'never'],
+      'object-curly-spacing': ['error', 'always'],
+      'space-before-function-paren': ['error', {
+        anonymous: 'never',
+        named: 'never',
+        asyncArrow: 'always',
+      }],
+      'space-before-blocks': ['error', 'always'],
+      'keyword-spacing': ['error', { before: true, after: true }],
+      'space-infix-ops': ['error', { int32Hint: false }],
+      'space-in-parens': ['error', 'never'],
+      'arrow-spacing': ['error', { before: true, after: true }],
+      'no-multiple-empty-lines': ['error', { max: 1 }],
+      'no-const-assign': ['error'],
+      'comma-dangle': ['error', 'always-multiline'],
+      'no-only-tests/no-only-tests': process.env.NODE_ENV === 'test' ? 'error' : 'warn',
+
+      // TypeScript overrides
+      'no-unused-vars': 'off',
+      '@typescript-eslint/no-unused-vars': ['error', {
+        argsIgnorePattern: '^_',
+        varsIgnorePattern: '^_',
+        caughtErrorsIgnorePattern: '^_',
+      }],
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-namespace': 'off',
+    },
+  },
+  {
+    ignores: ['dist/**', 'node_modules/**'],
+  },
+);

examples/actions.ts

@@ -1,8 +1,8 @@
 import { Express } from 'express';
-import { createApp, LocalBucket, S3Bucket } from '../src';
-import { MkdirAction, DownloadArchiveAction, CleanupTTL } from '../src/actions';
-import { ExecuteActions, MultipartUpload, RetrieveObjects } from '../src/';
-import { s3client } from './s3';
+import { createApp, LocalBucket, S3Bucket } from '../src/index.js';
+import { MkdirAction, DownloadArchiveAction, CleanupTTL } from '../src/actions/index.js';
+import { ExecuteActions, MultipartUpload, RetrieveObjects } from '../src/index.js';
+import { s3client } from './s3.js';
 
 /**
  * This example shows how actions can be executed on a bucket.

examples/authentication.ts

@@ -1,6 +1,6 @@
 import { Express, NextFunction, Request, Response } from 'express';
-import { createApp, S3Bucket } from '../src';
-import { s3client } from './s3';
+import { createApp, S3Bucket } from '../src/index.js';
+import { s3client } from './s3.js';
 
 /**
  * This simple example shows how you can setup a middleware to

examples/cacheControl.ts

@@ -1,5 +1,5 @@
 import { Express } from 'express';
-import { createApp, DeleteObjects, LocalBucket, MultipartUpload, RetrieveObjects } from '../src';
+import { createApp, DeleteObjects, LocalBucket, MultipartUpload, RetrieveObjects } from '../src/index.js';
 
 /**
  * This simple example shows how to override the default

examples/clamav.ts

@@ -1,7 +1,7 @@
 import { Express } from 'express';
-import { createApp, LocalBucket, S3Bucket } from '../src';
-import { ClamavScanner } from '../src/transformers';
-import { s3client } from './s3';
+import { createApp, LocalBucket, S3Bucket } from '../src/index.js';
+import { ClamavScanner } from '../src/transformers/index.js';
+import { s3client } from './s3.js';
 
 /**
  * This example shows how a bucket can use the clamav transformer

examples/gcs.ts

@@ -1,5 +1,5 @@
 import { Express } from 'express';
-import { createApp, GCSBucket } from '../src';
+import { createApp, GCSBucket } from '../src/index.js';
 import { Storage } from '@google-cloud/storage';
 
 /**

examples/gzip.ts

@@ -1,7 +1,7 @@
 import { Express } from 'express';
-import { createApp, S3Bucket } from '../src';
-import { ObjectCompressor } from '../src/transformers';
-import { s3client } from './s3';
+import { createApp, S3Bucket } from '../src/index.js';
+import { ObjectCompressor } from '../src/transformers/index.js';
+import { s3client } from './s3.js';
 
 /**
  * This simple example shows how a bucket can use object transformers.

examples/index.ts

@@ -1,21 +1,21 @@
 import express, { NextFunction, Request, Response } from 'express';
 
-import localExample from './local';
-import s3example from './s3';
-import gcsexample from './gcs';
-import gzipExample from './gzip';
-import authenticationExample from './authentication';
-import readOnlyExample from './readonly';
-import renameExample from './rename';
-import thumbnailsExample from './thumbnails';
-import thumbnailsOnTheFlyExample from './thumbnails-on-the-fly';
-import actionsExample from './actions';
-import sseExample from './sse-c';
-import clamavExample from './clamav';
-import cacheControlExample from './cacheControl';
+import localExample from './local.js';
+import s3example from './s3.js';
+import gcsexample from './gcs.js';
+import gzipExample from './gzip.js';
+import authenticationExample from './authentication.js';
+import readOnlyExample from './readonly.js';
+import renameExample from './rename.js';
+import thumbnailsExample from './thumbnails.js';
+import thumbnailsOnTheFlyExample from './thumbnails-on-the-fly.js';
+import actionsExample from './actions.js';
+import sseExample from './sse-c.js';
+import clamavExample from './clamav.js';
+import cacheControlExample from './cacheControl.js';
 
-import { version } from '../src';
-import logger from '../src/logger';
+import { version } from '../src/index.js';
+import logger from '../src/logger.js';
 
 const app = express();
 app.set('etag', 'strong');

examples/local.ts

@@ -1,5 +1,5 @@
 import { Express } from 'express';
-import { createApp, LocalBucket } from '../src';
+import { createApp, LocalBucket } from '../src/index.js';
 
 /**
  * This simple example shows how to add a seshat endpoint

examples/readonly.ts

@@ -1,6 +1,6 @@
 import { Express } from 'express';
-import { createApp, LocalBucket } from '../src';
-import { ReadOnlyPolicy } from '../src';
+import { createApp, LocalBucket } from '../src/index.js';
+import { ReadOnlyPolicy } from '../src/index.js';
 
 /**
  * This simple example shows how a bucket can use policies to allow/disallow actions.

examples/rename.ts

@@ -1,7 +1,7 @@
 import { Express } from 'express';
-import { createApp, S3Bucket } from '../src';
-import { SecureRename } from '../src/transformers';
-import { s3client } from './s3';
+import { createApp, S3Bucket } from '../src/index.js';
+import { SecureRename } from '../src/transformers/index.js';
+import { s3client } from './s3.js';
 
 /**
  * This simple example shows how a bucket can use policies to allow/disallow actions.

examples/s3.ts

@@ -1,5 +1,5 @@
 import { Express } from 'express';
-import { createApp, S3Bucket } from '../src';
+import { createApp, S3Bucket } from '../src/index.js';
 import { S3Client } from '@aws-sdk/client-s3';
 
 /**

examples/sse-c.ts

@@ -1,5 +1,5 @@
 import { Express } from 'express';
-import { createApp, S3Bucket } from '../src';
+import { createApp, S3Bucket } from '../src/index.js';
 import { S3Client } from '@aws-sdk/client-s3';
 
 /**

examples/thumbnails-on-the-fly.ts

@@ -1,10 +1,10 @@
 import { Express } from 'express';
-import { createApp, S3Bucket } from '../src';
-import { SharpTransformer } from '../src/transformers/sharp';
-import { s3client } from './s3';
+import { createApp, S3Bucket } from '../src/index.js';
+import { SharpTransformer } from '../src/transformers/sharp.js';
+import { s3client } from './s3.js';
 
 // Reuse the policy from the other example
-import { imagesOnlyPolicy } from './thumbnails';
+import { imagesOnlyPolicy } from './thumbnails.js';
 
 /**
  * This example is similar to the 'thumbnails' example as it combines a custom policy

examples/thumbnails.ts

@@ -1,7 +1,7 @@
 import { Express } from 'express';
-import { BucketPolicy, BucketPolicyError, createApp, ObjectMeta, S3Bucket } from '../src';
-import { SharpTransformer } from '../src/transformers/sharp';
-import { s3client } from './s3';
+import { type BucketPolicy, BucketPolicyError, createApp, type ObjectMeta, S3Bucket } from '../src/index.js';
+import { SharpTransformer } from '../src/transformers/sharp.js';
+import { s3client } from './s3.js';
 
 export const imagesOnlyPolicy: BucketPolicy = {
   async head(_path: string) {

formaldoc/test-suite/bucket-storages/gcs/_prefix/get.yml

@@ -17,7 +17,7 @@
 
     input_schema: |-
       {
-        prefix : String
+        prefix : String|Nil
       }
 
     output_schema: |-
@@ -31,7 +31,7 @@
       - description: |-
           FOR: the root prefix exists
         params:
-          prefix: /
+          prefix:
         expected:
           content_type: application/json
           status: 200

formaldoc/test-suite/bucket-storages/s3/_prefix/get.yml

@@ -17,7 +17,7 @@
 
     input_schema: |-
       {
-        prefix : String
+        prefix : String|Nil
       }
 
     output_schema: |-
@@ -31,7 +31,7 @@
       - description: |-
           FOR: the root prefix exists
         params:
-          prefix: /
+          prefix:
         expected:
           content_type: application/json
           status: 200