@fgv/ts-res 5.0.0-22 → 5.0.0-23

package/src/packlets/runtime/validate.ts

@@ -1,63 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * 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.
- */
-
-import { Validators, Validator } from '@fgv/ts-utils';
-import { Validators as JsonValidators } from '@fgv/ts-json-base';
-import { Validate, ResourceId } from '../common';
-import { ResourceType } from '../resource-types';
-import { ConcreteDecision } from '../decisions';
-import { IResource, IResourceCandidate } from './iResourceManager';
-
-/**
- * Validates an {@link Runtime.IResourceCandidate | IResourceCandidate} object.
- * @public
- */
-export const resourceCandidate: Validator<IResourceCandidate, unknown> =
-  Validators.object<IResourceCandidate>({
-    json: JsonValidators.jsonObject,
-    isPartial: Validators.boolean,
-    mergeMethod: Validators.isA(
-      'resource value merge method',
-      (v): v is 'augment' | 'delete' | 'replace' => v === 'augment' || v === 'delete' || v === 'replace'
-    )
-  });
-
-/**
- * Validates an {@link Runtime.IResource | IResource} object.
- * @public
- */
-export const resource: Validator<IResource, unknown> = Validators.object<IResource>({
-  id: Validators.isA(
-    'ResourceId',
-    (v): v is ResourceId => typeof v === 'string' && Validate.isValidResourceId(v)
-  ),
-  name: Validators.isA(
-    'ResourceName',
-    (v): v is string => typeof v === 'string' && Validate.isValidResourceName(v)
-  ),
-  resourceType: Validators.isA('ResourceType instance', (v): v is ResourceType => v instanceof ResourceType),
-  decision: Validators.isA(
-    'ConcreteDecision instance',
-    (v): v is ConcreteDecision => v instanceof ConcreteDecision
-  ),
-  candidates: Validators.arrayOf(resourceCandidate)
-});

package/src/packlets/zip-archive/convert.ts

@@ -1,121 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * 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.
- */
-
-/* eslint-disable @rushstack/typedef-var */
-
-import { Validator, Validators, Converter, Converters } from '@fgv/ts-utils';
-import * as Json from './json';
-import { Model as ConfigModel, Convert as ConfigConvert } from '../config';
-
-/**
- * Validator for ZIP archive input type
- * @public
- */
-export const zipArchiveInputType: Validator<'file' | 'directory'> = Validators.enumeratedValue([
-  'file',
-  'directory'
-] as const);
-
-/**
- * Validator for ZIP archive config type
- * @public
- */
-export const zipArchiveConfigType: Validator<'file'> = Validators.enumeratedValue(['file'] as const);
-
-/**
- * Validator for ZIP archive input information
- * @public
- */
-export const zipArchiveInputInfo: Validator<Json.IZipArchiveInputInfo> =
-  Validators.object<Json.IZipArchiveInputInfo>({
-    type: zipArchiveInputType,
-    originalPath: Validators.string,
-    archivePath: Validators.string
-  });
-
-/**
- * Validator for ZIP archive config information
- * @public
- */
-export const zipArchiveConfigInfo: Validator<Json.IZipArchiveConfigInfo> =
-  Validators.object<Json.IZipArchiveConfigInfo>({
-    type: zipArchiveConfigType,
-    originalPath: Validators.string,
-    archivePath: Validators.string
-  });
-
-/**
- * Validator for ZIP archive manifest
- * Compatible with existing tools from ts-res-browser-cli
- * @public
- */
-export const zipArchiveManifest: Validator<Json.IZipArchiveManifest> =
-  Validators.object<Json.IZipArchiveManifest>({
-    timestamp: Validators.string,
-    input: zipArchiveInputInfo.optional(),
-    config: zipArchiveConfigInfo.optional()
-  });
-
-/**
- * Validator for MIME type strings
- * @public
- */
-export const mimeType: Validator<string> = Validators.string;
-
-/**
- * Converter for imported file
- * @public
- */
-export const importedFile: Converter<Json.IImportedFile> = Converters.strictObject<Json.IImportedFile>({
-  name: Converters.string,
-  path: Converters.string,
-  content: Converters.string,
-  type: Converters.string // MIME type as string
-});
-
-/**
- * Converter for imported directory structure (recursive)
- * Note: Uses Converter pattern because Validators don't support recursion with self parameter
- * @public
- */
-export const importedDirectory: Converter<Json.IImportedDirectory> = Converters.generic<
-  Json.IImportedDirectory,
-  unknown
->((from: unknown, self: Converter<Json.IImportedDirectory, unknown>, context?: unknown) => {
-  return Converters.strictObject<Json.IImportedDirectory>({
-    name: Converters.string,
-    files: Converters.arrayOf(importedFile),
-    subdirectories: Converters.arrayOf(self)
-  }).convert(from, context);
-});
-
-/**
- * Validator for system configuration (delegates to config packlet)
- * This validates that the parsed JSON conforms to the system configuration schema
- * @public
- */
-export const systemConfiguration: Validator<ConfigModel.ISystemConfiguration> = Validators.isA(
-  'system configuration',
-  (value: unknown): value is ConfigModel.ISystemConfiguration => {
-    return ConfigConvert.systemConfiguration.convert(value).isSuccess();
-  }
-);

