directus-template-cli 0.7.7 → 0.7.8

package/dist/commands/apply.d.ts

@@ -45,9 +45,10 @@ export default class ApplyCommand extends BaseCommand {
     private runProgrammatic;
     /**
      * INTERACTIVE
-     * Select a local template from the given directory
-     * @param localTemplateDir - The local template directory path
+     * Select a template from the given GitHub repository
+     * @param ghTemplateUrl - The GitHub repository URL
      * @returns {Promise<Template>} - Returns the selected template
      */
+    private selectGithubTemplate;
     private selectLocalTemplate;
 }

package/dist/commands/apply.js

@@ -9,7 +9,7 @@ import apply from '../lib/load/index.js';
 import { animatedBunny } from '../lib/utils/animated-bunny.js';
 import { getDirectusEmailAndPassword, getDirectusToken, getDirectusUrl, initializeDirectusApi } from '../lib/utils/auth.js';
 import catchError from '../lib/utils/catch-error.js';
-import { getCommunityTemplates, getGithubTemplate, getInteractiveLocalTemplate, getLocalTemplate } from '../lib/utils/get-template.js';
+import { getCommunityTemplates, getGithubTemplate, getInteractiveGithubTemplate, getInteractiveLocalTemplate, getLocalTemplate } from '../lib/utils/get-template.js';
 import { logger } from '../lib/utils/logger.js';
 import openUrl from '../lib/utils/open-url.js';
 import { shutdown, track } from '../services/posthog.js';
@@ -138,7 +138,7 @@ export default class ApplyCommand extends BaseCommand {
                 const ghTemplateUrl = await text({
                     message: 'What is the public GitHub repository URL?',
                 });
-                template = await getGithubTemplate(ghTemplateUrl);
+                template = await this.selectGithubTemplate(ghTemplateUrl);
                 break;
             }
             case 'local': {
@@ -303,10 +303,33 @@ export default class ApplyCommand extends BaseCommand {
     }
     /**
      * INTERACTIVE
-     * Select a local template from the given directory
-     * @param localTemplateDir - The local template directory path
+     * Select a template from the given GitHub repository
+     * @param ghTemplateUrl - The GitHub repository URL
      * @returns {Promise<Template>} - Returns the selected template
      */
+    async selectGithubTemplate(ghTemplateUrl) {
+        try {
+            const templates = await getInteractiveGithubTemplate(ghTemplateUrl);
+            if (templates.length === 1) {
+                return templates[0];
+            }
+            log.info('Multiple Directus templates found in this repository.');
+            const selectedTemplate = await select({
+                message: 'Select a template.',
+                options: templates.map(t => ({ label: t.templateName, value: t })),
+            });
+            return selectedTemplate;
+        }
+        catch (error) {
+            if (error instanceof Error) {
+                ux.error(error.message);
+            }
+            else {
+                ux.error('An unknown error occurred while getting the GitHub template.');
+            }
+            throw error;
+        }
+    }
     async selectLocalTemplate(localTemplateDir) {
         try {
             const templates = await getInteractiveLocalTemplate(localTemplateDir);
@@ -329,6 +352,7 @@ export default class ApplyCommand extends BaseCommand {
             else {
                 ux.error('An unknown error occurred while getting the local template.');
             }
+            throw error;
         }
     }
 }

package/dist/lib/load/load-files.js

@@ -1,6 +1,6 @@
 import { readFiles, uploadFiles } from '@directus/sdk';
 import { ux } from '@oclif/core';
-import { FormData } from 'formdata-node';
+import { File } from 'node:buffer';
 import { readFileSync } from 'node:fs';
 import path from 'pathe';
 import { DIRECTUS_PINK } from '../constants.js';
@@ -17,9 +17,9 @@ export default async function loadFiles(dir) {
                 fields: ['id', 'filename_disk'],
                 limit: -1,
             }));
