@dpuse/dpuse-development 0.3.450

package/dist/types/src/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Development utilities.
+ */
+declare function buildDirectoryIndex(id: string): Promise<void>;
+export { buildDirectoryIndex };
+export { buildProject, releaseProject, syncProjectWithGitHub, testProject } from './operations/manageProject';
+export { auditDependencies } from './operations/auditDependencies';
+export { checkDependencies } from './operations/checkDependencies';
+export { documentDependencies } from './operations/documentDependencies';
+export { formatCode } from './operations/formatCode';
+export { lintCode } from './operations/lintCode';
+export { updateDPUseDependencies } from './operations/updateDPUseDependencies';

package/dist/types/src/operations/auditDependencies.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Audit dependencies utilities.
+ */
+declare function auditDependencies(): Promise<void>;
+export { auditDependencies };

package/dist/types/src/operations/checkDependencies.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Check dependencies utilities.
+ */
+/** Utilities - Check dependencies. */
+declare function checkDependencies(): Promise<void>;
+/** Exposures */
+export { checkDependencies };

package/dist/types/src/operations/documentDependencies.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Document dependencies utilities.
+ */
+/** Utilities - Document. */
+declare function documentDependencies(licenses?: string[], checkRecursive?: boolean): Promise<void>;
+/** Exposures */
+export { documentDependencies };

package/dist/types/src/operations/formatCode.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Format code utilities.
+ */
+declare function formatCode(): Promise<void>;
+export { formatCode };

package/dist/types/src/operations/lintCode.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Lint code utilities.
+ */
+declare function lintCode(): Promise<void>;
+export { lintCode };

package/dist/types/src/operations/manageProject.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Manage project utilities.
+ */
+declare function buildProject(): Promise<void>;
+declare function releaseProject(): Promise<void>;
+declare function syncProjectWithGitHub(): Promise<void>;
+declare function testProject(): void;
+export { buildProject, releaseProject, syncProjectWithGitHub, testProject };

package/dist/types/src/operations/test.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Manage project utilities.
+ */
+declare function test(): void;
+export { test };

package/dist/types/src/operations/updateDPUseDependencies.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Update datapos dependencies utilities.
+ */
+declare function updateDPUseDependencies(dependencies?: string[]): Promise<void>;
+export { updateDPUseDependencies };

package/dist/types/src/utilities/cloudflare.d.ts

@@ -0,0 +1,7 @@
+import { PackageJson } from 'type-fest';
+import { ModuleConfig } from '@datapos/datapos-shared/component';
+declare function putState(): Promise<void>;
+declare function uploadDirectoryToR2(sourceDirectory: string, uploadDirectory: string): Promise<void>;
+declare function uploadModuleConfigToDO(configJSON: ModuleConfig): Promise<void>;
+declare function uploadModuleToR2(packageJSON: PackageJson, uploadDirectoryPath: string): Promise<void>;
+export { putState, uploadDirectoryToR2, uploadModuleConfigToDO, uploadModuleToR2 };

package/dist/types/src/utilities/index.d.ts

