directus-template-cli 0.6.0-beta.2 → 0.7.0-beta.10

package/dist/lib/utils/parse-github-url.js

@@ -0,0 +1,89 @@
+import { DEFAULT_BRANCH, DEFAULT_REPO } from '../constants.js';
+/**
+ * Clean and normalize a GitHub URL
+ * Handles various formats:
+ * - Full URLs with .git
+ * - URLs with query parameters
+ * - URLs with hash fragments
+ * - URLs with branches/refs
+ * - Repository paths
+ * @param url The URL or path to clean
+ * @returns Cleaned URL without .git, queries, or hashes
+ */
+function cleanGitHubUrl(url) {
+    try {
+        // If it's not a URL, return as is (might be a path)
+        if (!url.includes('://')) {
+            return url.replace(/\.git$/, '');
+        }
+        // Parse the URL
+        const parsed = new URL(url);
+        // Remove .git suffix from pathname
+        parsed.pathname = parsed.pathname.replace(/\.git$/, '');
+        // Remove search params and hash
+        parsed.search = '';
+        parsed.hash = '';
+        return parsed.toString();
+    }
+    catch (error) {
+        // If URL parsing fails, just remove .git suffix
+        return url.replace(/\.git$/, '');
+    }
+}
+/**
+ * Parse a GitHub URL or path into its components
+ * @param url The URL or path to parse
+ * @returns The parsed components
+ */
+export function parseGitHubUrl(url) {
+    if (!url) {
+        throw new Error('URL is required');
+    }
+    // Clean the URL first
+    const cleanedUrl = cleanGitHubUrl(url);
+    // Handle full GitHub URLs
+    if (cleanedUrl.includes('github.com')) {
+        try {
+            const parsed = new URL(cleanedUrl);
+            const parts = parsed.pathname.split('/').filter(Boolean);
+            if (parts.length < 2) {
+                throw new Error('Invalid GitHub URL format');
+            }
+            const [owner, repo, ...rest] = parts;
+            const path = rest.length > 0 ? rest.join('/') : undefined;
+            const ref = parsed.searchParams.get('ref') || DEFAULT_BRANCH;
+            return { owner, repo, path, ref };
+        }
+        catch (error) {
+            throw new Error(`Invalid GitHub URL: ${url}`);
+        }
+    }
+    // Handle repository paths (owner/repo format)
+    const parts = cleanedUrl.split('/').filter(Boolean);
+    if (parts.length >= 2) {
+        const [owner, repo, ...rest] = parts;
+        const path = rest.length > 0 ? rest.join('/') : undefined;
+        return { owner, repo, path, ref: DEFAULT_BRANCH };
+    }
+    // Handle simple template names using DEFAULT_REPO
+    return {
+        ...DEFAULT_REPO,
+        path: cleanedUrl // The template name becomes the subpath
+    };
+}
+/**
+ * Creates a giget-compatible string from GitHub URL parts
+ * @param parts The parsed GitHub URL parts
+ * @returns A string in the format 'gh:owner/repo#ref[/path]'
+ */
+export function createGigetString(parts) {
+    // For the default repo case with a template name
+    if (parts.owner === DEFAULT_REPO.owner && parts.repo === DEFAULT_REPO.repo) {
+        return `gh:${parts.owner}/${parts.repo}/${parts.path}#${DEFAULT_REPO.ref}`;
+    }
+    // For other GitHub URLs
+    const base = `gh:${parts.owner}/${parts.repo}`;
+    const path = parts.path ? `/${parts.path}` : '';
+    const ref = parts.ref ? `#${parts.ref}` : '';
+    return `${base}${path}${ref}`;
+}

package/dist/lib/utils/path.js

@@ -1,20 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const node_process_1 = require("node:process");
+import fs from 'node:fs';
+import path from 'pathe';
+import { cwd } from 'node:process';
 /**
  * Resolves a given path to an absolute path and checks if it exists.
  * @param inputPath The path to resolve.
  * @param checkExistence Whether to check if the resolved path exists.
  * @returns The resolved absolute path if it exists, or null if it doesn't.
  */