package/src/packlets/zip-archive/index.ts

@@ -1,76 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * 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.
- */
-
-/**
- * ZIP archive functionality for ts-res source file archives
- *
- * This packlet provides consolidated ZIP archive creation and loading functionality
- * for source files, compatible with existing tools while using fflate for
- * universal browser compatibility.
- *
- * @remarks
- * ZIP archives contain source files for resource ingestion with directory
- * structure preserved and optional validation but no processing or transformation.
- * This is distinct from ZIP bundles which contain processed resource output.
- *
- * @packageDocumentation
- */
-
-import * as Json from './json';
-import * as Convert from './convert';
-
-// Namespaces
-export { Json, Convert };
-
-// Core classes
-export { ZipArchiveCreator } from './zipArchiveCreator';
-export { ZipArchiveLoader } from './zipArchiveLoader';
-
-// Types and interfaces
-export type {
-  IZipArchivePathOptions,
-  IZipArchiveFileTreeOptions,
-  ZipArchiveOptions,
-  IZipArchiveResult,
-  IZipArchiveManifest,
-  IZipArchiveLoadOptions,
-  IZipArchiveLoadResult,
-  IImportedFile,
-  IImportedDirectory,
-  ZipArchiveProgressCallback
-} from './types';
-
-// Format utilities
-export {
-  createZipArchiveManifest,
-  parseZipArchiveManifest,
-  validateZipArchiveManifest,
-  parseZipArchiveConfiguration,
-  generateZipArchiveFilename,
-  normalizePath,
-  getDirectoryName,
-  sanitizeFilename,
-  isZipFile
-} from './zipArchiveFormat';
-
-// Constants
-export { ZipArchiveConstants } from './types';

package/src/packlets/zip-archive/json.ts

@@ -1,91 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * 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.
- */
-
-/**
- * JSON representation of ZIP archive input information
- * @public
- */
-export interface IZipArchiveInputInfo {
-  /** Type of input (file or directory) */
-  type: 'file' | 'directory';
-  /** Original file/directory path */
-  originalPath: string;
-  /** Path within the archive (e.g., "input/mydir") */
-  archivePath: string;
-}
-
-/**
- * JSON representation of ZIP archive config information
- * @public
- */
-export interface IZipArchiveConfigInfo {
-  /** Type of config (always 'file') */
-  type: 'file';
-  /** Original config file path */
-  originalPath: string;
-  /** Path within the archive (e.g., "config.json") */
-  archivePath: string;
-}
-
-/**
- * JSON representation of a ZIP archive manifest
- * Compatible with existing tools from ts-res-browser-cli
- * @public
- */
-export interface IZipArchiveManifest {
-  /** Archive creation timestamp */
-  timestamp: string;
-
-  /** Optional input source information */
-  input?: IZipArchiveInputInfo;
-
-  /** Optional configuration file information */
-  config?: IZipArchiveConfigInfo;
-}
-
-/**
- * JSON representation of an imported file
- * @public
- */
-export interface IImportedFile {
-  /** File name */
-  name: string;
-  /** Full path within archive */
-  path: string;
-  /** File content as string */
-  content: string;
-  /** MIME type */
-  type: string;
-}
-
-/**
- * JSON representation of an imported directory structure
- * @public
- */
-export interface IImportedDirectory {
-  /** Directory name */
-  name: string;
-  /** Files in this directory */
-  files: IImportedFile[];
-  /** Subdirectories */
-  subdirectories: IImportedDirectory[];
-}

