@contember/engine-s3-plugin 2.1.0-alpha.36 → 2.1.0-alpha.39

package/dist/types/Config.d.ts

@@ -0,0 +1,33 @@
+import * as Typesafe from '@contember/typesafe';
+export declare enum S3Providers {
+    aws = "aws",
+    minio = "minio",
+    ceph = "ceph",
+    localstack = "localstack",
+    cloudserver = "cloudserver"
+}
+export declare const s3ConfigSchema: Typesafe.Type<{
+    readonly bucket: string;
+    readonly region: string;
+    readonly prefix: string;
+    readonly credentials: {
+        readonly key: string;
+        readonly secret: string;
+    };
+} & {
+    readonly endpoint?: string | undefined;
+    readonly cdnEndpoint?: string | undefined;
+    readonly provider?: S3Providers | undefined;
+    readonly noAcl?: boolean | undefined;
+}>;
+export type S3Config = ReturnType<typeof s3ConfigSchema>;
+export type Project3Config = {
+    s3?: S3Config;
+};
+export declare const resolveS3Config: (config: S3Config) => S3Config;
+export declare const resolveS3Endpoint: (config: S3Config) => {
+    endpoint: string;
+    basePath: string;
+};
+export declare const resolveS3PublicBaseUrl: (config: S3Config) => string;
+//# sourceMappingURL=Config.d.ts.map

package/dist/types/Config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAA;AAE/C,oBAAY,WAAW;IACtB,GAAG,QAAQ;IACX,KAAK,UAAU;IACf,IAAI,SAAS;IACb,UAAU,eAAe;IACzB,WAAW,gBAAgB;CAC3B;AAED,eAAO,MAAM,cAAc;;;;;;;;;;;;;EAgB1B,CAAA;AAED,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAA;AAExD,MAAM,MAAM,cAAc,GAAG;IAAE,EAAE,CAAC,EAAE,QAAQ,CAAA;CAAE,CAAA;AAK9C,eAAO,MAAM,eAAe,GAAI,QAAQ,QAAQ,KAAG,QAKlD,CAAA;AAID,eAAO,MAAM,iBAAiB,GAC7B,QAAQ,QAAQ,KACd;IACF,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;CAOhB,CAAA;AAED,eAAO,MAAM,sBAAsB,GAAI,QAAQ,QAAQ,KAAG,MAMzD,CAAA"}

package/dist/types/S3ConfigProcessor.d.ts

@@ -0,0 +1,9 @@
+import { ConfigProcessor, ConfigTemplate, ConfigTemplateContext } from '@contember/engine-plugins';
+import { Project3Config } from './Config';
+import * as Typesafe from '@contember/typesafe';
+export declare class S3ConfigProcessor implements ConfigProcessor<Project3Config> {
+    getDefaultEnv(): Record<string, string>;
+    prepareConfigTemplate(template: ConfigTemplate, { env }: ConfigTemplateContext): any;
+    getProjectConfigSchema(slug: string): Typesafe.Type<Record<string, any>>;
+}
+//# sourceMappingURL=S3ConfigProcessor.d.ts.map

package/dist/types/S3ConfigProcessor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"S3ConfigProcessor.d.ts","sourceRoot":"","sources":["../../src/S3ConfigProcessor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAA;AAClG,OAAO,EAAE,cAAc,EAAkB,MAAM,UAAU,CAAA;AACzD,OAAO,KAAK,QAAQ,MAAM,qBAAqB,CAAA;AAE/C,qBAAa,iBAAkB,YAAW,eAAe,CAAC,cAAc,CAAC;IACxE,aAAa,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAQvC,qBAAqB,CAAC,QAAQ,EAAE,cAAc,EAAE,EAAE,GAAG,EAAE,EAAE,qBAAqB;IAqB9E,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAQxE"}

package/dist/types/S3ObjectAuthorizator.d.ts