@@ -0,0 +1,42 @@
+import { Dirent, ObjectEncodingOptions, Stats } from 'node:fs';
+/** Interfaces/Types */
+export interface ModuleTypeConfig {
+    idPrefix: string;
+    typeId: 'app' | 'api' | 'connector' | 'context' | 'development' | 'engine' | 'eslint' | 'presenter' | 'resources' | 'shared' | 'tool';
+    isPublish: boolean;
+    uploadGroupName: 'connectors' | 'contexts' | 'engine' | 'presenters' | 'tools' | undefined;
+}
+/** Utilities - Clear directory. */
+declare function clearDirectory(directoryPath: string): Promise<void>;
+/** Utilities - Extract operations from source. */
+declare function extractOperationsFromSource<T>(source: string): T[];
+/** TODO Utilities - Execute command. */
+declare function execCommand(label: string | undefined, command_: string, arguments_?: string[], outputFilePath?: string): Promise<void>;
+/** Utilities - Get directory entries. */
+declare function getDirectoryEntries(path: string): Promise<string[]>;
+declare function getDirectoryEntries(path: string, options: ObjectEncodingOptions): Promise<Dirent[]>;
+/** Utilities - Get module type identifier. */
+declare function getModuleConfig(configId: string): ModuleTypeConfig;
+/** Utilities - Get stats for path. */
+declare function getStatsForPath(path: string): Promise<Stats>;
+/** Utilities - Log operation header. */
+declare function logOperationHeader(text: string): void;
+/** Utilities - Log operation success. */
+declare function logOperationSuccess(message: string): void;
+/** Utilities - Log step header. */
+declare function logStepHeader(text: string): void;
+/** Utilities - Read JSON file. */
+declare function readJSONFile<T>(path: string): Promise<T>;
+declare function readTextFile(path: string): Promise<string>;
+/** Utilities - Remove file. */
+declare function removeFile(path: string): Promise<void>;
+/** Utilities - Spawn command. */
+declare function spawnCommand(label: string, command: string, arguments_?: string[], ignoreErrors?: boolean): Promise<void>;
+/** Utilities - Substitute content. */
+declare function substituteContent(originalContent: string, substituteContent: string, startMarker: string, endMarker: string): string;
+/** Utilities - Write JSON file. */
+declare function writeJSONFile(path: string, data: object): Promise<void>;
+/** Utilities - Write text file. */
+declare function writeTextFile(path: string, data: string): Promise<void>;
+/** Exposures */
+export { clearDirectory, execCommand, extractOperationsFromSource, getDirectoryEntries, getModuleConfig, getStatsForPath, logOperationHeader, logOperationSuccess, logStepHeader, readJSONFile, readTextFile, removeFile, spawnCommand, substituteContent, writeJSONFile, writeTextFile };

package/dist/types/vite.config.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Vite configuration.
+ */
+declare const _default: import('vite').UserConfig;
+export default _default;

package/dist/types/vitest.config.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Vitest configuration.
+ */
+declare const _default: import('vite').UserConfig;
+export default _default;

package/eslint.config.ts

@@ -0,0 +1,9 @@
+/**
+ * ESLint configuration.
+ */
+
+/** Dependencies - Framework. */
+import dpuse from '@dpuse/eslint-config-dpuse';
+
+/** Exposures - Configuration. */
+export default [...dpuse];

package/licenses/license-report-config.json

@@ -0,0 +1,16 @@
+{
+    "fields": [
+        "department",
+        "relatedTo",
+        "name",
+        "licensePeriod",
+        "material",
+        "licenseType",
+        "link",
+        "remoteVersion",
+        "installedVersion",
+        "definedVersion",
+        "author",
+        "latestRemoteModified"
+    ]
+}

package/package.json

