@push.rocks/smartexpose

Expose in-memory files through short-lived public URLs backed by a WebDAV-accessible storage location. @push.rocks/smartexpose is a small TypeScript utility for upload-and-share flows where your app needs to hand another service a temporary URL without permanently publishing the file.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

What It Does

SmartExpose accepts SmartFile instances, uploads them to a configured provider, verifies that the public URL returns the uploaded bytes, and returns a stable result object containing the public URL, generated file id, and creation status.

The built-in provider is WebDAV-based. Point it at a writable WebDAV folder and an externally reachable base URL for that same folder, and it will handle the upload path generation for you.

Install

pnpm add @push.rocks/smartexpose @push.rocks/smartfile

Quick Start

import { SmartExpose } from '@push.rocks/smartexpose';
import { SmartFileFactory } from '@push.rocks/smartfile';

const expose = new SmartExpose({
  webdav: {
    webdavCredentials: {
      serverUrl: 'https://webdav.example.com/',
      password: process.env.WEBDAV_SERVER_TOKEN!,
    },
    webdavSubPath: '/public/temp-share',
  },
  exposedBaseUrl: 'https://cdn.example.com/',
  deleteAfterMillis: 30_000,
  privateUrl: true,
});

await expose.start();

const smartfileFactory = new SmartFileFactory(undefined);
const result = await expose.exposeFile({
  smartFile: smartfileFactory.fromString('report.txt', 'hello from smartexpose', 'utf8'),
  deleteAfterMillis: 10_000,
});

console.log(result.url);
// -> https://cdn.example.com/public/temp-share/<generated-id>

await expose.stop();

Core Concepts

SmartExpose

SmartExpose is the main orchestration class. It owns the provider, starts provider housekeeping, exposes single files or arrays of files, and stops scheduled tasks when you are done.

import { SmartExpose } from '@push.rocks/smartexpose';

const expose = new SmartExpose({
  exposedBaseUrl: 'https://cdn.example.com/',
  webdav: {
    webdavCredentials: {
      serverUrl: 'https://webdav.example.com/',
      password: process.env.WEBDAV_SERVER_TOKEN!,
    },
    webdavSubPath: '/public/temp-share',
  },
});

await expose.start();

WebDAV Provider

The default provider uploads every exposed file into webdavSubPath under a generated id. The public URL is assembled from exposedBaseUrl and the generated WebDAV file path.

The provider verifies successful exposure by requesting the assembled public URL and comparing the response body with the uploaded file contents. If the public endpoint cannot serve the file, exposeFile() throws instead of returning a broken URL.

Configuration

interface ISmartExposeOptions {
  exposedBaseUrl: string;
  deleteAfterMillis?: number;
  privateUrl?: boolean;
  webdav?: {
    webdavCredentials: IWebdavClientOptions;
    webdavSubPath: string;
  };
}

| Option | Required | Description | | --- | --- | --- | | exposedBaseUrl | Yes | Public base URL that maps to the WebDAV location. Returned URLs are built from this value and the generated file path. | | webdav.webdavCredentials | Yes for WebDAV | Credentials passed to @push.rocks/smartwebdav. | | webdav.webdavSubPath | Yes for WebDAV | Remote WebDAV directory used for exposed files. It is created if needed. | | deleteAfterMillis | No | Default intended lifetime for exposed files. Per-call values can override it where supported. | | privateUrl | No | Marks the requested exposure as private-by-design. The current WebDAV provider accepts the flag as part of the shared provider API. |

Exposing Files

Single File

const result = await expose.exposeFile({
  smartFile,
  deleteAfterMillis: 60_000,
  privateUrl: true,
});

console.log(result);
// {
//   url: 'https://cdn.example.com/public/temp-share/<generated-id>',
//   id: '<generated-id>',
//   status: 'created'
// }

Multiple Files

const results = await expose.exposeFileArray({
  smartFiles: [firstSmartFile, secondSmartFile],
  deleteAfterMillis: 60_000,
});

for (const exposedFile of results) {
  console.log(exposedFile.id, exposedFile.url);
}

exposeFileArray() processes the files through the same provider path as exposeFile() and returns one result per file.

Cleanup

Files can be scheduled for deletion by passing deleteAfterMillis to exposeFile() or exposeFileArray().

If you need provider-level cleanup, the WebDAV provider also implements:

await expose.provider?.deleteFileById(fileId);
await expose.provider?.wipeAll();

deleteFileById() returns deleted, failed, or notfound. wipeAll() empties the configured WebDAV exposure directory and returns a deletion result for each previously listed entry.

Testing Integration Flows

The test suite includes WebDAV integration tests that are skipped by default. To run them, set:

SMARTEXPOSE_RUN_INTEGRATION_TESTS=true
WEBDAV_SERVER_URL=https://webdav.example.com/
WEBDAV_SERVER_TOKEN=...
WEBDAV_SUB_PATH=/public/temp-share
EXPOSED_BASE_URL=https://cdn.example.com/
pnpm test

API Surface

@push.rocks/smartexpose exports:

| Export | Purpose | | --- | --- | | SmartExpose | Main class for configuring, starting, exposing files, and stopping exposure providers. | | ISmartExposeOptions | Constructor options for SmartExpose. | | ExposeProvider | Abstract provider interface for custom exposure backends. |

Availability and Links

| Resource | Link | | --- | --- | | npm package | npmjs.com/package/@push.rocks/smartexpose | | Source | code.foss.global/push.rocks/smartexpose | | GitHub mirror | github.com/push.rocks/smartexpose |

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the LICENSE file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

Company Information

Task Venture Capital GmbH Registered at District Court Bremen HRB 35230 HB, Germany

For any legal inquiries or further information, please contact us via email at [email protected].

By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.