@openstax/ts-utils 1.34.0 → 1.35.0

package/dist/esm/services/documentStore/versioned/dynamodb.js

@@ -0,0 +1,139 @@
+import { DynamoDB, PutItemCommand, QueryCommand, ScanCommand } from '@aws-sdk/client-dynamodb';
+import { once } from '../../..';
+import { resolveConfigValue } from '../../../config';
+import { ifDefined } from '../../../guards';
+import { decodeDynamoDocument, encodeDynamoAttribute, encodeDynamoDocument } from '../dynamoEncoding';
+// i'm not really excited about getAuthor being required, but ts is getting confused about the type when unspecified
+export const dynamoVersionedDocumentStore = (initializer) => {
+    const init = ifDefined(initializer, {});
+    const dynamodb = once(() => { var _a; return (_a = init.dynamoClient) !== null && _a !== void 0 ? _a : new DynamoDB({ apiVersion: '2012-08-10' }); });
+    return () => (configProvider) => (_, hashKey, options) => {
+        const tableName = once(() => resolveConfigValue(configProvider[ifDefined(init.configSpace, 'dynamodb')].tableName));
+        return {
+            loadAllDocumentsTheBadWay: async () => {
+                const loadAllResults = async (ExclusiveStartKey) => {
+                    var _a;
+                    const cmd = new ScanCommand({ TableName: await tableName(), ExclusiveStartKey });
+                    const result = await dynamodb().send(cmd);
+                    const resultItems = ((_a = result.Items) === null || _a === void 0 ? void 0 : _a.map(decodeDynamoDocument)) || [];
+                    if (result.LastEvaluatedKey) {
+                        return [...resultItems, ...await loadAllResults(result.LastEvaluatedKey)];
+                    }
+                    return resultItems;
+                };
+                const allResults = await loadAllResults().then(results => results.reduce((result, document) => {
+                    const current = result.get(document[hashKey]);
+                    if (!current || current.timestamp < document.timestamp) {
+                        return result.set(document[hashKey], document);
+                    }
+                    return result;
+                }, new Map()));
+                return Array.from(allResults.values());
+            },
+            getVersions: async (id, startVersion) => {
+                const cmd = new QueryCommand({
+                    TableName: await tableName(),
+                    KeyConditionExpression: '#hk = :hkv',
+                    ExpressionAttributeValues: {
+                        ':hkv': encodeDynamoAttribute(id)
+                    },
+                    ExpressionAttributeNames: {
+                        '#hk': hashKey.toString()
+                    },
+                    ...(startVersion
+                        ? { ExclusiveStartKey: {
+                                [hashKey]: encodeDynamoAttribute(id),
+                                timestamp: { N: startVersion.toString() }
+                            } }
+                        : {}),
+                    ScanIndexForward: false,
+                });
+                return dynamodb().send(cmd).then(result => {
+                    var _a;
+                    const items = (_a = result.Items) === null || _a === void 0 ? void 0 : _a.map(decodeDynamoDocument);
+                    if (!items || items.length === 0) {
+                        return undefined;
+                    }
+                    return {
+                        items,
+                        nextPageToken: result.LastEvaluatedKey ? decodeDynamoDocument(result.LastEvaluatedKey).timestamp : undefined
+                    };
+                });
+            },
+            getItem: async (id, timestamp) => {
+                let keyConditionExpression = '#hk = :hkv';
+                const expressionAttributeNames = {
+                    '#hk': hashKey.toString()
+                };
+                const expressionAttributeValues = {
+                    ':hkv': encodeDynamoAttribute(id)
+                };
+                if (timestamp) {
+                    keyConditionExpression += ' and #ts = :tsv';
+                    expressionAttributeNames['#ts'] = 'timestamp';
+                    expressionAttributeValues[':tsv'] = encodeDynamoAttribute(timestamp);
+                }
+                const cmd = new QueryCommand({
+                    TableName: await tableName(),
+                    KeyConditionExpression: keyConditionExpression,
+                    ExpressionAttributeNames: expressionAttributeNames,
+                    ExpressionAttributeValues: expressionAttributeValues,
+                    ScanIndexForward: false,
+                    Limit: 1
+                });
+                return dynamodb().send(cmd).then(result => {
+                    var _a;
+                    return (_a = result.Items) === null || _a === void 0 ? void 0 : _a.map(decodeDynamoDocument)[0];
+                });
+            },
+            /* prepares a new version of a document with the given data, then allows some additional
+             * changes to be input to a `save` function that actually saves it. useful for additional
+             * changes based on the new document version or author. the document version and author
+             * cannot be modified */
+            prepareItem: async (item, ...authorArgs) => {
+                // this getAuthor type is terrible
+                const author = (options === null || options === void 0 ? void 0 : options.getAuthor) ? await options.getAuthor(...authorArgs) : authorArgs[0];
+                const timestamp = new Date().getTime();
+                return {
+                    document: { ...item, timestamp, author },
+                    save: async (changes) => {
+                        var _a;
+                        const document = {
+                            ...item,
+                            ...changes,
+                            timestamp,
+                            author
+                        };
+                        const cmd = new PutItemCommand({
+                            TableName: await tableName(),
+                            Item: encodeDynamoDocument(document),
+                        });
+                        const updatedDoc = await dynamodb().send(cmd)
+                            .then(() => document);
+                        await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, updatedDoc));
+                        return updatedDoc;
+                    }
+                };
+            },
+            /* saves a new version of a document with the given data */
+            putItem: async (item, ...authorArgs) => {
+                var _a;
+                // this getAuthor type is terrible
+                const author = (options === null || options === void 0 ? void 0 : options.getAuthor) ? await options.getAuthor(...authorArgs) : authorArgs[0];
+                const document = {
+                    ...item,
+                    timestamp: new Date().getTime(),
+                    author
+                };
+                const cmd = new PutItemCommand({
+                    TableName: await tableName(),
+                    Item: encodeDynamoDocument(document),
+                });
+                const updatedDoc = await dynamodb().send(cmd)
+                    .then(() => document);
+                await ((_a = options === null || options === void 0 ? void 0 : options.afterWrite) === null || _a === void 0 ? void 0 : _a.call(options, updatedDoc));
+                return updatedDoc;
+            },
+        };
+    };
+};