-            const existingFileIds = new Set(existingFiles.map(file => file.id));
-            const existingFileNames = new Set(existingFiles.map(file => file.filename_disk));
-            const filesToUpload = files.filter(file => {
+            const existingFileIds = new Set(existingFiles.map((file) => file.id));
+            const existingFileNames = new Set(existingFiles.map((file) => file.filename_disk));
+            const filesToUpload = files.filter((file) => {
                 if (existingFileIds.has(file.id)) {
                     return false;
                 }
@@ -31,7 +31,8 @@ export default async function loadFiles(dir) {
             await Promise.all(filesToUpload.map(async (asset) => {
                 const fileName = asset.filename_disk;
                 const assetPath = path.resolve(dir, 'assets', fileName);
-                const fileStream = new Blob([readFileSync(assetPath)], { type: asset.type });
+                const mimeType = asset.type || 'application/octet-stream';
+                const file = new File([readFileSync(assetPath)], fileName, { type: mimeType });
                 const form = new FormData();
                 form.append('id', asset.id);
                 if (asset.title)
@@ -40,9 +41,8 @@ export default async function loadFiles(dir) {
                     form.append('description', asset.description);
                 if (asset.folder)
                     form.append('folder', asset.folder);
-                if (asset.type)
-                    form.append('type', asset.type);
-                form.append('file', fileStream, fileName);
+                form.append('type', mimeType);
+                form.append('file', file);
                 try {
                     await api.client.request(uploadFiles(form));
                 }

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

@@ -6,4 +6,5 @@ export declare function getCommunityTemplates(): Promise<Template[]>;
 export declare function getLocalTemplate(localTemplateDir: string): Promise<Template>;
 export declare function getInteractiveLocalTemplate(localTemplateDir: string): Promise<Template[]>;
 export declare function getGithubTemplate(ghTemplateUrl: string): Promise<Template>;
+export declare function getInteractiveGithubTemplate(ghTemplateUrl: string): Promise<Template[]>;
 export {};

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

@@ -3,9 +3,10 @@ import fs from 'node:fs';
 import { fileURLToPath } from 'node:url';
 import path, { dirname } from 'pathe';
 import { COMMUNITY_TEMPLATE_REPO } from '../constants.js';
+import { logger } from './logger.js';
 import resolvePathAndCheckExistence from './path.js';
 import { readAllTemplates, readTemplate } from './read-templates.js';
-import { transformGitHubUrl } from './transform-github-url.js';
+import { parseGitHubUrl, transformGitHubUrl } from './transform-github-url.js';
 // Create __dirname equivalent for ESM
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
@@ -71,25 +72,74 @@ async function findNestedTemplates(dir, depth) {
     }
     return templates;
 }
+async function downloadGithubTemplate(ghTemplateUrl) {
+    const ghString = transformGitHubUrl(ghTemplateUrl);
+    const downloadDir = resolvePathAndCheckExistence(path.join(__dirname, '..', 'downloads', 'github'), false);
+    if (!downloadDir) {
+        throw new Error(`Invalid download directory: ${path.join(__dirname, '..', 'downloads', 'github')}`);
+    }
+    const { dir } = await downloadTemplate(ghString, {
+        dir: downloadDir,
+        force: true,
+        forceClean: true,
+    });
+    const resolvedDir = resolvePathAndCheckExistence(dir);
+    if (!resolvedDir) {
+        throw new Error(`Downloaded template directory does not exist: ${dir}`);
+    }
+    return resolvedDir;
+}
+function buildSubpathUrl(ghTemplateUrl, templatePath) {
+    const { owner, ref, repo } = parseGitHubUrl(ghTemplateUrl);
+    const normalizedPath = templatePath.split(path.sep).join('/');
+    return `https://github.com/${owner}/${repo}/tree/${ref || 'HEAD'}/${normalizedPath}`;
+}
+function getErrorMessage(error) {
+    return error instanceof Error ? error.message : String(error);
+}
 export async function getGithubTemplate(ghTemplateUrl) {
     try {
-        const ghString = await transformGitHubUrl(ghTemplateUrl);
-        const downloadDir = resolvePathAndCheckExistence(path.join(__dirname, '..', 'downloads', 'github'), false);
-        if (!downloadDir) {
-            throw new Error(`Invalid download directory: ${path.join(__dirname, '..', 'downloads', 'github')}`);
+        const resolvedDir = await downloadGithubTemplate(ghTemplateUrl);
+        const template = await readTemplate(resolvedDir);
+        if (template) {
+            return template;
         }
-        const { dir } = await downloadTemplate(ghString, {
-            dir: downloadDir,
-            force: true,
-            forceClean: true,
-        });
-        const resolvedDir = resolvePathAndCheckExistence(dir);
-        if (!resolvedDir) {
-            throw new Error(`Downloaded template directory does not exist: ${dir}`);
+        const nested = await findNestedTemplates(resolvedDir, 3);
+        if (nested.length === 1) {
+            const subpath = path.relative(resolvedDir, nested[0].directoryPath);
+            const pinnedUrl = buildSubpathUrl(ghTemplateUrl, subpath);
+            logger.log('warn', `Auto-selected nested template "${nested[0].templateName}" at ${subpath}. Pin --templateLocation="${pinnedUrl}" to avoid ambiguity if more templates are added.`);
+            return nested[0];
+        }
+        if (nested.length > 1) {
+            const list = nested
+                .map(t => {
+                const subpath = path.relative(resolvedDir, t.directoryPath);
+                return `  --templateLocation="${buildSubpathUrl(ghTemplateUrl, subpath)}"   # ${t.templateName}`;
+            })
+                .join('\n');
+            throw new Error(`Found multiple Directus templates in ${ghTemplateUrl}. Re-run with one of:\n${list}`);
+        }
+        throw new Error(`No Directus template found at ${ghTemplateUrl}. A Directus template needs a package.json with a "templateName" field.`);
+    }
+    catch (error) {
+        throw new Error(`Failed to download GitHub template: ${getErrorMessage(error)}`, { cause: error });
+    }
+}
+export async function getInteractiveGithubTemplate(ghTemplateUrl) {
+    try {
+        const resolvedDir = await downloadGithubTemplate(ghTemplateUrl);
+        const template = await readTemplate(resolvedDir);
+        if (template) {
+            return [template];
+        }
+        const nested = await findNestedTemplates(resolvedDir, 3);
+        if (nested.length === 0) {
+            throw new Error(`No Directus template found at ${ghTemplateUrl}. A Directus template needs a package.json with a "templateName" field.`);
         }
-        return readTemplate(resolvedDir);
+        return nested;
     }
     catch (error) {
-        throw new Error(`Failed to download GitHub template: ${error}`);
+        throw new Error(`Failed to download GitHub template: ${getErrorMessage(error)}`, { cause: error });
     }
 }

package/dist/lib/utils/transform-github-url.d.ts

@@ -1 +1,8 @@
+export interface ParsedGitHubUrl {
+    owner: string;
+    ref?: string;
+    repo: string;
+    subpath?: string;
+}
+export declare function parseGitHubUrl(url: string): ParsedGitHubUrl;
 export declare function transformGitHubUrl(url: string): string;

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

@@ -1,11 +1,31 @@
+export function parseGitHubUrl(url) {
+    const cleaned = url.trim().replace(/\/+$/, '');
+    const urlToParse = /^https?:\/\//i.test(cleaned) ? cleaned : `https://${cleaned}`;
+    let parsed;
+    try {
+        parsed = new URL(urlToParse);
+    }
+    catch {
+        throw new Error(`Invalid GitHub URL: ${url}`);
+    }
+    if (!['github.com', 'www.github.com'].includes(parsed.hostname.toLowerCase())) {
+        throw new Error(`Invalid GitHub URL: ${url}`);
+    }
+    const pathParts = parsed.pathname.split('/').filter(Boolean);
+    const [owner, rawRepo, tree, ref, ...subpathParts] = pathParts;
+    const repo = rawRepo?.replace(/\.git$/, '');
+    if (!owner || !repo || pathParts.length > 2 && tree !== 'tree') {
+        throw new Error(`Invalid GitHub URL: ${url}`);
+    }
+    if (tree === 'tree' && !ref) {
+        throw new Error(`Invalid GitHub URL: ${url}`);
+    }
+    const subpath = subpathParts.length > 0 ? subpathParts.join('/') : undefined;
+    return { owner, ref, repo, subpath };
+}
 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);
-    if (match) {
-        const repo = match[1];
-        const subpath = match[2] ? match[2] : '';
-        return `github:${repo}/${subpath}`;
-    }
-    return 'Invalid URL';
+    const { owner, ref, repo, subpath } = parseGitHubUrl(url);
+    const pathPart = subpath ? `/${subpath}` : '';
+    const refPart = ref ? `#${ref}` : '';
+    return `github:${owner}/${repo}${pathPart}${refPart}`;
 }

package/oclif.manifest.json

@@ -401,5 +401,5 @@
       ]
     }
   },
-  "version": "0.7.7"
+  "version": "0.7.8"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "directus-template-cli",
-  "version": "0.7.7",
+  "version": "0.7.8",
   "description": "CLI Utility for applying templates to a Directus instance.",
   "author": "bryantgillespie @bryantgillespie",
   "type": "module",
@@ -19,45 +19,44 @@
   ],
   "dependencies": {
     "@clack/prompts": "^0.10.0",
-    "@directus/sdk": "20.1.0",
-    "@inquirer/prompts": "^7.3.3",
-    "@oclif/core": "^4.2.9",
-    "@oclif/plugin-help": "^6.2.26",
-    "@oclif/plugin-plugins": "^5.4.34",
-    "@octokit/rest": "^21.1.1",
-    "@sindresorhus/slugify": "^2.2.1",
+    "@directus/sdk": "21.2.2",
+    "@inquirer/prompts": "^8.4.1",
+    "@oclif/core": "^4.10.5",
+    "@oclif/plugin-help": "^6.2.44",
+    "@oclif/plugin-plugins": "^5.4.61",
+    "@octokit/rest": "^22.0.1",
+    "@sindresorhus/slugify": "^3.0.0",
     "bottleneck": "^2.19.5",
-    "chalk": "5.4.1",
+    "chalk": "5.6.2",
     "cli-progress": "^3.12.0",
-    "defu": "^6.1.4",
-    "dotenv": "^16.4.7",
-    "execa": "9.5.2",
-    "formdata-node": "^6.0.3",
-    "giget": "^2.0.0",
-    "glob": "^11.0.1",
-    "log-update": "^6.1.0",
-    "nypm": "^0.6.0",
+    "defu": "^6.1.7",
+    "dotenv": "^17.4.2",
+    "execa": "9.6.1",
+    "giget": "^3.2.0",
+    "glob": "^13.0.6",
+    "log-update": "^8.0.0",
+    "nypm": "^0.6.5",
     "pathe": "^2.0.3",
-    "posthog-node": "^4.10.1"
+    "posthog-node": "^5.29.2"
   },
   "devDependencies": {
-    "@directus/types": "^13.0.0",
-    "@eslint/compat": "^1",
+    "@directus/types": "^15.0.2",
+    "@eslint/compat": "^2.0.5",
     "@oclif/prettier-config": "^0.2.1",
-    "@oclif/test": "^4",
-    "@types/chai": "^5.2.0",
+    "@oclif/test": "^4.1.18",
+    "@types/chai": "^5.2.3",
     "@types/mocha": "^10",
-    "@types/node": "^18",
-    "chai": "^5.2.0",
-    "eslint": "^9.39.2",
-    "eslint-config-oclif": "^6.0.130",
+    "@types/node": "^25.6.0",
+    "chai": "^6.2.2",
+    "eslint": "^10.2.1",
+    "eslint-config-oclif": "^6.0.157",
     "eslint-config-prettier": "^10",
-    "mocha": "^10",
-    "oclif": "^4",
-    "prettier": "^3.7.4",
-    "shx": "^0.3.3",
+    "mocha": "^11.7.5",
+    "oclif": "^4.23.0",
+    "prettier": "^3.8.3",
+    "shx": "^0.4.0",
     "ts-node": "^10",
-    "typescript": "^5.8.2"
+    "typescript": "^6.0.3"
   },
   "oclif": {
     "bin": "directus-template-cli",