shelving 1.121.1 → 1.122.0

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.121.1",
+	"version": "1.122.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",

package/schema/FileSchema.d.ts

@@ -0,0 +1,14 @@
+import type { FileTypes } from "../util/file.js";
+import { StringSchema, type StringSchemaOptions } from "./StringSchema.js";
+/** Allowed options for `FileSchema` */
+export type FileSchemaOptions = StringSchemaOptions & {
+    readonly formats: FileTypes;
+};
+/** Validate a file name matching one or more extensions. */
+export declare class FileSchema extends StringSchema {
+    readonly formats: FileTypes;
+    constructor(options: {
+        formats: FileTypes;
+    } & StringSchemaOptions);
+    validate(unsafeValue?: unknown): string;
+}

package/schema/FileSchema.js

@@ -0,0 +1,25 @@
+import { Feedback } from "../feedback/Feedback.js";
+import { getOptionalFileExtension } from "../util/file.js";
+import { isProp } from "../util/object.js";
+import { getValidationContext } from "../util/validate.js";
+import { StringSchema } from "./StringSchema.js";
+/** Validate a file name matching one or more extensions. */
+export class FileSchema extends StringSchema {
+    formats;
+    constructor(options) {
+        super(options);
+        this.formats = options.formats;
+    }
+    validate(unsafeValue = this.value) {
+        const path = super.validate(unsafeValue);
+        const { action } = getValidationContext();
+        if (action === "set" || action === "update") {
+            const extension = getOptionalFileExtension(path);
+            if (!extension)
+                throw new Feedback("Must be file name with extension", unsafeValue);
+            if (!isProp(this.formats, extension))
+                throw new Feedback("Invalid file type", extension);
+        }
+        return path;
+    }
+}

package/util/file.d.ts

@@ -0,0 +1,8 @@
+/** List of file types in `extension: mime` format. */
+export type FileTypes = {
+    [extension: string]: string;
+};
+/** Get the file extension from a file path, or return `undefined` if the input has no extension. */
+export declare function getOptionalFileExtension(file: string): string | undefined;
+/** Get the file extension from a file path, or throw `ValueError` if the input has no extension. */
+export declare function getFileExtension(path: string): string;

package/util/file.js

@@ -0,0 +1,13 @@
+import { ValueError } from "../error/ValueError.js";
+/** Get the file extension from a file path, or return `undefined` if the input has no extension. */
+export function getOptionalFileExtension(file) {
+    const i = file.lastIndexOf(".");
+    return (i >= 0 && file.slice(i + 1)) || undefined;
+}
+/** Get the file extension from a file path, or throw `ValueError` if the input has no extension. */
+export function getFileExtension(path) {
+    const extension = getOptionalFileExtension(path);
+    if (!extension)
+        throw new ValueError("File extension is required", path);
+    return extension;
+}

package/util/index.d.ts

@@ -16,6 +16,7 @@ export * from "./duration.js";
 export * from "./entry.js";
 export * from "./equal.js";
 export * from "./error.js";
+export * from "./file.js";
 export * from "./focus.js";
 export * from "./function.js";
 export * from "./hash.js";

package/util/index.js

@@ -16,6 +16,7 @@ export * from "./duration.js";
 export * from "./entry.js";
 export * from "./equal.js";
 export * from "./error.js";
+export * from "./file.js";
 export * from "./focus.js";
 export * from "./function.js";
 export * from "./hash.js";