package/dist/esm/services/documentStore/versioned/file-system.d.ts

@@ -0,0 +1,25 @@
+import { Config } from '..';
+import { ConfigProviderForConfig } from '../../../config';
+import { VersionedDocumentAuthor, VersionedTDocument } from '.';
+interface Initializer<C> {
+    dataDir: string;
+    fs?: Pick<typeof import('fs'), 'mkdir' | 'readdir' | 'readFile' | 'writeFile'>;
+    configSpace?: C;
+}
+export declare const fileSystemVersionedDocumentStore: <C extends string = "fileSystem">(initializer: Initializer<C>) => <T extends VersionedTDocument<T>>() => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => <K extends keyof T, A extends undefined | ((...a: any[]) => Promise<VersionedDocumentAuthor>)>(_: {}, hashKey: K, options?: {
+    getAuthor?: A;
+    skipAssert?: boolean;
+}) => {
+    loadAllDocumentsTheBadWay: () => Promise<T[]>;
+    getVersions: (id: T[K], startVersion?: number) => Promise<{
+        items: T[];
+        nextPageToken: number | undefined;
+    } | undefined>;
+    getItem: (id: T[K], timestamp?: number) => Promise<T | undefined>;
+    prepareItem: (item: Omit<T, "timestamp" | "author">, ...authorArgs: A extends Function ? Parameters<A> : [VersionedDocumentAuthor]) => Promise<{
+        document: T;
+        save: (changes?: Partial<Omit<T, "timestamp" | "author">>) => Promise<T>;
+    }>;
+    putItem: (item: Omit<T, "timestamp" | "author">, ...authorArgs: A extends Function ? Parameters<A> : [VersionedDocumentAuthor]) => Promise<T>;
+};
+export {};

package/dist/esm/services/documentStore/versioned/file-system.js