@@ -0,0 +1,22 @@
+export type S3ObjectUploadRule = {
+    pattern: string;
+    maxSize?: number;
+    matcher?: (key: string) => boolean;
+};
+export type S3ObjectReadRule = {
+    pattern: string;
+    matcher?: (key: string) => boolean;
+};
+export declare class S3ObjectAuthorizator {
+    private readonly uploadRules;
+    private readonly readRules;
+    constructor(uploadRules: Omit<S3ObjectUploadRule, 'matcher'>[], readRules: Omit<S3ObjectReadRule, 'matcher'>[]);
+    verifyReadAccess({ key }: {
+        key: string;
+    }): void;
+    verifyUploadAccess({ key, size }: {
+        key: string;
+        size: number | null;
+    }): void;
+}
+//# sourceMappingURL=S3ObjectAuthorizator.d.ts.map

package/dist/types/S3ObjectAuthorizator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"S3ObjectAuthorizator.d.ts","sourceRoot":"","sources":["../../src/S3ObjectAuthorizator.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,kBAAkB,GAAG;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAA;CAClC,CAAA;AAED,qBAAa,oBAAoB;IAChC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAsB;IAClD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;gBAG7C,WAAW,EAAE,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,EAAE,EAClD,SAAS,EAAE,IAAI,CAAC,gBAAgB,EAAE,SAAS,CAAC,EAAE;IAMxC,gBAAgB,CAAC,EAAE,GAAG,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAYhD,kBAAkB,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,IAAI;CAwBpF"}

package/dist/types/S3SchemaContributor.d.ts

@@ -0,0 +1,21 @@
+import { GraphQLSchemaConfig } from 'graphql';
+import { S3ServiceFactory } from './S3Service';
+import { GraphQLSchemaContributor, GraphQLSchemaContributorContext, Providers } from '@contember/engine-plugins';
+export type S3SchemaUploadAcl = boolean | {
+    maxSize?: number;
+};
+export type S3SchemaAcl = Record<string, // public/*.jpg
+{
+    read?: boolean;
+    upload?: S3SchemaUploadAcl;
+}>;
+export declare class S3SchemaContributor implements GraphQLSchemaContributor {
+    private readonly s3Factory;
+    private readonly providers;
+    constructor(s3Factory: S3ServiceFactory, providers: Providers);
+    getCacheKey?({ project }: GraphQLSchemaContributorContext): string;
+    createSchema(context: GraphQLSchemaContributorContext): GraphQLSchemaConfig | undefined;
+    private createReadMutation;
+    private createUploadMutation;
+}
+//# sourceMappingURL=S3SchemaContributor.d.ts.map

package/dist/types/S3SchemaContributor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"S3SchemaContributor.d.ts","sourceRoot":"","sources":["../../src/S3SchemaContributor.ts"],"names":[],"mappings":"AAAA,OAAO,EAON,mBAAmB,EAEnB,MAAM,SAAS,CAAA;AAChB,OAAO,EAAa,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAEzD,OAAO,EAAE,wBAAwB,EAAE,+BAA+B,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAShH,MAAM,MAAM,iBAAiB,GAC1B,OAAO,GACP;IACD,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAEF,MAAM,MAAM,WAAW,GAAG,MAAM,CAC/B,MAAM,EAAE,eAAe;AACvB;IACC,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,MAAM,CAAC,EAAE,iBAAiB,CAAA;CAC1B,CACD,CAAA;AAED,qBAAa,mBAAoB,YAAW,wBAAwB;IAElE,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,SAAS;gBADT,SAAS,EAAE,gBAAgB,EAC3B,SAAS,EAAE,SAAS;IAGtC,WAAW,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,+BAA+B,GAAG,MAAM;IAIlE,YAAY,CAAC,OAAO,EAAE,+BAA+B,GAAG,mBAAmB,GAAG,SAAS;IAyCvF,OAAO,CAAC,kBAAkB;IAsB1B,OAAO,CAAC,oBAAoB;CAkC5B"}

package/dist/types/S3SchemaTypes.d.ts