-function resolvePathAndCheckExistence(inputPath, checkExistence = true) {
-    const resolvedPath = node_path_1.default.isAbsolute(inputPath) ? inputPath : node_path_1.default.resolve((0, node_process_1.cwd)(), inputPath);
-    if (!checkExistence || node_fs_1.default.existsSync(resolvedPath)) {
+export default function resolvePathAndCheckExistence(inputPath, checkExistence = true) {
+    const resolvedPath = path.isAbsolute(inputPath) ? inputPath : path.resolve(cwd(), inputPath);
+    if (!checkExistence || fs.existsSync(resolvedPath)) {
         return resolvedPath;
     }
     return null;
 }
-exports.default = resolvePathAndCheckExistence;

package/dist/lib/utils/protected-domains.js

@@ -1,6 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.protectedDomains = void 0;
-exports.protectedDomains = [
+export const protectedDomains = [
     'directus.pizza',
 ];

package/dist/lib/utils/read-file.js

@@ -1,16 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
-const catch_error_1 = tslib_1.__importDefault(require("./catch-error"));
-function readFile(file, dir) {
-    const filePath = node_path_1.default.join(dir, `${file}.json`); // Use path.join for proper path resolution
-    if (!node_fs_1.default.existsSync(filePath)) {
-        (0, catch_error_1.default)(`File not found: ${filePath}`);
+import fs from 'node:fs';
+import path from 'pathe';
+import catchError from './catch-error.js';
+export default function readFile(file, dir) {
+    const filePath = path.join(dir, `${file}.json`); // Use path.join for proper path resolution
+    if (!fs.existsSync(filePath)) {
+        catchError(`File not found: ${filePath}`);
     }
-    const fileContents = node_fs_1.default.readFileSync(filePath, 'utf8');
+    const fileContents = fs.readFileSync(filePath, 'utf8');
     const obj = JSON.parse(fileContents);
     return obj;
 }
-exports.default = readFile;

package/dist/lib/utils/read-templates.js

@@ -1,13 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readAllTemplates = exports.readTemplate = void 0;
-const tslib_1 = require("tslib");
-const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
-async function readTemplate(directoryPath) {
-    const packageFilePath = node_path_1.default.join(directoryPath, 'package.json');
+import fs from 'node:fs';
+import path from 'pathe';
+export async function readTemplate(directoryPath) {
+    const packageFilePath = path.join(directoryPath, 'package.json');
     try {
-        const packageData = await node_fs_1.default.promises.readFile(packageFilePath, 'utf8');
+        const packageData = await fs.promises.readFile(packageFilePath, 'utf8');
         const packageJson = JSON.parse(packageData);
         if (packageJson.templateName) {
             return {
@@ -24,13 +20,12 @@ async function readTemplate(directoryPath) {
         return null;
     }
 }
-exports.readTemplate = readTemplate;
-async function readAllTemplates(directoryPath) {
+export async function readAllTemplates(directoryPath) {
     const templates = [];
-    const files = await node_fs_1.default.promises.readdir(directoryPath);
+    const files = await fs.promises.readdir(directoryPath);
     for (const file of files) {
-        const filePath = node_path_1.default.join(directoryPath, file);
-        const stats = await node_fs_1.default.promises.stat(filePath);
+        const filePath = path.join(directoryPath, file);
+        const stats = await fs.promises.stat(filePath);
         if (stats.isDirectory()) {
             const template = await readTemplate(filePath);
             if (template) {
@@ -40,4 +35,3 @@ async function readAllTemplates(directoryPath) {
     }
     return templates;
 }
-exports.readAllTemplates = readAllTemplates;

package/dist/lib/utils/sanitize-flags.d.ts

@@ -0,0 +1,3 @@
+export declare const sanitizeFlags: (flags: Record<string, unknown>) => {
+    [k: string]: unknown;
+};

package/dist/lib/utils/sanitize-flags.js

@@ -0,0 +1,4 @@
+const SENSITIVE_FLAGS = ['userEmail', 'userPassword', 'directusToken'];
+export const sanitizeFlags = (flags) => {
+    return Object.fromEntries(Object.entries(flags).filter(([key]) => !SENSITIVE_FLAGS.includes(key)));
+};

package/dist/lib/utils/system-fields.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.systemFields = exports.directusSettingsFields = exports.directusPanelFields = exports.directusDashboardFields = exports.directusOperationFields = exports.directusFlowFields = exports.directusFolderFields = exports.directusFileFields = exports.directusRoleFields = exports.directusUserFields = void 0;
-exports.directusUserFields = [
+export const directusUserFields = [
     'id',
     'status',
     'first_name',
@@ -25,7 +22,7 @@ exports.directusUserFields = [
     'tags',
     'email_notifications',
 ];
-exports.directusRoleFields = [
+export const directusRoleFields = [
     'id',
     'name',
     'description',
@@ -36,7 +33,7 @@ exports.directusRoleFields = [
     'app_access',
     'admin_access',
 ];
-exports.directusFileFields = [
+export const directusFileFields = [
     'id',
     'storage',
     'filename_disk',
@@ -59,12 +56,12 @@ exports.directusFileFields = [
     'tags',
     'metadata',
 ];
-exports.directusFolderFields = [
+export const directusFolderFields = [
     'id',
     'name',
     'parent',
 ];
-exports.directusFlowFields = [
+export const directusFlowFields = [
     'id',
     'name',
     'icon',
@@ -78,7 +75,7 @@ exports.directusFlowFields = [
     'date_created',
     'user_created',
 ];
-exports.directusOperationFields = [
+export const directusOperationFields = [
     'id',
     'name',
     'key',
@@ -92,7 +89,7 @@ exports.directusOperationFields = [
     'date_created',
     'user_created',
 ];
-exports.directusDashboardFields = [
+export const directusDashboardFields = [
     'id',
     'name',
     'icon',
@@ -101,7 +98,7 @@ exports.directusDashboardFields = [
     'user_created',
     'color',
 ];
-exports.directusPanelFields = [
+export const directusPanelFields = [
     'id',
     'dashboard',
     'name',
@@ -118,7 +115,7 @@ exports.directusPanelFields = [
     'date_created',
     'user_created',
 ];
-exports.directusSettingsFields = [
+export const directusSettingsFields = [
     'id',
     'project_name',
     'project_url',
@@ -146,14 +143,14 @@ exports.directusSettingsFields = [
     'default_theme_dark',
     'theme_dark_overrides',
 ];
-exports.systemFields = {
-    directus_dashboards: exports.directusDashboardFields,
-    directus_files: exports.directusFileFields,
-    directus_flows: exports.directusFlowFields,
-    directus_folders: exports.directusFolderFields,
-    directus_operations: exports.directusOperationFields,
-    directus_panels: exports.directusPanelFields,
-    directus_roles: exports.directusRoleFields,
-    directus_settings: exports.directusSettingsFields,
-    directus_users: exports.directusUserFields,
+export const systemFields = {
+    directus_dashboards: directusDashboardFields,
+    directus_files: directusFileFields,
+    directus_flows: directusFlowFields,
+    directus_folders: directusFolderFields,
+    directus_operations: directusOperationFields,
+    directus_panels: directusPanelFields,
+    directus_roles: directusRoleFields,
+    directus_settings: directusSettingsFields,
+    directus_users: directusUserFields,
 };

package/dist/lib/utils/template-config.d.ts

@@ -0,0 +1,16 @@
+import type { DirectusTemplateConfig } from '../types.js';
+export interface TemplateInfo {
+    config: DirectusTemplateConfig;
+    frontendOptions: Array<{
+        id: string;
+        name: string;
+        path: string;
+    }>;
+}
+/**
+ * Read and validate the template configuration from a directory
+ * @param dir Directory containing the template
+ * @returns Template configuration and frontend options
+ * @throws Error if package.json is missing or invalid
+ */
+export declare function readTemplateConfig(dir: string): TemplateInfo | null;

package/dist/lib/utils/template-config.js

@@ -0,0 +1,34 @@
+import fs from 'node:fs';
+import path from 'pathe';
+/**
+ * Read and validate the template configuration from a directory
+ * @param dir Directory containing the template
+ * @returns Template configuration and frontend options
+ * @throws Error if package.json is missing or invalid
+ */
+export function readTemplateConfig(dir) {
+    try {
+        const packageJsonPath = path.join(dir, 'package.json');
+        if (!fs.existsSync(packageJsonPath)) {
+            return null;
+        }
+        const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+        const templateConfig = packageJson['directus:template'];
+        if (!templateConfig) {
+            return null;
+        }
+        // Convert frontends object to array of options
+        const frontendOptions = Object.entries(templateConfig.frontends || {}).map(([id, frontend]) => ({
+            id,
+            name: frontend.name,
+            path: frontend.path.replace(/^\.\//, ''), // Remove leading ./
+        }));
+        return {
+            config: templateConfig,
+            frontendOptions,
+        };
+    }
+    catch (error) {
+        return null;
+    }
+}

package/dist/lib/utils/template-defaults.d.ts

@@ -1,2 +1,2 @@
-export declare const generatePackageJsonContent: (templateName: string) => string;
+export declare function generatePackageJsonContent(templateName: string): string;
 export declare const generateReadmeContent: (templateName: string) => string;

package/dist/lib/utils/template-defaults.js

@@ -1,13 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateReadmeContent = exports.generatePackageJsonContent = void 0;
-const tslib_1 = require("tslib");
-const slugify_1 = tslib_1.__importDefault(require("slugify"));
-const generatePackageJsonContent = (templateName) => {
-    const slugifiedName = (0, slugify_1.default)(templateName, {
-        lower: true, // Convert to lowercase
-        strict: true, // Remove special characters
-    });
+import slugify from '@sindresorhus/slugify';
+export function generatePackageJsonContent(templateName) {
+    const slugifiedName = slugify(templateName);
     const packageName = `directus-template-${slugifiedName}`;
     return JSON.stringify({
         author: '',
@@ -18,9 +11,8 @@ const generatePackageJsonContent = (templateName) => {
         templateName,
         version: '1.0.0',
     }, null, 2);
-};
-exports.generatePackageJsonContent = generatePackageJsonContent;
-const generateReadmeContent = (templateName) => `# ${templateName} Template
+}
+export const generateReadmeContent = (templateName) => `# ${templateName} Template
 
 This is a template for [Directus](https://directus.io/) - an open-source headless CMS and API. Use the template-cli to load / apply this template to a blank instance.
 
@@ -31,4 +23,3 @@ This is a template for [Directus](https://directus.io/) - an open-source headles
 ## License
 
 `;
-exports.generateReadmeContent = generateReadmeContent;

package/dist/lib/utils/transform-github-url.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.transformGitHubUrl = void 0;
-function transformGitHubUrl(url) {
+export function transformGitHubUrl(url) {
     // Regular expression to capture the repository name and any subsequent path after the 'tree'
     const regex = /github\.com\/([^/]+\/[^/]+)(?:\/tree\/[^/]+\/(.*))?$/;
     const match = url.match(regex);
@@ -12,4 +9,3 @@ function transformGitHubUrl(url) {
     }
     return 'Invalid URL';
 }
-exports.transformGitHubUrl = transformGitHubUrl;

package/dist/lib/utils/validate-url.js

@@ -1,13 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const protected_domains_1 = require("./protected-domains");
-function validateUrl(url) {
+import { protectedDomains } from './protected-domains.js';
+export default function validateUrl(url) {
     try {
         const parsedUrl = new URL(url);
-        return !protected_domains_1.protectedDomains.includes(parsedUrl.hostname);
+        return !protectedDomains.includes(parsedUrl.hostname);
     }
     catch {
         return false;
     }
 }
-exports.default = validateUrl;

package/dist/lib/utils/wait.d.ts

@@ -0,0 +1,7 @@
+interface WaitOptions {
+    errorMessage?: string;
+    interval?: number;
+    maxAttempts?: number;
+}
+export declare function waitFor(checkFn: () => Promise<boolean>, options?: WaitOptions): Promise<boolean>;
+export {};

package/dist/lib/utils/wait.js

@@ -0,0 +1,9 @@
+export async function waitFor(checkFn, options = {}) {
+    const { errorMessage = 'Operation timed out', interval = 2000, maxAttempts = 30, } = options;
+    for (let i = 0; i < maxAttempts; i++) {
+        if (await checkFn())
+            return true;
+        await new Promise(resolve => setTimeout(resolve, interval));
+    }
+    throw new Error(errorMessage);
+}

package/dist/lib/utils/write-to-file.js

@@ -1,23 +1,20 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
-const node_path_1 = tslib_1.__importDefault(require("node:path"));
-exports.default = async (fileName, data, dir) => {
+import fs from 'node:fs';
+import path from 'pathe';
+export default async (fileName, data, dir) => {
     const folders = fileName.split('/');
     const endFileName = folders.pop();
     const folderPath = folders.join('/');
     // Generate the full path where you want to write the file
-    const fullPath = node_path_1.default.join(dir, folderPath);
+    const fullPath = path.join(dir, folderPath);
     // Check if the directory exists. Create if it doesn't.
-    if (!node_fs_1.default.existsSync(fullPath)) {
-        node_fs_1.default.mkdirSync(fullPath, { recursive: true });
+    if (!fs.existsSync(fullPath)) {
+        fs.mkdirSync(fullPath, { recursive: true });
     }
     // Construct the full file path
-    const fullFilePath = node_path_1.default.join(fullPath, `${endFileName}.json`);
+    const fullFilePath = path.join(fullPath, `${endFileName}.json`);
     try {
         // Write the file
-        await node_fs_1.default.promises.writeFile(fullFilePath, JSON.stringify(data, null, 2));
+        await fs.promises.writeFile(fullFilePath, JSON.stringify(data, null, 2));
         // console.log(`Wrote ${fullFilePath}`);
     }
     catch (error) {

package/dist/services/docker.d.ts

@@ -0,0 +1,23 @@
+export interface DockerConfig {
+    composeFile: string;
+    healthCheckEndpoint: string;
+    interval: number;
+    maxAttempts: number;
+}
+export interface DockerService {
+    checkDocker: () => Promise<DockerCheckResult>;
+    startContainers: (cwd: string) => Promise<void>;
+    stopContainers: (cwd: string) => Promise<void>;
+    waitForHealthy: (healthCheckUrl: string) => Promise<boolean>;
+}
+export interface DockerCheckResult {
+    installed: boolean;
+    message?: string;
+    running: boolean;
+}
+/**
+ * Create a Docker service instance
+ * @param {DockerConfig} config - The Docker configuration
+ * @returns {DockerService} - Returns a Docker service instance
+ */
+export declare function createDocker(config: DockerConfig): DockerService;