@@ -0,0 +1,69 @@
+import { assertNoUndefined } from '../fileSystemAssert';
+import { fileSystemUnversionedDocumentStore } from '../unversioned/file-system';
+const PAGE_LIMIT = 5;
+export const fileSystemVersionedDocumentStore = (initializer) => () => (configProvider) => (_, hashKey, options) => {
+    var _a;
+    const skipAssert = (_a = options === null || options === void 0 ? void 0 : options.skipAssert) !== null && _a !== void 0 ? _a : false;
+    const unversionedDocuments = fileSystemUnversionedDocumentStore(initializer)()(configProvider)({}, 'id', { skipAssert });
+    return {
+        loadAllDocumentsTheBadWay: () => {
+            return unversionedDocuments.loadAllDocumentsTheBadWay().then(documents => documents.map(document => {
+                return document.items[document.items.length - 1];
+            }));
+        },
+        getVersions: async (id, startVersion) => {
+            if (!skipAssert)
+                assertNoUndefined(id, ['id']);
+            const item = await unversionedDocuments.getItem(id);
+            const versions = item === null || item === void 0 ? void 0 : item.items.reverse();
+            if (!versions) {
+                return undefined;
+            }
+            const startIndex = startVersion ? versions.findIndex(version => version.timestamp === startVersion) + 1 : 0;
+            const items = versions.slice(startIndex, startIndex + PAGE_LIMIT);
+            const hasMore = (startIndex + 5) < versions.length;
+            return {
+                items,
+                nextPageToken: hasMore ? items[items.length - 1].timestamp : undefined
+            };
+        },
+        getItem: async (id, timestamp) => {
+            if (!skipAssert)
+                assertNoUndefined(id, ['id']);
+            const item = await unversionedDocuments.getItem(id);
+            if (timestamp) {
+                return item === null || item === void 0 ? void 0 : item.items.find(version => version.timestamp === timestamp);
+            }
+            return item ? item.items[item.items.length - 1] : undefined;
+        },
+        prepareItem: async (item, ...authorArgs) => {
+            // this getAuthor type is terrible
+            const author = (options === null || options === void 0 ? void 0 : options.getAuthor) ? await options.getAuthor(...authorArgs) : authorArgs[0];
+            const timestamp = new Date().getTime();
+            return {
+                document: { ...item, timestamp, author },
+                save: async (changes) => {
+                    var _a;
+                    const document = { ...item, ...changes, timestamp, author };
+                    if (!skipAssert)
+                        assertNoUndefined(document);
+                    const container = (_a = await unversionedDocuments.getItem(document[hashKey])) !== null && _a !== void 0 ? _a : { id: document[hashKey], items: [] };
+                    const updated = { ...container, items: [...container.items, document] };
+                    await unversionedDocuments.putItem(updated);
+                    return document;
+                }
+            };
+        },
+        putItem: async (item, ...authorArgs) => {
+            var _a;
+            const author = (options === null || options === void 0 ? void 0 : options.getAuthor) ? await options.getAuthor(...authorArgs) : authorArgs[0];
+            const document = { ...item, timestamp: new Date().getTime(), author };
+            if (!skipAssert)
+                assertNoUndefined(document);
+            const container = (_a = await unversionedDocuments.getItem(document[hashKey])) !== null && _a !== void 0 ? _a : { id: document[hashKey], items: [] };
+            const updated = { ...container, items: [...container.items, document] };
+            await unversionedDocuments.putItem(updated);
+            return document;
+        },
+    };
+};

package/dist/esm/services/documentStore/versioned/index.d.ts

@@ -0,0 +1,17 @@
+import { TDocument } from '..';
+import { dynamoVersionedDocumentStore } from './dynamodb';
+export type VersionedDocumentAuthor = {
+    type: 'user';
+    uuid: string;
+    name: string;
+    reason?: string;
+} | {
+    type: 'system';
+    reason: string;
+};
+export type VersionedDocumentRequiredFields = {
+    timestamp: number;
+    author: VersionedDocumentAuthor;
+};
+export type VersionedTDocument<T> = TDocument<T> & VersionedDocumentRequiredFields;
+export type VersionedDocumentStoreCreator = typeof dynamoVersionedDocumentStore;

package/dist/esm/services/documentStore/versioned/index.js

@@ -0,0 +1 @@
+export {};

package/dist/esm/services/exercisesGateway/index.d.ts