@@ -0,0 +1,21 @@
+import { GraphQLEnumType, GraphQLInputObjectType, GraphQLObjectType } from 'graphql';
+export declare const S3Header: GraphQLObjectType<any, any>;
+export declare const S3ContentDisposition: GraphQLEnumType;
+export type S3ContentDisposition = 'ATTACHMENT' | 'INLINE';
+export declare const S3SignedRead: GraphQLObjectType<any, any>;
+export declare const S3SignedUpload: GraphQLObjectType<any, any>;
+export declare const S3Acl: GraphQLEnumType;
+export type S3Acl = 'PUBLIC_READ' | 'PRIVATE' | 'NONE';
+export declare const S3GenerateSignedUploadInput: GraphQLInputObjectType;
+export interface S3GenerateSignedUploadInput {
+    contentType: null | string;
+    extension: null | string;
+    expiration: null | number;
+    size: null | number;
+    prefix: null | string;
+    suffix: null | string;
+    fileName: null | string;
+    contentDisposition: null | S3ContentDisposition;
+    acl: null | S3Acl;
+}
+//# sourceMappingURL=S3SchemaTypes.d.ts.map

package/dist/types/S3SchemaTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"S3SchemaTypes.d.ts","sourceRoot":"","sources":["../../src/S3SchemaTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,sBAAsB,EAA2C,iBAAiB,EAAiB,MAAM,SAAS,CAAA;AAE5I,eAAO,MAAM,QAAQ,6BAMnB,CAAA;AAEF,eAAO,MAAM,oBAAoB,iBAM/B,CAAA;AACF,MAAM,MAAM,oBAAoB,GAAG,YAAY,GAAG,QAAQ,CAAA;AAE1D,eAAO,MAAM,YAAY,6BAWvB,CAAA;AAEF,eAAO,MAAM,cAAc,6BAYzB,CAAA;AAEF,eAAO,MAAM,KAAK,iBAOhB,CAAA;AAEF,MAAM,MAAM,KAAK,GAAG,aAAa,GAAG,SAAS,GAAG,MAAM,CAAA;AAEtD,eAAO,MAAM,2BAA2B,wBAatC,CAAA;AACF,MAAM,WAAW,2BAA2B;IAC3C,WAAW,EAAE,IAAI,GAAG,MAAM,CAAA;IAC1B,SAAS,EAAE,IAAI,GAAG,MAAM,CAAA;IACxB,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IACzB,IAAI,EAAE,IAAI,GAAG,MAAM,CAAA;IACnB,MAAM,EAAE,IAAI,GAAG,MAAM,CAAA;IACrB,MAAM,EAAE,IAAI,GAAG,MAAM,CAAA;IACrB,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAA;IACvB,kBAAkB,EAAE,IAAI,GAAG,oBAAoB,CAAA;IAC/C,GAAG,EAAE,IAAI,GAAG,KAAK,CAAA;CACjB"}

package/dist/types/S3Service.d.ts

@@ -0,0 +1,44 @@
+import { S3Config } from './Config';
+import { Providers } from '@contember/engine-plugins';
+import { S3GenerateSignedUploadInput } from './S3SchemaTypes';
+import { S3ObjectAuthorizator } from './S3ObjectAuthorizator';
+type SignedReadUrl = {
+    url: string;
+    bucket: string;
+    objectKey: string;
+    headers: {
+        key: string;
+        value: string;
+    }[];
+    method: string;
+};
+type SignedUploadUrl = {
+    objectKey: string;
+    url: string;
+    bucket: string;
+    publicUrl: string;
+    headers: {
+        key: string;
+        value: string;
+    }[];
+    method: string;
+};
+export declare class S3Service {
+    readonly config: S3Config;
+    private readonly providers;
+    private readonly authorizator;
+    private readonly publicBaseUrl;
+    private readonly signer;
+    constructor(config: S3Config, providers: Pick<Providers, 'uuid' | 'now'>, authorizator: S3ObjectAuthorizator);
+    getSignedUploadUrl({ acl, contentDisposition, contentType, expiration, prefix, suffix, fileName, extension, size }: S3GenerateSignedUploadInput): SignedUploadUrl;
+    getSignedReadUrl({ objectKey, expiration }: {
+        objectKey: string;
+        expiration: number | null;
+    }): SignedReadUrl;
+    formatPublicUrl(key: string): string;
+}
+export declare class S3ServiceFactory {
+    create(config: S3Config, providers: Providers, authorizator: S3ObjectAuthorizator): S3Service;
+}
+export {};
+//# sourceMappingURL=S3Service.d.ts.map

