@contember/engine-s3-plugin 2.1.0-alpha.9 → 2.1.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contember/engine-s3-plugin",
-  "version": "2.1.0-alpha.9",
+  "version": "2.1.0-beta.2",
   "license": "Apache-2.0",
   "main": "./dist/production/index.js",
   "typings": "./dist/types/index.d.ts",
@@ -23,22 +23,27 @@
     }
   },
   "dependencies": {
-    "@contember/engine-plugins": "2.1.0-alpha.9",
-    "@contember/graphql-utils": "2.1.0-alpha.9",
-    "@contember/typesafe": "2.1.0-alpha.9",
-    "mime-types": "^2.1.35",
-    "picomatch": "^4.0.2",
-    "qs": "^6.13.0",
-    "uuid": "^11.0.5"
+    "@contember/engine-plugins": "2.1.0-beta.1",
+    "@contember/graphql-utils": "2.1.0-beta.1",
+    "@contember/typesafe": "2.1.0-beta.1",
+    "mime-types": "^3.0.2",
+    "picomatch": "^4.0.3",
+    "qs": "^6.15.0",
+    "uuid": "^13.0.0"
   },
   "devDependencies": {
-    "@types/mime-types": "^2.1.4",
-    "@types/qs": "^6.9.16",
-    "graphql": "^16.9.0"
+    "@types/mime-types": "^3.0.1",
+    "@types/qs": "^6.15.0",
+    "graphql": "^16.13.1"
   },
   "peerDependencies": {
-    "graphql": ">= 14.6.0",
-    "pg": "^8.9.0"
+    "graphql": "^16.13.1",
+    "pg": "^8.20.0"
   },
-  "type": "module"
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/contember/contember.git",
+    "directory": "packages/engine-s3-plugin"
+  }
 }

package/src/Config.ts

@@ -8,7 +8,6 @@ export enum S3Providers {
 	cloudserver = 'cloudserver',
 }
 
-
 export const s3ConfigSchema = Typesafe.intersection(
 	Typesafe.object({
 		bucket: Typesafe.string,

package/src/S3ConfigProcessor.ts

@@ -40,5 +40,4 @@ export class S3ConfigProcessor implements ConfigProcessor<Project3Config> {
 			}),
 		)
 	}
-
 }

package/src/S3ObjectAuthorizator.ts

@@ -1,4 +1,3 @@
-// eslint-disable-next-line @typescript-eslint/triple-slash-reference
 /// <reference path="../types/picomatch/index.d.ts" />
 import pm from 'picomatch'
 import { ForbiddenError } from '@contember/graphql-utils'

package/src/S3SchemaContributor.ts

@@ -33,7 +33,6 @@ export type S3SchemaAcl = Record<
 	}
 >
 