@@ -0,0 +1,67 @@
+import { ConfigProviderForConfig } from '../../config';
+import { GenericFetch } from '../../fetch';
+export type Config = {
+    defaultCorrectness?: string;
+    exercisesHost: string;
+    exercisesAuthToken: string;
+};
+interface Initializer<C> {
+    configSpace?: C;
+    fetch: GenericFetch;
+}
+export type Answer = {
+    id: number;
+    content_html: string;
+    correctness?: string;
+    feedback_html?: string;
+};
+export type Solution = {
+    images: any[];
+    solution_type: string;
+    content_html: string;
+};
+export type Question = {
+    id: number;
+    is_answer_order_important: boolean;
+    stimulus_html: string;
+    stem_html: string;
+    answers: Answer[];
+    hints: string[];
+    formats: string[];
+    combo_choices: any[];
+    collaborator_solutions?: Solution[];
+    community_solutions?: Solution[];
+};
+export type Exercise = {
+    images: any[];
+    tags: string[];
+    uuid: string;
+    group_uuid: string;
+    number: number;
+    version: number;
+    uid: string;
+    published_at: string;
+    solutions_are_public: boolean;
+    authors: any[];
+    copyright_holders: any[];
+    derived_from: any[];
+    is_vocab: boolean;
+    questions: Question[];
+    delegations: any[];
+    versions: number[];
+    stimulus_html: string;
+};
+export type ExercisesSearchResults = {
+    total_count: number;
+    items: Exercise[];
+};
+export type ExercisesSearchResultsWithDigest = ExercisesSearchResults & {
+    digest: string;
+};
+export declare const exercisesGateway: <C extends string = "exercises">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => (_: {}) => {
+    searchDigest: (query: string, page?: number, per_page?: number) => Promise<string>;
+    get: (uuid: string) => Promise<Exercise | undefined>;
+    search: (query: string, page?: number, per_page?: number) => Promise<ExercisesSearchResultsWithDigest>;
+};
+export type ExercisesGateway = ReturnType<ReturnType<ReturnType<typeof exercisesGateway>>>;
+export {};

package/dist/esm/services/exercisesGateway/index.js

@@ -0,0 +1,70 @@
+import * as queryString from 'query-string';
+import { once } from '../..';
+import { assertString } from '../../assertions';
+import { resolveConfigValue } from '../../config';
+import { ifDefined } from '../../guards';
+import { METHOD } from '../../routing';
+export const exercisesGateway = (initializer) => (configProvider) => {
+    const config = configProvider[ifDefined(initializer.configSpace, 'exercises')];
+    const exercisesHost = once(() => resolveConfigValue(config.exercisesHost));
+    const exercisesAuthToken = once(() => resolveConfigValue(config.exercisesAuthToken));
+    const defaultCorrectness = once(() => resolveConfigValue(config.defaultCorrectness || ''));
+    const doDefaultCorrectness = async (exercise) => {
+        if (await defaultCorrectness() !== 'true') {
+            return exercise;
+        }
+        for (const question of exercise.questions) {
+            const existingCorrect = question.answers.find(answer => answer.correctness !== undefined);
+            if (question.answers.length < 1 || existingCorrect) {
+                continue;
+            }
+            const defaultCorrectIndex = question.id % question.answers.length;
+            const defaultCorrect = question.answers[defaultCorrectIndex];
+            const defaultHint = `<em>random default: the correct answer is ${defaultCorrect.id}: ${defaultCorrect.content_html.slice(0, 20)}</em>`;
+            question.stem_html += `\n<br>${defaultHint}`;
+            question.collaborator_solutions = [
+                { solution_type: 'detailed', images: [], content_html: defaultHint }
+            ];
+            for (let index = 0; index < question.answers.length; index++) {
+                const answer = question.answers[index];
+                answer.correctness = defaultCorrectIndex === index ? '1.0' : '0.0';
+                answer.feedback_html = defaultCorrectIndex === index ? 'This is the good one!' : defaultHint;
+            }
+        }
+        return exercise;
+    };
+    return (_) => {
+        const request = async (method, path, query = undefined) => {
+            const host = (await exercisesHost()).replace(/\/+$/, '');
+            const baseUrl = `${host}/api/${path}`;
+            const url = query ? `${baseUrl}?${queryString.stringify(query)}` : baseUrl;
+            return initializer.fetch(url, {
+                headers: {
+                    Authorization: `Bearer ${await exercisesAuthToken()}`,
+                },
+                method,
+            });
+        };
+        const searchDigest = async (query, page = 1, per_page = 100) => {
+            const response = await request(METHOD.HEAD, 'exercises', { query, page, per_page });
+            return assertString(response.headers.get('X-Digest'), 'OpenStax Exercises search endpoint HEAD did not return an X-Digest header');
+        };
+        const search = async (query, page = 1, per_page = 100) => {
+            const response = await request(METHOD.GET, 'exercises', { query, page, per_page });
+            const digest = assertString(response.headers.get('X-Digest'), 'OpenStax Exercises search endpoint GET did not return an X-Digest header');
+            const { items, total_count } = await response.json();
+            return { digest, items: await Promise.all(items.map(doDefaultCorrectness)), total_count };
+        };
+        const get = async (uuid) => {
+            const response = await request(METHOD.GET, `exercises/${uuid}`);
+            return response.status === 404
+                ? undefined
+                : response.json().then(doDefaultCorrectness);
+        };
+        return {
+            searchDigest,
+            get,
+            search,
+        };
+    };
+};

