@constructive-io/content-type-stream 2.4.3

package/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Dan Lynch <pyramation@gmail.com>
+Copyright (c) 2025 Constructive <developers@constructive.io>
+Copyright (c) 2020-present, Interweb, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,147 @@
+# @constructive-io/content-type-stream
+
+<p align="center" width="100%">
+  <img height="250" src="https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg" />
+</p>
+
+<p align="center" width="100%">
+  <a href="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml">
+    <img height="20" src="https://github.com/constructive-io/constructive/actions/workflows/run-tests.yaml/badge.svg" />
+  </a>
+   <a href="https://github.com/constructive-io/constructive/blob/main/LICENSE"><img height="20" src="https://img.shields.io/badge/license-MIT-blue.svg"/></a>
+   <a href="https://www.npmjs.com/package/@constructive-io/content-type-stream"><img height="20" src="https://img.shields.io/github/package-json/v/constructive-io/constructive?filename=packages%2Fcontent-type-stream%2Fpackage.json"/></a>
+</p>
+
+```sh
+npm install @constructive-io/content-type-stream
+```
+
+In my life I've always found that `content-type`s or mimetypes to be totally hacky and different across operating systems and browsers. Also, knowing when to use the magic bytes compared to how we actually use files based on their extensions is never consistent... so this is aimed to make all that simple :)
+
+## content-type info
+
+get proper content-type information via streams without ever writing to disk
+
+```js
+const readStream = createReadStream(filename);
+const { stream, magic, contentType } = await streamContentType({
+   readStream,
+   filename
+});
+```
+
+## using steams
+
+the `stream` it returns can then be used, for example
+
+```js
+  const { stream, contentType } = await streamContentType({
+    readStream,
+    filename
+  });
+  return await asyncUpload({
+    key,
+    contentType,
+    readStream: stream,
+    bucket
+  });
+```
+
+## contents hash stream
+
+if you want more info with your upload, with `ContentStream` you can get nice hashes
+
+* `uuid`: RFC-compliant UUID v5.
+* `etag`: Etag/S3 MD5 sum
+* `sha`: A sha sum
+
+```js
+    const contentStream = new ContentStream();
+// ...
+    readStream.pipe(contentStream);
+    contentStream.pipe(uploadStream);
+```
+
+```js
+   { 
+        uuid: '78160718-8dfa-5cb4-bb50-e479c8c58383',
+        sha: 'e6c7c64d292a414941d239c57117b36f24c9f829',
+        etag: '64dcb5b3b291074d02c80f600fda3f6e'
+    }
+```
+
+---
+
+## Education and Tutorials
+
+ 1. 🚀 [Quickstart: Getting Up and Running](https://constructive.io/learn/quickstart)
+Get started with modular databases in minutes. Install prerequisites and deploy your first module.
+
+ 2. 📦 [Modular PostgreSQL Development with Database Packages](https://constructive.io/learn/modular-postgres)
+Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.
+
+ 3. ✏️ [Authoring Database Changes](https://constructive.io/learn/authoring-database-changes)
+Master the workflow for adding, organizing, and managing database changes with pgpm.
+
+ 4. 🧪 [End-to-End PostgreSQL Testing with TypeScript](https://constructive.io/learn/e2e-postgres-testing)
+Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.
+
+ 5. ⚡ [Supabase Testing](https://constructive.io/learn/supabase)
+Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.
+
+ 6. 💧 [Drizzle ORM Testing](https://constructive.io/learn/drizzle-testing)
+Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.
+
+ 7. 🔧 [Troubleshooting](https://constructive.io/learn/troubleshooting)
+Common issues and solutions for pgpm, PostgreSQL, and testing.
+
+## Related Constructive Tooling
+
+### 🧪 Testing
+
+* [pgsql-test](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-test): **📊 Isolated testing environments** with per-test transaction rollbacks—ideal for integration tests, complex migrations, and RLS simulation.
+* [supabase-test](https://github.com/constructive-io/constructive/tree/main/postgres/supabase-test): **🧪 Supabase-native test harness** preconfigured for the local Supabase stack—per-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
+* [graphile-test](https://github.com/constructive-io/constructive/tree/main/graphile/graphile-test): **🔐 Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
+* [pg-query-context](https://github.com/constructive-io/constructive/tree/main/postgres/pg-query-context): **🔒 Session context injection** to add session-local context (e.g., `SET LOCAL`) into queries—ideal for setting `role`, `jwt.claims`, and other session settings.
+
+### 🧠 Parsing & AST
+
+* [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): **🔄 SQL conversion engine** that interprets and converts PostgreSQL syntax.
+* [libpg-query-node](https://www.npmjs.com/package/libpg-query): **🌉 Node.js bindings** for `libpg_query`, converting SQL into parse trees.
+* [pg-proto-parser](https://www.npmjs.com/package/pg-proto-parser): **📦 Protobuf parser** for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
+* [@pgsql/enums](https://www.npmjs.com/package/@pgsql/enums): **🏷️ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
+* [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): **📝 Type definitions** for PostgreSQL AST nodes in TypeScript.
+* [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): **🛠️ AST utilities** for constructing and transforming PostgreSQL syntax trees.
+* [pg-ast](https://www.npmjs.com/package/pg-ast): **🔍 Low-level AST tools** and transformations for Postgres query structures.
+
+### 🚀 API & Dev Tools
+
+* [@constructive-io/graphql-server](https://github.com/constructive-io/constructive/tree/main/graphql/server): **⚡ Express-based API server** powered by PostGraphile to expose a secure, scalable GraphQL API over your Postgres database.
+* [@constructive-io/graphql-explorer](https://github.com/constructive-io/constructive/tree/main/graphql/explorer): **🔎 Visual API explorer** with GraphiQL for browsing across all databases and schemas—useful for debugging, documentation, and API prototyping.
+
+### 🔁 Streaming & Uploads
+
+* [etag-hash](https://github.com/constructive-io/constructive/tree/main/streaming/etag-hash): **🏷️ S3-compatible ETags** created by streaming and hashing file uploads in chunks.
+* [etag-stream](https://github.com/constructive-io/constructive/tree/main/streaming/etag-stream): **🔄 ETag computation** via Node stream transformer during upload or transfer.
+* [uuid-hash](https://github.com/constructive-io/constructive/tree/main/streaming/uuid-hash): **🆔 Deterministic UUIDs** generated from hashed content, great for deduplication and asset referencing.
+* [uuid-stream](https://github.com/constructive-io/constructive/tree/main/streaming/uuid-stream): **🌊 Streaming UUID generation** based on piped file content—ideal for upload pipelines.
+* [@constructive-io/s3-streamer](https://github.com/constructive-io/constructive/tree/main/streaming/s3-streamer): **📤 Direct S3 streaming** for large files with support for metadata injection and content validation.
+* [@constructive-io/upload-names](https://github.com/constructive-io/constructive/tree/main/streaming/upload-names): **📂 Collision-resistant filenames** utility for structured and unique file names for uploads.
+
+### 🧰 CLI & Codegen
+
+* [pgpm](https://github.com/constructive-io/constructive/tree/main/pgpm/pgpm): **🖥️ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
+* [@constructive-io/cli](https://github.com/constructive-io/constructive/tree/main/packages/cli): **🖥️ Command-line toolkit** for managing Constructive projects—supports database scaffolding, migrations, seeding, code generation, and automation.
+* [@constructive-io/graphql-codegen](https://github.com/constructive-io/constructive/tree/main/graphql/codegen): **✨ GraphQL code generation** (types, operations, SDK) from schema/endpoint introspection.
+* [@constructive-io/query-builder](https://github.com/constructive-io/constructive/tree/main/packages/query-builder): **🏗️ SQL constructor** providing a robust TypeScript-based query builder for dynamic generation of `SELECT`, `INSERT`, `UPDATE`, `DELETE`, and stored procedure calls—supports advanced SQL features like `JOIN`, `GROUP BY`, and schema-qualified queries.
+* [@constructive-io/graphql-query](https://github.com/constructive-io/constructive/tree/main/graphql/query): **🧩 Fluent GraphQL builder** for PostGraphile schemas. ⚡ Schema-aware via introspection, 🧩 composable and ergonomic for building deeply nested queries.
+
+## Credits
+
+**🛠 Built by the [Constructive](https://constructive.io) team — creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on [GitHub](https://github.com/constructive-io).**
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.

package/content-stream.d.ts

@@ -0,0 +1,6 @@
+import stream from 'stream';
+export declare class ContentStream extends stream.Transform {
+    constructor();
+    _write(chunk: any, enc: any, next: any): void;
+    _flush(done: any): void;
+}

package/content-stream.js

@@ -0,0 +1,68 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentStream = void 0;
+// @ts-nocheck
+const crypto_1 = __importDefault(require("crypto"));
+const etag = __importStar(require("etag-hash"));
+const stream_1 = __importDefault(require("stream"));
+const uuid = __importStar(require("uuid-hash"));
+class ContentStream extends stream_1.default.Transform {
+    constructor() {
+        super();
+        this.shasum = crypto_1.default.createHash('sha1');
+        this.etagsum = etag.createHash();
+        this.uuidsum = uuid.createHash();
+    }
+    _write(chunk, enc, next) {
+        this.shasum.update(chunk);
+        this.etagsum.update(chunk);
+        this.uuidsum.update(chunk);
+        this.push(chunk);
+        next();
+    }
+    _flush(done) {
+        this.emit('contents', {
+            uuid: this.uuidsum.digest(),
+            sha: this.shasum.digest('hex'),
+            etag: this.etagsum.digest()
+        });
+        done();
+    }
+}
+exports.ContentStream = ContentStream;

package/content-type-stream.d.ts

@@ -0,0 +1,17 @@
+import { BufferPeekStream } from 'mime-bytes';
+import type { Readable } from 'stream';
+interface StreamContentTypeArgs {
+    readStream: Readable;
+    filename: string;
+    peekBytes?: number;
+}
+interface StreamContentTypeResult {
+    stream: BufferPeekStream | Readable;
+    magic: {
+        type: string;
+        charset: string;
+    };
+    contentType: string;
+}
+export declare function streamContentType({ readStream, filename, peekBytes }: StreamContentTypeArgs): Promise<StreamContentTypeResult>;
+export {};

package/content-type-stream.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.streamContentType = streamContentType;
+const mime_bytes_1 = require("mime-bytes");
+// Create a shared detector instance with default settings
+const detector = new mime_bytes_1.FileTypeDetector({
+    peekBytes: 16384,
+    checkMultipleOffsets: true
+});
+async function streamContentType({ readStream, filename, peekBytes = 16384 }) {
+    try {
+        // Create a custom detector if different peek bytes are needed
+        const customDetector = peekBytes !== 16384
+            ? new mime_bytes_1.FileTypeDetector({ peekBytes, checkMultipleOffsets: true })
+            : detector;
+        // Detect from stream with fallback to filename
+        const result = await customDetector.detectWithFallback(readStream, filename);
+        // Get the peek stream that was created during detection
+        // mime-bytes returns the peek stream as part of the result
+        const peekStream = result?._stream || readStream;
+        let type = 'application/octet-stream';
+        let charset = 'binary';
+        let contentType = 'application/octet-stream';
+        if (result) {
+            type = result.mimeType;
+            charset = result.charset || 'binary';
+            // Use the contentType directly from mime-bytes
+            contentType = result.contentType || result.mimeType;
+        }
+        return {
+            stream: peekStream,
+            magic: { type, charset },
+            contentType
+        };
+    }
+    catch (error) {
+        // If detection fails, return defaults with original stream
+        const type = 'application/octet-stream';
+        const charset = 'binary';
+        const contentType = 'application/octet-stream';
+        return {
+            stream: readStream,
+            magic: { type, charset },
+            contentType
+        };
+    }
+}

package/esm/content-stream.js

@@ -0,0 +1,28 @@
+// @ts-nocheck
+import crypto from 'crypto';
+import * as etag from 'etag-hash';
+import stream from 'stream';
+import * as uuid from 'uuid-hash';
+export class ContentStream extends stream.Transform {
+    constructor() {
+        super();
+        this.shasum = crypto.createHash('sha1');
+        this.etagsum = etag.createHash();
+        this.uuidsum = uuid.createHash();
+    }
+    _write(chunk, enc, next) {
+        this.shasum.update(chunk);
+        this.etagsum.update(chunk);
+        this.uuidsum.update(chunk);
+        this.push(chunk);
+        next();
+    }
+    _flush(done) {
+        this.emit('contents', {
+            uuid: this.uuidsum.digest(),
+            sha: this.shasum.digest('hex'),
+            etag: this.etagsum.digest()
+        });
+        done();
+    }
+}

package/esm/content-type-stream.js

@@ -0,0 +1,44 @@
+import { FileTypeDetector } from 'mime-bytes';
+// Create a shared detector instance with default settings
+const detector = new FileTypeDetector({
+    peekBytes: 16384,
+    checkMultipleOffsets: true
+});
+export async function streamContentType({ readStream, filename, peekBytes = 16384 }) {
+    try {
+        // Create a custom detector if different peek bytes are needed
+        const customDetector = peekBytes !== 16384
+            ? new FileTypeDetector({ peekBytes, checkMultipleOffsets: true })
+            : detector;
+        // Detect from stream with fallback to filename
+        const result = await customDetector.detectWithFallback(readStream, filename);
+        // Get the peek stream that was created during detection
+        // mime-bytes returns the peek stream as part of the result
+        const peekStream = result?._stream || readStream;
+        let type = 'application/octet-stream';
+        let charset = 'binary';
+        let contentType = 'application/octet-stream';
+        if (result) {
+            type = result.mimeType;
+            charset = result.charset || 'binary';
+            // Use the contentType directly from mime-bytes
+            contentType = result.contentType || result.mimeType;
+        }
+        return {
+            stream: peekStream,
+            magic: { type, charset },
+            contentType
+        };
+    }
+    catch (error) {
+        // If detection fails, return defaults with original stream
+        const type = 'application/octet-stream';
+        const charset = 'binary';
+        const contentType = 'application/octet-stream';
+        return {
+            stream: readStream,
+            magic: { type, charset },
+            contentType
+        };
+    }
+}

package/esm/index.js

@@ -0,0 +1,2 @@
+export * from './content-stream';
+export * from './content-type-stream';

package/index.d.ts

@@ -0,0 +1,2 @@
+export * from './content-stream';
+export * from './content-type-stream';

package/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./content-stream"), exports);
+__exportStar(require("./content-type-stream"), exports);

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@constructive-io/content-type-stream",
+  "version": "2.4.3",
+  "author": "Constructive <developers@constructive.io>",
+  "description": "detect content-types via streams",
+  "main": "index.js",
+  "module": "esm/index.js",
+  "types": "index.d.ts",
+  "homepage": "https://github.com/constructive-io/constructive",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "directory": "dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/constructive-io/constructive"
+  },
+  "bugs": {
+    "url": "https://github.com/constructive-io/constructive/issues"
+  },
+  "scripts": {
+    "clean": "makage clean",
+    "prepack": "npm run build",
+    "build": "makage build",
+    "build:dev": "makage build --dev",
+    "lint": "eslint . --fix",
+    "test": "jest --passWithNoTests",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "etag-hash": "^2.4.3",
+    "mime-bytes": "^0.4.3",
+    "uuid-hash": "^2.3.3"
+  },
+  "keywords": [
+    "content-type",
+    "stream",
+    "middleware"
+  ],
+  "devDependencies": {
+    "makage": "^0.1.8"
+  },
+  "gitHead": "22cfe32e994e26a6490e04e28bab26d1e7e6345c"
+}