package/src/packlets/zip-archive/types.ts

@@ -1,140 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * 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.
- */
-
-import { Model as ConfigModel } from '../config';
-import * as Json from './json';
-import { FileTree } from '@fgv/ts-utils';
-
-/**
- * Options for creating a ZIP archive buffer
- * @public
- */
-export interface IZipArchivePathOptions {
-  /** File or directory path to include in the archive */
-  inputPath?: string;
-  /** Optional configuration file path */
-  configPath?: string;
-}
-
-/**
- * Options for creating a ZIP archive buffer from a file tree
- * @public
- */
-export interface IZipArchiveFileTreeOptions {
-  /** Input file or directory */
-  inputItem?: FileTree.FileTreeItem;
-  /** Optional configuration file */
-  configItem?: FileTree.IFileTreeFileItem;
-}
-
-/**
- * Options for creating a ZIP archive buffer
- * @public
- */
-export type ZipArchiveOptions = IZipArchivePathOptions | IZipArchiveFileTreeOptions;
-
-/**
- * Standardized ZIP archive manifest format (compatible with existing tools)
- * @public
- */
-export type IZipArchiveManifest = Json.IZipArchiveManifest;
-
-/**
- * Result of ZIP archive buffer creation
- * @public
- */
-export interface IZipArchiveResult {
-  /** Raw ZIP data buffer */
-  zipBuffer: Uint8Array;
-  /** Archive manifest with metadata */
-  manifest: IZipArchiveManifest;
-  /** Total ZIP size in bytes */
-  size: number;
-}
-
-/**
- * Options for loading a ZIP archive
- * @public
- */
-export interface IZipArchiveLoadOptions {
-  /** Validate manifest strictly */
-  strictManifestValidation?: boolean;
-}
-
-/**
- * Result of ZIP archive loading
- * @public
- */
-export interface IZipArchiveLoadResult {
-  /** Parsed archive manifest */
-  manifest: IZipArchiveManifest | undefined;
-  /** Loaded configuration */
-  config: ConfigModel.ISystemConfiguration | undefined;
-  /** All files extracted from the archive */
-  files: IImportedFile[];
-  /** Directory structure if available */
-  directory: IImportedDirectory | undefined;
-}
-
-/**
- * Imported file representation
- * @public
- */
-export type IImportedFile = Json.IImportedFile;
-
-/**
- * Imported directory structure
- * @public
- */
-export type IImportedDirectory = Json.IImportedDirectory;
-
-/**
- * Progress callback for ZIP operations
- * @public
- */
-export type ZipArchiveProgressCallback = (
-  stage:
-    | 'reading-file'
-    | 'parsing-zip'
-    | 'loading-manifest'
-    | 'loading-config'
-    | 'extracting-files'
-    | 'processing-resources'
-    | 'creating-zip',
-  progress: number, // 0-100
-  details: string
-) => void;
-
-/**
- * Constants for ZIP archive structure
- * @public
- */
-export const ZipArchiveConstants = {
-  /** Manifest file name */
-  MANIFEST_FILE: 'manifest.json',
-  /** Configuration file name */
-  CONFIG_FILE: 'config.json',
-  /** Input files directory */
-  INPUT_DIR: 'input',
-  /** Configuration files directory */
-  CONFIG_DIR: 'config'
-} as const;