@@ -0,0 +1,95 @@
+{
+    "name": "@dpuse/dpuse-development",
+    "version": "0.3.450",
+    "description": "A collection of utilities for managing Data Positioning projects.",
+    "license": "MIT",
+    "author": "Jonathan Terrell <terrell.jm@gmail.com>",
+    "private": false,
+    "type": "module",
+    "homepage": "https://www.dpuse.app",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/data-positioning/dpuse-development.git"
+    },
+    "bugs": {
+        "url": "https://github.com/data-positioning/dpuse-development/issues"
+    },
+    "module": "./dist/dpuse-development.es.js",
+    "types": "./dist/types/src/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/dpuse-development.es.js",
+            "types": "./dist/types/src/index.d.ts"
+        },
+        "./prettierrc": "./.prettierrc.json",
+        "./license-report-config": "./licenses/license-report-config.json"
+    },
+    "files": [
+        ".editorconfig",
+        ".gitattributes",
+        ".gitignore_published",
+        ".gitignore_unpublished",
+        ".markdownlint.json",
+        ".prettierrc.json",
+        "dist",
+        "eslint.config.ts",
+        "LICENSE",
+        "licenses/license-report-config.json",
+        "tsconfig.json",
+        "tsconfig.vite.json",
+        "vite.config.ts",
+        "vitest.config.ts"
+    ],
+    "dependencies": {
+        "@datapos/datapos-shared": "^0.3.590",
+        "acorn": "^8.16.0",
+        "acorn-typescript": "^1.4.13",
+        "acorn-walk": "^8.3.5",
+        "nanoid": "^5.1.7",
+        "valibot": "^1.3.1"
+    },
+    "devDependencies": {
+        "@dpuse/eslint-config-dpuse": "^1.0.49",
+        "@types/eslint-plugin-security": "^3.0.1",
+        "@types/node": "^25.5.0",
+        "@typescript-eslint/eslint-plugin": "^8.57.1",
+        "@typescript-eslint/parser": "^8.57.1",
+        "eslint": "^9.39.2",
+        "eslint-import-resolver-typescript": "^4.4.4",
+        "eslint-plugin-import": "^2.32.0",
+        "eslint-plugin-security": "^4.0.0",
+        "eslint-plugin-sonarjs": "^4.0.2",
+        "eslint-plugin-unicorn": "^63.0.0",
+        "jiti": "^2.6.1",
+        "license-downloader": "^1.3.3",
+        "license-report": "^6.8.2",
+        "license-report-check": "^0.1.2",
+        "license-report-recursive": "^6.8.3",
+        "npm-check-updates": "^19.6.5",
+        "owasp-dependency-check": "^1.0.1",
+        "prettier": "^3.8.1",
+        "rollup-plugin-visualizer": "^7.0.1",
+        "sonda": "^0.11.1",
+        "type-fest": "^5.5.0",
+        "typescript": "^5.9.3",
+        "vite": "^8.0.1",
+        "vite-plugin-dts": "^4.5.4",
+        "vitest": "^4.1.0"
+    },
+    "scripts": {
+        "audit": "op run --env-file=.env -- node -e \"import('./dist/dpuse-development.es.js').then(m => m.auditDependencies())\"",
+        "build": "vite build",
+        "check": "node -e \"import('./dist/dpuse-development.es.js').then(m => m.checkDependencies())\"",
+        "document": "op run --env-file=.env -- node -e \"import('./dist/dpuse-development.es.js').then(m => m.documentDependencies(['MIT']))\"",
+        "format": "node -e \"import('./dist/dpuse-development.es.js').then(m => m.formatCode())\"",
+        "lint": "node -e \"import('./dist/dpuse-development.es.js').then(m => m.lintCode())\"",
+        "release": "op run --env-file=.env -- node -e \"import('./dist/dpuse-development.es.js').then(m => m.releaseProject())\"",
+        "sync": "node -e \"import('./dist/dpuse-development.es.js').then(m => m.syncProjectWithGitHub())\"",
+        "test": "node -e \"import('./dist/dpuse-development.es.js').then(m => m.testProject())\"",
+        "update": "node -e \"import('./dist/dpuse-development.es.js').then(m => m.updateDPUseDependencies(['eslint', 'shared']))\""
+    },
+    "engines": {
+        "node": ">=22.0.0",
+        "npm": ">=11.0.0"
+    }
+}

package/tsconfig.json