package/dist/types/S3Service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"S3Service.d.ts","sourceRoot":"","sources":["../../src/S3Service.ts"],"names":[],"mappings":"AACA,OAAO,EAA0B,QAAQ,EAAE,MAAM,UAAU,CAAA;AAE3D,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAErD,OAAO,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAA;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D,KAAK,aAAa,GAAG;IACpB,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACzC,MAAM,EAAE,MAAM,CAAA;CACd,CAAA;AAED,KAAK,eAAe,GAAG;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IACzC,MAAM,EAAE,MAAM,CAAA;CACd,CAAA;AAED,qBAAa,SAAS;aAMJ,MAAM,EAAE,QAAQ;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,YAAY;IAP9B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAQ;IAEtC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAU;gBAGhB,MAAM,EAAE,QAAQ,EACf,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC,EAC1C,YAAY,EAAE,oBAAoB;IAM7C,kBAAkB,CACxB,EAAE,GAAG,EAAE,kBAAkB,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,2BAA2B,GAC1H,eAAe;IAwDX,gBAAgB,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,aAAa;IA+B5G,eAAe,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;CAG3C;AAED,qBAAa,gBAAgB;IACrB,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,YAAY,EAAE,oBAAoB;CAGxF"}

package/dist/types/S3Signer.d.ts

@@ -0,0 +1,22 @@
+import { S3Config } from './Config';
+import { Providers } from '@contember/engine-plugins';
+interface S3Request {
+    action: 'read' | 'upload';
+    key: string;
+    expiration: number;
+    headers: Record<string, string>;
+}
+export declare class S3Signer {
+    private readonly config;
+    private readonly providers;
+    private region;
+    constructor(config: S3Config, providers: Pick<Providers, 'now'>);
+    sign(request: S3Request): string;
+    private getQueryParams;
+    private getScope;
+    private getSignedHeaders;
+    private isHeaderSignable;
+    private getSignedHeaderNames;
+}
+export {};
+//# sourceMappingURL=S3Signer.d.ts.map

package/dist/types/S3Signer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"S3Signer.d.ts","sourceRoot":"","sources":["../../src/S3Signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,QAAQ,EAAE,MAAM,UAAU,CAAA;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAIrD,UAAU,SAAS;IAClB,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAA;IACzB,GAAG,EAAE,MAAM,CAAA;IACX,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B;AAWD,qBAAa,QAAQ;IAGR,OAAO,CAAC,QAAQ,CAAC,MAAM;IAAY,OAAO,CAAC,QAAQ,CAAC,SAAS;IAFzE,OAAO,CAAC,MAAM,CAAQ;gBAEO,MAAM,EAAE,QAAQ,EAAmB,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;IAI1F,IAAI,CAAC,OAAO,EAAE,SAAS;IA2B9B,OAAO,CAAC,cAAc;IAqBtB,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,gBAAgB;IAaxB,OAAO,CAAC,gBAAgB;IAIxB,OAAO,CAAC,oBAAoB;CAO5B"}

package/dist/types/index.d.ts

@@ -0,0 +1,13 @@
+import { Plugin, SchemaContributorArgs } from '@contember/engine-plugins';
+import { S3ConfigProcessor } from './S3ConfigProcessor';
+import { S3SchemaContributor } from './S3SchemaContributor';
+import { Project3Config } from './Config';
+export * from './S3ObjectAuthorizator';
+export * from './S3SchemaContributor';
+export * from './S3Service';
+export default class S3 implements Plugin<Project3Config> {
+    name: string;
+    getConfigProcessor(): S3ConfigProcessor;
+    getSchemaContributor({ providers }: SchemaContributorArgs): S3SchemaContributor;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAA;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAE3D,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAEzC,cAAc,wBAAwB,CAAA;AACtC,cAAc,uBAAuB,CAAA;AACrC,cAAc,aAAa,CAAA;AAE3B,MAAM,CAAC,OAAO,OAAO,EAAG,YAAW,MAAM,CAAC,cAAc,CAAC;IACxD,IAAI,SAAiB;IAErB,kBAAkB;IAIlB,oBAAoB,CAAC,EAAE,SAAS,EAAE,EAAE,qBAAqB;CAIzD"}