-
 export class S3SchemaContributor implements GraphQLSchemaContributor {
 	constructor(
 		private readonly s3Factory: S3ServiceFactory,
@@ -48,10 +47,7 @@ export class S3SchemaContributor implements GraphQLSchemaContributor {
 		if (!context.project.s3) {
 			return undefined
 		}
-		const rules = context.identity.projectRoles.flatMap(it =>
-			Object.entries((context.schema.acl.roles[it]?.s3 as S3SchemaAcl) || {}),
-		)
-
+		const rules = context.identity.projectRoles.flatMap(it => Object.entries((context.schema.acl.roles[it]?.s3 as S3SchemaAcl) || {}))
 
 		const uploadRules = rules.filter(([, it]) => it.upload).map(([it, val]) => ({
 			pattern: it,
@@ -61,7 +57,7 @@ export class S3SchemaContributor implements GraphQLSchemaContributor {
 			pattern: it,
 		}))
 
-		if (uploadRules.length === 0 && readRules.length == 0) {
+		if (uploadRules.length === 0 && readRules.length === 0) {
 			return undefined
 		}
 
@@ -89,7 +85,6 @@ export class S3SchemaContributor implements GraphQLSchemaContributor {
 	}
 
 	private createReadMutation(authorizator: S3ObjectAuthorizator): GraphQLFieldConfig<any, { project: Project3Config }, any> {
-
 		return {
 			type: new GraphQLNonNull(S3SignedRead),
 			args: {

package/src/S3SchemaTypes.ts

@@ -1,12 +1,4 @@
-import {
-	GraphQLEnumType,
-	GraphQLInputObjectType,
-	GraphQLInt,
-	GraphQLList,
-	GraphQLNonNull,
-	GraphQLObjectType,
-	GraphQLString,
-} from 'graphql'
+import { GraphQLEnumType, GraphQLInputObjectType, GraphQLInt, GraphQLList, GraphQLNonNull, GraphQLObjectType, GraphQLString } from 'graphql'
 
 export const S3Header = new GraphQLObjectType({
 	name: 'S3Header',
@@ -17,7 +9,8 @@ export const S3Header = new GraphQLObjectType({
 })
 
 export const S3ContentDisposition = new GraphQLEnumType({
-	name: 'S33ContentDisposition', values: {
+	name: 'S33ContentDisposition',
+	values: {
 		ATTACHMENT: {},
 		INLINE: {},
 	},

package/src/S3Service.ts

@@ -23,7 +23,6 @@ type SignedUploadUrl = {
 	method: string
 }
 
-
 export class S3Service {
 	private readonly publicBaseUrl: string
 
@@ -96,7 +95,7 @@ export class S3Service {
 		}
 	}
 
-	public getSignedReadUrl({ objectKey, expiration }: { objectKey: string; expiration: number | null}): SignedReadUrl {
+	public getSignedReadUrl({ objectKey, expiration }: { objectKey: string; expiration: number | null }): SignedReadUrl {
 		const bucket = this.config.bucket
 
 		const publicPrefix = this.formatPublicUrl('')

package/src/S3Signer.ts

@@ -32,7 +32,7 @@ export class S3Signer {
 		const nowFormatted = this.providers
 			.now()
 			.toISOString()
-			.replace(/[:\-]|\.\d{3}/g, '')
+			.replace(/[:-]|\.\d{3}/g, '')
 		const queryString = this.getQueryParams(request, nowFormatted)
 		const path = uris.basePath + '/' + request.key
 		const lines = [

package/tests/cases/authorizator.test.ts

@@ -1,4 +1,4 @@
-import { test, expect } from 'bun:test'
+import { expect, test } from 'bun:test'
 import { S3ObjectAuthorizator } from '../../src'
 
 test('required read pattern', () => {
@@ -13,7 +13,6 @@ test('required upload pattern', () => {
 	expect(() => authorizator.verifyUploadAccess({ key: 'lorem.jpg', size: null })).toThrow('Upload access forbidden for object key lorem.jpg')
 })
 
-
 test('max upload size', () => {
 	const authorizator = new S3ObjectAuthorizator([{ pattern: '**', maxSize: 1024 }], [])
 	expect(() => authorizator.verifyUploadAccess({ key: 'lorem.jpg', size: 1000 })).not.toThrow()

package/tests/cases/signRequest.test.ts

@@ -1,54 +1,82 @@
-import { test, expect } from 'bun:test'
+import { expect, test } from 'bun:test'
 import { S3ObjectAuthorizator, S3Service } from '../../src'
 
 const mocked = new Date('2021-07-02T17:22Z')
 const constantUuid = '9fce3907-ff2b-45bb-b4ce-eff5527dd315'
-const createS3Service = (bucket: string, prefix = '') => new S3Service(
-	{
-		bucket,
-		region: 'eu-central-1',
-		credentials: {
-			key: 'test',
-			secret: 'abcd',
+const createS3Service = (bucket: string, prefix = '') =>
+	new S3Service(
+		{
+			bucket,
+			region: 'eu-central-1',
+			credentials: {
+				key: 'test',
+				secret: 'abcd',
+			},
+			prefix,
 		},
-		prefix,
-	},
-	{
-		uuid: () => constantUuid,
-		now: () => mocked,
-	},
-	new S3ObjectAuthorizator([{ pattern: '**' }], [{ pattern: '**' }]),
-)
-
+		{
+			uuid: () => constantUuid,
+			now: () => mocked,
+		},
+		new S3ObjectAuthorizator([{ pattern: '**' }], [{ pattern: '**' }]),
+	)
 
 test('sign s3 request', () => {
 	const service = createS3Service('test')
 	const signed = service.getSignedReadUrl({ objectKey: 'foo.jpg', expiration: null })
-	expect(signed.url).toEqual('https://test.s3.eu-central-1.amazonaws.com/foo.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test%2F20210702%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210702T172200Z&X-Amz-Expires=3600&X-Amz-Signature=00e912fe0383066802fc6c0f93ffb223320ca143992385fe69070bbb87c758dc&X-Amz-SignedHeaders=host')
+	expect(signed.url).toEqual(
+		'https://test.s3.eu-central-1.amazonaws.com/foo.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test%2F20210702%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210702T172200Z&X-Amz-Expires=3600&X-Amz-Signature=00e912fe0383066802fc6c0f93ffb223320ca143992385fe69070bbb87c758dc&X-Amz-SignedHeaders=host',
+	)
 })
 
 test('sign s3 request - prefix', () => {
 	const service = createS3Service('test', 'lorem')
 	const signed = service.getSignedReadUrl({ objectKey: 'lorem/foo.jpg', expiration: null })
-	expect(signed.url).toEqual('https://test.s3.eu-central-1.amazonaws.com/lorem/foo.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test%2F20210702%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210702T172200Z&X-Amz-Expires=3600&X-Amz-Signature=f6c69dc306422c2b3242c9d9d42147336817720ffae249af8bd91cc7062e9f6d&X-Amz-SignedHeaders=host')
+	expect(signed.url).toEqual(
+		'https://test.s3.eu-central-1.amazonaws.com/lorem/foo.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test%2F20210702%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210702T172200Z&X-Amz-Expires=3600&X-Amz-Signature=f6c69dc306422c2b3242c9d9d42147336817720ffae249af8bd91cc7062e9f6d&X-Amz-SignedHeaders=host',
+	)
 })
 
 test('sign upload', () => {
 	const service = createS3Service('test')
-	const signed = service.getSignedUploadUrl({ contentType: 'image/jpeg', acl: 'PUBLIC_READ', expiration: 1800, contentDisposition: null, extension: null, fileName: null, prefix: null, suffix: null, size: null })
-	expect(signed.url).toEqual('https://test.s3.eu-central-1.amazonaws.com/9fce3907-ff2b-45bb-b4ce-eff5527dd315.jpeg?Cache-Control=immutable&Content-Type=image%2Fjpeg&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test%2F20210702%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210702T172200Z&X-Amz-Expires=1800&X-Amz-Signature=fcd00b967054c19a2ee64b59e31d61e032ea086dcf2f0d8c36a883971c469c99&X-Amz-SignedHeaders=cache-control%3Bhost%3Bx-amz-acl&x-amz-acl=public-read')
+	const signed = service.getSignedUploadUrl({
+		contentType: 'image/jpeg',
+		acl: 'PUBLIC_READ',
+		expiration: 1800,
+		contentDisposition: null,
+		extension: null,
+		fileName: null,
+		prefix: null,
+		suffix: null,
+		size: null,
+	})
+	expect(signed.url).toEqual(
+		'https://test.s3.eu-central-1.amazonaws.com/9fce3907-ff2b-45bb-b4ce-eff5527dd315.jpg?Cache-Control=immutable&Content-Type=image%2Fjpeg&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test%2F20210702%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210702T172200Z&X-Amz-Expires=1800&X-Amz-Signature=b4d5ce6a36e7684f1367addb3259e8361a0ef1972986c05ce01536f2fd955a32&X-Amz-SignedHeaders=cache-control%3Bhost%3Bx-amz-acl&x-amz-acl=public-read',
+	)
 })
 
 test('sign upload #2', () => {
 	const service = createS3Service('test')
-	const signed = service.getSignedUploadUrl({ contentType: 'image/jpeg', acl: 'PUBLIC_READ', expiration: 1800, contentDisposition: 'INLINE', extension: 'jpeg', fileName: 'foo-bar.jpeg', prefix: 'foo', suffix: 'bar', size: null })
-	expect(signed.url).toEqual('https://test.s3.eu-central-1.amazonaws.com/foo/9fce3907-ff2b-45bb-b4ce-eff5527dd315bar.jpeg?Cache-Control=immutable&Content-Type=image%2Fjpeg&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test%2F20210702%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210702T172200Z&X-Amz-Expires=1800&X-Amz-Signature=979a93bca65a98ce6b2bf97d2bf2afe7d5f2fa805f7d596187675416c86a3bd5&X-Amz-SignedHeaders=cache-control%3Bcontent-disposition%3Bhost%3Bx-amz-acl&x-amz-acl=public-read')
+	const signed = service.getSignedUploadUrl({
+		contentType: 'image/jpeg',
+		acl: 'PUBLIC_READ',
+		expiration: 1800,
+		contentDisposition: 'INLINE',
+		extension: 'jpeg',
+		fileName: 'foo-bar.jpeg',
+		prefix: 'foo',
+		suffix: 'bar',
+		size: null,
+	})
+	expect(signed.url).toEqual(
+		'https://test.s3.eu-central-1.amazonaws.com/foo/9fce3907-ff2b-45bb-b4ce-eff5527dd315bar.jpeg?Cache-Control=immutable&Content-Type=image%2Fjpeg&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test%2F20210702%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210702T172200Z&X-Amz-Expires=1800&X-Amz-Signature=979a93bca65a98ce6b2bf97d2bf2afe7d5f2fa805f7d596187675416c86a3bd5&X-Amz-SignedHeaders=cache-control%3Bcontent-disposition%3Bhost%3Bx-amz-acl&x-amz-acl=public-read',
+	)
 })
 
-
 test('bucket with dot', () => {
 	const service = createS3Service('test.foo')
 	const signed = service.getSignedReadUrl({ objectKey: 'foo.jpg', expiration: null })
-	expect(signed.url).toEqual('https://s3.eu-central-1.amazonaws.com/test.foo/foo.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test%2F20210702%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210702T172200Z&X-Amz-Expires=3600&X-Amz-Signature=811a809196e60413e0e54e51d3dd91ab73ad1482b61e5371864d25d43ba642ff&X-Amz-SignedHeaders=host')
+	expect(signed.url).toEqual(
+		'https://s3.eu-central-1.amazonaws.com/test.foo/foo.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=test%2F20210702%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20210702T172200Z&X-Amz-Expires=3600&X-Amz-Signature=811a809196e60413e0e54e51d3dd91ab73ad1482b61e5371864d25d43ba642ff&X-Amz-SignedHeaders=host',
+	)
 })
-

package/types/picomatch/index.d.ts

@@ -1,5 +1,5 @@
 declare module 'picomatch' {
 	export type Matcher = (subject: string) => boolean
-	export default function (pattern: string): Matcher
+	export default function(pattern: string): Matcher
 	export function makeRe(pattern: string): RegExp
 }

package/vitest.config.ts

@@ -1,3 +0,0 @@
-import { defineProject } from 'vitest/config'
-
-export default defineProject({})