package/dist/esm/services/fileServer/index.d.ts

@@ -0,0 +1,30 @@
+export type FileValue = {
+    dataType: 'file';
+    mimeType: string;
+    path: string;
+    label: string;
+};
+export type FolderValue = {
+    dataType: 'folder';
+    files: FileValue[];
+};
+export declare const isFileValue: (thing: any) => thing is FileValue;
+export declare const isFolderValue: (thing: any) => thing is FolderValue;
+export interface FileServerAdapter {
+    putFileContent: (source: FileValue, content: string) => Promise<FileValue>;
+    getSignedViewerUrl: (source: FileValue) => Promise<string>;
+    getPublicViewerUrl: (source: FileValue) => Promise<string>;
+    getFileContent: (source: FileValue) => Promise<Buffer>;
+    getSignedFileUploadConfig: () => Promise<{
+        url: string;
+        payload: {
+            [key: string]: string;
+        };
+    }>;
+    copyFileTo: (source: FileValue, destinationPath: string) => Promise<FileValue>;
+    copyFileToDirectory: (source: FileValue, destinationDirectory: string) => Promise<FileValue>;
+    isTemporaryUpload: (source: FileValue) => boolean;
+    getFileChecksum: (source: FileValue) => Promise<string>;
+    filesEqual: (sourceA: FileValue, sourceB: FileValue) => Promise<boolean>;
+}
+export declare const isFileOrFolder: (thing: any) => thing is FileValue | FolderValue;

package/dist/esm/services/fileServer/index.js

@@ -0,0 +1,13 @@
+import { isPlainObject } from '../../guards';
+export const isFileValue = (thing) => isPlainObject(thing)
+    && Object.keys(thing).every(key => ['dataType', 'path', 'label', 'mimeType'].includes(key))
+    && thing.dataType === 'file'
+    && typeof thing.mimeType === 'string'
+    && typeof thing.path === 'string'
+    && typeof thing.label === 'string';
+export const isFolderValue = (thing) => isPlainObject(thing)
+    && Object.keys(thing).every(key => ['dataType', 'files'].includes(key))
+    && thing.dataType === 'folder'
+    && thing.files instanceof Array
+    && thing.files.every(isFileValue);
+export const isFileOrFolder = (thing) => isFileValue(thing) || isFolderValue(thing);

package/dist/esm/services/fileServer/localFileServer.d.ts

@@ -0,0 +1,13 @@
+import { ConfigProviderForConfig } from '../../config';
+import { FileServerAdapter } from '.';
+export type Config = {
+    port?: string;
+    host?: string;
+    storagePrefix: string;
+};
+interface Initializer<C> {
+    dataDir: string;
+    configSpace?: C;
+}
+export declare const localFileServer: <C extends string = "local">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => FileServerAdapter;
+export {};

package/dist/esm/services/fileServer/localFileServer.js