@@ -0,0 +1,35 @@
+{
+    "compilerOptions": {
+        "baseUrl": "./",
+        "declaration": true,
+        "esModuleInterop": true,
+        "exactOptionalPropertyTypes": true,
+        "forceConsistentCasingInFileNames": true,
+        "incremental": true,
+        "isolatedModules": true,
+        "lib": ["DOM", "ESNext"],
+        "module": "ESNext",
+        "moduleDetection": "force",
+        "moduleResolution": "bundler",
+        "noImplicitAny": true,
+        "noImplicitOverride": true,
+        "noPropertyAccessFromIndexSignature": true,
+        "noUncheckedIndexedAccess": true,
+        "noUnusedLocals": false,
+        "noUnusedParameters": false,
+        "outDir": "dist",
+        "paths": {
+            "~/*": ["*"],
+            "@/*": ["src/*"]
+        },
+        "resolveJsonModule": true,
+        "skipLibCheck": true,
+        "sourceMap": true,
+        "strict": true,
+        "strictNullChecks": true,
+        "target": "ESNext",
+        "tsBuildInfoFile": "./node_modules/.cache/tsconfig.tsbuildinfo",
+        "useDefineForClassFields": true
+    },
+    "include": ["src/**/*.ts", "tests/**/*.ts", "vite.config.*", "vitest.config.*"]
+}

package/vite.config.ts

@@ -0,0 +1,52 @@
+/**
+ * Vite configuration.
+ */
+
+// Dependencies - Vendor.
+import { defineConfig } from 'vite'; // Core Vite API.
+import dts from 'vite-plugin-dts'; // Emit .d.ts files alongside the bundle.
+import Sonda from 'sonda/vite'; // Visualize bundle results with Sonda plugin.
+import { visualizer } from 'rollup-plugin-visualizer'; // Generate bundle size report.
+import { fileURLToPath, URL } from 'node:url'; // ESM-safe path helpers.
+
+// Dependencies - Data.
+import config from './config.json' with { type: 'json' }; // Provide configuration identifier for naming.
+
+// Exposures - Configuration.
+export default defineConfig({
+    build: {
+        lib: {
+            entry: fileURLToPath(new URL('src/index.ts', import.meta.url)), // Absolute entry path.
+            fileName: (format) => `${config.id}.${format}.js`, // Bundle name derived from config identifier and format.
+            formats: ['es'] // Only emit native ES modules.
+        },
+        rollupOptions: {
+            external: ['node:child_process', 'node:fs', 'node:path', 'node:readline', 'node:url', 'node:util'], // Keep runtime dependencies out of bundle.
+            plugins: [
+                Sonda({
+                    filename: 'index', // Output file name.
+                    format: 'html', // Output file format.
+                    gzip: true, // Include gzip sizes.
+                    brotli: true, // Include brotli sizes.
+                    open: false, // Do not auto-open browser post-build.
+                    outputDir: './bundle-analysis-reports/sonda' // Output directory.
+                }), // Run Sonda analyser to generate additional bundle insights.
+                visualizer({
+                    filename: './bundle-analysis-reports/rollup-visualiser/index.html', // Output file path.
+                    open: false, // Do not auto-open browser post-build.
+                    gzipSize: true, // Include gzip sizes.
+                    brotliSize: true // Include brotli sizes.
+                })
+            ]
+        },
+        sourcemap: true,
+        target: 'ESNext' // Emit modern JavaScript for consumers.
+    },
+    plugins: [dts({ outDir: 'dist/types' })], // Generate type declarations in dist/types.
+    resolve: {
+        alias: {
+            '~': fileURLToPath(new URL('./', import.meta.url)), // Base alias matching tsconfig.
+            '@': fileURLToPath(new URL('src', import.meta.url)) // Source alias matching tsconfig.
+        }
+    }
+});

package/vitest.config.ts

@@ -0,0 +1,21 @@
+/**
+ * Vitest configuration.
+ */
+
+// Dependencies - Vendor.
+import { defineConfig } from 'vitest/config';
+import { resolve } from 'node:path';
+
+// Exposures - Configuration.
+export default defineConfig({
+    resolve: {
+        alias: {
+            '@': resolve(__dirname, './src')
+        }
+    },
+    test: {
+        globals: true,
+        include: ['tests/**/*.test.ts'],
+        environment: 'node'
+    }
+});