@cedarjs/storage 0.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Cedar
+
+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,123 @@
+# `@redwoodjs/storage`
+
+This package houses
+
+- Prisma extension for handling uploads. Currently
+  a) Query Extension: will save, delete, replace files on disk during CRUD
+  b) Result Extension: gives you functions like `.withSignedUri` on configured prisma results - which will take the paths, and convert it to a signed url
+- Storage adapters e.g. FS and Memory to use with the prisma extension
+- Processors - i.e. utility functions which will take [`Files`](https://developer.mozilla.org/en-US/docs/Web/API/File) and save them to storage
+
+## Usage
+
+In `api/src/uploads.ts` - setup uploads - processors, storage and the prisma extension.
+
+```ts
+// api/src/lib/uploads.ts
+nua
+import { setupUploads, UploadsConfig } from '@cedarjs/storage'
+import { FileSystemStorage } from '@cedarjs/storage/FileSystemStorage'
+import { UrlSigner } from '@cedarjs/storage/UrlSigner'
+
+const uploadsConfig: UploadsConfig = {
+  // 👇 prisma model
+  profile: {
+    // 👇 pass in fields that are going to be File uploads
+    // these should be configured as string in the Prisma.schema
+    fields: ['avatar', 'coverPhoto'],
+  },
+}
+
+// 👇 exporting these allows you access elsewhere on the api side
+export const fsStorage = new FileSystemStorage({
+  baseDir: './uploads',
+})
+
+// Optional
+export const urlSigner = new UrlSigner({
+  secret: process.env.UPLOADS_SECRET,
+  endpoint: '/signedUrl',
+})
+
+const { saveFiles, storagePrismaExtension } = setupStorage({
+  uploadsConfig,
+  storageAdapter: fsStorage,
+  urlSigner,
+})
+
+export { saveFiles, storagePrismaExtension }
+```
+
+### Configuring db to use the prisma extension
+
+```ts
+// api/src/lib/db.ts
+
+import { PrismaClient } from '@prisma/client'
+
+import { emitLogLevels, handlePrismaLogging } from '@cedarjs/api/logger'
+
+import { logger } from './logger'
+import { storagePrismaExtension } from './uploads'
+
+// 👇 Notice here we create prisma client, and don't export it yet
+export const prismaClient = new PrismaClient({
+  log: emitLogLevels(['info', 'warn', 'error']),
+})
+
+handlePrismaLogging({
+  db: prismaClient,
+  logger,
+  logLevels: ['info', 'warn', 'error'],
+})
+
+// 👇 Export db after adding uploads extension
+export const db = prismaClient.$extends(storagePrismaExtension)
+```
+
+## Using Prisma extension
+
+### A) CRUD operations
+
+No need to do anything here, but you have to use processors to supply Prisma with data in the correct format.
+
+### B) Result extensions
+
+```ts
+// api/src/services/profiles/profiles.ts
+
+export const profile: QueryResolvers['profile'] = async ({ id }) => {
+  // 👇 await the result from your prisma query
+  const profile = await db.profile.findUnique({
+    where: { id },
+  })
+
+  // Convert the avatar and coverPhoto fields to signed URLs
+  // Note that you still need to add a api endpoint to handle these signed urls
+  return profile?.withSignedUrl()
+}
+```
+
+## Using `saveFiles`
+
+In your services, you can use the preconfigured "processors" - exported as `saveFiles` to convert Files to paths on storage, for Prisma to save into the database. The processors, and storage adapters determine where the file is saved.
+
+```ts
+// api/src/services/profiles/profiles.ts
+
+export const updateProfile: MutationResolvers['updateProfile'] = async ({
+  id,
+  input,
+}) => {
+  const processedInput = await saveFiles.forProfile(input)
+
+  // This becomes a string 👇
+  // The configuration on where it was saved is passed when we setup uploads in src/lib/uploads.ts
+  // processedInput.avatar = '/mySavePath/profile/avatar/generatedId.jpg'
+
+  return db.profile.update({
+    data: processedInput,
+    where: { id },
+  })
+}
+```

package/dist/UrlSigner.d.ts

@@ -0,0 +1,46 @@
+export type SignedUrlSettings = {
+    endpoint: string;
+    secret: string;
+};
+export type SignatureValidationArgs = {
+    path: string;
+    s: string;
+    expiry?: number | string;
+};
+export declare class UrlSigner {
+    private secret;
+    private endpoint;
+    constructor({ secret, endpoint }: SignedUrlSettings);
+    generateSignature({ filePath, expiresInMs, }: {
+        filePath: string;
+        expiresInMs?: number;
+    }): {
+        expiry: number;
+        signature: string;
+    } | {
+        signature: string;
+        expiry: undefined;
+    };
+    /**
+     * The signature and expires have to be extracted from the URL
+     */
+    validateSignature({ s: signature, path: filePath, // In the URL we call it path
+    expiry, }: SignatureValidationArgs): string;
+    validateSignedUrl(fullPathWithQueryParametersOrUrl: string): string;
+    generateSignedUrl(filePath: string, expiresIn?: number): string;
+}
+export declare const getSignedDetailsFromUrl: (url: string) => {
+    expires: number | undefined;
+    file: string | null;
+    signature: string | null;
+};
+export declare const EXPIRES_IN: {
+    seconds: (s: number) => number;
+    minutes: (m: number) => number;
+    hours: (h: number) => number;
+    days: (d: number) => number;
+    weeks: (w: number) => number;
+    months: (m: number) => number;
+    years: (y: number) => number;
+};
+//# sourceMappingURL=UrlSigner.d.ts.map

package/dist/UrlSigner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UrlSigner.d.ts","sourceRoot":"","sources":["../src/UrlSigner.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,MAAM,CAAA;IACZ,CAAC,EAAE,MAAM,CAAA;IACT,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CACzB,CAAA;AACD,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,iBAAiB;IASnD,iBAAiB,CAAC,EAChB,QAAQ,EACR,WAAW,GACZ,EAAE;QACD,QAAQ,EAAE,MAAM,CAAA;QAChB,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB;;;;;;;IA2BD;;OAEG;IACH,iBAAiB,CAAC,EAChB,CAAC,EAAE,SAAS,EACZ,IAAI,EAAE,QAAQ,EAAE,6BAA6B;IAC7C,MAAM,GACP,EAAE,uBAAuB;IAiC1B,iBAAiB,CAAC,gCAAgC,EAAE,MAAM;IAuB1D,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;CAiBvD;AAED,eAAO,MAAM,uBAAuB,QAAS,MAAM;;;;CAQlD,CAAA;AAED,eAAO,MAAM,UAAU;iBACR,MAAM;iBACN,MAAM;eACR,MAAM;cACP,MAAM;eACL,MAAM;gBACL,MAAM;eACP,MAAM;CAClB,CAAA"}

package/dist/UrlSigner.js

@@ -0,0 +1,106 @@
+import crypto from "node:crypto";
+import { getConfig } from "@cedarjs/project-config";
+class UrlSigner {
+  secret;
+  endpoint;
+  constructor({ secret, endpoint }) {
+    this.secret = secret;
+    this.endpoint = endpoint;
+    this.endpoint = endpoint.startsWith("http") ? endpoint : `${getConfig().web.apiUrl}${endpoint}`;
+  }
+  generateSignature({
+    filePath,
+    expiresInMs
+  }) {
+    if (!this.secret) {
+      throw new Error("Please configure the secret");
+    }
+    if (expiresInMs) {
+      const expiry = Date.now() + expiresInMs;
+      const signature = crypto.createHmac("sha256", this.secret).update(`${filePath}:${expiry}`).digest("hex");
+      return { expiry, signature };
+    } else {
+      const signature = crypto.createHmac("sha256", this.secret).update(filePath).digest("hex");
+      return {
+        signature,
+        expiry: void 0
+      };
+    }
+  }
+  /**
+   * The signature and expires have to be extracted from the URL
+   */
+  validateSignature({
+    s: signature,
+    path: filePath,
+    // In the URL we call it path
+    expiry
+  }) {
+    if (!this.secret) {
+      throw new Error("Please configure the secret");
+    }
+    if (expiry) {
+      if (Date.now() > +expiry) {
+        throw new Error("Signature has expired");
+      }
+    }
+    const decodedFilePath = decodeURIComponent(filePath);
+    const validSignature = expiry ? crypto.createHmac("sha256", this.secret).update(`${decodedFilePath}:${expiry}`).digest("hex") : crypto.createHmac("sha256", this.secret).update(`${decodedFilePath}`).digest("hex");
+    if (validSignature !== signature) {
+      throw new Error("Invalid signature");
+    }
+    return decodedFilePath;
+  }
+  validateSignedUrl(fullPathWithQueryParametersOrUrl) {
+    const url = new URL(
+      fullPathWithQueryParametersOrUrl,
+      // We don't care about the host, but just need to create a URL object
+      // to parse search params
+      fullPathWithQueryParametersOrUrl.startsWith("http") ? void 0 : "http://localhost"
+    );
+    const path = url.searchParams.get("path");
+    this.validateSignature({
+      // Note the signature is called 's' in the URL
+      s: url.searchParams.get("s"),
+      expiry: url.searchParams.get("expiry"),
+      path
+    });
+    return decodeURIComponent(path);
+  }
+  generateSignedUrl(filePath, expiresIn) {
+    const { signature, expiry } = this.generateSignature({
+      filePath,
+      expiresInMs: expiresIn
+    });
+    const params = new URLSearchParams();
+    params.set("s", signature);
+    if (expiry) {
+      params.set("expiry", expiry.toString());
+    }
+    params.set("path", filePath);
+    return `${this.endpoint}?${params.toString()}`;
+  }
+}
+const getSignedDetailsFromUrl = (url) => {
+  const urlObj = new URL(url);
+  const expires = urlObj.searchParams.get("expires");
+  return {
+    expires: expires ? parseInt(expires) : void 0,
+    file: urlObj.searchParams.get("file"),
+    signature: urlObj.searchParams.get("s")
+  };
+};
+const EXPIRES_IN = {
+  seconds: (s) => s * 1e3,
+  minutes: (m) => m * 60 * 1e3,
+  hours: (h) => h * 60 * 60 * 1e3,
+  days: (d) => d * 24 * 60 * 60 * 1e3,
+  weeks: (w) => w * 7 * 24 * 60 * 60 * 1e3,
+  months: (m) => m * 30 * 24 * 60 * 60 * 1e3,
+  years: (y) => y * 365 * 24 * 60 * 60 * 1e3
+};
+export {
+  EXPIRES_IN,
+  UrlSigner,
+  getSignedDetailsFromUrl
+};

package/dist/adapters/BaseStorageAdapter.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The storage adapter will just save the file and return
+ * {
+ *  fileId: string,
+ *  location: string, // depending on storage it could be a path
+ * }
+ */
+import mime from 'mime-types';
+export type AdapterResult = {
+    location: string;
+};
+export type SaveOptionsOverride = {
+    fileName?: string;
+    path?: string;
+};
+export type AdapterOptions = {
+    baseDir: string;
+};
+export declare abstract class BaseStorageAdapter {
+    adapterOpts: AdapterOptions;
+    constructor(adapterOpts: AdapterOptions);
+    getAdapterOptions(): AdapterOptions;
+    generateFileNameWithExtension(saveOpts: SaveOptionsOverride | undefined, file: File): string;
+    abstract save(file: File, saveOpts?: SaveOptionsOverride): Promise<AdapterResult>;
+    abstract remove(fileLocation: AdapterResult['location']): Promise<void>;
+    abstract read(fileLocation: AdapterResult['location']): Promise<{
+        contents: Buffer | string;
+        type: ReturnType<typeof mime.lookup>;
+    }>;
+}
+//# sourceMappingURL=BaseStorageAdapter.d.ts.map

package/dist/adapters/BaseStorageAdapter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseStorageAdapter.d.ts","sourceRoot":"","sources":["../../src/adapters/BaseStorageAdapter.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,IAAI,MAAM,YAAY,CAAA;AAG7B,MAAM,MAAM,aAAa,GAAG;IAC1B,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,8BAAsB,kBAAkB;IACtC,WAAW,EAAE,cAAc,CAAA;gBACf,WAAW,EAAE,cAAc;IAIvC,iBAAiB;IAIjB,6BAA6B,CAC3B,QAAQ,EAAE,mBAAmB,GAAG,SAAS,EACzC,IAAI,EAAE,IAAI;IASZ,QAAQ,CAAC,IAAI,CACX,IAAI,EAAE,IAAI,EACV,QAAQ,CAAC,EAAE,mBAAmB,GAC7B,OAAO,CAAC,aAAa,CAAC;IACzB,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IACvE,QAAQ,CAAC,IAAI,CAAC,YAAY,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC;QAC9D,QAAQ,EAAE,MAAM,GAAG,MAAM,CAAA;QACzB,IAAI,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC,MAAM,CAAC,CAAA;KACrC,CAAC;CACH"}

package/dist/adapters/BaseStorageAdapter.js

@@ -0,0 +1,19 @@
+import mime from "mime-types";
+import { ulid } from "ulid";
+class BaseStorageAdapter {
+  adapterOpts;
+  constructor(adapterOpts) {
+    this.adapterOpts = adapterOpts;
+  }
+  getAdapterOptions() {
+    return this.adapterOpts;
+  }
+  generateFileNameWithExtension(saveOpts, file) {
+    const fileName = saveOpts?.fileName || ulid();
+    const extension = mime.extension(file.type) ? `.${mime.extension(file.type)}` : "";
+    return `${fileName}${extension}`;
+  }
+}
+export {
+  BaseStorageAdapter
+};

package/dist/adapters/FileSystemStorage/FileSystemStorage.d.ts

@@ -0,0 +1,16 @@
+import type { SaveOptionsOverride } from '../BaseStorageAdapter.js';
+import { BaseStorageAdapter } from '../BaseStorageAdapter.js';
+export declare class FileSystemStorage extends BaseStorageAdapter implements BaseStorageAdapter {
+    constructor(opts: {
+        baseDir: string;
+    });
+    save(file: File, saveOverride?: SaveOptionsOverride): Promise<{
+        location: string;
+    }>;
+    read(filePath: string): Promise<{
+        contents: Buffer;
+        type: string | false;
+    }>;
+    remove(filePath: string): Promise<void>;
+}
+//# sourceMappingURL=FileSystemStorage.d.ts.map

package/dist/adapters/FileSystemStorage/FileSystemStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FileSystemStorage.d.ts","sourceRoot":"","sources":["../../../src/adapters/FileSystemStorage/FileSystemStorage.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAE7D,qBAAa,iBACX,SAAQ,kBACR,YAAW,kBAAkB;gBAEjB,IAAI,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE;IAQ/B,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,YAAY,CAAC,EAAE,mBAAmB;;;IAanD,IAAI,CAAC,QAAQ,EAAE,MAAM;;;;IAOrB,MAAM,CAAC,QAAQ,EAAE,MAAM;CAG9B"}

package/dist/adapters/FileSystemStorage/FileSystemStorage.js

@@ -0,0 +1,38 @@
+import { existsSync, mkdirSync } from "node:fs";
+import fs from "node:fs/promises";
+import path from "node:path";
+import mime from "mime-types";
+import { ensurePosixPath } from "@cedarjs/project-config";
+import { BaseStorageAdapter } from "../BaseStorageAdapter.js";
+class FileSystemStorage extends BaseStorageAdapter {
+  constructor(opts) {
+    super(opts);
+    if (!existsSync(opts.baseDir)) {
+      const posixBaseDir = ensurePosixPath(opts.baseDir);
+      console.log("Creating baseDir >", posixBaseDir);
+      mkdirSync(posixBaseDir, { recursive: true });
+    }
+  }
+  async save(file, saveOverride) {
+    const fileName = this.generateFileNameWithExtension(saveOverride, file);
+    const location = path.join(
+      ensurePosixPath(saveOverride?.path || this.adapterOpts.baseDir),
+      fileName
+    );
+    const nodeBuffer = await file.arrayBuffer();
+    await fs.writeFile(location, Buffer.from(nodeBuffer));
+    return { location };
+  }
+  async read(filePath) {
+    return {
+      contents: await fs.readFile(filePath),
+      type: mime.lookup(filePath)
+    };
+  }
+  async remove(filePath) {
+    await fs.unlink(filePath);
+  }
+}
+export {
+  FileSystemStorage
+};

package/dist/adapters/MemoryStorage/MemoryStorage.d.ts

@@ -0,0 +1,15 @@
+import { BaseStorageAdapter } from '../BaseStorageAdapter.js';
+import type { SaveOptionsOverride } from '../BaseStorageAdapter.js';
+export declare class MemoryStorage extends BaseStorageAdapter implements BaseStorageAdapter {
+    store: Record<string, any>;
+    save(file: File, saveOpts?: SaveOptionsOverride): Promise<{
+        location: string;
+    }>;
+    remove(filePath: string): Promise<void>;
+    read(filePath: string): Promise<{
+        contents: any;
+        type: string | false;
+    }>;
+    clear(): Promise<void>;
+}
+//# sourceMappingURL=MemoryStorage.d.ts.map

package/dist/adapters/MemoryStorage/MemoryStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemoryStorage.d.ts","sourceRoot":"","sources":["../../../src/adapters/MemoryStorage/MemoryStorage.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAC7D,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAEnE,qBAAa,aACX,SAAQ,kBACR,YAAW,kBAAkB;IAE7B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAK;IAEzB,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,EAAE,mBAAmB;;;IAgB/C,MAAM,CAAC,QAAQ,EAAE,MAAM;IAIvB,IAAI,CAAC,QAAQ,EAAE,MAAM;;;;IAOrB,KAAK;CAGZ"}

package/dist/adapters/MemoryStorage/MemoryStorage.js

@@ -0,0 +1,33 @@
+import path from "node:path";
+import mime from "mime-types";
+import { BaseStorageAdapter } from "../BaseStorageAdapter.js";
+class MemoryStorage extends BaseStorageAdapter {
+  store = {};
+  async save(file, saveOpts) {
+    const fileName = this.generateFileNameWithExtension(saveOpts, file);
+    const location = path.join(
+      saveOpts?.path || this.adapterOpts.baseDir,
+      fileName
+    );
+    const nodeBuffer = await file.arrayBuffer();
+    this.store[location] = Buffer.from(nodeBuffer);
+    return {
+      location
+    };
+  }
+  async remove(filePath) {
+    delete this.store[filePath];
+  }
+  async read(filePath) {
+    return {
+      contents: this.store[filePath],
+      type: mime.lookup(filePath)
+    };
+  }
+  async clear() {
+    this.store = {};
+  }
+}
+export {
+  MemoryStorage
+};

package/dist/cjs/UrlSigner.d.ts

@@ -0,0 +1,46 @@
+export type SignedUrlSettings = {
+    endpoint: string;
+    secret: string;
+};
+export type SignatureValidationArgs = {
+    path: string;
+    s: string;
+    expiry?: number | string;
+};
+export declare class UrlSigner {
+    private secret;
+    private endpoint;
+    constructor({ secret, endpoint }: SignedUrlSettings);
+    generateSignature({ filePath, expiresInMs, }: {
+        filePath: string;
+        expiresInMs?: number;
+    }): {
+        expiry: number;
+        signature: string;
+    } | {
+        signature: string;
+        expiry: undefined;
+    };
+    /**
+     * The signature and expires have to be extracted from the URL
+     */
+    validateSignature({ s: signature, path: filePath, // In the URL we call it path
+    expiry, }: SignatureValidationArgs): string;
+    validateSignedUrl(fullPathWithQueryParametersOrUrl: string): string;
+    generateSignedUrl(filePath: string, expiresIn?: number): string;
+}
+export declare const getSignedDetailsFromUrl: (url: string) => {
+    expires: number | undefined;
+    file: string | null;
+    signature: string | null;
+};
+export declare const EXPIRES_IN: {
+    seconds: (s: number) => number;
+    minutes: (m: number) => number;
+    hours: (h: number) => number;
+    days: (d: number) => number;
+    weeks: (w: number) => number;
+    months: (m: number) => number;
+    years: (y: number) => number;
+};
+//# sourceMappingURL=UrlSigner.d.ts.map

package/dist/cjs/UrlSigner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"UrlSigner.d.ts","sourceRoot":"","sources":["../../src/UrlSigner.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,iBAAiB,GAAG;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,IAAI,EAAE,MAAM,CAAA;IACZ,CAAC,EAAE,MAAM,CAAA;IACT,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CACzB,CAAA;AACD,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,QAAQ,CAAQ;gBAEZ,EAAE,MAAM,EAAE,QAAQ,EAAE,EAAE,iBAAiB;IASnD,iBAAiB,CAAC,EAChB,QAAQ,EACR,WAAW,GACZ,EAAE;QACD,QAAQ,EAAE,MAAM,CAAA;QAChB,WAAW,CAAC,EAAE,MAAM,CAAA;KACrB;;;;;;;IA2BD;;OAEG;IACH,iBAAiB,CAAC,EAChB,CAAC,EAAE,SAAS,EACZ,IAAI,EAAE,QAAQ,EAAE,6BAA6B;IAC7C,MAAM,GACP,EAAE,uBAAuB;IAiC1B,iBAAiB,CAAC,gCAAgC,EAAE,MAAM;IAuB1D,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM;CAiBvD;AAED,eAAO,MAAM,uBAAuB,QAAS,MAAM;;;;CAQlD,CAAA;AAED,eAAO,MAAM,UAAU;iBACR,MAAM;iBACN,MAAM;eACR,MAAM;cACP,MAAM;eACL,MAAM;gBACL,MAAM;eACP,MAAM;CAClB,CAAA"}

package/dist/cjs/UrlSigner.js

@@ -0,0 +1,142 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var UrlSigner_exports = {};
+__export(UrlSigner_exports, {
+  EXPIRES_IN: () => EXPIRES_IN,
+  UrlSigner: () => UrlSigner,
+  getSignedDetailsFromUrl: () => getSignedDetailsFromUrl
+});
+module.exports = __toCommonJS(UrlSigner_exports);
+var import_node_crypto = __toESM(require("node:crypto"), 1);
+var import_project_config = require("@cedarjs/project-config");
+class UrlSigner {
+  secret;
+  endpoint;
+  constructor({ secret, endpoint }) {
+    this.secret = secret;
+    this.endpoint = endpoint;
+    this.endpoint = endpoint.startsWith("http") ? endpoint : `${(0, import_project_config.getConfig)().web.apiUrl}${endpoint}`;
+  }
+  generateSignature({
+    filePath,
+    expiresInMs
+  }) {
+    if (!this.secret) {
+      throw new Error("Please configure the secret");
+    }
+    if (expiresInMs) {
+      const expiry = Date.now() + expiresInMs;
+      const signature = import_node_crypto.default.createHmac("sha256", this.secret).update(`${filePath}:${expiry}`).digest("hex");
+      return { expiry, signature };
+    } else {
+      const signature = import_node_crypto.default.createHmac("sha256", this.secret).update(filePath).digest("hex");
+      return {
+        signature,
+        expiry: void 0
+      };
+    }
+  }
+  /**
+   * The signature and expires have to be extracted from the URL
+   */
+  validateSignature({
+    s: signature,
+    path: filePath,
+    // In the URL we call it path
+    expiry
+  }) {
+    if (!this.secret) {
+      throw new Error("Please configure the secret");
+    }
+    if (expiry) {
+      if (Date.now() > +expiry) {
+        throw new Error("Signature has expired");
+      }
+    }
+    const decodedFilePath = decodeURIComponent(filePath);
+    const validSignature = expiry ? import_node_crypto.default.createHmac("sha256", this.secret).update(`${decodedFilePath}:${expiry}`).digest("hex") : import_node_crypto.default.createHmac("sha256", this.secret).update(`${decodedFilePath}`).digest("hex");
+    if (validSignature !== signature) {
+      throw new Error("Invalid signature");
+    }
+    return decodedFilePath;
+  }
+  validateSignedUrl(fullPathWithQueryParametersOrUrl) {
+    const url = new URL(
+      fullPathWithQueryParametersOrUrl,
+      // We don't care about the host, but just need to create a URL object
+      // to parse search params
+      fullPathWithQueryParametersOrUrl.startsWith("http") ? void 0 : "http://localhost"
+    );
+    const path = url.searchParams.get("path");
+    this.validateSignature({
+      // Note the signature is called 's' in the URL
+      s: url.searchParams.get("s"),
+      expiry: url.searchParams.get("expiry"),
+      path
+    });
+    return decodeURIComponent(path);
+  }
+  generateSignedUrl(filePath, expiresIn) {
+    const { signature, expiry } = this.generateSignature({
+      filePath,
+      expiresInMs: expiresIn
+    });
+    const params = new URLSearchParams();
+    params.set("s", signature);
+    if (expiry) {
+      params.set("expiry", expiry.toString());
+    }
+    params.set("path", filePath);
+    return `${this.endpoint}?${params.toString()}`;
+  }
+}
+const getSignedDetailsFromUrl = (url) => {
+  const urlObj = new URL(url);
+  const expires = urlObj.searchParams.get("expires");
+  return {
+    expires: expires ? parseInt(expires) : void 0,
+    file: urlObj.searchParams.get("file"),
+    signature: urlObj.searchParams.get("s")
+  };
+};
+const EXPIRES_IN = {
+  seconds: (s) => s * 1e3,
+  minutes: (m) => m * 60 * 1e3,
+  hours: (h) => h * 60 * 60 * 1e3,
+  days: (d) => d * 24 * 60 * 60 * 1e3,
+  weeks: (w) => w * 7 * 24 * 60 * 60 * 1e3,
+  months: (m) => m * 30 * 24 * 60 * 60 * 1e3,
+  years: (y) => y * 365 * 24 * 60 * 60 * 1e3
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  EXPIRES_IN,
+  UrlSigner,
+  getSignedDetailsFromUrl
+});