@@ -0,0 +1,125 @@
+/* cspell:ignore originalname */
+import crypto from 'crypto';
+import fs from 'fs';
+import https from 'https';
+import path from 'path';
+import cors from 'cors';
+import express from 'express';
+import multer from 'multer';
+import { v4 as uuid } from 'uuid';
+import { assertString } from '../../assertions';
+import { resolveConfigValue } from '../../config';
+import { ifDefined } from '../../guards';
+import { memoize } from '../../misc/helpers';
+/* istanbul ignore next */
+const startServer = memoize((port, uploadDir) => {
+    // TODO - re-evaluate the `preservePath` behavior to match whatever s3 does
+    const upload = multer({ dest: uploadDir, preservePath: true });
+    const fileServerApp = express();
+    fileServerApp.use(cors());
+    fileServerApp.use(express.static(uploadDir));
+    fileServerApp.post('/', upload.single('file'), async (req, res) => {
+        const file = req.file;
+        if (!file) {
+            return res.status(400).send({ message: 'file is required' });
+        }
+        const destinationName = req.body.key.replace('${filename}', file.originalname);
+        const destinationPath = path.join(uploadDir, destinationName);
+        const destinationDirectory = path.dirname(destinationPath);
+        await fs.promises.mkdir(destinationDirectory, { recursive: true });
+        await fs.promises.rename(file.path, destinationPath);
+        res.status(201).send();
+    });
+    const server = https.createServer({
+        key: fs.readFileSync(assertString(process.env.SSL_KEY_FILE, new Error('ssl key is required for localFileServer')), 'utf8'),
+        cert: fs.readFileSync(assertString(process.env.SSL_CRT_FILE, new Error('ssl key is required for localFileServer')), 'utf8'),
+    }, fileServerApp);
+    server.once('error', function (err) {
+        if (err.code === 'EADDRINUSE') {
+            // when the local dev server reloads files on every request it doesn't
+            // actually tear down the old modules, so this server only starts on the
+            // first execution and changes in its code will not be reloaded
+            return;
+        }
+        throw err;
+    });
+    server.listen(port);
+    return true;
+});
+export const localFileServer = (initializer) => (configProvider) => {
+    const config = configProvider[ifDefined(initializer.configSpace, 'local')];
+    const port = resolveConfigValue(config.port || '');
+    const host = resolveConfigValue(config.host || '');
+    const storagePrefix = resolveConfigValue(config.storagePrefix);
+    const fileDir = storagePrefix.then((prefix) => path.join(initializer.dataDir, prefix));
+    Promise.all([port, fileDir])
+        .then(([port, fileDir]) => port && startServer(port, fileDir));
+    const getSignedViewerUrl = async (source) => {
+        return `https://${await host}:${await port}/${source.path}`;
+    };
+    const getPublicViewerUrl = async (source) => {
+        return `https://${await host}:${await port}/${source.path}`;
+    };
+    const getFileContent = async (source) => {
+        const filePath = path.join(await fileDir, source.path);
+        return fs.promises.readFile(filePath);
+    };
+    const putFileContent = async (source, content) => {
+        const filePath = path.join(await fileDir, source.path);
+        const directory = path.dirname(filePath);
+        await fs.promises.mkdir(directory, { recursive: true });
+        await fs.promises.writeFile(filePath, content);
+        return source;
+    };
+    const getSignedFileUploadConfig = async () => {
+        const prefix = 'uploads/' + uuid();
+        return {
+            url: `https://${await host}:${await port}/`,
+            payload: {
+                key: prefix + '/${filename}',
+            }
+        };
+    };
+    const copyFileTo = async (source, destinationPath) => {
+        const sourcePath = path.join(await fileDir, source.path);
+        const destPath = path.join(await fileDir, destinationPath);
+        const destDirectory = path.dirname(destPath);
+        await fs.promises.mkdir(destDirectory, { recursive: true });
+        await fs.promises.copyFile(sourcePath, destPath);
+        return {
+            ...source,
+            path: destinationPath
+        };
+    };
+    const copyFileToDirectory = async (source, destination) => {
+        const destinationPath = path.join(destination, source.label);
+        return copyFileTo(source, destinationPath);
+    };
+    const isTemporaryUpload = (source) => {
+        return source.path.indexOf('uploads/') === 0;
+    };
+    const getFileChecksum = async (source) => {
+        const filePath = path.join(await fileDir, source.path);
+        const fileContent = await fs.promises.readFile(filePath);
+        return crypto.createHash('md5').update(fileContent).digest('hex');
+    };
+    const filesEqual = async (sourceA, sourceB) => {
+        const [aSum, bSum] = await Promise.all([
+            getFileChecksum(sourceA),
+            getFileChecksum(sourceB)
+        ]);
+        return aSum === bSum;
+    };
+    return {
+        getSignedViewerUrl,
+        getPublicViewerUrl,
+        getFileContent,
+        putFileContent,
+        getSignedFileUploadConfig,
+        copyFileTo,
+        copyFileToDirectory,
+        isTemporaryUpload,
+        getFileChecksum,
+        filesEqual,
+    };
+};

package/dist/esm/services/fileServer/s3FileServer.d.ts

@@ -0,0 +1,14 @@
+import { S3Client } from '@aws-sdk/client-s3';
+import { ConfigProviderForConfig } from '../../config';
+import { FileServerAdapter } from '.';
+export type Config = {
+    bucketName: string;
+    bucketRegion: string;
+    publicViewerDomain?: string;
+};
+interface Initializer<C> {
+    configSpace?: C;
+    getS3Client?: (...args: ConstructorParameters<typeof S3Client>) => S3Client;
+}
+export declare const s3FileServer: <C extends string = "deployed">(initializer: Initializer<C>) => (configProvider: { [_key in C]: ConfigProviderForConfig<Config>; }) => FileServerAdapter;
+export {};